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