Homepage | Demos | Overview | Downloads | Tutorials | Reference | Credits |
#include <HelpControl.h>
Inheritance diagram for HelpControl:
Definition at line 8 of file HelpControl.h.
Public Member Functions | |
HelpControl (ControlBase *r, unsigned int depth=-1U) | |
< constructor | |
virtual ControlBase * | activate (MotionManager::MC_ID disp_id, Socket *gui) |
displays global Controller commands (hardcoded as strings, will need updates) as well as recursing the menu system (dynamic) | |
void | report (ControlBase *r, const std::string &prefix, unsigned int max_depth) |
displays the menu items of r and their descriptions, recursing on submenus | |
void | setReportDepth (unsigned int depth) |
sets maxDepth | |
unsigned int | getReportDepth () const |
gets maxDepth | |
Protected Attributes | |
unsigned int | maxDepth |
default maximum recursion depth for reporting from activation | |
ControlBase * | root |
stores root node to begin recursion (this item is not displayed) | |
Static Protected Attributes | |
const unsigned int | term_width = 80 |
number of character to word wrap the display | |
Private Member Functions | |
HelpControl (const HelpControl &) | |
don't call | |
HelpControl | operator= (const HelpControl &) |
don't call |
|
< constructor
Definition at line 11 of file HelpControl.h. |
|
don't call
|
|
displays global Controller commands (hardcoded as strings, will need updates) as well as recursing the menu system (dynamic)
Reimplemented from NullControl. Definition at line 3 of file HelpControl.cc. |
|
gets maxDepth
Definition at line 29 of file HelpControl.h. |
|
don't call
|
|
displays the menu items of r and their descriptions, recursing on submenus prefix is what should be displayed before each menu item (like a bullet point) this is itself prefixed by 2 spaces for each level of recursion. Word wrapping is performed to maintain the clean indenting Definition at line 28 of file HelpControl.cc. Referenced by activate(). |
|
sets maxDepth
Definition at line 26 of file HelpControl.h. |
|
default maximum recursion depth for reporting from activation
Definition at line 34 of file HelpControl.h. Referenced by activate(), getReportDepth(), HelpControl(), and setReportDepth(). |
|
stores root node to begin recursion (this item is not displayed)
Definition at line 36 of file HelpControl.h. Referenced by activate(), and HelpControl(). |
|
number of character to word wrap the display
Definition at line 32 of file HelpControl.h. Referenced by report(). |
Tekkotsu v2.0 |
Generated Wed Jan 21 03:23:14 2004 by Doxygen 1.3.4 |