NullControl Class Reference
when activated, this will return immediately (handy for fake items in a menu) More...
#include <NullControl.h>
Detailed Description
when activated, this will return immediately (handy for fake items in a menu)
Definition at line 8 of file NullControl.h.
Public Member Functions | |
| NullControl (ControlBase *inputRedirectTgt=NULL) | |
| Constructor. | |
| NullControl (const std::string &n, ControlBase *inputRedirectTgt=NULL) | |
| Constructor. | |
| NullControl (const std::string &n, const std::string &d, ControlBase *inputRedirectTgt=NULL) | |
| Constructor. | |
| virtual void | setInputRedirect (ControlBase *inputRedirectTgt) |
| sets inputRedirect | |
| virtual ControlBase * | getInputRedirect () const |
| returns inputRedirect | |
| virtual ControlBase * | takeInput (const std::string &msg) |
| returns NULL unless inputRedirect is set, in which case it will return inputRedirect->takeInput(msg) | |
| virtual ControlBase * | activate (MC_ID, Socket *) |
| returns NULL | |
| virtual ControlBase * | doSelect () |
| returns NULL | |
| virtual ControlBase * | doNextItem () |
| returns NULL | |
| virtual ControlBase * | doPrevItem () |
| returns NULL | |
| virtual ControlBase * | doReadStdIn (const std::string &=std::string()) |
| returns NULL | |
Protected Attributes | |
| ControlBase * | inputRedirect |
| the target to receiving forwarding of any calls to takeInput() | |
Private Member Functions | |
| NullControl (const NullControl &) | |
| you can override, but don't call this... | |
| NullControl & | operator= (const NullControl &) |
| you can override, but don't call this... | |
Constructor & Destructor Documentation
| NullControl::NullControl | ( | ControlBase * | inputRedirectTgt = NULL |
) | [explicit] |
Constructor.
Definition at line 12 of file NullControl.h.
| NullControl::NullControl | ( | const std::string & | n, | |
| ControlBase * | inputRedirectTgt = NULL | |||
| ) | [explicit] |
Constructor.
Definition at line 14 of file NullControl.h.
| NullControl::NullControl | ( | const std::string & | n, | |
| const std::string & | d, | |||
| ControlBase * | inputRedirectTgt = NULL | |||
| ) |
Constructor.
Definition at line 16 of file NullControl.h.
| NullControl::NullControl | ( | const NullControl & | ) | [private] |
you can override, but don't call this...
Member Function Documentation
| virtual ControlBase* NullControl::activate | ( | MC_ID | , | |
| Socket * | ||||
| ) | [virtual] |
returns NULL
Reimplemented from ControlBase.
Reimplemented in BehaviorActivatorControl, HelpControl, RebootControl, ShutdownControl, and ToggleControl.
Definition at line 23 of file NullControl.h.
| virtual ControlBase* NullControl::doNextItem | ( | ) | [virtual] |
| virtual ControlBase* NullControl::doPrevItem | ( | ) | [virtual] |
| virtual ControlBase* NullControl::doReadStdIn | ( | const std::string & | = std::string() |
) | [virtual] |
| virtual ControlBase* NullControl::doSelect | ( | ) | [virtual] |
returns NULL
Reimplemented from ControlBase.
Reimplemented in RebootControl, ShutdownControl, and ToggleControl.
Definition at line 25 of file NullControl.h.
| virtual ControlBase* NullControl::getInputRedirect | ( | ) | const [virtual] |
returns inputRedirect
Definition at line 19 of file NullControl.h.
| NullControl& NullControl::operator= | ( | const NullControl & | ) | [private] |
you can override, but don't call this...
| virtual void NullControl::setInputRedirect | ( | ControlBase * | inputRedirectTgt | ) | [virtual] |
sets inputRedirect
Definition at line 18 of file NullControl.h.
| virtual ControlBase* NullControl::takeInput | ( | const std::string & | msg | ) | [virtual] |
returns NULL unless inputRedirect is set, in which case it will return inputRedirect->takeInput(msg)
Reimplemented from ControlBase.
Definition at line 32 of file NullControl.h.
Member Data Documentation
ControlBase* NullControl::inputRedirect [protected] |
the target to receiving forwarding of any calls to takeInput()
this is handy if this instance is some feedback to the user, and any input they enter with this control selected only makes sense to be handled by the parent
Definition at line 38 of file NullControl.h.
Referenced by getInputRedirect(), setInputRedirect(), and takeInput().
The documentation for this class was generated from the following file:
