Endl Class Reference

End of command line element. More...

#include <endl.h>

Inheritance diagram for Endl:

Public Member Functions
	Endl (const Help &CLI_Help)
	Constructor. More...
virtual	~Endl (void)
	Destructor. More...
Menu &	SetMenu (Menu *const PCLI_Menu)
	Attaches the optional menu. More...
MenuRef &	SetMenuRef (MenuRef *const PCLI_MenuRef)
	Attaches the optional menu. More...
const MenuRef *const	GetMenuRef (void) const
	Optional menu reference accessor. More...
Public Member Functions inherited from Element
	Element (const char *const STR_Keyword, const Help &STR_Help)
	Constructor. More...
virtual	~Element (void)=0
	Destructor. More...
virtual const tk::String	GetKeyword (void) const
	String identifier accessor. More...
virtual const Help &	GetHelp (void) const
	Element help accessor. More...
virtual const bool	FindElements (Element::List &CLI_ExactList, Element::List &CLI_NearList, const char *const STR_Keyword) const
	Sub-elements search. More...
virtual void	SetCli (Cli &CLI_Cli)
	Cli reference setting. More...
Cli &	GetCli (void)
	Read-Write Cli reference accessor. More...
const Cli &	GetCli (void) const
	Read-only Cli reference accessor. More...
Shell &	GetShell (void) const
	Shell reference accessor. More...
const OutputDevice &	GetOutputStream (void) const
	Output stream reference accessor. More...
const OutputDevice &	GetErrorStream (void) const
	Error stream reference accessor. More...
Public Member Functions inherited from Object
virtual	~Object (void)=0
	Pure virtual destructor. More...

Additional Inherited Members
Public Types inherited from Element
typedef tk::Queue< const Element * >	List
	CLI element list type. More...
typedef tk::Map< const tk::String, const Element * >	Map
	CLI element map type. More...
Protected Member Functions inherited from Object
	Object (void)
	Default constructor only available to sub-classes. More...

Detailed Description

End of command line element.

CLI element used to terminate a command line. A menu reference can be optionally attached.

Definition at line 51 of file endl.h.

Constructor & Destructor Documentation

Endl()

Endl::Endl ( const Help &  CLI_Help )

explicit

Constructor.

Parameters

CLI_Help

Help.

~Endl()

virtual Endl::~Endl ( void  )

virtual

Destructor.

Member Function Documentation

GetMenuRef()

const MenuRef* const Endl::GetMenuRef

(

void

)

const

Optional menu reference accessor.

Returns

Menu reference if set, NULL otherwise.

SetMenu()

Menu& Endl::SetMenu

(

Menu *const

PCLI_Menu

)

Attaches the optional menu.

Returns

The menu object reference.

Stores the menu object reference and gives it to the corresponding CLI object for ownership.

Parameters

PCLI_Menu

Newly created menu object.

SetMenuRef()

MenuRef& Endl::SetMenuRef

(

MenuRef *const

PCLI_MenuRef

)

Attaches the optional menu.

Returns

The menu object reference.

Parameters

PCLI_MenuRef

Menu reference.

---

The documentation for this class was generated from the following file:

• endl.h