DtSubCommandManager Class Reference

A specialized version of DtConsoleCommandManager which handles a set of sub commands from another console command manager. More...

Inheritance diagram for DtSubCommandManager:

Classes
class	DtRunSubCommand
	Command which is registered on the parent manager, and invokes this command manager. More...

Public Member Functions
	DtSubCommandManager (const DtString &commandName, DtConsoleCommandManager *parentManager)
virtual	~DtSubCommandManager ()
Public Member Functions inherited from DtConsoleCommandManager
	DtConsoleCommandManager ()
virtual	~DtConsoleCommandManager ()
virtual void	addCommand (DtString commandString, DtConsoleCommand *command)
	Register a new command with the manager.
virtual void	removeCommand (DtString commandString)
	Remove a command from the manager.
virtual void	removeCommand (DtConsoleCommand *command)
	Removes all references to the specified command.
virtual bool	runCommand (DtString consoleString)
	Pass in the string entered on the console to run the command (if any) contained in it.
virtual DtString	helpText (const DtString &parameters) const
virtual void	addAlias (DtString aliasString, DtConsoleCommand *command)
	Adds an additional string which will invoke a command already registered with addCommand().
virtual void	addAlias (DtString aliasString, DtString commandString)
	Adds an additional string which will invoke a command already registered with addCommand().

Protected Attributes
DtConsoleCommandManager *	myParentManager
DtRunSubCommand *	myCommand
Protected Attributes inherited from DtConsoleCommandManager
DtConsoleCommandMap	myCommandMap
DtConsoleCommandMap	myAliasMap
DtHelpConsoleCommand *	myHelpCommand

Additional Inherited Members
Static Public Member Functions inherited from DtConsoleCommandManager
static void	cleanup ()
	Cleans up global command manager.
static DtConsoleCommandManager *	globalConsoleCommandManager ()
Public Attributes inherited from DtConsoleCommandManager
boost::signal< void()>	signal_globalCommandManagerToBeDestroyed
Protected Types inherited from DtConsoleCommandManager
typedef std::map< DtString, DtConsoleCommand * >	DtConsoleCommandMap
Protected Member Functions inherited from DtConsoleCommandManager
virtual void	removeReferencesFromMap (DtConsoleCommandMap &commandMap, DtConsoleCommand *command)
	Used internally. Removes all items that refer to command from commandMap.
Static Protected Attributes inherited from DtConsoleCommandManager
static DtConsoleCommandManager *	theConsoleCommandManager

Detailed Description

A specialized version of DtConsoleCommandManager which handles a set of sub commands from another console command manager.

This class will register a command with a parent DtConsoleCommandManager when it is created, and then process the arguments from the parent with the local commands registered.

Constructor & Destructor Documentation

DtSubCommandManager::DtSubCommandManager	(	const DtString &	commandName,
		DtConsoleCommandManager *	parentManager
	)

Parameters

commandName

The name of the command that will invoke subcommands in this manager. This is basically the "sub-menu" name.

virtual DtSubCommandManager::~DtSubCommandManager ( )

virtual

Member Data Documentation

DtConsoleCommandManager* DtSubCommandManager::myParentManager

protected

DtRunSubCommand* DtSubCommandManager::myCommand

protected

---

The documentation for this class was generated from the following file:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfutil/consoleCommandManager.h