fix the new wxThreadEvent class adopting the new type-safe conventions for event...
[wxWidgets.git] / include / wx / event.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/event.h
3 // Purpose: Event classes
4 // Author: Julian Smart
5 // Modified by:
6 // Created: 01/02/97
7 // RCS-ID: $Id$
8 // Copyright: (c) wxWidgets team
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_EVENT_H_
13 #define _WX_EVENT_H_
14
15 #include "wx/defs.h"
16 #include "wx/cpp.h"
17 #include "wx/object.h"
18 #include "wx/clntdata.h"
19
20 #if wxUSE_GUI
21 #include "wx/gdicmn.h"
22 #include "wx/cursor.h"
23 #include "wx/mousestate.h"
24 #endif
25
26 #include "wx/dynarray.h"
27 #include "wx/thread.h"
28 #include "wx/tracker.h"
29
30 #if !wxEVENTS_COMPATIBILITY_2_8
31 #include "wx/meta/convertible.h"
32 #endif
33
34 // ----------------------------------------------------------------------------
35 // forward declarations
36 // ----------------------------------------------------------------------------
37
38 class WXDLLIMPEXP_FWD_BASE wxList;
39 class WXDLLIMPEXP_FWD_BASE wxEvent;
40 #if wxUSE_GUI
41 class WXDLLIMPEXP_FWD_CORE wxDC;
42 class WXDLLIMPEXP_FWD_CORE wxMenu;
43 class WXDLLIMPEXP_FWD_CORE wxWindow;
44 class WXDLLIMPEXP_FWD_CORE wxWindowBase;
45 #endif // wxUSE_GUI
46
47 // We operate with pointer to members of wxEvtHandler (such functions are used
48 // as event handlers in the event tables or as arguments to Connect()) but by
49 // default MSVC uses a restricted (but more efficient) representation of
50 // pointers to members which can't deal with multiple base classes. To avoid
51 // mysterious (as the compiler is not good enough to detect this and give a
52 // sensible error message) errors in the user code as soon as it defines
53 // classes inheriting from both wxEvtHandler (possibly indirectly, e.g. via
54 // wxWindow) and something else (including our own wxTrackable but not limited
55 // to it), we use the special MSVC keyword telling the compiler to use a more
56 // general pointer to member representation for the classes inheriting from
57 // wxEvtHandler.
58 #ifdef __VISUALC__
59 #define wxMSVC_FWD_MULTIPLE_BASES __multiple_inheritance
60 #else
61 #define wxMSVC_FWD_MULTIPLE_BASES
62 #endif
63
64 class WXDLLIMPEXP_FWD_BASE wxMSVC_FWD_MULTIPLE_BASES wxEvtHandler;
65 class wxEventConnectionRef;
66
67 // ----------------------------------------------------------------------------
68 // Event types
69 // ----------------------------------------------------------------------------
70
71 typedef int wxEventType;
72
73 #define wxEVT_ANY ((wxEventType)-1)
74
75 // this is used to make the event table entry type safe, so that for an event
76 // handler only a function with proper parameter list can be given. See also
77 // the wxEVENT_HANDLER_CAST-macro.
78 #define wxStaticCastEvent(type, val) static_cast<type>(val)
79
80 #define DECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj) \
81 wxEventTableEntry(type, winid, idLast, wxNewEventFunctor(type, fn), obj)
82
83 #define DECLARE_EVENT_TABLE_TERMINATOR() \
84 wxEventTableEntry(wxEVT_NULL, 0, 0, 0, 0)
85
86 // obsolete event declaration/definition macros, we don't need them any longer
87 // but we keep them for compatibility as it doesn't cost us anything anyhow
88 #define BEGIN_DECLARE_EVENT_TYPES()
89 #define END_DECLARE_EVENT_TYPES()
90 #define DECLARE_EXPORTED_EVENT_TYPE(expdecl, name, value) \
91 extern expdecl const wxEventType name;
92 #define DECLARE_EVENT_TYPE(name, value) \
93 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_CORE, name, value)
94 #define DECLARE_LOCAL_EVENT_TYPE(name, value) \
95 DECLARE_EXPORTED_EVENT_TYPE(wxEMPTY_PARAMETER_VALUE, name, value)
96 #define DEFINE_EVENT_TYPE(name) const wxEventType name = wxNewEventType();
97 #define DEFINE_LOCAL_EVENT_TYPE(name) DEFINE_EVENT_TYPE(name)
98
99 // generate a new unique event type
100 extern WXDLLIMPEXP_BASE wxEventType wxNewEventType();
101
102 // New macros to create templatized event types:
103
104 #if wxEVENTS_COMPATIBILITY_2_8
105
106 // Define/Declare a wxEventType-based event type:
107
108 #define wxDEFINE_EVENT( name, type ) \
109 const wxEventType name( wxNewEventType() );
110
111 #define wxDECLARE_EXPORTED_EVENT( expdecl, name, type ) \
112 extern const expdecl wxEventType name;
113
114 // Define/Declare a wxEventType-based event type and initialize it with a
115 // predefined event type. (Only used for wxEVT_SPIN_XXX for backward
116 // compatibility)
117
118 #define wxDEFINE_EVENT_ALIAS( name, type, value ) \
119 const wxEventType name = value;
120
121 #define wxDECLARE_EXPORTED_EVENT_ALIAS( expdecl, name, type ) \
122 extern const expdecl wxEventType name;
123
124 // Declare a local (not exported) wxEventType-based event type:
125
126 #define wxDECLARE_LOCAL_EVENT( name, type ) \
127 wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type )
128
129 // Try to cast the given event handler to the correct handler type:
130
131 #define wxEVENT_HANDLER_CAST( functype, func ) \
132 ( wxObjectEventFunction )( wxEventFunction )wxStaticCastEvent( functype, &func )
133 #else
134 // Define/Declare a templatized event type with the corresponding event as
135 // a nested typedef:
136
137 #define wxDEFINE_EVENT( name, type ) \
138 const wxEventTypeTag< type > name( wxNewEventType() );
139
140 #define wxDECLARE_EXPORTED_EVENT( expdecl, name, type ) \
141 extern const expdecl wxEventTypeTag< type > name;
142
143 // Define/Declare a templatized event type and initialize it with a
144 // predefined event type. (Only used for wxEVT_SPIN_XXX for backward
145 // compatibility)
146
147 #define wxDEFINE_EVENT_ALIAS( name, type, value ) \
148 const wxEventTypeTag< type > name( value );
149
150 #define wxDECLARE_EXPORTED_EVENT_ALIAS( expdecl, name, type ) \
151 extern const expdecl wxEventTypeTag< type > name;
152
153 // Declare a local (not exported) templatized event type:
154
155 #define wxDECLARE_LOCAL_EVENT( name, type ) \
156 wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type )
157
158 // Don't cast the given event handler so that wxEvtHandler::Connect() sees
159 // the actual type:
160
161 #define wxEVENT_HANDLER_CAST( functype, func ) \
162 ( &func )
163 #endif
164
165 // Template which associates the correct event object with the event type
166
167 #if !wxEVENTS_COMPATIBILITY_2_8
168
169 // The tag is a type associated to the event type (which is an integer itself,
170 // in spite of its name) value. It exists in order to be used as a template
171 // parameter and provide a mapping between the event type values and their
172 // corresponding wxEvent-derived classes.
173 template <typename T>
174 class wxEventTypeTag
175 {
176 public:
177 // The class of wxEvent-derived class carried by the events of this type.
178 typedef T EventClass;
179
180 wxEventTypeTag(wxEventType type) { m_type = type; }
181
182 // Return a wxEventType reference for the initialization of the static
183 // event tables. See wxEventTableEntry::m_eventType for a more thorough
184 // explanation.
185 operator const wxEventType&() const { return m_type; }
186
187 private:
188 wxEventType m_type;
189 };
190
191 #endif // !wxEVENTS_COMPATIBILITY_2_8
192
193 // These are needed for the functor definitions
194 typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&);
195
196 // We had some trouble (specifically with eVC for ARM WinCE build) with using
197 // wxEventFunction in the past so we had introduced wxObjectEventFunction which
198 // used to be a typedef for a member of wxObject and not wxEvtHandler to work
199 // around this but as eVC is not really supported any longer we now only keep
200 // this for backwards compatibility and, despite its name, this is a typedef
201 // for wxEvtHandler member now -- but if we have the same problem with another
202 // compiler we can restore its old definition for it.
203 typedef wxEventFunction wxObjectEventFunction;
204
205
206 // The event functor which is stored in the static and dynamic event tables:
207 class WXDLLIMPEXP_BASE wxEventFunctor
208 {
209 public:
210 virtual ~wxEventFunctor();
211
212 // Invoke the actual event handler:
213 virtual void operator()(wxEvtHandler *, wxEvent&) = 0;
214
215 // this function tests whether this functor is matched, for the purpose of
216 // finding it in an event table in Disconnect(), by the given func
217 virtual bool Matches(const wxEventFunctor& func) const = 0;
218
219 // these functions are used for functors comparison in Matches()
220 virtual void *GetHandler() const { return GetEvtHandler(); }
221 virtual wxEventFunction GetMethod() const { return NULL; }
222
223 // this one is also used elsewhere in the code and should be overridden to
224 // return non-NULL if we are indeed associated with an wxEvtHandler
225 virtual wxEvtHandler *GetEvtHandler() const { return NULL; }
226 };
227
228 // A plain method functor: notice that it is used even with the new events as
229 // it is reused as a specialization of wxEventFunctorMethod for legacy untyped
230 // event types
231 class WXDLLIMPEXP_BASE wxObjectEventFunctor : public wxEventFunctor
232 {
233 public:
234 wxObjectEventFunctor(wxObjectEventFunction method, wxEvtHandler *handler)
235 {
236 m_handler = handler;
237 m_method = method;
238 }
239
240 virtual void operator()(wxEvtHandler *handler, wxEvent& event)
241 {
242 wxEvtHandler * const realHandler = m_handler ? m_handler : handler;
243
244 (realHandler->*m_method)(event);
245 }
246
247 virtual bool Matches(const wxEventFunctor& func) const
248 {
249 void * const handler = func.GetHandler();
250 if ( handler && GetHandler() != handler )
251 return false;
252
253 const wxEventFunction method = GetMethod();
254
255 // FIXME-VC6: amazing but true: replacing "method == NULL" here with
256 // "!method" makes VC6 crash with an ICE in DLL build (only!)
257 return method == NULL || GetMethod() == method;
258 }
259
260 virtual wxEvtHandler *GetEvtHandler() const { return m_handler; }
261 virtual wxEventFunction GetMethod() const { return m_method; }
262
263 private:
264 wxEvtHandler *m_handler;
265 wxEventFunction m_method;
266 };
267
268 #if wxEVENTS_COMPATIBILITY_2_8
269
270 // Create a functor for the legacy events: handler can be NULL and its default
271 // value is used by the event table macros
272
273 inline wxObjectEventFunctor *
274 wxNewEventFunctor(const wxEventType& WXUNUSED(evtType),
275 wxObjectEventFunction method,
276 wxEvtHandler *handler = NULL)
277 {
278 return new wxObjectEventFunctor(method, handler);
279 }
280
281 inline wxObjectEventFunctor
282 wxMakeEventFunctor(const wxEventType& WXUNUSED(evtType),
283 wxObjectEventFunction method,
284 wxEvtHandler *handler)
285 {
286 return wxObjectEventFunctor(method, handler);
287 }
288
289 #else // !wxEVENTS_COMPATIBILITY_2_8
290
291 // functor forwarding the event to anything callable (function, static method,
292 // generalized functor...)
293 template <typename EventTag, typename Functor>
294 class wxEventFunctorFunction : public wxEventFunctor
295 {
296 public:
297 typedef typename EventTag::EventClass EventArg;
298
299 wxEventFunctorFunction(Functor handler)
300 {
301 m_handler = handler;
302 }
303
304 virtual void operator()(wxEvtHandler *WXUNUSED(handler), wxEvent& event)
305 {
306 m_handler(static_cast<EventArg&>(event));
307 }
308
309 virtual bool Matches(const wxEventFunctor& WXUNUSED(func)) const
310 {
311 // we have no way to compare arbitrary functors so just consider them
312 // to be equal: this means that disconnecting a functor will always
313 // find the last functor connected which in turn implies that it's
314 // probably a bad idea to connect more than one functor if you plan to
315 // disconnect them but this limitation doesn't seem very important in
316 // practice
317 return true;
318 }
319
320 private:
321 Functor m_handler;
322 };
323
324 // helper class defining operations different for method functors using an
325 // object of wxEvtHandler-derived class as handler and the others
326 namespace wxPrivate
327 {
328
329 template <typename T, typename A, bool> struct HandlerImpl;
330
331 // specialization for handlers deriving from wxEvtHandler
332 template <typename T, typename A>
333 struct HandlerImpl<T, A, true>
334 {
335 static bool IsEvtHandler()
336 { return true; }
337 static T *ConvertFromEvtHandler(wxEvtHandler *p)
338 { return static_cast<T *>(p); }
339 static wxEvtHandler *ConvertToEvtHandler(T *p)
340 { return p; }
341 static wxEventFunction ConvertToEvtFunction(void (T::*f)(A&))
342 { return reinterpret_cast<wxEventFunction>(f); }
343 };
344
345 // specialization for handlers not deriving from wxEvtHandler
346 template <typename T, typename A>
347 struct HandlerImpl<T, A, false>
348 {
349 static bool IsEvtHandler()
350 { return false; }
351 static T *ConvertFromEvtHandler(wxEvtHandler *)
352 { return NULL; }
353 static wxEvtHandler *ConvertToEvtHandler(T *)
354 { return NULL; }
355 static wxEventFunction ConvertToEvtFunction(void (T::*)(A&))
356 { return NULL; }
357 };
358
359 } // namespace wxPrivate
360
361 // functor forwarding the event to a method of the given object
362 //
363 // notice that the object class may be different from the class in which the
364 // method is defined but it must be convertible to this class
365 template <typename EventTag, typename Class, typename ObjClass>
366 class wxEventFunctorMethod
367 : public wxEventFunctor,
368 private wxPrivate::HandlerImpl
369 <
370 Class,
371 typename EventTag::EventClass,
372 wxConvertibleTo<Class, wxEvtHandler>::value
373 >
374 {
375 public:
376 typedef typename EventTag::EventClass EventArg;
377
378 wxEventFunctorMethod(void (Class::*method)(EventArg&), ObjClass *handler)
379 {
380 wxASSERT_MSG( handler || this->IsEvtHandler(),
381 "handlers defined in non-wxEvtHandler-derived classes "
382 "must be connected with a valid sink object" );
383
384 m_handler = handler;
385 m_method = method;
386 }
387
388 virtual void operator()(wxEvtHandler *handler, wxEvent& event)
389 {
390 Class * realHandler = m_handler;
391 if ( !realHandler )
392 {
393 realHandler = this->ConvertFromEvtHandler(handler);
394
395 // this is not supposed to happen but check for it nevertheless
396 wxCHECK_RET( realHandler, "invalid event handler" );
397 }
398
399 (realHandler->*m_method)(static_cast<EventArg&>(event));
400 }
401
402 virtual bool Matches(const wxEventFunctor& func) const
403 {
404 void * const handler = func.GetHandler();
405 if ( handler && GetHandler() != handler )
406 return false;
407
408 const wxEventFunction method = GetMethod();
409 return !method || GetMethod() == method;
410 }
411
412 virtual void *GetHandler() const
413 {
414 return m_handler;
415 }
416
417 virtual wxEventFunction GetMethod() const
418 {
419 return this->ConvertToEvtFunction(m_method);
420 }
421
422 virtual wxEvtHandler *GetEvtHandler() const
423 {
424 return this->ConvertToEvtHandler(m_handler);
425 }
426
427 private:
428 ObjClass *m_handler;
429 void (Class::*m_method)(EventArg&);
430 };
431
432 // partial specialization for legacy event types
433 template <typename ObjClass>
434 class wxEventFunctorMethod<wxEventType, wxEvtHandler, ObjClass>
435 : public wxObjectEventFunctor
436 {
437 public:
438 wxEventFunctorMethod(wxObjectEventFunction method, ObjClass *handler)
439 : wxObjectEventFunctor(method, handler)
440 {
441 }
442 };
443
444
445 //
446 // Create functors for the templatized events, either allocated on the heap for
447 // wxNewXXX() variants (this is needed in wxEvtHandler::Connect() to store them
448 // in dynamic event table) or just by returning them as temporary objects (this
449 // is enough for Disconnect() and we allocate unnecessary heap allocation like
450 // this)
451
452
453 // Create functors wrapping other functors (including functions):
454 template <typename EventTag, typename Functor>
455 inline wxEventFunctorFunction<EventTag, Functor> *
456 wxNewEventFunctor(const EventTag&, Functor func)
457 {
458 return new wxEventFunctorFunction<EventTag, Functor>(func);
459 }
460
461 template <typename EventTag, typename Functor>
462 inline wxEventFunctorFunction<EventTag, Functor>
463 wxMakeEventFunctor(const EventTag&, Functor func)
464 {
465 return wxEventFunctorFunction<EventTag, Functor>(func);
466 }
467
468
469 // Create functors for methods:
470 template
471 <typename EventTag, typename Class, typename EventArg, typename ObjClass>
472 inline wxEventFunctorMethod<EventTag, Class, ObjClass> *
473 wxNewEventFunctor(const EventTag&,
474 void (Class::*method)(EventArg&),
475 ObjClass *handler)
476 {
477 return new wxEventFunctorMethod<EventTag, Class, ObjClass>(method, handler);
478 }
479
480 template
481 <typename EventTag, typename Class, typename EventArg, typename ObjClass>
482 inline wxEventFunctorMethod<EventTag, Class, ObjClass>
483 wxMakeEventFunctor(const EventTag&,
484 void (Class::*method)(EventArg&),
485 ObjClass *handler)
486 {
487 return wxEventFunctorMethod<EventTag, Class, ObjClass>(method, handler);
488 }
489
490 // Special case for the wxNewEventFunctor() calls used inside the event table
491 // macros: they don't specify the handler so ObjClass can't be deduced
492 template <typename EventTag, typename Class, typename EventArg>
493 inline wxEventFunctorMethod<EventTag, Class, Class> *
494 wxNewEventFunctor(const EventTag&, void (Class::*method)(EventArg&))
495 {
496 return new wxEventFunctorMethod<EventTag, Class, Class>(method, NULL);
497 }
498
499 template
500 <typename EventTag, typename Class, typename EventArg, typename ObjClass>
501 inline wxEventFunctorMethod<EventTag, Class, Class>
502 wxMakeEventFunctor(const EventTag&, void (Class::*method)(EventArg&))
503 {
504 return wxEventFunctorMethod<EventTag, Class, Class>(method, NULL);
505 }
506
507 #endif // !wxEVENTS_COMPATIBILITY_2_8
508
509
510 // many, but not all, standard event types
511
512 // some generic events
513 extern WXDLLIMPEXP_BASE const wxEventType wxEVT_NULL;
514 extern WXDLLIMPEXP_BASE const wxEventType wxEVT_FIRST;
515 extern WXDLLIMPEXP_BASE const wxEventType wxEVT_USER_FIRST;
516
517 // Need events declared to do this
518 class WXDLLIMPEXP_FWD_CORE wxCommandEvent;
519 class WXDLLIMPEXP_FWD_CORE wxThreadEvent;
520 class WXDLLIMPEXP_FWD_CORE wxMouseEvent;
521 class WXDLLIMPEXP_FWD_CORE wxFocusEvent;
522 class WXDLLIMPEXP_FWD_CORE wxChildFocusEvent;
523 class WXDLLIMPEXP_FWD_CORE wxKeyEvent;
524 class WXDLLIMPEXP_FWD_CORE wxNavigationKeyEvent;
525 class WXDLLIMPEXP_FWD_CORE wxSetCursorEvent;
526 class WXDLLIMPEXP_FWD_CORE wxScrollEvent;
527 class WXDLLIMPEXP_FWD_CORE wxSpinEvent;
528 class WXDLLIMPEXP_FWD_CORE wxScrollWinEvent;
529 class WXDLLIMPEXP_FWD_CORE wxSizeEvent;
530 class WXDLLIMPEXP_FWD_CORE wxMoveEvent;
531 class WXDLLIMPEXP_FWD_CORE wxCloseEvent;
532 class WXDLLIMPEXP_FWD_CORE wxActivateEvent;
533 class WXDLLIMPEXP_FWD_CORE wxWindowCreateEvent;
534 class WXDLLIMPEXP_FWD_CORE wxWindowDestroyEvent;
535 class WXDLLIMPEXP_FWD_CORE wxShowEvent;
536 class WXDLLIMPEXP_FWD_CORE wxIconizeEvent;
537 class WXDLLIMPEXP_FWD_CORE wxMaximizeEvent;
538 class WXDLLIMPEXP_FWD_CORE wxMouseCaptureChangedEvent;
539 class WXDLLIMPEXP_FWD_CORE wxMouseCaptureLostEvent;
540 class WXDLLIMPEXP_FWD_CORE wxPaintEvent;
541 class WXDLLIMPEXP_FWD_CORE wxEraseEvent;
542 class WXDLLIMPEXP_FWD_CORE wxNcPaintEvent;
543 class WXDLLIMPEXP_FWD_CORE wxMenuEvent;
544 class WXDLLIMPEXP_FWD_CORE wxContextMenuEvent;
545 class WXDLLIMPEXP_FWD_CORE wxSysColourChangedEvent;
546 class WXDLLIMPEXP_FWD_CORE wxDisplayChangedEvent;
547 class WXDLLIMPEXP_FWD_CORE wxQueryNewPaletteEvent;
548 class WXDLLIMPEXP_FWD_CORE wxPaletteChangedEvent;
549 class WXDLLIMPEXP_FWD_CORE wxJoystickEvent;
550 class WXDLLIMPEXP_FWD_CORE wxDropFilesEvent;
551 class WXDLLIMPEXP_FWD_CORE wxInitDialogEvent;
552 class WXDLLIMPEXP_FWD_CORE wxIdleEvent;
553 class WXDLLIMPEXP_FWD_CORE wxUpdateUIEvent;
554 class WXDLLIMPEXP_FWD_CORE wxClipboardTextEvent;
555 class WXDLLIMPEXP_FWD_CORE wxHelpEvent;
556
557
558 // Command events
559 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEvent)
560 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_CHECKBOX_CLICKED, wxCommandEvent)
561 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_CHOICE_SELECTED, wxCommandEvent)
562 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_LISTBOX_SELECTED, wxCommandEvent)
563 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, wxCommandEvent)
564 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, wxCommandEvent)
565 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_MENU_SELECTED, wxCommandEvent)
566 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_SLIDER_UPDATED, wxCommandEvent)
567 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_RADIOBOX_SELECTED, wxCommandEvent)
568 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_RADIOBUTTON_SELECTED, wxCommandEvent)
569
570 // wxEVT_COMMAND_SCROLLBAR_UPDATED is deprecated, use wxEVT_SCROLL... events
571 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_SCROLLBAR_UPDATED, wxCommandEvent)
572 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_VLBOX_SELECTED, wxCommandEvent)
573 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_COMBOBOX_SELECTED, wxCommandEvent)
574 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TOOL_RCLICKED, wxCommandEvent)
575 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, wxCommandEvent)
576 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TOOL_ENTER, wxCommandEvent)
577
578 // Thread events
579 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_THREAD, wxThreadEvent)
580
581 // Mouse event types
582 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_LEFT_DOWN, wxMouseEvent)
583 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_LEFT_UP, wxMouseEvent)
584 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MIDDLE_DOWN, wxMouseEvent)
585 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MIDDLE_UP, wxMouseEvent)
586 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_RIGHT_DOWN, wxMouseEvent)
587 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_RIGHT_UP, wxMouseEvent)
588 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOTION, wxMouseEvent)
589 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_ENTER_WINDOW, wxMouseEvent)
590 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_LEAVE_WINDOW, wxMouseEvent)
591 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_LEFT_DCLICK, wxMouseEvent)
592 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MIDDLE_DCLICK, wxMouseEvent)
593 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_RIGHT_DCLICK, wxMouseEvent)
594 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SET_FOCUS, wxFocusEvent)
595 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_KILL_FOCUS, wxFocusEvent)
596 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_CHILD_FOCUS, wxChildFocusEvent)
597 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOUSEWHEEL, wxMouseEvent)
598 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_AUX1_DOWN, wxMouseEvent)
599 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_AUX1_UP, wxMouseEvent)
600 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_AUX1_DCLICK, wxMouseEvent)
601 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_AUX2_DOWN, wxMouseEvent)
602 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_AUX2_UP, wxMouseEvent)
603 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_AUX2_DCLICK, wxMouseEvent)
604
605 // Character input event type
606 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_CHAR, wxKeyEvent)
607 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_CHAR_HOOK, wxKeyEvent)
608 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_NAVIGATION_KEY, wxNavigationKeyEvent)
609 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_KEY_DOWN, wxKeyEvent)
610 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_KEY_UP, wxKeyEvent)
611 #if wxUSE_HOTKEY
612 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_HOTKEY, wxKeyEvent)
613 #endif
614 // Set cursor event
615 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SET_CURSOR, wxSetCursorEvent)
616
617 // wxScrollBar and wxSlider event identifiers
618 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_TOP, wxScrollEvent)
619 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_BOTTOM, wxScrollEvent)
620 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_LINEUP, wxScrollEvent)
621 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_LINEDOWN, wxScrollEvent)
622 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_PAGEUP, wxScrollEvent)
623 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_PAGEDOWN, wxScrollEvent)
624 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_THUMBTRACK, wxScrollEvent)
625 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_THUMBRELEASE, wxScrollEvent)
626 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_CHANGED, wxScrollEvent)
627
628 // Due to a bug in older wx versions, wxSpinEvents were being sent with type of
629 // wxEVT_SCROLL_LINEUP, wxEVT_SCROLL_LINEDOWN and wxEVT_SCROLL_THUMBTRACK. But
630 // with the type-safe events in place, these event types are associated with
631 // wxScrollEvent. To allow handling of spin events, new event types have been
632 // defined in spinbutt.h/spinnbuttcmn.cpp. To maintain backward compatibility
633 // the spin event types are being initialized with the scroll event types.
634
635 #if wxUSE_SPINBTN
636
637 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE, wxEVT_SPIN_UP, wxSpinEvent )
638 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE, wxEVT_SPIN_DOWN, wxSpinEvent )
639 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE, wxEVT_SPIN, wxSpinEvent )
640
641 #endif
642
643 // Scroll events from wxWindow
644 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_TOP, wxScrollWinEvent)
645 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEvent)
646 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_LINEUP, wxScrollWinEvent)
647 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEvent)
648 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEvent)
649 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEvent)
650 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEvent)
651 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEvent)
652
653 // System events
654 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SIZE, wxSizeEvent)
655 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOVE, wxMoveEvent)
656 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_CLOSE_WINDOW, wxCloseEvent)
657 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_END_SESSION, wxCloseEvent)
658 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_QUERY_END_SESSION, wxCloseEvent)
659 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_ACTIVATE_APP, wxActivateEvent)
660 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_ACTIVATE, wxActivateEvent)
661 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_CREATE, wxWindowCreateEvent)
662 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_DESTROY, wxWindowDestroyEvent)
663 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SHOW, wxShowEvent)
664 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_ICONIZE, wxIconizeEvent)
665 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MAXIMIZE, wxMaximizeEvent)
666 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEvent)
667 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEvent)
668 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_PAINT, wxPaintEvent)
669 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_ERASE_BACKGROUND, wxEraseEvent)
670 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_NC_PAINT, wxNcPaintEvent)
671 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MENU_OPEN, wxMenuEvent)
672 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MENU_CLOSE, wxMenuEvent)
673 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MENU_HIGHLIGHT, wxMenuEvent)
674 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_CONTEXT_MENU, wxContextMenuEvent)
675 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEvent)
676 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_DISPLAY_CHANGED, wxDisplayChangedEvent)
677 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEvent)
678 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_PALETTE_CHANGED, wxPaletteChangedEvent)
679 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_JOY_BUTTON_DOWN, wxJoystickEvent)
680 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_JOY_BUTTON_UP, wxJoystickEvent)
681 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_JOY_MOVE, wxJoystickEvent)
682 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_JOY_ZMOVE, wxJoystickEvent)
683 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_DROP_FILES, wxDropFilesEvent)
684 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_INIT_DIALOG, wxInitDialogEvent)
685 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_BASE, wxEVT_IDLE, wxIdleEvent)
686 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_UPDATE_UI, wxUpdateUIEvent)
687 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SIZING, wxSizeEvent)
688 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOVING, wxMoveEvent)
689 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOVE_START, wxMoveEvent)
690 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOVE_END, wxMoveEvent)
691 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_HIBERNATE, wxActivateEvent)
692
693 // Clipboard events
694 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TEXT_COPY, wxClipboardTextEvent)
695 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TEXT_CUT, wxClipboardTextEvent)
696 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TEXT_PASTE, wxClipboardTextEvent)
697
698 // Generic command events
699 // Note: a click is a higher-level event than button down/up
700 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_LEFT_CLICK, wxCommandEvent)
701 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_LEFT_DCLICK, wxCommandEvent)
702 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_RIGHT_CLICK, wxCommandEvent)
703 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_RIGHT_DCLICK, wxCommandEvent)
704 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_SET_FOCUS, wxCommandEvent)
705 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_KILL_FOCUS, wxCommandEvent)
706 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_ENTER, wxCommandEvent)
707
708 // Help events
709 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_HELP, wxHelpEvent)
710 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_DETAILED_HELP, wxHelpEvent)
711
712 // these 2 events are the same
713 #define wxEVT_COMMAND_TOOL_CLICKED wxEVT_COMMAND_MENU_SELECTED
714
715 // ----------------------------------------------------------------------------
716 // Compatibility
717 // ----------------------------------------------------------------------------
718
719 // this event is also used by wxComboBox and wxSpinCtrl which don't include
720 // wx/textctrl.h in all ports [yet], so declare it here as well
721 //
722 // still, any new code using it should include wx/textctrl.h explicitly
723 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TEXT_UPDATED, wxCommandEvent)
724
725
726 // ----------------------------------------------------------------------------
727 // wxEvent(-derived) classes
728 // ----------------------------------------------------------------------------
729
730 // the predefined constants for the number of times we propagate event
731 // upwards window child-parent chain
732 enum wxEventPropagation
733 {
734 // don't propagate it at all
735 wxEVENT_PROPAGATE_NONE = 0,
736
737 // propagate it until it is processed
738 wxEVENT_PROPAGATE_MAX = INT_MAX
739 };
740
741 // The different categories for a wxEvent; see wxEvent::GetEventCategory.
742 // NOTE: they are used as OR-combinable flags by wxApp::Yield
743 enum wxEventCategory
744 {
745 // this is the category for those events which are generated to update
746 // the appearance of the GUI but which (usually) do not comport data
747 // processing, i.e. which do not provide input or output data
748 // (e.g. size events, scroll events, etc).
749 // They are events NOT directly generated by the user's input devices.
750 wxEVT_CATEGORY_UI = 1,
751
752 // this category groups those events which are generated directly from the
753 // user through input devices like mouse and keyboard and usually result in
754 // data to be processed from the application.
755 // (e.g. mouse clicks, key presses, etc)
756 wxEVT_CATEGORY_USER_INPUT = 2,
757
758 // this category is for wxSocketEvent
759 wxEVT_CATEGORY_SOCKET = 4,
760
761 // this category is for wxTimerEvent
762 wxEVT_CATEGORY_TIMER = 8,
763
764 // this category is for any event used to send notifications from the
765 // secondary threads to the main one or in general for notifications among
766 // different threads (which may or may not be user-generated)
767 wxEVT_CATEGORY_THREAD = 16,
768
769
770 // implementation only
771
772 // used in the implementations of DoYield()
773 wxEVT_CATEGORY_UNKNOWN = 32,
774
775 // a special category used as an argument to wxApp::Yield() to indicate that
776 // Yield() should leave all wxEvents on the queue while emptying the native event queue
777 // (native events will be processed but the wxEvents they generate will be queued)
778 wxEVT_CATEGORY_CLIPBOARD = 64,
779
780
781 // shortcut masks
782
783 // this category groups those events which are emitted in response to
784 // events of the native toolkit and which typically are not-"delayable".
785 wxEVT_CATEGORY_NATIVE_EVENTS = wxEVT_CATEGORY_UI|wxEVT_CATEGORY_USER_INPUT,
786
787 // used in wxApp::Yield to specify all event categories should be processed:
788 wxEVT_CATEGORY_ALL =
789 wxEVT_CATEGORY_UI|wxEVT_CATEGORY_USER_INPUT|wxEVT_CATEGORY_SOCKET| \
790 wxEVT_CATEGORY_TIMER|wxEVT_CATEGORY_THREAD
791 };
792
793 /*
794 * wxWidgets events, covering all interesting things that might happen
795 * (button clicking, resizing, setting text in widgets, etc.).
796 *
797 * For each completely new event type, derive a new event class.
798 * An event CLASS represents a C++ class defining a range of similar event TYPES;
799 * examples are canvas events, panel item command events.
800 * An event TYPE is a unique identifier for a particular system event,
801 * such as a button press or a listbox deselection.
802 *
803 */
804
805 class WXDLLIMPEXP_BASE wxEvent : public wxObject
806 {
807 public:
808 wxEvent(int winid = 0, wxEventType commandType = wxEVT_NULL );
809
810 void SetEventType(wxEventType typ) { m_eventType = typ; }
811 wxEventType GetEventType() const { return m_eventType; }
812
813 wxObject *GetEventObject() const { return m_eventObject; }
814 void SetEventObject(wxObject *obj) { m_eventObject = obj; }
815
816 long GetTimestamp() const { return m_timeStamp; }
817 void SetTimestamp(long ts = 0) { m_timeStamp = ts; }
818
819 int GetId() const { return m_id; }
820 void SetId(int Id) { m_id = Id; }
821
822 // Can instruct event processor that we wish to ignore this event
823 // (treat as if the event table entry had not been found): this must be done
824 // to allow the event processing by the base classes (calling event.Skip()
825 // is the analog of calling the base class version of a virtual function)
826 void Skip(bool skip = true) { m_skipped = skip; }
827 bool GetSkipped() const { return m_skipped; }
828
829 // This function is used to create a copy of the event polymorphically and
830 // all derived classes must implement it because otherwise wxPostEvent()
831 // for them wouldn't work (it needs to do a copy of the event)
832 virtual wxEvent *Clone() const = 0;
833
834 // this function is used to selectively process events in wxApp::YieldFor
835 // NOTE: by default it returns wxEVT_CATEGORY_UI just because the major
836 // part of wxWidgets events belong to that category.
837 virtual wxEventCategory GetEventCategory() const
838 { return wxEVT_CATEGORY_UI; }
839
840 // Implementation only: this test is explicitly anti OO and this function
841 // exists only for optimization purposes.
842 bool IsCommandEvent() const { return m_isCommandEvent; }
843
844 // Determine if this event should be propagating to the parent window.
845 bool ShouldPropagate() const
846 { return m_propagationLevel != wxEVENT_PROPAGATE_NONE; }
847
848 // Stop an event from propagating to its parent window, returns the old
849 // propagation level value
850 int StopPropagation()
851 {
852 int propagationLevel = m_propagationLevel;
853 m_propagationLevel = wxEVENT_PROPAGATE_NONE;
854 return propagationLevel;
855 }
856
857 // Resume the event propagation by restoring the propagation level
858 // (returned by StopPropagation())
859 void ResumePropagation(int propagationLevel)
860 {
861 m_propagationLevel = propagationLevel;
862 }
863
864
865 // This is for internal use only and is only called by
866 // wxEvtHandler::ProcessEvent() to check whether it's the first time this
867 // event is being processed
868 bool WasProcessed()
869 {
870 if ( m_wasProcessed )
871 return true;
872
873 m_wasProcessed = true;
874
875 return false;
876 }
877
878 protected:
879 wxObject* m_eventObject;
880 wxEventType m_eventType;
881 long m_timeStamp;
882 int m_id;
883
884 public:
885 // m_callbackUserData is for internal usage only
886 wxObject* m_callbackUserData;
887
888 protected:
889 // the propagation level: while it is positive, we propagate the event to
890 // the parent window (if any)
891 int m_propagationLevel;
892
893 bool m_skipped;
894 bool m_isCommandEvent;
895
896 // initially false but becomes true as soon as WasProcessed() is called for
897 // the first time, as this is done only by ProcessEvent() it explains the
898 // variable name: it becomes true after ProcessEvent() was called at least
899 // once for this event
900 bool m_wasProcessed;
901
902 protected:
903 wxEvent(const wxEvent&); // for implementing Clone()
904 wxEvent& operator=(const wxEvent&); // for derived classes operator=()
905
906 private:
907 // it needs to access our m_propagationLevel
908 friend class WXDLLIMPEXP_FWD_BASE wxPropagateOnce;
909
910 DECLARE_ABSTRACT_CLASS(wxEvent)
911 };
912
913 /*
914 * Helper class to temporarily change an event not to propagate.
915 */
916 class WXDLLIMPEXP_BASE wxPropagationDisabler
917 {
918 public:
919 wxPropagationDisabler(wxEvent& event) : m_event(event)
920 {
921 m_propagationLevelOld = m_event.StopPropagation();
922 }
923
924 ~wxPropagationDisabler()
925 {
926 m_event.ResumePropagation(m_propagationLevelOld);
927 }
928
929 private:
930 wxEvent& m_event;
931 int m_propagationLevelOld;
932
933 DECLARE_NO_COPY_CLASS(wxPropagationDisabler)
934 };
935
936 /*
937 * Another one to temporarily lower propagation level.
938 */
939 class WXDLLIMPEXP_BASE wxPropagateOnce
940 {
941 public:
942 wxPropagateOnce(wxEvent& event) : m_event(event)
943 {
944 wxASSERT_MSG( m_event.m_propagationLevel > 0,
945 _T("shouldn't be used unless ShouldPropagate()!") );
946
947 m_event.m_propagationLevel--;
948 }
949
950 ~wxPropagateOnce()
951 {
952 m_event.m_propagationLevel++;
953 }
954
955 private:
956 wxEvent& m_event;
957
958 DECLARE_NO_COPY_CLASS(wxPropagateOnce)
959 };
960
961
962 #if wxUSE_GUI
963
964
965 // Item or menu event class
966 /*
967 wxEVT_COMMAND_BUTTON_CLICKED
968 wxEVT_COMMAND_CHECKBOX_CLICKED
969 wxEVT_COMMAND_CHOICE_SELECTED
970 wxEVT_COMMAND_LISTBOX_SELECTED
971 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
972 wxEVT_COMMAND_TEXT_UPDATED
973 wxEVT_COMMAND_TEXT_ENTER
974 wxEVT_COMMAND_MENU_SELECTED
975 wxEVT_COMMAND_SLIDER_UPDATED
976 wxEVT_COMMAND_RADIOBOX_SELECTED
977 wxEVT_COMMAND_RADIOBUTTON_SELECTED
978 wxEVT_COMMAND_SCROLLBAR_UPDATED
979 wxEVT_COMMAND_VLBOX_SELECTED
980 wxEVT_COMMAND_COMBOBOX_SELECTED
981 wxEVT_COMMAND_TOGGLEBUTTON_CLICKED
982 */
983
984 class WXDLLIMPEXP_CORE wxCommandEvent : public wxEvent
985 {
986 public:
987 wxCommandEvent(wxEventType commandType = wxEVT_NULL, int winid = 0);
988
989 wxCommandEvent(const wxCommandEvent& event)
990 : wxEvent(event),
991 m_cmdString(event.m_cmdString),
992 m_commandInt(event.m_commandInt),
993 m_extraLong(event.m_extraLong),
994 m_clientData(event.m_clientData),
995 m_clientObject(event.m_clientObject)
996 { }
997
998 // Set/Get client data from controls
999 void SetClientData(void* clientData) { m_clientData = clientData; }
1000 void *GetClientData() const { return m_clientData; }
1001
1002 // Set/Get client object from controls
1003 void SetClientObject(wxClientData* clientObject) { m_clientObject = clientObject; }
1004 wxClientData *GetClientObject() const { return m_clientObject; }
1005
1006 // Get listbox selection if single-choice
1007 int GetSelection() const { return m_commandInt; }
1008
1009 // Set/Get listbox/choice selection string
1010 void SetString(const wxString& s) { m_cmdString = s; }
1011 wxString GetString() const;
1012
1013 // Get checkbox value
1014 bool IsChecked() const { return m_commandInt != 0; }
1015
1016 // true if the listbox event was a selection.
1017 bool IsSelection() const { return (m_extraLong != 0); }
1018
1019 void SetExtraLong(long extraLong) { m_extraLong = extraLong; }
1020 long GetExtraLong() const { return m_extraLong; }
1021
1022 void SetInt(int i) { m_commandInt = i; }
1023 int GetInt() const { return m_commandInt; }
1024
1025 virtual wxEvent *Clone() const { return new wxCommandEvent(*this); }
1026 virtual wxEventCategory GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT; }
1027
1028 protected:
1029 wxString m_cmdString; // String event argument
1030 int m_commandInt;
1031 long m_extraLong; // Additional information (e.g. select/deselect)
1032 void* m_clientData; // Arbitrary client data
1033 wxClientData* m_clientObject; // Arbitrary client object
1034
1035 private:
1036 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCommandEvent)
1037 };
1038
1039 // this class adds a possibility to react (from the user) code to a control
1040 // notification: allow or veto the operation being reported.
1041 class WXDLLIMPEXP_CORE wxNotifyEvent : public wxCommandEvent
1042 {
1043 public:
1044 wxNotifyEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
1045 : wxCommandEvent(commandType, winid)
1046 { m_bAllow = true; }
1047
1048 wxNotifyEvent(const wxNotifyEvent& event)
1049 : wxCommandEvent(event)
1050 { m_bAllow = event.m_bAllow; }
1051
1052 // veto the operation (usually it's allowed by default)
1053 void Veto() { m_bAllow = false; }
1054
1055 // allow the operation if it was disabled by default
1056 void Allow() { m_bAllow = true; }
1057
1058 // for implementation code only: is the operation allowed?
1059 bool IsAllowed() const { return m_bAllow; }
1060
1061 virtual wxEvent *Clone() const { return new wxNotifyEvent(*this); }
1062
1063 private:
1064 bool m_bAllow;
1065
1066 private:
1067 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNotifyEvent)
1068 };
1069
1070
1071 // Thread event
1072
1073 class WXDLLIMPEXP_BASE wxThreadEvent : public wxCommandEvent
1074 {
1075 public:
1076 wxThreadEvent(int id = wxID_ANY)
1077 : wxCommandEvent(wxEVT_COMMAND_THREAD, id)
1078 { }
1079
1080 virtual wxEvent *Clone() const
1081 {
1082 // make sure our string member (which uses COW aka refcounting) is not
1083 // shared by other string instances:
1084 const_cast<wxThreadEvent*>(this)->SetString(GetString().c_str());
1085
1086 return new wxThreadEvent(*this);
1087 }
1088
1089 // this is important to avoid that calling wxApp::Yield() thread events
1090 // gets processed when this is unwanted:
1091 virtual wxEventCategory GetEventCategory() const
1092 { return wxEVT_CATEGORY_THREAD; }
1093
1094 private:
1095 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxThreadEvent)
1096 };
1097
1098
1099
1100 // Scroll event class, derived form wxCommandEvent. wxScrollEvents are
1101 // sent by wxSlider and wxScrollBar.
1102 /*
1103 wxEVT_SCROLL_TOP
1104 wxEVT_SCROLL_BOTTOM
1105 wxEVT_SCROLL_LINEUP
1106 wxEVT_SCROLL_LINEDOWN
1107 wxEVT_SCROLL_PAGEUP
1108 wxEVT_SCROLL_PAGEDOWN
1109 wxEVT_SCROLL_THUMBTRACK
1110 wxEVT_SCROLL_THUMBRELEASE
1111 wxEVT_SCROLL_CHANGED
1112 */
1113
1114 class WXDLLIMPEXP_CORE wxScrollEvent : public wxCommandEvent
1115 {
1116 public:
1117 wxScrollEvent(wxEventType commandType = wxEVT_NULL,
1118 int winid = 0, int pos = 0, int orient = 0);
1119
1120 int GetOrientation() const { return (int) m_extraLong; }
1121 int GetPosition() const { return m_commandInt; }
1122 void SetOrientation(int orient) { m_extraLong = (long) orient; }
1123 void SetPosition(int pos) { m_commandInt = pos; }
1124
1125 virtual wxEvent *Clone() const { return new wxScrollEvent(*this); }
1126
1127 private:
1128 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollEvent)
1129 };
1130
1131 // ScrollWin event class, derived fom wxEvent. wxScrollWinEvents
1132 // are sent by wxWindow.
1133 /*
1134 wxEVT_SCROLLWIN_TOP
1135 wxEVT_SCROLLWIN_BOTTOM
1136 wxEVT_SCROLLWIN_LINEUP
1137 wxEVT_SCROLLWIN_LINEDOWN
1138 wxEVT_SCROLLWIN_PAGEUP
1139 wxEVT_SCROLLWIN_PAGEDOWN
1140 wxEVT_SCROLLWIN_THUMBTRACK
1141 wxEVT_SCROLLWIN_THUMBRELEASE
1142 */
1143
1144 class WXDLLIMPEXP_CORE wxScrollWinEvent : public wxEvent
1145 {
1146 public:
1147 wxScrollWinEvent(wxEventType commandType = wxEVT_NULL,
1148 int pos = 0, int orient = 0);
1149 wxScrollWinEvent(const wxScrollWinEvent& event) : wxEvent(event)
1150 { m_commandInt = event.m_commandInt;
1151 m_extraLong = event.m_extraLong; }
1152
1153 int GetOrientation() const { return (int) m_extraLong; }
1154 int GetPosition() const { return m_commandInt; }
1155 void SetOrientation(int orient) { m_extraLong = (long) orient; }
1156 void SetPosition(int pos) { m_commandInt = pos; }
1157
1158 virtual wxEvent *Clone() const { return new wxScrollWinEvent(*this); }
1159
1160 protected:
1161 int m_commandInt;
1162 long m_extraLong;
1163
1164 private:
1165 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollWinEvent)
1166 };
1167
1168
1169
1170 // Mouse event class
1171
1172 /*
1173 wxEVT_LEFT_DOWN
1174 wxEVT_LEFT_UP
1175 wxEVT_MIDDLE_DOWN
1176 wxEVT_MIDDLE_UP
1177 wxEVT_RIGHT_DOWN
1178 wxEVT_RIGHT_UP
1179 wxEVT_MOTION
1180 wxEVT_ENTER_WINDOW
1181 wxEVT_LEAVE_WINDOW
1182 wxEVT_LEFT_DCLICK
1183 wxEVT_MIDDLE_DCLICK
1184 wxEVT_RIGHT_DCLICK
1185 wxEVT_NC_LEFT_DOWN
1186 wxEVT_NC_LEFT_UP,
1187 wxEVT_NC_MIDDLE_DOWN,
1188 wxEVT_NC_MIDDLE_UP,
1189 wxEVT_NC_RIGHT_DOWN,
1190 wxEVT_NC_RIGHT_UP,
1191 wxEVT_NC_MOTION,
1192 wxEVT_NC_ENTER_WINDOW,
1193 wxEVT_NC_LEAVE_WINDOW,
1194 wxEVT_NC_LEFT_DCLICK,
1195 wxEVT_NC_MIDDLE_DCLICK,
1196 wxEVT_NC_RIGHT_DCLICK,
1197 */
1198
1199 // the symbolic names for the mouse buttons
1200 enum
1201 {
1202 wxMOUSE_BTN_ANY = -1,
1203 wxMOUSE_BTN_NONE = 0,
1204 wxMOUSE_BTN_LEFT = 1,
1205 wxMOUSE_BTN_MIDDLE = 2,
1206 wxMOUSE_BTN_RIGHT = 3,
1207 wxMOUSE_BTN_AUX1 = 4,
1208 wxMOUSE_BTN_AUX2 = 5,
1209 wxMOUSE_BTN_MAX
1210 };
1211
1212 class WXDLLIMPEXP_CORE wxMouseEvent : public wxEvent,
1213 public wxMouseState
1214 {
1215 public:
1216 wxMouseEvent(wxEventType mouseType = wxEVT_NULL);
1217 wxMouseEvent(const wxMouseEvent& event)
1218 : wxEvent(event),
1219 wxMouseState(event)
1220 {
1221 Assign(event);
1222 }
1223
1224 // Was it a button event? (*doesn't* mean: is any button *down*?)
1225 bool IsButton() const { return Button(wxMOUSE_BTN_ANY); }
1226
1227 // Was it a down event from this (or any) button?
1228 bool ButtonDown(int but = wxMOUSE_BTN_ANY) const;
1229
1230 // Was it a dclick event from this (or any) button?
1231 bool ButtonDClick(int but = wxMOUSE_BTN_ANY) const;
1232
1233 // Was it a up event from this (or any) button?
1234 bool ButtonUp(int but = wxMOUSE_BTN_ANY) const;
1235
1236 // Was the given button?
1237 bool Button(int but) const;
1238
1239 // Was the given button in Down state?
1240 bool ButtonIsDown(int but) const;
1241
1242 // Get the button which is changing state (wxMOUSE_BTN_NONE if none)
1243 int GetButton() const;
1244
1245 // Find which event was just generated
1246 bool LeftDown() const { return (m_eventType == wxEVT_LEFT_DOWN); }
1247 bool MiddleDown() const { return (m_eventType == wxEVT_MIDDLE_DOWN); }
1248 bool RightDown() const { return (m_eventType == wxEVT_RIGHT_DOWN); }
1249 bool Aux1Down() const { return (m_eventType == wxEVT_AUX1_DOWN); }
1250 bool Aux2Down() const { return (m_eventType == wxEVT_AUX2_DOWN); }
1251
1252 bool LeftUp() const { return (m_eventType == wxEVT_LEFT_UP); }
1253 bool MiddleUp() const { return (m_eventType == wxEVT_MIDDLE_UP); }
1254 bool RightUp() const { return (m_eventType == wxEVT_RIGHT_UP); }
1255 bool Aux1Up() const { return (m_eventType == wxEVT_AUX1_UP); }
1256 bool Aux2Up() const { return (m_eventType == wxEVT_AUX2_UP); }
1257
1258 bool LeftDClick() const { return (m_eventType == wxEVT_LEFT_DCLICK); }
1259 bool MiddleDClick() const { return (m_eventType == wxEVT_MIDDLE_DCLICK); }
1260 bool RightDClick() const { return (m_eventType == wxEVT_RIGHT_DCLICK); }
1261 bool Aux1DClick() const { return (m_eventType == wxEVT_AUX1_UP); }
1262 bool Aux2DClick() const { return (m_eventType == wxEVT_AUX2_UP); }
1263
1264 // Find the current state of the mouse buttons (regardless
1265 // of current event type)
1266 bool LeftIsDown() const { return m_leftDown; }
1267 bool MiddleIsDown() const { return m_middleDown; }
1268 bool RightIsDown() const { return m_rightDown; }
1269 bool Aux1IsDown() const { return m_aux1Down; }
1270 bool Aux2IsDown() const { return m_aux2Down; }
1271
1272 // True if a button is down and the mouse is moving
1273 bool Dragging() const
1274 {
1275 return (m_eventType == wxEVT_MOTION) && ButtonIsDown(wxMOUSE_BTN_ANY);
1276 }
1277
1278 // True if the mouse is moving, and no button is down
1279 bool Moving() const
1280 {
1281 return (m_eventType == wxEVT_MOTION) && !ButtonIsDown(wxMOUSE_BTN_ANY);
1282 }
1283
1284 // True if the mouse is just entering the window
1285 bool Entering() const { return (m_eventType == wxEVT_ENTER_WINDOW); }
1286
1287 // True if the mouse is just leaving the window
1288 bool Leaving() const { return (m_eventType == wxEVT_LEAVE_WINDOW); }
1289
1290 // Returns the number of mouse clicks associated with this event.
1291 int GetClickCount() const { return m_clickCount; }
1292
1293
1294 // Find the position of the event
1295 void GetPosition(wxCoord *xpos, wxCoord *ypos) const
1296 {
1297 if (xpos)
1298 *xpos = m_x;
1299 if (ypos)
1300 *ypos = m_y;
1301 }
1302
1303 void GetPosition(long *xpos, long *ypos) const
1304 {
1305 if (xpos)
1306 *xpos = (long)m_x;
1307 if (ypos)
1308 *ypos = (long)m_y;
1309 }
1310
1311 // Find the position of the event
1312 wxPoint GetPosition() const { return wxPoint(m_x, m_y); }
1313
1314 // Find the logical position of the event given the DC
1315 wxPoint GetLogicalPosition(const wxDC& dc) const;
1316
1317 // Get X position
1318 wxCoord GetX() const { return m_x; }
1319
1320 // Get Y position
1321 wxCoord GetY() const { return m_y; }
1322
1323 // Get wheel rotation, positive or negative indicates direction of
1324 // rotation. Current devices all send an event when rotation is equal to
1325 // +/-WheelDelta, but this allows for finer resolution devices to be
1326 // created in the future. Because of this you shouldn't assume that one
1327 // event is equal to 1 line or whatever, but you should be able to either
1328 // do partial line scrolling or wait until +/-WheelDelta rotation values
1329 // have been accumulated before scrolling.
1330 int GetWheelRotation() const { return m_wheelRotation; }
1331
1332 // Get wheel delta, normally 120. This is the threshold for action to be
1333 // taken, and one such action (for example, scrolling one increment)
1334 // should occur for each delta.
1335 int GetWheelDelta() const { return m_wheelDelta; }
1336
1337 // Gets the axis the wheel operation concerns, 0 being the y axis as on
1338 // most mouse wheels, 1 is the x axis for things like MightyMouse scrolls
1339 // or horizontal trackpad scrolling
1340 int GetWheelAxis() const { return m_wheelAxis; }
1341
1342 // Returns the configured number of lines (or whatever) to be scrolled per
1343 // wheel action. Defaults to one.
1344 int GetLinesPerAction() const { return m_linesPerAction; }
1345
1346 // Is the system set to do page scrolling?
1347 bool IsPageScroll() const { return ((unsigned int)m_linesPerAction == UINT_MAX); }
1348
1349 virtual wxEvent *Clone() const { return new wxMouseEvent(*this); }
1350 virtual wxEventCategory GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT; }
1351
1352 wxMouseEvent& operator=(const wxMouseEvent& event)
1353 {
1354 if (&event != this)
1355 Assign(event);
1356 return *this;
1357 }
1358
1359 public:
1360 wxCoord m_x, m_y;
1361
1362 bool m_leftDown;
1363 bool m_middleDown;
1364 bool m_rightDown;
1365 bool m_aux1Down;
1366 bool m_aux2Down;
1367
1368 int m_clickCount;
1369
1370 int m_wheelAxis;
1371 int m_wheelRotation;
1372 int m_wheelDelta;
1373 int m_linesPerAction;
1374
1375 protected:
1376 void Assign(const wxMouseEvent& evt);
1377
1378 private:
1379 DECLARE_DYNAMIC_CLASS(wxMouseEvent)
1380 };
1381
1382 // Cursor set event
1383
1384 /*
1385 wxEVT_SET_CURSOR
1386 */
1387
1388 class WXDLLIMPEXP_CORE wxSetCursorEvent : public wxEvent
1389 {
1390 public:
1391 wxSetCursorEvent(wxCoord x = 0, wxCoord y = 0)
1392 : wxEvent(0, wxEVT_SET_CURSOR),
1393 m_x(x), m_y(y), m_cursor()
1394 { }
1395
1396 wxSetCursorEvent(const wxSetCursorEvent& event)
1397 : wxEvent(event),
1398 m_x(event.m_x),
1399 m_y(event.m_y),
1400 m_cursor(event.m_cursor)
1401 { }
1402
1403 wxCoord GetX() const { return m_x; }
1404 wxCoord GetY() const { return m_y; }
1405
1406 void SetCursor(const wxCursor& cursor) { m_cursor = cursor; }
1407 const wxCursor& GetCursor() const { return m_cursor; }
1408 bool HasCursor() const { return m_cursor.Ok(); }
1409
1410 virtual wxEvent *Clone() const { return new wxSetCursorEvent(*this); }
1411
1412 private:
1413 wxCoord m_x, m_y;
1414 wxCursor m_cursor;
1415
1416 private:
1417 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSetCursorEvent)
1418 };
1419
1420 // Keyboard input event class
1421
1422 /*
1423 wxEVT_CHAR
1424 wxEVT_CHAR_HOOK
1425 wxEVT_KEY_DOWN
1426 wxEVT_KEY_UP
1427 wxEVT_HOTKEY
1428 */
1429
1430 class WXDLLIMPEXP_CORE wxKeyEvent : public wxEvent,
1431 public wxKeyboardState
1432 {
1433 public:
1434 wxKeyEvent(wxEventType keyType = wxEVT_NULL);
1435 wxKeyEvent(const wxKeyEvent& evt);
1436
1437 // get the key code: an ASCII7 char or an element of wxKeyCode enum
1438 int GetKeyCode() const { return (int)m_keyCode; }
1439
1440 #if wxUSE_UNICODE
1441 // get the Unicode character corresponding to this key
1442 wxChar GetUnicodeKey() const { return m_uniChar; }
1443 #endif // wxUSE_UNICODE
1444
1445 // get the raw key code (platform-dependent)
1446 wxUint32 GetRawKeyCode() const { return m_rawCode; }
1447
1448 // get the raw key flags (platform-dependent)
1449 wxUint32 GetRawKeyFlags() const { return m_rawFlags; }
1450
1451 // Find the position of the event
1452 void GetPosition(wxCoord *xpos, wxCoord *ypos) const
1453 {
1454 if (xpos) *xpos = m_x;
1455 if (ypos) *ypos = m_y;
1456 }
1457
1458 void GetPosition(long *xpos, long *ypos) const
1459 {
1460 if (xpos) *xpos = (long)m_x;
1461 if (ypos) *ypos = (long)m_y;
1462 }
1463
1464 wxPoint GetPosition() const
1465 { return wxPoint(m_x, m_y); }
1466
1467 // Get X position
1468 wxCoord GetX() const { return m_x; }
1469
1470 // Get Y position
1471 wxCoord GetY() const { return m_y; }
1472
1473 virtual wxEvent *Clone() const { return new wxKeyEvent(*this); }
1474 virtual wxEventCategory GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT; }
1475
1476 // we do need to copy wxKeyEvent sometimes (in wxTreeCtrl code, for
1477 // example)
1478 wxKeyEvent& operator=(const wxKeyEvent& evt)
1479 {
1480 if ( &evt != this )
1481 {
1482 wxEvent::operator=(evt);
1483
1484 // Borland C++ 5.82 doesn't compile an explicit call to an
1485 // implicitly defined operator=() so need to do it this way:
1486 *static_cast<wxKeyboardState *>(this) = evt;
1487
1488 m_x = evt.m_x;
1489 m_y = evt.m_y;
1490
1491 m_keyCode = evt.m_keyCode;
1492
1493 m_scanCode = evt.m_scanCode;
1494 m_rawCode = evt.m_rawCode;
1495 m_rawFlags = evt.m_rawFlags;
1496 #if wxUSE_UNICODE
1497 m_uniChar = evt.m_uniChar;
1498 #endif
1499 }
1500 return *this;
1501 }
1502
1503 public:
1504 wxCoord m_x, m_y;
1505
1506 long m_keyCode;
1507
1508 // FIXME: what is this for? relation to m_rawXXX?
1509 bool m_scanCode;
1510
1511 #if wxUSE_UNICODE
1512 // This contains the full Unicode character
1513 // in a character events in Unicode mode
1514 wxChar m_uniChar;
1515 #endif
1516
1517 // these fields contain the platform-specific information about
1518 // key that was pressed
1519 wxUint32 m_rawCode;
1520 wxUint32 m_rawFlags;
1521
1522 private:
1523 DECLARE_DYNAMIC_CLASS(wxKeyEvent)
1524 };
1525
1526 // Size event class
1527 /*
1528 wxEVT_SIZE
1529 */
1530
1531 class WXDLLIMPEXP_CORE wxSizeEvent : public wxEvent
1532 {
1533 public:
1534 wxSizeEvent() : wxEvent(0, wxEVT_SIZE)
1535 { }
1536 wxSizeEvent(const wxSize& sz, int winid = 0)
1537 : wxEvent(winid, wxEVT_SIZE),
1538 m_size(sz)
1539 { }
1540 wxSizeEvent(const wxSizeEvent& event)
1541 : wxEvent(event),
1542 m_size(event.m_size), m_rect(event.m_rect)
1543 { }
1544 wxSizeEvent(const wxRect& rect, int id = 0)
1545 : m_size(rect.GetSize()), m_rect(rect)
1546 { m_eventType = wxEVT_SIZING; m_id = id; }
1547
1548 wxSize GetSize() const { return m_size; }
1549 wxRect GetRect() const { return m_rect; }
1550 void SetRect(const wxRect& rect) { m_rect = rect; }
1551
1552 virtual wxEvent *Clone() const { return new wxSizeEvent(*this); }
1553
1554 public:
1555 // For internal usage only. Will be converted to protected members.
1556 wxSize m_size;
1557 wxRect m_rect; // Used for wxEVT_SIZING
1558
1559 private:
1560 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSizeEvent)
1561 };
1562
1563 // Move event class
1564
1565 /*
1566 wxEVT_MOVE
1567 */
1568
1569 class WXDLLIMPEXP_CORE wxMoveEvent : public wxEvent
1570 {
1571 public:
1572 wxMoveEvent()
1573 : wxEvent(0, wxEVT_MOVE)
1574 { }
1575 wxMoveEvent(const wxPoint& pos, int winid = 0)
1576 : wxEvent(winid, wxEVT_MOVE),
1577 m_pos(pos)
1578 { }
1579 wxMoveEvent(const wxMoveEvent& event)
1580 : wxEvent(event),
1581 m_pos(event.m_pos)
1582 { }
1583 wxMoveEvent(const wxRect& rect, int id = 0)
1584 : m_pos(rect.GetPosition()), m_rect(rect)
1585 { m_eventType = wxEVT_MOVING; m_id = id; }
1586
1587 wxPoint GetPosition() const { return m_pos; }
1588 void SetPosition(const wxPoint& pos) { m_pos = pos; }
1589 wxRect GetRect() const { return m_rect; }
1590 void SetRect(const wxRect& rect) { m_rect = rect; }
1591
1592 virtual wxEvent *Clone() const { return new wxMoveEvent(*this); }
1593
1594 protected:
1595 wxPoint m_pos;
1596 wxRect m_rect;
1597
1598 private:
1599 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMoveEvent)
1600 };
1601
1602 // Paint event class
1603 /*
1604 wxEVT_PAINT
1605 wxEVT_NC_PAINT
1606 wxEVT_PAINT_ICON
1607 */
1608
1609 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1610 // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined
1611 extern WXDLLIMPEXP_CORE int g_isPainting;
1612 #endif // debug
1613
1614 class WXDLLIMPEXP_CORE wxPaintEvent : public wxEvent
1615 {
1616 public:
1617 wxPaintEvent(int Id = 0)
1618 : wxEvent(Id, wxEVT_PAINT)
1619 {
1620 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1621 // set the internal flag for the duration of processing of WM_PAINT
1622 g_isPainting++;
1623 #endif // debug
1624 }
1625
1626 // default copy ctor and dtor are normally fine, we only need them to keep
1627 // g_isPainting updated in debug build
1628 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1629 wxPaintEvent(const wxPaintEvent& event)
1630 : wxEvent(event)
1631 {
1632 g_isPainting++;
1633 }
1634
1635 virtual ~wxPaintEvent()
1636 {
1637 g_isPainting--;
1638 }
1639 #endif // debug
1640
1641 virtual wxEvent *Clone() const { return new wxPaintEvent(*this); }
1642
1643 private:
1644 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaintEvent)
1645 };
1646
1647 class WXDLLIMPEXP_CORE wxNcPaintEvent : public wxEvent
1648 {
1649 public:
1650 wxNcPaintEvent(int winid = 0)
1651 : wxEvent(winid, wxEVT_NC_PAINT)
1652 { }
1653
1654 virtual wxEvent *Clone() const { return new wxNcPaintEvent(*this); }
1655
1656 private:
1657 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNcPaintEvent)
1658 };
1659
1660 // Erase background event class
1661 /*
1662 wxEVT_ERASE_BACKGROUND
1663 */
1664
1665 class WXDLLIMPEXP_CORE wxEraseEvent : public wxEvent
1666 {
1667 public:
1668 wxEraseEvent(int Id = 0, wxDC *dc = NULL)
1669 : wxEvent(Id, wxEVT_ERASE_BACKGROUND),
1670 m_dc(dc)
1671 { }
1672
1673 wxEraseEvent(const wxEraseEvent& event)
1674 : wxEvent(event),
1675 m_dc(event.m_dc)
1676 { }
1677
1678 wxDC *GetDC() const { return m_dc; }
1679
1680 virtual wxEvent *Clone() const { return new wxEraseEvent(*this); }
1681
1682 protected:
1683 wxDC *m_dc;
1684
1685 private:
1686 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxEraseEvent)
1687 };
1688
1689 // Focus event class
1690 /*
1691 wxEVT_SET_FOCUS
1692 wxEVT_KILL_FOCUS
1693 */
1694
1695 class WXDLLIMPEXP_CORE wxFocusEvent : public wxEvent
1696 {
1697 public:
1698 wxFocusEvent(wxEventType type = wxEVT_NULL, int winid = 0)
1699 : wxEvent(winid, type)
1700 { m_win = NULL; }
1701
1702 wxFocusEvent(const wxFocusEvent& event)
1703 : wxEvent(event)
1704 { m_win = event.m_win; }
1705
1706 // The window associated with this event is the window which had focus
1707 // before for SET event and the window which will have focus for the KILL
1708 // one. NB: it may be NULL in both cases!
1709 wxWindow *GetWindow() const { return m_win; }
1710 void SetWindow(wxWindow *win) { m_win = win; }
1711
1712 virtual wxEvent *Clone() const { return new wxFocusEvent(*this); }
1713
1714 private:
1715 wxWindow *m_win;
1716
1717 private:
1718 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFocusEvent)
1719 };
1720
1721 // wxChildFocusEvent notifies the parent that a child has got the focus: unlike
1722 // wxFocusEvent it is propagated upwards the window chain
1723 class WXDLLIMPEXP_CORE wxChildFocusEvent : public wxCommandEvent
1724 {
1725 public:
1726 wxChildFocusEvent(wxWindow *win = NULL);
1727
1728 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1729
1730 virtual wxEvent *Clone() const { return new wxChildFocusEvent(*this); }
1731
1732 private:
1733 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxChildFocusEvent)
1734 };
1735
1736 // Activate event class
1737 /*
1738 wxEVT_ACTIVATE
1739 wxEVT_ACTIVATE_APP
1740 wxEVT_HIBERNATE
1741 */
1742
1743 class WXDLLIMPEXP_CORE wxActivateEvent : public wxEvent
1744 {
1745 public:
1746 wxActivateEvent(wxEventType type = wxEVT_NULL, bool active = true, int Id = 0)
1747 : wxEvent(Id, type)
1748 { m_active = active; }
1749 wxActivateEvent(const wxActivateEvent& event)
1750 : wxEvent(event)
1751 { m_active = event.m_active; }
1752
1753 bool GetActive() const { return m_active; }
1754
1755 virtual wxEvent *Clone() const { return new wxActivateEvent(*this); }
1756
1757 private:
1758 bool m_active;
1759
1760 private:
1761 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxActivateEvent)
1762 };
1763
1764 // InitDialog event class
1765 /*
1766 wxEVT_INIT_DIALOG
1767 */
1768
1769 class WXDLLIMPEXP_CORE wxInitDialogEvent : public wxEvent
1770 {
1771 public:
1772 wxInitDialogEvent(int Id = 0)
1773 : wxEvent(Id, wxEVT_INIT_DIALOG)
1774 { }
1775
1776 virtual wxEvent *Clone() const { return new wxInitDialogEvent(*this); }
1777
1778 private:
1779 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxInitDialogEvent)
1780 };
1781
1782 // Miscellaneous menu event class
1783 /*
1784 wxEVT_MENU_OPEN,
1785 wxEVT_MENU_CLOSE,
1786 wxEVT_MENU_HIGHLIGHT,
1787 */
1788
1789 class WXDLLIMPEXP_CORE wxMenuEvent : public wxEvent
1790 {
1791 public:
1792 wxMenuEvent(wxEventType type = wxEVT_NULL, int winid = 0, wxMenu* menu = NULL)
1793 : wxEvent(winid, type)
1794 { m_menuId = winid; m_menu = menu; }
1795 wxMenuEvent(const wxMenuEvent& event)
1796 : wxEvent(event)
1797 { m_menuId = event.m_menuId; m_menu = event.m_menu; }
1798
1799 // only for wxEVT_MENU_HIGHLIGHT
1800 int GetMenuId() const { return m_menuId; }
1801
1802 // only for wxEVT_MENU_OPEN/CLOSE
1803 bool IsPopup() const { return m_menuId == wxID_ANY; }
1804
1805 // only for wxEVT_MENU_OPEN/CLOSE
1806 wxMenu* GetMenu() const { return m_menu; }
1807
1808 virtual wxEvent *Clone() const { return new wxMenuEvent(*this); }
1809
1810 private:
1811 int m_menuId;
1812 wxMenu* m_menu;
1813
1814 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMenuEvent)
1815 };
1816
1817 // Window close or session close event class
1818 /*
1819 wxEVT_CLOSE_WINDOW,
1820 wxEVT_END_SESSION,
1821 wxEVT_QUERY_END_SESSION
1822 */
1823
1824 class WXDLLIMPEXP_CORE wxCloseEvent : public wxEvent
1825 {
1826 public:
1827 wxCloseEvent(wxEventType type = wxEVT_NULL, int winid = 0)
1828 : wxEvent(winid, type),
1829 m_loggingOff(true),
1830 m_veto(false), // should be false by default
1831 m_canVeto(true) {}
1832
1833 wxCloseEvent(const wxCloseEvent& event)
1834 : wxEvent(event),
1835 m_loggingOff(event.m_loggingOff),
1836 m_veto(event.m_veto),
1837 m_canVeto(event.m_canVeto) {}
1838
1839 void SetLoggingOff(bool logOff) { m_loggingOff = logOff; }
1840 bool GetLoggingOff() const
1841 {
1842 // m_loggingOff flag is only used by wxEVT_[QUERY_]END_SESSION, it
1843 // doesn't make sense for wxEVT_CLOSE_WINDOW
1844 wxASSERT_MSG( m_eventType != wxEVT_CLOSE_WINDOW,
1845 _T("this flag is for end session events only") );
1846
1847 return m_loggingOff;
1848 }
1849
1850 void Veto(bool veto = true)
1851 {
1852 // GetVeto() will return false anyhow...
1853 wxCHECK_RET( m_canVeto,
1854 wxT("call to Veto() ignored (can't veto this event)") );
1855
1856 m_veto = veto;
1857 }
1858 void SetCanVeto(bool canVeto) { m_canVeto = canVeto; }
1859 bool CanVeto() const { return m_canVeto; }
1860 bool GetVeto() const { return m_canVeto && m_veto; }
1861
1862 virtual wxEvent *Clone() const { return new wxCloseEvent(*this); }
1863
1864 protected:
1865 bool m_loggingOff,
1866 m_veto,
1867 m_canVeto;
1868
1869 private:
1870 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCloseEvent)
1871 };
1872
1873 /*
1874 wxEVT_SHOW
1875 */
1876
1877 class WXDLLIMPEXP_CORE wxShowEvent : public wxEvent
1878 {
1879 public:
1880 wxShowEvent(int winid = 0, bool show = false)
1881 : wxEvent(winid, wxEVT_SHOW)
1882 { m_show = show; }
1883 wxShowEvent(const wxShowEvent& event)
1884 : wxEvent(event)
1885 { m_show = event.m_show; }
1886
1887 void SetShow(bool show) { m_show = show; }
1888
1889 // return true if the window was shown, false if hidden
1890 bool IsShown() const { return m_show; }
1891
1892 #if WXWIN_COMPATIBILITY_2_8
1893 wxDEPRECATED( bool GetShow() const { return IsShown(); } )
1894 #endif
1895
1896 virtual wxEvent *Clone() const { return new wxShowEvent(*this); }
1897
1898 protected:
1899 bool m_show;
1900
1901 private:
1902 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxShowEvent)
1903 };
1904
1905 /*
1906 wxEVT_ICONIZE
1907 */
1908
1909 class WXDLLIMPEXP_CORE wxIconizeEvent : public wxEvent
1910 {
1911 public:
1912 wxIconizeEvent(int winid = 0, bool iconized = true)
1913 : wxEvent(winid, wxEVT_ICONIZE)
1914 { m_iconized = iconized; }
1915 wxIconizeEvent(const wxIconizeEvent& event)
1916 : wxEvent(event)
1917 { m_iconized = event.m_iconized; }
1918
1919 #if WXWIN_COMPATIBILITY_2_8
1920 wxDEPRECATED( bool Iconized() const { return IsIconized(); } )
1921 #endif
1922 // return true if the frame was iconized, false if restored
1923 bool IsIconized() const { return m_iconized; }
1924
1925 virtual wxEvent *Clone() const { return new wxIconizeEvent(*this); }
1926
1927 protected:
1928 bool m_iconized;
1929
1930 private:
1931 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIconizeEvent)
1932 };
1933 /*
1934 wxEVT_MAXIMIZE
1935 */
1936
1937 class WXDLLIMPEXP_CORE wxMaximizeEvent : public wxEvent
1938 {
1939 public:
1940 wxMaximizeEvent(int winid = 0)
1941 : wxEvent(winid, wxEVT_MAXIMIZE)
1942 { }
1943
1944 virtual wxEvent *Clone() const { return new wxMaximizeEvent(*this); }
1945
1946 private:
1947 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMaximizeEvent)
1948 };
1949
1950 // Joystick event class
1951 /*
1952 wxEVT_JOY_BUTTON_DOWN,
1953 wxEVT_JOY_BUTTON_UP,
1954 wxEVT_JOY_MOVE,
1955 wxEVT_JOY_ZMOVE
1956 */
1957
1958 // Which joystick? Same as Windows ids so no conversion necessary.
1959 enum
1960 {
1961 wxJOYSTICK1,
1962 wxJOYSTICK2
1963 };
1964
1965 // Which button is down?
1966 enum
1967 {
1968 wxJOY_BUTTON_ANY = -1,
1969 wxJOY_BUTTON1 = 1,
1970 wxJOY_BUTTON2 = 2,
1971 wxJOY_BUTTON3 = 4,
1972 wxJOY_BUTTON4 = 8
1973 };
1974
1975 class WXDLLIMPEXP_CORE wxJoystickEvent : public wxEvent
1976 {
1977 protected:
1978 wxPoint m_pos;
1979 int m_zPosition;
1980 int m_buttonChange; // Which button changed?
1981 int m_buttonState; // Which buttons are down?
1982 int m_joyStick; // Which joystick?
1983
1984 public:
1985 wxJoystickEvent(wxEventType type = wxEVT_NULL,
1986 int state = 0,
1987 int joystick = wxJOYSTICK1,
1988 int change = 0)
1989 : wxEvent(0, type),
1990 m_pos(),
1991 m_zPosition(0),
1992 m_buttonChange(change),
1993 m_buttonState(state),
1994 m_joyStick(joystick)
1995 {
1996 }
1997 wxJoystickEvent(const wxJoystickEvent& event)
1998 : wxEvent(event),
1999 m_pos(event.m_pos),
2000 m_zPosition(event.m_zPosition),
2001 m_buttonChange(event.m_buttonChange),
2002 m_buttonState(event.m_buttonState),
2003 m_joyStick(event.m_joyStick)
2004 { }
2005
2006 wxPoint GetPosition() const { return m_pos; }
2007 int GetZPosition() const { return m_zPosition; }
2008 int GetButtonState() const { return m_buttonState; }
2009 int GetButtonChange() const { return m_buttonChange; }
2010 int GetJoystick() const { return m_joyStick; }
2011
2012 void SetJoystick(int stick) { m_joyStick = stick; }
2013 void SetButtonState(int state) { m_buttonState = state; }
2014 void SetButtonChange(int change) { m_buttonChange = change; }
2015 void SetPosition(const wxPoint& pos) { m_pos = pos; }
2016 void SetZPosition(int zPos) { m_zPosition = zPos; }
2017
2018 // Was it a button event? (*doesn't* mean: is any button *down*?)
2019 bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) ||
2020 (GetEventType() == wxEVT_JOY_BUTTON_UP)); }
2021
2022 // Was it a move event?
2023 bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE); }
2024
2025 // Was it a zmove event?
2026 bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE); }
2027
2028 // Was it a down event from button 1, 2, 3, 4 or any?
2029 bool ButtonDown(int but = wxJOY_BUTTON_ANY) const
2030 { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) &&
2031 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
2032
2033 // Was it a up event from button 1, 2, 3 or any?
2034 bool ButtonUp(int but = wxJOY_BUTTON_ANY) const
2035 { return ((GetEventType() == wxEVT_JOY_BUTTON_UP) &&
2036 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
2037
2038 // Was the given button 1,2,3,4 or any in Down state?
2039 bool ButtonIsDown(int but = wxJOY_BUTTON_ANY) const
2040 { return (((but == wxJOY_BUTTON_ANY) && (m_buttonState != 0)) ||
2041 ((m_buttonState & but) == but)); }
2042
2043 virtual wxEvent *Clone() const { return new wxJoystickEvent(*this); }
2044
2045 private:
2046 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxJoystickEvent)
2047 };
2048
2049 // Drop files event class
2050 /*
2051 wxEVT_DROP_FILES
2052 */
2053
2054 class WXDLLIMPEXP_CORE wxDropFilesEvent : public wxEvent
2055 {
2056 public:
2057 int m_noFiles;
2058 wxPoint m_pos;
2059 wxString* m_files;
2060
2061 wxDropFilesEvent(wxEventType type = wxEVT_NULL,
2062 int noFiles = 0,
2063 wxString *files = NULL)
2064 : wxEvent(0, type),
2065 m_noFiles(noFiles),
2066 m_pos(),
2067 m_files(files)
2068 { }
2069
2070 // we need a copy ctor to avoid deleting m_files pointer twice
2071 wxDropFilesEvent(const wxDropFilesEvent& other)
2072 : wxEvent(other),
2073 m_noFiles(other.m_noFiles),
2074 m_pos(other.m_pos),
2075 m_files(NULL)
2076 {
2077 m_files = new wxString[m_noFiles];
2078 for ( int n = 0; n < m_noFiles; n++ )
2079 {
2080 m_files[n] = other.m_files[n];
2081 }
2082 }
2083
2084 virtual ~wxDropFilesEvent()
2085 {
2086 delete [] m_files;
2087 }
2088
2089 wxPoint GetPosition() const { return m_pos; }
2090 int GetNumberOfFiles() const { return m_noFiles; }
2091 wxString *GetFiles() const { return m_files; }
2092
2093 virtual wxEvent *Clone() const { return new wxDropFilesEvent(*this); }
2094
2095 private:
2096 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDropFilesEvent)
2097 };
2098
2099 // Update UI event
2100 /*
2101 wxEVT_UPDATE_UI
2102 */
2103
2104 // Whether to always send update events to windows, or
2105 // to only send update events to those with the
2106 // wxWS_EX_PROCESS_UI_UPDATES style.
2107
2108 enum wxUpdateUIMode
2109 {
2110 // Send UI update events to all windows
2111 wxUPDATE_UI_PROCESS_ALL,
2112
2113 // Send UI update events to windows that have
2114 // the wxWS_EX_PROCESS_UI_UPDATES flag specified
2115 wxUPDATE_UI_PROCESS_SPECIFIED
2116 };
2117
2118 class WXDLLIMPEXP_CORE wxUpdateUIEvent : public wxCommandEvent
2119 {
2120 public:
2121 wxUpdateUIEvent(wxWindowID commandId = 0)
2122 : wxCommandEvent(wxEVT_UPDATE_UI, commandId)
2123 {
2124 m_checked =
2125 m_enabled =
2126 m_shown =
2127 m_setEnabled =
2128 m_setShown =
2129 m_setText =
2130 m_setChecked = false;
2131 }
2132 wxUpdateUIEvent(const wxUpdateUIEvent& event)
2133 : wxCommandEvent(event),
2134 m_checked(event.m_checked),
2135 m_enabled(event.m_enabled),
2136 m_shown(event.m_shown),
2137 m_setEnabled(event.m_setEnabled),
2138 m_setShown(event.m_setShown),
2139 m_setText(event.m_setText),
2140 m_setChecked(event.m_setChecked),
2141 m_text(event.m_text)
2142 { }
2143
2144 bool GetChecked() const { return m_checked; }
2145 bool GetEnabled() const { return m_enabled; }
2146 bool GetShown() const { return m_shown; }
2147 wxString GetText() const { return m_text; }
2148 bool GetSetText() const { return m_setText; }
2149 bool GetSetChecked() const { return m_setChecked; }
2150 bool GetSetEnabled() const { return m_setEnabled; }
2151 bool GetSetShown() const { return m_setShown; }
2152
2153 void Check(bool check) { m_checked = check; m_setChecked = true; }
2154 void Enable(bool enable) { m_enabled = enable; m_setEnabled = true; }
2155 void Show(bool show) { m_shown = show; m_setShown = true; }
2156 void SetText(const wxString& text) { m_text = text; m_setText = true; }
2157
2158 // Sets the interval between updates in milliseconds.
2159 // Set to -1 to disable updates, or to 0 to update as frequently as possible.
2160 static void SetUpdateInterval(long updateInterval) { sm_updateInterval = updateInterval; }
2161
2162 // Returns the current interval between updates in milliseconds
2163 static long GetUpdateInterval() { return sm_updateInterval; }
2164
2165 // Can we update this window?
2166 static bool CanUpdate(wxWindowBase *win);
2167
2168 // Reset the update time to provide a delay until the next
2169 // time we should update
2170 static void ResetUpdateTime();
2171
2172 // Specify how wxWidgets will send update events: to
2173 // all windows, or only to those which specify that they
2174 // will process the events.
2175 static void SetMode(wxUpdateUIMode mode) { sm_updateMode = mode; }
2176
2177 // Returns the UI update mode
2178 static wxUpdateUIMode GetMode() { return sm_updateMode; }
2179
2180 virtual wxEvent *Clone() const { return new wxUpdateUIEvent(*this); }
2181
2182 protected:
2183 bool m_checked;
2184 bool m_enabled;
2185 bool m_shown;
2186 bool m_setEnabled;
2187 bool m_setShown;
2188 bool m_setText;
2189 bool m_setChecked;
2190 wxString m_text;
2191 #if wxUSE_LONGLONG
2192 static wxLongLong sm_lastUpdate;
2193 #endif
2194 static long sm_updateInterval;
2195 static wxUpdateUIMode sm_updateMode;
2196
2197 private:
2198 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxUpdateUIEvent)
2199 };
2200
2201 /*
2202 wxEVT_SYS_COLOUR_CHANGED
2203 */
2204
2205 // TODO: shouldn't all events record the window ID?
2206 class WXDLLIMPEXP_CORE wxSysColourChangedEvent : public wxEvent
2207 {
2208 public:
2209 wxSysColourChangedEvent()
2210 : wxEvent(0, wxEVT_SYS_COLOUR_CHANGED)
2211 { }
2212
2213 virtual wxEvent *Clone() const { return new wxSysColourChangedEvent(*this); }
2214
2215 private:
2216 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSysColourChangedEvent)
2217 };
2218
2219 /*
2220 wxEVT_MOUSE_CAPTURE_CHANGED
2221 The window losing the capture receives this message
2222 (even if it released the capture itself).
2223 */
2224
2225 class WXDLLIMPEXP_CORE wxMouseCaptureChangedEvent : public wxEvent
2226 {
2227 public:
2228 wxMouseCaptureChangedEvent(wxWindowID winid = 0, wxWindow* gainedCapture = NULL)
2229 : wxEvent(winid, wxEVT_MOUSE_CAPTURE_CHANGED),
2230 m_gainedCapture(gainedCapture)
2231 { }
2232
2233 wxMouseCaptureChangedEvent(const wxMouseCaptureChangedEvent& event)
2234 : wxEvent(event),
2235 m_gainedCapture(event.m_gainedCapture)
2236 { }
2237
2238 virtual wxEvent *Clone() const { return new wxMouseCaptureChangedEvent(*this); }
2239
2240 wxWindow* GetCapturedWindow() const { return m_gainedCapture; }
2241
2242 private:
2243 wxWindow* m_gainedCapture;
2244
2245 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureChangedEvent)
2246 };
2247
2248 /*
2249 wxEVT_MOUSE_CAPTURE_LOST
2250 The window losing the capture receives this message, unless it released it
2251 it itself or unless wxWindow::CaptureMouse was called on another window
2252 (and so capture will be restored when the new capturer releases it).
2253 */
2254
2255 class WXDLLIMPEXP_CORE wxMouseCaptureLostEvent : public wxEvent
2256 {
2257 public:
2258 wxMouseCaptureLostEvent(wxWindowID winid = 0)
2259 : wxEvent(winid, wxEVT_MOUSE_CAPTURE_LOST)
2260 {}
2261
2262 wxMouseCaptureLostEvent(const wxMouseCaptureLostEvent& event)
2263 : wxEvent(event)
2264 {}
2265
2266 virtual wxEvent *Clone() const { return new wxMouseCaptureLostEvent(*this); }
2267
2268 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureLostEvent)
2269 };
2270
2271 /*
2272 wxEVT_DISPLAY_CHANGED
2273 */
2274 class WXDLLIMPEXP_CORE wxDisplayChangedEvent : public wxEvent
2275 {
2276 private:
2277 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDisplayChangedEvent)
2278
2279 public:
2280 wxDisplayChangedEvent()
2281 : wxEvent(0, wxEVT_DISPLAY_CHANGED)
2282 { }
2283
2284 virtual wxEvent *Clone() const { return new wxDisplayChangedEvent(*this); }
2285 };
2286
2287 /*
2288 wxEVT_PALETTE_CHANGED
2289 */
2290
2291 class WXDLLIMPEXP_CORE wxPaletteChangedEvent : public wxEvent
2292 {
2293 public:
2294 wxPaletteChangedEvent(wxWindowID winid = 0)
2295 : wxEvent(winid, wxEVT_PALETTE_CHANGED),
2296 m_changedWindow(NULL)
2297 { }
2298
2299 wxPaletteChangedEvent(const wxPaletteChangedEvent& event)
2300 : wxEvent(event),
2301 m_changedWindow(event.m_changedWindow)
2302 { }
2303
2304 void SetChangedWindow(wxWindow* win) { m_changedWindow = win; }
2305 wxWindow* GetChangedWindow() const { return m_changedWindow; }
2306
2307 virtual wxEvent *Clone() const { return new wxPaletteChangedEvent(*this); }
2308
2309 protected:
2310 wxWindow* m_changedWindow;
2311
2312 private:
2313 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaletteChangedEvent)
2314 };
2315
2316 /*
2317 wxEVT_QUERY_NEW_PALETTE
2318 Indicates the window is getting keyboard focus and should re-do its palette.
2319 */
2320
2321 class WXDLLIMPEXP_CORE wxQueryNewPaletteEvent : public wxEvent
2322 {
2323 public:
2324 wxQueryNewPaletteEvent(wxWindowID winid = 0)
2325 : wxEvent(winid, wxEVT_QUERY_NEW_PALETTE),
2326 m_paletteRealized(false)
2327 { }
2328 wxQueryNewPaletteEvent(const wxQueryNewPaletteEvent& event)
2329 : wxEvent(event),
2330 m_paletteRealized(event.m_paletteRealized)
2331 { }
2332
2333 // App sets this if it changes the palette.
2334 void SetPaletteRealized(bool realized) { m_paletteRealized = realized; }
2335 bool GetPaletteRealized() const { return m_paletteRealized; }
2336
2337 virtual wxEvent *Clone() const { return new wxQueryNewPaletteEvent(*this); }
2338
2339 protected:
2340 bool m_paletteRealized;
2341
2342 private:
2343 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxQueryNewPaletteEvent)
2344 };
2345
2346 /*
2347 Event generated by dialog navigation keys
2348 wxEVT_NAVIGATION_KEY
2349 */
2350 // NB: don't derive from command event to avoid being propagated to the parent
2351 class WXDLLIMPEXP_CORE wxNavigationKeyEvent : public wxEvent
2352 {
2353 public:
2354 wxNavigationKeyEvent()
2355 : wxEvent(0, wxEVT_NAVIGATION_KEY),
2356 m_flags(IsForward | FromTab), // defaults are for TAB
2357 m_focus(NULL)
2358 {
2359 m_propagationLevel = wxEVENT_PROPAGATE_NONE;
2360 }
2361
2362 wxNavigationKeyEvent(const wxNavigationKeyEvent& event)
2363 : wxEvent(event),
2364 m_flags(event.m_flags),
2365 m_focus(event.m_focus)
2366 { }
2367
2368 // direction: forward (true) or backward (false)
2369 bool GetDirection() const
2370 { return (m_flags & IsForward) != 0; }
2371 void SetDirection(bool bForward)
2372 { if ( bForward ) m_flags |= IsForward; else m_flags &= ~IsForward; }
2373
2374 // it may be a window change event (MDI, notebook pages...) or a control
2375 // change event
2376 bool IsWindowChange() const
2377 { return (m_flags & WinChange) != 0; }
2378 void SetWindowChange(bool bIs)
2379 { if ( bIs ) m_flags |= WinChange; else m_flags &= ~WinChange; }
2380
2381 // Set to true under MSW if the event was generated using the tab key.
2382 // This is required for proper navogation over radio buttons
2383 bool IsFromTab() const
2384 { return (m_flags & FromTab) != 0; }
2385 void SetFromTab(bool bIs)
2386 { if ( bIs ) m_flags |= FromTab; else m_flags &= ~FromTab; }
2387
2388 // the child which has the focus currently (may be NULL - use
2389 // wxWindow::FindFocus then)
2390 wxWindow* GetCurrentFocus() const { return m_focus; }
2391 void SetCurrentFocus(wxWindow *win) { m_focus = win; }
2392
2393 // Set flags
2394 void SetFlags(long flags) { m_flags = flags; }
2395
2396 virtual wxEvent *Clone() const { return new wxNavigationKeyEvent(*this); }
2397
2398 enum
2399 {
2400 IsBackward = 0x0000,
2401 IsForward = 0x0001,
2402 WinChange = 0x0002,
2403 FromTab = 0x0004
2404 };
2405
2406 long m_flags;
2407 wxWindow *m_focus;
2408
2409 private:
2410 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNavigationKeyEvent)
2411 };
2412
2413 // Window creation/destruction events: the first is sent as soon as window is
2414 // created (i.e. the underlying GUI object exists), but when the C++ object is
2415 // fully initialized (so virtual functions may be called). The second,
2416 // wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
2417 // still safe to call virtual functions at this moment
2418 /*
2419 wxEVT_CREATE
2420 wxEVT_DESTROY
2421 */
2422
2423 class WXDLLIMPEXP_CORE wxWindowCreateEvent : public wxCommandEvent
2424 {
2425 public:
2426 wxWindowCreateEvent(wxWindow *win = NULL);
2427
2428 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
2429
2430 virtual wxEvent *Clone() const { return new wxWindowCreateEvent(*this); }
2431
2432 private:
2433 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowCreateEvent)
2434 };
2435
2436 class WXDLLIMPEXP_CORE wxWindowDestroyEvent : public wxCommandEvent
2437 {
2438 public:
2439 wxWindowDestroyEvent(wxWindow *win = NULL);
2440
2441 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
2442
2443 virtual wxEvent *Clone() const { return new wxWindowDestroyEvent(*this); }
2444
2445 private:
2446 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowDestroyEvent)
2447 };
2448
2449 // A help event is sent when the user clicks on a window in context-help mode.
2450 /*
2451 wxEVT_HELP
2452 wxEVT_DETAILED_HELP
2453 */
2454
2455 class WXDLLIMPEXP_CORE wxHelpEvent : public wxCommandEvent
2456 {
2457 public:
2458 // how was this help event generated?
2459 enum Origin
2460 {
2461 Origin_Unknown, // unrecognized event source
2462 Origin_Keyboard, // event generated from F1 key press
2463 Origin_HelpButton // event from [?] button on the title bar (Windows)
2464 };
2465
2466 wxHelpEvent(wxEventType type = wxEVT_NULL,
2467 wxWindowID winid = 0,
2468 const wxPoint& pt = wxDefaultPosition,
2469 Origin origin = Origin_Unknown)
2470 : wxCommandEvent(type, winid),
2471 m_pos(pt),
2472 m_origin(GuessOrigin(origin))
2473 { }
2474 wxHelpEvent(const wxHelpEvent& event)
2475 : wxCommandEvent(event),
2476 m_pos(event.m_pos),
2477 m_target(event.m_target),
2478 m_link(event.m_link),
2479 m_origin(event.m_origin)
2480 { }
2481
2482 // Position of event (in screen coordinates)
2483 const wxPoint& GetPosition() const { return m_pos; }
2484 void SetPosition(const wxPoint& pos) { m_pos = pos; }
2485
2486 // Optional link to further help
2487 const wxString& GetLink() const { return m_link; }
2488 void SetLink(const wxString& link) { m_link = link; }
2489
2490 // Optional target to display help in. E.g. a window specification
2491 const wxString& GetTarget() const { return m_target; }
2492 void SetTarget(const wxString& target) { m_target = target; }
2493
2494 virtual wxEvent *Clone() const { return new wxHelpEvent(*this); }
2495
2496 // optional indication of the event source
2497 Origin GetOrigin() const { return m_origin; }
2498 void SetOrigin(Origin origin) { m_origin = origin; }
2499
2500 protected:
2501 wxPoint m_pos;
2502 wxString m_target;
2503 wxString m_link;
2504 Origin m_origin;
2505
2506 // we can try to guess the event origin ourselves, even if none is
2507 // specified in the ctor
2508 static Origin GuessOrigin(Origin origin);
2509
2510 private:
2511 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHelpEvent)
2512 };
2513
2514 // A Clipboard Text event is sent when a window intercepts text copy/cut/paste
2515 // message, i.e. the user has cut/copied/pasted data from/into a text control
2516 // via ctrl-C/X/V, ctrl/shift-del/insert, a popup menu command, etc.
2517 // NOTE : under windows these events are *NOT* generated automatically
2518 // for a Rich Edit text control.
2519 /*
2520 wxEVT_COMMAND_TEXT_COPY
2521 wxEVT_COMMAND_TEXT_CUT
2522 wxEVT_COMMAND_TEXT_PASTE
2523 */
2524
2525 class WXDLLIMPEXP_CORE wxClipboardTextEvent : public wxCommandEvent
2526 {
2527 public:
2528 wxClipboardTextEvent(wxEventType type = wxEVT_NULL,
2529 wxWindowID winid = 0)
2530 : wxCommandEvent(type, winid)
2531 { }
2532 wxClipboardTextEvent(const wxClipboardTextEvent& event)
2533 : wxCommandEvent(event)
2534 { }
2535
2536 virtual wxEvent *Clone() const { return new wxClipboardTextEvent(*this); }
2537
2538 private:
2539 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxClipboardTextEvent)
2540 };
2541
2542 // A Context event is sent when the user right clicks on a window or
2543 // presses Shift-F10
2544 // NOTE : Under windows this is a repackaged WM_CONTETXMENU message
2545 // Under other systems it may have to be generated from a right click event
2546 /*
2547 wxEVT_CONTEXT_MENU
2548 */
2549
2550 class WXDLLIMPEXP_CORE wxContextMenuEvent : public wxCommandEvent
2551 {
2552 public:
2553 wxContextMenuEvent(wxEventType type = wxEVT_NULL,
2554 wxWindowID winid = 0,
2555 const wxPoint& pt = wxDefaultPosition)
2556 : wxCommandEvent(type, winid),
2557 m_pos(pt)
2558 { }
2559 wxContextMenuEvent(const wxContextMenuEvent& event)
2560 : wxCommandEvent(event),
2561 m_pos(event.m_pos)
2562 { }
2563
2564 // Position of event (in screen coordinates)
2565 const wxPoint& GetPosition() const { return m_pos; }
2566 void SetPosition(const wxPoint& pos) { m_pos = pos; }
2567
2568 virtual wxEvent *Clone() const { return new wxContextMenuEvent(*this); }
2569
2570 protected:
2571 wxPoint m_pos;
2572
2573 private:
2574 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxContextMenuEvent)
2575 };
2576
2577 #endif // wxUSE_GUI
2578
2579 // Idle event
2580 /*
2581 wxEVT_IDLE
2582 */
2583
2584 // Whether to always send idle events to windows, or
2585 // to only send update events to those with the
2586 // wxWS_EX_PROCESS_IDLE style.
2587
2588 enum wxIdleMode
2589 {
2590 // Send idle events to all windows
2591 wxIDLE_PROCESS_ALL,
2592
2593 // Send idle events to windows that have
2594 // the wxWS_EX_PROCESS_IDLE flag specified
2595 wxIDLE_PROCESS_SPECIFIED
2596 };
2597
2598 class WXDLLIMPEXP_BASE wxIdleEvent : public wxEvent
2599 {
2600 public:
2601 wxIdleEvent()
2602 : wxEvent(0, wxEVT_IDLE),
2603 m_requestMore(false)
2604 { }
2605 wxIdleEvent(const wxIdleEvent& event)
2606 : wxEvent(event),
2607 m_requestMore(event.m_requestMore)
2608 { }
2609
2610 void RequestMore(bool needMore = true) { m_requestMore = needMore; }
2611 bool MoreRequested() const { return m_requestMore; }
2612
2613 virtual wxEvent *Clone() const { return new wxIdleEvent(*this); }
2614
2615 // Specify how wxWidgets will send idle events: to
2616 // all windows, or only to those which specify that they
2617 // will process the events.
2618 static void SetMode(wxIdleMode mode) { sm_idleMode = mode; }
2619
2620 // Returns the idle event mode
2621 static wxIdleMode GetMode() { return sm_idleMode; }
2622
2623 protected:
2624 bool m_requestMore;
2625 static wxIdleMode sm_idleMode;
2626
2627 private:
2628 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIdleEvent)
2629 };
2630
2631 /* TODO
2632 wxEVT_MOUSE_CAPTURE_CHANGED,
2633 wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
2634 // wxEVT_FONT_CHANGED, // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
2635 // wxEVT_FONT_CHANGED to all other windows (maybe).
2636 wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
2637 wxEVT_MEASURE_ITEM,
2638 wxEVT_COMPARE_ITEM
2639 */
2640
2641
2642
2643 // ============================================================================
2644 // event handler and related classes
2645 // ============================================================================
2646
2647
2648 // struct containing the members common to static and dynamic event tables
2649 // entries
2650 struct WXDLLIMPEXP_BASE wxEventTableEntryBase
2651 {
2652 wxEventTableEntryBase(int winid, int idLast,
2653 wxEventFunctor* fn, wxObject *data)
2654 : m_id(winid),
2655 m_lastId(idLast),
2656 m_fn(fn),
2657 m_callbackUserData(data)
2658 { }
2659
2660 wxEventTableEntryBase( const wxEventTableEntryBase &entry )
2661 : m_id( entry.m_id ),
2662 m_lastId( entry.m_lastId ),
2663 m_fn( entry.m_fn ),
2664 m_callbackUserData( entry.m_callbackUserData )
2665 {
2666 // This is a 'hack' to ensure that only one instance tries to delete
2667 // the functor pointer. It is safe as long as the only place where the
2668 // copy constructor is being called is when the static event tables are
2669 // being initialized (a temporary instance is created and then this
2670 // constructor is called).
2671
2672 const_cast<wxEventTableEntryBase&>( entry ).m_fn = NULL;
2673 }
2674
2675 ~wxEventTableEntryBase()
2676 {
2677 delete m_fn;
2678 }
2679
2680 // the range of ids for this entry: if m_lastId == wxID_ANY, the range
2681 // consists only of m_id, otherwise it is m_id..m_lastId inclusive
2682 int m_id,
2683 m_lastId;
2684
2685 // function/method/functor to call
2686 wxEventFunctor* m_fn;
2687
2688 // arbitrary user data associated with the callback
2689 wxObject* m_callbackUserData;
2690
2691 private:
2692 DECLARE_NO_ASSIGN_CLASS(wxEventTableEntryBase)
2693 };
2694
2695 // an entry from a static event table
2696 struct WXDLLIMPEXP_BASE wxEventTableEntry : public wxEventTableEntryBase
2697 {
2698 wxEventTableEntry(const int& evType, int winid, int idLast,
2699 wxEventFunctor* fn, wxObject *data)
2700 : wxEventTableEntryBase(winid, idLast, fn, data),
2701 m_eventType(evType)
2702 { }
2703
2704 // the reference to event type: this allows us to not care about the
2705 // (undefined) order in which the event table entries and the event types
2706 // are initialized: initially the value of this reference might be
2707 // invalid, but by the time it is used for the first time, all global
2708 // objects will have been initialized (including the event type constants)
2709 // and so it will have the correct value when it is needed
2710 const int& m_eventType;
2711
2712 private:
2713 DECLARE_NO_ASSIGN_CLASS(wxEventTableEntry)
2714 };
2715
2716 // an entry used in dynamic event table managed by wxEvtHandler::Connect()
2717 struct WXDLLIMPEXP_BASE wxDynamicEventTableEntry : public wxEventTableEntryBase
2718 {
2719 wxDynamicEventTableEntry(int evType, int winid, int idLast,
2720 wxEventFunctor* fn, wxObject *data)
2721 : wxEventTableEntryBase(winid, idLast, fn, data),
2722 m_eventType(evType)
2723 { }
2724
2725 // not a reference here as we can't keep a reference to a temporary int
2726 // created to wrap the constant value typically passed to Connect() - nor
2727 // do we need it
2728 int m_eventType;
2729
2730 private:
2731 DECLARE_NO_ASSIGN_CLASS(wxDynamicEventTableEntry)
2732 };
2733
2734 // ----------------------------------------------------------------------------
2735 // wxEventTable: an array of event entries terminated with {0, 0, 0, 0, 0}
2736 // ----------------------------------------------------------------------------
2737
2738 struct WXDLLIMPEXP_BASE wxEventTable
2739 {
2740 const wxEventTable *baseTable; // base event table (next in chain)
2741 const wxEventTableEntry *entries; // bottom of entry array
2742 };
2743
2744 // ----------------------------------------------------------------------------
2745 // wxEventHashTable: a helper of wxEvtHandler to speed up wxEventTable lookups.
2746 // ----------------------------------------------------------------------------
2747
2748 WX_DEFINE_ARRAY_PTR(const wxEventTableEntry*, wxEventTableEntryPointerArray);
2749
2750 class WXDLLIMPEXP_BASE wxEventHashTable
2751 {
2752 private:
2753 // Internal data structs
2754 struct EventTypeTable
2755 {
2756 wxEventType eventType;
2757 wxEventTableEntryPointerArray eventEntryTable;
2758 };
2759 typedef EventTypeTable* EventTypeTablePointer;
2760
2761 public:
2762 // Constructor, needs the event table it needs to hash later on.
2763 // Note: hashing of the event table is not done in the constructor as it
2764 // can be that the event table is not yet full initialize, the hash
2765 // will gets initialized when handling the first event look-up request.
2766 wxEventHashTable(const wxEventTable &table);
2767 // Destructor.
2768 ~wxEventHashTable();
2769
2770 // Handle the given event, in other words search the event table hash
2771 // and call self->ProcessEvent() if a match was found.
2772 bool HandleEvent(wxEvent& event, wxEvtHandler *self);
2773
2774 // Clear table
2775 void Clear();
2776
2777 #if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
2778 // Clear all tables
2779 static void ClearAll();
2780 #endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING
2781
2782 protected:
2783 // Init the hash table with the entries of the static event table.
2784 void InitHashTable();
2785 // Helper funtion of InitHashTable() to insert 1 entry into the hash table.
2786 void AddEntry(const wxEventTableEntry &entry);
2787 // Allocate and init with null pointers the base hash table.
2788 void AllocEventTypeTable(size_t size);
2789 // Grow the hash table in size and transfer all items currently
2790 // in the table to the correct location in the new table.
2791 void GrowEventTypeTable();
2792
2793 protected:
2794 const wxEventTable &m_table;
2795 bool m_rebuildHash;
2796
2797 size_t m_size;
2798 EventTypeTablePointer *m_eventTypeTable;
2799
2800 static wxEventHashTable* sm_first;
2801 wxEventHashTable* m_previous;
2802 wxEventHashTable* m_next;
2803
2804 DECLARE_NO_COPY_CLASS(wxEventHashTable)
2805 };
2806
2807 // ----------------------------------------------------------------------------
2808 // wxEvtHandler: the base class for all objects handling wxWidgets events
2809 // ----------------------------------------------------------------------------
2810
2811 class WXDLLIMPEXP_BASE wxEvtHandler : public wxObject
2812 , public wxTrackable
2813 {
2814 public:
2815 wxEvtHandler();
2816 virtual ~wxEvtHandler();
2817
2818
2819 // Event handler chain
2820 // -------------------
2821
2822 wxEvtHandler *GetNextHandler() const { return m_nextHandler; }
2823 wxEvtHandler *GetPreviousHandler() const { return m_previousHandler; }
2824 virtual void SetNextHandler(wxEvtHandler *handler) { m_nextHandler = handler; }
2825 virtual void SetPreviousHandler(wxEvtHandler *handler) { m_previousHandler = handler; }
2826
2827 void SetEvtHandlerEnabled(bool enabled) { m_enabled = enabled; }
2828 bool GetEvtHandlerEnabled() const { return m_enabled; }
2829
2830 void Unlink();
2831 bool IsUnlinked() const;
2832
2833
2834
2835 // Event queuing and processing
2836 // ----------------------------
2837
2838
2839 // Process an event right now: this can only be called from the main
2840 // thread, use QueueEvent() for scheduling the events for
2841 // processing from other threads.
2842 virtual bool ProcessEvent(wxEvent& event);
2843
2844 // Process an event by calling ProcessEvent and handling any exceptions
2845 // thrown by event handlers. It's mostly useful when processing wx events
2846 // when called from C code (e.g. in GTK+ callback) when the exception
2847 // wouldn't correctly propagate to wxEventLoop.
2848 bool SafelyProcessEvent(wxEvent& event);
2849 // NOTE: uses ProcessEvent()
2850
2851 // Schedule the given event to be processed later. It takes ownership of
2852 // the event pointer, i.e. it will be deleted later. This is safe to call
2853 // from multiple threads although you still need to ensure that wxString
2854 // fields of the event object are deep copies and not use the same string
2855 // buffer as other wxString objects in this thread.
2856 virtual void QueueEvent(wxEvent *event);
2857
2858 // Add an event to be processed later: notice that this function is not
2859 // safe to call from threads other than main, use QueueEvent()
2860 virtual void AddPendingEvent(const wxEvent& event)
2861 {
2862 // notice that the thread-safety problem comes from the fact that
2863 // Clone() doesn't make deep copies of wxString fields of wxEvent
2864 // object and so the same wxString could be used from both threads when
2865 // the event object is destroyed in this one -- QueueEvent() avoids
2866 // this problem as the event pointer is not used any more in this
2867 // thread at all after it is called.
2868 QueueEvent(event.Clone());
2869 }
2870
2871 void ProcessPendingEvents();
2872 // NOTE: uses ProcessEvent()
2873
2874 #if wxUSE_THREADS
2875 bool ProcessThreadEvent(const wxEvent& event);
2876 // NOTE: uses AddPendingEvent()
2877 #endif
2878
2879
2880 // Connecting and disconnecting
2881 // ----------------------------
2882
2883 // These functions are used for old, untyped, event handlers and don't
2884 // check that the type of the function passed to them actually matches the
2885 // type of the event. They also only allow connecting events to methods of
2886 // wxEvtHandler-derived classes.
2887 //
2888 // The template Connect() methods below are safer and allow connecting
2889 // events to arbitrary functions or functors -- but require compiler
2890 // support for templates.
2891
2892 // Dynamic association of a member function handler with the event handler,
2893 // winid and event type
2894 void Connect(int winid,
2895 int lastId,
2896 wxEventType eventType,
2897 wxObjectEventFunction func,
2898 wxObject *userData = NULL,
2899 wxEvtHandler *eventSink = NULL)
2900 {
2901 DoConnect(winid, lastId, eventType,
2902 wxNewEventFunctor(eventType, func, eventSink),
2903 userData);
2904 }
2905
2906 // Convenience function: take just one id
2907 void Connect(int winid,
2908 wxEventType eventType,
2909 wxObjectEventFunction func,
2910 wxObject *userData = NULL,
2911 wxEvtHandler *eventSink = NULL)
2912 { Connect(winid, wxID_ANY, eventType, func, userData, eventSink); }
2913
2914 // Even more convenient: without id (same as using id of wxID_ANY)
2915 void Connect(wxEventType eventType,
2916 wxObjectEventFunction func,
2917 wxObject *userData = NULL,
2918 wxEvtHandler *eventSink = NULL)
2919 { Connect(wxID_ANY, wxID_ANY, eventType, func, userData, eventSink); }
2920
2921 bool Disconnect(int winid,
2922 int lastId,
2923 wxEventType eventType,
2924 wxObjectEventFunction func = NULL,
2925 wxObject *userData = NULL,
2926 wxEvtHandler *eventSink = NULL)
2927 {
2928 return DoDisconnect(winid, lastId, eventType,
2929 wxMakeEventFunctor(eventType, func, eventSink),
2930 userData );
2931 }
2932
2933 bool Disconnect(int winid = wxID_ANY,
2934 wxEventType eventType = wxEVT_NULL,
2935 wxObjectEventFunction func = NULL,
2936 wxObject *userData = NULL,
2937 wxEvtHandler *eventSink = NULL)
2938 { return Disconnect(winid, wxID_ANY, eventType, func, userData, eventSink); }
2939
2940 bool Disconnect(wxEventType eventType,
2941 wxObjectEventFunction func,
2942 wxObject *userData = NULL,
2943 wxEvtHandler *eventSink = NULL)
2944 { return Disconnect(wxID_ANY, eventType, func, userData, eventSink); }
2945
2946 #if !wxEVENTS_COMPATIBILITY_2_8
2947 // Event handling in functions (including generalized functors):
2948
2949 template <typename EventTag, typename Functor>
2950 void Connect(int winid,
2951 int lastId,
2952 const EventTag& eventType,
2953 Functor func)
2954 {
2955 DoConnect(winid, lastId, eventType,
2956 wxNewEventFunctor(eventType, func));
2957 }
2958
2959 template <typename EventTag, typename Functor>
2960 void Connect(int winid, const EventTag& eventType, Functor func)
2961 { Connect(winid, wxID_ANY, eventType, func); }
2962
2963 template <typename EventTag, typename Functor>
2964 void Connect(const EventTag& eventType, Functor func)
2965 { Connect(wxID_ANY, eventType, func); }
2966
2967
2968 template <typename EventTag, typename Functor>
2969 bool Disconnect(int winid,
2970 int lastId,
2971 const EventTag& eventType,
2972 Functor func)
2973 {
2974 return DoDisconnect(winid, lastId, eventType,
2975 wxMakeEventFunctor(eventType, func));
2976 }
2977
2978 template <typename EventTag, typename Functor>
2979 bool Disconnect(int winid, const EventTag& eventType, Functor func)
2980 { return Disconnect(winid, wxID_ANY, eventType, func); }
2981
2982 template <typename EventTag, typename Functor>
2983 bool Disconnect(const EventTag& eventType, Functor func)
2984 { return Disconnect(wxID_ANY, eventType, func); }
2985
2986
2987
2988 // Event handling in class methods: the object handling the event (i.e.
2989 // this object itself by default or eventSink if specified) must be
2990 // convertible to this class.
2991 //
2992 // Notice that we need to have separate overloads for the versions with and
2993 // without eventSink because in the latter case we must check that this
2994 // object itself derives from Class while in the former this is not
2995 // necessarily true
2996
2997 // Methods connecting/disconnecting event to this object itself
2998
2999 template <typename EventTag, typename Class, typename EventArg>
3000 void Connect(int winid,
3001 int lastId,
3002 const EventTag& eventType,
3003 void (Class::*func)(EventArg&),
3004 wxObject *userData = NULL)
3005 {
3006 DoConnect(winid, lastId, eventType,
3007 wxNewEventFunctor(eventType, func, static_cast<Class *>(this)),
3008 userData);
3009 }
3010
3011 template <typename EventTag, typename Class, typename EventArg>
3012 void Connect(int winid,
3013 const EventTag& eventType,
3014 void (Class::*func)(EventArg&),
3015 wxObject *userData = NULL)
3016 { Connect(winid, wxID_ANY, eventType, func, userData); }
3017
3018 template <typename EventTag, typename Class, typename EventArg>
3019 void Connect(const EventTag& eventType,
3020 void (Class::*func)(EventArg&),
3021 wxObject *userData = NULL)
3022 { Connect(wxID_ANY, eventType, func, userData); }
3023
3024
3025 template <typename EventTag, typename Class, typename EventArg>
3026 bool Disconnect(int winid,
3027 int lastId,
3028 const EventTag& eventType,
3029 void (Class::*func)(EventArg&),
3030 wxObject *userData = NULL)
3031 {
3032 return DoDisconnect(winid, lastId, eventType,
3033 wxMakeEventFunctor(eventType, func,
3034 static_cast<Class *>(this)),
3035 userData);
3036 }
3037
3038 template <typename EventTag, typename Class, typename EventArg>
3039 bool Disconnect(int winid,
3040 const EventTag& eventType,
3041 void (Class::*func)(EventArg&),
3042 wxObject *userData = NULL)
3043 { return Disconnect(winid, wxID_ANY, eventType, func, userData); }
3044
3045 template <typename EventTag, typename Class, typename EventArg>
3046 bool Disconnect(const EventTag& eventType,
3047 void (Class::*func)(EventArg&),
3048 wxObject *userData = NULL)
3049 { return Disconnect(wxID_ANY, eventType, func, userData); }
3050
3051
3052 // Methods connecting/disconnecting event to another object
3053
3054 template
3055 <typename EventTag, typename Class, typename EventArg, typename ObjClass>
3056 void Connect(int winid,
3057 int lastId,
3058 const EventTag& eventType,
3059 void (Class::*func)(EventArg&),
3060 wxObject *userData,
3061 ObjClass *eventSink)
3062 {
3063 DoConnect(winid, lastId, eventType,
3064 wxNewEventFunctor(eventType, func, eventSink),
3065 userData);
3066 }
3067
3068 template
3069 <typename EventTag, typename Class, typename EventArg, typename ObjClass>
3070 void Connect(int winid,
3071 const EventTag& eventType,
3072 void (Class::*func)(EventArg&),
3073 wxObject *userData,
3074 ObjClass *eventSink)
3075 { Connect(winid, wxID_ANY, eventType, func, userData, eventSink); }
3076
3077 template
3078 <typename EventTag, typename Class, typename EventArg, typename ObjClass>
3079 void Connect(const EventTag& eventType,
3080 void (Class::*func)(EventArg&),
3081 wxObject *userData,
3082 ObjClass *eventSink)
3083 { Connect(wxID_ANY, eventType, func, userData, eventSink); }
3084
3085
3086 template
3087 <typename EventTag, typename Class, typename EventArg, typename ObjClass>
3088 bool Disconnect(int winid,
3089 int lastId,
3090 const EventTag& eventType,
3091 void (Class::*func)(EventArg&),
3092 wxObject *userData,
3093 ObjClass *eventSink)
3094 {
3095 return DoDisconnect(winid, lastId, eventType,
3096 wxMakeEventFunctor(eventType, func, eventSink),
3097 userData);
3098 }
3099
3100 template
3101 <typename EventTag, typename Class, typename EventArg, typename ObjClass>
3102 bool Disconnect(int winid,
3103 const EventTag& eventType,
3104 void (Class::*func)(EventArg&),
3105 wxObject *userData,
3106 ObjClass *eventSink)
3107 { return Disconnect(winid, wxID_ANY, eventType, func,
3108 userData, eventSink); }
3109
3110 template
3111 <typename EventTag, typename Class, typename EventArg, typename ObjClass>
3112 bool Disconnect(const EventTag& eventType,
3113 void (Class::*func)(EventArg&),
3114 wxObject *userData,
3115 ObjClass *eventSink)
3116 { return Disconnect(wxID_ANY, eventType, func, userData, eventSink); }
3117
3118
3119
3120 // Static version of Connect() which allows to specify the event source and
3121 // event handler in a more symmetric way
3122 template <typename ObjSource, typename EventTag,
3123 typename Class, typename EventArg, typename ObjClass>
3124 static void Connect(ObjSource *eventSrc,
3125 int winid,
3126 int lastId,
3127 const EventTag& eventType,
3128 void (Class::*func)(EventArg&),
3129 wxObject *userData = NULL,
3130 ObjClass *eventSink = NULL)
3131 {
3132 eventSrc->Connect(winid, lastId, eventType, func, userData, eventSink);
3133 }
3134
3135 template <typename ObjSource, typename EventTag,
3136 typename Class, typename EventArg, typename ObjClass>
3137 static void Connect(ObjSource *eventSrc,
3138 int winid,
3139 const EventTag& eventType,
3140 void (Class::*func)(EventArg&),
3141 wxObject *userData = NULL,
3142 ObjClass *eventSink = NULL)
3143 {
3144 Connect(eventSrc, winid, wxID_ANY, eventType, func, userData, eventSink);
3145 }
3146
3147 template <typename ObjSource, typename EventTag,
3148 typename Class, typename EventArg, typename ObjClass>
3149 static void Connect(ObjSource *eventSrc,
3150 const EventTag& eventType,
3151 void (Class::*func)(EventArg&),
3152 wxObject *userData = NULL,
3153 ObjClass *eventSink = NULL)
3154 {
3155 Connect(eventSrc, wxID_ANY, eventType, func, userData, eventSink);
3156 }
3157
3158
3159 template <typename ObjSource, typename EventTag,
3160 typename Class, typename EventArg, typename ObjClass>
3161 static bool Disconnect(ObjSource *eventSrc,
3162 int winid,
3163 int lastId,
3164 const EventTag& eventType,
3165 void (Class::*func)(EventArg&),
3166 wxObject *userData = NULL,
3167 ObjClass *eventSink = NULL)
3168 {
3169 return eventSrc->Disconnect(winid, lastId, eventType, func,
3170 userData, eventSink);
3171 }
3172
3173 template <typename ObjSource, typename EventTag,
3174 typename Class, typename EventArg, typename ObjClass>
3175 static bool Disconnect(ObjSource *eventSrc,
3176 int winid,
3177 const EventTag& eventType,
3178 void (Class::*func)(EventArg&),
3179 wxObject *userData = NULL,
3180 ObjClass *eventSink = NULL)
3181 {
3182 return Disconnect(eventSrc, winid, wxID_ANY, eventType, func,
3183 userData, eventSink);
3184 }
3185
3186 template <typename ObjSource, typename EventTag,
3187 typename Class, typename EventArg, typename ObjClass>
3188 static bool Disconnect(ObjSource *eventSrc,
3189 const EventTag& eventType,
3190 void (Class::*func)(EventArg&),
3191 wxObject *userData = NULL,
3192 ObjClass *eventSink = NULL)
3193 {
3194 return Disconnect(eventSrc, wxID_ANY, eventType, func,
3195 userData, eventSink);
3196 }
3197 #endif // !wxEVENTS_COMPATIBILITY_2_8
3198
3199
3200 wxList* GetDynamicEventTable() const { return m_dynamicEvents ; }
3201
3202 // User data can be associated with each wxEvtHandler
3203 void SetClientObject( wxClientData *data ) { DoSetClientObject(data); }
3204 wxClientData *GetClientObject() const { return DoGetClientObject(); }
3205
3206 void SetClientData( void *data ) { DoSetClientData(data); }
3207 void *GetClientData() const { return DoGetClientData(); }
3208
3209
3210 // implementation from now on
3211 // --------------------------
3212
3213 // check if the given event table entry matches this event by id (the check
3214 // for the event type should be done by caller) and call the handler if it
3215 // does
3216 //
3217 // return true if the event was processed, false otherwise (no match or the
3218 // handler decided to skip the event)
3219 static bool ProcessEventIfMatchesId(const wxEventTableEntryBase& tableEntry,
3220 wxEvtHandler *handler,
3221 wxEvent& event);
3222
3223 virtual bool SearchEventTable(wxEventTable& table, wxEvent& event);
3224 bool SearchDynamicEventTable( wxEvent& event );
3225
3226 // Avoid problems at exit by cleaning up static hash table gracefully
3227 void ClearEventHashTable() { GetEventHashTable().Clear(); }
3228 void OnSinkDestroyed( wxEvtHandler *sink );
3229
3230
3231 // The method tries to process the event in this event handler.
3232 //
3233 // It is meant to be called from ProcessEvent() only and is not virtual,
3234 // additional event handlers can be hooked into the normal event processing
3235 // logic using TryValidator() hook.
3236 bool ProcessEventHere(wxEvent& event);
3237
3238
3239 private:
3240 void DoConnect(int winid,
3241 int lastId,
3242 wxEventType eventType,
3243 wxEventFunctor *func,
3244 wxObject* userData = NULL);
3245
3246 bool DoDisconnect(int winid,
3247 int lastId,
3248 wxEventType eventType,
3249 const wxEventFunctor& func,
3250 wxObject *userData = NULL);
3251
3252 static const wxEventTableEntry sm_eventTableEntries[];
3253
3254 protected:
3255 // hooks for wxWindow used by ProcessEvent()
3256 // -----------------------------------------
3257
3258 // This one is called before trying our own event table to allow plugging
3259 // in the validators.
3260 //
3261 // NB: This method is intentionally *not* inside wxUSE_VALIDATORS!
3262 // It is part of wxBase which doesn't use validators and the code
3263 // is compiled out when building wxBase w/o GUI classes, which affects
3264 // binary compatibility and wxBase library can't be used by GUI
3265 // ports.
3266 virtual bool TryValidator(wxEvent& WXUNUSED(event)) { return false; }
3267
3268 // this one is called after failing to find the event handle in our own
3269 // table to give a chance to the other windows to process it
3270 //
3271 // base class implementation passes the event to wxTheApp
3272 virtual bool TryParent(wxEvent& event);
3273
3274
3275 static const wxEventTable sm_eventTable;
3276 virtual const wxEventTable *GetEventTable() const;
3277
3278 static wxEventHashTable sm_eventHashTable;
3279 virtual wxEventHashTable& GetEventHashTable() const;
3280
3281 wxEvtHandler* m_nextHandler;
3282 wxEvtHandler* m_previousHandler;
3283 wxList* m_dynamicEvents;
3284 wxList* m_pendingEvents;
3285
3286 #if wxUSE_THREADS
3287 // critical section protecting m_pendingEvents
3288 wxCriticalSection m_pendingEventsLock;
3289 #endif // wxUSE_THREADS
3290
3291 // Is event handler enabled?
3292 bool m_enabled;
3293
3294
3295 // The user data: either an object which will be deleted by the container
3296 // when it's deleted or some raw pointer which we do nothing with - only
3297 // one type of data can be used with the given window (i.e. you cannot set
3298 // the void data and then associate the container with wxClientData or vice
3299 // versa)
3300 union
3301 {
3302 wxClientData *m_clientObject;
3303 void *m_clientData;
3304 };
3305
3306 // what kind of data do we have?
3307 wxClientDataType m_clientDataType;
3308
3309 // client data accessors
3310 virtual void DoSetClientObject( wxClientData *data );
3311 virtual wxClientData *DoGetClientObject() const;
3312
3313 virtual void DoSetClientData( void *data );
3314 virtual void *DoGetClientData() const;
3315
3316 // Search tracker objects for event connection with this sink
3317 wxEventConnectionRef *FindRefInTrackerList(wxEvtHandler *eventSink);
3318
3319 private:
3320 DECLARE_DYNAMIC_CLASS_NO_COPY(wxEvtHandler)
3321 };
3322
3323 WX_DEFINE_EXPORTED_ARRAY_PTR(wxEvtHandler*, wxEvtHandlerArray);
3324
3325 // ----------------------------------------------------------------------------
3326 // wxEventConnectionRef represents all connections between two event handlers
3327 // and enables automatic disconnect when an event handler sink goes out of
3328 // scope. Each connection/disconnect increases/decreases ref count, and
3329 // when it reaches zero the node goes out of scope.
3330 // ----------------------------------------------------------------------------
3331
3332 class wxEventConnectionRef : public wxTrackerNode
3333 {
3334 public:
3335 wxEventConnectionRef() : m_src(NULL), m_sink(NULL), m_refCount(0) { }
3336 wxEventConnectionRef(wxEvtHandler *src, wxEvtHandler *sink)
3337 : m_src(src), m_sink(sink), m_refCount(1)
3338 {
3339 m_sink->AddNode(this);
3340 }
3341
3342 // The sink is being destroyed
3343 virtual void OnObjectDestroy( )
3344 {
3345 if ( m_src )
3346 m_src->OnSinkDestroyed( m_sink );
3347 delete this;
3348 }
3349
3350 virtual wxEventConnectionRef *ToEventConnection() { return this; }
3351
3352 void IncRef() { m_refCount++; }
3353 void DecRef()
3354 {
3355 if ( !--m_refCount )
3356 {
3357 // The sink holds the only external pointer to this object
3358 if ( m_sink )
3359 m_sink->RemoveNode(this);
3360 delete this;
3361 }
3362 }
3363
3364 private:
3365 wxEvtHandler *m_src,
3366 *m_sink;
3367 int m_refCount;
3368
3369 friend class wxEvtHandler;
3370
3371 DECLARE_NO_ASSIGN_CLASS(wxEventConnectionRef)
3372 };
3373
3374 // Post a message to the given event handler which will be processed during the
3375 // next event loop iteration.
3376 //
3377 // Notice that this one is not thread-safe, use wxQueueEvent()
3378 inline void wxPostEvent(wxEvtHandler *dest, const wxEvent& event)
3379 {
3380 wxCHECK_RET( dest, "need an object to post event to" );
3381
3382 dest->AddPendingEvent(event);
3383 }
3384
3385 // Wrapper around wxEvtHandler::QueueEvent(): adds an event for later
3386 // processing, unlike wxPostEvent it is safe to use from different thread even
3387 // for events with wxString members
3388 inline void wxQueueEvent(wxEvtHandler *dest, wxEvent *event)
3389 {
3390 wxCHECK_RET( dest, "need an object to queue event for" );
3391
3392 dest->QueueEvent(event);
3393 }
3394
3395 typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&);
3396 typedef void (wxEvtHandler::*wxIdleEventFunction)(wxIdleEvent&);
3397
3398 #define wxEventHandler(func) \
3399 wxEVENT_HANDLER_CAST(wxEventFunction, func)
3400 #define wxIdleEventHandler(func) \
3401 wxEVENT_HANDLER_CAST(wxIdleEventFunction, func)
3402
3403 #if wxUSE_GUI
3404
3405 // ----------------------------------------------------------------------------
3406 // wxEventBlocker: helper class to temporarily disable event handling for a window
3407 // ----------------------------------------------------------------------------
3408
3409 class WXDLLIMPEXP_CORE wxEventBlocker : public wxEvtHandler
3410 {
3411 public:
3412 wxEventBlocker(wxWindow *win, wxEventType type = wxEVT_ANY);
3413 virtual ~wxEventBlocker();
3414
3415 void Block(wxEventType type)
3416 {
3417 m_eventsToBlock.push_back(type);
3418 }
3419
3420 virtual bool ProcessEvent(wxEvent& event);
3421
3422 protected:
3423 wxArrayInt m_eventsToBlock;
3424 wxWindow *m_window;
3425
3426 DECLARE_NO_COPY_CLASS(wxEventBlocker)
3427 };
3428
3429 typedef void (wxEvtHandler::*wxCommandEventFunction)(wxCommandEvent&);
3430 typedef void (wxEvtHandler::*wxThreadEventFunction)(wxThreadEvent&);
3431 typedef void (wxEvtHandler::*wxScrollEventFunction)(wxScrollEvent&);
3432 typedef void (wxEvtHandler::*wxScrollWinEventFunction)(wxScrollWinEvent&);
3433 typedef void (wxEvtHandler::*wxSizeEventFunction)(wxSizeEvent&);
3434 typedef void (wxEvtHandler::*wxMoveEventFunction)(wxMoveEvent&);
3435 typedef void (wxEvtHandler::*wxPaintEventFunction)(wxPaintEvent&);
3436 typedef void (wxEvtHandler::*wxNcPaintEventFunction)(wxNcPaintEvent&);
3437 typedef void (wxEvtHandler::*wxEraseEventFunction)(wxEraseEvent&);
3438 typedef void (wxEvtHandler::*wxMouseEventFunction)(wxMouseEvent&);
3439 typedef void (wxEvtHandler::*wxCharEventFunction)(wxKeyEvent&);
3440 typedef void (wxEvtHandler::*wxFocusEventFunction)(wxFocusEvent&);
3441 typedef void (wxEvtHandler::*wxChildFocusEventFunction)(wxChildFocusEvent&);
3442 typedef void (wxEvtHandler::*wxActivateEventFunction)(wxActivateEvent&);
3443 typedef void (wxEvtHandler::*wxMenuEventFunction)(wxMenuEvent&);
3444 typedef void (wxEvtHandler::*wxJoystickEventFunction)(wxJoystickEvent&);
3445 typedef void (wxEvtHandler::*wxDropFilesEventFunction)(wxDropFilesEvent&);
3446 typedef void (wxEvtHandler::*wxInitDialogEventFunction)(wxInitDialogEvent&);
3447 typedef void (wxEvtHandler::*wxSysColourChangedEventFunction)(wxSysColourChangedEvent&);
3448 typedef void (wxEvtHandler::*wxDisplayChangedEventFunction)(wxDisplayChangedEvent&);
3449 typedef void (wxEvtHandler::*wxUpdateUIEventFunction)(wxUpdateUIEvent&);
3450 typedef void (wxEvtHandler::*wxCloseEventFunction)(wxCloseEvent&);
3451 typedef void (wxEvtHandler::*wxShowEventFunction)(wxShowEvent&);
3452 typedef void (wxEvtHandler::*wxIconizeEventFunction)(wxIconizeEvent&);
3453 typedef void (wxEvtHandler::*wxMaximizeEventFunction)(wxMaximizeEvent&);
3454 typedef void (wxEvtHandler::*wxNavigationKeyEventFunction)(wxNavigationKeyEvent&);
3455 typedef void (wxEvtHandler::*wxPaletteChangedEventFunction)(wxPaletteChangedEvent&);
3456 typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction)(wxQueryNewPaletteEvent&);
3457 typedef void (wxEvtHandler::*wxWindowCreateEventFunction)(wxWindowCreateEvent&);
3458 typedef void (wxEvtHandler::*wxWindowDestroyEventFunction)(wxWindowDestroyEvent&);
3459 typedef void (wxEvtHandler::*wxSetCursorEventFunction)(wxSetCursorEvent&);
3460 typedef void (wxEvtHandler::*wxNotifyEventFunction)(wxNotifyEvent&);
3461 typedef void (wxEvtHandler::*wxHelpEventFunction)(wxHelpEvent&);
3462 typedef void (wxEvtHandler::*wxContextMenuEventFunction)(wxContextMenuEvent&);
3463 typedef void (wxEvtHandler::*wxMouseCaptureChangedEventFunction)(wxMouseCaptureChangedEvent&);
3464 typedef void (wxEvtHandler::*wxMouseCaptureLostEventFunction)(wxMouseCaptureLostEvent&);
3465 typedef void (wxEvtHandler::*wxClipboardTextEventFunction)(wxClipboardTextEvent&);
3466
3467
3468 #define wxCommandEventHandler(func) \
3469 wxEVENT_HANDLER_CAST(wxCommandEventFunction, func)
3470 #define wxThreadEventHandler(func) \
3471 wxEVENT_HANDLER_CAST(wxThreadEventFunction, func)
3472 #define wxScrollEventHandler(func) \
3473 wxEVENT_HANDLER_CAST(wxScrollEventFunction, func)
3474 #define wxScrollWinEventHandler(func) \
3475 wxEVENT_HANDLER_CAST(wxScrollWinEventFunction, func)
3476 #define wxSizeEventHandler(func) \
3477 wxEVENT_HANDLER_CAST(wxSizeEventFunction, func)
3478 #define wxMoveEventHandler(func) \
3479 wxEVENT_HANDLER_CAST(wxMoveEventFunction, func)
3480 #define wxPaintEventHandler(func) \
3481 wxEVENT_HANDLER_CAST(wxPaintEventFunction, func)
3482 #define wxNcPaintEventHandler(func) \
3483 wxEVENT_HANDLER_CAST(wxNcPaintEventFunction, func)
3484 #define wxEraseEventHandler(func) \
3485 wxEVENT_HANDLER_CAST(wxEraseEventFunction, func)
3486 #define wxMouseEventHandler(func) \
3487 wxEVENT_HANDLER_CAST(wxMouseEventFunction, func)
3488 #define wxCharEventHandler(func) \
3489 wxEVENT_HANDLER_CAST(wxCharEventFunction, func)
3490 #define wxKeyEventHandler(func) wxCharEventHandler(func)
3491 #define wxFocusEventHandler(func) \
3492 wxEVENT_HANDLER_CAST(wxFocusEventFunction, func)
3493 #define wxChildFocusEventHandler(func) \
3494 wxEVENT_HANDLER_CAST(wxChildFocusEventFunction, func)
3495 #define wxActivateEventHandler(func) \
3496 wxEVENT_HANDLER_CAST(wxActivateEventFunction, func)
3497 #define wxMenuEventHandler(func) \
3498 wxEVENT_HANDLER_CAST(wxMenuEventFunction, func)
3499 #define wxJoystickEventHandler(func) \
3500 wxEVENT_HANDLER_CAST(wxJoystickEventFunction, func)
3501 #define wxDropFilesEventHandler(func) \
3502 wxEVENT_HANDLER_CAST(wxDropFilesEventFunction, func)
3503 #define wxInitDialogEventHandler(func) \
3504 wxEVENT_HANDLER_CAST(wxInitDialogEventFunction, func)
3505 #define wxSysColourChangedEventHandler(func) \
3506 wxEVENT_HANDLER_CAST(wxSysColourChangedEventFunction, func)
3507 #define wxDisplayChangedEventHandler(func) \
3508 wxEVENT_HANDLER_CAST(wxDisplayChangedEventFunction, func)
3509 #define wxUpdateUIEventHandler(func) \
3510 wxEVENT_HANDLER_CAST(wxUpdateUIEventFunction, func)
3511 #define wxCloseEventHandler(func) \
3512 wxEVENT_HANDLER_CAST(wxCloseEventFunction, func)
3513 #define wxShowEventHandler(func) \
3514 wxEVENT_HANDLER_CAST(wxShowEventFunction, func)
3515 #define wxIconizeEventHandler(func) \
3516 wxEVENT_HANDLER_CAST(wxIconizeEventFunction, func)
3517 #define wxMaximizeEventHandler(func) \
3518 wxEVENT_HANDLER_CAST(wxMaximizeEventFunction, func)
3519 #define wxNavigationKeyEventHandler(func) \
3520 wxEVENT_HANDLER_CAST(wxNavigationKeyEventFunction, func)
3521 #define wxPaletteChangedEventHandler(func) \
3522 wxEVENT_HANDLER_CAST(wxPaletteChangedEventFunction, func)
3523 #define wxQueryNewPaletteEventHandler(func) \
3524 wxEVENT_HANDLER_CAST(wxQueryNewPaletteEventFunction, func)
3525 #define wxWindowCreateEventHandler(func) \
3526 wxEVENT_HANDLER_CAST(wxWindowCreateEventFunction, func)
3527 #define wxWindowDestroyEventHandler(func) \
3528 wxEVENT_HANDLER_CAST(wxWindowDestroyEventFunction, func)
3529 #define wxSetCursorEventHandler(func) \
3530 wxEVENT_HANDLER_CAST(wxSetCursorEventFunction, func)
3531 #define wxNotifyEventHandler(func) \
3532 wxEVENT_HANDLER_CAST(wxNotifyEventFunction, func)
3533 #define wxHelpEventHandler(func) \
3534 wxEVENT_HANDLER_CAST(wxHelpEventFunction, func)
3535 #define wxContextMenuEventHandler(func) \
3536 wxEVENT_HANDLER_CAST(wxContextMenuEventFunction, func)
3537 #define wxMouseCaptureChangedEventHandler(func) \
3538 wxEVENT_HANDLER_CAST(wxMouseCaptureChangedEventFunction, func)
3539 #define wxMouseCaptureLostEventHandler(func) \
3540 wxEVENT_HANDLER_CAST(wxMouseCaptureLostEventFunction, func)
3541 #define wxClipboardTextEventHandler(func) \
3542 wxEVENT_HANDLER_CAST(wxClipboardTextEventFunction, func)
3543
3544 #endif // wxUSE_GUI
3545
3546 // N.B. In GNU-WIN32, you *have* to take the address of a member function
3547 // (use &) or the compiler crashes...
3548
3549 #define DECLARE_EVENT_TABLE() \
3550 private: \
3551 static const wxEventTableEntry sm_eventTableEntries[]; \
3552 protected: \
3553 static const wxEventTable sm_eventTable; \
3554 virtual const wxEventTable* GetEventTable() const; \
3555 static wxEventHashTable sm_eventHashTable; \
3556 virtual wxEventHashTable& GetEventHashTable() const;
3557
3558 // N.B.: when building DLL with Borland C++ 5.5 compiler, you must initialize
3559 // sm_eventTable before using it in GetEventTable() or the compiler gives
3560 // E2233 (see http://groups.google.com/groups?selm=397dcc8a%241_2%40dnews)
3561
3562 #define BEGIN_EVENT_TABLE(theClass, baseClass) \
3563 const wxEventTable theClass::sm_eventTable = \
3564 { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] }; \
3565 const wxEventTable *theClass::GetEventTable() const \
3566 { return &theClass::sm_eventTable; } \
3567 wxEventHashTable theClass::sm_eventHashTable(theClass::sm_eventTable); \
3568 wxEventHashTable &theClass::GetEventHashTable() const \
3569 { return theClass::sm_eventHashTable; } \
3570 const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
3571
3572 #define BEGIN_EVENT_TABLE_TEMPLATE1(theClass, baseClass, T1) \
3573 template<typename T1> \
3574 const wxEventTable theClass<T1>::sm_eventTable = \
3575 { &baseClass::sm_eventTable, &theClass<T1>::sm_eventTableEntries[0] }; \
3576 template<typename T1> \
3577 const wxEventTable *theClass<T1>::GetEventTable() const \
3578 { return &theClass<T1>::sm_eventTable; } \
3579 template<typename T1> \
3580 wxEventHashTable theClass<T1>::sm_eventHashTable(theClass<T1>::sm_eventTable); \
3581 template<typename T1> \
3582 wxEventHashTable &theClass<T1>::GetEventHashTable() const \
3583 { return theClass<T1>::sm_eventHashTable; } \
3584 template<typename T1> \
3585 const wxEventTableEntry theClass<T1>::sm_eventTableEntries[] = { \
3586
3587 #define BEGIN_EVENT_TABLE_TEMPLATE2(theClass, baseClass, T1, T2) \
3588 template<typename T1, typename T2> \
3589 const wxEventTable theClass<T1, T2>::sm_eventTable = \
3590 { &baseClass::sm_eventTable, &theClass<T1, T2>::sm_eventTableEntries[0] }; \
3591 template<typename T1, typename T2> \
3592 const wxEventTable *theClass<T1, T2>::GetEventTable() const \
3593 { return &theClass<T1, T2>::sm_eventTable; } \
3594 template<typename T1, typename T2> \
3595 wxEventHashTable theClass<T1, T2>::sm_eventHashTable(theClass<T1, T2>::sm_eventTable); \
3596 template<typename T1, typename T2> \
3597 wxEventHashTable &theClass<T1, T2>::GetEventHashTable() const \
3598 { return theClass<T1, T2>::sm_eventHashTable; } \
3599 template<typename T1, typename T2> \
3600 const wxEventTableEntry theClass<T1, T2>::sm_eventTableEntries[] = { \
3601
3602 #define BEGIN_EVENT_TABLE_TEMPLATE3(theClass, baseClass, T1, T2, T3) \
3603 template<typename T1, typename T2, typename T3> \
3604 const wxEventTable theClass<T1, T2, T3>::sm_eventTable = \
3605 { &baseClass::sm_eventTable, &theClass<T1, T2, T3>::sm_eventTableEntries[0] }; \
3606 template<typename T1, typename T2, typename T3> \
3607 const wxEventTable *theClass<T1, T2, T3>::GetEventTable() const \
3608 { return &theClass<T1, T2, T3>::sm_eventTable; } \
3609 template<typename T1, typename T2, typename T3> \
3610 wxEventHashTable theClass<T1, T2, T3>::sm_eventHashTable(theClass<T1, T2, T3>::sm_eventTable); \
3611 template<typename T1, typename T2, typename T3> \
3612 wxEventHashTable &theClass<T1, T2, T3>::GetEventHashTable() const \
3613 { return theClass<T1, T2, T3>::sm_eventHashTable; } \
3614 template<typename T1, typename T2, typename T3> \
3615 const wxEventTableEntry theClass<T1, T2, T3>::sm_eventTableEntries[] = { \
3616
3617 #define BEGIN_EVENT_TABLE_TEMPLATE4(theClass, baseClass, T1, T2, T3, T4) \
3618 template<typename T1, typename T2, typename T3, typename T4> \
3619 const wxEventTable theClass<T1, T2, T3, T4>::sm_eventTable = \
3620 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4>::sm_eventTableEntries[0] }; \
3621 template<typename T1, typename T2, typename T3, typename T4> \
3622 const wxEventTable *theClass<T1, T2, T3, T4>::GetEventTable() const \
3623 { return &theClass<T1, T2, T3, T4>::sm_eventTable; } \
3624 template<typename T1, typename T2, typename T3, typename T4> \
3625 wxEventHashTable theClass<T1, T2, T3, T4>::sm_eventHashTable(theClass<T1, T2, T3, T4>::sm_eventTable); \
3626 template<typename T1, typename T2, typename T3, typename T4> \
3627 wxEventHashTable &theClass<T1, T2, T3, T4>::GetEventHashTable() const \
3628 { return theClass<T1, T2, T3, T4>::sm_eventHashTable; } \
3629 template<typename T1, typename T2, typename T3, typename T4> \
3630 const wxEventTableEntry theClass<T1, T2, T3, T4>::sm_eventTableEntries[] = { \
3631
3632 #define BEGIN_EVENT_TABLE_TEMPLATE5(theClass, baseClass, T1, T2, T3, T4, T5) \
3633 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3634 const wxEventTable theClass<T1, T2, T3, T4, T5>::sm_eventTable = \
3635 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[0] }; \
3636 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3637 const wxEventTable *theClass<T1, T2, T3, T4, T5>::GetEventTable() const \
3638 { return &theClass<T1, T2, T3, T4, T5>::sm_eventTable; } \
3639 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3640 wxEventHashTable theClass<T1, T2, T3, T4, T5>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5>::sm_eventTable); \
3641 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3642 wxEventHashTable &theClass<T1, T2, T3, T4, T5>::GetEventHashTable() const \
3643 { return theClass<T1, T2, T3, T4, T5>::sm_eventHashTable; } \
3644 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3645 const wxEventTableEntry theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[] = { \
3646
3647 #define BEGIN_EVENT_TABLE_TEMPLATE7(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7) \
3648 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3649 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable = \
3650 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[0] }; \
3651 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3652 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventTable() const \
3653 { return &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable; } \
3654 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3655 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable); \
3656 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3657 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventHashTable() const \
3658 { return theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable; } \
3659 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3660 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[] = { \
3661
3662 #define BEGIN_EVENT_TABLE_TEMPLATE8(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7, T8) \
3663 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3664 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable = \
3665 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[0] }; \
3666 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3667 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventTable() const \
3668 { return &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable; } \
3669 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3670 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable); \
3671 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3672 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventHashTable() const \
3673 { return theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable; } \
3674 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3675 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[] = { \
3676
3677 #define END_EVENT_TABLE() DECLARE_EVENT_TABLE_TERMINATOR() };
3678
3679 /*
3680 * Event table macros
3681 */
3682
3683 // helpers for writing shorter code below: declare an event macro taking 2, 1
3684 // or none ids (the missing ids default to wxID_ANY)
3685 //
3686 // macro arguments:
3687 // - evt one of wxEVT_XXX constants
3688 // - id1, id2 ids of the first/last id
3689 // - fn the function (should be cast to the right type)
3690 #define wx__DECLARE_EVT2(evt, id1, id2, fn) \
3691 DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
3692 #define wx__DECLARE_EVT1(evt, id, fn) \
3693 wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
3694 #define wx__DECLARE_EVT0(evt, fn) \
3695 wx__DECLARE_EVT1(evt, wxID_ANY, fn)
3696
3697
3698 // Generic events
3699 #define EVT_CUSTOM(event, winid, func) \
3700 wx__DECLARE_EVT1(event, winid, wxEventHandler(func))
3701 #define EVT_CUSTOM_RANGE(event, id1, id2, func) \
3702 wx__DECLARE_EVT2(event, id1, id2, wxEventHandler(func))
3703
3704 // EVT_COMMAND
3705 #define EVT_COMMAND(winid, event, func) \
3706 wx__DECLARE_EVT1(event, winid, wxCommandEventHandler(func))
3707
3708 #define EVT_COMMAND_RANGE(id1, id2, event, func) \
3709 wx__DECLARE_EVT2(event, id1, id2, wxCommandEventHandler(func))
3710
3711 #define EVT_NOTIFY(event, winid, func) \
3712 wx__DECLARE_EVT1(event, winid, wxNotifyEventHandler(func))
3713
3714 #define EVT_NOTIFY_RANGE(event, id1, id2, func) \
3715 wx__DECLARE_EVT2(event, id1, id2, wxNotifyEventHandler(func))
3716
3717 // Miscellaneous
3718 #define EVT_SIZE(func) wx__DECLARE_EVT0(wxEVT_SIZE, wxSizeEventHandler(func))
3719 #define EVT_SIZING(func) wx__DECLARE_EVT0(wxEVT_SIZING, wxSizeEventHandler(func))
3720 #define EVT_MOVE(func) wx__DECLARE_EVT0(wxEVT_MOVE, wxMoveEventHandler(func))
3721 #define EVT_MOVING(func) wx__DECLARE_EVT0(wxEVT_MOVING, wxMoveEventHandler(func))
3722 #define EVT_MOVE_START(func) wx__DECLARE_EVT0(wxEVT_MOVE_START, wxMoveEventHandler(func))
3723 #define EVT_MOVE_END(func) wx__DECLARE_EVT0(wxEVT_MOVE_END, wxMoveEventHandler(func))
3724 #define EVT_CLOSE(func) wx__DECLARE_EVT0(wxEVT_CLOSE_WINDOW, wxCloseEventHandler(func))
3725 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3726 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3727 #define EVT_PAINT(func) wx__DECLARE_EVT0(wxEVT_PAINT, wxPaintEventHandler(func))
3728 #define EVT_NC_PAINT(func) wx__DECLARE_EVT0(wxEVT_NC_PAINT, wxNcPaintEventHandler(func))
3729 #define EVT_ERASE_BACKGROUND(func) wx__DECLARE_EVT0(wxEVT_ERASE_BACKGROUND, wxEraseEventHandler(func))
3730 #define EVT_CHAR(func) wx__DECLARE_EVT0(wxEVT_CHAR, wxCharEventHandler(func))
3731 #define EVT_KEY_DOWN(func) wx__DECLARE_EVT0(wxEVT_KEY_DOWN, wxKeyEventHandler(func))
3732 #define EVT_KEY_UP(func) wx__DECLARE_EVT0(wxEVT_KEY_UP, wxKeyEventHandler(func))
3733 #if wxUSE_HOTKEY
3734 #define EVT_HOTKEY(winid, func) wx__DECLARE_EVT1(wxEVT_HOTKEY, winid, wxCharEventHandler(func))
3735 #endif
3736 #define EVT_CHAR_HOOK(func) wx__DECLARE_EVT0(wxEVT_CHAR_HOOK, wxCharEventHandler(func))
3737 #define EVT_MENU_OPEN(func) wx__DECLARE_EVT0(wxEVT_MENU_OPEN, wxMenuEventHandler(func))
3738 #define EVT_MENU_CLOSE(func) wx__DECLARE_EVT0(wxEVT_MENU_CLOSE, wxMenuEventHandler(func))
3739 #define EVT_MENU_HIGHLIGHT(winid, func) wx__DECLARE_EVT1(wxEVT_MENU_HIGHLIGHT, winid, wxMenuEventHandler(func))
3740 #define EVT_MENU_HIGHLIGHT_ALL(func) wx__DECLARE_EVT0(wxEVT_MENU_HIGHLIGHT, wxMenuEventHandler(func))
3741 #define EVT_SET_FOCUS(func) wx__DECLARE_EVT0(wxEVT_SET_FOCUS, wxFocusEventHandler(func))
3742 #define EVT_KILL_FOCUS(func) wx__DECLARE_EVT0(wxEVT_KILL_FOCUS, wxFocusEventHandler(func))
3743 #define EVT_CHILD_FOCUS(func) wx__DECLARE_EVT0(wxEVT_CHILD_FOCUS, wxChildFocusEventHandler(func))
3744 #define EVT_ACTIVATE(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE, wxActivateEventHandler(func))
3745 #define EVT_ACTIVATE_APP(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE_APP, wxActivateEventHandler(func))
3746 #define EVT_HIBERNATE(func) wx__DECLARE_EVT0(wxEVT_HIBERNATE, wxActivateEventHandler(func))
3747 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3748 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3749 #define EVT_DROP_FILES(func) wx__DECLARE_EVT0(wxEVT_DROP_FILES, wxDropFilesEventHandler(func))
3750 #define EVT_INIT_DIALOG(func) wx__DECLARE_EVT0(wxEVT_INIT_DIALOG, wxInitDialogEventHandler(func))
3751 #define EVT_SYS_COLOUR_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEventHandler(func))
3752 #define EVT_DISPLAY_CHANGED(func) wx__DECLARE_EVT0(wxEVT_DISPLAY_CHANGED, wxDisplayChangedEventHandler(func))
3753 #define EVT_SHOW(func) wx__DECLARE_EVT0(wxEVT_SHOW, wxShowEventHandler(func))
3754 #define EVT_MAXIMIZE(func) wx__DECLARE_EVT0(wxEVT_MAXIMIZE, wxMaximizeEventHandler(func))
3755 #define EVT_ICONIZE(func) wx__DECLARE_EVT0(wxEVT_ICONIZE, wxIconizeEventHandler(func))
3756 #define EVT_NAVIGATION_KEY(func) wx__DECLARE_EVT0(wxEVT_NAVIGATION_KEY, wxNavigationKeyEventHandler(func))
3757 #define EVT_PALETTE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_PALETTE_CHANGED, wxPaletteChangedEventHandler(func))
3758 #define EVT_QUERY_NEW_PALETTE(func) wx__DECLARE_EVT0(wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEventHandler(func))
3759 #define EVT_WINDOW_CREATE(func) wx__DECLARE_EVT0(wxEVT_CREATE, wxWindowCreateEventHandler(func))
3760 #define EVT_WINDOW_DESTROY(func) wx__DECLARE_EVT0(wxEVT_DESTROY, wxWindowDestroyEventHandler(func))
3761 #define EVT_SET_CURSOR(func) wx__DECLARE_EVT0(wxEVT_SET_CURSOR, wxSetCursorEventHandler(func))
3762 #define EVT_MOUSE_CAPTURE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEventHandler(func))
3763 #define EVT_MOUSE_CAPTURE_LOST(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEventHandler(func))
3764
3765 // Mouse events
3766 #define EVT_LEFT_DOWN(func) wx__DECLARE_EVT0(wxEVT_LEFT_DOWN, wxMouseEventHandler(func))
3767 #define EVT_LEFT_UP(func) wx__DECLARE_EVT0(wxEVT_LEFT_UP, wxMouseEventHandler(func))
3768 #define EVT_MIDDLE_DOWN(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DOWN, wxMouseEventHandler(func))
3769 #define EVT_MIDDLE_UP(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_UP, wxMouseEventHandler(func))
3770 #define EVT_RIGHT_DOWN(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DOWN, wxMouseEventHandler(func))
3771 #define EVT_RIGHT_UP(func) wx__DECLARE_EVT0(wxEVT_RIGHT_UP, wxMouseEventHandler(func))
3772 #define EVT_MOTION(func) wx__DECLARE_EVT0(wxEVT_MOTION, wxMouseEventHandler(func))
3773 #define EVT_LEFT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_LEFT_DCLICK, wxMouseEventHandler(func))
3774 #define EVT_MIDDLE_DCLICK(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DCLICK, wxMouseEventHandler(func))
3775 #define EVT_RIGHT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DCLICK, wxMouseEventHandler(func))
3776 #define EVT_LEAVE_WINDOW(func) wx__DECLARE_EVT0(wxEVT_LEAVE_WINDOW, wxMouseEventHandler(func))
3777 #define EVT_ENTER_WINDOW(func) wx__DECLARE_EVT0(wxEVT_ENTER_WINDOW, wxMouseEventHandler(func))
3778 #define EVT_MOUSEWHEEL(func) wx__DECLARE_EVT0(wxEVT_MOUSEWHEEL, wxMouseEventHandler(func))
3779 #define EVT_MOUSE_AUX1_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX1_DOWN, wxMouseEventHandler(func))
3780 #define EVT_MOUSE_AUX1_UP(func) wx__DECLARE_EVT0(wxEVT_AUX1_UP, wxMouseEventHandler(func))
3781 #define EVT_MOUSE_AUX1_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX1_DCLICK, wxMouseEventHandler(func))
3782 #define EVT_MOUSE_AUX2_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX2_DOWN, wxMouseEventHandler(func))
3783 #define EVT_MOUSE_AUX2_UP(func) wx__DECLARE_EVT0(wxEVT_AUX2_UP, wxMouseEventHandler(func))
3784 #define EVT_MOUSE_AUX2_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX2_DCLICK, wxMouseEventHandler(func))
3785
3786 // All mouse events
3787 #define EVT_MOUSE_EVENTS(func) \
3788 EVT_LEFT_DOWN(func) \
3789 EVT_LEFT_UP(func) \
3790 EVT_LEFT_DCLICK(func) \
3791 EVT_MIDDLE_DOWN(func) \
3792 EVT_MIDDLE_UP(func) \
3793 EVT_MIDDLE_DCLICK(func) \
3794 EVT_RIGHT_DOWN(func) \
3795 EVT_RIGHT_UP(func) \
3796 EVT_RIGHT_DCLICK(func) \
3797 EVT_MOUSE_AUX1_DOWN(func) \
3798 EVT_MOUSE_AUX1_UP(func) \
3799 EVT_MOUSE_AUX1_DCLICK(func) \
3800 EVT_MOUSE_AUX2_DOWN(func) \
3801 EVT_MOUSE_AUX2_UP(func) \
3802 EVT_MOUSE_AUX2_DCLICK(func) \
3803 EVT_MOTION(func) \
3804 EVT_LEAVE_WINDOW(func) \
3805 EVT_ENTER_WINDOW(func) \
3806 EVT_MOUSEWHEEL(func)
3807
3808 // Scrolling from wxWindow (sent to wxScrolledWindow)
3809 #define EVT_SCROLLWIN_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_TOP, wxScrollWinEventHandler(func))
3810 #define EVT_SCROLLWIN_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEventHandler(func))
3811 #define EVT_SCROLLWIN_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEUP, wxScrollWinEventHandler(func))
3812 #define EVT_SCROLLWIN_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEventHandler(func))
3813 #define EVT_SCROLLWIN_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEventHandler(func))
3814 #define EVT_SCROLLWIN_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEventHandler(func))
3815 #define EVT_SCROLLWIN_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEventHandler(func))
3816 #define EVT_SCROLLWIN_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEventHandler(func))
3817
3818 #define EVT_SCROLLWIN(func) \
3819 EVT_SCROLLWIN_TOP(func) \
3820 EVT_SCROLLWIN_BOTTOM(func) \
3821 EVT_SCROLLWIN_LINEUP(func) \
3822 EVT_SCROLLWIN_LINEDOWN(func) \
3823 EVT_SCROLLWIN_PAGEUP(func) \
3824 EVT_SCROLLWIN_PAGEDOWN(func) \
3825 EVT_SCROLLWIN_THUMBTRACK(func) \
3826 EVT_SCROLLWIN_THUMBRELEASE(func)
3827
3828 // Scrolling from wxSlider and wxScrollBar
3829 #define EVT_SCROLL_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_TOP, wxScrollEventHandler(func))
3830 #define EVT_SCROLL_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLL_BOTTOM, wxScrollEventHandler(func))
3831 #define EVT_SCROLL_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEUP, wxScrollEventHandler(func))
3832 #define EVT_SCROLL_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEDOWN, wxScrollEventHandler(func))
3833 #define EVT_SCROLL_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEUP, wxScrollEventHandler(func))
3834 #define EVT_SCROLL_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler(func))
3835 #define EVT_SCROLL_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler(func))
3836 #define EVT_SCROLL_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBRELEASE, wxScrollEventHandler(func))
3837 #define EVT_SCROLL_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SCROLL_CHANGED, wxScrollEventHandler(func))
3838
3839 #define EVT_SCROLL(func) \
3840 EVT_SCROLL_TOP(func) \
3841 EVT_SCROLL_BOTTOM(func) \
3842 EVT_SCROLL_LINEUP(func) \
3843 EVT_SCROLL_LINEDOWN(func) \
3844 EVT_SCROLL_PAGEUP(func) \
3845 EVT_SCROLL_PAGEDOWN(func) \
3846 EVT_SCROLL_THUMBTRACK(func) \
3847 EVT_SCROLL_THUMBRELEASE(func) \
3848 EVT_SCROLL_CHANGED(func)
3849
3850 // Scrolling from wxSlider and wxScrollBar, with an id
3851 #define EVT_COMMAND_SCROLL_TOP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_TOP, winid, wxScrollEventHandler(func))
3852 #define EVT_COMMAND_SCROLL_BOTTOM(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_BOTTOM, winid, wxScrollEventHandler(func))
3853 #define EVT_COMMAND_SCROLL_LINEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEUP, winid, wxScrollEventHandler(func))
3854 #define EVT_COMMAND_SCROLL_LINEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEDOWN, winid, wxScrollEventHandler(func))
3855 #define EVT_COMMAND_SCROLL_PAGEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEUP, winid, wxScrollEventHandler(func))
3856 #define EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEDOWN, winid, wxScrollEventHandler(func))
3857 #define EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBTRACK, winid, wxScrollEventHandler(func))
3858 #define EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBRELEASE, winid, wxScrollEventHandler(func))
3859 #define EVT_COMMAND_SCROLL_CHANGED(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_CHANGED, winid, wxScrollEventHandler(func))
3860
3861 #define EVT_COMMAND_SCROLL(winid, func) \
3862 EVT_COMMAND_SCROLL_TOP(winid, func) \
3863 EVT_COMMAND_SCROLL_BOTTOM(winid, func) \
3864 EVT_COMMAND_SCROLL_LINEUP(winid, func) \
3865 EVT_COMMAND_SCROLL_LINEDOWN(winid, func) \
3866 EVT_COMMAND_SCROLL_PAGEUP(winid, func) \
3867 EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) \
3868 EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) \
3869 EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) \
3870 EVT_COMMAND_SCROLL_CHANGED(winid, func)
3871
3872 #if WXWIN_COMPATIBILITY_2_6
3873 // compatibility macros for the old name, deprecated in 2.8
3874 #define wxEVT_SCROLL_ENDSCROLL wxEVT_SCROLL_CHANGED
3875 #define EVT_COMMAND_SCROLL_ENDSCROLL EVT_COMMAND_SCROLL_CHANGED
3876 #define EVT_SCROLL_ENDSCROLL EVT_SCROLL_CHANGED
3877 #endif // WXWIN_COMPATIBILITY_2_6
3878
3879 // Convenience macros for commonly-used commands
3880 #define EVT_CHECKBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKBOX_CLICKED, winid, wxCommandEventHandler(func))
3881 #define EVT_CHOICE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHOICE_SELECTED, winid, wxCommandEventHandler(func))
3882 #define EVT_LISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_SELECTED, winid, wxCommandEventHandler(func))
3883 #define EVT_LISTBOX_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, winid, wxCommandEventHandler(func))
3884 #define EVT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_MENU_SELECTED, winid, wxCommandEventHandler(func))
3885 #define EVT_MENU_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_MENU_SELECTED, id1, id2, wxCommandEventHandler(func))
3886 #if defined(__SMARTPHONE__)
3887 # define EVT_BUTTON(winid, func) EVT_MENU(winid, func)
3888 #else
3889 # define EVT_BUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_BUTTON_CLICKED, winid, wxCommandEventHandler(func))
3890 #endif
3891 #define EVT_SLIDER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SLIDER_UPDATED, winid, wxCommandEventHandler(func))
3892 #define EVT_RADIOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBOX_SELECTED, winid, wxCommandEventHandler(func))
3893 #define EVT_RADIOBUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBUTTON_SELECTED, winid, wxCommandEventHandler(func))
3894 // EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events
3895 #define EVT_SCROLLBAR(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SCROLLBAR_UPDATED, winid, wxCommandEventHandler(func))
3896 #define EVT_VLBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_VLBOX_SELECTED, winid, wxCommandEventHandler(func))
3897 #define EVT_COMBOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_SELECTED, winid, wxCommandEventHandler(func))
3898 #define EVT_TOOL(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_CLICKED, winid, wxCommandEventHandler(func))
3899 #define EVT_TOOL_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, winid, wxCommandEventHandler(func))
3900 #define EVT_TOOL_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_CLICKED, id1, id2, wxCommandEventHandler(func))
3901 #define EVT_TOOL_RCLICKED(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_RCLICKED, winid, wxCommandEventHandler(func))
3902 #define EVT_TOOL_RCLICKED_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, wxCommandEventHandler(func))
3903 #define EVT_TOOL_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_ENTER, winid, wxCommandEventHandler(func))
3904 #define EVT_CHECKLISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, winid, wxCommandEventHandler(func))
3905
3906 // Generic command events
3907 #define EVT_COMMAND_LEFT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_CLICK, winid, wxCommandEventHandler(func))
3908 #define EVT_COMMAND_LEFT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_DCLICK, winid, wxCommandEventHandler(func))
3909 #define EVT_COMMAND_RIGHT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_CLICK, winid, wxCommandEventHandler(func))
3910 #define EVT_COMMAND_RIGHT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_DCLICK, winid, wxCommandEventHandler(func))
3911 #define EVT_COMMAND_SET_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SET_FOCUS, winid, wxCommandEventHandler(func))
3912 #define EVT_COMMAND_KILL_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_KILL_FOCUS, winid, wxCommandEventHandler(func))
3913 #define EVT_COMMAND_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_ENTER, winid, wxCommandEventHandler(func))
3914
3915 // Joystick events
3916
3917 #define EVT_JOY_BUTTON_DOWN(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_DOWN, wxJoystickEventHandler(func))
3918 #define EVT_JOY_BUTTON_UP(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_UP, wxJoystickEventHandler(func))
3919 #define EVT_JOY_MOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_MOVE, wxJoystickEventHandler(func))
3920 #define EVT_JOY_ZMOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_ZMOVE, wxJoystickEventHandler(func))
3921
3922 // All joystick events
3923 #define EVT_JOYSTICK_EVENTS(func) \
3924 EVT_JOY_BUTTON_DOWN(func) \
3925 EVT_JOY_BUTTON_UP(func) \
3926 EVT_JOY_MOVE(func) \
3927 EVT_JOY_ZMOVE(func)
3928
3929 // Idle event
3930 #define EVT_IDLE(func) wx__DECLARE_EVT0(wxEVT_IDLE, wxIdleEventHandler(func))
3931
3932 // Update UI event
3933 #define EVT_UPDATE_UI(winid, func) wx__DECLARE_EVT1(wxEVT_UPDATE_UI, winid, wxUpdateUIEventHandler(func))
3934 #define EVT_UPDATE_UI_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_UPDATE_UI, id1, id2, wxUpdateUIEventHandler(func))
3935
3936 // Help events
3937 #define EVT_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_HELP, winid, wxHelpEventHandler(func))
3938 #define EVT_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_HELP, id1, id2, wxHelpEventHandler(func))
3939 #define EVT_DETAILED_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_DETAILED_HELP, winid, wxHelpEventHandler(func))
3940 #define EVT_DETAILED_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_DETAILED_HELP, id1, id2, wxHelpEventHandler(func))
3941
3942 // Context Menu Events
3943 #define EVT_CONTEXT_MENU(func) wx__DECLARE_EVT0(wxEVT_CONTEXT_MENU, wxContextMenuEventHandler(func))
3944 #define EVT_COMMAND_CONTEXT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_CONTEXT_MENU, winid, wxContextMenuEventHandler(func))
3945
3946 // Clipboard text Events
3947 #define EVT_TEXT_CUT(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_CUT, winid, wxClipboardTextEventHandler(func))
3948 #define EVT_TEXT_COPY(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_COPY, winid, wxClipboardTextEventHandler(func))
3949 #define EVT_TEXT_PASTE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_PASTE, winid, wxClipboardTextEventHandler(func))
3950
3951 // Thread events
3952 #define EVT_THREAD(id, func) wx__DECLARE_EVT1(wxEVT_COMMAND_THREAD, id, wxThreadEventHandler(func))
3953
3954 // ----------------------------------------------------------------------------
3955 // Global data
3956 // ----------------------------------------------------------------------------
3957
3958 // list containing event handlers with pending events for them
3959 //
3960 // notice that each event handler should occur at most once in this list
3961 extern WXDLLIMPEXP_BASE wxList *wxHandlersWithPendingEvents;
3962 extern WXDLLIMPEXP_BASE wxList *wxHandlersWithPendingDelayedEvents;
3963 #if wxUSE_THREADS
3964 // this critical section protectes both the lists above
3965 extern WXDLLIMPEXP_BASE wxCriticalSection *wxHandlersWithPendingEventsLocker;
3966 #endif
3967
3968 // old list names:
3969 #define wxPendingEvents wxHandlersWithPendingEvents
3970 #define wxPendingEventsLocker wxHandlersWithPendingEventsLocker
3971
3972 // ----------------------------------------------------------------------------
3973 // Helper functions
3974 // ----------------------------------------------------------------------------
3975
3976 #if wxUSE_GUI
3977
3978 // Find a window with the focus, that is also a descendant of the given window.
3979 // This is used to determine the window to initially send commands to.
3980 WXDLLIMPEXP_CORE wxWindow* wxFindFocusDescendant(wxWindow* ancestor);
3981
3982 #endif // wxUSE_GUI
3983
3984 #endif // _WX_EVENT_H_