HelpControl Class Reference
#include <HelpControl.h>
Inheritance diagram for HelpControl:
Detailed Description
Recurses through the menu system and outputs the name and description of each item.
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 | |
| static 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 | |
Member Function Documentation
| 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 33 of file HelpControl.cc.
Referenced by activate().
The documentation for this class was generated from the following files:
