ConfigMenu Class Reference

CLI configuration menu definition. More...

#include <config_menu.h>

Inheritance diagram for ConfigMenu:

Public Member Functions
	ConfigMenu (void)
	Default constructor. More...
virtual	~ConfigMenu (void)
	Destructor. More...
virtual void	SetCli (Cli &CLI_Cli)
	Cli reference setting. More...
virtual const bool	ExecuteReserved (const CommandLine &CLI_CmdLine) const
	Reserved commands execution. More...
virtual const bool	Execute (const CommandLine &CLI_CmdLine) const
	User-defined commands execution. More...
Public Member Functions inherited from Menu
	Menu (const char *const STR_Name, const Help &CLI_Help)
	Constructor. More...
virtual	~Menu (void)
	Destructor. More...
const tk::String	GetName (void) const
	Menu name access. More...
virtual void	OnExit (void) const
	Handler on menu exit. More...
virtual const tk::String	OnPrompt (void) const
	Handler on prompt display. More...
Public Member Functions inherited from SyntaxNode
	SyntaxNode (const char *const STR_Keyword, const Help &CLI_Help)
	Constructor. More...
virtual	~SyntaxNode (void)
	Destructor. More...
Element &	AddElement (Element *const PCLI_Element)
	Possible element addition. More...
const bool	RemoveElement (const Element *const PCLI_Element, const bool B_AutoDelete)
	Element removal. More...
virtual const bool	FindElements (Element::List &CLI_ExactList, Element::List &CLI_NearList, const char *const STR_Keyword) const
	Sub-elements search. 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...
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

CLI configuration menu definition.

Definition at line 47 of file config_menu.h.

Constructor & Destructor Documentation

ConfigMenu()

ConfigMenu::ConfigMenu ( void  )

explicit

Default constructor.

~ConfigMenu()

virtual ConfigMenu::~ConfigMenu ( void  )

virtual

Destructor.

Member Function Documentation

Execute()

virtual const bool ConfigMenu::Execute ( const CommandLine &  CLI_CommandLine ) const

virtual

User-defined commands execution.

Parameters

CLI_CommandLine

Command line to execute.

Returns

true if the command has found an execution code, false otherwise.

Reimplemented from Menu.

ExecuteReserved()

virtual const bool ConfigMenu::ExecuteReserved ( const CommandLine &  CLI_CommandLine ) const

virtual

Reserved commands execution.

Parameters

CLI_CommandLine

Command line to execute.

Returns

true if the command has found an execution code, false otherwise.

Reimplemented from Menu.

SetCli()

virtual void ConfigMenu::SetCli ( Cli &  CLI_Cli )

virtual

Cli reference setting.

Parameters

CLI_Cli

Cli reference.

The m_pcliCli member should be set for each Element object. However, generally, this method is automaticaly called, as in SyntaxNode::AddElement() for instance.

Reimplemented from Menu.

---

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

• config_menu.h