CLI
2.9
|
Yes/No question user interface object. More...
#include <ui_yesno.h>
Public Member Functions | |
YesNo (const bool B_DefaultAnswer) | |
Top execution context constructor. More... | |
YesNo (ExecutionContext &CLI_ParentContext, const bool B_DefaultAnswer) | |
Child execution context constructor. More... | |
virtual | ~YesNo (void) |
Destructor. More... | |
const bool | GetYesNo (void) const |
Yes/No answer retrieval. More... | |
virtual void | OnKey (const KEY E_KeyCode) |
Handler called on character input. More... | |
Public Member Functions inherited from Choice | |
Choice (const int I_DefaultChoice, const tk::Queue< ResourceString > &TK_Choices) | |
Top execution context constructor. More... | |
Choice (ExecutionContext &CLI_ParentContext, const int I_DefaultChoice, const tk::Queue< ResourceString > &TK_Choices) | |
Child execution context constructor. More... | |
virtual | ~Choice (void) |
Destructor. More... | |
const int | GetChoice (void) const |
Choice retrieval. More... | |
const ResourceString | GetstrChoice (void) const |
Choice retrieval in its string form. More... | |
Public Member Functions inherited from Line | |
Line (const tk::String &TK_DefaultLine, const int I_MinLineLength, const int I_MaxLineLength) | |
Top execution context constructor. More... | |
Line (ExecutionContext &CLI_ParentContext, const tk::String &TK_DefaultLine, const int I_MinLineLength, const int I_MaxLineLength) | |
Child execution context constructor. More... | |
virtual | ~Line (void) |
Destructor. More... | |
const tk::String | GetLine (void) const |
Line retrieval. More... | |
Public Member Functions inherited from UI | |
virtual | ~UI (void) |
Destructor. More... | |
const bool | GetbExecResult (void) const |
Execution result accessor. More... | |
Public Member Functions inherited from ExecutionContext | |
virtual | ~ExecutionContext (void) |
Destructor. More... | |
ExecutionContextManager & | GetContextManager (void) |
Execution context manager accessor. More... | |
const IODevice & | GetInput (void) const |
Input stream accessor. More... | |
const OutputDevice & | GetStream (const STREAM_TYPE E_StreamType) const |
Output stream accessor. More... | |
const bool | SetStream (const STREAM_TYPE E_StreamType, OutputDevice &CLI_Stream) |
Output stream positionning. More... | |
const bool | StreamEnabled (const STREAM_TYPE E_StreamType) const |
Enabled/disabled stream accessor. More... | |
const bool | EnableStream (const STREAM_TYPE E_StreamType, const bool B_Enable) |
Enable/disable stream. More... | |
void | SetLang (const ResourceString::LANG E_Lang) |
Language setting. More... | |
const ResourceString::LANG | GetLang (void) const |
Language access. More... | |
void | SetBeep (const bool B_Enable) |
Beep configuration setting. More... | |
const bool | GetBeep (void) const |
Beep configuration access. More... | |
void | Beep (void) |
Sends a beep signal. More... | |
void | Run (IODevice &CLI_IODevice) |
Runs the execution context onto the corresponding input/output device. More... | |
void | Run (void) |
Runs the execution context as a child context of the parent given by the construction. More... | |
const bool | IsRunning (void) const |
Tells whether this execution context is running or not. More... | |
void | StopExecution (void) |
Terminates this execution context's execution. More... | |
void | StopAllExecutions (void) |
Terminates execution for all execution contexts attached to the same top execution context. More... | |
Public Member Functions inherited from Object | |
virtual | ~Object (void)=0 |
Pure virtual destructor. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from Choice | |
virtual void | ResetToDefault (void) |
Handler called when default value is required to be restored. More... | |
Protected Member Functions inherited from Line | |
void | SetLine (const tk::String &TK_Line, const bool B_NewLine, const bool B_CleanOnTyping) |
Protected line setter for child classes. More... | |
virtual void | Reset (void) |
Handler called when data reset is required. More... | |
Protected Member Functions inherited from UI | |
UI (void) | |
Top execution context constructor. More... | |
UI (ExecutionContext &CLI_ExecutionContext) | |
Child execution context constructor. More... | |
virtual const bool | OnStartExecution (void) |
Beginning of execution handler. More... | |
virtual const bool | OnStopExecution (void) |
Execution termination handler. More... | |
void | EndControl (const bool B_ExecResult) |
Method to call by child classes in order to end the control execution. More... | |
Protected Member Functions inherited from ExecutionContext | |
ExecutionContext (void) | |
Top context constructor. More... | |
ExecutionContext (ExecutionContext &CLI_ParentContext) | |
Child context constructor. More... | |
Protected Member Functions inherited from Object | |
Object (void) | |
Default constructor only available to sub-classes. More... | |
Yes/No question user interface object.
Definition at line 43 of file ui_yesno.h.
|
explicit |
Top execution context constructor.
B_DefaultAnswer | Default answer: true for 'yes', false for 'no'. |
Definition at line 58 of file ui_yesno.cpp.
References YesNo().
Referenced by YesNo().
|
explicit |
Child execution context constructor.
CLI_ParentContext | Parent execution context. |
B_DefaultAnswer | Default answer: true for 'yes', false for 'no'. |
Definition at line 63 of file ui_yesno.cpp.
References YesNo().
|
virtual |
Destructor.
Definition at line 68 of file ui_yesno.cpp.
const bool YesNo::GetYesNo | ( | void | ) | const |
Yes/No answer retrieval.
Definition at line 72 of file ui_yesno.cpp.
References Choice::GetChoice().
|
virtual |
Handler called on character input.
E_KeyCode | Input key. |
Reimplemented from Choice.
Definition at line 84 of file ui_yesno.cpp.
References Choice::OnKey().