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