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{Event table macros}
  11
  12 To process a menu command event, use these event handler macros to direct input to member
  13 functions that take a wxCommandEvent argument.
  14
  15 \twocolwidtha{7cm}
  16 \begin{twocollist}\itemsep=0pt
  17 \twocolitem{{\bf EVT\_COMMAND(id, event, func)}}{Process a command, supplying the window identifier,
  18 command event identifier, and member function.}
  19 \twocolitem{{\bf EVT\_COMMAND\_RANGE(id1, id2, event, func)}}{Process a command for a range
  20 of window identifiers, supplying the minimum and maximum window identifiers,
  21 command event identifier, and member function.}
  22 \twocolitem{{\bf EVT\_BUTTON(id, func)}}{Process a wxEVT\_COMMAND\_BUTTON\_CLICKED command,
  23 which is generated by a wxButton control.}
  24 \twocolitem{{\bf EVT\_CHECKBOX(id, func)}}{Process a wxEVT\_COMMAND\_CHECKBOX\_CLICKED command,
  25 which is generated by a wxCheckBox control.}
  26 \twocolitem{{\bf EVT\_CHOICE(id, func)}}{Process a wxEVT\_COMMAND\_CHOICE\_SELECTED command,
  27 which is generated by a wxChoice control.}
  28 \twocolitem{{\bf EVT\_LISTBOX(id, func)}}{Process a wxEVT\_COMMAND\_LISTBOX\_SELECTED command,
  29 which is generated by a wxListBox control.}
  30 \twocolitem{{\bf EVT\_LISTBOX\_DCLICK(id, func)}}{Process a wxEVT\_COMMAND\_LISTBOX\_DOUBLECLICKED command,
  31 which is generated by a wxListBox control.}
  32 \twocolitem{{\bf EVT\_TEXT(id, func)}}{Process a wxEVT\_COMMAND\_TEXT\_UPDATED command,
  33 which is generated by a wxTextCtrl control.}
  34 \twocolitem{{\bf EVT\_TEXT\_ENTER(id, func)}}{Process a wxEVT\_COMMAND\_TEXT\_ENTER command,
  35 which is generated by a wxTextCtrl control.}
  36 \twocolitem{{\bf EVT\_MENU(id, func)}}{Process a wxEVT\_COMMAND\_MENU\_SELECTED command,
  37 which is generated by a menu item.}
  38 \twocolitem{{\bf EVT\_MENU\_RANGE(id1, id2, func)}}{Process a wxEVT\_COMMAND\_MENU\_RANGE command,
  39 which is generated by a range of menu items.}
  40 \twocolitem{{\bf EVT\_SLIDER(id, func)}}{Process a wxEVT\_COMMAND\_SLIDER\_UPDATED command,
  41 which is generated by a wxSlider control.}
  42 \twocolitem{{\bf EVT\_RADIOBOX(id, func)}}{Process a wxEVT\_COMMAND\_RADIOBOX\_SELECTED command,
  43 which is generated by a wxRadioBox control.}
  44 \twocolitem{{\bf EVT\_RADIOBUTTON(id, func)}}{Process a wxEVT\_COMMAND\_RADIOBUTTON\_SELECTED command,
  45 which is generated by a wxRadioButton control.}
  46 \twocolitem{{\bf EVT\_SCROLLBAR(id, func)}}{Process a wxEVT\_COMMAND\_SCROLLBAR\_UPDATED command,
  47 which is generated by a wxScrollBar control. This is provided for compatibility only;
  48 more specific scrollbar event macros should be used instead (see \helpref{wxScrollEvent}{wxscrollevent}).}
  49 \twocolitem{{\bf EVT\_COMBOBOX(id, func)}}{Process a wxEVT\_COMMAND\_COMBOBOX\_SELECTED command,
  50 which is generated by a wxComboBox control.}
  51 \twocolitem{{\bf EVT\_TOOL(id, func)}}{Process a wxEVT\_COMMAND\_TOOL\_CLICKED event
  52 (a synonym for wxEVT\_COMMAND\_MENU\_SELECTED). Pass the id of the tool.}
  53 \twocolitem{{\bf EVT\_TOOL\_RANGE(id1, id2, func)}}{Process a wxEVT\_COMMAND\_TOOL\_CLICKED event
  54 for a range id identifiers. Pass the ids of the tools.}
  55 \twocolitem{{\bf EVT\_TOOL\_RCLICKED(id, func)}}{Process a wxEVT\_COMMAND\_TOOL\_RCLICKED event.
  56 Pass the id of the tool.}
  57 \twocolitem{{\bf EVT\_TOOL\_RCLICKED\_RANGE(id1, id2, func)}}{Process a wxEVT\_COMMAND\_TOOL\_RCLICKED event
  58 for a range of ids. Pass the ids of the tools.}
  59 \twocolitem{{\bf EVT\_TOOL\_ENTER(id, func)}}{Process a wxEVT\_COMMAND\_TOOL\_ENTER event.
  60 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.}
  61 \twocolitem{{\bf EVT\_COMMAND\_LEFT\_CLICK(id, func)}}{Process a wxEVT\_COMMAND\_LEFT\_CLICK command,
  62 which is generated by a control (Windows 95 and NT only).}
  63 \twocolitem{{\bf EVT\_COMMAND\_LEFT\_DCLICK(id, func)}}{Process a wxEVT\_COMMAND\_LEFT\_DCLICK command,
  64 which is generated by a control (Windows 95 and NT only).}
  65 \twocolitem{{\bf EVT\_COMMAND\_RIGHT\_CLICK(id, func)}}{Process a wxEVT\_COMMAND\_RIGHT\_CLICK command,
  66 which is generated by a control (Windows 95 and NT only).}
  67 \twocolitem{{\bf EVT\_COMMAND\_SET\_FOCUS(id, func)}}{Process a wxEVT\_COMMAND\_SET\_FOCUS command,
  68 which is generated by a control (Windows 95 and NT only).}
  69 \twocolitem{{\bf EVT\_COMMAND\_KILL\_FOCUS(id, func)}}{Process a wxEVT\_COMMAND\_KILL\_FOCUS command,
  70 which is generated by a control (Windows 95 and NT only).}
  71 \twocolitem{{\bf EVT\_COMMAND\_ENTER(id, func)}}{Process a wxEVT\_COMMAND\_ENTER command,
  72 which is generated by a control.}
  73 \end{twocollist}%
  74
  75 \latexignore{\rtfignore{\wxheading{Members}}}
  76
  77 \membersection{wxCommandEvent::m\_clientData}
  78
  79 \member{char*}{m\_clientData}
  80
  81 Contains a pointer to client data for listboxes and choices, if the event
  82 was a selection.
  83
  84 \membersection{wxCommandEvent::m\_commandInt}
  85
  86 \member{int}{m\_commandInt}
  87
  88 Contains an integer identifier corresponding to a listbox, choice or
  89 radiobox selection (only if the event was a selection, not a
  90 deselection), or a boolean value representing the value of a checkbox.
  91
  92 \membersection{wxCommandEvent::m\_commandString}
  93
  94 \member{char*}{m\_commandString}
  95
  96 Contains a string corresponding to a listbox or choice selection.
  97
  98 \membersection{wxCommandEvent::m\_extraLong}
  99
 100 \member{long}{m\_extraLong}
 101
 102 Extra information. If the event comes from a listbox selection, it is
 103 a boolean determining whether the event was a selection (TRUE) or a
 104 deselection (FALSE). A listbox deselection only occurs for
 105 multiple-selection boxes, and in this case the index and string values
 106 are indeterminate and the listbox must be examined by the application.
 107
 108 \membersection{wxCommandEvent::wxCommandEvent}
 109
 110 \func{}{wxCommandEvent}{\param{WXTYPE}{ commandEventType = 0}, \param{int}{ id = 0}}
 111
 112 Constructor.
 113
 114 \membersection{wxCommandEvent::Checked}
 115
 116 \func{bool}{Checked}{\void}
 117
 118 Returns TRUE or FALSE for a checkbox selection event.
 119
 120 \membersection{wxCommandEvent::GetClientData}
 121
 122 \func{char*}{GetClientData}{\void}
 123
 124 Returns client data pointer for a listbox or choice selection event
 125 (not valid for a deselection).
 126
 127 \membersection{wxCommandEvent::GetExtraLong}
 128
 129 \func{long}{GetExtraLong}{\void}
 130
 131 Returns the {\bf m\_extraLong} member.
 132
 133 \membersection{wxCommandEvent::GetInt}
 134
 135 \func{int}{GetInt}{\void}
 136
 137 Returns the {\bf m\_commandInt} member.
 138
 139 \membersection{wxCommandEvent::GetSelection}
 140
 141 \func{int}{GetSelection}{\void}
 142
 143 Returns item index for a listbox or choice selection event (not valid for
 144 a deselection).
 145
 146 \membersection{wxCommandEvent::GetString}
 147
 148 \func{char*}{GetString}{\void}
 149
 150 Returns item string for a listbox or choice selection event (not valid for
 151 a deselection).
 152
 153 \membersection{wxCommandEvent::IsSelection}
 154
 155 \func{bool}{IsSelection}{\void}
 156
 157 For a listbox or choice event, returns TRUE if it is a selection, FALSE if it
 158 is a deselection.
 159
 160 \membersection{wxCommandEvent::SetClientData}
 161
 162 \func{void}{SetClientData}{\param{char*}{ clientData}}
 163
 164 Sets the client data for this event.
 165
 166 \membersection{wxCommandEvent::SetExtraLong}
 167
 168 \func{void}{SetExtraLong}{\param{int}{ extraLong}}
 169
 170 Sets the {\bf m\_extraLong} member.
 171
 172 \membersection{wxCommandEvent::SetInt}
 173
 174 \func{void}{SetInt}{\param{int}{ intCommand}}
 175
 176 Sets the {\bf m\_commandInt} member.
 177
 178 \membersection{wxCommandEvent::SetString}
 179
 180 \func{void}{SetString}{\param{char*}{ string}}
 181
 182 Sets the {\bf m\_commandString} member.
 183