Inheritance diagram for wx.CommandEvent:
This event class contains information about command events, which originate from a variety of simple controls.
More complex controls, such as wx.TreeCtrl , have separate command event classes.
wx.BookCtrlBaseEvent, wx.ChildFocusEvent, wx.ChoicebookEvent, wx.ClipboardTextEvent, wx.CollapsiblePaneEvent, wx.ColourPickerEvent, wx.ContextMenuEvent, wx.DateEvent, wx.FileDirPickerEvent, wx.FindDialogEvent, wx.FontPickerEvent, wx.HelpEvent, wx.HyperlinkEvent, wx.ListEvent, wx.ListbookEvent, wx.NotebookEvent, wx.NotifyEvent, wx.PyCommandEvent, wx.SashEvent, wx.ScrollEvent, wx.SpinEvent, wx.SplitterEvent, wx.TextUrlEvent, wx.ToolbookEvent, wx.TreeEvent, wx.TreebookEvent, wx.UpdateUIEvent, wx.WindowCreateEvent, wx.WindowDestroyEvent
| Event Name | Description |
|---|---|
| wx.EVT_COMMAND(id, event, func) | Process a command, supplying the window identifier, command event identifier, and member function. |
| wx.EVT_COMMAND_RANGE(id1, id2, event, func) | Process a command for a range of window identifiers, supplying the minimum and maximum window identifiers, command event identifier, and member function. |
| wx.EVT_BUTTON(id, func) | Process a wx.wxEVT_COMMAND_BUTTON_CLICKED command, which is generated by a wx.Button control. |
| wx.EVT_CHECKBOX(id, func) | Process a wx.wxEVT_COMMAND_CHECKBOX_CLICKED command, which is generated by a wx.CheckBox control. |
| wx.EVT_CHOICE(id, func) | Process a wx.wxEVT_COMMAND_CHOICE_SELECTED command, which is generated by a wx.Choice control. |
| wx.EVT_COMBOBOX(id, func) | Process a wx.wxEVT_COMMAND_COMBOBOX_SELECTED command, which is generated by a wx.ComboBox control. |
| wx.EVT_LISTBOX(id, func) | Process a wx.wxEVT_COMMAND_LISTBOX_SELECTED command, which is generated by a wx.ListBox control. |
| wx.EVT_LISTBOX_DCLICK(id, func) | Process a wx.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED command, which is generated by a wx.ListBox control. |
| wx.EVT_MENU(id, func) | Process a wx.wxEVT_COMMAND_MENU_SELECTED command, which is generated by a menu item. |
| wx.EVT_MENU_RANGE(id1, id2, func) | Process a wx.wxEVT_COMMAND_MENU_RANGE command, which is generated by a range of menu items. |
| wx.EVT_CONTEXT_MENU(func) | 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. |
| wx.EVT_RADIOBOX(id, func) | Process a wx.wxEVT_COMMAND_RADIOBOX_SELECTED command, which is generated by a wx.RadioBox control. |
| wx.EVT_RADIOBUTTON(id, func) | Process a wx.wxEVT_COMMAND_RADIOBUTTON_SELECTED command, which is generated by a wx.RadioButton control. |
| wx.EVT_SCROLLBAR(id, func) | Process a wx.wxEVT_COMMAND_SCROLLBAR_UPDATED 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). |
| wx.EVT_SLIDER(id, func) | Process a wx.wxEVT_COMMAND_SLIDER_UPDATED command, which is generated by a wx.Slider control. |
| wx.EVT_TEXT(id, func) | Process a wx.wxEVT_COMMAND_TEXT_UPDATED command, which is generated by a wx.TextCtrl control. |
| wx.EVT_TEXT_ENTER(id, func) | Process a wx.wxEVT_COMMAND_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. |
| wx.EVT_TEXT_MAXLEN(id, func) | Process a wx.wxEVT_COMMAND_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 wx.TextCtrl.SetMaxLength. |
| wx.EVT_TOGGLEBUTTON(id, func) | Process a wx.wxEVT_COMMAND_TOGGLEBUTTON_CLICKED event. |
| wx.EVT_TOOL(id, func) | Process a wx.wxEVT_COMMAND_TOOL_CLICKED event (a synonym for wx.wxEVT_COMMAND_MENU_SELECTED). Pass the id of the tool. |
| wx.EVT_TOOL_RANGE(id1, id2, func) | Process a wx.wxEVT_COMMAND_TOOL_CLICKED event for a range of identifiers. Pass the ids of the tools. |
| wx.EVT_TOOL_RCLICKED(id, func) | Process a wx.wxEVT_COMMAND_TOOL_RCLICKED event. Pass the id of the tool. |
| wx.EVT_TOOL_RCLICKED_RANGE(id1, id2, func) | Process a wx.wxEVT_COMMAND_TOOL_RCLICKED event for a range of ids. Pass the ids of the tools. |
| wx.EVT_TOOL_ENTER(id, func) | Process a wx.wxEVT_COMMAND_TOOL_ENTER event. Pass the id of the toolbar itself. The value of GetSelection is the tool id, or -1 if the mouse cursor has moved off a tool. |
| wx.EVT_COMMAND_LEFT_CLICK(id, func) | Process a wx.wxEVT_COMMAND_LEFT_CLICK command, which is generated by a control (Windows 95 and NT only). |
| wx.EVT_COMMAND_LEFT_DCLICK(id, func) | Process a wx.wxEVT_COMMAND_LEFT_DCLICK command, which is generated by a control (Windows 95 and NT only). |
| wx.EVT_COMMAND_RIGHT_CLICK(id, func) | Process a wx.wxEVT_COMMAND_RIGHT_CLICK command, which is generated by a control (Windows 95 and NT only). |
| wx.EVT_COMMAND_SET_FOCUS(id, func) | Process a wx.wxEVT_COMMAND_SET_FOCUS command, which is generated by a control (Windows 95 and NT only). |
| wx.EVT_COMMAND_KILL_FOCUS(id, func) | Process a wx.wxEVT_COMMAND_KILL_FOCUS command, which is generated by a control (Windows 95 and NT only). |
| wx.EVT_COMMAND_ENTER(id, func) | Process a wx.wxEVT_COMMAND_ENTER command, which is generated by a control. |
This event class contains information about command events, which originate from a variety of simple controls, as well as menus and toolbars.
Parameters:
Returns:
Warning
This method is deprecated.
Returns client data pointer for a listbox or choice selection event (not valid for a deselection).
Returns:
int
Returns client object pointer for a listbox or choice selection event (not valid for a deselection).
Returns:
PyObject
Returns extra information dependant 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.
Returns:
long
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.
Returns:
int
Returns item index for a listbox or choice selection event (not valid for a deselection).
Returns:
int
Returns item string for a listbox or choice selection event (not valid for a deselection).
Returns:
string
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).
Returns:
bool
For a listbox or similar event, returns True if it is a selection, False if it is a deselection.
Returns:
bool
Sets the client data for this event.
Parameters:
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:
Sets the m_extraLong member.
Parameters:
Sets the m_commandInt member.
Parameters:
Sets the m_commandString member.
Parameters:
