wx.Command

wx.Command 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.

See also

Command Overview

Class Hierarchy

Inheritance diagram for class Command:

Known Subclasses

wx.richtext.RichTextCommand

Methods Summary

__init__	Constructor.
CanUndo	Returns True if the command can be undone, False otherwise.
Do	Override this member function to execute the appropriate action when called.
GetName	Returns the command name.
Undo	Override this member function to un-execute a previous Do.

Properties Summary

Name	See GetName

Class API

class wx.Command(Object)

Possible constructors:

Command(canUndo=False, name="")

Command 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.

Methods

__init__(self, canUndo=False, name="")

Constructor.

wx.Command is an abstract class, so you will need to derive a new class and call this constructor from your own constructor.

Parameters:

• canUndo (bool) – 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 (string) – Must be supplied for the command processor to display the command name in the application’s edit menu.

---

CanUndo(self)

Returns True if the command can be undone, False otherwise.

Return type:

bool

---

Do(self)

Override this member function to execute the appropriate action when called.

Return type:

bool

Returns:

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.

---

GetName(self)

Returns the command name.

Return type:

string

---

Undo(self)

Override this member function to un-execute a previous Do.

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

• Perform an inverse operation on the last modified piece of data in the document. When redone, a copy of data stored in command is pasted back or some operation reapplied. This relies on the fact that you know the ordering of Undos; the user can never Undo at an arbitrary position in the command history.

• Restore the entire document state (perhaps using document transacting). Potentially very inefficient, but possibly easier to code if the user interface and data are complex, and an “inverse

  execute” operation is hard to write. The docview sample uses the first method, to remove or restore segments in the drawing.

Return type:

bool

Returns:

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.

Properties

Name

See GetName