#include </home/zeitlin/src/wx/github/interface/wx/cmdproc.h>
wxCommand is a base class for modelling an application command, which is an action usually performed by selecting a menu item, pressing a toolbar button or any other means provided by the application to change the data or view.
Public Member Functions | |
wxCommand (bool canUndo=false, const wxString &name=wxEmptyString) | |
Constructor. | |
virtual | ~wxCommand () |
Destructor. | |
virtual bool | CanUndo () const |
Returns true if the command can be undone, false otherwise. | |
virtual bool | Do ()=0 |
Override this member function to execute the appropriate action when called. | |
virtual wxString | GetName () const |
Returns the command name. | |
virtual bool | Undo ()=0 |
Override this member function to un-execute a previous Do. |
wxCommand::wxCommand | ( | bool | canUndo = false , |
const wxString & | name = wxEmptyString |
||
) |
Constructor.
wxCommand is an abstract class, so you will need to derive a new class and call this constructor from your own constructor.
canUndo | Tells the command processor whether this command is undo-able. You can achieve the same functionality by overriding the CanUndo() member function (if for example the criteria for undoability is context-dependent). |
name | Must be supplied for the command processor to display the command name in the application's edit menu. |
virtual wxCommand::~wxCommand | ( | ) | [virtual] |
Destructor.
virtual bool wxCommand::CanUndo | ( | ) | const [virtual] |
Returns true if the command can be undone, false otherwise.
virtual bool wxCommand::Do | ( | ) | [pure virtual] |
Override this member function to execute the appropriate action when called.
Implemented in wxRichTextCommand.
virtual wxString wxCommand::GetName | ( | ) | const [virtual] |
Returns the command name.
virtual bool wxCommand::Undo | ( | ) | [pure virtual] |
Override this member function to un-execute a previous Do.
How you implement this command is totally application dependent, but typical strategies include:
Implemented in wxRichTextCommand.