wx.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 wx.TreeCtrl, have separate command event classes.

Events Emitted by this Class¶

Handlers bound for the following event types will receive a wx.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_BUTTON command, which is generated by a wx.Button control.
EVT_CHECKBOX: Process a wxEVT_CHECKBOX command, which is generated by a wx.CheckBox control.
EVT_CHOICE: Process a wxEVT_CHOICE command, which is generated by a wx.Choice control.
EVT_COMBOBOX: Process a wxEVT_COMBOBOX command, which is generated by a wx.ComboBox control.
EVT_LISTBOX: Process a wxEVT_LISTBOX command, which is generated by a wx.ListBox control.
EVT_LISTBOX_DCLICK: Process a wxEVT_LISTBOX_DCLICK command, which is generated by a wx.ListBox control.
EVT_CHECKLISTBOX: Process a wxEVT_CHECKLISTBOX command, which is generated by a wx.CheckListBox control.
EVT_MENU: Process a wxEVT_MENU command, which is generated by a menu item.
EVT_MENU_RANGE: Process a wxEVT_MENU 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_RADIOBOX command, which is generated by a wx.RadioBox control.
EVT_RADIOBUTTON: Process a wxEVT_RADIOBUTTON command, which is generated by a wx.RadioButton control.
EVT_SCROLLBAR: Process a wxEVT_SCROLLBAR command, which is generated by a wx.ScrollBar control. This is provided for compatibility only; more specific scrollbar event macros should be used instead (see wx.ScrollEvent).
EVT_SLIDER: Process a wxEVT_SLIDER command, which is generated by a wx.Slider control.
EVT_TEXT: Process a wxEVT_TEXT command, which is generated by a wx.TextCtrl control.
EVT_TEXT_ENTER: Process a wxEVT_TEXT_ENTER command, which is generated by a wx.TextCtrl control. Note that you must use wx.TE_PROCESS_ENTER flag when creating the control if you want it to generate such events.
EVT_TEXT_MAXLEN: Process a wxEVT_TEXT_MAXLEN command, which is generated by a wx.TextCtrl control when the user tries to enter more characters into it than the limit previously set with SetMaxLength().
EVT_TOGGLEBUTTON: Process a wxEVT_TOGGLEBUTTON event.
EVT_TOOL: Process a wxEVT_TOOL event (a synonym for wxEVT_MENU ). Pass the id of the tool.
EVT_TOOL_RANGE: Process a wxEVT_TOOL event for a range of identifiers. Pass the ids of the tools.
EVT_TOOL_RCLICKED: Process a wxEVT_TOOL_RCLICKED event. Pass the id of the tool. (Not available on wxOSX.)
EVT_TOOL_RCLICKED_RANGE: Process a wxEVT_TOOL_RCLICKED event for a range of ids. Pass the ids of the tools. (Not available on wxOSX.)
EVT_TOOL_ENTER: Process a wxEVT_TOOL_ENTER event. Pass the id of the toolbar itself. The value of wx.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.

Class Hierarchy¶

Inheritance diagram for class CommandEvent:

Known Subclasses¶

ActiveXEvent , wx.ChildFocusEvent, wx.ClipboardTextEvent, wx.CollapsiblePaneEvent, wx.ColourPickerEvent, wx.ContextMenuEvent, wx.adv.DateEvent, wx.FileCtrlEvent, wx.FileDirPickerEvent, wx.FindDialogEvent, wx.FontPickerEvent, wx.grid.GridEditorCreatedEvent, wx.HelpEvent, wx.html.HtmlCellEvent, wx.html.HtmlLinkEvent, wx.adv.HyperlinkEvent, wx.NotifyEvent, wx.propgrid.PropertyGridEvent, wx.ribbon.RibbonButtonBarEvent, wx.ribbon.RibbonGalleryEvent, wx.ribbon.RibbonPanelEvent, wx.ribbon.RibbonToolBarEvent, wx.adv.SashEvent, wx.ScrollEvent, wx.stc.StyledTextEvent, wx.TextUrlEvent, wx.UpdateUIEvent, wx.webkit.WebKitBeforeLoadEvent, wx.webkit.WebKitNewWindowEvent, wx.webkit.WebKitStateChangedEvent, wx.WindowCreateEvent, wx.WindowDestroyEvent, wx.WindowModalDialogEvent

Methods Summary¶

`__init__`	Constructor.
`GetClientData`	Returns client object pointer for a listbox or choice selection event (not valid for a deselection).
`GetClientObject`	Alias for `GetClientData`
`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.
`SetClientData`	Sets the client object for this event.
`SetClientObject`	Alias for `SetClientData`
`SetExtraLong`	Sets the m_extraLong member.
`SetInt`	Sets the m_commandInt member.
`SetString`	Sets the m_commandString member.

Properties Summary¶

`ClientData`	See `GetClientData` and `SetClientData`
`ExtraLong`	See `GetExtraLong` and `SetExtraLong`
`Int`	See `GetInt` and `SetInt`
`Selection`	See `GetSelection`
`String`	See `GetString` and `SetString`

Class API¶

class wx.CommandEvent(Event)¶

Possible constructors:

CommandEvent(commandEventType=wxEVT_NULL, id=0)

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

Methods¶

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

Constructor.

Parameters:	commandEventType (wx.EventType) – id (int) –

GetClientData(self)¶

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

Return type:	`ClientData`

GetClientObject(self)¶: Alias for GetClientData

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

SetClientData(self, data)¶

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:	data (ClientData) –

SetClientObject(self, data)¶: Alias for SetClientData

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¶

ClientData¶: See GetClientData and SetClientData

ExtraLong¶: See GetExtraLong and SetExtraLong

Int¶: See GetInt and SetInt

Selection¶: See GetSelection

String¶: See GetString and SetString

Navigation