RunToggleFunctionCommand Class Reference

Inheritance diagram for RunToggleFunctionCommand:

Collaboration diagram for RunToggleFunctionCommand:

Public Member Functions
void	Execute () override
	Executes this command.
void	Undo () override
	Undoes the command if it is undoable.
bool	Combine (ICommand *&other) override
	Does not combine the commands.
std::string	GetName () const override
	Returns the name of this command.
	RunToggleFunctionCommand (const std::string &name, std::function< void()> function)
	Instantiates a command that runs the given function once the command is executed.
Public Member Functions inherited from ICommand
bool	Undoable () const
	Returns whether the command is undoable.
bool	Trackable () const
	Returns whether the command is trackable (ie. should be stored in ActionStack)

Protected Attributes
std::function< void()>	mFunction = nullptr
std::string	mName = ""
Protected Attributes inherited from ICommand
bool	mCanBeUndone = true
bool	mTrackable = true

Constructor & Destructor Documentation

RunToggleFunctionCommand()

RunToggleFunctionCommand::RunToggleFunctionCommand ( const std::string &  name, std::function< void()>  function  )

inlineexplicit

Instantiates a command that runs the given function once the command is executed.

Member Function Documentation

Combine()

bool RunToggleFunctionCommand::Combine ( ICommand *&  other )

inlineoverridevirtual

Does not combine the commands.

Parameters

other

Other command to combine with

Returns

Whether the commands were combined

Implements ICommand.

Execute()

void RunToggleFunctionCommand::Execute ( )

inlineoverridevirtual

Executes this command.

Implements ICommand.

GetName()

std::string RunToggleFunctionCommand::GetName ( ) const

inlineoverridevirtual

Returns the name of this command.

Returns

Implements ICommand.

Undo()

void RunToggleFunctionCommand::Undo ( )

inlineoverridevirtual

Undoes the command if it is undoable.

Implements ICommand.

Member Data Documentation

mFunction

std::function<void()> RunToggleFunctionCommand::mFunction = nullptr

protected

mName

std::string RunToggleFunctionCommand::mName = ""

protected