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