Homepage Demos Overview Downloads Tutorials Reference
Credits
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Namespace Members | Compound Members | File Members | Related Pages | Search

HelpControl Class Reference

#include <HelpControl.h>

Inheritance diagram for HelpControl:

Inheritance graph
[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.

Public Member Functions

 HelpControl (ControlBase *r)
 < constructor

virtual ControlBaseactivate (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)
 displays the menu items of r and their descriptions, recursing on submenus


Protected Attributes

ControlBaseroot
 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 & Destructor Documentation

HelpControl::HelpControl ControlBase r  )  [inline]
 

< constructor

Definition at line 11 of file HelpControl.h.

References ControlBase::description, ControlBase::name, and root.

HelpControl::HelpControl const HelpControl  )  [private]
 

don't call


Member Function Documentation

ControlBase * HelpControl::activate MotionManager::MC_ID  disp_id,
Socket gui
[virtual]
 

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.

References NullControl::activate(), config, Config::main, Socket::printf(), report(), root, sout, and Config::main_config::use_VT100.

HelpControl HelpControl::operator= const HelpControl  )  [private]
 

don't call

void HelpControl::report ControlBase r,
const std::string &  prefix
 

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.

References config, ControlBase::getSlots(), Config::main, Socket::printf(), sout, term_width, and Config::main_config::use_VT100.


Member Data Documentation

ControlBase* HelpControl::root [protected]
 

stores root node to begin recursion (this item is not displayed)

Definition at line 25 of file HelpControl.h.

const unsigned int HelpControl::term_width = 80 [static, protected]
 

number of character to word wrap the display

Definition at line 23 of file HelpControl.h.


The documentation for this class was generated from the following files:
Tekkotsu v1.4
Generated Sat Jul 19 00:08:59 2003 by Doxygen 1.3.2