Contents Up Previous Next

wxCommandEvent

This event class contains information about command events, which originate from a variety of simple controls. More complex controls, such as wxTreeCtrl, have separate command event classes.

Derived from

wxEvent

Include files

<wx/event.h>

Event table macros

To process a menu command event, use these event handler macros to direct input to member functions that take a wxCommandEvent argument.

EVT_COMMAND(id, event, func) Process a command, supplying the window identifier, command event identifier, and member function.
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.
EVT_BUTTON(id, func) Process a wxEVT_COMMAND_BUTTON_CLICKED command, which is generated by a wxButton control.
EVT_CHECKBOX(id, func) Process a wxEVT_COMMAND_CHECKBOX_CLICKED command, which is generated by a wxCheckBox control.
EVT_CHOICE(id, func) Process a wxEVT_COMMAND_CHOICE_SELECTED command, which is generated by a wxChoice control.
EVT_LISTBOX(id, func) Process a wxEVT_COMMAND_LISTBOX_SELECTED command, which is generated by a wxListBox control.
EVT_LISTBOX_DCLICK(id, func) Process a wxEVT_COMMAND_LISTBOX_DOUBLECLICKED command, which is generated by a wxListBox control.
EVT_TEXT(id, func) Process a wxEVT_COMMAND_TEXT_UPDATED command, which is generated by a wxTextCtrl control.
EVT_TEXT_ENTER(id, func) Process a wxEVT_COMMAND_TEXT_ENTER command, which is generated by a wxTextCtrl control. Note that you must use wxTE_PROCESS_ENTER flag when creating the control if you want it to generate such events.
EVT_MENU(id, func) Process a wxEVT_COMMAND_MENU_SELECTED command, which is generated by a menu item.
EVT_MENU_RANGE(id1, id2, func) Process a wxEVT_COMMAND_MENU_RANGE command, which is generated by a range of menu items.
EVT_SLIDER(id, func) Process a wxEVT_COMMAND_SLIDER_UPDATED command, which is generated by a wxSlider control.
EVT_RADIOBOX(id, func) Process a wxEVT_COMMAND_RADIOBOX_SELECTED command, which is generated by a wxRadioBox control.
EVT_RADIOBUTTON(id, func) Process a wxEVT_COMMAND_RADIOBUTTON_SELECTED command, which is generated by a wxRadioButton control.
EVT_SCROLLBAR(id, func) Process a wxEVT_COMMAND_SCROLLBAR_UPDATED command, which is generated by a wxScrollBar control. This is provided for compatibility only; more specific scrollbar event macros should be used instead (see wxScrollEvent).
EVT_COMBOBOX(id, func) Process a wxEVT_COMMAND_COMBOBOX_SELECTED command, which is generated by a wxComboBox control.
EVT_TOOL(id, func) Process a wxEVT_COMMAND_TOOL_CLICKED event (a synonym for wxEVT_COMMAND_MENU_SELECTED). Pass the id of the tool.
EVT_TOOL_RANGE(id1, id2, func) Process a wxEVT_COMMAND_TOOL_CLICKED event for a range id identifiers. Pass the ids of the tools.
EVT_TOOL_RCLICKED(id, func) Process a wxEVT_COMMAND_TOOL_RCLICKED event. Pass the id of the tool.
EVT_TOOL_RCLICKED_RANGE(id1, id2, func) Process a wxEVT_COMMAND_TOOL_RCLICKED event for a range of ids. Pass the ids of the tools.
EVT_TOOL_ENTER(id, func) Process a wxEVT_COMMAND_TOOL_ENTER event. Pass the id of the toolbar itself. The value of wxCommandEvent::GetSelection is the tool id, or -1 if the mouse cursor has moved off a tool.
EVT_COMMAND_LEFT_CLICK(id, func) Process a wxEVT_COMMAND_LEFT_CLICK command, which is generated by a control (Windows 95 and NT only).
EVT_COMMAND_LEFT_DCLICK(id, func) Process a wxEVT_COMMAND_LEFT_DCLICK command, which is generated by a control (Windows 95 and NT only).
EVT_COMMAND_RIGHT_CLICK(id, func) Process a wxEVT_COMMAND_RIGHT_CLICK command, which is generated by a control (Windows 95 and NT only).
EVT_COMMAND_SET_FOCUS(id, func) Process a wxEVT_COMMAND_SET_FOCUS command, which is generated by a control (Windows 95 and NT only).
EVT_COMMAND_KILL_FOCUS(id, func) Process a wxEVT_COMMAND_KILL_FOCUS command, which is generated by a control (Windows 95 and NT only).
EVT_COMMAND_ENTER(id, func) Process a wxEVT_COMMAND_ENTER command, which is generated by a control.
Members

wxCommandEvent::m_clientData
wxCommandEvent::m_commandInt
wxCommandEvent::m_commandString
wxCommandEvent::m_extraLong
wxCommandEvent::wxCommandEvent
wxCommandEvent::Checked
wxCommandEvent::GetClientData
wxCommandEvent::GetExtraLong
wxCommandEvent::GetInt
wxCommandEvent::GetSelection
wxCommandEvent::GetString
wxCommandEvent::IsChecked
wxCommandEvent::IsSelection
wxCommandEvent::SetClientData
wxCommandEvent::SetExtraLong
wxCommandEvent::SetInt
wxCommandEvent::SetString


wxCommandEvent::m_clientData

void* m_clientData

Contains a pointer to client data for listboxes and choices, if the event was a selection. Beware, this is not implemented anyway...


wxCommandEvent::m_commandInt

int m_commandInt

Contains an 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.


wxCommandEvent::m_commandString

char* m_commandString

Contains a string corresponding to a listbox or choice selection.


wxCommandEvent::m_extraLong

long m_extraLong

Extra information. 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.


wxCommandEvent::wxCommandEvent

wxCommandEvent(WXTYPE commandEventType = 0, int id = 0)

Constructor.


wxCommandEvent::Checked

bool Checked() const

Deprecated, use IsChecked instead.


wxCommandEvent::GetClientData

void* GetClientData()

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


wxCommandEvent::GetExtraLong

long GetExtraLong()

Returns the m_extraLong member.


wxCommandEvent::GetInt

int GetInt()

Returns the m_commandInt member.


wxCommandEvent::GetSelection

int GetSelection()

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


wxCommandEvent::GetString

char* GetString()

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


wxCommandEvent::IsChecked

bool IsChecked() const

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


wxCommandEvent::IsSelection

bool IsSelection()

For a listbox or choice event, returns TRUE if it is a selection, FALSE if it is a deselection.


wxCommandEvent::SetClientData

void SetClientData(void* clientData)

Sets the client data for this event.


wxCommandEvent::SetExtraLong

void SetExtraLong(int extraLong)

Sets the m_extraLong member.


wxCommandEvent::SetInt

void SetInt(int intCommand)

Sets the m_commandInt member.


wxCommandEvent::SetString

void SetString(char* string)

Sets the m_commandString member.