CLI  2.9
Keyword Class Reference

Keyword element class. More...

#include <keyword.h>

Inheritance diagram for Keyword:

Public Member Functions

 Keyword (const char *const STR_Keyword, const Help &CLI_Help)
 Constructor. More...
 
virtual ~Keyword (void)
 Destructor. More...
 
- Public Member Functions inherited from SyntaxNode
 SyntaxNode (const char *const STR_Keyword, const Help &CLI_Help)
 Constructor. More...
 
virtual ~SyntaxNode (void)
 Destructor. More...
 
ElementAddElement (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 HelpGetHelp (void) const
 Element help accessor. More...
 
virtual void SetCli (Cli &CLI_Cli)
 Cli reference setting. More...
 
CliGetCli (void)
 Read-Write Cli reference accessor. More...
 
const CliGetCli (void) const
 Read-only Cli reference accessor. More...
 
ShellGetShell (void) const
 Shell reference accessor. More...
 
const OutputDeviceGetOutputStream (void) const
 Output stream reference accessor. More...
 
const OutputDeviceGetErrorStream (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

Keyword element class.

Definition at line 47 of file keyword.h.

Constructor & Destructor Documentation

◆ Keyword()

Keyword::Keyword ( const char *const  STR_Keyword,
const Help CLI_Help 
)
explicit

Constructor.

Parameters
STR_KeywordTHE keyword.
CLI_HelpCorresponding help.

◆ ~Keyword()

virtual Keyword::~Keyword ( void  )
virtual

Destructor.


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