GUICommand Class Reference

Class for the GUI command. More...

#include <GUICommand.hpp>

Inheritance diagram for GUICommand:

Collaboration diagram for GUICommand:

Public Member Functions
	GUICommand ()
int	execute (std::vector< std::string > args)
	Executes the command. More...
Public Member Functions inherited from ToolCommand
std::string	GetCommandName ()
	Retrieves the name of the command. More...
std::string	GetSyntax ()
	Retrieves the syntax of the command. More...
std::string	GetDescription ()
	Retrieves the description of the command. More...

Additional Inherited Members
Protected Attributes inherited from ToolCommand
std::string	command = ""
	The name of the command. More...
std::string	syntax = ""
	The syntax of the command. This should include the command name, as well as any arguments. More...
std::string	description = ""
	A description of the command. More...

Detailed Description

Class for the GUI command.

This command displays a simple GUI, allowing for faster/easier usage of most Tool operations from a GUI, rather than via command-line.

Note

Unlike all other commands, this command's execute method is never supposed to be called. This class is primarily intended to display the GUI command within the command list.

Constructor & Destructor Documentation

GUICommand()

GUICommand::GUICommand ( )

inline

Member Function Documentation

execute()

int GUICommand::execute ( std::vector< std::string >  args )

inlinevirtual

Executes the command.

Parameters

args	- A list of arguments provided to the command.

Returns

The command execution result. Will return 0 if the command completed successfully. If an error occurred, this will usually return a negative number.

Reimplemented from ToolCommand.

---

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

• HEKTool/components/console/commands/GUICommand.hpp