wxCommand

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.

Derived from

wxObject

Include files

<wx/cmdproc.h>

See also

See Overview.



wxCommand::wxCommand



wxCommand(bool canUndo = false, const wxString& name = NULL)

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.



wxCommand::~wxCommand



~wxCommand(void)

Destructor.



wxCommand::CanUndo



bool CanUndo(void)

Returns true if the command can be undone, false otherwise.



wxCommand::Do



bool Do(void)

Override this member function to execute the appropriate action when called. Return true to indicate that the action has taken place, false otherwise. Returning false will indicate to the command processor that the action is not undoable and should not be added to the command history.



wxCommand::GetName



wxString GetName(void)

Returns the command name.



wxCommand::Undo



bool Undo(void)

Override this member function to un-execute a previous Do. Return true to indicate that the action has taken place, false otherwise. Returning false will indicate to the command processor that the action is not redoable and no change should be made to the command history.

How you implement this command is totally application dependent, but typical strategies include:

The docview sample uses the first method, to remove or restore segments in the drawing.

ymasuda 平成17年11月19日