HelpControl Class Reference#include <HelpControl.h>
Inheritance diagram for HelpControl:
[legend]List of all members.
Detailed Description
Recurses through the menu system and outputs the name and description of each item.
Definition at line 8 of file HelpControl.h.
Constructor & Destructor Documentation
HelpControl::HelpControl |
( |
ControlBase * |
r, |
|
|
unsigned int |
depth = -1U |
|
) |
[inline] |
|
HelpControl::HelpControl |
( |
const HelpControl & |
|
) |
[private] |
|
Member Function Documentation
|
displays global Controller commands (hardcoded as strings, will need updates) as well as recursing the menu system (dynamic)
Reimplemented from NullControl.
Definition at line 5 of file HelpControl.cc. |
unsigned int HelpControl::getReportDepth |
( |
|
) |
const [inline] |
|
void HelpControl::report |
( |
ControlBase * |
r, |
|
|
const std::string & |
prefix, |
|
|
unsigned int |
max_depth |
|
) |
|
|
|
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 30 of file HelpControl.cc.
Referenced by activate(). |
void HelpControl::setReportDepth |
( |
unsigned int |
depth |
) |
[inline] |
|
Member Data Documentation
The documentation for this class was generated from the following files:
|