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