]> git.saurik.com Git - wxWidgets.git/blob - include/wx/event.h
added wxBG_STYLE_TRANSPARENT and implemented it for wxMac; documented various transpa...
[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) wxWidgets team
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_EVENT_H__
13 #define _WX_EVENT_H__
14
15 #include "wx/defs.h"
16 #include "wx/cpp.h"
17 #include "wx/object.h"
18 #include "wx/clntdata.h"
19
20 #if wxUSE_GUI
21 #include "wx/gdicmn.h"
22 #include "wx/cursor.h"
23 #endif
24
25 #include "wx/thread.h"
26
27 #include "wx/dynarray.h"
28
29 // ----------------------------------------------------------------------------
30 // forward declarations
31 // ----------------------------------------------------------------------------
32
33 class WXDLLIMPEXP_FWD_BASE wxList;
34
35 #if wxUSE_GUI
36 class WXDLLIMPEXP_FWD_CORE wxDC;
37 class WXDLLIMPEXP_FWD_CORE wxMenu;
38 class WXDLLIMPEXP_FWD_CORE wxWindow;
39 class WXDLLIMPEXP_FWD_CORE wxWindowBase;
40 #endif // wxUSE_GUI
41
42 class WXDLLIMPEXP_FWD_BASE wxEvtHandler;
43
44 // ----------------------------------------------------------------------------
45 // Event types
46 // ----------------------------------------------------------------------------
47
48 typedef int wxEventType;
49
50 #define wxEVT_ANY ((wxEventType)-1)
51
52 // this is used to make the event table entry type safe, so that for an event
53 // handler only a function with proper parameter list can be given.
54 #define wxStaticCastEvent(type, val) wx_static_cast(type, val)
55
56 // in previous versions of wxWidgets the event types used to be constants
57 // which created difficulties with custom/user event types definition
58 //
59 // starting from wxWidgets 2.4 the event types are now dynamically assigned
60 // using wxNewEventType() which solves this problem, however at price of
61 // several incompatibilities:
62 //
63 // a) event table macros declaration changed, it now uses wxEventTableEntry
64 // ctor instead of initialisation from an agregate - the macro
65 // DECLARE_EVENT_TABLE_ENTRY may be used to write code which can compile
66 // with all versions of wxWidgets
67 //
68 // b) event types can't be used as switch() cases as they're not really
69 // constant any more - there is no magic solution here, you just have to
70 // change the switch()es to if()s
71 //
72 // if these are real problems for you, define WXWIN_COMPATIBILITY_EVENT_TYPES
73 // as 1 to get 100% old behaviour, however you won't be able to use the
74 // libraries using the new dynamic event type allocation in such case, so avoid
75 // it if possible.
76 #ifndef WXWIN_COMPATIBILITY_EVENT_TYPES
77 #define WXWIN_COMPATIBILITY_EVENT_TYPES 0
78 #endif
79
80 #if WXWIN_COMPATIBILITY_EVENT_TYPES
81
82 #define DECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj) \
83 { type, winid, idLast, fn, obj }
84
85 #define BEGIN_DECLARE_EVENT_TYPES() enum {
86 #define END_DECLARE_EVENT_TYPES() };
87 #define DECLARE_EVENT_TYPE(name, value) name = wxEVT_FIRST + value,
88 #define DECLARE_LOCAL_EVENT_TYPE(name, value) name = wxEVT_USER_FIRST + value,
89 #define DECLARE_EXPORTED_EVENT_TYPE(expdecl, name, value) \
90 DECLARE_LOCAL_EVENT_TYPE(name, value)
91 #define DEFINE_EVENT_TYPE(name)
92 #define DEFINE_LOCAL_EVENT_TYPE(name)
93
94
95 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
96
97 #define DECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj) \
98 wxEventTableEntry(type, winid, idLast, fn, obj)
99
100 #define BEGIN_DECLARE_EVENT_TYPES()
101 #define END_DECLARE_EVENT_TYPES()
102 #define DECLARE_EXPORTED_EVENT_TYPE(expdecl, name, value) \
103 extern expdecl const wxEventType name;
104 #define DECLARE_EVENT_TYPE(name, value) \
105 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_CORE, name, value)
106 #define DECLARE_LOCAL_EVENT_TYPE(name, value) \
107 DECLARE_EXPORTED_EVENT_TYPE(wxEMPTY_PARAMETER_VALUE, name, value)
108 #define DEFINE_EVENT_TYPE(name) const wxEventType name = wxNewEventType();
109 #define DEFINE_LOCAL_EVENT_TYPE(name) DEFINE_EVENT_TYPE(name)
110
111 // generate a new unique event type
112 extern WXDLLIMPEXP_BASE wxEventType wxNewEventType();
113
114 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
115
116 BEGIN_DECLARE_EVENT_TYPES()
117
118 #if WXWIN_COMPATIBILITY_EVENT_TYPES
119 wxEVT_NULL = 0,
120 wxEVT_FIRST = 10000,
121 wxEVT_USER_FIRST = wxEVT_FIRST + 2000,
122 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
123 // it is important to still have these as constants to avoid
124 // initialization order related problems
125 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_NULL, 0)
126 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_FIRST, 10000)
127 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_USER_FIRST, wxEVT_FIRST + 2000)
128 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
129
130 DECLARE_EVENT_TYPE(wxEVT_COMMAND_BUTTON_CLICKED, 1)
131 DECLARE_EVENT_TYPE(wxEVT_COMMAND_CHECKBOX_CLICKED, 2)
132 DECLARE_EVENT_TYPE(wxEVT_COMMAND_CHOICE_SELECTED, 3)
133 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_SELECTED, 4)
134 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 5)
135 DECLARE_EVENT_TYPE(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 6)
136 // now they are in wx/textctrl.h
137 #if WXWIN_COMPATIBILITY_EVENT_TYPES
138 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_UPDATED, 7)
139 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_ENTER, 8)
140 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_URL, 13)
141 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_MAXLEN, 14)
142 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES
143 DECLARE_EVENT_TYPE(wxEVT_COMMAND_MENU_SELECTED, 9)
144 DECLARE_EVENT_TYPE(wxEVT_COMMAND_SLIDER_UPDATED, 10)
145 DECLARE_EVENT_TYPE(wxEVT_COMMAND_RADIOBOX_SELECTED, 11)
146 DECLARE_EVENT_TYPE(wxEVT_COMMAND_RADIOBUTTON_SELECTED, 12)
147
148 // wxEVT_COMMAND_SCROLLBAR_UPDATED is now obsolete since we use
149 // wxEVT_SCROLL... events
150
151 DECLARE_EVENT_TYPE(wxEVT_COMMAND_SCROLLBAR_UPDATED, 13)
152 DECLARE_EVENT_TYPE(wxEVT_COMMAND_VLBOX_SELECTED, 14)
153 DECLARE_EVENT_TYPE(wxEVT_COMMAND_COMBOBOX_SELECTED, 15)
154 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TOOL_RCLICKED, 16)
155 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TOOL_ENTER, 17)
156 DECLARE_EVENT_TYPE(wxEVT_COMMAND_SPINCTRL_UPDATED, 18)
157
158 // Toolbar dropdown arrows
159 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, 19)
160
161 // Sockets and timers send events, too
162 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_SOCKET, 50)
163 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_TIMER , 80)
164
165 // Mouse event types
166 DECLARE_EVENT_TYPE(wxEVT_LEFT_DOWN, 100)
167 DECLARE_EVENT_TYPE(wxEVT_LEFT_UP, 101)
168 DECLARE_EVENT_TYPE(wxEVT_MIDDLE_DOWN, 102)
169 DECLARE_EVENT_TYPE(wxEVT_MIDDLE_UP, 103)
170 DECLARE_EVENT_TYPE(wxEVT_RIGHT_DOWN, 104)
171 DECLARE_EVENT_TYPE(wxEVT_RIGHT_UP, 105)
172 DECLARE_EVENT_TYPE(wxEVT_MOTION, 106)
173 DECLARE_EVENT_TYPE(wxEVT_ENTER_WINDOW, 107)
174 DECLARE_EVENT_TYPE(wxEVT_LEAVE_WINDOW, 108)
175 DECLARE_EVENT_TYPE(wxEVT_LEFT_DCLICK, 109)
176 DECLARE_EVENT_TYPE(wxEVT_MIDDLE_DCLICK, 110)
177 DECLARE_EVENT_TYPE(wxEVT_RIGHT_DCLICK, 111)
178 DECLARE_EVENT_TYPE(wxEVT_SET_FOCUS, 112)
179 DECLARE_EVENT_TYPE(wxEVT_KILL_FOCUS, 113)
180 DECLARE_EVENT_TYPE(wxEVT_CHILD_FOCUS, 114)
181 DECLARE_EVENT_TYPE(wxEVT_MOUSEWHEEL, 115)
182 DECLARE_EVENT_TYPE(wxEVT_AUX1_DOWN, 116)
183 DECLARE_EVENT_TYPE(wxEVT_AUX1_UP, 117)
184 DECLARE_EVENT_TYPE(wxEVT_AUX1_DCLICK, 118)
185 DECLARE_EVENT_TYPE(wxEVT_AUX2_DOWN, 119)
186 DECLARE_EVENT_TYPE(wxEVT_AUX2_UP, 120)
187 DECLARE_EVENT_TYPE(wxEVT_AUX2_DCLICK, 121)
188
189 // Non-client mouse events
190 DECLARE_EVENT_TYPE(wxEVT_NC_LEFT_DOWN, 200)
191 DECLARE_EVENT_TYPE(wxEVT_NC_LEFT_UP, 201)
192 DECLARE_EVENT_TYPE(wxEVT_NC_MIDDLE_DOWN, 202)
193 DECLARE_EVENT_TYPE(wxEVT_NC_MIDDLE_UP, 203)
194 DECLARE_EVENT_TYPE(wxEVT_NC_RIGHT_DOWN, 204)
195 DECLARE_EVENT_TYPE(wxEVT_NC_RIGHT_UP, 205)
196 DECLARE_EVENT_TYPE(wxEVT_NC_MOTION, 206)
197 DECLARE_EVENT_TYPE(wxEVT_NC_ENTER_WINDOW, 207)
198 DECLARE_EVENT_TYPE(wxEVT_NC_LEAVE_WINDOW, 208)
199 DECLARE_EVENT_TYPE(wxEVT_NC_LEFT_DCLICK, 209)
200 DECLARE_EVENT_TYPE(wxEVT_NC_MIDDLE_DCLICK, 210)
201 DECLARE_EVENT_TYPE(wxEVT_NC_RIGHT_DCLICK, 211)
202
203 // Character input event type
204 DECLARE_EVENT_TYPE(wxEVT_CHAR, 212)
205 DECLARE_EVENT_TYPE(wxEVT_CHAR_HOOK, 213)
206 DECLARE_EVENT_TYPE(wxEVT_NAVIGATION_KEY, 214)
207 DECLARE_EVENT_TYPE(wxEVT_KEY_DOWN, 215)
208 DECLARE_EVENT_TYPE(wxEVT_KEY_UP, 216)
209 #if wxUSE_HOTKEY
210 DECLARE_EVENT_TYPE(wxEVT_HOTKEY, 217)
211 #endif
212 // Set cursor event
213 DECLARE_EVENT_TYPE(wxEVT_SET_CURSOR, 230)
214
215 // wxScrollBar and wxSlider event identifiers
216 DECLARE_EVENT_TYPE(wxEVT_SCROLL_TOP, 300)
217 DECLARE_EVENT_TYPE(wxEVT_SCROLL_BOTTOM, 301)
218 DECLARE_EVENT_TYPE(wxEVT_SCROLL_LINEUP, 302)
219 DECLARE_EVENT_TYPE(wxEVT_SCROLL_LINEDOWN, 303)
220 DECLARE_EVENT_TYPE(wxEVT_SCROLL_PAGEUP, 304)
221 DECLARE_EVENT_TYPE(wxEVT_SCROLL_PAGEDOWN, 305)
222 DECLARE_EVENT_TYPE(wxEVT_SCROLL_THUMBTRACK, 306)
223 DECLARE_EVENT_TYPE(wxEVT_SCROLL_THUMBRELEASE, 307)
224 DECLARE_EVENT_TYPE(wxEVT_SCROLL_CHANGED, 308)
225
226 // Scroll events from wxWindow
227 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_TOP, 320)
228 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_BOTTOM, 321)
229 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEUP, 322)
230 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEDOWN, 323)
231 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEUP, 324)
232 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEDOWN, 325)
233 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBTRACK, 326)
234 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBRELEASE, 327)
235
236 // System events
237 DECLARE_EVENT_TYPE(wxEVT_SIZE, 400)
238 DECLARE_EVENT_TYPE(wxEVT_MOVE, 401)
239 DECLARE_EVENT_TYPE(wxEVT_CLOSE_WINDOW, 402)
240 DECLARE_EVENT_TYPE(wxEVT_END_SESSION, 403)
241 DECLARE_EVENT_TYPE(wxEVT_QUERY_END_SESSION, 404)
242 DECLARE_EVENT_TYPE(wxEVT_ACTIVATE_APP, 405)
243 // 406..408 are power events
244 DECLARE_EVENT_TYPE(wxEVT_ACTIVATE, 409)
245 DECLARE_EVENT_TYPE(wxEVT_CREATE, 410)
246 DECLARE_EVENT_TYPE(wxEVT_DESTROY, 411)
247 DECLARE_EVENT_TYPE(wxEVT_SHOW, 412)
248 DECLARE_EVENT_TYPE(wxEVT_ICONIZE, 413)
249 DECLARE_EVENT_TYPE(wxEVT_MAXIMIZE, 414)
250 DECLARE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_CHANGED, 415)
251 DECLARE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_LOST, 416)
252 DECLARE_EVENT_TYPE(wxEVT_PAINT, 417)
253 DECLARE_EVENT_TYPE(wxEVT_ERASE_BACKGROUND, 418)
254 DECLARE_EVENT_TYPE(wxEVT_NC_PAINT, 419)
255 DECLARE_EVENT_TYPE(wxEVT_PAINT_ICON, 420)
256 DECLARE_EVENT_TYPE(wxEVT_MENU_OPEN, 421)
257 DECLARE_EVENT_TYPE(wxEVT_MENU_CLOSE, 422)
258 DECLARE_EVENT_TYPE(wxEVT_MENU_HIGHLIGHT, 423)
259 DECLARE_EVENT_TYPE(wxEVT_CONTEXT_MENU, 424)
260 DECLARE_EVENT_TYPE(wxEVT_SYS_COLOUR_CHANGED, 425)
261 DECLARE_EVENT_TYPE(wxEVT_DISPLAY_CHANGED, 426)
262 DECLARE_EVENT_TYPE(wxEVT_SETTING_CHANGED, 427)
263 DECLARE_EVENT_TYPE(wxEVT_QUERY_NEW_PALETTE, 428)
264 DECLARE_EVENT_TYPE(wxEVT_PALETTE_CHANGED, 429)
265 DECLARE_EVENT_TYPE(wxEVT_JOY_BUTTON_DOWN, 430)
266 DECLARE_EVENT_TYPE(wxEVT_JOY_BUTTON_UP, 431)
267 DECLARE_EVENT_TYPE(wxEVT_JOY_MOVE, 432)
268 DECLARE_EVENT_TYPE(wxEVT_JOY_ZMOVE, 433)
269 DECLARE_EVENT_TYPE(wxEVT_DROP_FILES, 434)
270 DECLARE_EVENT_TYPE(wxEVT_DRAW_ITEM, 435)
271 DECLARE_EVENT_TYPE(wxEVT_MEASURE_ITEM, 436)
272 DECLARE_EVENT_TYPE(wxEVT_COMPARE_ITEM, 437)
273 DECLARE_EVENT_TYPE(wxEVT_INIT_DIALOG, 438)
274 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_IDLE, 439)
275 DECLARE_EVENT_TYPE(wxEVT_UPDATE_UI, 440)
276 DECLARE_EVENT_TYPE(wxEVT_SIZING, 441)
277 DECLARE_EVENT_TYPE(wxEVT_MOVING, 442)
278 DECLARE_EVENT_TYPE(wxEVT_MOVE_START, 443)
279 DECLARE_EVENT_TYPE(wxEVT_MOVE_END, 444)
280 DECLARE_EVENT_TYPE(wxEVT_HIBERNATE, 445)
281 // more power events follow -- see wx/power.h
282
283 // Clipboard events
284 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_COPY, 446)
285 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_CUT, 447)
286 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_PASTE, 448)
287
288 // Generic command events
289 // Note: a click is a higher-level event than button down/up
290 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LEFT_CLICK, 500)
291 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LEFT_DCLICK, 501)
292 DECLARE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_CLICK, 502)
293 DECLARE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_DCLICK, 503)
294 DECLARE_EVENT_TYPE(wxEVT_COMMAND_SET_FOCUS, 504)
295 DECLARE_EVENT_TYPE(wxEVT_COMMAND_KILL_FOCUS, 505)
296 DECLARE_EVENT_TYPE(wxEVT_COMMAND_ENTER, 506)
297
298 // Help events
299 DECLARE_EVENT_TYPE(wxEVT_HELP, 1050)
300 DECLARE_EVENT_TYPE(wxEVT_DETAILED_HELP, 1051)
301
302 END_DECLARE_EVENT_TYPES()
303
304 // these 2 events are the same
305 #define wxEVT_COMMAND_TOOL_CLICKED wxEVT_COMMAND_MENU_SELECTED
306
307 // ----------------------------------------------------------------------------
308 // Compatibility
309 // ----------------------------------------------------------------------------
310
311 // this event is also used by wxComboBox and wxSpinCtrl which don't include
312 // wx/textctrl.h in all ports [yet], so declare it here as well
313 //
314 // still, any new code using it should include wx/textctrl.h explicitly
315 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
316 extern const wxEventType WXDLLIMPEXP_CORE wxEVT_COMMAND_TEXT_UPDATED;
317 #endif
318
319 // the predefined constants for the number of times we propagate event
320 // upwards window child-parent chain
321 enum Propagation_state
322 {
323 // don't propagate it at all
324 wxEVENT_PROPAGATE_NONE = 0,
325
326 // propagate it until it is processed
327 wxEVENT_PROPAGATE_MAX = INT_MAX
328 };
329
330 /*
331 * wxWidgets events, covering all interesting things that might happen
332 * (button clicking, resizing, setting text in widgets, etc.).
333 *
334 * For each completely new event type, derive a new event class.
335 * An event CLASS represents a C++ class defining a range of similar event TYPES;
336 * examples are canvas events, panel item command events.
337 * An event TYPE is a unique identifier for a particular system event,
338 * such as a button press or a listbox deselection.
339 *
340 */
341
342 class WXDLLIMPEXP_BASE wxEvent : public wxObject
343 {
344 private:
345 wxEvent& operator=(const wxEvent&);
346
347 protected:
348 wxEvent(const wxEvent&); // for implementing Clone()
349
350 public:
351 wxEvent(int winid = 0, wxEventType commandType = wxEVT_NULL );
352
353 void SetEventType(wxEventType typ) { m_eventType = typ; }
354 wxEventType GetEventType() const { return m_eventType; }
355 wxObject *GetEventObject() const { return m_eventObject; }
356 void SetEventObject(wxObject *obj) { m_eventObject = obj; }
357 long GetTimestamp() const { return m_timeStamp; }
358 void SetTimestamp(long ts = 0) { m_timeStamp = ts; }
359 int GetId() const { return m_id; }
360 void SetId(int Id) { m_id = Id; }
361
362 // Can instruct event processor that we wish to ignore this event
363 // (treat as if the event table entry had not been found): this must be done
364 // to allow the event processing by the base classes (calling event.Skip()
365 // is the analog of calling the base class version of a virtual function)
366 void Skip(bool skip = true) { m_skipped = skip; }
367 bool GetSkipped() const { return m_skipped; }
368
369 // this function is used to create a copy of the event polymorphically and
370 // all derived classes must implement it because otherwise wxPostEvent()
371 // for them wouldn't work (it needs to do a copy of the event)
372 virtual wxEvent *Clone() const = 0;
373
374 // Implementation only: this test is explicitly anti OO and this function
375 // exists only for optimization purposes.
376 bool IsCommandEvent() const { return m_isCommandEvent; }
377
378 // Determine if this event should be propagating to the parent window.
379 bool ShouldPropagate() const
380 { return m_propagationLevel != wxEVENT_PROPAGATE_NONE; }
381
382 // Stop an event from propagating to its parent window, returns the old
383 // propagation level value
384 int StopPropagation()
385 {
386 int propagationLevel = m_propagationLevel;
387 m_propagationLevel = wxEVENT_PROPAGATE_NONE;
388 return propagationLevel;
389 }
390
391 // Resume the event propagation by restoring the propagation level
392 // (returned by StopPropagation())
393 void ResumePropagation(int propagationLevel)
394 {
395 m_propagationLevel = propagationLevel;
396 }
397
398 protected:
399 wxObject* m_eventObject;
400 wxEventType m_eventType;
401 long m_timeStamp;
402 int m_id;
403
404 public:
405 // m_callbackUserData is for internal usage only
406 wxObject* m_callbackUserData;
407
408 protected:
409 // the propagation level: while it is positive, we propagate the event to
410 // the parent window (if any)
411 //
412 // this one doesn't have to be public, we don't have to worry about
413 // backwards compatibility as it is new
414 int m_propagationLevel;
415
416 protected:
417 bool m_skipped;
418 bool m_isCommandEvent;
419
420 private:
421 // it needs to access our m_propagationLevel
422 friend class WXDLLIMPEXP_FWD_BASE wxPropagateOnce;
423
424 DECLARE_ABSTRACT_CLASS(wxEvent)
425 };
426
427 /*
428 * Helper class to temporarily change an event not to propagate.
429 */
430 class WXDLLIMPEXP_BASE wxPropagationDisabler
431 {
432 public:
433 wxPropagationDisabler(wxEvent& event) : m_event(event)
434 {
435 m_propagationLevelOld = m_event.StopPropagation();
436 }
437
438 ~wxPropagationDisabler()
439 {
440 m_event.ResumePropagation(m_propagationLevelOld);
441 }
442
443 private:
444 wxEvent& m_event;
445 int m_propagationLevelOld;
446
447 DECLARE_NO_COPY_CLASS(wxPropagationDisabler)
448 };
449
450 /*
451 * Another one to temporarily lower propagation level.
452 */
453 class WXDLLIMPEXP_BASE wxPropagateOnce
454 {
455 public:
456 wxPropagateOnce(wxEvent& event) : m_event(event)
457 {
458 wxASSERT_MSG( m_event.m_propagationLevel > 0,
459 _T("shouldn't be used unless ShouldPropagate()!") );
460
461 m_event.m_propagationLevel--;
462 }
463
464 ~wxPropagateOnce()
465 {
466 m_event.m_propagationLevel++;
467 }
468
469 private:
470 wxEvent& m_event;
471
472 DECLARE_NO_COPY_CLASS(wxPropagateOnce)
473 };
474
475
476 #if wxUSE_GUI
477
478
479 // Item or menu event class
480 /*
481 wxEVT_COMMAND_BUTTON_CLICKED
482 wxEVT_COMMAND_CHECKBOX_CLICKED
483 wxEVT_COMMAND_CHOICE_SELECTED
484 wxEVT_COMMAND_LISTBOX_SELECTED
485 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
486 wxEVT_COMMAND_TEXT_UPDATED
487 wxEVT_COMMAND_TEXT_ENTER
488 wxEVT_COMMAND_MENU_SELECTED
489 wxEVT_COMMAND_SLIDER_UPDATED
490 wxEVT_COMMAND_RADIOBOX_SELECTED
491 wxEVT_COMMAND_RADIOBUTTON_SELECTED
492 wxEVT_COMMAND_SCROLLBAR_UPDATED
493 wxEVT_COMMAND_VLBOX_SELECTED
494 wxEVT_COMMAND_COMBOBOX_SELECTED
495 wxEVT_COMMAND_TOGGLEBUTTON_CLICKED
496 */
497
498 class WXDLLIMPEXP_CORE wxCommandEvent : public wxEvent
499 {
500 public:
501 wxCommandEvent(wxEventType commandType = wxEVT_NULL, int winid = 0);
502
503 wxCommandEvent(const wxCommandEvent& event)
504 : wxEvent(event),
505 m_cmdString(event.m_cmdString),
506 m_commandInt(event.m_commandInt),
507 m_extraLong(event.m_extraLong),
508 m_clientData(event.m_clientData),
509 m_clientObject(event.m_clientObject)
510 { }
511
512 // Set/Get client data from controls
513 void SetClientData(void* clientData) { m_clientData = clientData; }
514 void *GetClientData() const { return m_clientData; }
515
516 // Set/Get client object from controls
517 void SetClientObject(wxClientData* clientObject) { m_clientObject = clientObject; }
518 wxClientData *GetClientObject() const { return m_clientObject; }
519
520 // Get listbox selection if single-choice
521 int GetSelection() const { return m_commandInt; }
522
523 // Set/Get listbox/choice selection string
524 void SetString(const wxString& s) { m_cmdString = s; }
525 wxString GetString() const;
526
527 // Get checkbox value
528 bool IsChecked() const { return m_commandInt != 0; }
529
530 // true if the listbox event was a selection.
531 bool IsSelection() const { return (m_extraLong != 0); }
532
533 void SetExtraLong(long extraLong) { m_extraLong = extraLong; }
534 long GetExtraLong() const { return m_extraLong; }
535
536 void SetInt(int i) { m_commandInt = i; }
537 int GetInt() const { return m_commandInt; }
538
539 virtual wxEvent *Clone() const { return new wxCommandEvent(*this); }
540
541 protected:
542 wxString m_cmdString; // String event argument
543 int m_commandInt;
544 long m_extraLong; // Additional information (e.g. select/deselect)
545 void* m_clientData; // Arbitrary client data
546 wxClientData* m_clientObject; // Arbitrary client object
547
548 private:
549 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCommandEvent)
550 };
551
552 // this class adds a possibility to react (from the user) code to a control
553 // notification: allow or veto the operation being reported.
554 class WXDLLIMPEXP_CORE wxNotifyEvent : public wxCommandEvent
555 {
556 public:
557 wxNotifyEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
558 : wxCommandEvent(commandType, winid)
559 { m_bAllow = true; }
560
561 wxNotifyEvent(const wxNotifyEvent& event)
562 : wxCommandEvent(event)
563 { m_bAllow = event.m_bAllow; }
564
565 // veto the operation (usually it's allowed by default)
566 void Veto() { m_bAllow = false; }
567
568 // allow the operation if it was disabled by default
569 void Allow() { m_bAllow = true; }
570
571 // for implementation code only: is the operation allowed?
572 bool IsAllowed() const { return m_bAllow; }
573
574 virtual wxEvent *Clone() const { return new wxNotifyEvent(*this); }
575
576 private:
577 bool m_bAllow;
578
579 private:
580 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNotifyEvent)
581 };
582
583 // Scroll event class, derived form wxCommandEvent. wxScrollEvents are
584 // sent by wxSlider and wxScrollBar.
585 /*
586 wxEVT_SCROLL_TOP
587 wxEVT_SCROLL_BOTTOM
588 wxEVT_SCROLL_LINEUP
589 wxEVT_SCROLL_LINEDOWN
590 wxEVT_SCROLL_PAGEUP
591 wxEVT_SCROLL_PAGEDOWN
592 wxEVT_SCROLL_THUMBTRACK
593 wxEVT_SCROLL_THUMBRELEASE
594 wxEVT_SCROLL_CHANGED
595 */
596
597 class WXDLLIMPEXP_CORE wxScrollEvent : public wxCommandEvent
598 {
599 public:
600 wxScrollEvent(wxEventType commandType = wxEVT_NULL,
601 int winid = 0, int pos = 0, int orient = 0);
602
603 int GetOrientation() const { return (int) m_extraLong; }
604 int GetPosition() const { return m_commandInt; }
605 void SetOrientation(int orient) { m_extraLong = (long) orient; }
606 void SetPosition(int pos) { m_commandInt = pos; }
607
608 virtual wxEvent *Clone() const { return new wxScrollEvent(*this); }
609
610 private:
611 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollEvent)
612 };
613
614 // ScrollWin event class, derived fom wxEvent. wxScrollWinEvents
615 // are sent by wxWindow.
616 /*
617 wxEVT_SCROLLWIN_TOP
618 wxEVT_SCROLLWIN_BOTTOM
619 wxEVT_SCROLLWIN_LINEUP
620 wxEVT_SCROLLWIN_LINEDOWN
621 wxEVT_SCROLLWIN_PAGEUP
622 wxEVT_SCROLLWIN_PAGEDOWN
623 wxEVT_SCROLLWIN_THUMBTRACK
624 wxEVT_SCROLLWIN_THUMBRELEASE
625 */
626
627 class WXDLLIMPEXP_CORE wxScrollWinEvent : public wxEvent
628 {
629 public:
630 wxScrollWinEvent(wxEventType commandType = wxEVT_NULL,
631 int pos = 0, int orient = 0);
632 wxScrollWinEvent(const wxScrollWinEvent & event) : wxEvent(event)
633 { m_commandInt = event.m_commandInt;
634 m_extraLong = event.m_extraLong; }
635
636 int GetOrientation() const { return (int) m_extraLong; }
637 int GetPosition() const { return m_commandInt; }
638 void SetOrientation(int orient) { m_extraLong = (long) orient; }
639 void SetPosition(int pos) { m_commandInt = pos; }
640
641 virtual wxEvent *Clone() const { return new wxScrollWinEvent(*this); }
642
643 protected:
644 int m_commandInt;
645 long m_extraLong;
646
647 private:
648 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollWinEvent)
649 };
650
651 // Mouse event class
652
653 /*
654 wxEVT_LEFT_DOWN
655 wxEVT_LEFT_UP
656 wxEVT_MIDDLE_DOWN
657 wxEVT_MIDDLE_UP
658 wxEVT_RIGHT_DOWN
659 wxEVT_RIGHT_UP
660 wxEVT_MOTION
661 wxEVT_ENTER_WINDOW
662 wxEVT_LEAVE_WINDOW
663 wxEVT_LEFT_DCLICK
664 wxEVT_MIDDLE_DCLICK
665 wxEVT_RIGHT_DCLICK
666 wxEVT_NC_LEFT_DOWN
667 wxEVT_NC_LEFT_UP,
668 wxEVT_NC_MIDDLE_DOWN,
669 wxEVT_NC_MIDDLE_UP,
670 wxEVT_NC_RIGHT_DOWN,
671 wxEVT_NC_RIGHT_UP,
672 wxEVT_NC_MOTION,
673 wxEVT_NC_ENTER_WINDOW,
674 wxEVT_NC_LEAVE_WINDOW,
675 wxEVT_NC_LEFT_DCLICK,
676 wxEVT_NC_MIDDLE_DCLICK,
677 wxEVT_NC_RIGHT_DCLICK,
678 */
679
680 // the symbolic names for the mouse buttons
681 enum
682 {
683 wxMOUSE_BTN_ANY = -1,
684 wxMOUSE_BTN_NONE = 0,
685 wxMOUSE_BTN_LEFT = 1,
686 wxMOUSE_BTN_MIDDLE = 2,
687 wxMOUSE_BTN_RIGHT = 3,
688 wxMOUSE_BTN_AUX1 = 4,
689 wxMOUSE_BTN_AUX2 = 5,
690 wxMOUSE_BTN_MAX
691 };
692
693 class WXDLLIMPEXP_CORE wxMouseEvent : public wxEvent
694 {
695 public:
696 wxMouseEvent(wxEventType mouseType = wxEVT_NULL);
697 wxMouseEvent(const wxMouseEvent& event) : wxEvent(event)
698 { Assign(event); }
699
700 // Was it a button event? (*doesn't* mean: is any button *down*?)
701 bool IsButton() const { return Button(wxMOUSE_BTN_ANY); }
702
703 // Was it a down event from this (or any) button?
704 bool ButtonDown(int but = wxMOUSE_BTN_ANY) const;
705
706 // Was it a dclick event from this (or any) button?
707 bool ButtonDClick(int but = wxMOUSE_BTN_ANY) const;
708
709 // Was it a up event from this (or any) button?
710 bool ButtonUp(int but = wxMOUSE_BTN_ANY) const;
711
712 // Was the given button?
713 bool Button(int but) const;
714
715 // Was the given button in Down state?
716 bool ButtonIsDown(int but) const;
717
718 // Get the button which is changing state (wxMOUSE_BTN_NONE if none)
719 int GetButton() const;
720
721 // Find state of shift/control keys
722 bool ControlDown() const { return m_controlDown; }
723 bool MetaDown() const { return m_metaDown; }
724 bool AltDown() const { return m_altDown; }
725 bool ShiftDown() const { return m_shiftDown; }
726 bool CmdDown() const
727 {
728 #if defined(__WXMAC__) || defined(__WXCOCOA__)
729 return MetaDown();
730 #else
731 return ControlDown();
732 #endif
733 }
734
735 // Find which event was just generated
736 bool LeftDown() const { return (m_eventType == wxEVT_LEFT_DOWN); }
737 bool MiddleDown() const { return (m_eventType == wxEVT_MIDDLE_DOWN); }
738 bool RightDown() const { return (m_eventType == wxEVT_RIGHT_DOWN); }
739 bool Aux1Down() const { return (m_eventType == wxEVT_AUX1_DOWN); }
740 bool Aux2Down() const { return (m_eventType == wxEVT_AUX2_DOWN); }
741
742 bool LeftUp() const { return (m_eventType == wxEVT_LEFT_UP); }
743 bool MiddleUp() const { return (m_eventType == wxEVT_MIDDLE_UP); }
744 bool RightUp() const { return (m_eventType == wxEVT_RIGHT_UP); }
745 bool Aux1Up() const { return (m_eventType == wxEVT_AUX1_UP); }
746 bool Aux2Up() const { return (m_eventType == wxEVT_AUX2_UP); }
747
748 bool LeftDClick() const { return (m_eventType == wxEVT_LEFT_DCLICK); }
749 bool MiddleDClick() const { return (m_eventType == wxEVT_MIDDLE_DCLICK); }
750 bool RightDClick() const { return (m_eventType == wxEVT_RIGHT_DCLICK); }
751 bool Aux1DClick() const { return (m_eventType == wxEVT_AUX1_UP); }
752 bool Aux2DClick() const { return (m_eventType == wxEVT_AUX2_UP); }
753
754 // Find the current state of the mouse buttons (regardless
755 // of current event type)
756 bool LeftIsDown() const { return m_leftDown; }
757 bool MiddleIsDown() const { return m_middleDown; }
758 bool RightIsDown() const { return m_rightDown; }
759 bool Aux1IsDown() const { return m_aux1Down; }
760 bool Aux2IsDown() const { return m_aux2Down; }
761
762 // True if a button is down and the mouse is moving
763 bool Dragging() const
764 {
765 return (m_eventType == wxEVT_MOTION) && ButtonIsDown(wxMOUSE_BTN_ANY);
766 }
767
768 // True if the mouse is moving, and no button is down
769 bool Moving() const
770 {
771 return (m_eventType == wxEVT_MOTION) && !ButtonIsDown(wxMOUSE_BTN_ANY);
772 }
773
774 // True if the mouse is just entering the window
775 bool Entering() const { return (m_eventType == wxEVT_ENTER_WINDOW); }
776
777 // True if the mouse is just leaving the window
778 bool Leaving() const { return (m_eventType == wxEVT_LEAVE_WINDOW); }
779
780 // Find the position of the event
781 void GetPosition(wxCoord *xpos, wxCoord *ypos) const
782 {
783 if (xpos)
784 *xpos = m_x;
785 if (ypos)
786 *ypos = m_y;
787 }
788
789 void GetPosition(long *xpos, long *ypos) const
790 {
791 if (xpos)
792 *xpos = (long)m_x;
793 if (ypos)
794 *ypos = (long)m_y;
795 }
796
797 // Find the position of the event
798 wxPoint GetPosition() const { return wxPoint(m_x, m_y); }
799
800 // Find the logical position of the event given the DC
801 wxPoint GetLogicalPosition(const wxDC& dc) const;
802
803 // Get X position
804 wxCoord GetX() const { return m_x; }
805
806 // Get Y position
807 wxCoord GetY() const { return m_y; }
808
809 // Get wheel rotation, positive or negative indicates direction of
810 // rotation. Current devices all send an event when rotation is equal to
811 // +/-WheelDelta, but this allows for finer resolution devices to be
812 // created in the future. Because of this you shouldn't assume that one
813 // event is equal to 1 line or whatever, but you should be able to either
814 // do partial line scrolling or wait until +/-WheelDelta rotation values
815 // have been accumulated before scrolling.
816 int GetWheelRotation() const { return m_wheelRotation; }
817
818 // Get wheel delta, normally 120. This is the threshold for action to be
819 // taken, and one such action (for example, scrolling one increment)
820 // should occur for each delta.
821 int GetWheelDelta() const { return m_wheelDelta; }
822
823 // Gets the axis the wheel operation concerns, 0 being the y axis as on
824 // most mouse wheels, 1 is the x axis for things like MightyMouse scrolls
825 // or horizontal trackpad scrolling
826 int GetWheelAxis() const { return m_wheelAxis; }
827
828 // Returns the configured number of lines (or whatever) to be scrolled per
829 // wheel action. Defaults to one.
830 int GetLinesPerAction() const { return m_linesPerAction; }
831
832 // Is the system set to do page scrolling?
833 bool IsPageScroll() const { return ((unsigned int)m_linesPerAction == UINT_MAX); }
834
835 virtual wxEvent *Clone() const { return new wxMouseEvent(*this); }
836
837 wxMouseEvent& operator=(const wxMouseEvent& event) { Assign(event); return *this; }
838
839 public:
840 wxCoord m_x, m_y;
841
842 bool m_leftDown;
843 bool m_middleDown;
844 bool m_rightDown;
845 bool m_aux1Down;
846 bool m_aux2Down;
847
848 bool m_controlDown;
849 bool m_shiftDown;
850 bool m_altDown;
851 bool m_metaDown;
852
853 int m_wheelAxis;
854 int m_wheelRotation;
855 int m_wheelDelta;
856 int m_linesPerAction;
857
858 protected:
859 void Assign(const wxMouseEvent& evt);
860
861 private:
862 DECLARE_DYNAMIC_CLASS(wxMouseEvent)
863 };
864
865 // Cursor set event
866
867 /*
868 wxEVT_SET_CURSOR
869 */
870
871 class WXDLLIMPEXP_CORE wxSetCursorEvent : public wxEvent
872 {
873 public:
874 wxSetCursorEvent(wxCoord x = 0, wxCoord y = 0)
875 : wxEvent(0, wxEVT_SET_CURSOR),
876 m_x(x), m_y(y), m_cursor()
877 { }
878
879 wxSetCursorEvent(const wxSetCursorEvent & event)
880 : wxEvent(event),
881 m_x(event.m_x),
882 m_y(event.m_y),
883 m_cursor(event.m_cursor)
884 { }
885
886 wxCoord GetX() const { return m_x; }
887 wxCoord GetY() const { return m_y; }
888
889 void SetCursor(const wxCursor& cursor) { m_cursor = cursor; }
890 const wxCursor& GetCursor() const { return m_cursor; }
891 bool HasCursor() const { return m_cursor.Ok(); }
892
893 virtual wxEvent *Clone() const { return new wxSetCursorEvent(*this); }
894
895 private:
896 wxCoord m_x, m_y;
897 wxCursor m_cursor;
898
899 private:
900 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSetCursorEvent)
901 };
902
903 // Keyboard input event class
904
905 /*
906 wxEVT_CHAR
907 wxEVT_CHAR_HOOK
908 wxEVT_KEY_DOWN
909 wxEVT_KEY_UP
910 wxEVT_HOTKEY
911 */
912
913 class WXDLLIMPEXP_CORE wxKeyEvent : public wxEvent
914 {
915 public:
916 wxKeyEvent(wxEventType keyType = wxEVT_NULL);
917 wxKeyEvent(const wxKeyEvent& evt);
918
919 // can be used check if the key event has exactly the given modifiers:
920 // "GetModifiers() = wxMOD_CONTROL" is easier to write than "ControlDown()
921 // && !MetaDown() && !AltDown() && !ShiftDown()"
922 int GetModifiers() const
923 {
924 return (m_controlDown ? wxMOD_CONTROL : 0) |
925 (m_shiftDown ? wxMOD_SHIFT : 0) |
926 (m_metaDown ? wxMOD_META : 0) |
927 (m_altDown ? wxMOD_ALT : 0);
928 }
929
930 // Find state of shift/control keys
931 bool ControlDown() const { return m_controlDown; }
932 bool ShiftDown() const { return m_shiftDown; }
933 bool MetaDown() const { return m_metaDown; }
934 bool AltDown() const { return m_altDown; }
935
936 // "Cmd" is a pseudo key which is Control for PC and Unix platforms but
937 // Apple ("Command") key under Macs: it makes often sense to use it instead
938 // of, say, ControlDown() because Cmd key is used for the same thing under
939 // Mac as Ctrl elsewhere (but Ctrl still exists, just not used for this
940 // purpose under Mac)
941 bool CmdDown() const
942 {
943 #if defined(__WXMAC__) || defined(__WXCOCOA__)
944 return MetaDown();
945 #else
946 return ControlDown();
947 #endif
948 }
949
950 // exclude MetaDown() from HasModifiers() because NumLock under X is often
951 // configured as mod2 modifier, yet the key events even when it is pressed
952 // should be processed normally, not like Ctrl- or Alt-key
953 bool HasModifiers() const { return ControlDown() || AltDown(); }
954
955 // get the key code: an ASCII7 char or an element of wxKeyCode enum
956 int GetKeyCode() const { return (int)m_keyCode; }
957
958 #if wxUSE_UNICODE
959 // get the Unicode character corresponding to this key
960 wxChar GetUnicodeKey() const { return m_uniChar; }
961 #endif // wxUSE_UNICODE
962
963 // get the raw key code (platform-dependent)
964 wxUint32 GetRawKeyCode() const { return m_rawCode; }
965
966 // get the raw key flags (platform-dependent)
967 wxUint32 GetRawKeyFlags() const { return m_rawFlags; }
968
969 // Find the position of the event
970 void GetPosition(wxCoord *xpos, wxCoord *ypos) const
971 {
972 if (xpos) *xpos = m_x;
973 if (ypos) *ypos = m_y;
974 }
975
976 void GetPosition(long *xpos, long *ypos) const
977 {
978 if (xpos) *xpos = (long)m_x;
979 if (ypos) *ypos = (long)m_y;
980 }
981
982 wxPoint GetPosition() const
983 { return wxPoint(m_x, m_y); }
984
985 // Get X position
986 wxCoord GetX() const { return m_x; }
987
988 // Get Y position
989 wxCoord GetY() const { return m_y; }
990
991 #if WXWIN_COMPATIBILITY_2_6
992 // deprecated, Use GetKeyCode instead.
993 wxDEPRECATED( long KeyCode() const );
994 #endif // WXWIN_COMPATIBILITY_2_6
995
996 virtual wxEvent *Clone() const { return new wxKeyEvent(*this); }
997
998 // we do need to copy wxKeyEvent sometimes (in wxTreeCtrl code, for
999 // example)
1000 wxKeyEvent& operator=(const wxKeyEvent& evt)
1001 {
1002 m_x = evt.m_x;
1003 m_y = evt.m_y;
1004
1005 m_keyCode = evt.m_keyCode;
1006
1007 m_controlDown = evt.m_controlDown;
1008 m_shiftDown = evt.m_shiftDown;
1009 m_altDown = evt.m_altDown;
1010 m_metaDown = evt.m_metaDown;
1011 m_scanCode = evt.m_scanCode;
1012 m_rawCode = evt.m_rawCode;
1013 m_rawFlags = evt.m_rawFlags;
1014 #if wxUSE_UNICODE
1015 m_uniChar = evt.m_uniChar;
1016 #endif
1017
1018 return *this;
1019 }
1020
1021 public:
1022 wxCoord m_x, m_y;
1023
1024 long m_keyCode;
1025
1026 // TODO: replace those with a single m_modifiers bitmask of wxMOD_XXX?
1027 bool m_controlDown;
1028 bool m_shiftDown;
1029 bool m_altDown;
1030 bool m_metaDown;
1031
1032 // FIXME: what is this for? relation to m_rawXXX?
1033 bool m_scanCode;
1034
1035 #if wxUSE_UNICODE
1036 // This contains the full Unicode character
1037 // in a character events in Unicode mode
1038 wxChar m_uniChar;
1039 #endif
1040
1041 // these fields contain the platform-specific information about
1042 // key that was pressed
1043 wxUint32 m_rawCode;
1044 wxUint32 m_rawFlags;
1045
1046 private:
1047 DECLARE_DYNAMIC_CLASS(wxKeyEvent)
1048 };
1049
1050 // Size event class
1051 /*
1052 wxEVT_SIZE
1053 */
1054
1055 class WXDLLIMPEXP_CORE wxSizeEvent : public wxEvent
1056 {
1057 public:
1058 wxSizeEvent() : wxEvent(0, wxEVT_SIZE)
1059 { }
1060 wxSizeEvent(const wxSize& sz, int winid = 0)
1061 : wxEvent(winid, wxEVT_SIZE),
1062 m_size(sz)
1063 { }
1064 wxSizeEvent(const wxSizeEvent & event)
1065 : wxEvent(event),
1066 m_size(event.m_size), m_rect(event.m_rect)
1067 { }
1068 wxSizeEvent(const wxRect& rect, int id = 0)
1069 : m_size(rect.GetSize()), m_rect(rect)
1070 { m_eventType = wxEVT_SIZING; m_id = id; }
1071
1072 wxSize GetSize() const { return m_size; }
1073 wxRect GetRect() const { return m_rect; }
1074 void SetRect(const wxRect& rect) { m_rect = rect; }
1075
1076 virtual wxEvent *Clone() const { return new wxSizeEvent(*this); }
1077
1078 public:
1079 // For internal usage only. Will be converted to protected members.
1080 wxSize m_size;
1081 wxRect m_rect; // Used for wxEVT_SIZING
1082
1083 private:
1084 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSizeEvent)
1085 };
1086
1087 // Move event class
1088
1089 /*
1090 wxEVT_MOVE
1091 */
1092
1093 class WXDLLIMPEXP_CORE wxMoveEvent : public wxEvent
1094 {
1095 public:
1096 wxMoveEvent()
1097 : wxEvent(0, wxEVT_MOVE)
1098 { }
1099 wxMoveEvent(const wxPoint& pos, int winid = 0)
1100 : wxEvent(winid, wxEVT_MOVE),
1101 m_pos(pos)
1102 { }
1103 wxMoveEvent(const wxMoveEvent& event)
1104 : wxEvent(event),
1105 m_pos(event.m_pos)
1106 { }
1107 wxMoveEvent(const wxRect& rect, int id = 0)
1108 : m_pos(rect.GetPosition()), m_rect(rect)
1109 { m_eventType = wxEVT_MOVING; m_id = id; }
1110
1111 wxPoint GetPosition() const { return m_pos; }
1112 void SetPosition(const wxPoint& pos) { m_pos = pos; }
1113 wxRect GetRect() const { return m_rect; }
1114 void SetRect(const wxRect& rect) { m_rect = rect; }
1115
1116 virtual wxEvent *Clone() const { return new wxMoveEvent(*this); }
1117
1118 protected:
1119 wxPoint m_pos;
1120 wxRect m_rect;
1121
1122 private:
1123 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMoveEvent)
1124 };
1125
1126 // Paint event class
1127 /*
1128 wxEVT_PAINT
1129 wxEVT_NC_PAINT
1130 wxEVT_PAINT_ICON
1131 */
1132
1133 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1134 // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined
1135 extern WXDLLIMPEXP_CORE int g_isPainting;
1136 #endif // debug
1137
1138 class WXDLLIMPEXP_CORE wxPaintEvent : public wxEvent
1139 {
1140 public:
1141 wxPaintEvent(int Id = 0)
1142 : wxEvent(Id, wxEVT_PAINT)
1143 {
1144 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1145 // set the internal flag for the duration of processing of WM_PAINT
1146 g_isPainting++;
1147 #endif // debug
1148 }
1149
1150 // default copy ctor and dtor are normally fine, we only need them to keep
1151 // g_isPainting updated in debug build
1152 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1153 wxPaintEvent(const wxPaintEvent& event)
1154 : wxEvent(event)
1155 {
1156 g_isPainting++;
1157 }
1158
1159 virtual ~wxPaintEvent()
1160 {
1161 g_isPainting--;
1162 }
1163 #endif // debug
1164
1165 virtual wxEvent *Clone() const { return new wxPaintEvent(*this); }
1166
1167 private:
1168 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaintEvent)
1169 };
1170
1171 class WXDLLIMPEXP_CORE wxNcPaintEvent : public wxEvent
1172 {
1173 public:
1174 wxNcPaintEvent(int winid = 0)
1175 : wxEvent(winid, wxEVT_NC_PAINT)
1176 { }
1177
1178 virtual wxEvent *Clone() const { return new wxNcPaintEvent(*this); }
1179
1180 private:
1181 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNcPaintEvent)
1182 };
1183
1184 // Erase background event class
1185 /*
1186 wxEVT_ERASE_BACKGROUND
1187 */
1188
1189 class WXDLLIMPEXP_CORE wxEraseEvent : public wxEvent
1190 {
1191 public:
1192 wxEraseEvent(int Id = 0, wxDC *dc = (wxDC *) NULL)
1193 : wxEvent(Id, wxEVT_ERASE_BACKGROUND),
1194 m_dc(dc)
1195 { }
1196
1197 wxEraseEvent(const wxEraseEvent& event)
1198 : wxEvent(event),
1199 m_dc(event.m_dc)
1200 { }
1201
1202 wxDC *GetDC() const { return m_dc; }
1203
1204 virtual wxEvent *Clone() const { return new wxEraseEvent(*this); }
1205
1206 protected:
1207 wxDC *m_dc;
1208
1209 private:
1210 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxEraseEvent)
1211 };
1212
1213 // Focus event class
1214 /*
1215 wxEVT_SET_FOCUS
1216 wxEVT_KILL_FOCUS
1217 */
1218
1219 class WXDLLIMPEXP_CORE wxFocusEvent : public wxEvent
1220 {
1221 public:
1222 wxFocusEvent(wxEventType type = wxEVT_NULL, int winid = 0)
1223 : wxEvent(winid, type)
1224 { m_win = NULL; }
1225
1226 wxFocusEvent(const wxFocusEvent& event)
1227 : wxEvent(event)
1228 { m_win = event.m_win; }
1229
1230 // The window associated with this event is the window which had focus
1231 // before for SET event and the window which will have focus for the KILL
1232 // one. NB: it may be NULL in both cases!
1233 wxWindow *GetWindow() const { return m_win; }
1234 void SetWindow(wxWindow *win) { m_win = win; }
1235
1236 virtual wxEvent *Clone() const { return new wxFocusEvent(*this); }
1237
1238 private:
1239 wxWindow *m_win;
1240
1241 private:
1242 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFocusEvent)
1243 };
1244
1245 // wxChildFocusEvent notifies the parent that a child has got the focus: unlike
1246 // wxFocusEvent it is propagated upwards the window chain
1247 class WXDLLIMPEXP_CORE wxChildFocusEvent : public wxCommandEvent
1248 {
1249 public:
1250 wxChildFocusEvent(wxWindow *win = NULL);
1251
1252 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1253
1254 virtual wxEvent *Clone() const { return new wxChildFocusEvent(*this); }
1255
1256 private:
1257 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxChildFocusEvent)
1258 };
1259
1260 // Activate event class
1261 /*
1262 wxEVT_ACTIVATE
1263 wxEVT_ACTIVATE_APP
1264 wxEVT_HIBERNATE
1265 */
1266
1267 class WXDLLIMPEXP_CORE wxActivateEvent : public wxEvent
1268 {
1269 public:
1270 wxActivateEvent(wxEventType type = wxEVT_NULL, bool active = true, int Id = 0)
1271 : wxEvent(Id, type)
1272 { m_active = active; }
1273 wxActivateEvent(const wxActivateEvent& event)
1274 : wxEvent(event)
1275 { m_active = event.m_active; }
1276
1277 bool GetActive() const { return m_active; }
1278
1279 virtual wxEvent *Clone() const { return new wxActivateEvent(*this); }
1280
1281 private:
1282 bool m_active;
1283
1284 private:
1285 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxActivateEvent)
1286 };
1287
1288 // InitDialog event class
1289 /*
1290 wxEVT_INIT_DIALOG
1291 */
1292
1293 class WXDLLIMPEXP_CORE wxInitDialogEvent : public wxEvent
1294 {
1295 public:
1296 wxInitDialogEvent(int Id = 0)
1297 : wxEvent(Id, wxEVT_INIT_DIALOG)
1298 { }
1299
1300 virtual wxEvent *Clone() const { return new wxInitDialogEvent(*this); }
1301
1302 private:
1303 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxInitDialogEvent)
1304 };
1305
1306 // Miscellaneous menu event class
1307 /*
1308 wxEVT_MENU_OPEN,
1309 wxEVT_MENU_CLOSE,
1310 wxEVT_MENU_HIGHLIGHT,
1311 */
1312
1313 class WXDLLIMPEXP_CORE wxMenuEvent : public wxEvent
1314 {
1315 public:
1316 wxMenuEvent(wxEventType type = wxEVT_NULL, int winid = 0, wxMenu* menu = NULL)
1317 : wxEvent(winid, type)
1318 { m_menuId = winid; m_menu = menu; }
1319 wxMenuEvent(const wxMenuEvent & event)
1320 : wxEvent(event)
1321 { m_menuId = event.m_menuId; m_menu = event.m_menu; }
1322
1323 // only for wxEVT_MENU_HIGHLIGHT
1324 int GetMenuId() const { return m_menuId; }
1325
1326 // only for wxEVT_MENU_OPEN/CLOSE
1327 bool IsPopup() const { return m_menuId == wxID_ANY; }
1328
1329 // only for wxEVT_MENU_OPEN/CLOSE
1330 wxMenu* GetMenu() const { return m_menu; }
1331
1332 virtual wxEvent *Clone() const { return new wxMenuEvent(*this); }
1333
1334 private:
1335 int m_menuId;
1336 wxMenu* m_menu;
1337
1338 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMenuEvent)
1339 };
1340
1341 // Window close or session close event class
1342 /*
1343 wxEVT_CLOSE_WINDOW,
1344 wxEVT_END_SESSION,
1345 wxEVT_QUERY_END_SESSION
1346 */
1347
1348 class WXDLLIMPEXP_CORE wxCloseEvent : public wxEvent
1349 {
1350 public:
1351 wxCloseEvent(wxEventType type = wxEVT_NULL, int winid = 0)
1352 : wxEvent(winid, type),
1353 m_loggingOff(true),
1354 m_veto(false), // should be false by default
1355 m_canVeto(true) {}
1356
1357 wxCloseEvent(const wxCloseEvent & event)
1358 : wxEvent(event),
1359 m_loggingOff(event.m_loggingOff),
1360 m_veto(event.m_veto),
1361 m_canVeto(event.m_canVeto) {}
1362
1363 void SetLoggingOff(bool logOff) { m_loggingOff = logOff; }
1364 bool GetLoggingOff() const
1365 {
1366 // m_loggingOff flag is only used by wxEVT_[QUERY_]END_SESSION, it
1367 // doesn't make sense for wxEVT_CLOSE_WINDOW
1368 wxASSERT_MSG( m_eventType != wxEVT_CLOSE_WINDOW,
1369 _T("this flag is for end session events only") );
1370
1371 return m_loggingOff;
1372 }
1373
1374 void Veto(bool veto = true)
1375 {
1376 // GetVeto() will return false anyhow...
1377 wxCHECK_RET( m_canVeto,
1378 wxT("call to Veto() ignored (can't veto this event)") );
1379
1380 m_veto = veto;
1381 }
1382 void SetCanVeto(bool canVeto) { m_canVeto = canVeto; }
1383 bool CanVeto() const { return m_canVeto; }
1384 bool GetVeto() const { return m_canVeto && m_veto; }
1385
1386 virtual wxEvent *Clone() const { return new wxCloseEvent(*this); }
1387
1388 protected:
1389 bool m_loggingOff,
1390 m_veto,
1391 m_canVeto;
1392
1393 private:
1394 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCloseEvent)
1395 };
1396
1397 /*
1398 wxEVT_SHOW
1399 */
1400
1401 class WXDLLIMPEXP_CORE wxShowEvent : public wxEvent
1402 {
1403 public:
1404 wxShowEvent(int winid = 0, bool show = false)
1405 : wxEvent(winid, wxEVT_SHOW)
1406 { m_show = show; }
1407 wxShowEvent(const wxShowEvent & event)
1408 : wxEvent(event)
1409 { m_show = event.m_show; }
1410
1411 void SetShow(bool show) { m_show = show; }
1412 bool GetShow() const { return m_show; }
1413
1414 virtual wxEvent *Clone() const { return new wxShowEvent(*this); }
1415
1416 protected:
1417 bool m_show;
1418
1419 private:
1420 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxShowEvent)
1421 };
1422
1423 /*
1424 wxEVT_ICONIZE
1425 */
1426
1427 class WXDLLIMPEXP_CORE wxIconizeEvent : public wxEvent
1428 {
1429 public:
1430 wxIconizeEvent(int winid = 0, bool iconized = true)
1431 : wxEvent(winid, wxEVT_ICONIZE)
1432 { m_iconized = iconized; }
1433 wxIconizeEvent(const wxIconizeEvent & event)
1434 : wxEvent(event)
1435 { m_iconized = event.m_iconized; }
1436
1437 // return true if the frame was iconized, false if restored
1438 bool Iconized() const { return m_iconized; }
1439
1440 virtual wxEvent *Clone() const { return new wxIconizeEvent(*this); }
1441
1442 protected:
1443 bool m_iconized;
1444
1445 private:
1446 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIconizeEvent)
1447 };
1448 /*
1449 wxEVT_MAXIMIZE
1450 */
1451
1452 class WXDLLIMPEXP_CORE wxMaximizeEvent : public wxEvent
1453 {
1454 public:
1455 wxMaximizeEvent(int winid = 0)
1456 : wxEvent(winid, wxEVT_MAXIMIZE)
1457 { }
1458
1459 virtual wxEvent *Clone() const { return new wxMaximizeEvent(*this); }
1460
1461 private:
1462 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMaximizeEvent)
1463 };
1464
1465 // Joystick event class
1466 /*
1467 wxEVT_JOY_BUTTON_DOWN,
1468 wxEVT_JOY_BUTTON_UP,
1469 wxEVT_JOY_MOVE,
1470 wxEVT_JOY_ZMOVE
1471 */
1472
1473 // Which joystick? Same as Windows ids so no conversion necessary.
1474 enum
1475 {
1476 wxJOYSTICK1,
1477 wxJOYSTICK2
1478 };
1479
1480 // Which button is down?
1481 enum
1482 {
1483 wxJOY_BUTTON_ANY = -1,
1484 wxJOY_BUTTON1 = 1,
1485 wxJOY_BUTTON2 = 2,
1486 wxJOY_BUTTON3 = 4,
1487 wxJOY_BUTTON4 = 8
1488 };
1489
1490 class WXDLLIMPEXP_CORE wxJoystickEvent : public wxEvent
1491 {
1492 protected:
1493 wxPoint m_pos;
1494 int m_zPosition;
1495 int m_buttonChange; // Which button changed?
1496 int m_buttonState; // Which buttons are down?
1497 int m_joyStick; // Which joystick?
1498
1499 public:
1500 wxJoystickEvent(wxEventType type = wxEVT_NULL,
1501 int state = 0,
1502 int joystick = wxJOYSTICK1,
1503 int change = 0)
1504 : wxEvent(0, type),
1505 m_pos(),
1506 m_zPosition(0),
1507 m_buttonChange(change),
1508 m_buttonState(state),
1509 m_joyStick(joystick)
1510 {
1511 }
1512 wxJoystickEvent(const wxJoystickEvent & event)
1513 : wxEvent(event),
1514 m_pos(event.m_pos),
1515 m_zPosition(event.m_zPosition),
1516 m_buttonChange(event.m_buttonChange),
1517 m_buttonState(event.m_buttonState),
1518 m_joyStick(event.m_joyStick)
1519 { }
1520
1521 wxPoint GetPosition() const { return m_pos; }
1522 int GetZPosition() const { return m_zPosition; }
1523 int GetButtonState() const { return m_buttonState; }
1524 int GetButtonChange() const { return m_buttonChange; }
1525 int GetJoystick() const { return m_joyStick; }
1526
1527 void SetJoystick(int stick) { m_joyStick = stick; }
1528 void SetButtonState(int state) { m_buttonState = state; }
1529 void SetButtonChange(int change) { m_buttonChange = change; }
1530 void SetPosition(const wxPoint& pos) { m_pos = pos; }
1531 void SetZPosition(int zPos) { m_zPosition = zPos; }
1532
1533 // Was it a button event? (*doesn't* mean: is any button *down*?)
1534 bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) ||
1535 (GetEventType() == wxEVT_JOY_BUTTON_UP)); }
1536
1537 // Was it a move event?
1538 bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE); }
1539
1540 // Was it a zmove event?
1541 bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE); }
1542
1543 // Was it a down event from button 1, 2, 3, 4 or any?
1544 bool ButtonDown(int but = wxJOY_BUTTON_ANY) const
1545 { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) &&
1546 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
1547
1548 // Was it a up event from button 1, 2, 3 or any?
1549 bool ButtonUp(int but = wxJOY_BUTTON_ANY) const
1550 { return ((GetEventType() == wxEVT_JOY_BUTTON_UP) &&
1551 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
1552
1553 // Was the given button 1,2,3,4 or any in Down state?
1554 bool ButtonIsDown(int but = wxJOY_BUTTON_ANY) const
1555 { return (((but == wxJOY_BUTTON_ANY) && (m_buttonState != 0)) ||
1556 ((m_buttonState & but) == but)); }
1557
1558 virtual wxEvent *Clone() const { return new wxJoystickEvent(*this); }
1559
1560 private:
1561 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxJoystickEvent)
1562 };
1563
1564 // Drop files event class
1565 /*
1566 wxEVT_DROP_FILES
1567 */
1568
1569 class WXDLLIMPEXP_CORE wxDropFilesEvent : public wxEvent
1570 {
1571 public:
1572 int m_noFiles;
1573 wxPoint m_pos;
1574 wxString* m_files;
1575
1576 wxDropFilesEvent(wxEventType type = wxEVT_NULL,
1577 int noFiles = 0,
1578 wxString *files = (wxString *) NULL)
1579 : wxEvent(0, type),
1580 m_noFiles(noFiles),
1581 m_pos(),
1582 m_files(files)
1583 { }
1584
1585 // we need a copy ctor to avoid deleting m_files pointer twice
1586 wxDropFilesEvent(const wxDropFilesEvent& other)
1587 : wxEvent(other),
1588 m_noFiles(other.m_noFiles),
1589 m_pos(other.m_pos),
1590 m_files(NULL)
1591 {
1592 m_files = new wxString[m_noFiles];
1593 for ( int n = 0; n < m_noFiles; n++ )
1594 {
1595 m_files[n] = other.m_files[n];
1596 }
1597 }
1598
1599 virtual ~wxDropFilesEvent()
1600 {
1601 delete [] m_files;
1602 }
1603
1604 wxPoint GetPosition() const { return m_pos; }
1605 int GetNumberOfFiles() const { return m_noFiles; }
1606 wxString *GetFiles() const { return m_files; }
1607
1608 virtual wxEvent *Clone() const { return new wxDropFilesEvent(*this); }
1609
1610 private:
1611 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDropFilesEvent)
1612 };
1613
1614 // Update UI event
1615 /*
1616 wxEVT_UPDATE_UI
1617 */
1618
1619 // Whether to always send update events to windows, or
1620 // to only send update events to those with the
1621 // wxWS_EX_PROCESS_UI_UPDATES style.
1622
1623 enum wxUpdateUIMode
1624 {
1625 // Send UI update events to all windows
1626 wxUPDATE_UI_PROCESS_ALL,
1627
1628 // Send UI update events to windows that have
1629 // the wxWS_EX_PROCESS_UI_UPDATES flag specified
1630 wxUPDATE_UI_PROCESS_SPECIFIED
1631 };
1632
1633 class WXDLLIMPEXP_CORE wxUpdateUIEvent : public wxCommandEvent
1634 {
1635 public:
1636 wxUpdateUIEvent(wxWindowID commandId = 0)
1637 : wxCommandEvent(wxEVT_UPDATE_UI, commandId)
1638 {
1639 m_checked =
1640 m_enabled =
1641 m_shown =
1642 m_setEnabled =
1643 m_setShown =
1644 m_setText =
1645 m_setChecked = false;
1646 }
1647 wxUpdateUIEvent(const wxUpdateUIEvent & event)
1648 : wxCommandEvent(event),
1649 m_checked(event.m_checked),
1650 m_enabled(event.m_enabled),
1651 m_shown(event.m_shown),
1652 m_setEnabled(event.m_setEnabled),
1653 m_setShown(event.m_setShown),
1654 m_setText(event.m_setText),
1655 m_setChecked(event.m_setChecked),
1656 m_text(event.m_text)
1657 { }
1658
1659 bool GetChecked() const { return m_checked; }
1660 bool GetEnabled() const { return m_enabled; }
1661 bool GetShown() const { return m_shown; }
1662 wxString GetText() const { return m_text; }
1663 bool GetSetText() const { return m_setText; }
1664 bool GetSetChecked() const { return m_setChecked; }
1665 bool GetSetEnabled() const { return m_setEnabled; }
1666 bool GetSetShown() const { return m_setShown; }
1667
1668 void Check(bool check) { m_checked = check; m_setChecked = true; }
1669 void Enable(bool enable) { m_enabled = enable; m_setEnabled = true; }
1670 void Show(bool show) { m_shown = show; m_setShown = true; }
1671 void SetText(const wxString& text) { m_text = text; m_setText = true; }
1672
1673 // Sets the interval between updates in milliseconds.
1674 // Set to -1 to disable updates, or to 0 to update as frequently as possible.
1675 static void SetUpdateInterval(long updateInterval) { sm_updateInterval = updateInterval; }
1676
1677 // Returns the current interval between updates in milliseconds
1678 static long GetUpdateInterval() { return sm_updateInterval; }
1679
1680 // Can we update this window?
1681 static bool CanUpdate(wxWindowBase *win);
1682
1683 // Reset the update time to provide a delay until the next
1684 // time we should update
1685 static void ResetUpdateTime();
1686
1687 // Specify how wxWidgets will send update events: to
1688 // all windows, or only to those which specify that they
1689 // will process the events.
1690 static void SetMode(wxUpdateUIMode mode) { sm_updateMode = mode; }
1691
1692 // Returns the UI update mode
1693 static wxUpdateUIMode GetMode() { return sm_updateMode; }
1694
1695 virtual wxEvent *Clone() const { return new wxUpdateUIEvent(*this); }
1696
1697 protected:
1698 bool m_checked;
1699 bool m_enabled;
1700 bool m_shown;
1701 bool m_setEnabled;
1702 bool m_setShown;
1703 bool m_setText;
1704 bool m_setChecked;
1705 wxString m_text;
1706 #if wxUSE_LONGLONG
1707 static wxLongLong sm_lastUpdate;
1708 #endif
1709 static long sm_updateInterval;
1710 static wxUpdateUIMode sm_updateMode;
1711
1712 private:
1713 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxUpdateUIEvent)
1714 };
1715
1716 /*
1717 wxEVT_SYS_COLOUR_CHANGED
1718 */
1719
1720 // TODO: shouldn't all events record the window ID?
1721 class WXDLLIMPEXP_CORE wxSysColourChangedEvent : public wxEvent
1722 {
1723 public:
1724 wxSysColourChangedEvent()
1725 : wxEvent(0, wxEVT_SYS_COLOUR_CHANGED)
1726 { }
1727
1728 virtual wxEvent *Clone() const { return new wxSysColourChangedEvent(*this); }
1729
1730 private:
1731 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSysColourChangedEvent)
1732 };
1733
1734 /*
1735 wxEVT_MOUSE_CAPTURE_CHANGED
1736 The window losing the capture receives this message
1737 (even if it released the capture itself).
1738 */
1739
1740 class WXDLLIMPEXP_CORE wxMouseCaptureChangedEvent : public wxEvent
1741 {
1742 public:
1743 wxMouseCaptureChangedEvent(wxWindowID winid = 0, wxWindow* gainedCapture = NULL)
1744 : wxEvent(winid, wxEVT_MOUSE_CAPTURE_CHANGED),
1745 m_gainedCapture(gainedCapture)
1746 { }
1747
1748 wxMouseCaptureChangedEvent(const wxMouseCaptureChangedEvent& event)
1749 : wxEvent(event),
1750 m_gainedCapture(event.m_gainedCapture)
1751 { }
1752
1753 virtual wxEvent *Clone() const { return new wxMouseCaptureChangedEvent(*this); }
1754
1755 wxWindow* GetCapturedWindow() const { return m_gainedCapture; }
1756
1757 private:
1758 wxWindow* m_gainedCapture;
1759
1760 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureChangedEvent)
1761 };
1762
1763 /*
1764 wxEVT_MOUSE_CAPTURE_LOST
1765 The window losing the capture receives this message, unless it released it
1766 it itself or unless wxWindow::CaptureMouse was called on another window
1767 (and so capture will be restored when the new capturer releases it).
1768 */
1769
1770 class WXDLLIMPEXP_CORE wxMouseCaptureLostEvent : public wxEvent
1771 {
1772 public:
1773 wxMouseCaptureLostEvent(wxWindowID winid = 0)
1774 : wxEvent(winid, wxEVT_MOUSE_CAPTURE_LOST)
1775 {}
1776
1777 wxMouseCaptureLostEvent(const wxMouseCaptureLostEvent& event)
1778 : wxEvent(event)
1779 {}
1780
1781 virtual wxEvent *Clone() const { return new wxMouseCaptureLostEvent(*this); }
1782
1783 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureLostEvent)
1784 };
1785
1786 /*
1787 wxEVT_DISPLAY_CHANGED
1788 */
1789 class WXDLLIMPEXP_CORE wxDisplayChangedEvent : public wxEvent
1790 {
1791 private:
1792 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDisplayChangedEvent)
1793
1794 public:
1795 wxDisplayChangedEvent()
1796 : wxEvent(0, wxEVT_DISPLAY_CHANGED)
1797 { }
1798
1799 virtual wxEvent *Clone() const { return new wxDisplayChangedEvent(*this); }
1800 };
1801
1802 /*
1803 wxEVT_PALETTE_CHANGED
1804 */
1805
1806 class WXDLLIMPEXP_CORE wxPaletteChangedEvent : public wxEvent
1807 {
1808 public:
1809 wxPaletteChangedEvent(wxWindowID winid = 0)
1810 : wxEvent(winid, wxEVT_PALETTE_CHANGED),
1811 m_changedWindow((wxWindow *) NULL)
1812 { }
1813
1814 wxPaletteChangedEvent(const wxPaletteChangedEvent& event)
1815 : wxEvent(event),
1816 m_changedWindow(event.m_changedWindow)
1817 { }
1818
1819 void SetChangedWindow(wxWindow* win) { m_changedWindow = win; }
1820 wxWindow* GetChangedWindow() const { return m_changedWindow; }
1821
1822 virtual wxEvent *Clone() const { return new wxPaletteChangedEvent(*this); }
1823
1824 protected:
1825 wxWindow* m_changedWindow;
1826
1827 private:
1828 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaletteChangedEvent)
1829 };
1830
1831 /*
1832 wxEVT_QUERY_NEW_PALETTE
1833 Indicates the window is getting keyboard focus and should re-do its palette.
1834 */
1835
1836 class WXDLLIMPEXP_CORE wxQueryNewPaletteEvent : public wxEvent
1837 {
1838 public:
1839 wxQueryNewPaletteEvent(wxWindowID winid = 0)
1840 : wxEvent(winid, wxEVT_QUERY_NEW_PALETTE),
1841 m_paletteRealized(false)
1842 { }
1843 wxQueryNewPaletteEvent(const wxQueryNewPaletteEvent & event)
1844 : wxEvent(event),
1845 m_paletteRealized(event.m_paletteRealized)
1846 { }
1847
1848 // App sets this if it changes the palette.
1849 void SetPaletteRealized(bool realized) { m_paletteRealized = realized; }
1850 bool GetPaletteRealized() const { return m_paletteRealized; }
1851
1852 virtual wxEvent *Clone() const { return new wxQueryNewPaletteEvent(*this); }
1853
1854 protected:
1855 bool m_paletteRealized;
1856
1857 private:
1858 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxQueryNewPaletteEvent)
1859 };
1860
1861 /*
1862 Event generated by dialog navigation keys
1863 wxEVT_NAVIGATION_KEY
1864 */
1865 // NB: don't derive from command event to avoid being propagated to the parent
1866 class WXDLLIMPEXP_CORE wxNavigationKeyEvent : public wxEvent
1867 {
1868 public:
1869 wxNavigationKeyEvent()
1870 : wxEvent(0, wxEVT_NAVIGATION_KEY),
1871 m_flags(IsForward | FromTab), // defaults are for TAB
1872 m_focus((wxWindow *)NULL)
1873 {
1874 m_propagationLevel = wxEVENT_PROPAGATE_NONE;
1875 }
1876
1877 wxNavigationKeyEvent(const wxNavigationKeyEvent& event)
1878 : wxEvent(event),
1879 m_flags(event.m_flags),
1880 m_focus(event.m_focus)
1881 { }
1882
1883 // direction: forward (true) or backward (false)
1884 bool GetDirection() const
1885 { return (m_flags & IsForward) != 0; }
1886 void SetDirection(bool bForward)
1887 { if ( bForward ) m_flags |= IsForward; else m_flags &= ~IsForward; }
1888
1889 // it may be a window change event (MDI, notebook pages...) or a control
1890 // change event
1891 bool IsWindowChange() const
1892 { return (m_flags & WinChange) != 0; }
1893 void SetWindowChange(bool bIs)
1894 { if ( bIs ) m_flags |= WinChange; else m_flags &= ~WinChange; }
1895
1896 // Set to true under MSW if the event was generated using the tab key.
1897 // This is required for proper navogation over radio buttons
1898 bool IsFromTab() const
1899 { return (m_flags & FromTab) != 0; }
1900 void SetFromTab(bool bIs)
1901 { if ( bIs ) m_flags |= FromTab; else m_flags &= ~FromTab; }
1902
1903 // the child which has the focus currently (may be NULL - use
1904 // wxWindow::FindFocus then)
1905 wxWindow* GetCurrentFocus() const { return m_focus; }
1906 void SetCurrentFocus(wxWindow *win) { m_focus = win; }
1907
1908 // Set flags
1909 void SetFlags(long flags) { m_flags = flags; }
1910
1911 virtual wxEvent *Clone() const { return new wxNavigationKeyEvent(*this); }
1912
1913 enum
1914 {
1915 IsBackward = 0x0000,
1916 IsForward = 0x0001,
1917 WinChange = 0x0002,
1918 FromTab = 0x0004
1919 };
1920
1921 long m_flags;
1922 wxWindow *m_focus;
1923
1924 private:
1925 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNavigationKeyEvent)
1926 };
1927
1928 // Window creation/destruction events: the first is sent as soon as window is
1929 // created (i.e. the underlying GUI object exists), but when the C++ object is
1930 // fully initialized (so virtual functions may be called). The second,
1931 // wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
1932 // still safe to call virtual functions at this moment
1933 /*
1934 wxEVT_CREATE
1935 wxEVT_DESTROY
1936 */
1937
1938 class WXDLLIMPEXP_CORE wxWindowCreateEvent : public wxCommandEvent
1939 {
1940 public:
1941 wxWindowCreateEvent(wxWindow *win = NULL);
1942
1943 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1944
1945 virtual wxEvent *Clone() const { return new wxWindowCreateEvent(*this); }
1946
1947 private:
1948 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowCreateEvent)
1949 };
1950
1951 class WXDLLIMPEXP_CORE wxWindowDestroyEvent : public wxCommandEvent
1952 {
1953 public:
1954 wxWindowDestroyEvent(wxWindow *win = NULL);
1955
1956 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1957
1958 virtual wxEvent *Clone() const { return new wxWindowDestroyEvent(*this); }
1959
1960 private:
1961 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowDestroyEvent)
1962 };
1963
1964 // A help event is sent when the user clicks on a window in context-help mode.
1965 /*
1966 wxEVT_HELP
1967 wxEVT_DETAILED_HELP
1968 */
1969
1970 class WXDLLIMPEXP_CORE wxHelpEvent : public wxCommandEvent
1971 {
1972 public:
1973 // how was this help event generated?
1974 enum Origin
1975 {
1976 Origin_Unknown, // unrecognized event source
1977 Origin_Keyboard, // event generated from F1 key press
1978 Origin_HelpButton // event from [?] button on the title bar (Windows)
1979 };
1980
1981 wxHelpEvent(wxEventType type = wxEVT_NULL,
1982 wxWindowID winid = 0,
1983 const wxPoint& pt = wxDefaultPosition,
1984 Origin origin = Origin_Unknown)
1985 : wxCommandEvent(type, winid),
1986 m_pos(pt),
1987 m_origin(GuessOrigin(origin))
1988 { }
1989 wxHelpEvent(const wxHelpEvent & event)
1990 : wxCommandEvent(event),
1991 m_pos(event.m_pos),
1992 m_target(event.m_target),
1993 m_link(event.m_link),
1994 m_origin(event.m_origin)
1995 { }
1996
1997 // Position of event (in screen coordinates)
1998 const wxPoint& GetPosition() const { return m_pos; }
1999 void SetPosition(const wxPoint& pos) { m_pos = pos; }
2000
2001 // Optional link to further help
2002 const wxString& GetLink() const { return m_link; }
2003 void SetLink(const wxString& link) { m_link = link; }
2004
2005 // Optional target to display help in. E.g. a window specification
2006 const wxString& GetTarget() const { return m_target; }
2007 void SetTarget(const wxString& target) { m_target = target; }
2008
2009 virtual wxEvent *Clone() const { return new wxHelpEvent(*this); }
2010
2011 // optional indication of the event source
2012 Origin GetOrigin() const { return m_origin; }
2013 void SetOrigin(Origin origin) { m_origin = origin; }
2014
2015 protected:
2016 wxPoint m_pos;
2017 wxString m_target;
2018 wxString m_link;
2019 Origin m_origin;
2020
2021 // we can try to guess the event origin ourselves, even if none is
2022 // specified in the ctor
2023 static Origin GuessOrigin(Origin origin);
2024
2025 private:
2026 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHelpEvent)
2027 };
2028
2029 // A Clipboard Text event is sent when a window intercepts text copy/cut/paste
2030 // message, i.e. the user has cut/copied/pasted data from/into a text control
2031 // via ctrl-C/X/V, ctrl/shift-del/insert, a popup menu command, etc.
2032 // NOTE : under windows these events are *NOT* generated automatically
2033 // for a Rich Edit text control.
2034 /*
2035 wxEVT_COMMAND_TEXT_COPY
2036 wxEVT_COMMAND_TEXT_CUT
2037 wxEVT_COMMAND_TEXT_PASTE
2038 */
2039
2040 class WXDLLIMPEXP_CORE wxClipboardTextEvent : public wxCommandEvent
2041 {
2042 public:
2043 wxClipboardTextEvent(wxEventType type = wxEVT_NULL,
2044 wxWindowID winid = 0)
2045 : wxCommandEvent(type, winid)
2046 { }
2047 wxClipboardTextEvent(const wxClipboardTextEvent & event)
2048 : wxCommandEvent(event)
2049 { }
2050
2051 virtual wxEvent *Clone() const { return new wxClipboardTextEvent(*this); }
2052
2053 private:
2054 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxClipboardTextEvent)
2055 };
2056
2057 // A Context event is sent when the user right clicks on a window or
2058 // presses Shift-F10
2059 // NOTE : Under windows this is a repackaged WM_CONTETXMENU message
2060 // Under other systems it may have to be generated from a right click event
2061 /*
2062 wxEVT_CONTEXT_MENU
2063 */
2064
2065 class WXDLLIMPEXP_CORE wxContextMenuEvent : public wxCommandEvent
2066 {
2067 public:
2068 wxContextMenuEvent(wxEventType type = wxEVT_NULL,
2069 wxWindowID winid = 0,
2070 const wxPoint& pt = wxDefaultPosition)
2071 : wxCommandEvent(type, winid),
2072 m_pos(pt)
2073 { }
2074 wxContextMenuEvent(const wxContextMenuEvent & event)
2075 : wxCommandEvent(event),
2076 m_pos(event.m_pos)
2077 { }
2078
2079 // Position of event (in screen coordinates)
2080 const wxPoint& GetPosition() const { return m_pos; }
2081 void SetPosition(const wxPoint& pos) { m_pos = pos; }
2082
2083 virtual wxEvent *Clone() const { return new wxContextMenuEvent(*this); }
2084
2085 protected:
2086 wxPoint m_pos;
2087
2088 private:
2089 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxContextMenuEvent)
2090 };
2091
2092 #endif // wxUSE_GUI
2093
2094 // Idle event
2095 /*
2096 wxEVT_IDLE
2097 */
2098
2099 // Whether to always send idle events to windows, or
2100 // to only send update events to those with the
2101 // wxWS_EX_PROCESS_IDLE style.
2102
2103 enum wxIdleMode
2104 {
2105 // Send idle events to all windows
2106 wxIDLE_PROCESS_ALL,
2107
2108 // Send idle events to windows that have
2109 // the wxWS_EX_PROCESS_IDLE flag specified
2110 wxIDLE_PROCESS_SPECIFIED
2111 };
2112
2113 class WXDLLIMPEXP_BASE wxIdleEvent : public wxEvent
2114 {
2115 public:
2116 wxIdleEvent()
2117 : wxEvent(0, wxEVT_IDLE),
2118 m_requestMore(false)
2119 { }
2120 wxIdleEvent(const wxIdleEvent & event)
2121 : wxEvent(event),
2122 m_requestMore(event.m_requestMore)
2123 { }
2124
2125 void RequestMore(bool needMore = true) { m_requestMore = needMore; }
2126 bool MoreRequested() const { return m_requestMore; }
2127
2128 virtual wxEvent *Clone() const { return new wxIdleEvent(*this); }
2129
2130 // Specify how wxWidgets will send idle events: to
2131 // all windows, or only to those which specify that they
2132 // will process the events.
2133 static void SetMode(wxIdleMode mode) { sm_idleMode = mode; }
2134
2135 // Returns the idle event mode
2136 static wxIdleMode GetMode() { return sm_idleMode; }
2137
2138 protected:
2139 bool m_requestMore;
2140 static wxIdleMode sm_idleMode;
2141
2142 private:
2143 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIdleEvent)
2144 };
2145
2146 /* TODO
2147 wxEVT_MOUSE_CAPTURE_CHANGED,
2148 wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
2149 // wxEVT_FONT_CHANGED, // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
2150 // wxEVT_FONT_CHANGED to all other windows (maybe).
2151 wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
2152 wxEVT_MEASURE_ITEM,
2153 wxEVT_COMPARE_ITEM
2154 */
2155
2156
2157 // ============================================================================
2158 // event handler and related classes
2159 // ============================================================================
2160
2161 // for backwards compatibility and to prevent eVC 4 for ARM from crashing with
2162 // internal compiler error when compiling wx, we define wxObjectEventFunction
2163 // as a wxObject method even though it can only be a wxEvtHandler one
2164 typedef void (wxObject::*wxObjectEventFunction)(wxEvent&);
2165
2166 // we can't have ctors nor base struct in backwards compatibility mode or
2167 // otherwise we won't be able to initialize the objects with an agregate, so
2168 // we have to keep both versions
2169 #if WXWIN_COMPATIBILITY_EVENT_TYPES
2170
2171 struct WXDLLIMPEXP_BASE wxEventTableEntry
2172 {
2173 // For some reason, this can't be wxEventType, or VC++ complains.
2174 int m_eventType; // main event type
2175 int m_id; // control/menu/toolbar id
2176 int m_lastId; // used for ranges of ids
2177 wxObjectEventFunction m_fn; // function to call: not wxEventFunction,
2178 // because of dependency problems
2179
2180 wxObject* m_callbackUserData;
2181 };
2182
2183 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
2184
2185 // struct containing the members common to static and dynamic event tables
2186 // entries
2187 struct WXDLLIMPEXP_BASE wxEventTableEntryBase
2188 {
2189 private:
2190 wxEventTableEntryBase& operator=(const wxEventTableEntryBase& event);
2191
2192 public:
2193 wxEventTableEntryBase(int winid, int idLast,
2194 wxObjectEventFunction fn, wxObject *data)
2195 : m_id(winid),
2196 m_lastId(idLast),
2197 m_fn(fn),
2198 m_callbackUserData(data)
2199 { }
2200
2201 wxEventTableEntryBase(const wxEventTableEntryBase& event)
2202 : m_id(event.m_id),
2203 m_lastId(event.m_lastId),
2204 m_fn(event.m_fn),
2205 m_callbackUserData(event.m_callbackUserData)
2206 { }
2207
2208 // the range of ids for this entry: if m_lastId == wxID_ANY, the range
2209 // consists only of m_id, otherwise it is m_id..m_lastId inclusive
2210 int m_id,
2211 m_lastId;
2212
2213 // function to call: not wxEventFunction, because of dependency problems
2214 wxObjectEventFunction m_fn;
2215
2216 // arbitrary user data asosciated with the callback
2217 wxObject* m_callbackUserData;
2218 };
2219
2220 // an entry from a static event table
2221 struct WXDLLIMPEXP_BASE wxEventTableEntry : public wxEventTableEntryBase
2222 {
2223 wxEventTableEntry(const int& evType, int winid, int idLast,
2224 wxObjectEventFunction fn, wxObject *data)
2225 : wxEventTableEntryBase(winid, idLast, fn, data),
2226 m_eventType(evType)
2227 { }
2228
2229 // the reference to event type: this allows us to not care about the
2230 // (undefined) order in which the event table entries and the event types
2231 // are initialized: initially the value of this reference might be
2232 // invalid, but by the time it is used for the first time, all global
2233 // objects will have been initialized (including the event type constants)
2234 // and so it will have the correct value when it is needed
2235 const int& m_eventType;
2236
2237 private:
2238 wxEventTableEntry& operator=(const wxEventTableEntry&);
2239 };
2240
2241 // an entry used in dynamic event table managed by wxEvtHandler::Connect()
2242 struct WXDLLIMPEXP_BASE wxDynamicEventTableEntry : public wxEventTableEntryBase
2243 {
2244 wxDynamicEventTableEntry(int evType, int winid, int idLast,
2245 wxObjectEventFunction fn, wxObject *data, wxEvtHandler* eventSink)
2246 : wxEventTableEntryBase(winid, idLast, fn, data),
2247 m_eventType(evType),
2248 m_eventSink(eventSink)
2249 { }
2250
2251 // not a reference here as we can't keep a reference to a temporary int
2252 // created to wrap the constant value typically passed to Connect() - nor
2253 // do we need it
2254 int m_eventType;
2255
2256 // Pointer to object whose function is fn - so we don't assume the
2257 // EventFunction is always a member of the EventHandler receiving the
2258 // message
2259 wxEvtHandler* m_eventSink;
2260
2261 DECLARE_NO_COPY_CLASS(wxDynamicEventTableEntry)
2262 };
2263
2264 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
2265
2266 // ----------------------------------------------------------------------------
2267 // wxEventTable: an array of event entries terminated with {0, 0, 0, 0, 0}
2268 // ----------------------------------------------------------------------------
2269
2270 struct WXDLLIMPEXP_BASE wxEventTable
2271 {
2272 const wxEventTable *baseTable; // base event table (next in chain)
2273 const wxEventTableEntry *entries; // bottom of entry array
2274 };
2275
2276 // ----------------------------------------------------------------------------
2277 // wxEventHashTable: a helper of wxEvtHandler to speed up wxEventTable lookups.
2278 // ----------------------------------------------------------------------------
2279
2280 WX_DEFINE_ARRAY_PTR(const wxEventTableEntry*, wxEventTableEntryPointerArray);
2281
2282 class WXDLLIMPEXP_BASE wxEventHashTable
2283 {
2284 private:
2285 // Internal data structs
2286 struct EventTypeTable
2287 {
2288 wxEventType eventType;
2289 wxEventTableEntryPointerArray eventEntryTable;
2290 };
2291 typedef EventTypeTable* EventTypeTablePointer;
2292
2293 public:
2294 // Constructor, needs the event table it needs to hash later on.
2295 // Note: hashing of the event table is not done in the constructor as it
2296 // can be that the event table is not yet full initialize, the hash
2297 // will gets initialized when handling the first event look-up request.
2298 wxEventHashTable(const wxEventTable &table);
2299 // Destructor.
2300 ~wxEventHashTable();
2301
2302 // Handle the given event, in other words search the event table hash
2303 // and call self->ProcessEvent() if a match was found.
2304 bool HandleEvent(wxEvent &event, wxEvtHandler *self);
2305
2306 // Clear table
2307 void Clear();
2308
2309 #if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
2310 // Clear all tables
2311 static void ClearAll();
2312 #endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING
2313
2314 protected:
2315 // Init the hash table with the entries of the static event table.
2316 void InitHashTable();
2317 // Helper funtion of InitHashTable() to insert 1 entry into the hash table.
2318 void AddEntry(const wxEventTableEntry &entry);
2319 // Allocate and init with null pointers the base hash table.
2320 void AllocEventTypeTable(size_t size);
2321 // Grow the hash table in size and transfer all items currently
2322 // in the table to the correct location in the new table.
2323 void GrowEventTypeTable();
2324
2325 protected:
2326 const wxEventTable &m_table;
2327 bool m_rebuildHash;
2328
2329 size_t m_size;
2330 EventTypeTablePointer *m_eventTypeTable;
2331
2332 static wxEventHashTable* sm_first;
2333 wxEventHashTable* m_previous;
2334 wxEventHashTable* m_next;
2335
2336 DECLARE_NO_COPY_CLASS(wxEventHashTable)
2337 };
2338
2339 // ----------------------------------------------------------------------------
2340 // wxEvtHandler: the base class for all objects handling wxWidgets events
2341 // ----------------------------------------------------------------------------
2342
2343 class WXDLLIMPEXP_BASE wxEvtHandler : public wxObject
2344 {
2345 public:
2346 wxEvtHandler();
2347 virtual ~wxEvtHandler();
2348
2349 wxEvtHandler *GetNextHandler() const { return m_nextHandler; }
2350 wxEvtHandler *GetPreviousHandler() const { return m_previousHandler; }
2351 void SetNextHandler(wxEvtHandler *handler) { m_nextHandler = handler; }
2352 void SetPreviousHandler(wxEvtHandler *handler) { m_previousHandler = handler; }
2353
2354 void SetEvtHandlerEnabled(bool enabled) { m_enabled = enabled; }
2355 bool GetEvtHandlerEnabled() const { return m_enabled; }
2356
2357 // process an event right now
2358 virtual bool ProcessEvent(wxEvent& event);
2359
2360 // add an event to be processed later
2361 virtual void AddPendingEvent(const wxEvent& event);
2362
2363 void ProcessPendingEvents();
2364
2365 #if wxUSE_THREADS
2366 bool ProcessThreadEvent(const wxEvent& event);
2367 #endif
2368
2369 // Dynamic association of a member function handler with the event handler,
2370 // winid and event type
2371 void Connect(int winid,
2372 int lastId,
2373 int eventType,
2374 wxObjectEventFunction func,
2375 wxObject *userData = (wxObject *) NULL,
2376 wxEvtHandler *eventSink = (wxEvtHandler *) NULL);
2377
2378 // Convenience function: take just one id
2379 void Connect(int winid,
2380 int eventType,
2381 wxObjectEventFunction func,
2382 wxObject *userData = (wxObject *) NULL,
2383 wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2384 { Connect(winid, wxID_ANY, eventType, func, userData, eventSink); }
2385
2386 // Even more convenient: without id (same as using id of wxID_ANY)
2387 void Connect(int eventType,
2388 wxObjectEventFunction func,
2389 wxObject *userData = (wxObject *) NULL,
2390 wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2391 { Connect(wxID_ANY, wxID_ANY, eventType, func, userData, eventSink); }
2392
2393 bool Disconnect(int winid,
2394 int lastId,
2395 wxEventType eventType,
2396 wxObjectEventFunction func = NULL,
2397 wxObject *userData = (wxObject *) NULL,
2398 wxEvtHandler *eventSink = (wxEvtHandler *) NULL);
2399
2400 bool Disconnect(int winid = wxID_ANY,
2401 wxEventType eventType = wxEVT_NULL,
2402 wxObjectEventFunction func = NULL,
2403 wxObject *userData = (wxObject *) NULL,
2404 wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2405 { return Disconnect(winid, wxID_ANY, eventType, func, userData, eventSink); }
2406
2407 bool Disconnect(wxEventType eventType,
2408 wxObjectEventFunction func,
2409 wxObject *userData = (wxObject *) NULL,
2410 wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2411 { return Disconnect(wxID_ANY, eventType, func, userData, eventSink); }
2412
2413 wxList* GetDynamicEventTable() const { return m_dynamicEvents ; }
2414
2415 // User data can be associated with each wxEvtHandler
2416 void SetClientObject( wxClientData *data ) { DoSetClientObject(data); }
2417 wxClientData *GetClientObject() const { return DoGetClientObject(); }
2418
2419 void SetClientData( void *data ) { DoSetClientData(data); }
2420 void *GetClientData() const { return DoGetClientData(); }
2421
2422 // check if the given event table entry matches this event and call the
2423 // handler if it does
2424 //
2425 // return true if the event was processed, false otherwise (no match or the
2426 // handler decided to skip the event)
2427 static bool ProcessEventIfMatches(const wxEventTableEntryBase& tableEntry,
2428 wxEvtHandler *handler,
2429 wxEvent& event);
2430
2431 // implementation from now on
2432 virtual bool SearchEventTable(wxEventTable& table, wxEvent& event);
2433 bool SearchDynamicEventTable( wxEvent& event );
2434
2435 #if wxUSE_THREADS
2436 void ClearEventLocker();
2437 #endif // wxUSE_THREADS
2438
2439 // Avoid problems at exit by cleaning up static hash table gracefully
2440 void ClearEventHashTable() { GetEventHashTable().Clear(); }
2441
2442 private:
2443 static const wxEventTableEntry sm_eventTableEntries[];
2444
2445 protected:
2446 // hooks for wxWindow used by ProcessEvent()
2447 // -----------------------------------------
2448
2449 // This one is called before trying our own event table to allow plugging
2450 // in the validators.
2451 //
2452 // NB: This method is intentionally *not* inside wxUSE_VALIDATORS!
2453 // It is part of wxBase which doesn't use validators and the code
2454 // is compiled out when building wxBase w/o GUI classes, which affects
2455 // binary compatibility and wxBase library can't be used by GUI
2456 // ports.
2457 virtual bool TryValidator(wxEvent& WXUNUSED(event)) { return false; }
2458
2459 // this one is called after failing to find the event handle in our own
2460 // table to give a chance to the other windows to process it
2461 //
2462 // base class implementation passes the event to wxTheApp
2463 virtual bool TryParent(wxEvent& event);
2464
2465
2466 static const wxEventTable sm_eventTable;
2467 virtual const wxEventTable *GetEventTable() const;
2468
2469 static wxEventHashTable sm_eventHashTable;
2470 virtual wxEventHashTable& GetEventHashTable() const;
2471
2472 wxEvtHandler* m_nextHandler;
2473 wxEvtHandler* m_previousHandler;
2474 wxList* m_dynamicEvents;
2475 wxList* m_pendingEvents;
2476
2477 #if wxUSE_THREADS
2478 #if defined (__VISAGECPP__)
2479 const wxCriticalSection& Lock() const { return m_eventsLocker; }
2480 wxCriticalSection& Lock() { return m_eventsLocker; }
2481
2482 wxCriticalSection m_eventsLocker;
2483 # else
2484 const wxCriticalSection& Lock() const { return *m_eventsLocker; }
2485 wxCriticalSection& Lock() { return *m_eventsLocker; }
2486
2487 wxCriticalSection* m_eventsLocker;
2488 # endif
2489 #endif
2490
2491 // Is event handler enabled?
2492 bool m_enabled;
2493
2494
2495 // The user data: either an object which will be deleted by the container
2496 // when it's deleted or some raw pointer which we do nothing with - only
2497 // one type of data can be used with the given window (i.e. you cannot set
2498 // the void data and then associate the container with wxClientData or vice
2499 // versa)
2500 union
2501 {
2502 wxClientData *m_clientObject;
2503 void *m_clientData;
2504 };
2505
2506 // what kind of data do we have?
2507 wxClientDataType m_clientDataType;
2508
2509 // client data accessors
2510 virtual void DoSetClientObject( wxClientData *data );
2511 virtual wxClientData *DoGetClientObject() const;
2512
2513 virtual void DoSetClientData( void *data );
2514 virtual void *DoGetClientData() const;
2515
2516 private:
2517 DECLARE_DYNAMIC_CLASS_NO_COPY(wxEvtHandler)
2518 };
2519
2520 // Post a message to the given eventhandler which will be processed during the
2521 // next event loop iteration
2522 inline void wxPostEvent(wxEvtHandler *dest, const wxEvent& event)
2523 {
2524 wxCHECK_RET( dest, wxT("need an object to post event to in wxPostEvent") );
2525
2526 dest->AddPendingEvent(event);
2527 }
2528
2529 typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&);
2530
2531 #define wxEventHandler(func) \
2532 (wxObjectEventFunction)wxStaticCastEvent(wxEventFunction, &func)
2533
2534 #if wxUSE_GUI
2535
2536 // ----------------------------------------------------------------------------
2537 // wxEventBlocker: helper class to temporarily disable event handling for a window
2538 // ----------------------------------------------------------------------------
2539
2540 class WXDLLIMPEXP_CORE wxEventBlocker : public wxEvtHandler
2541 {
2542 public:
2543 wxEventBlocker(wxWindow *win, wxEventType type = wxEVT_ANY);
2544 virtual ~wxEventBlocker();
2545
2546 void Block(wxEventType type)
2547 {
2548 m_eventsToBlock.push_back(type);
2549 }
2550
2551 virtual bool ProcessEvent(wxEvent& event);
2552
2553 protected:
2554 wxArrayInt m_eventsToBlock;
2555 wxWindow *m_window;
2556
2557 DECLARE_NO_COPY_CLASS(wxEventBlocker)
2558 };
2559
2560 typedef void (wxEvtHandler::*wxCommandEventFunction)(wxCommandEvent&);
2561 typedef void (wxEvtHandler::*wxScrollEventFunction)(wxScrollEvent&);
2562 typedef void (wxEvtHandler::*wxScrollWinEventFunction)(wxScrollWinEvent&);
2563 typedef void (wxEvtHandler::*wxSizeEventFunction)(wxSizeEvent&);
2564 typedef void (wxEvtHandler::*wxMoveEventFunction)(wxMoveEvent&);
2565 typedef void (wxEvtHandler::*wxPaintEventFunction)(wxPaintEvent&);
2566 typedef void (wxEvtHandler::*wxNcPaintEventFunction)(wxNcPaintEvent&);
2567 typedef void (wxEvtHandler::*wxEraseEventFunction)(wxEraseEvent&);
2568 typedef void (wxEvtHandler::*wxMouseEventFunction)(wxMouseEvent&);
2569 typedef void (wxEvtHandler::*wxCharEventFunction)(wxKeyEvent&);
2570 typedef void (wxEvtHandler::*wxFocusEventFunction)(wxFocusEvent&);
2571 typedef void (wxEvtHandler::*wxChildFocusEventFunction)(wxChildFocusEvent&);
2572 typedef void (wxEvtHandler::*wxActivateEventFunction)(wxActivateEvent&);
2573 typedef void (wxEvtHandler::*wxMenuEventFunction)(wxMenuEvent&);
2574 typedef void (wxEvtHandler::*wxJoystickEventFunction)(wxJoystickEvent&);
2575 typedef void (wxEvtHandler::*wxDropFilesEventFunction)(wxDropFilesEvent&);
2576 typedef void (wxEvtHandler::*wxInitDialogEventFunction)(wxInitDialogEvent&);
2577 typedef void (wxEvtHandler::*wxSysColourChangedEventFunction)(wxSysColourChangedEvent&);
2578 typedef void (wxEvtHandler::*wxDisplayChangedEventFunction)(wxDisplayChangedEvent&);
2579 typedef void (wxEvtHandler::*wxUpdateUIEventFunction)(wxUpdateUIEvent&);
2580 typedef void (wxEvtHandler::*wxIdleEventFunction)(wxIdleEvent&);
2581 typedef void (wxEvtHandler::*wxCloseEventFunction)(wxCloseEvent&);
2582 typedef void (wxEvtHandler::*wxShowEventFunction)(wxShowEvent&);
2583 typedef void (wxEvtHandler::*wxIconizeEventFunction)(wxIconizeEvent&);
2584 typedef void (wxEvtHandler::*wxMaximizeEventFunction)(wxMaximizeEvent&);
2585 typedef void (wxEvtHandler::*wxNavigationKeyEventFunction)(wxNavigationKeyEvent&);
2586 typedef void (wxEvtHandler::*wxPaletteChangedEventFunction)(wxPaletteChangedEvent&);
2587 typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction)(wxQueryNewPaletteEvent&);
2588 typedef void (wxEvtHandler::*wxWindowCreateEventFunction)(wxWindowCreateEvent&);
2589 typedef void (wxEvtHandler::*wxWindowDestroyEventFunction)(wxWindowDestroyEvent&);
2590 typedef void (wxEvtHandler::*wxSetCursorEventFunction)(wxSetCursorEvent&);
2591 typedef void (wxEvtHandler::*wxNotifyEventFunction)(wxNotifyEvent&);
2592 typedef void (wxEvtHandler::*wxHelpEventFunction)(wxHelpEvent&);
2593 typedef void (wxEvtHandler::*wxContextMenuEventFunction)(wxContextMenuEvent&);
2594 typedef void (wxEvtHandler::*wxMouseCaptureChangedEventFunction)(wxMouseCaptureChangedEvent&);
2595 typedef void (wxEvtHandler::*wxMouseCaptureLostEventFunction)(wxMouseCaptureLostEvent&);
2596 typedef void (wxEvtHandler::*wxClipboardTextEventFunction)(wxClipboardTextEvent&);
2597
2598
2599 #define wxCommandEventHandler(func) \
2600 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxCommandEventFunction, &func)
2601 #define wxScrollEventHandler(func) \
2602 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxScrollEventFunction, &func)
2603 #define wxScrollWinEventHandler(func) \
2604 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxScrollWinEventFunction, &func)
2605 #define wxSizeEventHandler(func) \
2606 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxSizeEventFunction, &func)
2607 #define wxMoveEventHandler(func) \
2608 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMoveEventFunction, &func)
2609 #define wxPaintEventHandler(func) \
2610 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxPaintEventFunction, &func)
2611 #define wxNcPaintEventHandler(func) \
2612 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNcPaintEventFunction, &func)
2613 #define wxEraseEventHandler(func) \
2614 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxEraseEventFunction, &func)
2615 #define wxMouseEventHandler(func) \
2616 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMouseEventFunction, &func)
2617 #define wxCharEventHandler(func) \
2618 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxCharEventFunction, &func)
2619 #define wxKeyEventHandler(func) wxCharEventHandler(func)
2620 #define wxFocusEventHandler(func) \
2621 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxFocusEventFunction, &func)
2622 #define wxChildFocusEventHandler(func) \
2623 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxChildFocusEventFunction, &func)
2624 #define wxActivateEventHandler(func) \
2625 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxActivateEventFunction, &func)
2626 #define wxMenuEventHandler(func) \
2627 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMenuEventFunction, &func)
2628 #define wxJoystickEventHandler(func) \
2629 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxJoystickEventFunction, &func)
2630 #define wxDropFilesEventHandler(func) \
2631 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxDropFilesEventFunction, &func)
2632 #define wxInitDialogEventHandler(func) \
2633 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxInitDialogEventFunction, &func)
2634 #define wxSysColourChangedEventHandler(func) \
2635 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxSysColourChangedEventFunction, &func)
2636 #define wxDisplayChangedEventHandler(func) \
2637 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxDisplayChangedEventFunction, &func)
2638 #define wxUpdateUIEventHandler(func) \
2639 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxUpdateUIEventFunction, &func)
2640 #define wxIdleEventHandler(func) \
2641 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxIdleEventFunction, &func)
2642 #define wxCloseEventHandler(func) \
2643 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxCloseEventFunction, &func)
2644 #define wxShowEventHandler(func) \
2645 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxShowEventFunction, &func)
2646 #define wxIconizeEventHandler(func) \
2647 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxIconizeEventFunction, &func)
2648 #define wxMaximizeEventHandler(func) \
2649 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMaximizeEventFunction, &func)
2650 #define wxNavigationKeyEventHandler(func) \
2651 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNavigationKeyEventFunction, &func)
2652 #define wxPaletteChangedEventHandler(func) \
2653 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxPaletteChangedEventFunction, &func)
2654 #define wxQueryNewPaletteEventHandler(func) \
2655 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxQueryNewPaletteEventFunction, &func)
2656 #define wxWindowCreateEventHandler(func) \
2657 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxWindowCreateEventFunction, &func)
2658 #define wxWindowDestroyEventHandler(func) \
2659 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxWindowDestroyEventFunction, &func)
2660 #define wxSetCursorEventHandler(func) \
2661 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxSetCursorEventFunction, &func)
2662 #define wxNotifyEventHandler(func) \
2663 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNotifyEventFunction, &func)
2664 #define wxHelpEventHandler(func) \
2665 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxHelpEventFunction, &func)
2666 #define wxContextMenuEventHandler(func) \
2667 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxContextMenuEventFunction, &func)
2668 #define wxMouseCaptureChangedEventHandler(func) \
2669 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMouseCaptureChangedEventFunction, &func)
2670 #define wxMouseCaptureLostEventHandler(func) \
2671 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMouseCaptureLostEventFunction, &func)
2672 #define wxClipboardTextEventHandler(func) \
2673 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxClipboardTextEventFunction, &func)
2674
2675 #endif // wxUSE_GUI
2676
2677 // N.B. In GNU-WIN32, you *have* to take the address of a member function
2678 // (use &) or the compiler crashes...
2679
2680 #define DECLARE_EVENT_TABLE() \
2681 private: \
2682 static const wxEventTableEntry sm_eventTableEntries[]; \
2683 protected: \
2684 static const wxEventTable sm_eventTable; \
2685 virtual const wxEventTable* GetEventTable() const; \
2686 static wxEventHashTable sm_eventHashTable; \
2687 virtual wxEventHashTable& GetEventHashTable() const;
2688
2689 // N.B.: when building DLL with Borland C++ 5.5 compiler, you must initialize
2690 // sm_eventTable before using it in GetEventTable() or the compiler gives
2691 // E2233 (see http://groups.google.com/groups?selm=397dcc8a%241_2%40dnews)
2692
2693 #define BEGIN_EVENT_TABLE(theClass, baseClass) \
2694 const wxEventTable theClass::sm_eventTable = \
2695 { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] }; \
2696 const wxEventTable *theClass::GetEventTable() const \
2697 { return &theClass::sm_eventTable; } \
2698 wxEventHashTable theClass::sm_eventHashTable(theClass::sm_eventTable); \
2699 wxEventHashTable &theClass::GetEventHashTable() const \
2700 { return theClass::sm_eventHashTable; } \
2701 const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
2702
2703 #define BEGIN_EVENT_TABLE_TEMPLATE1(theClass, baseClass, T1) \
2704 template<typename T1> \
2705 const wxEventTable theClass<T1>::sm_eventTable = \
2706 { &baseClass::sm_eventTable, &theClass<T1>::sm_eventTableEntries[0] }; \
2707 template<typename T1> \
2708 const wxEventTable *theClass<T1>::GetEventTable() const \
2709 { return &theClass<T1>::sm_eventTable; } \
2710 template<typename T1> \
2711 wxEventHashTable theClass<T1>::sm_eventHashTable(theClass<T1>::sm_eventTable); \
2712 template<typename T1> \
2713 wxEventHashTable &theClass<T1>::GetEventHashTable() const \
2714 { return theClass<T1>::sm_eventHashTable; } \
2715 template<typename T1> \
2716 const wxEventTableEntry theClass<T1>::sm_eventTableEntries[] = { \
2717
2718 #define BEGIN_EVENT_TABLE_TEMPLATE2(theClass, baseClass, T1, T2) \
2719 template<typename T1, typename T2> \
2720 const wxEventTable theClass<T1, T2>::sm_eventTable = \
2721 { &baseClass::sm_eventTable, &theClass<T1, T2>::sm_eventTableEntries[0] }; \
2722 template<typename T1, typename T2> \
2723 const wxEventTable *theClass<T1, T2>::GetEventTable() const \
2724 { return &theClass<T1, T2>::sm_eventTable; } \
2725 template<typename T1, typename T2> \
2726 wxEventHashTable theClass<T1, T2>::sm_eventHashTable(theClass<T1, T2>::sm_eventTable); \
2727 template<typename T1, typename T2> \
2728 wxEventHashTable &theClass<T1, T2>::GetEventHashTable() const \
2729 { return theClass<T1, T2>::sm_eventHashTable; } \
2730 template<typename T1, typename T2> \
2731 const wxEventTableEntry theClass<T1, T2>::sm_eventTableEntries[] = { \
2732
2733 #define BEGIN_EVENT_TABLE_TEMPLATE3(theClass, baseClass, T1, T2, T3) \
2734 template<typename T1, typename T2, typename T3> \
2735 const wxEventTable theClass<T1, T2, T3>::sm_eventTable = \
2736 { &baseClass::sm_eventTable, &theClass<T1, T2, T3>::sm_eventTableEntries[0] }; \
2737 template<typename T1, typename T2, typename T3> \
2738 const wxEventTable *theClass<T1, T2, T3>::GetEventTable() const \
2739 { return &theClass<T1, T2, T3>::sm_eventTable; } \
2740 template<typename T1, typename T2, typename T3> \
2741 wxEventHashTable theClass<T1, T2, T3>::sm_eventHashTable(theClass<T1, T2, T3>::sm_eventTable); \
2742 template<typename T1, typename T2, typename T3> \
2743 wxEventHashTable &theClass<T1, T2, T3>::GetEventHashTable() const \
2744 { return theClass<T1, T2, T3>::sm_eventHashTable; } \
2745 template<typename T1, typename T2, typename T3> \
2746 const wxEventTableEntry theClass<T1, T2, T3>::sm_eventTableEntries[] = { \
2747
2748 #define BEGIN_EVENT_TABLE_TEMPLATE4(theClass, baseClass, T1, T2, T3, T4) \
2749 template<typename T1, typename T2, typename T3, typename T4> \
2750 const wxEventTable theClass<T1, T2, T3, T4>::sm_eventTable = \
2751 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4>::sm_eventTableEntries[0] }; \
2752 template<typename T1, typename T2, typename T3, typename T4> \
2753 const wxEventTable *theClass<T1, T2, T3, T4>::GetEventTable() const \
2754 { return &theClass<T1, T2, T3, T4>::sm_eventTable; } \
2755 template<typename T1, typename T2, typename T3, typename T4> \
2756 wxEventHashTable theClass<T1, T2, T3, T4>::sm_eventHashTable(theClass<T1, T2, T3, T4>::sm_eventTable); \
2757 template<typename T1, typename T2, typename T3, typename T4> \
2758 wxEventHashTable &theClass<T1, T2, T3, T4>::GetEventHashTable() const \
2759 { return theClass<T1, T2, T3, T4>::sm_eventHashTable; } \
2760 template<typename T1, typename T2, typename T3, typename T4> \
2761 const wxEventTableEntry theClass<T1, T2, T3, T4>::sm_eventTableEntries[] = { \
2762
2763 #define BEGIN_EVENT_TABLE_TEMPLATE5(theClass, baseClass, T1, T2, T3, T4, T5) \
2764 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2765 const wxEventTable theClass<T1, T2, T3, T4, T5>::sm_eventTable = \
2766 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[0] }; \
2767 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2768 const wxEventTable *theClass<T1, T2, T3, T4, T5>::GetEventTable() const \
2769 { return &theClass<T1, T2, T3, T4, T5>::sm_eventTable; } \
2770 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2771 wxEventHashTable theClass<T1, T2, T3, T4, T5>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5>::sm_eventTable); \
2772 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2773 wxEventHashTable &theClass<T1, T2, T3, T4, T5>::GetEventHashTable() const \
2774 { return theClass<T1, T2, T3, T4, T5>::sm_eventHashTable; } \
2775 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2776 const wxEventTableEntry theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[] = { \
2777
2778 #define BEGIN_EVENT_TABLE_TEMPLATE7(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7) \
2779 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2780 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable = \
2781 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[0] }; \
2782 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2783 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventTable() const \
2784 { return &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable; } \
2785 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2786 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable); \
2787 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2788 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventHashTable() const \
2789 { return theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable; } \
2790 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2791 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[] = { \
2792
2793 #define BEGIN_EVENT_TABLE_TEMPLATE8(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7, T8) \
2794 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2795 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable = \
2796 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[0] }; \
2797 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2798 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventTable() const \
2799 { return &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable; } \
2800 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2801 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable); \
2802 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2803 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventHashTable() const \
2804 { return theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable; } \
2805 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2806 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[] = { \
2807
2808 #define END_EVENT_TABLE() DECLARE_EVENT_TABLE_ENTRY( wxEVT_NULL, 0, 0, 0, 0 ) };
2809
2810 /*
2811 * Event table macros
2812 */
2813
2814 // helpers for writing shorter code below: declare an event macro taking 2, 1
2815 // or none ids (the missing ids default to wxID_ANY)
2816 //
2817 // macro arguments:
2818 // - evt one of wxEVT_XXX constants
2819 // - id1, id2 ids of the first/last id
2820 // - fn the function (should be cast to the right type)
2821 #define wx__DECLARE_EVT2(evt, id1, id2, fn) \
2822 DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
2823 #define wx__DECLARE_EVT1(evt, id, fn) \
2824 wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
2825 #define wx__DECLARE_EVT0(evt, fn) \
2826 wx__DECLARE_EVT1(evt, wxID_ANY, fn)
2827
2828
2829 // Generic events
2830 #define EVT_CUSTOM(event, winid, func) \
2831 wx__DECLARE_EVT1(event, winid, wxEventHandler(func))
2832 #define EVT_CUSTOM_RANGE(event, id1, id2, func) \
2833 wx__DECLARE_EVT2(event, id1, id2, wxEventHandler(func))
2834
2835 // EVT_COMMAND
2836 #define EVT_COMMAND(winid, event, func) \
2837 wx__DECLARE_EVT1(event, winid, wxCommandEventHandler(func))
2838 #define EVT_COMMAND_RANGE(id1, id2, event, func) \
2839 wx__DECLARE_EVT2(event, id1, id2, wxCommandEventHandler(func))
2840
2841 #define EVT_NOTIFY(event, winid, func) \
2842 wx__DECLARE_EVT1(event, winid, wxNotifyEventHandler(func))
2843 #define EVT_NOTIFY_RANGE(event, id1, id2, func) \
2844 wx__DECLARE_EVT2(event, id1, id2, wxNotifyEventHandler(func))
2845
2846 // Miscellaneous
2847 #define EVT_SIZE(func) wx__DECLARE_EVT0(wxEVT_SIZE, wxSizeEventHandler(func))
2848 #define EVT_SIZING(func) wx__DECLARE_EVT0(wxEVT_SIZING, wxSizeEventHandler(func))
2849 #define EVT_MOVE(func) wx__DECLARE_EVT0(wxEVT_MOVE, wxMoveEventHandler(func))
2850 #define EVT_MOVING(func) wx__DECLARE_EVT0(wxEVT_MOVING, wxMoveEventHandler(func))
2851 #define EVT_MOVE_START(func) wx__DECLARE_EVT0(wxEVT_MOVE_START, wxMoveEventHandler(func))
2852 #define EVT_MOVE_END(func) wx__DECLARE_EVT0(wxEVT_MOVE_END, wxMoveEventHandler(func))
2853 #define EVT_CLOSE(func) wx__DECLARE_EVT0(wxEVT_CLOSE_WINDOW, wxCloseEventHandler(func))
2854 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
2855 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
2856 #define EVT_PAINT(func) wx__DECLARE_EVT0(wxEVT_PAINT, wxPaintEventHandler(func))
2857 #define EVT_NC_PAINT(func) wx__DECLARE_EVT0(wxEVT_NC_PAINT, wxNcPaintEventHandler(func))
2858 #define EVT_ERASE_BACKGROUND(func) wx__DECLARE_EVT0(wxEVT_ERASE_BACKGROUND, wxEraseEventHandler(func))
2859 #define EVT_CHAR(func) wx__DECLARE_EVT0(wxEVT_CHAR, wxCharEventHandler(func))
2860 #define EVT_KEY_DOWN(func) wx__DECLARE_EVT0(wxEVT_KEY_DOWN, wxKeyEventHandler(func))
2861 #define EVT_KEY_UP(func) wx__DECLARE_EVT0(wxEVT_KEY_UP, wxKeyEventHandler(func))
2862 #if wxUSE_HOTKEY
2863 #define EVT_HOTKEY(winid, func) wx__DECLARE_EVT1(wxEVT_HOTKEY, winid, wxCharEventHandler(func))
2864 #endif
2865 #define EVT_CHAR_HOOK(func) wx__DECLARE_EVT0(wxEVT_CHAR_HOOK, wxCharEventHandler(func))
2866 #define EVT_MENU_OPEN(func) wx__DECLARE_EVT0(wxEVT_MENU_OPEN, wxMenuEventHandler(func))
2867 #define EVT_MENU_CLOSE(func) wx__DECLARE_EVT0(wxEVT_MENU_CLOSE, wxMenuEventHandler(func))
2868 #define EVT_MENU_HIGHLIGHT(winid, func) wx__DECLARE_EVT1(wxEVT_MENU_HIGHLIGHT, winid, wxMenuEventHandler(func))
2869 #define EVT_MENU_HIGHLIGHT_ALL(func) wx__DECLARE_EVT0(wxEVT_MENU_HIGHLIGHT, wxMenuEventHandler(func))
2870 #define EVT_SET_FOCUS(func) wx__DECLARE_EVT0(wxEVT_SET_FOCUS, wxFocusEventHandler(func))
2871 #define EVT_KILL_FOCUS(func) wx__DECLARE_EVT0(wxEVT_KILL_FOCUS, wxFocusEventHandler(func))
2872 #define EVT_CHILD_FOCUS(func) wx__DECLARE_EVT0(wxEVT_CHILD_FOCUS, wxChildFocusEventHandler(func))
2873 #define EVT_ACTIVATE(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE, wxActivateEventHandler(func))
2874 #define EVT_ACTIVATE_APP(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE_APP, wxActivateEventHandler(func))
2875 #define EVT_HIBERNATE(func) wx__DECLARE_EVT0(wxEVT_HIBERNATE, wxActivateEventHandler(func))
2876 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
2877 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
2878 #define EVT_DROP_FILES(func) wx__DECLARE_EVT0(wxEVT_DROP_FILES, wxDropFilesEventHandler(func))
2879 #define EVT_INIT_DIALOG(func) wx__DECLARE_EVT0(wxEVT_INIT_DIALOG, wxInitDialogEventHandler(func))
2880 #define EVT_SYS_COLOUR_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEventHandler(func))
2881 #define EVT_DISPLAY_CHANGED(func) wx__DECLARE_EVT0(wxEVT_DISPLAY_CHANGED, wxDisplayChangedEventHandler(func))
2882 #define EVT_SHOW(func) wx__DECLARE_EVT0(wxEVT_SHOW, wxShowEventHandler(func))
2883 #define EVT_MAXIMIZE(func) wx__DECLARE_EVT0(wxEVT_MAXIMIZE, wxMaximizeEventHandler(func))
2884 #define EVT_ICONIZE(func) wx__DECLARE_EVT0(wxEVT_ICONIZE, wxIconizeEventHandler(func))
2885 #define EVT_NAVIGATION_KEY(func) wx__DECLARE_EVT0(wxEVT_NAVIGATION_KEY, wxNavigationKeyEventHandler(func))
2886 #define EVT_PALETTE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_PALETTE_CHANGED, wxPaletteChangedEventHandler(func))
2887 #define EVT_QUERY_NEW_PALETTE(func) wx__DECLARE_EVT0(wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEventHandler(func))
2888 #define EVT_WINDOW_CREATE(func) wx__DECLARE_EVT0(wxEVT_CREATE, wxWindowCreateEventHandler(func))
2889 #define EVT_WINDOW_DESTROY(func) wx__DECLARE_EVT0(wxEVT_DESTROY, wxWindowDestroyEventHandler(func))
2890 #define EVT_SET_CURSOR(func) wx__DECLARE_EVT0(wxEVT_SET_CURSOR, wxSetCursorEventHandler(func))
2891 #define EVT_MOUSE_CAPTURE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEventHandler(func))
2892 #define EVT_MOUSE_CAPTURE_LOST(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEventHandler(func))
2893
2894 // Mouse events
2895 #define EVT_LEFT_DOWN(func) wx__DECLARE_EVT0(wxEVT_LEFT_DOWN, wxMouseEventHandler(func))
2896 #define EVT_LEFT_UP(func) wx__DECLARE_EVT0(wxEVT_LEFT_UP, wxMouseEventHandler(func))
2897 #define EVT_MIDDLE_DOWN(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DOWN, wxMouseEventHandler(func))
2898 #define EVT_MIDDLE_UP(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_UP, wxMouseEventHandler(func))
2899 #define EVT_RIGHT_DOWN(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DOWN, wxMouseEventHandler(func))
2900 #define EVT_RIGHT_UP(func) wx__DECLARE_EVT0(wxEVT_RIGHT_UP, wxMouseEventHandler(func))
2901 #define EVT_MOTION(func) wx__DECLARE_EVT0(wxEVT_MOTION, wxMouseEventHandler(func))
2902 #define EVT_LEFT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_LEFT_DCLICK, wxMouseEventHandler(func))
2903 #define EVT_MIDDLE_DCLICK(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DCLICK, wxMouseEventHandler(func))
2904 #define EVT_RIGHT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DCLICK, wxMouseEventHandler(func))
2905 #define EVT_LEAVE_WINDOW(func) wx__DECLARE_EVT0(wxEVT_LEAVE_WINDOW, wxMouseEventHandler(func))
2906 #define EVT_ENTER_WINDOW(func) wx__DECLARE_EVT0(wxEVT_ENTER_WINDOW, wxMouseEventHandler(func))
2907 #define EVT_MOUSEWHEEL(func) wx__DECLARE_EVT0(wxEVT_MOUSEWHEEL, wxMouseEventHandler(func))
2908 #define EVT_MOUSE_AUX1_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX1_DOWN, wxMouseEventHandler(func))
2909 #define EVT_MOUSE_AUX1_UP(func) wx__DECLARE_EVT0(wxEVT_AUX1_UP, wxMouseEventHandler(func))
2910 #define EVT_MOUSE_AUX1_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX1_DCLICK, wxMouseEventHandler(func))
2911 #define EVT_MOUSE_AUX2_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX2_DOWN, wxMouseEventHandler(func))
2912 #define EVT_MOUSE_AUX2_UP(func) wx__DECLARE_EVT0(wxEVT_AUX2_UP, wxMouseEventHandler(func))
2913 #define EVT_MOUSE_AUX2_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX2_DCLICK, wxMouseEventHandler(func))
2914
2915 // All mouse events
2916 #define EVT_MOUSE_EVENTS(func) \
2917 EVT_LEFT_DOWN(func) \
2918 EVT_LEFT_UP(func) \
2919 EVT_LEFT_DCLICK(func) \
2920 EVT_MIDDLE_DOWN(func) \
2921 EVT_MIDDLE_UP(func) \
2922 EVT_MIDDLE_DCLICK(func) \
2923 EVT_RIGHT_DOWN(func) \
2924 EVT_RIGHT_UP(func) \
2925 EVT_RIGHT_DCLICK(func) \
2926 EVT_MOUSE_AUX1_DOWN(func) \
2927 EVT_MOUSE_AUX1_UP(func) \
2928 EVT_MOUSE_AUX1_DCLICK(func) \
2929 EVT_MOUSE_AUX2_DOWN(func) \
2930 EVT_MOUSE_AUX2_UP(func) \
2931 EVT_MOUSE_AUX2_DCLICK(func) \
2932 EVT_MOTION(func) \
2933 EVT_LEAVE_WINDOW(func) \
2934 EVT_ENTER_WINDOW(func) \
2935 EVT_MOUSEWHEEL(func)
2936
2937 // Scrolling from wxWindow (sent to wxScrolledWindow)
2938 #define EVT_SCROLLWIN_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_TOP, wxScrollWinEventHandler(func))
2939 #define EVT_SCROLLWIN_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEventHandler(func))
2940 #define EVT_SCROLLWIN_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEUP, wxScrollWinEventHandler(func))
2941 #define EVT_SCROLLWIN_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEventHandler(func))
2942 #define EVT_SCROLLWIN_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEventHandler(func))
2943 #define EVT_SCROLLWIN_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEventHandler(func))
2944 #define EVT_SCROLLWIN_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEventHandler(func))
2945 #define EVT_SCROLLWIN_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEventHandler(func))
2946
2947 #define EVT_SCROLLWIN(func) \
2948 EVT_SCROLLWIN_TOP(func) \
2949 EVT_SCROLLWIN_BOTTOM(func) \
2950 EVT_SCROLLWIN_LINEUP(func) \
2951 EVT_SCROLLWIN_LINEDOWN(func) \
2952 EVT_SCROLLWIN_PAGEUP(func) \
2953 EVT_SCROLLWIN_PAGEDOWN(func) \
2954 EVT_SCROLLWIN_THUMBTRACK(func) \
2955 EVT_SCROLLWIN_THUMBRELEASE(func)
2956
2957 // Scrolling from wxSlider and wxScrollBar
2958 #define EVT_SCROLL_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_TOP, wxScrollEventHandler(func))
2959 #define EVT_SCROLL_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLL_BOTTOM, wxScrollEventHandler(func))
2960 #define EVT_SCROLL_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEUP, wxScrollEventHandler(func))
2961 #define EVT_SCROLL_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEDOWN, wxScrollEventHandler(func))
2962 #define EVT_SCROLL_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEUP, wxScrollEventHandler(func))
2963 #define EVT_SCROLL_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler(func))
2964 #define EVT_SCROLL_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler(func))
2965 #define EVT_SCROLL_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBRELEASE, wxScrollEventHandler(func))
2966 #define EVT_SCROLL_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SCROLL_CHANGED, wxScrollEventHandler(func))
2967
2968 #define EVT_SCROLL(func) \
2969 EVT_SCROLL_TOP(func) \
2970 EVT_SCROLL_BOTTOM(func) \
2971 EVT_SCROLL_LINEUP(func) \
2972 EVT_SCROLL_LINEDOWN(func) \
2973 EVT_SCROLL_PAGEUP(func) \
2974 EVT_SCROLL_PAGEDOWN(func) \
2975 EVT_SCROLL_THUMBTRACK(func) \
2976 EVT_SCROLL_THUMBRELEASE(func) \
2977 EVT_SCROLL_CHANGED(func)
2978
2979 // Scrolling from wxSlider and wxScrollBar, with an id
2980 #define EVT_COMMAND_SCROLL_TOP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_TOP, winid, wxScrollEventHandler(func))
2981 #define EVT_COMMAND_SCROLL_BOTTOM(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_BOTTOM, winid, wxScrollEventHandler(func))
2982 #define EVT_COMMAND_SCROLL_LINEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEUP, winid, wxScrollEventHandler(func))
2983 #define EVT_COMMAND_SCROLL_LINEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEDOWN, winid, wxScrollEventHandler(func))
2984 #define EVT_COMMAND_SCROLL_PAGEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEUP, winid, wxScrollEventHandler(func))
2985 #define EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEDOWN, winid, wxScrollEventHandler(func))
2986 #define EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBTRACK, winid, wxScrollEventHandler(func))
2987 #define EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBRELEASE, winid, wxScrollEventHandler(func))
2988 #define EVT_COMMAND_SCROLL_CHANGED(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_CHANGED, winid, wxScrollEventHandler(func))
2989
2990 #define EVT_COMMAND_SCROLL(winid, func) \
2991 EVT_COMMAND_SCROLL_TOP(winid, func) \
2992 EVT_COMMAND_SCROLL_BOTTOM(winid, func) \
2993 EVT_COMMAND_SCROLL_LINEUP(winid, func) \
2994 EVT_COMMAND_SCROLL_LINEDOWN(winid, func) \
2995 EVT_COMMAND_SCROLL_PAGEUP(winid, func) \
2996 EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) \
2997 EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) \
2998 EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) \
2999 EVT_COMMAND_SCROLL_CHANGED(winid, func)
3000
3001 #if WXWIN_COMPATIBILITY_2_6
3002 // compatibility macros for the old name, deprecated in 2.8
3003 #define wxEVT_SCROLL_ENDSCROLL wxEVT_SCROLL_CHANGED
3004 #define EVT_COMMAND_SCROLL_ENDSCROLL EVT_COMMAND_SCROLL_CHANGED
3005 #define EVT_SCROLL_ENDSCROLL EVT_SCROLL_CHANGED
3006 #endif // WXWIN_COMPATIBILITY_2_6
3007
3008 // Convenience macros for commonly-used commands
3009 #define EVT_CHECKBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKBOX_CLICKED, winid, wxCommandEventHandler(func))
3010 #define EVT_CHOICE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHOICE_SELECTED, winid, wxCommandEventHandler(func))
3011 #define EVT_LISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_SELECTED, winid, wxCommandEventHandler(func))
3012 #define EVT_LISTBOX_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, winid, wxCommandEventHandler(func))
3013 #define EVT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_MENU_SELECTED, winid, wxCommandEventHandler(func))
3014 #define EVT_MENU_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_MENU_SELECTED, id1, id2, wxCommandEventHandler(func))
3015 #if defined(__SMARTPHONE__)
3016 # define EVT_BUTTON(winid, func) EVT_MENU(winid, func)
3017 #else
3018 # define EVT_BUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_BUTTON_CLICKED, winid, wxCommandEventHandler(func))
3019 #endif
3020 #define EVT_SLIDER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SLIDER_UPDATED, winid, wxCommandEventHandler(func))
3021 #define EVT_RADIOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBOX_SELECTED, winid, wxCommandEventHandler(func))
3022 #define EVT_RADIOBUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBUTTON_SELECTED, winid, wxCommandEventHandler(func))
3023 // EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events
3024 #define EVT_SCROLLBAR(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SCROLLBAR_UPDATED, winid, wxCommandEventHandler(func))
3025 #define EVT_VLBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_VLBOX_SELECTED, winid, wxCommandEventHandler(func))
3026 #define EVT_COMBOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_SELECTED, winid, wxCommandEventHandler(func))
3027 #define EVT_TOOL(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_CLICKED, winid, wxCommandEventHandler(func))
3028 #define EVT_TOOL_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, winid, wxCommandEventHandler(func))
3029 #define EVT_TOOL_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_CLICKED, id1, id2, wxCommandEventHandler(func))
3030 #define EVT_TOOL_RCLICKED(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_RCLICKED, winid, wxCommandEventHandler(func))
3031 #define EVT_TOOL_RCLICKED_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, wxCommandEventHandler(func))
3032 #define EVT_TOOL_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_ENTER, winid, wxCommandEventHandler(func))
3033 #define EVT_CHECKLISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, winid, wxCommandEventHandler(func))
3034
3035 // Generic command events
3036 #define EVT_COMMAND_LEFT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_CLICK, winid, wxCommandEventHandler(func))
3037 #define EVT_COMMAND_LEFT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_DCLICK, winid, wxCommandEventHandler(func))
3038 #define EVT_COMMAND_RIGHT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_CLICK, winid, wxCommandEventHandler(func))
3039 #define EVT_COMMAND_RIGHT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_DCLICK, winid, wxCommandEventHandler(func))
3040 #define EVT_COMMAND_SET_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SET_FOCUS, winid, wxCommandEventHandler(func))
3041 #define EVT_COMMAND_KILL_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_KILL_FOCUS, winid, wxCommandEventHandler(func))
3042 #define EVT_COMMAND_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_ENTER, winid, wxCommandEventHandler(func))
3043
3044 // Joystick events
3045
3046 #define EVT_JOY_BUTTON_DOWN(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_DOWN, wxJoystickEventHandler(func))
3047 #define EVT_JOY_BUTTON_UP(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_UP, wxJoystickEventHandler(func))
3048 #define EVT_JOY_MOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_MOVE, wxJoystickEventHandler(func))
3049 #define EVT_JOY_ZMOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_ZMOVE, wxJoystickEventHandler(func))
3050
3051 // All joystick events
3052 #define EVT_JOYSTICK_EVENTS(func) \
3053 EVT_JOY_BUTTON_DOWN(func) \
3054 EVT_JOY_BUTTON_UP(func) \
3055 EVT_JOY_MOVE(func) \
3056 EVT_JOY_ZMOVE(func)
3057
3058 // Idle event
3059 #define EVT_IDLE(func) wx__DECLARE_EVT0(wxEVT_IDLE, wxIdleEventHandler(func))
3060
3061 // Update UI event
3062 #define EVT_UPDATE_UI(winid, func) wx__DECLARE_EVT1(wxEVT_UPDATE_UI, winid, wxUpdateUIEventHandler(func))
3063 #define EVT_UPDATE_UI_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_UPDATE_UI, id1, id2, wxUpdateUIEventHandler(func))
3064
3065 // Help events
3066 #define EVT_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_HELP, winid, wxHelpEventHandler(func))
3067 #define EVT_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_HELP, id1, id2, wxHelpEventHandler(func))
3068 #define EVT_DETAILED_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_DETAILED_HELP, winid, wxHelpEventHandler(func))
3069 #define EVT_DETAILED_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_DETAILED_HELP, id1, id2, wxHelpEventHandler(func))
3070
3071 // Context Menu Events
3072 #define EVT_CONTEXT_MENU(func) wx__DECLARE_EVT0(wxEVT_CONTEXT_MENU, wxContextMenuEventHandler(func))
3073 #define EVT_COMMAND_CONTEXT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_CONTEXT_MENU, winid, wxContextMenuEventHandler(func))
3074
3075 // Clipboard text Events
3076 #define EVT_TEXT_CUT(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_CUT, winid, wxClipboardTextEventHandler(func))
3077 #define EVT_TEXT_COPY(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_COPY, winid, wxClipboardTextEventHandler(func))
3078 #define EVT_TEXT_PASTE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_PASTE, winid, wxClipboardTextEventHandler(func))
3079
3080 // ----------------------------------------------------------------------------
3081 // Global data
3082 // ----------------------------------------------------------------------------
3083
3084 // for pending event processing - notice that there is intentionally no
3085 // WXDLLEXPORT here
3086 extern WXDLLIMPEXP_BASE wxList *wxPendingEvents;
3087 #if wxUSE_THREADS
3088 extern WXDLLIMPEXP_BASE wxCriticalSection *wxPendingEventsLocker;
3089 #endif
3090
3091 // ----------------------------------------------------------------------------
3092 // Helper functions
3093 // ----------------------------------------------------------------------------
3094
3095 #if wxUSE_GUI
3096
3097 // Find a window with the focus, that is also a descendant of the given window.
3098 // This is used to determine the window to initially send commands to.
3099 WXDLLIMPEXP_CORE wxWindow* wxFindFocusDescendant(wxWindow* ancestor);
3100
3101 #endif // wxUSE_GUI
3102
3103 #endif // _WX_EVENT_H__