docs/latex/wx/cmdevent.tex

   1 \section{\class{wxCommandEvent}}\label{wxcommandevent}
   2
   3 This event class contains information about command events, which originate from a variety of
   4 simple controls. More complex controls, such as \helpref{wxTreeCtrl}{wxtreectrl}, have separate command event classes.
   5
   6 \wxheading{Derived from}
   7
   8 \helpref{wxEvent}{wxevent}
   9
  10 \wxheading{Include files}
  11
  12 <wx/event.h>
  13
  14 \wxheading{Library}
  15
  16 \helpref{wxCore}{librarieslist}
  17
  18 \wxheading{Event table macros}
  19
  20 To process a menu command event, use these event handler macros to direct input to member
  21 functions that take a wxCommandEvent argument.
  22
  23 \twocolwidtha{7cm}
  24 \begin{twocollist}\itemsep=0pt
  25 \twocolitem{{\bf EVT\_COMMAND(id, event, func)}}{Process a command, supplying the window identifier,
  26 command event identifier, and member function.}
  27 \twocolitem{{\bf EVT\_COMMAND\_RANGE(id1, id2, event, func)}}{Process a command for a range
  28 of window identifiers, supplying the minimum and maximum window identifiers,
  29 command event identifier, and member function.}
  30 \twocolitem{{\bf EVT\_BUTTON(id, func)}}{Process a wxEVT\_COMMAND\_BUTTON\_CLICKED command,
  31 which is generated by a wxButton control.}
  32 \twocolitem{{\bf EVT\_CHECKBOX(id, func)}}{Process a wxEVT\_COMMAND\_CHECKBOX\_CLICKED command,
  33 which is generated by a wxCheckBox control.}
  34 \twocolitem{{\bf EVT\_CHOICE(id, func)}}{Process a wxEVT\_COMMAND\_CHOICE\_SELECTED command,
  35 which is generated by a wxChoice control.}
  36 \twocolitem{{\bf EVT\_COMBOBOX(id, func)}}{Process a wxEVT\_COMMAND\_COMBOBOX\_SELECTED command,
  37 which is generated by a wxComboBox control.}
  38 \twocolitem{{\bf EVT\_LISTBOX(id, func)}}{Process a wxEVT\_COMMAND\_LISTBOX\_SELECTED command,
  39 which is generated by a wxListBox control.}
  40 \twocolitem{{\bf EVT\_LISTBOX\_DCLICK(id, func)}}{Process a wxEVT\_COMMAND\_LISTBOX\_DOUBLECLICKED command,
  41 which is generated by a wxListBox control.}
  42 \twocolitem{{\bf EVT\_MENU(id, func)}}{Process a wxEVT\_COMMAND\_MENU\_SELECTED command,
  43 which is generated by a menu item.}
  44 \twocolitem{{\bf EVT\_MENU\_RANGE(id1, id2, func)}}{Process a wxEVT\_COMMAND\_MENU\_RANGE command,
  45 which is generated by a range of menu items.}
  46 \twocolitem{{\bf EVT\_CONTEXT\_MENU(func)}}{Process the event generated
  47 when the user has requested a popup menu to appear by pressing a special
  48 keyboard key (under Windows) or by right clicking the mouse.}
  49 \twocolitem{{\bf EVT\_RADIOBOX(id, func)}}{Process a wxEVT\_COMMAND\_RADIOBOX\_SELECTED command,
  50 which is generated by a wxRadioBox control.}
  51 \twocolitem{{\bf EVT\_RADIOBUTTON(id, func)}}{Process a wxEVT\_COMMAND\_RADIOBUTTON\_SELECTED command,
  52 which is generated by a wxRadioButton control.}
  53 \twocolitem{{\bf EVT\_SCROLLBAR(id, func)}}{Process a wxEVT\_COMMAND\_SCROLLBAR\_UPDATED command,
  54 which is generated by a wxScrollBar control. This is provided for compatibility only;
  55 more specific scrollbar event macros should be used instead (see \helpref{wxScrollEvent}{wxscrollevent}).}
  56 \twocolitem{{\bf EVT\_SLIDER(id, func)}}{Process a wxEVT\_COMMAND\_SLIDER\_UPDATED command,
  57 which is generated by a wxSlider control.}
  58 \twocolitem{{\bf EVT\_TEXT(id, func)}}{Process a wxEVT\_COMMAND\_TEXT\_UPDATED command,
  59 which is generated by a wxTextCtrl control.}
  60 \twocolitem{{\bf EVT\_TEXT\_ENTER(id, func)}}{Process a wxEVT\_COMMAND\_TEXT\_ENTER command,
  61 which is generated by a wxTextCtrl control. Note that you must use
  62 wxTE\_PROCESS\_ENTER flag when creating the control if you want it to generate
  63 such events.}
  64 \twocolitem{{\bf EVT\_TEXT\_MAXLEN(id, func)}}{Process a wxEVT\_COMMAND\_TEXT\_MAXLEN command,
  65 which is generated by a wxTextCtrl control when the user tries to enter more
  66 characters into it than the limit previously set with
  67 \helpref{SetMaxLength}{wxtextctrlsetmaxlength}.}
  68 \twocolitem{{\bf EVT\_TOGGLEBUTTON(id, func)}}{Process a wxEVT\_COMMAND\_TOGGLEBUTTON\_CLICKED event.}
  69 \twocolitem{{\bf EVT\_TOOL(id, func)}}{Process a wxEVT\_COMMAND\_TOOL\_CLICKED event
  70 (a synonym for wxEVT\_COMMAND\_MENU\_SELECTED). Pass the id of the tool.}
  71 \twocolitem{{\bf EVT\_TOOL\_RANGE(id1, id2, func)}}{Process a wxEVT\_COMMAND\_TOOL\_CLICKED event
  72 for a range of identifiers. Pass the ids of the tools.}
  73 \twocolitem{{\bf EVT\_TOOL\_RCLICKED(id, func)}}{Process a wxEVT\_COMMAND\_TOOL\_RCLICKED event.
  74 Pass the id of the tool.}
  75 \twocolitem{{\bf EVT\_TOOL\_RCLICKED\_RANGE(id1, id2, func)}}{Process a wxEVT\_COMMAND\_TOOL\_RCLICKED event
  76 for a range of ids. Pass the ids of the tools.}
  77 \twocolitem{{\bf EVT\_TOOL\_ENTER(id, func)}}{Process a wxEVT\_COMMAND\_TOOL\_ENTER event.
  78 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.}
  79 \twocolitem{{\bf EVT\_COMMAND\_LEFT\_CLICK(id, func)}}{Process a wxEVT\_COMMAND\_LEFT\_CLICK command,
  80 which is generated by a control (Windows 95 and NT only).}
  81 \twocolitem{{\bf EVT\_COMMAND\_LEFT\_DCLICK(id, func)}}{Process a wxEVT\_COMMAND\_LEFT\_DCLICK command,
  82 which is generated by a control (Windows 95 and NT only).}
  83 \twocolitem{{\bf EVT\_COMMAND\_RIGHT\_CLICK(id, func)}}{Process a wxEVT\_COMMAND\_RIGHT\_CLICK command,
  84 which is generated by a control (Windows 95 and NT only).}
  85 \twocolitem{{\bf EVT\_COMMAND\_SET\_FOCUS(id, func)}}{Process a wxEVT\_COMMAND\_SET\_FOCUS command,
  86 which is generated by a control (Windows 95 and NT only).}
  87 \twocolitem{{\bf EVT\_COMMAND\_KILL\_FOCUS(id, func)}}{Process a wxEVT\_COMMAND\_KILL\_FOCUS command,
  88 which is generated by a control (Windows 95 and NT only).}
  89 \twocolitem{{\bf EVT\_COMMAND\_ENTER(id, func)}}{Process a wxEVT\_COMMAND\_ENTER command,
  90 which is generated by a control.}
  91 \end{twocollist}%
  92
  93 \latexignore{\rtfignore{\wxheading{Members}}}
  94
  95 \membersection{wxCommandEvent::wxCommandEvent}\label{wxcommandeventctor}
  96
  97 \func{}{wxCommandEvent}{\param{WXTYPE}{ commandEventType = 0}, \param{int}{ id = 0}}
  98
  99 Constructor.
 100
 101 \membersection{wxCommandEvent::Checked}\label{wxcommandeventchecked}
 102
 103 \constfunc{bool}{Checked}{\void}
 104
 105 Deprecated, use \helpref{IsChecked}{wxcommandeventischecked} instead.
 106
 107 \membersection{wxCommandEvent::GetClientData}\label{wxcommandeventgetclientdata}
 108
 109 \func{void*}{GetClientData}{\void}
 110
 111 Returns client data pointer for a listbox or choice selection event
 112 (not valid for a deselection).
 113
 114 \membersection{wxCommandEvent::GetClientObject}\label{wxcommandeventgetclientobject}
 115
 116 \func{wxClientData *}{GetClientObject}{\void}
 117
 118 Returns client object pointer for a listbox or choice selection event
 119 (not valid for a deselection).
 120
 121 \membersection{wxCommandEvent::GetExtraLong}\label{wxcommandeventgetextralong}
 122
 123 \func{long}{GetExtraLong}{\void}
 124
 125 Returns extra information dependant on the event objects type.
 126 If the event comes from a listbox selection, it is a boolean
 127 determining whether the event was a selection (true) or a
 128 deselection (false). A listbox deselection only occurs for
 129 multiple-selection boxes, and in this case the index and string values
 130 are indeterminate and the listbox must be examined by the application.
 131
 132 \membersection{wxCommandEvent::GetInt}\label{wxcommandeventgetint}
 133
 134 \func{int}{GetInt}{\void}
 135
 136 Returns the integer identifier corresponding to a listbox, choice or
 137 radiobox selection (only if the event was a selection, not a
 138 deselection), or a boolean value representing the value of a checkbox.
 139
 140 \membersection{wxCommandEvent::GetSelection}\label{wxcommandeventgetselection}
 141
 142 \func{int}{GetSelection}{\void}
 143
 144 Returns item index for a listbox or choice selection event (not valid for
 145 a deselection).
 146
 147 \membersection{wxCommandEvent::GetString}\label{wxcommandeventgetstring}
 148
 149 \func{wxString}{GetString}{\void}
 150
 151 Returns item string for a listbox or choice selection event (not valid for
 152 a deselection).
 153
 154 \membersection{wxCommandEvent::IsChecked}\label{wxcommandeventischecked}
 155
 156 \constfunc{bool}{IsChecked}{\void}
 157
 158 This method can be used with checkbox and menu events: for the checkboxes, the
 159 method returns {\tt true} for a selection event and {\tt false} for a
 160 deselection one. For the menu events, this method indicates if the menu item
 161 just has become checked or unchecked (and thus only makes sense for checkable
 162 menu items).
 163
 164 \membersection{wxCommandEvent::IsSelection}\label{wxcommandeventisselection}
 165
 166 \func{bool}{IsSelection}{\void}
 167
 168 For a listbox or similar event, returns true if it is a selection, false if it
 169 is a deselection.
 170
 171 \membersection{wxCommandEvent::SetClientData}\label{wxcommandeventsetclientdata}
 172
 173 \func{void}{SetClientData}{\param{void*}{ clientData}}
 174
 175 Sets the client data for this event.
 176
 177 \membersection{wxCommandEvent::SetClientObject}\label{wxcommandeventsetclientobject}
 178
 179 \func{void}{SetClientObject}{\param{wxClientData*}{ clientObject}}
 180
 181 Sets the client object for this event. The client object is \emph{not} owned by the event
 182 object and the event object will not delete the client object in its destructor.
 183 The client object must be owned and deleted by another object (e.g. a control)
 184 that has longer life time than the event object.
 185
 186 \membersection{wxCommandEvent::SetExtraLong}\label{wxcommandeventsetextralong}
 187
 188 \func{void}{SetExtraLong}{\param{long}{ extraLong}}
 189
 190 Sets the {\bf m\_extraLong} member.
 191
 192 \membersection{wxCommandEvent::SetInt}\label{wxcommandeventsetint}
 193
 194 \func{void}{SetInt}{\param{int}{ intCommand}}
 195
 196 Sets the {\bf m\_commandInt} member.
 197
 198 \membersection{wxCommandEvent::SetString}\label{wxcommandeventsetstring}
 199
 200 \func{void}{SetString}{\param{const wxString\&}{ string}}
 201
 202 Sets the {\bf m\_commandString} member.
 203