CommandEvent

This event class contains information about command events, which originate from a variety of simple controls.

Note that CommandEvents and CommandEvent-derived event classes by default and unlike other Event-derived classes propagate upward from the source window (the window which emits the event) up to the first parent which processes the event. Be sure to read How Events Propagate Upwards.

More complex controls, such as TreeCtrl, have separate command event classes.

Events Emitted by this Class

Handlers bound for the following event types will receive a CommandEvent parameter.

• EVT_COMMAND: Process a command, supplying the window identifier, command event identifier, and member function.
• EVT_COMMAND_RANGE: Process a command for a range of window identifiers, supplying the minimum and maximum window identifiers, command event identifier, and member function.
• EVT_BUTTON: Process a wxEVT_COMMAND_BUTTON_CLICKED command, which is generated by a Button control.
• EVT_CHECKBOX: Process a wxEVT_COMMAND_CHECKBOX_CLICKED command, which is generated by a CheckBox control.
• EVT_CHOICE: Process a wxEVT_COMMAND_CHOICE_SELECTED command, which is generated by a Choice control.
• EVT_COMBOBOX: Process a wxEVT_COMMAND_COMBOBOX_SELECTED command, which is generated by a ComboBox control.
• EVT_LISTBOX: Process a wxEVT_COMMAND_LISTBOX_SELECTED command, which is generated by a ListBox control.
• EVT_LISTBOX_DCLICK: Process a wxEVT_COMMAND_LISTBOX_DOUBLECLICKED command, which is generated by a ListBox control.
• EVT_CHECKLISTBOX: Process a wxEVT_COMMAND_CHECKLISTBOX_TOGGLED command, which is generated by a CheckListBox control.
• EVT_MENU: Process a wxEVT_COMMAND_MENU_SELECTED command, which is generated by a menu item.
• EVT_MENU_RANGE: Process a wxEVT_COMMAND_MENU_RANGE command, which is generated by a range of menu items.
• EVT_CONTEXT_MENU: Process the event generated when the user has requested a popup menu to appear by pressing a special keyboard key (under Windows) or by right clicking the mouse.
• EVT_RADIOBOX: Process a wxEVT_COMMAND_RADIOBOX_SELECTED command, which is generated by a RadioBox control.
• EVT_RADIOBUTTON: Process a wxEVT_COMMAND_RADIOBUTTON_SELECTED command, which is generated by a RadioButton control.
• EVT_SCROLLBAR: Process a wxEVT_COMMAND_SCROLLBAR_UPDATED command, which is generated by a ScrollBar control. This is provided for compatibility only; more specific scrollbar event macros should be used instead (see ScrollEvent).
• EVT_SLIDER: Process a wxEVT_COMMAND_SLIDER_UPDATED command, which is generated by a Slider control.
• EVT_TEXT: Process a wxEVT_COMMAND_TEXT_UPDATED command, which is generated by a TextCtrl control.
• EVT_TEXT_ENTER: Process a wxEVT_COMMAND_TEXT_ENTER command, which is generated by a TextCtrl control. Note that you must use TE_PROCESS_ENTER flag when creating the control if you want it to generate such events.
• EVT_TEXT_MAXLEN: Process a wxEVT_COMMAND_TEXT_MAXLEN command, which is generated by a TextCtrl control when the user tries to enter more characters into it than the limit previously set with SetMaxLength().
• EVT_TOGGLEBUTTON: Process a wxEVT_COMMAND_TOGGLEBUTTON_CLICKED event.
• EVT_TOOL: Process a wxEVT_COMMAND_TOOL_CLICKED event (a synonym for wxEVT_COMMAND_MENU_SELECTED ). Pass the id of the tool.
• EVT_TOOL_RANGE: Process a wxEVT_COMMAND_TOOL_CLICKED event for a range of identifiers. Pass the ids of the tools.
• EVT_TOOL_RCLICKED: Process a wxEVT_COMMAND_TOOL_RCLICKED event. Pass the id of the tool. (Not available on wxOSX.)
• EVT_TOOL_RCLICKED_RANGE: Process a wxEVT_COMMAND_TOOL_RCLICKED event for a range of ids. Pass the ids of the tools. (Not available on wxOSX.)
• EVT_TOOL_ENTER: Process a wxEVT_COMMAND_TOOL_ENTER event. Pass the id of the toolbar itself. The value of CommandEvent.GetSelection is the tool id, or -1 if the mouse cursor has moved off a tool. (Not available on wxOSX.)
• EVT_COMMAND_LEFT_CLICK: Process a wxEVT_COMMAND_LEFT_CLICK command, which is generated by a control (wxMSW only).
• EVT_COMMAND_LEFT_DCLICK: Process a wxEVT_COMMAND_LEFT_DCLICK command, which is generated by a control (wxMSW only).
• EVT_COMMAND_RIGHT_CLICK: Process a wxEVT_COMMAND_RIGHT_CLICK command, which is generated by a control (wxMSW only).
• EVT_COMMAND_SET_FOCUS: Process a wxEVT_COMMAND_SET_FOCUS command, which is generated by a control (wxMSW only).
• EVT_COMMAND_KILL_FOCUS: Process a wxEVT_COMMAND_KILL_FOCUS command, which is generated by a control (wxMSW only).
• EVT_COMMAND_ENTER: Process a wxEVT_COMMAND_ENTER command, which is generated by a control.

Inheritance Diagram

Inheritance diagram for class CommandEvent

Known Subclasses

ActiveXEvent, ChildFocusEvent, ClipboardTextEvent, CollapsiblePaneEvent, ColourPickerEvent, ContextMenuEvent, DateEvent, FileCtrlEvent, FileDirPickerEvent, FindDialogEvent, FontPickerEvent, GridEditorCreatedEvent, HelpEvent, HtmlCellEvent, HtmlLinkEvent, HyperlinkEvent, NotifyEvent, PropertyGridEvent, RibbonButtonBarEvent, RibbonGalleryEvent, SashEvent, ScrollEvent, StyledTextEvent, UpdateUIEvent, WindowCreateEvent, WindowDestroyEvent, WindowModalDialogEvent

Methods Summary

__init__	Constructor.
GetClientObject	Returns client object pointer for a listbox or choice selection event (not valid for a deselection).
GetExtraLong	Returns extra information dependent on the event objects type.
GetInt	Returns the integer identifier corresponding to a listbox, choice or radiobox selection (only if the event was a selection, not a deselection), or a boolean value representing the value of a checkbox.
GetSelection	Returns item index for a listbox or choice selection event (not valid for a deselection).
GetString	Returns item string for a listbox or choice selection event.
IsChecked	This method can be used with checkbox and menu events: for the checkboxes, the method returns True for a selection event and False for a deselection one.
IsSelection	For a listbox or similar event, returns True if it is a selection, False if it is a deselection.
SetClientObject	Sets the client object for this event.
SetExtraLong	Sets the m_extraLong member.
SetInt	Sets the m_commandInt member.
SetString	Sets the m_commandString member.

Properties Summary

ClientObject	See GetClientObject and SetClientObject
ExtraLong	See GetExtraLong and SetExtraLong
Int	See GetInt and SetInt
Selection	See GetSelection
String	See GetString and SetString

Class API

---

class CommandEvent(Event)

This event class contains information about command events, which originate from a variety of simple controls.

Possible constructors:

CommandEvent(commandEventType=wxEVT_NULL, id=0)

Methods

---

__init__(self, commandEventType=wxEVT_NULL, id=0)

Constructor.

Parameters:

• commandEventType (EventType) –
• id (int) –

---

GetClientObject(self)

Returns client object pointer for a listbox or choice selection event (not valid for a deselection).

Return type:ClientData

---

GetExtraLong(self)

Returns extra information dependent on the event objects type.

If the event comes from a listbox selection, it is a boolean determining whether the event was a selection (True) or a deselection (False). A listbox deselection only occurs for multiple-selection boxes, and in this case the index and string values are indeterminate and the listbox must be examined by the application.

Return type:long

---

GetInt(self)

Returns the integer identifier corresponding to a listbox, choice or radiobox selection (only if the event was a selection, not a deselection), or a boolean value representing the value of a checkbox.

For a menu item, this method returns -1 if the item is not checkable or a boolean value (True or False) for checkable items indicating the new state of the item.

Return type:int

---

GetSelection(self)

Returns item index for a listbox or choice selection event (not valid for a deselection).

Return type:int

---

GetString(self)

Returns item string for a listbox or choice selection event.

If one or several items have been deselected, returns the index of the first deselected item. If some items have been selected and others deselected at the same time, it will return the index of the first selected item.

Return type:string

---

IsChecked(self)

This method can be used with checkbox and menu events: for the checkboxes, the method returns True for a selection event and False for a deselection one.

For the menu events, this method indicates if the menu item just has become checked or unchecked (and thus only makes sense for checkable menu items).

Notice that this method cannot be used with CheckListBox currently.

Return type:bool

---

IsSelection(self)

For a listbox or similar event, returns True if it is a selection, False if it is a deselection.

If some items have been selected and others deselected at the same time, it will return True.

Return type:bool

---

SetClientObject(self, clientObject)

Sets the client object for this event.

The client object is not owned by the event object and the event object will not delete the client object in its destructor.

The client object must be owned and deleted by another object (e.g. a control) that has longer life time than the event object.

Parameters:clientObject (ClientData) –

---

SetExtraLong(self, extraLong)

Sets the m_extraLong member.

Parameters:extraLong (long) –

---

SetInt(self, intCommand)

Sets the m_commandInt member.

Parameters:intCommand (int) –

---

SetString(self, string)

Sets the m_commandString member.

Parameters:string (string) –

Properties

---

ClientObject

See GetClientObject and SetClientObject

---

ExtraLong

See GetExtraLong and SetExtraLong

---

Int

See GetInt and SetInt

---

Selection

See GetSelection

---

String

See GetString and SetString