]> git.saurik.com Git - wxWidgets.git/blob - include/wx/event.h
Corrected some more docs,
[wxWidgets.git] / include / wx / event.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: event.h
3 // Purpose: Event classes
4 // Author: Julian Smart
5 // Modified by:
6 // Created: 01/02/97
7 // RCS-ID: $Id$
8 // Copyright: (c)
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_EVENTH__
13 #define _WX_EVENTH__
14
15 #ifdef __GNUG__
16 #pragma interface "event.h"
17 #endif
18
19 #include "wx/defs.h"
20 #include "wx/object.h"
21 #include "wx/gdicmn.h"
22
23 #if wxUSE_THREADS
24 #include "wx/thread.h"
25 #endif
26
27 /*
28 * Event types
29 *
30 */
31
32 typedef int wxEventType;
33
34 const wxEventType wxEVT_NULL = 0;
35 const wxEventType wxEVT_FIRST = 10000;
36
37 const wxEventType wxEVT_COMMAND_BUTTON_CLICKED = wxEVT_FIRST + 1;
38 const wxEventType wxEVT_COMMAND_CHECKBOX_CLICKED = wxEVT_FIRST + 2;
39 const wxEventType wxEVT_COMMAND_CHOICE_SELECTED = wxEVT_FIRST + 3;
40 const wxEventType wxEVT_COMMAND_LISTBOX_SELECTED = wxEVT_FIRST + 4;
41 const wxEventType wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = wxEVT_FIRST + 5;
42 const wxEventType wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = wxEVT_FIRST + 6;
43 const wxEventType wxEVT_COMMAND_TEXT_UPDATED = wxEVT_FIRST + 7;
44 const wxEventType wxEVT_COMMAND_TEXT_ENTER = wxEVT_FIRST + 8;
45 const wxEventType wxEVT_COMMAND_MENU_SELECTED = wxEVT_FIRST + 9;
46 const wxEventType wxEVT_COMMAND_TOOL_CLICKED = wxEVT_COMMAND_MENU_SELECTED;
47 const wxEventType wxEVT_COMMAND_SLIDER_UPDATED = wxEVT_FIRST + 10;
48 const wxEventType wxEVT_COMMAND_RADIOBOX_SELECTED = wxEVT_FIRST + 11;
49 const wxEventType wxEVT_COMMAND_RADIOBUTTON_SELECTED = wxEVT_FIRST + 12;
50 //const wxEventType wxEVT_COMMAND_SCROLLBAR_UPDATED is now obsolete since we use wxEVT_SCROLL... events
51 const wxEventType wxEVT_COMMAND_SCROLLBAR_UPDATED = wxEVT_FIRST + 13;
52 const wxEventType wxEVT_COMMAND_VLBOX_SELECTED = wxEVT_FIRST + 14;
53 const wxEventType wxEVT_COMMAND_COMBOBOX_SELECTED = wxEVT_FIRST + 15;
54 const wxEventType wxEVT_COMMAND_TOOL_RCLICKED = wxEVT_FIRST + 16;
55 const wxEventType wxEVT_COMMAND_TOOL_ENTER = wxEVT_FIRST + 17;
56
57 /* Sockets send events, too */
58 const wxEventType wxEVT_SOCKET = wxEVT_FIRST + 50;
59
60 /* Mouse event types */
61 const wxEventType wxEVT_LEFT_DOWN = wxEVT_FIRST + 100;
62 const wxEventType wxEVT_LEFT_UP = wxEVT_FIRST + 101;
63 const wxEventType wxEVT_MIDDLE_DOWN = wxEVT_FIRST + 102;
64 const wxEventType wxEVT_MIDDLE_UP = wxEVT_FIRST + 103;
65 const wxEventType wxEVT_RIGHT_DOWN = wxEVT_FIRST + 104;
66 const wxEventType wxEVT_RIGHT_UP = wxEVT_FIRST + 105;
67 const wxEventType wxEVT_MOTION = wxEVT_FIRST + 106;
68 const wxEventType wxEVT_ENTER_WINDOW = wxEVT_FIRST + 107;
69 const wxEventType wxEVT_LEAVE_WINDOW = wxEVT_FIRST + 108;
70 const wxEventType wxEVT_LEFT_DCLICK = wxEVT_FIRST + 109;
71 const wxEventType wxEVT_MIDDLE_DCLICK = wxEVT_FIRST + 110;
72 const wxEventType wxEVT_RIGHT_DCLICK = wxEVT_FIRST + 111;
73 const wxEventType wxEVT_SET_FOCUS = wxEVT_FIRST + 112;
74 const wxEventType wxEVT_KILL_FOCUS = wxEVT_FIRST + 113;
75
76 /* Non-client mouse events */
77 const wxEventType wxEVT_NC_LEFT_DOWN = wxEVT_FIRST + 200;
78 const wxEventType wxEVT_NC_LEFT_UP = wxEVT_FIRST + 201;
79 const wxEventType wxEVT_NC_MIDDLE_DOWN = wxEVT_FIRST + 202;
80 const wxEventType wxEVT_NC_MIDDLE_UP = wxEVT_FIRST + 203;
81 const wxEventType wxEVT_NC_RIGHT_DOWN = wxEVT_FIRST + 204;
82 const wxEventType wxEVT_NC_RIGHT_UP = wxEVT_FIRST + 205;
83 const wxEventType wxEVT_NC_MOTION = wxEVT_FIRST + 206;
84 const wxEventType wxEVT_NC_ENTER_WINDOW = wxEVT_FIRST + 207;
85 const wxEventType wxEVT_NC_LEAVE_WINDOW = wxEVT_FIRST + 208;
86 const wxEventType wxEVT_NC_LEFT_DCLICK = wxEVT_FIRST + 209;
87 const wxEventType wxEVT_NC_MIDDLE_DCLICK = wxEVT_FIRST + 210;
88 const wxEventType wxEVT_NC_RIGHT_DCLICK = wxEVT_FIRST + 211;
89
90 /* Character input event type */
91 const wxEventType wxEVT_CHAR = wxEVT_FIRST + 212;
92 const wxEventType wxEVT_CHAR_HOOK = wxEVT_FIRST + 213;
93 const wxEventType wxEVT_NAVIGATION_KEY = wxEVT_FIRST + 214;
94 const wxEventType wxEVT_KEY_DOWN = wxEVT_FIRST + 215;
95 const wxEventType wxEVT_KEY_UP = wxEVT_FIRST + 216;
96
97 /*
98 * wxScrollbar and wxSlider event identifiers
99 */
100 const wxEventType wxEVT_SCROLL_TOP = wxEVT_FIRST + 300;
101 const wxEventType wxEVT_SCROLL_BOTTOM = wxEVT_FIRST + 301;
102 const wxEventType wxEVT_SCROLL_LINEUP = wxEVT_FIRST + 302;
103 const wxEventType wxEVT_SCROLL_LINEDOWN = wxEVT_FIRST + 303;
104 const wxEventType wxEVT_SCROLL_PAGEUP = wxEVT_FIRST + 304;
105 const wxEventType wxEVT_SCROLL_PAGEDOWN = wxEVT_FIRST + 305;
106 const wxEventType wxEVT_SCROLL_THUMBTRACK = wxEVT_FIRST + 306;
107
108 /*
109 * Scroll events from wxWindow
110 */
111 const wxEventType wxEVT_SCROLLWIN_TOP = wxEVT_FIRST + 320;
112 const wxEventType wxEVT_SCROLLWIN_BOTTOM = wxEVT_FIRST + 321;
113 const wxEventType wxEVT_SCROLLWIN_LINEUP = wxEVT_FIRST + 322;
114 const wxEventType wxEVT_SCROLLWIN_LINEDOWN = wxEVT_FIRST + 323;
115 const wxEventType wxEVT_SCROLLWIN_PAGEUP = wxEVT_FIRST + 324;
116 const wxEventType wxEVT_SCROLLWIN_PAGEDOWN = wxEVT_FIRST + 325;
117 const wxEventType wxEVT_SCROLLWIN_THUMBTRACK = wxEVT_FIRST + 326;
118
119 /*
120 * System events
121 */
122 const wxEventType wxEVT_SIZE = wxEVT_FIRST + 400;
123 const wxEventType wxEVT_MOVE = wxEVT_FIRST + 401;
124 const wxEventType wxEVT_CLOSE_WINDOW = wxEVT_FIRST + 402;
125 const wxEventType wxEVT_END_SESSION = wxEVT_FIRST + 403;
126 const wxEventType wxEVT_QUERY_END_SESSION = wxEVT_FIRST + 404;
127 const wxEventType wxEVT_ACTIVATE_APP = wxEVT_FIRST + 405;
128 const wxEventType wxEVT_POWER = wxEVT_FIRST + 406;
129 const wxEventType wxEVT_ACTIVATE = wxEVT_FIRST + 409;
130 const wxEventType wxEVT_CREATE = wxEVT_FIRST + 410;
131 const wxEventType wxEVT_DESTROY = wxEVT_FIRST + 411;
132 const wxEventType wxEVT_SHOW = wxEVT_FIRST + 412;
133 const wxEventType wxEVT_ICONIZE = wxEVT_FIRST + 413;
134 const wxEventType wxEVT_MAXIMIZE = wxEVT_FIRST + 414;
135 const wxEventType wxEVT_MOUSE_CAPTURE_CHANGED = wxEVT_FIRST + 415;
136 const wxEventType wxEVT_PAINT = wxEVT_FIRST + 416;
137 const wxEventType wxEVT_ERASE_BACKGROUND = wxEVT_FIRST + 417;
138 const wxEventType wxEVT_NC_PAINT = wxEVT_FIRST + 418;
139 const wxEventType wxEVT_PAINT_ICON = wxEVT_FIRST + 419;
140 const wxEventType wxEVT_MENU_CHAR = wxEVT_FIRST + 420;
141 const wxEventType wxEVT_MENU_INIT = wxEVT_FIRST + 421;
142 const wxEventType wxEVT_MENU_HIGHLIGHT = wxEVT_FIRST + 422;
143 const wxEventType wxEVT_POPUP_MENU_INIT = wxEVT_FIRST + 423;
144 const wxEventType wxEVT_CONTEXT_MENU = wxEVT_FIRST + 424;
145 const wxEventType wxEVT_SYS_COLOUR_CHANGED = wxEVT_FIRST + 425;
146 const wxEventType wxEVT_SETTING_CHANGED = wxEVT_FIRST + 426;
147 const wxEventType wxEVT_QUERY_NEW_PALETTE = wxEVT_FIRST + 427;
148 const wxEventType wxEVT_PALETTE_CHANGED = wxEVT_FIRST + 428;
149 const wxEventType wxEVT_JOY_BUTTON_DOWN = wxEVT_FIRST + 429;
150 const wxEventType wxEVT_JOY_BUTTON_UP = wxEVT_FIRST + 430;
151 const wxEventType wxEVT_JOY_MOVE = wxEVT_FIRST + 431;
152 const wxEventType wxEVT_JOY_ZMOVE = wxEVT_FIRST + 432;
153 const wxEventType wxEVT_DROP_FILES = wxEVT_FIRST + 433;
154 const wxEventType wxEVT_DRAW_ITEM = wxEVT_FIRST + 434;
155 const wxEventType wxEVT_MEASURE_ITEM = wxEVT_FIRST + 435;
156 const wxEventType wxEVT_COMPARE_ITEM = wxEVT_FIRST + 436;
157 const wxEventType wxEVT_INIT_DIALOG = wxEVT_FIRST + 437;
158 const wxEventType wxEVT_IDLE = wxEVT_FIRST + 438;
159 const wxEventType wxEVT_UPDATE_UI = wxEVT_FIRST + 439;
160
161 /* System misc. */
162 const wxEventType wxEVT_END_PROCESS = wxEVT_FIRST + 440;
163
164 /* Dial up events */
165 const wxEventType wxEVT_DIALUP_CONNECTED = wxEVT_FIRST + 450;
166 const wxEventType wxEVT_DIALUP_DISCONNECTED = wxEVT_FIRST + 451;
167
168 /* Generic command events */
169 /* Note: a click is a higher-level event than button down/up */
170 const wxEventType wxEVT_COMMAND_LEFT_CLICK = wxEVT_FIRST + 500;
171 const wxEventType wxEVT_COMMAND_LEFT_DCLICK = wxEVT_FIRST + 501;
172 const wxEventType wxEVT_COMMAND_RIGHT_CLICK = wxEVT_FIRST + 502;
173 const wxEventType wxEVT_COMMAND_RIGHT_DCLICK = wxEVT_FIRST + 503;
174 const wxEventType wxEVT_COMMAND_SET_FOCUS = wxEVT_FIRST + 504;
175 const wxEventType wxEVT_COMMAND_KILL_FOCUS = wxEVT_FIRST + 505;
176 const wxEventType wxEVT_COMMAND_ENTER = wxEVT_FIRST + 506;
177
178 /* Tree control event types */
179 const wxEventType wxEVT_COMMAND_TREE_BEGIN_DRAG = wxEVT_FIRST + 600;
180 const wxEventType wxEVT_COMMAND_TREE_BEGIN_RDRAG = wxEVT_FIRST + 601;
181 const wxEventType wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT = wxEVT_FIRST + 602;
182 const wxEventType wxEVT_COMMAND_TREE_END_LABEL_EDIT = wxEVT_FIRST + 603;
183 const wxEventType wxEVT_COMMAND_TREE_DELETE_ITEM = wxEVT_FIRST + 604;
184 const wxEventType wxEVT_COMMAND_TREE_GET_INFO = wxEVT_FIRST + 605;
185 const wxEventType wxEVT_COMMAND_TREE_SET_INFO = wxEVT_FIRST + 606;
186 const wxEventType wxEVT_COMMAND_TREE_ITEM_EXPANDED = wxEVT_FIRST + 607;
187 const wxEventType wxEVT_COMMAND_TREE_ITEM_EXPANDING = wxEVT_FIRST + 608;
188 const wxEventType wxEVT_COMMAND_TREE_ITEM_COLLAPSED = wxEVT_FIRST + 609;
189 const wxEventType wxEVT_COMMAND_TREE_ITEM_COLLAPSING = wxEVT_FIRST + 610;
190 const wxEventType wxEVT_COMMAND_TREE_SEL_CHANGED = wxEVT_FIRST + 611;
191 const wxEventType wxEVT_COMMAND_TREE_SEL_CHANGING = wxEVT_FIRST + 612;
192 const wxEventType wxEVT_COMMAND_TREE_KEY_DOWN = wxEVT_FIRST + 613;
193 const wxEventType wxEVT_COMMAND_TREE_ITEM_ACTIVATED = wxEVT_FIRST + 614;
194
195 /* List control event types */
196 const wxEventType wxEVT_COMMAND_LIST_BEGIN_DRAG = wxEVT_FIRST + 700;
197 const wxEventType wxEVT_COMMAND_LIST_BEGIN_RDRAG = wxEVT_FIRST + 701;
198 const wxEventType wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT = wxEVT_FIRST + 702;
199 const wxEventType wxEVT_COMMAND_LIST_END_LABEL_EDIT = wxEVT_FIRST + 703;
200 const wxEventType wxEVT_COMMAND_LIST_DELETE_ITEM = wxEVT_FIRST + 704;
201 const wxEventType wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS = wxEVT_FIRST + 705;
202 const wxEventType wxEVT_COMMAND_LIST_GET_INFO = wxEVT_FIRST + 706;
203 const wxEventType wxEVT_COMMAND_LIST_SET_INFO = wxEVT_FIRST + 707;
204 const wxEventType wxEVT_COMMAND_LIST_ITEM_SELECTED = wxEVT_FIRST + 708;
205 const wxEventType wxEVT_COMMAND_LIST_ITEM_DESELECTED = wxEVT_FIRST + 709;
206 const wxEventType wxEVT_COMMAND_LIST_KEY_DOWN = wxEVT_FIRST + 710;
207 const wxEventType wxEVT_COMMAND_LIST_INSERT_ITEM = wxEVT_FIRST + 711;
208 const wxEventType wxEVT_COMMAND_LIST_COL_CLICK = wxEVT_FIRST + 712;
209 const wxEventType wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK = wxEVT_FIRST + 713;
210 const wxEventType wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK = wxEVT_FIRST + 714;
211 const wxEventType wxEVT_COMMAND_LIST_ITEM_ACTIVATED = wxEVT_FIRST + 715;
212
213 /* Tab and notebook control event types */
214 const wxEventType wxEVT_COMMAND_TAB_SEL_CHANGED = wxEVT_FIRST + 800;
215 const wxEventType wxEVT_COMMAND_TAB_SEL_CHANGING = wxEVT_FIRST + 801;
216
217 #if defined(__BORLANDC__) && defined(__WIN16__)
218 /* For 16-bit BC++, these 2 are identical (truncated) */
219 const wxEventType wxEVT_COMMAND_NB_PAGE_CHANGED = wxEVT_FIRST + 802;
220 const wxEventType wxEVT_COMMAND_NB_PAGE_CHANGING = wxEVT_FIRST + 803;
221 #else
222 const wxEventType wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED = wxEVT_FIRST + 802;
223 const wxEventType wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING = wxEVT_FIRST + 803;
224 #endif
225
226 /* Splitter events */
227 const wxEventType wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED = wxEVT_FIRST + 850;
228 const wxEventType wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING = wxEVT_FIRST + 851;
229 const wxEventType wxEVT_COMMAND_SPLITTER_DOUBLECLICKED = wxEVT_FIRST + 852;
230 const wxEventType wxEVT_COMMAND_SPLITTER_UNSPLIT = wxEVT_FIRST + 853;
231
232 const wxEventType wxEVT_USER_FIRST = wxEVT_FIRST + 2000;
233
234 /* Compatibility */
235
236 #if WXWIN_COMPATIBILITY
237
238 #define wxEVENT_TYPE_BUTTON_COMMAND wxEVT_COMMAND_BUTTON_CLICKED
239 #define wxEVENT_TYPE_CHECKBOX_COMMAND wxEVT_COMMAND_CHECKBOX_CLICKED
240 #define wxEVENT_TYPE_CHOICE_COMMAND wxEVT_COMMAND_CHOICE_SELECTED
241 #define wxEVENT_TYPE_LISTBOX_COMMAND wxEVT_COMMAND_LISTBOX_SELECTED
242 #define wxEVENT_TYPE_LISTBOX_DCLICK_COMMAND wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
243 #define wxEVENT_TYPE_TEXT_COMMAND wxEVT_COMMAND_TEXT_UPDATED
244 #define wxEVENT_TYPE_MULTITEXT_COMMAND wxEVT_COMMAND_TEXT_UPDATED
245 #define wxEVENT_TYPE_MENU_COMMAND wxEVT_COMMAND_MENU_SELECTED
246 #define wxEVENT_TYPE_SLIDER_COMMAND wxEVT_COMMAND_SLIDER_UPDATED
247 #define wxEVENT_TYPE_RADIOBOX_COMMAND wxEVT_COMMAND_RADIOBOX_SELECTED
248 #define wxEVENT_TYPE_RADIOBUTTON_COMMAND wxEVT_COMMAND_RADIOBUTTON_SELECTED
249 #define wxEVENT_TYPE_TEXT_ENTER_COMMAND wxEVT_COMMAND_TEXT_ENTER
250 #define wxEVENT_TYPE_SET_FOCUS wxEVT_SET_FOCUS
251 #define wxEVENT_TYPE_KILL_FOCUS wxEVT_KILL_FOCUS
252 #define wxEVENT_TYPE_SCROLLBAR_COMMAND wxEVT_COMMAND_SCROLLBAR_UPDATED
253 #define wxEVENT_TYPE_VIRT_LISTBOX_COMMAND wxEVT_COMMAND_VLBOX_SELECTED
254 #define wxEVENT_TYPE_COMBOBOX_COMMAND wxEVT_COMMAND_COMBOBOX_SELECTED
255
256 #define wxEVENT_TYPE_LEFT_DOWN wxEVT_LEFT_DOWN
257 #define wxEVENT_TYPE_LEFT_UP wxEVT_LEFT_UP
258 #define wxEVENT_TYPE_MIDDLE_DOWN wxEVT_MIDDLE_DOWN
259 #define wxEVENT_TYPE_MIDDLE_UP wxEVT_MIDDLE_UP
260 #define wxEVENT_TYPE_RIGHT_DOWN wxEVT_RIGHT_DOWN
261 #define wxEVENT_TYPE_RIGHT_UP wxEVT_RIGHT_UP
262 #define wxEVENT_TYPE_MOTION wxEVT_MOTION
263 #define wxEVENT_TYPE_ENTER_WINDOW wxEVT_ENTER_WINDOW
264 #define wxEVENT_TYPE_LEAVE_WINDOW wxEVT_LEAVE_WINDOW
265 #define wxEVENT_TYPE_LEFT_DCLICK wxEVT_LEFT_DCLICK
266 #define wxEVENT_TYPE_MIDDLE_DCLICK wxEVT_MIDDLE_DCLICK
267 #define wxEVENT_TYPE_RIGHT_DCLICK wxEVT_RIGHT_DCLICK
268 #define wxEVENT_TYPE_CHAR wxEVT_CHAR
269 #define wxEVENT_TYPE_SCROLL_TOP wxEVT_SCROLL_TOP
270 #define wxEVENT_TYPE_SCROLL_BOTTOM wxEVT_SCROLL_BOTTOM
271 #define wxEVENT_TYPE_SCROLL_LINEUP wxEVT_SCROLL_LINEUP
272 #define wxEVENT_TYPE_SCROLL_LINEDOWN wxEVT_SCROLL_LINEDOWN
273 #define wxEVENT_TYPE_SCROLL_PAGEUP wxEVT_SCROLL_PAGEUP
274 #define wxEVENT_TYPE_SCROLL_PAGEDOWN wxEVT_SCROLL_PAGEDOWN
275 #define wxEVENT_TYPE_SCROLL_THUMBTRACK wxEVT_SCROLL_THUMBTRACK
276
277 #endif // WXWIN_COMPATIBILITY
278
279 /*
280 * wxWindows events, covering all interesting things that might happen
281 * (button clicking, resizing, setting text in widgets, etc.).
282 *
283 * For each completely new event type, derive a new event class.
284 * An event CLASS represents a C++ class defining a range of similar event TYPES;
285 * examples are canvas events, panel item command events.
286 * An event TYPE is a unique identifier for a particular system event,
287 * such as a button press or a listbox deselection.
288 *
289 */
290
291 class WXDLLEXPORT wxEvent : public wxObject
292 {
293 DECLARE_ABSTRACT_CLASS(wxEvent)
294
295 public:
296 wxEvent(int id = 0);
297 ~wxEvent() {}
298
299 void SetEventType(wxEventType typ) { m_eventType = typ; }
300 wxEventType GetEventType() const { return m_eventType; }
301 wxObject *GetEventObject() const { return m_eventObject; }
302 void SetEventObject(wxObject *obj) { m_eventObject = obj; }
303 long GetTimestamp() const { return m_timeStamp; }
304 void SetTimestamp(long ts = 0) { m_timeStamp = ts; }
305 int GetId() const { return m_id; }
306 void SetId(int Id) { m_id = Id; }
307
308 // Can instruct event processor that we wish to ignore this event
309 // (treat as if the event table entry had not been found): this must be done
310 // to allow the event processing by the base classes (calling event.Skip()
311 // is the analog of calling the base class verstion of a virtual function)
312 void Skip(bool skip = TRUE) { m_skipped = skip; }
313 bool GetSkipped() const { return m_skipped; };
314
315 // implementation only: this test is explicitlty anti OO and this functions
316 // exists only for optimization purposes
317 bool IsCommandEvent() const { return m_isCommandEvent; }
318
319 void CopyObject(wxObject& object_dest) const;
320
321 public:
322 wxObject* m_eventObject;
323 wxEventType m_eventType;
324 long m_timeStamp;
325 int m_id;
326 wxObject* m_callbackUserData;
327 bool m_skipped;
328
329 // optimization: instead of using costly IsKindOf() we keep a flag telling
330 // whether we're a command event (by far the most common case)
331 bool m_isCommandEvent;
332 };
333
334 // Item or menu event class
335 /*
336 wxEVT_COMMAND_BUTTON_CLICKED
337 wxEVT_COMMAND_CHECKBOX_CLICKED
338 wxEVT_COMMAND_CHOICE_SELECTED
339 wxEVT_COMMAND_LISTBOX_SELECTED
340 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
341 wxEVT_COMMAND_TEXT_UPDATED
342 wxEVT_COMMAND_TEXT_ENTER
343 wxEVT_COMMAND_MENU_SELECTED
344 wxEVT_COMMAND_SLIDER_UPDATED
345 wxEVT_COMMAND_RADIOBOX_SELECTED
346 wxEVT_COMMAND_RADIOBUTTON_SELECTED
347 wxEVT_COMMAND_SCROLLBAR_UPDATED
348 wxEVT_COMMAND_VLBOX_SELECTED
349 wxEVT_COMMAND_COMBOBOX_SELECTED
350 */
351
352 class WXDLLEXPORT wxClientData;
353
354 class WXDLLEXPORT wxCommandEvent : public wxEvent
355 {
356 DECLARE_DYNAMIC_CLASS(wxCommandEvent)
357
358 public:
359 wxCommandEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
360 ~wxCommandEvent() {}
361
362 /*
363 * Accessors dependent on context
364 *
365 */
366
367 // Set/Get client data from controls
368 void SetClientData(void* clientData) { m_clientData = clientData; }
369 void *GetClientData() const { return m_clientData; }
370
371 // Set/Get client object from controls
372 void SetClientObject(wxClientData* clientObject) { m_clientObject = clientObject; }
373 void *GetClientObject() const { return m_clientObject; }
374
375 // Get listbox selection if single-choice
376 int GetSelection() const { return m_commandInt; }
377
378 // Set/Get listbox/choice selection string
379 void SetString(const wxString& s) { m_commandString = s; }
380 wxString GetString() const { return m_commandString; }
381
382 // Get checkbox value
383 bool Checked() const { return (m_commandInt != 0); }
384
385 // TRUE if the listbox event was a selection.
386 bool IsSelection() const { return (m_extraLong != 0); }
387
388 void SetExtraLong(long extraLong) { m_extraLong = extraLong; }
389 long GetExtraLong() const { return m_extraLong ; }
390
391 void SetInt(int i) { m_commandInt = i; }
392 long GetInt() const { return m_commandInt ; }
393
394 void CopyObject(wxObject& obj) const;
395
396 public:
397 wxString m_commandString; // String event argument
398 int m_commandInt;
399 long m_extraLong; // Additional information (e.g. select/deselect)
400 void* m_clientData; // Arbitrary client data
401 wxClientData* m_clientObject; // Arbitrary client object
402 };
403
404 // this class adds a possibility to react (from the user) code to a control
405 // notification: allow or veto the operation being reported.
406 class WXDLLEXPORT wxNotifyEvent : public wxCommandEvent
407 {
408 public:
409 wxNotifyEvent(wxEventType commandType = wxEVT_NULL, int id = 0)
410 : wxCommandEvent(commandType, id) { m_bAllow = TRUE; }
411
412 // veto the operation (by default it's allowed)
413 void Veto() { m_bAllow = FALSE; }
414
415 // for implementation code only: is the operation allowed?
416 bool IsAllowed() const { return m_bAllow; }
417
418 private:
419 bool m_bAllow;
420
421 DECLARE_DYNAMIC_CLASS(wxNotifyEvent)
422 };
423
424 // Scroll event class, derived form wxCommandEvent. wxScrollEvents are
425 // sent by wxSlider and wxScrollbar.
426 /*
427 wxEVT_SCROLL_TOP
428 wxEVT_SCROLL_BOTTOM
429 wxEVT_SCROLL_LINEUP
430 wxEVT_SCROLL_LINEDOWN
431 wxEVT_SCROLL_PAGEUP
432 wxEVT_SCROLL_PAGEDOWN
433 wxEVT_SCROLL_THUMBTRACK
434 */
435
436 class WXDLLEXPORT wxScrollEvent : public wxCommandEvent
437 {
438 DECLARE_DYNAMIC_CLASS(wxScrollEvent)
439
440 public:
441 wxScrollEvent(wxEventType commandType = wxEVT_NULL,
442 int id = 0, int pos = 0, int orient = 0);
443 ~wxScrollEvent() {}
444
445 /*
446 * Accessors
447 *
448 */
449
450 int GetOrientation() const { return (int) m_extraLong ; }
451 int GetPosition() const { return m_commandInt ; }
452 void SetOrientation(int orient) { m_extraLong = (long) orient; }
453 void SetPosition(int pos) { m_commandInt = pos; }
454 };
455
456 // ScrollWin event class, derived fom wxEvent. wxScrollWinEvents
457 // are sent by wxWindow.
458 /*
459 wxEVT_SCROLLWIN_TOP
460 wxEVT_SCROLLWIN_BOTTOM
461 wxEVT_SCROLLWIN_LINEUP
462 wxEVT_SCROLLWIN_LINEDOWN
463 wxEVT_SCROLLWIN_PAGEUP
464 wxEVT_SCROLLWIN_PAGEDOWN
465 wxEVT_SCROLLWIN_THUMBTRACK
466 */
467
468 class WXDLLEXPORT wxScrollWinEvent : public wxEvent
469 {
470 DECLARE_DYNAMIC_CLASS(wxScrollWinEvent)
471
472 public:
473 wxScrollWinEvent(wxEventType commandType = wxEVT_NULL,
474 int pos = 0, int orient = 0);
475 ~wxScrollWinEvent() {}
476
477 /*
478 * Accessors
479 */
480
481 int GetOrientation() const { return (int) m_extraLong ; }
482 int GetPosition() const { return m_commandInt ; }
483 void SetOrientation(int orient) { m_extraLong = (long) orient; }
484 void SetPosition(int pos) { m_commandInt = pos; }
485
486 void CopyObject(wxObject& object_dest) const;
487 public:
488 int m_commandInt; // Additional information
489 long m_extraLong;
490 };
491
492 // Mouse event class
493
494 /*
495 wxEVT_LEFT_DOWN
496 wxEVT_LEFT_UP
497 wxEVT_MIDDLE_DOWN
498 wxEVT_MIDDLE_UP
499 wxEVT_RIGHT_DOWN
500 wxEVT_RIGHT_UP
501 wxEVT_MOTION
502 wxEVT_ENTER_WINDOW
503 wxEVT_LEAVE_WINDOW
504 wxEVT_LEFT_DCLICK
505 wxEVT_MIDDLE_DCLICK
506 wxEVT_RIGHT_DCLICK
507 wxEVT_NC_LEFT_DOWN
508 wxEVT_NC_LEFT_UP,
509 wxEVT_NC_MIDDLE_DOWN,
510 wxEVT_NC_MIDDLE_UP,
511 wxEVT_NC_RIGHT_DOWN,
512 wxEVT_NC_RIGHT_UP,
513 wxEVT_NC_MOTION,
514 wxEVT_NC_ENTER_WINDOW,
515 wxEVT_NC_LEAVE_WINDOW,
516 wxEVT_NC_LEFT_DCLICK,
517 wxEVT_NC_MIDDLE_DCLICK,
518 wxEVT_NC_RIGHT_DCLICK,
519 */
520
521 class WXDLLEXPORT wxDC;
522 class WXDLLEXPORT wxMouseEvent : public wxEvent
523 {
524 DECLARE_DYNAMIC_CLASS(wxMouseEvent)
525
526 public:
527 wxMouseEvent(wxEventType mouseType = wxEVT_NULL);
528
529 // Was it a button event? (*doesn't* mean: is any button *down*?)
530 bool IsButton() const { return Button(-1); }
531
532 // Was it a down event from button 1, 2 or 3 or any?
533 bool ButtonDown(int but = -1) const;
534
535 // Was it a dclick event from button 1, 2 or 3 or any?
536 bool ButtonDClick(int but = -1) const;
537
538 // Was it a up event from button 1, 2 or 3 or any?
539 bool ButtonUp(int but = -1) const;
540
541 // Was the given button 1,2,3 or any changing state?
542 bool Button(int but) const;
543
544 // Was the given button 1,2,3 or any in Down state?
545 bool ButtonIsDown(int but) const;
546
547 // Find state of shift/control keys
548 bool ControlDown() const { return m_controlDown; }
549 bool MetaDown() const { return m_metaDown; }
550 bool AltDown() const { return m_altDown; }
551 bool ShiftDown() const { return m_shiftDown; }
552
553 // Find which event was just generated
554 bool LeftDown() const { return (m_eventType == wxEVT_LEFT_DOWN); }
555 bool MiddleDown() const { return (m_eventType == wxEVT_MIDDLE_DOWN); }
556 bool RightDown() const { return (m_eventType == wxEVT_RIGHT_DOWN); }
557
558 bool LeftUp() const { return (m_eventType == wxEVT_LEFT_UP); }
559 bool MiddleUp() const { return (m_eventType == wxEVT_MIDDLE_UP); }
560 bool RightUp() const { return (m_eventType == wxEVT_RIGHT_UP); }
561
562 bool LeftDClick() const { return (m_eventType == wxEVT_LEFT_DCLICK); }
563 bool MiddleDClick() const { return (m_eventType == wxEVT_MIDDLE_DCLICK); }
564 bool RightDClick() const { return (m_eventType == wxEVT_RIGHT_DCLICK); }
565
566 // Find the current state of the mouse buttons (regardless
567 // of current event type)
568 bool LeftIsDown() const { return m_leftDown; }
569 bool MiddleIsDown() const { return m_middleDown; }
570 bool RightIsDown() const { return m_rightDown; }
571
572 // True if a button is down and the mouse is moving
573 bool Dragging() const
574 {
575 return ((m_eventType == wxEVT_MOTION) &&
576 (LeftIsDown() || MiddleIsDown() || RightIsDown()));
577 }
578
579 // True if the mouse is moving, and no button is down
580 bool Moving() const { return (m_eventType == wxEVT_MOTION); }
581
582 // True if the mouse is just entering the window
583 bool Entering() const { return (m_eventType == wxEVT_ENTER_WINDOW); }
584
585 // True if the mouse is just leaving the window
586 bool Leaving() const { return (m_eventType == wxEVT_LEAVE_WINDOW); }
587
588 // Find the position of the event
589 void GetPosition(long *xpos, long *ypos) const { *xpos = m_x; *ypos = m_y; }
590 void Position(long *xpos, long *ypos) const { *xpos = m_x; *ypos = m_y; }
591
592 // Find the position of the event
593 wxPoint GetPosition() const { return wxPoint(m_x, m_y); }
594
595 // Find the logical position of the event given the DC
596 wxPoint GetLogicalPosition(const wxDC& dc) const ;
597
598 // Compatibility
599 #if WXWIN_COMPATIBILITY
600 void Position(float *xpos, float *ypos) const
601 {
602 *xpos = (float) m_x; *ypos = (float) m_y;
603 }
604 #endif // WXWIN_COMPATIBILITY
605
606 // Get X position
607 long GetX() const { return m_x; }
608
609 // Get Y position
610 long GetY() const { return m_y; }
611
612 void CopyObject(wxObject& obj) const;
613
614 public:
615 long m_x;
616 long m_y;
617 bool m_leftDown;
618 bool m_middleDown;
619 bool m_rightDown;
620
621 bool m_controlDown;
622 bool m_shiftDown;
623 bool m_altDown;
624 bool m_metaDown;
625 };
626
627 // Keyboard input event class
628
629 /*
630 wxEVT_CHAR
631 wxEVT_CHAR_HOOK
632 wxEVT_KEY_DOWN
633 wxEVT_KEY_UP
634 */
635
636 class WXDLLEXPORT wxKeyEvent : public wxEvent
637 {
638 DECLARE_DYNAMIC_CLASS(wxKeyEvent)
639
640 public:
641 wxKeyEvent(wxEventType keyType = wxEVT_NULL);
642
643 // Find state of shift/control keys
644 bool ControlDown() const { return m_controlDown; }
645 bool MetaDown() const { return m_metaDown; }
646 bool AltDown() const { return m_altDown; }
647 bool ShiftDown() const { return m_shiftDown; }
648 long KeyCode() const { return m_keyCode; }
649
650 // Find the position of the event
651 void GetPosition(long *xpos, long *ypos) const
652 { *xpos = m_x; *ypos = m_y; }
653
654 wxPoint GetPosition() const
655 { return wxPoint(m_x, m_y); }
656
657 // Get X position
658 long GetX() const { return m_x; }
659
660 // Get Y position
661 long GetY() const { return m_y; }
662
663 void CopyObject(wxObject& obj) const;
664
665 public:
666 long m_x;
667 long m_y;
668 long m_keyCode;
669 bool m_controlDown;
670 bool m_shiftDown;
671 bool m_altDown;
672 bool m_metaDown;
673 bool m_scanCode;
674 };
675
676 // Size event class
677 /*
678 wxEVT_SIZE
679 */
680
681 class WXDLLEXPORT wxSizeEvent : public wxEvent
682 {
683 DECLARE_DYNAMIC_CLASS(wxSizeEvent)
684
685 public:
686 wxSize m_size;
687
688 wxSizeEvent() { m_eventType = wxEVT_SIZE; }
689 wxSizeEvent(const wxSize& sz, int id = 0)
690 : m_size(sz)
691 { m_eventType = wxEVT_SIZE; m_id = id; }
692
693 wxSize GetSize() const { return m_size; }
694
695 void CopyObject(wxObject& obj) const;
696 };
697
698 // Move event class
699
700 /*
701 wxEVT_MOVE
702 */
703
704 class WXDLLEXPORT wxMoveEvent : public wxEvent
705 {
706 DECLARE_DYNAMIC_CLASS(wxMoveEvent)
707
708 public:
709 wxPoint m_pos;
710
711 wxMoveEvent() { m_eventType = wxEVT_MOVE; }
712 wxMoveEvent(const wxPoint& pos, int id = 0)
713 : m_pos(pos)
714 { m_eventType = wxEVT_MOVE; m_id = id; }
715
716 wxPoint GetPosition() const { return m_pos; }
717
718 void CopyObject(wxObject& obj) const;
719 };
720
721 // Paint event class
722 /*
723 wxEVT_PAINT
724 wxEVT_NC_PAINT
725 wxEVT_PAINT_ICON
726 */
727
728 #if defined(__WXDEBUG__) && defined(__WXMSW__)
729 // see comments in src/msw/dcclient.cpp where g_isPainting is defined
730 extern int g_isPainting;
731 #endif // debug
732
733 class WXDLLEXPORT wxPaintEvent : public wxEvent
734 {
735 DECLARE_DYNAMIC_CLASS(wxPaintEvent)
736
737 public:
738 wxPaintEvent(int Id = 0)
739 {
740 m_eventType = wxEVT_PAINT;
741 m_id = Id;
742
743 #if defined(__WXDEBUG__) && defined(__WXMSW__)
744 // set the internal flag for the duration of processing of WM_PAINT
745 g_isPainting++;
746 #endif // debug
747 }
748
749 #if defined(__WXDEBUG__) && defined(__WXMSW__)
750 ~wxPaintEvent()
751 {
752 g_isPainting--;
753 }
754 #endif // debug
755 };
756
757 // Erase background event class
758 /*
759 wxEVT_ERASE_BACKGROUND
760 */
761
762 class WXDLLEXPORT wxDC;
763 class WXDLLEXPORT wxEraseEvent : public wxEvent
764 {
765 DECLARE_DYNAMIC_CLASS(wxEraseEvent)
766
767 public:
768 wxDC *m_dc;
769
770 wxEraseEvent(int Id = 0, wxDC *dc = (wxDC *) NULL)
771 { m_eventType = wxEVT_ERASE_BACKGROUND; m_id = Id; m_dc = dc; }
772 wxDC *GetDC() const { return m_dc; }
773
774 void CopyObject(wxObject& obj) const;
775 };
776
777 // Focus event class
778 /*
779 wxEVT_SET_FOCUS
780 wxEVT_KILL_FOCUS
781 */
782
783 class WXDLLEXPORT wxFocusEvent : public wxEvent
784 {
785 DECLARE_DYNAMIC_CLASS(wxFocusEvent)
786
787 public:
788 wxFocusEvent(wxEventType type = wxEVT_NULL, int Id = 0)
789 { m_eventType = type; m_id = Id; }
790 };
791
792 // Activate event class
793 /*
794 wxEVT_ACTIVATE
795 wxEVT_ACTIVATE_APP
796 */
797
798 class WXDLLEXPORT wxActivateEvent : public wxEvent
799 {
800 DECLARE_DYNAMIC_CLASS(wxActivateEvent)
801
802 public:
803 wxActivateEvent(wxEventType type = wxEVT_NULL, bool active = TRUE, int Id = 0)
804 { m_eventType = type; m_active = active; m_id = Id; }
805 bool GetActive() const { return m_active; }
806
807 void CopyObject(wxObject& obj) const;
808
809 private:
810 bool m_active;
811 };
812
813 // InitDialog event class
814 /*
815 wxEVT_INIT_DIALOG
816 */
817
818 class WXDLLEXPORT wxInitDialogEvent : public wxEvent
819 {
820 DECLARE_DYNAMIC_CLASS(wxInitDialogEvent)
821
822 public:
823 wxInitDialogEvent(int Id = 0)
824 { m_eventType = wxEVT_INIT_DIALOG; m_id = Id; }
825 };
826
827 // Miscellaneous menu event class
828 /*
829 wxEVT_MENU_CHAR,
830 wxEVT_MENU_INIT,
831 wxEVT_MENU_HIGHLIGHT,
832 wxEVT_POPUP_MENU_INIT,
833 wxEVT_CONTEXT_MENU,
834 */
835
836 class WXDLLEXPORT wxMenuEvent : public wxEvent
837 {
838 DECLARE_DYNAMIC_CLASS(wxMenuEvent)
839
840 public:
841 wxMenuEvent(wxEventType type = wxEVT_NULL, int id = 0)
842 { m_eventType = type; m_menuId = id; }
843
844 int GetMenuId() const { return m_menuId; }
845
846 void CopyObject(wxObject& obj) const;
847 private:
848 int m_menuId;
849 };
850
851 // Window close or session close event class
852 /*
853 wxEVT_CLOSE_WINDOW,
854 wxEVT_END_SESSION,
855 wxEVT_QUERY_END_SESSION
856 */
857
858 class WXDLLEXPORT wxCloseEvent : public wxEvent
859 {
860 DECLARE_DYNAMIC_CLASS(wxCloseEvent)
861
862 public:
863 wxCloseEvent(wxEventType type = wxEVT_NULL, int id = 0)
864 {
865 m_eventType = type;
866 m_loggingOff = TRUE;
867 m_veto = FALSE; // should be FALSE by default
868 m_id = id;
869 #if WXWIN_COMPATIBILITY
870 m_force = FALSE;
871 #endif // WXWIN_COMPATIBILITY
872 m_canVeto = TRUE;
873 }
874
875 void SetLoggingOff(bool logOff) { m_loggingOff = logOff; }
876 bool GetLoggingOff() const { return m_loggingOff; }
877
878 void Veto(bool veto = TRUE)
879 {
880 // GetVeto() will return FALSE anyhow...
881 wxCHECK_RET( m_canVeto,
882 _T("call to Veto() ignored (can't veto this event)") );
883
884 m_veto = veto;
885 }
886 void SetCanVeto(bool canVeto) { m_canVeto = canVeto; }
887 // No more asserts here please, the one you put here was wrong.
888 bool CanVeto() const { return m_canVeto; }
889 bool GetVeto() const { return m_canVeto && m_veto; }
890
891 #if WXWIN_COMPATIBILITY
892 // This is probably obsolete now, since we use CanVeto instead, in
893 // both OnCloseWindow and OnQueryEndSession.
894 // m_force == ! m_canVeto i.e., can't veto means we must force it to close.
895 void SetForce(bool force) { m_force = force; }
896 bool GetForce() const { return m_force; }
897 #endif
898
899 void CopyObject(wxObject& obj) const;
900
901 protected:
902 bool m_loggingOff;
903 bool m_veto, m_canVeto;
904
905 #if WXWIN_COMPATIBILITY
906 bool m_force;
907 #endif
908 };
909
910 /*
911 wxEVT_SHOW
912 */
913
914 class WXDLLEXPORT wxShowEvent : public wxEvent
915 {
916 DECLARE_DYNAMIC_CLASS(wxShowEvent)
917
918 public:
919
920 wxShowEvent(int id = 0, bool show = FALSE)
921 { m_eventType = wxEVT_SHOW; m_id = id; m_show = show; }
922
923 void SetShow(bool show) { m_show = show; }
924 bool GetShow() const { return m_show; }
925
926 void CopyObject(wxObject& obj) const;
927
928 protected:
929 bool m_show;
930 };
931
932 /*
933 wxEVT_ICONIZE
934 */
935
936 class WXDLLEXPORT wxIconizeEvent : public wxEvent
937 {
938 DECLARE_DYNAMIC_CLASS(wxIconizeEvent)
939
940 public:
941 wxIconizeEvent(int id = 0)
942 { m_eventType = wxEVT_ICONIZE; m_id = id; }
943 };
944
945 /*
946 wxEVT_MAXIMIZE
947 */
948
949 class WXDLLEXPORT wxMaximizeEvent : public wxEvent
950 {
951 DECLARE_DYNAMIC_CLASS(wxMaximizeEvent)
952
953 public:
954 wxMaximizeEvent(int id = 0)
955 { m_eventType = wxEVT_MAXIMIZE; m_id = id; }
956 };
957
958 // Joystick event class
959 /*
960 wxEVT_JOY_BUTTON_DOWN,
961 wxEVT_JOY_BUTTON_UP,
962 wxEVT_JOY_MOVE,
963 wxEVT_JOY_ZMOVE
964 */
965
966 // Which joystick? Same as Windows ids so no conversion necessary.
967 #define wxJOYSTICK1 0
968 #define wxJOYSTICK2 1
969
970 // Which button is down?
971 #define wxJOY_BUTTON1 1
972 #define wxJOY_BUTTON2 2
973 #define wxJOY_BUTTON3 4
974 #define wxJOY_BUTTON4 8
975 #define wxJOY_BUTTON_ANY -1
976
977 class WXDLLEXPORT wxJoystickEvent : public wxEvent
978 {
979 DECLARE_DYNAMIC_CLASS(wxJoystickEvent)
980
981 public:
982 wxPoint m_pos;
983 int m_zPosition;
984 int m_buttonChange; // Which button changed?
985 int m_buttonState; // Which buttons are down?
986 int m_joyStick; // Which joystick?
987
988 wxJoystickEvent(wxEventType type = wxEVT_NULL,
989 int state = 0,
990 int joystick = wxJOYSTICK1,
991 int change = 0)
992 {
993 m_eventType = type;
994 m_buttonState = state;
995 m_pos = wxPoint(0,0);
996 m_zPosition = 0;
997 m_joyStick = joystick;
998 m_buttonChange = change;
999 }
1000
1001 wxPoint GetPosition() const { return m_pos; }
1002 int GetZPosition() const { return m_zPosition; }
1003 int GetButtonState() const { return m_buttonState; }
1004 int GetButtonChange() const { return m_buttonChange; }
1005 int GetJoystick() const { return m_joyStick; }
1006
1007 void SetJoystick(int stick) { m_joyStick = stick; }
1008 void SetButtonState(int state) { m_buttonState = state; }
1009 void SetButtonChange(int change) { m_buttonChange = change; }
1010 void SetPosition(const wxPoint& pos) { m_pos = pos; }
1011 void SetZPosition(int zPos) { m_zPosition = zPos; }
1012
1013 // Was it a button event? (*doesn't* mean: is any button *down*?)
1014 bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) ||
1015 (GetEventType() == wxEVT_JOY_BUTTON_DOWN)); }
1016
1017 // Was it a move event?
1018 bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE) ; }
1019
1020 // Was it a zmove event?
1021 bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE) ; }
1022
1023 // Was it a down event from button 1, 2, 3, 4 or any?
1024 bool ButtonDown(int but = wxJOY_BUTTON_ANY) const
1025 { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) &&
1026 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
1027
1028 // Was it a up event from button 1, 2, 3 or any?
1029 bool ButtonUp(int but = wxJOY_BUTTON_ANY) const
1030 { return ((GetEventType() == wxEVT_JOY_BUTTON_UP) &&
1031 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
1032
1033 // Was the given button 1,2,3,4 or any in Down state?
1034 bool ButtonIsDown(int but = wxJOY_BUTTON_ANY) const
1035 { return (((but == wxJOY_BUTTON_ANY) && (m_buttonState != 0)) ||
1036 ((m_buttonState & but) == but)); }
1037
1038 void CopyObject(wxObject& obj) const;
1039 };
1040
1041 // Drop files event class
1042 /*
1043 wxEVT_DROP_FILES
1044 */
1045
1046 class WXDLLEXPORT wxDropFilesEvent : public wxEvent
1047 {
1048 DECLARE_DYNAMIC_CLASS(wxDropFilesEvent)
1049
1050 public:
1051 int m_noFiles;
1052 wxPoint m_pos;
1053 wxString* m_files; // Memory (de)allocated by code calling ProcessEvent
1054
1055 wxDropFilesEvent(wxEventType type = wxEVT_NULL,
1056 int noFiles = 0,
1057 wxString *files = (wxString *) NULL)
1058 { m_eventType = type; m_noFiles = noFiles; m_files = files; }
1059
1060 wxPoint GetPosition() const { return m_pos; }
1061 int GetNumberOfFiles() const { return m_noFiles; }
1062 wxString *GetFiles() const { return m_files; }
1063
1064 void CopyObject(wxObject& obj) const;
1065 };
1066
1067 // Idle event
1068 /*
1069 wxEVT_IDLE
1070 */
1071
1072 class WXDLLEXPORT wxIdleEvent : public wxEvent
1073 {
1074 DECLARE_DYNAMIC_CLASS(wxIdleEvent)
1075
1076 public:
1077 wxIdleEvent()
1078 { m_eventType = wxEVT_IDLE; m_requestMore = FALSE; }
1079
1080 void RequestMore(bool needMore = TRUE) { m_requestMore = needMore; }
1081 bool MoreRequested() const { return m_requestMore; }
1082
1083 void CopyObject(wxObject& obj) const;
1084
1085 protected:
1086 bool m_requestMore;
1087 };
1088
1089 // Update UI event
1090 /*
1091 wxEVT_UPDATE_UI
1092 */
1093
1094 class WXDLLEXPORT wxMenu;
1095 class WXDLLEXPORT wxWindow;
1096
1097 class WXDLLEXPORT wxUpdateUIEvent : public wxCommandEvent
1098 {
1099 DECLARE_DYNAMIC_CLASS(wxUpdateUIEvent)
1100
1101 public:
1102 wxUpdateUIEvent(wxWindowID commandId = 0)
1103 {
1104 m_eventType = wxEVT_UPDATE_UI;
1105 m_id = commandId;
1106 m_checked = FALSE;
1107 m_setChecked = FALSE;
1108 m_enabled = FALSE;
1109 m_setEnabled = FALSE;
1110 m_setText = FALSE;
1111 m_text = "";
1112 }
1113
1114 bool GetChecked() const { return m_checked; }
1115 bool GetEnabled() const { return m_enabled; }
1116 wxString GetText() const { return m_text; }
1117 bool GetSetText() const { return m_setText; }
1118 bool GetSetChecked() const { return m_setChecked; }
1119 bool GetSetEnabled() const { return m_setEnabled; }
1120
1121 void Check(bool check) { m_checked = check; m_setChecked = TRUE; }
1122 void Enable(bool enable) { m_enabled = enable; m_setEnabled = TRUE; }
1123 void SetText(const wxString& text) { m_text = text; m_setText = TRUE; }
1124
1125 void CopyObject(wxObject& obj) const;
1126
1127 protected:
1128 bool m_checked;
1129 bool m_enabled;
1130 bool m_setEnabled;
1131 bool m_setText;
1132 bool m_setChecked;
1133 wxString m_text;
1134 };
1135
1136 /*
1137 wxEVT_SYS_COLOUR_CHANGED
1138 */
1139
1140 // TODO: shouldn't all events record the window ID?
1141 class WXDLLEXPORT wxSysColourChangedEvent : public wxEvent
1142 {
1143 DECLARE_DYNAMIC_CLASS(wxSysColourChangedEvent)
1144
1145 public:
1146 wxSysColourChangedEvent()
1147 { m_eventType = wxEVT_SYS_COLOUR_CHANGED; }
1148 };
1149
1150 /*
1151 wxEVT_PALETTE_CHANGED
1152 */
1153
1154 class WXDLLEXPORT wxPaletteChangedEvent : public wxEvent
1155 {
1156 DECLARE_DYNAMIC_CLASS(wxPaletteChangedEvent)
1157
1158 public:
1159 wxPaletteChangedEvent(wxWindowID id = 0) : wxEvent(id)
1160 {
1161 m_eventType = wxEVT_PALETTE_CHANGED;
1162 m_changedWindow = (wxWindow *) NULL;
1163 }
1164
1165 void SetChangedWindow(wxWindow* win) { m_changedWindow = win; }
1166 wxWindow* GetChangedWindow() const { return m_changedWindow; }
1167
1168 void CopyObject(wxObject& obj) const;
1169
1170 protected:
1171 wxWindow* m_changedWindow;
1172 };
1173
1174 /*
1175 wxEVT_QUERY_NEW_PALETTE
1176 Indicates the window is getting keyboard focus and should re-do its palette.
1177 */
1178
1179 class WXDLLEXPORT wxQueryNewPaletteEvent : public wxEvent
1180 {
1181 DECLARE_DYNAMIC_CLASS(wxQueryNewPaletteEvent)
1182
1183 public:
1184 wxQueryNewPaletteEvent(wxWindowID id = 0): wxEvent(id)
1185 { m_eventType = wxEVT_QUERY_NEW_PALETTE; m_paletteRealized = FALSE; }
1186
1187 // App sets this if it changes the palette.
1188 void SetPaletteRealized(bool realized) { m_paletteRealized = realized; }
1189 bool GetPaletteRealized() const { return m_paletteRealized; }
1190
1191 void CopyObject(wxObject& obj) const;
1192
1193 protected:
1194 bool m_paletteRealized;
1195 };
1196
1197 /*
1198 Event generated by dialog navigation keys
1199 wxEVT_NAVIGATION_KEY
1200 */
1201 // must derive from command event to be propagated to the parent
1202 class WXDLLEXPORT wxNavigationKeyEvent : public wxCommandEvent
1203 {
1204 DECLARE_DYNAMIC_CLASS(wxNavigationKeyEvent)
1205
1206 public:
1207 wxNavigationKeyEvent() : wxCommandEvent(wxEVT_NAVIGATION_KEY) { }
1208
1209 // direction: forward (true) or backward (false)
1210 bool GetDirection() const { return m_commandInt == 1; }
1211 void SetDirection(bool bForward) { m_commandInt = bForward; }
1212
1213 // it may be a window change event (MDI, notebook pages...) or a control
1214 // change event
1215 bool IsWindowChange() const { return m_extraLong == 1; }
1216 void SetWindowChange(bool bIs) { m_extraLong = bIs; }
1217
1218 // the child which has the focus currently (may be NULL - use
1219 // wxWindow::FindFocus then)
1220 wxWindow* GetCurrentFocus() const { return (wxWindow *)m_clientData; }
1221 void SetCurrentFocus(wxWindow *win) { m_clientData = (void *)win; }
1222 };
1223
1224 // Window creation/destruction events: the first is sent as soon as window is
1225 // created (i.e. the underlying GUI object exists), but when the C++ object is
1226 // fully initialized (so virtual functions may be called). The second,
1227 // wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
1228 // still safe to call virtual functions at this moment
1229 /*
1230 wxEVT_CREATE
1231 wxEVT_DESTROY
1232 */
1233
1234 class WXDLLEXPORT wxWindowCreateEvent : public wxEvent
1235 {
1236 DECLARE_DYNAMIC_CLASS(wxWindowCreateEvent)
1237
1238 public:
1239 wxWindowCreateEvent(wxWindow *win = NULL);
1240
1241 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1242 };
1243
1244 class WXDLLEXPORT wxWindowDestroyEvent : public wxEvent
1245 {
1246 DECLARE_DYNAMIC_CLASS(wxWindowDestroyEvent)
1247
1248 public:
1249 wxWindowDestroyEvent(wxWindow *win = NULL);
1250
1251 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1252 };
1253
1254 /* TODO
1255 wxEVT_POWER,
1256 wxEVT_MOUSE_CAPTURE_CHANGED,
1257 wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
1258 // wxEVT_FONT_CHANGED, // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
1259 // wxEVT_FONT_CHANGED to all other windows (maybe).
1260 wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
1261 wxEVT_MEASURE_ITEM,
1262 wxEVT_COMPARE_ITEM
1263 */
1264
1265 class WXDLLEXPORT wxWindow;
1266 class WXDLLEXPORT wxControl;
1267
1268 // struct WXDLLEXPORT wxEventTableEntry;
1269
1270 typedef void (wxObject::*wxObjectEventFunction)(wxEvent&);
1271
1272 struct WXDLLEXPORT wxEventTableEntry
1273 {
1274 // For some reason, this can't be wxEventType, or VC++ complains.
1275 int m_eventType; // main event type
1276 int m_id; // control/menu/toolbar id
1277 int m_lastId; // used for ranges of ids
1278 wxObjectEventFunction m_fn; // function to call: not wxEventFunction,
1279 // because of dependency problems
1280
1281 wxObject* m_callbackUserData;
1282 };
1283
1284 struct WXDLLEXPORT wxEventTable
1285 {
1286 const wxEventTable *baseTable; // Points to base event table (next in chain)
1287 const wxEventTableEntry *entries; // Points to bottom of entry array
1288 };
1289
1290 class WXDLLEXPORT wxEvtHandler : public wxObject
1291 {
1292 DECLARE_DYNAMIC_CLASS(wxEvtHandler)
1293
1294 public:
1295 wxEvtHandler();
1296 ~wxEvtHandler();
1297
1298 wxEvtHandler *GetNextHandler() const { return m_nextHandler; }
1299 wxEvtHandler *GetPreviousHandler() const { return m_previousHandler; }
1300 void SetNextHandler(wxEvtHandler *handler) { m_nextHandler = handler; }
1301 void SetPreviousHandler(wxEvtHandler *handler) { m_previousHandler = handler; }
1302
1303 void SetEvtHandlerEnabled(bool en) { m_enabled = en; }
1304 bool GetEvtHandlerEnabled() const { return m_enabled; }
1305
1306 #if WXWIN_COMPATIBILITY_2
1307 virtual void OnCommand(wxWindow& WXUNUSED(win),
1308 wxCommandEvent& WXUNUSED(event))
1309 {
1310 wxFAIL_MSG(_T("shouldn't be called any more"));
1311 }
1312
1313 // Called if child control has no callback function
1314 virtual long Default()
1315 { return GetNextHandler() ? GetNextHandler()->Default() : 0; };
1316 #endif // WXWIN_COMPATIBILITY_2
1317
1318 #if WXWIN_COMPATIBILITY
1319 virtual bool OnClose();
1320 #endif
1321
1322 #if wxUSE_THREADS
1323 bool ProcessThreadEvent(wxEvent& event);
1324 void ProcessPendingEvents();
1325 #endif
1326 virtual bool ProcessEvent(wxEvent& event);
1327 virtual bool SearchEventTable(wxEventTable& table, wxEvent& event);
1328
1329 // Dynamic association of a member function handler with the event handler,
1330 // id and event type
1331 void Connect( int id, int lastId, wxEventType eventType,
1332 wxObjectEventFunction func,
1333 wxObject *userData = (wxObject *) NULL );
1334
1335 // Convenience function: take just one id
1336 void Connect( int id, wxEventType eventType,
1337 wxObjectEventFunction func,
1338 wxObject *userData = (wxObject *) NULL )
1339 { Connect(id, -1, eventType, func, userData); }
1340
1341 bool SearchDynamicEventTable( wxEvent& event );
1342
1343 #if wxUSE_THREADS
1344 void ClearEventLocker() { delete m_eventsLocker; m_eventsLocker = NULL; };
1345 #endif
1346
1347 private:
1348 static const wxEventTableEntry sm_eventTableEntries[];
1349
1350 protected:
1351 static const wxEventTable sm_eventTable;
1352
1353 virtual const wxEventTable *GetEventTable() const;
1354
1355 protected:
1356 wxEvtHandler* m_nextHandler;
1357 wxEvtHandler* m_previousHandler;
1358 bool m_enabled; // Is event handler enabled?
1359 wxList* m_dynamicEvents;
1360 wxList* m_pendingEvents;
1361 #if wxUSE_THREADS
1362 wxCriticalSection* m_eventsLocker;
1363 #endif
1364
1365 // optimization: instead of using costly IsKindOf() to decide whether we're
1366 // a window (which is true in 99% of cases), use this flag
1367 bool m_isWindow;
1368 };
1369
1370 typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&);
1371 typedef void (wxEvtHandler::*wxCommandEventFunction)(wxCommandEvent&);
1372 typedef void (wxEvtHandler::*wxScrollEventFunction)(wxScrollEvent&);
1373 typedef void (wxEvtHandler::*wxScrollWinEventFunction)(wxScrollWinEvent&);
1374 typedef void (wxEvtHandler::*wxSizeEventFunction)(wxSizeEvent&);
1375 typedef void (wxEvtHandler::*wxMoveEventFunction)(wxMoveEvent&);
1376 typedef void (wxEvtHandler::*wxPaintEventFunction)(wxPaintEvent&);
1377 typedef void (wxEvtHandler::*wxEraseEventFunction)(wxEraseEvent&);
1378 typedef void (wxEvtHandler::*wxMouseEventFunction)(wxMouseEvent&);
1379 typedef void (wxEvtHandler::*wxCharEventFunction)(wxKeyEvent&);
1380 typedef void (wxEvtHandler::*wxFocusEventFunction)(wxFocusEvent&);
1381 typedef void (wxEvtHandler::*wxActivateEventFunction)(wxActivateEvent&);
1382 typedef void (wxEvtHandler::*wxMenuEventFunction)(wxMenuEvent&);
1383 typedef void (wxEvtHandler::*wxJoystickEventFunction)(wxJoystickEvent&);
1384 typedef void (wxEvtHandler::*wxDropFilesEventFunction)(wxDropFilesEvent&);
1385 typedef void (wxEvtHandler::*wxInitDialogEventFunction)(wxInitDialogEvent&);
1386 typedef void (wxEvtHandler::*wxSysColourChangedFunction)(wxSysColourChangedEvent&);
1387 typedef void (wxEvtHandler::*wxUpdateUIEventFunction)(wxUpdateUIEvent&);
1388 typedef void (wxEvtHandler::*wxIdleEventFunction)(wxIdleEvent&);
1389 typedef void (wxEvtHandler::*wxCloseEventFunction)(wxCloseEvent&);
1390 typedef void (wxEvtHandler::*wxShowEventFunction)(wxShowEvent&);
1391 typedef void (wxEvtHandler::*wxIconizeEventFunction)(wxShowEvent&);
1392 typedef void (wxEvtHandler::*wxMaximizeEventFunction)(wxShowEvent&);
1393 typedef void (wxEvtHandler::*wxNavigationKeyEventFunction)(wxNavigationKeyEvent&);
1394 typedef void (wxEvtHandler::*wxPaletteChangedEventFunction)(wxPaletteChangedEvent&);
1395 typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction)(wxQueryNewPaletteEvent&);
1396
1397 // N.B. In GNU-WIN32, you *have* to take the address of a member function
1398 // (use &) or the compiler crashes...
1399
1400 #define DECLARE_EVENT_TABLE() \
1401 private:\
1402 static const wxEventTableEntry sm_eventTableEntries[];\
1403 protected:\
1404 static const wxEventTable sm_eventTable;\
1405 virtual const wxEventTable* GetEventTable() const;
1406
1407 #define BEGIN_EVENT_TABLE(theClass, baseClass) \
1408 const wxEventTable *theClass::GetEventTable() const { return &theClass::sm_eventTable; }\
1409 const wxEventTable theClass::sm_eventTable =\
1410 { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] };\
1411 const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
1412
1413 #define END_EVENT_TABLE() \
1414 { 0, 0, 0, 0, 0 } };
1415
1416 /*
1417 * Event table macros
1418 */
1419
1420 // Generic events
1421 #define EVT_CUSTOM(event, id, func) { event, id, -1, (wxObjectEventFunction) (wxEventFunction) & func, (wxObject *) NULL },
1422 #define EVT_CUSTOM_RANGE(event, id1, id2, func) { event, id1, id2, (wxObjectEventFunction) (wxEventFunction) & func, (wxObject *) NULL },
1423
1424 // Miscellaneous
1425 #define EVT_SIZE(func) { wxEVT_SIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxSizeEventFunction) & func, (wxObject *) NULL },
1426 #define EVT_MOVE(func) { wxEVT_MOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMoveEventFunction) & func, (wxObject *) NULL },
1427 #define EVT_CLOSE(func) { wxEVT_CLOSE_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL },
1428 #define EVT_END_SESSION(func) { wxEVT_END_SESSION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL },
1429 #define EVT_QUERY_END_SESSION(func) { wxEVT_QUERY_END_SESSION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL },
1430 #define EVT_PAINT(func) { wxEVT_PAINT, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxPaintEventFunction) & func, (wxObject *) NULL },
1431 #define EVT_ERASE_BACKGROUND(func) { wxEVT_ERASE_BACKGROUND, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxEraseEventFunction) & func, (wxObject *) NULL },
1432 #define EVT_CHAR(func) { wxEVT_CHAR, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCharEventFunction) & func, (wxObject *) NULL },
1433 #define EVT_KEY_DOWN(func) { wxEVT_KEY_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCharEventFunction) & func, (wxObject *) NULL },
1434 #define EVT_KEY_UP(func) { wxEVT_KEY_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCharEventFunction) & func, (wxObject *) NULL },
1435 #define EVT_CHAR_HOOK(func) { wxEVT_CHAR_HOOK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCharEventFunction) & func, NULL },
1436 #define EVT_MENU_HIGHLIGHT(id, func) { wxEVT_MENU_HIGHLIGHT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxMenuEventFunction) & func, (wxObject *) NULL },
1437 #define EVT_MENU_HIGHLIGHT_ALL(func) { wxEVT_MENU_HIGHLIGHT, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMenuEventFunction) & func, (wxObject *) NULL },
1438 #define EVT_SET_FOCUS(func) { wxEVT_SET_FOCUS, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxFocusEventFunction) & func, (wxObject *) NULL },
1439 #define EVT_KILL_FOCUS(func) { wxEVT_KILL_FOCUS, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxFocusEventFunction) & func, (wxObject *) NULL },
1440 #define EVT_ACTIVATE(func) { wxEVT_ACTIVATE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxActivateEventFunction) & func, (wxObject *) NULL },
1441 #define EVT_ACTIVATE_APP(func) { wxEVT_ACTIVATE_APP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxActivateEventFunction) & func, (wxObject *) NULL },
1442 #define EVT_END_SESSION(func) { wxEVT_END_SESSION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL },
1443 #define EVT_QUERY_END_SESSION(func) { wxEVT_QUERY_END_SESSION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL },
1444 #define EVT_DROP_FILES(func) { wxEVT_DROP_FILES, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxDropFilesEventFunction) & func, (wxObject *) NULL },
1445 #define EVT_INIT_DIALOG(func) { wxEVT_INIT_DIALOG, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxInitDialogEventFunction) & func, (wxObject *) NULL },
1446 #define EVT_SYS_COLOUR_CHANGED(func) { wxEVT_SYS_COLOUR_CHANGED, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxSysColourChangedFunction) & func, (wxObject *) NULL },
1447 #define EVT_SHOW(func) { wxEVT_SHOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxShowEventFunction) & func, (wxObject *) NULL },
1448 #define EVT_MAXIMIZE(func) { wxEVT_MAXIMIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMaximizeEventFunction) & func, (wxObject *) NULL },
1449 #define EVT_ICONIZE(func) { wxEVT_ICONIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxIconizeEventFunction) & func, (wxObject *) NULL },
1450 #define EVT_NAVIGATION_KEY(func) { wxEVT_NAVIGATION_KEY, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxNavigationKeyEventFunction) & func, (wxObject *) NULL },
1451 #define EVT_PALETTE_CHANGED(func) { wxEVT_PALETTE_CHANGED, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxPaletteChangedEventFunction) & func, (wxObject *) NULL },
1452 #define EVT_QUERY_NEW_PALETTE(func) { wxEVT_QUERY_NEW_PALETTE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxQueryNewPaletteEventFunction) & func, (wxObject *) NULL },
1453 #define EVT_WINDOW_CREATE(func) { wxEVT_CREATE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxQueryNewPaletteEventFunction) & func, (wxObject *) NULL },
1454 #define EVT_WINDOW_DESTROY(func) { wxEVT_DESTROY, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxQueryNewPaletteEventFunction) & func, (wxObject *) NULL },
1455
1456 // Mouse events
1457 #define EVT_LEFT_DOWN(func) { wxEVT_LEFT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1458 #define EVT_LEFT_UP(func) { wxEVT_LEFT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1459 #define EVT_MIDDLE_DOWN(func) { wxEVT_MIDDLE_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1460 #define EVT_MIDDLE_UP(func) { wxEVT_MIDDLE_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1461 #define EVT_RIGHT_DOWN(func) { wxEVT_RIGHT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1462 #define EVT_RIGHT_UP(func) { wxEVT_RIGHT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1463 #define EVT_MOTION(func) { wxEVT_MOTION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1464 #define EVT_LEFT_DCLICK(func) { wxEVT_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1465 #define EVT_MIDDLE_DCLICK(func) { wxEVT_MIDDLE_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1466 #define EVT_RIGHT_DCLICK(func) { wxEVT_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1467 #define EVT_LEAVE_WINDOW(func) { wxEVT_LEAVE_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1468 #define EVT_ENTER_WINDOW(func) { wxEVT_ENTER_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1469
1470 // All mouse events
1471 #define EVT_MOUSE_EVENTS(func) \
1472 { wxEVT_LEFT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1473 { wxEVT_LEFT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1474 { wxEVT_MIDDLE_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1475 { wxEVT_MIDDLE_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1476 { wxEVT_RIGHT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1477 { wxEVT_RIGHT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1478 { wxEVT_MOTION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1479 { wxEVT_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1480 { wxEVT_MIDDLE_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1481 { wxEVT_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1482 { wxEVT_ENTER_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1483 { wxEVT_LEAVE_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1484
1485 // EVT_COMMAND
1486 #define EVT_COMMAND(id, event, fn) { event, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1487 #define EVT_COMMAND_RANGE(id1, id2, event, fn) { event, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1488
1489 // Scrolling from wxWindow (sent to wxScrolledWindow)
1490 #define EVT_SCROLLWIN(func) \
1491 { wxEVT_SCROLLWIN_TOP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },\
1492 { wxEVT_SCROLLWIN_BOTTOM, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },\
1493 { wxEVT_SCROLLWIN_LINEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },\
1494 { wxEVT_SCROLLWIN_LINEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },\
1495 { wxEVT_SCROLLWIN_PAGEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },\
1496 { wxEVT_SCROLLWIN_PAGEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },\
1497 { wxEVT_SCROLLWIN_THUMBTRACK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },
1498
1499 #define EVT_SCROLLWIN_TOP(func) { wxEVT_SCROLLWIN_TOP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },
1500 #define EVT_SCROLLWIN_BOTTOM(func) { wxEVT_SCROLLWIN_BOTTOM, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },
1501 #define EVT_SCROLLWIN_LINEUP(func) { wxEVT_SCROLLWIN_LINEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },
1502 #define EVT_SCROLLWIN_LINEDOWN(func) { wxEVT_SCROLLWIN_LINEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },
1503 #define EVT_SCROLLWIN_PAGEUP(func) { wxEVT_SCROLLWIN_PAGEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },
1504 #define EVT_SCROLLWIN_PAGEDOWN(func) { wxEVT_SCROLLWIN_PAGEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },
1505 #define EVT_SCROLLWIN_THUMBTRACK(func) { wxEVT_SCROLLWIN_THUMBTRACK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },
1506
1507 // Scrolling from wxSlider and wxScrollBar
1508 #define EVT_SCROLL(func) \
1509 { wxEVT_SCROLL_TOP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1510 { wxEVT_SCROLL_BOTTOM, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1511 { wxEVT_SCROLL_LINEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1512 { wxEVT_SCROLL_LINEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1513 { wxEVT_SCROLL_PAGEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1514 { wxEVT_SCROLL_PAGEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1515 { wxEVT_SCROLL_THUMBTRACK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1516
1517 #define EVT_SCROLL_TOP(func) { wxEVT_SCROLL_TOP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1518 #define EVT_SCROLL_BOTTOM(func) { wxEVT_SCROLL_BOTTOM, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1519 #define EVT_SCROLL_LINEUP(func) { wxEVT_SCROLL_LINEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1520 #define EVT_SCROLL_LINEDOWN(func) { wxEVT_SCROLL_LINEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1521 #define EVT_SCROLL_PAGEUP(func) { wxEVT_SCROLL_PAGEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1522 #define EVT_SCROLL_PAGEDOWN(func) { wxEVT_SCROLL_PAGEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1523 #define EVT_SCROLL_THUMBTRACK(func) { wxEVT_SCROLL_THUMBTRACK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1524
1525 // Scrolling from wxSlider and wxScrollBar, with an id
1526 #define EVT_COMMAND_SCROLL(id, func) \
1527 { wxEVT_SCROLL_TOP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1528 { wxEVT_SCROLL_BOTTOM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1529 { wxEVT_SCROLL_LINEUP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1530 { wxEVT_SCROLL_LINEDOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1531 { wxEVT_SCROLL_PAGEUP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1532 { wxEVT_SCROLL_PAGEDOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1533 { wxEVT_SCROLL_THUMBTRACK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1534
1535 #define EVT_COMMAND_SCROLL_TOP(id, func) { wxEVT_SCROLL_TOP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1536 #define EVT_COMMAND_SCROLL_BOTTOM(id, func) { wxEVT_SCROLL_BOTTOM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1537 #define EVT_COMMAND_SCROLL_LINEUP(id, func) { wxEVT_SCROLL_LINEUP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1538 #define EVT_COMMAND_SCROLL_LINEDOWN(id, func) { wxEVT_SCROLL_LINEDOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1539 #define EVT_COMMAND_SCROLL_PAGEUP(id, func) { wxEVT_SCROLL_PAGEUP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1540 #define EVT_COMMAND_SCROLL_PAGEDOWN(id, func) { wxEVT_SCROLL_PAGEDOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1541 #define EVT_COMMAND_SCROLL_THUMBTRACK(id, func) { wxEVT_SCROLL_THUMBTRACK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1542
1543 // Convenience macros for commonly-used commands
1544 #define EVT_BUTTON(id, fn) { wxEVT_COMMAND_BUTTON_CLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1545 #define EVT_CHECKBOX(id, fn) { wxEVT_COMMAND_CHECKBOX_CLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1546 #define EVT_CHOICE(id, fn) { wxEVT_COMMAND_CHOICE_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1547 #define EVT_LISTBOX(id, fn) { wxEVT_COMMAND_LISTBOX_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1548 #define EVT_LISTBOX_DCLICK(id, fn) { wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1549 #define EVT_TEXT(id, fn) { wxEVT_COMMAND_TEXT_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1550 #define EVT_TEXT_ENTER(id, fn) { wxEVT_COMMAND_TEXT_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1551 #define EVT_MENU(id, fn) { wxEVT_COMMAND_MENU_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1552 #define EVT_MENU_RANGE(id1, id2, fn) { wxEVT_COMMAND_MENU_SELECTED, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1553 #define EVT_SLIDER(id, fn) { wxEVT_COMMAND_SLIDER_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1554 #define EVT_RADIOBOX(id, fn) { wxEVT_COMMAND_RADIOBOX_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1555 #define EVT_RADIOBUTTON(id, fn) { wxEVT_COMMAND_RADIOBUTTON_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1556 // EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events
1557 #define EVT_SCROLLBAR(id, fn) { wxEVT_COMMAND_SCROLLBAR_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1558 #define EVT_VLBOX(id, fn) { wxEVT_COMMAND_VLBOX_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1559 #define EVT_COMBOBOX(id, fn) { wxEVT_COMMAND_COMBOBOX_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1560 #define EVT_TOOL(id, fn) { wxEVT_COMMAND_TOOL_CLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1561 #define EVT_TOOL_RANGE(id1, id2, fn) { wxEVT_COMMAND_TOOL_CLICKED, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1562 #define EVT_TOOL_RCLICKED(id, fn) { wxEVT_COMMAND_TOOL_RCLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1563 #define EVT_TOOL_RCLICKED_RANGE(id1, id2, fn) { wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1564 #define EVT_TOOL_ENTER(id, fn) { wxEVT_COMMAND_TOOL_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1565 #define EVT_CHECKLISTBOX(id, fn) { wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1566
1567 // Generic command events
1568 #define EVT_COMMAND_LEFT_CLICK(id, fn) { wxEVT_COMMAND_LEFT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1569 #define EVT_COMMAND_LEFT_DCLICK(id, fn) { wxEVT_COMMAND_LEFT_DCLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1570 #define EVT_COMMAND_RIGHT_CLICK(id, fn) { wxEVT_COMMAND_RIGHT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1571 #define EVT_COMMAND_RIGHT_DCLICK(id, fn) { wxEVT_COMMAND_RIGHT_DCLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1572 #define EVT_COMMAND_SET_FOCUS(id, fn) { wxEVT_COMMAND_SET_FOCUS, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1573 #define EVT_COMMAND_KILL_FOCUS(id, fn) { wxEVT_COMMAND_KILL_FOCUS, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1574 #define EVT_COMMAND_ENTER(id, fn) { wxEVT_COMMAND_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1575
1576 // Joystick events
1577 #define EVT_JOY_DOWN(func) \
1578 { wxEVT_JOY_BUTTON_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },
1579 #define EVT_JOY_UP(func) \
1580 { wxEVT_JOY_BUTTON_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },
1581 #define EVT_JOY_MOVE(func) \
1582 { wxEVT_JOY_MOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },
1583 #define EVT_JOY_ZMOVE(func) \
1584 { wxEVT_JOY_ZMOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },
1585
1586 // All joystick events
1587 #define EVT_JOYSTICK_EVENTS(func) \
1588 { wxEVT_JOY_BUTTON_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },\
1589 { wxEVT_JOY_BUTTON_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },\
1590 { wxEVT_JOY_MOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },\
1591 { wxEVT_JOY_ZMOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },\
1592
1593 // Idle event
1594 #define EVT_IDLE(func) \
1595 { wxEVT_IDLE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxIdleEventFunction) & func, (wxObject *) NULL },\
1596
1597 // Update UI event
1598 #define EVT_UPDATE_UI(id, func) \
1599 { wxEVT_UPDATE_UI, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxUpdateUIEventFunction) & func, (wxObject *) NULL },\
1600
1601 /*
1602 * Helper functions
1603 */
1604
1605 // Find a window with the focus, that is also a descendant of the given window.
1606 // This is used to determine the window to initially send commands to.
1607 wxWindow* wxFindFocusDescendant(wxWindow* ancestor);
1608
1609 #endif
1610 // _WX_EVENTH__