A Command which prints help messages for commands. More...
#include <HelpCommand.h>
Public Member Functions | |
HelpCommand () | |
Constructs a HelpCommand. More... | |
virtual | ~HelpCommand () |
virtual bool | Execute (GXemul &gxemul, const vector< string > &arguments) |
Executes the command on a given GXemul instance. More... | |
virtual string | GetShortDescription () const |
Returns a short (one-line) description of the command. More... | |
virtual string | GetLongDescription () const |
Returns a long description/help message for the command. More... | |
![]() | |
Command (const string &name, const string &argumentFormat) | |
Constructs a Command. More... | |
virtual | ~Command ()=0 |
const string & | GetCommandName () const |
Gets the name of the command. More... | |
const string & | GetArgumentFormat () const |
Gets the argument format for the command. More... | |
virtual bool | MayBeReexecutedWithoutArgs () const |
Returns whether the command can be quickly re-executed using an empty command line. More... | |
![]() | |
ReferenceCountable () | |
Default constructor, which initializes the reference count to zero. More... | |
~ReferenceCountable () | |
Additional Inherited Members | |
![]() | |
static void | RunUnitTests (int &nSucceeded, int &nFailures) |
![]() | |
static void | RunUnitTests (int &nSucceeded, int &nFailures) |
Runs unit test cases. More... | |
A Command which prints help messages for commands.
Definition at line 40 of file HelpCommand.h.
HelpCommand::HelpCommand | ( | ) |
Constructs a HelpCommand.
Definition at line 32 of file HelpCommand.cc.
|
virtual |
Definition at line 38 of file HelpCommand.cc.
|
virtual |
Executes the command on a given GXemul instance.
gxemul | A reference to the GXemul instance. |
arguments | A vector of zero or more string arguments. |
Implements Command.
Definition at line 43 of file HelpCommand.cc.
References Command::GetArgumentFormat(), GXemul::GetCommandInterpreter(), Command::GetCommandName(), CommandInterpreter::GetCommands(), Command::GetShortDescription(), GXemul::GetUI(), and UI::ShowDebugMessage().
|
virtual |
Returns a long description/help message for the command.
Implements Command.
Definition at line 158 of file HelpCommand.cc.
|
virtual |
Returns a short (one-line) description of the command.
Implements Command.
Definition at line 152 of file HelpCommand.cc.