CLI
2.9
|
#include <menu.h>
Public Member Functions | |
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 | SetCli (Cli &CLI_Cli) |
Cli reference setting. More... | |
virtual const bool | ExecuteReserved (const CommandLine &CLI_CommandLine) const |
Reserved commands execution. More... | |
virtual const bool | Execute (const CommandLine &CLI_CommandLine) const |
User-defined commands execution. More... | |
virtual void | OnExit (void) const |
Handler on menu exit. More... | |
virtual const tk::String | OnPrompt (void) const |
Handler on prompt display. More... | |
![]() | |
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... | |
![]() | |
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... | |
![]() | |
virtual | ~Object (void)=0 |
Pure virtual destructor. More... | |
Additional Inherited Members | |
![]() | |
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... | |
![]() | |
Object (void) | |
Default constructor only available to sub-classes. More... | |
|
explicit |
Constructor.
STR_Name | Menu name. |
CLI_Help | Corresponding help. |
|
virtual |
Destructor.
|
virtual |
User-defined commands execution.
CLI_CommandLine | Command line to execute. |
Reimplemented in ConfigMenu, and TracesMenu.
|
virtual |
Reserved commands execution.
CLI_CommandLine | Command line to execute. |
Reimplemented in Cli, ConfigMenu, and TracesMenu.
const tk::String Menu::GetName | ( | void | ) | const |
Menu name access.
|
virtual |
Handler on menu exit.
Reimplemented in Cli.
|
virtual |
Handler on prompt display.
|
virtual |
Cli reference setting.
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 Element.
Reimplemented in Cli, ConfigMenu, and TracesMenu.