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