*************** wx.CommandEvent *************** Inheritance diagram for `wx.CommandEvent`: | .. inheritance-diagram:: wx.CommandEvent | Description =========== This event class contains information about command events, which originate from a variety of simple controls. More complex controls, such as `wx.TreeCtrl <../Widgets/wx.TreeCtrl.html>`_ , have separate command event classes. Derived From ^^^^^^^^^^^^^ * `wx.Event `_ Known Subclasses ^^^^^^^^^^^^^^^^ `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 Handling ^^^^^^^^^^^^^^ ================================================================== ================================================== 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 <../Widgets/wx.Button.html>`_ control. wx.EVT_CHECKBOX(id, func) Process a ``wx.wxEVT_COMMAND_CHECKBOX_CLICKED`` command, which is generated by a `wx.CheckBox <../Widgets/wx.CheckBox.html>`_ control. wx.EVT_CHOICE(id, func) Process a ``wx.wxEVT_COMMAND_CHOICE_SELECTED`` command, which is generated by a `wx.Choice <../Widgets/wx.Choice.html>`_ control. wx.EVT_COMBOBOX(id, func) Process a ``wx.wxEVT_COMMAND_COMBOBOX_SELECTED`` command, which is generated by a `wx.ComboBox <../Widgets/wx.ComboBox.html>`_ control. wx.EVT_LISTBOX(id, func) Process a ``wx.wxEVT_COMMAND_LISTBOX_SELECTED`` command, which is generated by a `wx.ListBox <../Widgets/wx.ListBox.html>`_ control. wx.EVT_LISTBOX_DCLICK(id, func) Process a ``wx.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED`` command, which is generated by a `wx.ListBox <../Widgets/wx.ListBox.html>`_ 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 <../Widgets/wx.RadioBox.html>`_ control. wx.EVT_RADIOBUTTON(id, func) Process a ``wx.wxEVT_COMMAND_RADIOBUTTON_SELECTED`` command, which is generated by a `wx.RadioButton <../Widgets/wx.RadioButton.html>`_ control. wx.EVT_SCROLLBAR(id, func) Process a ``wx.wxEVT_COMMAND_SCROLLBAR_UPDATED`` command, which is generated by a `wx.ScrollBar <../Widgets/wx.ScrollBar.html>`_ 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 <../Widgets/wx.Slider.html>`_ control. wx.EVT_TEXT(id, func) Process a ``wx.wxEVT_COMMAND_TEXT_UPDATED`` command, which is generated by a `wx.TextCtrl <../Widgets/wx.TextCtrl.html>`_ control. wx.EVT_TEXT_ENTER(id, func) Process a ``wx.wxEVT_COMMAND_TEXT_ENTER`` command, which is generated by a `wx.TextCtrl <../Widgets/wx.TextCtrl.html>`_ 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 <../Widgets/wx.TextCtrl.html>`_ control when the user tries to enter more characters into it than the limit previously set with `wx.TextCtrl.SetMaxLength <../Widgets/wx.TextCtrl.html#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 <#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. ================================================================== ================================================== Methods Summary ^^^^^^^^^^^^^^^ * `__init__ <#__init__>`_ * `Checked <#Checked>`_ * `GetClientData <#GetClientData>`_ * `GetClientObject <#GetClientObject>`_ * `GetExtraLong <#GetExtraLong>`_ * `GetInt <#GetInt>`_ * `GetSelection <#GetSelection>`_ * `GetString <#GetString>`_ * `IsChecked <#IsChecked>`_ * `IsSelection <#IsSelection>`_ * `SetClientData <#SetClientData>`_ * `SetClientObject <#SetClientObject>`_ * `SetExtraLong <#SetExtraLong>`_ * `SetInt <#SetInt>`_ * `SetString <#SetString>`_ Properties Summary ^^^^^^^^^^^^^^^^^^ * `ClientData <#ClientData>`_ * `ClientObject <#ClientObject>`_ * `ExtraLong <#ExtraLong>`_ * `Int <#Int>`_ * `Selection <#Selection>`_ * `String <#String>`_ Class API ========= Methods ^^^^^^^ .. method:: __init__(commandType=wx.wxEVT_NULL, winid=0) This event class contains information about command events, which originate from a variety of simple controls, as well as menus and toolbars. **Parameters:** * `commandType` (eventtype) * `winid` (int) | **Returns:** `wx.CommandEvent `_ -------- .. method:: Checked() Deprecated, use `IsChecked <#IsChecked>`_ instead. | **Returns:** `bool` .. warning:: This method is deprecated. -------- .. method:: GetClientData() Returns client data pointer for a listbox or choice selection event (not valid for a deselection). | **Returns:** `int` -------- .. method:: GetClientObject() Returns client object pointer for a listbox or choice selection event (not valid for a deselection). | **Returns:** `PyObject` -------- .. method:: GetExtraLong() 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` -------- .. method:: 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. | **Returns:** `int` -------- .. method:: GetSelection() Returns item index for a listbox or choice selection event (not valid for a deselection). | **Returns:** `int` -------- .. method:: GetString() Returns item string for a listbox or choice selection event (not valid for a deselection). | **Returns:** `string` -------- .. method:: 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. 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` -------- .. method:: IsSelection() For a listbox or similar event, returns ``True`` if it is a selection, ``False`` if it is a deselection. | **Returns:** `bool` -------- .. method:: SetClientData(clientData) Sets the client data for this event. **Parameters:** * `clientData` (int) -------- .. method:: SetClientObject(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` (PyObject) -------- .. method:: SetExtraLong(extraLong) Sets the `m_extraLong` member. **Parameters:** * `extraLong` (long) -------- .. method:: SetInt(intCommand) Sets the `m_commandInt` member. **Parameters:** * `intCommand` (int) -------- .. method:: SetString(string) Sets the `m_commandString` member. **Parameters:** * `string` (string) -------- Properties ^^^^^^^^^^ .. attribute:: ClientData See `GetClientData <#GetClientData>`_ and `SetClientData <#SetClientData>`_ .. attribute:: ClientObject See `GetClientObject <#GetClientObject>`_ and `SetClientObject <#SetClientObject>`_ .. attribute:: ExtraLong See `GetExtraLong <#GetExtraLong>`_ and `SetExtraLong <#SetExtraLong>`_ .. attribute:: Int See `GetInt <#GetInt>`_ and `SetInt <#SetInt>`_ .. attribute:: Selection See `GetSelection <#GetSelection>`_ .. attribute:: String See `GetString <#GetString>`_ and `SetString <#SetString>`_