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