1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Event classes
4 // Author: Julian Smart
8 // Copyright: (c) wxWidgets team
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
17 #include "wx/object.h"
18 #include "wx/clntdata.h"
21 #include "wx/gdicmn.h"
22 #include "wx/cursor.h"
23 #include "wx/mousestate.h"
26 #include "wx/dynarray.h"
27 #include "wx/thread.h"
28 #include "wx/tracker.h"
30 #if !wxEVENTS_COMPATIBILITY_2_8
31 #include "wx/meta/convertible.h"
34 // ----------------------------------------------------------------------------
35 // forward declarations
36 // ----------------------------------------------------------------------------
38 class WXDLLIMPEXP_FWD_BASE wxList
;
39 class WXDLLIMPEXP_FWD_BASE wxEvent
;
41 class WXDLLIMPEXP_FWD_CORE wxDC
;
42 class WXDLLIMPEXP_FWD_CORE wxMenu
;
43 class WXDLLIMPEXP_FWD_CORE wxWindow
;
44 class WXDLLIMPEXP_FWD_CORE wxWindowBase
;
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
59 #define wxMSVC_FWD_MULTIPLE_BASES __multiple_inheritance
61 #define wxMSVC_FWD_MULTIPLE_BASES
64 class WXDLLIMPEXP_FWD_BASE wxMSVC_FWD_MULTIPLE_BASES wxEvtHandler
;
65 class wxEventConnectionRef
;
67 // ----------------------------------------------------------------------------
69 // ----------------------------------------------------------------------------
71 typedef int wxEventType
;
73 #define wxEVT_ANY ((wxEventType)-1)
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)
80 #define DECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj) \
81 wxEventTableEntry(type, winid, idLast, wxNewEventFunctor(type, fn), obj)
83 #define DECLARE_EVENT_TABLE_TERMINATOR() \
84 wxEventTableEntry(wxEVT_NULL, 0, 0, 0, 0)
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)
99 // generate a new unique event type
100 extern WXDLLIMPEXP_BASE wxEventType
wxNewEventType();
102 // New macros to create templatized event types:
104 #if wxEVENTS_COMPATIBILITY_2_8
106 // Define/Declare a wxEventType-based event type:
108 #define wxDEFINE_EVENT( name, type ) \
109 const wxEventType name( wxNewEventType() )
111 #define wxDECLARE_EXPORTED_EVENT( expdecl, name, type ) \
112 extern const expdecl wxEventType name
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
118 #define wxDEFINE_EVENT_ALIAS( name, type, value ) \
119 const wxEventType name = value
121 #define wxDECLARE_EXPORTED_EVENT_ALIAS( expdecl, name, type ) \
122 extern const expdecl wxEventType name
124 // Declare a local (not exported) wxEventType-based event type:
126 #define wxDECLARE_EVENT( name, type ) \
127 wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type );
129 // Try to cast the given event handler to the correct handler type:
131 #define wxEVENT_HANDLER_CAST( functype, func ) \
132 ( wxObjectEventFunction )( wxEventFunction )wxStaticCastEvent( functype, &func )
134 // Define/Declare a templatized event type with the corresponding event as
137 #define wxDEFINE_EVENT( name, type ) \
138 const wxEventTypeTag< type > name( wxNewEventType() )
140 #define wxDECLARE_EXPORTED_EVENT( expdecl, name, type ) \
141 extern const expdecl wxEventTypeTag< type > name
143 // Define/Declare a templatized event type and initialize it with a
144 // predefined event type. (Only used for wxEVT_SPIN_XXX for backward
147 #define wxDEFINE_EVENT_ALIAS( name, type, value ) \
148 const wxEventTypeTag< type > name( value )
150 #define wxDECLARE_EXPORTED_EVENT_ALIAS( expdecl, name, type ) \
151 extern const expdecl wxEventTypeTag< type > name
153 // Declare a local (not exported) templatized event type:
155 #define wxDECLARE_EVENT( name, type ) \
156 wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type );
158 // Don't cast the given event handler so that wxEvtHandler::Connect() sees
161 #define wxEVENT_HANDLER_CAST( functype, func ) \
165 // Template which associates the correct event object with the event type
167 #if !wxEVENTS_COMPATIBILITY_2_8
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
>
177 // The class of wxEvent-derived class carried by the events of this type.
178 typedef T EventClass
;
180 wxEventTypeTag(wxEventType type
) { m_type
= type
; }
182 // Return a wxEventType reference for the initialization of the static
183 // event tables. See wxEventTableEntry::m_eventType for a more thorough
185 operator const wxEventType
&() const { return m_type
; }
191 #endif // !wxEVENTS_COMPATIBILITY_2_8
193 // These are needed for the functor definitions
194 typedef void (wxEvtHandler::*wxEventFunction
)(wxEvent
&);
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
;
206 // The event functor which is stored in the static and dynamic event tables:
207 class WXDLLIMPEXP_BASE wxEventFunctor
210 virtual ~wxEventFunctor();
212 // Invoke the actual event handler:
213 virtual void operator()(wxEvtHandler
*, wxEvent
&) = 0;
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;
219 // these functions are used for functors comparison in Matches()
220 virtual void *GetHandler() const { return GetEvtHandler(); }
221 virtual wxEventFunction
GetMethod() const { return NULL
; }
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
; }
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
231 class WXDLLIMPEXP_BASE wxObjectEventFunctor
: public wxEventFunctor
234 wxObjectEventFunctor(wxObjectEventFunction method
, wxEvtHandler
*handler
)
240 virtual void operator()(wxEvtHandler
*handler
, wxEvent
& event
)
242 wxEvtHandler
* const realHandler
= m_handler
? m_handler
: handler
;
244 (realHandler
->*m_method
)(event
);
247 virtual bool Matches(const wxEventFunctor
& func
) const
249 void * const handler
= func
.GetHandler();
250 if ( handler
&& GetHandler() != handler
)
253 const wxEventFunction method
= GetMethod();
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
;
260 virtual wxEvtHandler
*GetEvtHandler() const { return m_handler
; }
261 virtual wxEventFunction
GetMethod() const { return m_method
; }
264 wxEvtHandler
*m_handler
;
265 wxEventFunction m_method
;
268 #if wxEVENTS_COMPATIBILITY_2_8
270 // Create a functor for the legacy events: handler can be NULL and its default
271 // value is used by the event table macros
273 inline wxObjectEventFunctor
*
274 wxNewEventFunctor(const wxEventType
& WXUNUSED(evtType
),
275 wxObjectEventFunction method
,
276 wxEvtHandler
*handler
= NULL
)
278 return new wxObjectEventFunctor(method
, handler
);
281 inline wxObjectEventFunctor
282 wxMakeEventFunctor(const wxEventType
& WXUNUSED(evtType
),
283 wxObjectEventFunction method
,
284 wxEvtHandler
*handler
)
286 return wxObjectEventFunctor(method
, handler
);
289 #else // !wxEVENTS_COMPATIBILITY_2_8
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
297 typedef typename
EventTag::EventClass EventArg
;
299 wxEventFunctorFunction(Functor handler
)
304 virtual void operator()(wxEvtHandler
*WXUNUSED(handler
), wxEvent
& event
)
306 m_handler(static_cast<EventArg
&>(event
));
309 virtual bool Matches(const wxEventFunctor
& WXUNUSED(func
)) const
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
327 // helper template defining nested "type" typedef as the event class
328 // corresponding to the given event type
329 template <typename T
> struct EventClassOf
;
331 // the typed events provide the information about the class of the events they
333 template <typename T
>
334 struct EventClassOf
< wxEventTypeTag
<T
> >
336 typedef typename wxEventTypeTag
<T
>::EventClass type
;
339 // for the old untyped events we don't have information about the exact event
340 // class carried by them
342 struct EventClassOf
<wxEventType
>
344 typedef wxEvent type
;
348 // helper class defining operations different for method functors using an
349 // object of wxEvtHandler-derived class as handler and the others
350 template <typename T
, typename A
, bool> struct HandlerImpl
;
352 // specialization for handlers deriving from wxEvtHandler
353 template <typename T
, typename A
>
354 struct HandlerImpl
<T
, A
, true>
356 static bool IsEvtHandler()
358 static T
*ConvertFromEvtHandler(wxEvtHandler
*p
)
359 { return static_cast<T
*>(p
); }
360 static wxEvtHandler
*ConvertToEvtHandler(T
*p
)
362 static wxEventFunction
ConvertToEvtFunction(void (T::*f
)(A
&))
363 { return static_cast<wxEventFunction
>(
364 reinterpret_cast<void (T::*)(wxEvent
&)>(f
)); }
367 // specialization for handlers not deriving from wxEvtHandler
368 template <typename T
, typename A
>
369 struct HandlerImpl
<T
, A
, false>
371 static bool IsEvtHandler()
373 static T
*ConvertFromEvtHandler(wxEvtHandler
*)
375 static wxEvtHandler
*ConvertToEvtHandler(T
*)
377 static wxEventFunction
ConvertToEvtFunction(void (T::*)(A
&))
381 } // namespace wxPrivate
383 // functor forwarding the event to a method of the given object
385 // notice that the object class may be different from the class in which the
386 // method is defined but it must be convertible to this class
388 // also, the type of the handler parameter doesn't need to be exactly the same
389 // as EventTag::EventClass but it must be its base class -- this is explicitly
390 // allowed to handle different events in the same handler taking wxEvent&, for
393 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
394 class wxEventFunctorMethod
395 : public wxEventFunctor
,
396 private wxPrivate::HandlerImpl
400 wxConvertibleTo
<Class
, wxEvtHandler
>::value
!= 0
404 static void CheckHandlerArgument(EventArg
*) { }
407 // the event class associated with the given event tag
408 typedef typename
wxPrivate::EventClassOf
<EventTag
>::type EventClass
;
411 wxEventFunctorMethod(void (Class::*method
)(EventArg
&), ObjClass
*handler
)
413 wxASSERT_MSG( handler
|| this->IsEvtHandler(),
414 "handlers defined in non-wxEvtHandler-derived classes "
415 "must be connected with a valid sink object" );
417 // if you get an error here it means that the signature of the handler
418 // you're trying to use is not compatible with (i.e. is not the same as
419 // or a base class of) the real event class used for this event type
420 CheckHandlerArgument(static_cast<EventClass
*>(NULL
));
426 virtual void operator()(wxEvtHandler
*handler
, wxEvent
& event
)
428 Class
* realHandler
= m_handler
;
431 realHandler
= this->ConvertFromEvtHandler(handler
);
433 // this is not supposed to happen but check for it nevertheless
434 wxCHECK_RET( realHandler
, "invalid event handler" );
437 // the real (run-time) type of event is EventClass and we checked in
438 // the ctor that EventClass can be converted to EventArg, so this cast
440 (realHandler
->*m_method
)(static_cast<EventArg
&>(event
));
443 virtual bool Matches(const wxEventFunctor
& func
) const
445 void * const handler
= func
.GetHandler();
446 if ( handler
&& GetHandler() != handler
)
449 const wxEventFunction method
= GetMethod();
450 return !method
|| GetMethod() == method
;
453 virtual void *GetHandler() const
458 virtual wxEventFunction
GetMethod() const
460 return this->ConvertToEvtFunction(m_method
);
463 virtual wxEvtHandler
*GetEvtHandler() const
465 return this->ConvertToEvtHandler(m_handler
);
470 void (Class::*m_method
)(EventArg
&);
475 // Create functors for the templatized events, either allocated on the heap for
476 // wxNewXXX() variants (this is needed in wxEvtHandler::Connect() to store them
477 // in dynamic event table) or just by returning them as temporary objects (this
478 // is enough for Disconnect() and we allocate unnecessary heap allocation like
482 // Create functors wrapping other functors (including functions):
483 template <typename EventTag
, typename Functor
>
484 inline wxEventFunctorFunction
<EventTag
, Functor
> *
485 wxNewEventFunctor(const EventTag
&, Functor func
)
487 return new wxEventFunctorFunction
<EventTag
, Functor
>(func
);
490 template <typename EventTag
, typename Functor
>
491 inline wxEventFunctorFunction
<EventTag
, Functor
>
492 wxMakeEventFunctor(const EventTag
&, Functor func
)
494 return wxEventFunctorFunction
<EventTag
, Functor
>(func
);
498 // Create functors for methods:
500 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
501 inline wxEventFunctorMethod
<EventTag
, Class
, EventArg
, ObjClass
> *
502 wxNewEventFunctor(const EventTag
&,
503 void (Class::*method
)(EventArg
&),
506 return new wxEventFunctorMethod
<EventTag
, Class
, EventArg
, ObjClass
>(
511 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
512 inline wxEventFunctorMethod
<EventTag
, Class
, EventArg
, ObjClass
>
513 wxMakeEventFunctor(const EventTag
&,
514 void (Class::*method
)(EventArg
&),
517 return wxEventFunctorMethod
<EventTag
, Class
, EventArg
, ObjClass
>(
521 // Special case for the wxNewEventFunctor() calls used inside the event table
522 // macros: they don't specify the handler so ObjClass can't be deduced
523 template <typename EventTag
, typename Class
, typename EventArg
>
524 inline wxEventFunctorMethod
<EventTag
, Class
, EventArg
, Class
> *
525 wxNewEventFunctor(const EventTag
&, void (Class::*method
)(EventArg
&))
527 return new wxEventFunctorMethod
<EventTag
, Class
, EventArg
, Class
>(
532 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
533 inline wxEventFunctorMethod
<EventTag
, Class
, EventArg
, Class
>
534 wxMakeEventFunctor(const EventTag
&, void (Class::*method
)(EventArg
&))
536 return wxEventFunctorMethod
<EventTag
, Class
, EventArg
, Class
>(
540 #endif // !wxEVENTS_COMPATIBILITY_2_8
543 // many, but not all, standard event types
545 // some generic events
546 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_NULL
;
547 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_FIRST
;
548 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_USER_FIRST
;
550 // Need events declared to do this
551 class WXDLLIMPEXP_FWD_CORE wxCommandEvent
;
552 class WXDLLIMPEXP_FWD_CORE wxThreadEvent
;
553 class WXDLLIMPEXP_FWD_CORE wxMouseEvent
;
554 class WXDLLIMPEXP_FWD_CORE wxFocusEvent
;
555 class WXDLLIMPEXP_FWD_CORE wxChildFocusEvent
;
556 class WXDLLIMPEXP_FWD_CORE wxKeyEvent
;
557 class WXDLLIMPEXP_FWD_CORE wxNavigationKeyEvent
;
558 class WXDLLIMPEXP_FWD_CORE wxSetCursorEvent
;
559 class WXDLLIMPEXP_FWD_CORE wxScrollEvent
;
560 class WXDLLIMPEXP_FWD_CORE wxSpinEvent
;
561 class WXDLLIMPEXP_FWD_CORE wxScrollWinEvent
;
562 class WXDLLIMPEXP_FWD_CORE wxSizeEvent
;
563 class WXDLLIMPEXP_FWD_CORE wxMoveEvent
;
564 class WXDLLIMPEXP_FWD_CORE wxCloseEvent
;
565 class WXDLLIMPEXP_FWD_CORE wxActivateEvent
;
566 class WXDLLIMPEXP_FWD_CORE wxWindowCreateEvent
;
567 class WXDLLIMPEXP_FWD_CORE wxWindowDestroyEvent
;
568 class WXDLLIMPEXP_FWD_CORE wxShowEvent
;
569 class WXDLLIMPEXP_FWD_CORE wxIconizeEvent
;
570 class WXDLLIMPEXP_FWD_CORE wxMaximizeEvent
;
571 class WXDLLIMPEXP_FWD_CORE wxMouseCaptureChangedEvent
;
572 class WXDLLIMPEXP_FWD_CORE wxMouseCaptureLostEvent
;
573 class WXDLLIMPEXP_FWD_CORE wxPaintEvent
;
574 class WXDLLIMPEXP_FWD_CORE wxEraseEvent
;
575 class WXDLLIMPEXP_FWD_CORE wxNcPaintEvent
;
576 class WXDLLIMPEXP_FWD_CORE wxMenuEvent
;
577 class WXDLLIMPEXP_FWD_CORE wxContextMenuEvent
;
578 class WXDLLIMPEXP_FWD_CORE wxSysColourChangedEvent
;
579 class WXDLLIMPEXP_FWD_CORE wxDisplayChangedEvent
;
580 class WXDLLIMPEXP_FWD_CORE wxQueryNewPaletteEvent
;
581 class WXDLLIMPEXP_FWD_CORE wxPaletteChangedEvent
;
582 class WXDLLIMPEXP_FWD_CORE wxJoystickEvent
;
583 class WXDLLIMPEXP_FWD_CORE wxDropFilesEvent
;
584 class WXDLLIMPEXP_FWD_CORE wxInitDialogEvent
;
585 class WXDLLIMPEXP_FWD_CORE wxIdleEvent
;
586 class WXDLLIMPEXP_FWD_CORE wxUpdateUIEvent
;
587 class WXDLLIMPEXP_FWD_CORE wxClipboardTextEvent
;
588 class WXDLLIMPEXP_FWD_CORE wxHelpEvent
;
592 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_BUTTON_CLICKED
, wxCommandEvent
);
593 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHECKBOX_CLICKED
, wxCommandEvent
);
594 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHOICE_SELECTED
, wxCommandEvent
);
595 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LISTBOX_SELECTED
, wxCommandEvent
);
596 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
, wxCommandEvent
);
597 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
, wxCommandEvent
);
598 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_MENU_SELECTED
, wxCommandEvent
);
599 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SLIDER_UPDATED
, wxCommandEvent
);
600 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RADIOBOX_SELECTED
, wxCommandEvent
);
601 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RADIOBUTTON_SELECTED
, wxCommandEvent
);
603 // wxEVT_COMMAND_SCROLLBAR_UPDATED is deprecated, use wxEVT_SCROLL... events
604 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SCROLLBAR_UPDATED
, wxCommandEvent
);
605 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_VLBOX_SELECTED
, wxCommandEvent
);
606 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_COMBOBOX_SELECTED
, wxCommandEvent
);
607 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_RCLICKED
, wxCommandEvent
);
608 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED
, wxCommandEvent
);
609 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_ENTER
, wxCommandEvent
);
612 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_THREAD
, wxThreadEvent
);
615 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_DOWN
, wxMouseEvent
);
616 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_UP
, wxMouseEvent
);
617 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_DOWN
, wxMouseEvent
);
618 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_UP
, wxMouseEvent
);
619 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_DOWN
, wxMouseEvent
);
620 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_UP
, wxMouseEvent
);
621 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOTION
, wxMouseEvent
);
622 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ENTER_WINDOW
, wxMouseEvent
);
623 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEAVE_WINDOW
, wxMouseEvent
);
624 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_DCLICK
, wxMouseEvent
);
625 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_DCLICK
, wxMouseEvent
);
626 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_DCLICK
, wxMouseEvent
);
627 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SET_FOCUS
, wxFocusEvent
);
628 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KILL_FOCUS
, wxFocusEvent
);
629 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHILD_FOCUS
, wxChildFocusEvent
);
630 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSEWHEEL
, wxMouseEvent
);
631 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_DOWN
, wxMouseEvent
);
632 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_UP
, wxMouseEvent
);
633 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_DCLICK
, wxMouseEvent
);
634 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_DOWN
, wxMouseEvent
);
635 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_UP
, wxMouseEvent
);
636 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_DCLICK
, wxMouseEvent
);
638 // Character input event type
639 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHAR
, wxKeyEvent
);
640 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHAR_HOOK
, wxKeyEvent
);
641 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_NAVIGATION_KEY
, wxNavigationKeyEvent
);
642 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KEY_DOWN
, wxKeyEvent
);
643 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KEY_UP
, wxKeyEvent
);
645 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HOTKEY
, wxKeyEvent
);
648 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SET_CURSOR
, wxSetCursorEvent
);
650 // wxScrollBar and wxSlider event identifiers
651 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_TOP
, wxScrollEvent
);
652 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_BOTTOM
, wxScrollEvent
);
653 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_LINEUP
, wxScrollEvent
);
654 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_LINEDOWN
, wxScrollEvent
);
655 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_PAGEUP
, wxScrollEvent
);
656 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_PAGEDOWN
, wxScrollEvent
);
657 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_THUMBTRACK
, wxScrollEvent
);
658 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_THUMBRELEASE
, wxScrollEvent
);
659 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_CHANGED
, wxScrollEvent
);
661 // Due to a bug in older wx versions, wxSpinEvents were being sent with type of
662 // wxEVT_SCROLL_LINEUP, wxEVT_SCROLL_LINEDOWN and wxEVT_SCROLL_THUMBTRACK. But
663 // with the type-safe events in place, these event types are associated with
664 // wxScrollEvent. To allow handling of spin events, new event types have been
665 // defined in spinbutt.h/spinnbuttcmn.cpp. To maintain backward compatibility
666 // the spin event types are being initialized with the scroll event types.
670 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN_UP
, wxSpinEvent
);
671 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN_DOWN
, wxSpinEvent
);
672 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN
, wxSpinEvent
);
676 // Scroll events from wxWindow
677 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_TOP
, wxScrollWinEvent
);
678 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_BOTTOM
, wxScrollWinEvent
);
679 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_LINEUP
, wxScrollWinEvent
);
680 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_LINEDOWN
, wxScrollWinEvent
);
681 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_PAGEUP
, wxScrollWinEvent
);
682 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_PAGEDOWN
, wxScrollWinEvent
);
683 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_THUMBTRACK
, wxScrollWinEvent
);
684 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_THUMBRELEASE
, wxScrollWinEvent
);
687 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SIZE
, wxSizeEvent
);
688 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE
, wxMoveEvent
);
689 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CLOSE_WINDOW
, wxCloseEvent
);
690 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_END_SESSION
, wxCloseEvent
);
691 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_QUERY_END_SESSION
, wxCloseEvent
);
692 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ACTIVATE_APP
, wxActivateEvent
);
693 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ACTIVATE
, wxActivateEvent
);
694 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CREATE
, wxWindowCreateEvent
);
695 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DESTROY
, wxWindowDestroyEvent
);
696 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SHOW
, wxShowEvent
);
697 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ICONIZE
, wxIconizeEvent
);
698 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MAXIMIZE
, wxMaximizeEvent
);
699 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSE_CAPTURE_CHANGED
, wxMouseCaptureChangedEvent
);
700 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSE_CAPTURE_LOST
, wxMouseCaptureLostEvent
);
701 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_PAINT
, wxPaintEvent
);
702 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ERASE_BACKGROUND
, wxEraseEvent
);
703 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_NC_PAINT
, wxNcPaintEvent
);
704 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_OPEN
, wxMenuEvent
);
705 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_CLOSE
, wxMenuEvent
);
706 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_HIGHLIGHT
, wxMenuEvent
);
707 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CONTEXT_MENU
, wxContextMenuEvent
);
708 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SYS_COLOUR_CHANGED
, wxSysColourChangedEvent
);
709 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DISPLAY_CHANGED
, wxDisplayChangedEvent
);
710 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_QUERY_NEW_PALETTE
, wxQueryNewPaletteEvent
);
711 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_PALETTE_CHANGED
, wxPaletteChangedEvent
);
712 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_BUTTON_DOWN
, wxJoystickEvent
);
713 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_BUTTON_UP
, wxJoystickEvent
);
714 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_MOVE
, wxJoystickEvent
);
715 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_ZMOVE
, wxJoystickEvent
);
716 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DROP_FILES
, wxDropFilesEvent
);
717 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_INIT_DIALOG
, wxInitDialogEvent
);
718 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_BASE
, wxEVT_IDLE
, wxIdleEvent
);
719 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_UPDATE_UI
, wxUpdateUIEvent
);
720 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SIZING
, wxSizeEvent
);
721 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVING
, wxMoveEvent
);
722 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE_START
, wxMoveEvent
);
723 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE_END
, wxMoveEvent
);
724 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HIBERNATE
, wxActivateEvent
);
727 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_COPY
, wxClipboardTextEvent
);
728 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_CUT
, wxClipboardTextEvent
);
729 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_PASTE
, wxClipboardTextEvent
);
731 // Generic command events
732 // Note: a click is a higher-level event than button down/up
733 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LEFT_CLICK
, wxCommandEvent
);
734 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LEFT_DCLICK
, wxCommandEvent
);
735 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RIGHT_CLICK
, wxCommandEvent
);
736 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RIGHT_DCLICK
, wxCommandEvent
);
737 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SET_FOCUS
, wxCommandEvent
);
738 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_KILL_FOCUS
, wxCommandEvent
);
739 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_ENTER
, wxCommandEvent
);
742 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HELP
, wxHelpEvent
);
743 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DETAILED_HELP
, wxHelpEvent
);
745 // these 2 events are the same
746 #define wxEVT_COMMAND_TOOL_CLICKED wxEVT_COMMAND_MENU_SELECTED
748 // ----------------------------------------------------------------------------
750 // ----------------------------------------------------------------------------
752 // this event is also used by wxComboBox and wxSpinCtrl which don't include
753 // wx/textctrl.h in all ports [yet], so declare it here as well
755 // still, any new code using it should include wx/textctrl.h explicitly
756 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_UPDATED
, wxCommandEvent
);
759 // ----------------------------------------------------------------------------
760 // wxEvent(-derived) classes
761 // ----------------------------------------------------------------------------
763 // the predefined constants for the number of times we propagate event
764 // upwards window child-parent chain
765 enum wxEventPropagation
767 // don't propagate it at all
768 wxEVENT_PROPAGATE_NONE
= 0,
770 // propagate it until it is processed
771 wxEVENT_PROPAGATE_MAX
= INT_MAX
774 // The different categories for a wxEvent; see wxEvent::GetEventCategory.
775 // NOTE: they are used as OR-combinable flags by wxEventLoopBase::YieldFor
778 // this is the category for those events which are generated to update
779 // the appearance of the GUI but which (usually) do not comport data
780 // processing, i.e. which do not provide input or output data
781 // (e.g. size events, scroll events, etc).
782 // They are events NOT directly generated by the user's input devices.
783 wxEVT_CATEGORY_UI
= 1,
785 // this category groups those events which are generated directly from the
786 // user through input devices like mouse and keyboard and usually result in
787 // data to be processed from the application.
788 // (e.g. mouse clicks, key presses, etc)
789 wxEVT_CATEGORY_USER_INPUT
= 2,
791 // this category is for wxSocketEvent
792 wxEVT_CATEGORY_SOCKET
= 4,
794 // this category is for wxTimerEvent
795 wxEVT_CATEGORY_TIMER
= 8,
797 // this category is for any event used to send notifications from the
798 // secondary threads to the main one or in general for notifications among
799 // different threads (which may or may not be user-generated)
800 wxEVT_CATEGORY_THREAD
= 16,
803 // implementation only
805 // used in the implementations of wxEventLoopBase::YieldFor
806 wxEVT_CATEGORY_UNKNOWN
= 32,
808 // a special category used as an argument to wxEventLoopBase::YieldFor to indicate that
809 // Yield() should leave all wxEvents on the queue while emptying the native event queue
810 // (native events will be processed but the wxEvents they generate will be queued)
811 wxEVT_CATEGORY_CLIPBOARD
= 64,
816 // this category groups those events which are emitted in response to
817 // events of the native toolkit and which typically are not-"delayable".
818 wxEVT_CATEGORY_NATIVE_EVENTS
= wxEVT_CATEGORY_UI
|wxEVT_CATEGORY_USER_INPUT
,
820 // used in wxEventLoopBase::YieldFor to specify all event categories should be processed:
822 wxEVT_CATEGORY_UI
|wxEVT_CATEGORY_USER_INPUT
|wxEVT_CATEGORY_SOCKET
| \
823 wxEVT_CATEGORY_TIMER
|wxEVT_CATEGORY_THREAD
827 * wxWidgets events, covering all interesting things that might happen
828 * (button clicking, resizing, setting text in widgets, etc.).
830 * For each completely new event type, derive a new event class.
831 * An event CLASS represents a C++ class defining a range of similar event TYPES;
832 * examples are canvas events, panel item command events.
833 * An event TYPE is a unique identifier for a particular system event,
834 * such as a button press or a listbox deselection.
838 class WXDLLIMPEXP_BASE wxEvent
: public wxObject
841 wxEvent(int winid
= 0, wxEventType commandType
= wxEVT_NULL
);
843 void SetEventType(wxEventType typ
) { m_eventType
= typ
; }
844 wxEventType
GetEventType() const { return m_eventType
; }
846 wxObject
*GetEventObject() const { return m_eventObject
; }
847 void SetEventObject(wxObject
*obj
) { m_eventObject
= obj
; }
849 long GetTimestamp() const { return m_timeStamp
; }
850 void SetTimestamp(long ts
= 0) { m_timeStamp
= ts
; }
852 int GetId() const { return m_id
; }
853 void SetId(int Id
) { m_id
= Id
; }
855 // Can instruct event processor that we wish to ignore this event
856 // (treat as if the event table entry had not been found): this must be done
857 // to allow the event processing by the base classes (calling event.Skip()
858 // is the analog of calling the base class version of a virtual function)
859 void Skip(bool skip
= true) { m_skipped
= skip
; }
860 bool GetSkipped() const { return m_skipped
; }
862 // This function is used to create a copy of the event polymorphically and
863 // all derived classes must implement it because otherwise wxPostEvent()
864 // for them wouldn't work (it needs to do a copy of the event)
865 virtual wxEvent
*Clone() const = 0;
867 // this function is used to selectively process events in wxEventLoopBase::YieldFor
868 // NOTE: by default it returns wxEVT_CATEGORY_UI just because the major
869 // part of wxWidgets events belong to that category.
870 virtual wxEventCategory
GetEventCategory() const
871 { return wxEVT_CATEGORY_UI
; }
873 // Implementation only: this test is explicitly anti OO and this function
874 // exists only for optimization purposes.
875 bool IsCommandEvent() const { return m_isCommandEvent
; }
877 // Determine if this event should be propagating to the parent window.
878 bool ShouldPropagate() const
879 { return m_propagationLevel
!= wxEVENT_PROPAGATE_NONE
; }
881 // Stop an event from propagating to its parent window, returns the old
882 // propagation level value
883 int StopPropagation()
885 int propagationLevel
= m_propagationLevel
;
886 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
887 return propagationLevel
;
890 // Resume the event propagation by restoring the propagation level
891 // (returned by StopPropagation())
892 void ResumePropagation(int propagationLevel
)
894 m_propagationLevel
= propagationLevel
;
898 // This is for internal use only and is only called by
899 // wxEvtHandler::ProcessEvent() to check whether it's the first time this
900 // event is being processed
903 if ( m_wasProcessed
)
906 m_wasProcessed
= true;
912 wxObject
* m_eventObject
;
913 wxEventType m_eventType
;
918 // m_callbackUserData is for internal usage only
919 wxObject
* m_callbackUserData
;
922 // the propagation level: while it is positive, we propagate the event to
923 // the parent window (if any)
924 int m_propagationLevel
;
927 bool m_isCommandEvent
;
929 // initially false but becomes true as soon as WasProcessed() is called for
930 // the first time, as this is done only by ProcessEvent() it explains the
931 // variable name: it becomes true after ProcessEvent() was called at least
932 // once for this event
936 wxEvent(const wxEvent
&); // for implementing Clone()
937 wxEvent
& operator=(const wxEvent
&); // for derived classes operator=()
940 // it needs to access our m_propagationLevel
941 friend class WXDLLIMPEXP_FWD_BASE wxPropagateOnce
;
943 DECLARE_ABSTRACT_CLASS(wxEvent
)
947 * Helper class to temporarily change an event not to propagate.
949 class WXDLLIMPEXP_BASE wxPropagationDisabler
952 wxPropagationDisabler(wxEvent
& event
) : m_event(event
)
954 m_propagationLevelOld
= m_event
.StopPropagation();
957 ~wxPropagationDisabler()
959 m_event
.ResumePropagation(m_propagationLevelOld
);
964 int m_propagationLevelOld
;
966 wxDECLARE_NO_COPY_CLASS(wxPropagationDisabler
);
970 * Another one to temporarily lower propagation level.
972 class WXDLLIMPEXP_BASE wxPropagateOnce
975 wxPropagateOnce(wxEvent
& event
) : m_event(event
)
977 wxASSERT_MSG( m_event
.m_propagationLevel
> 0,
978 _T("shouldn't be used unless ShouldPropagate()!") );
980 m_event
.m_propagationLevel
--;
985 m_event
.m_propagationLevel
++;
991 wxDECLARE_NO_COPY_CLASS(wxPropagateOnce
);
998 // Item or menu event class
1000 wxEVT_COMMAND_BUTTON_CLICKED
1001 wxEVT_COMMAND_CHECKBOX_CLICKED
1002 wxEVT_COMMAND_CHOICE_SELECTED
1003 wxEVT_COMMAND_LISTBOX_SELECTED
1004 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
1005 wxEVT_COMMAND_TEXT_UPDATED
1006 wxEVT_COMMAND_TEXT_ENTER
1007 wxEVT_COMMAND_MENU_SELECTED
1008 wxEVT_COMMAND_SLIDER_UPDATED
1009 wxEVT_COMMAND_RADIOBOX_SELECTED
1010 wxEVT_COMMAND_RADIOBUTTON_SELECTED
1011 wxEVT_COMMAND_SCROLLBAR_UPDATED
1012 wxEVT_COMMAND_VLBOX_SELECTED
1013 wxEVT_COMMAND_COMBOBOX_SELECTED
1014 wxEVT_COMMAND_TOGGLEBUTTON_CLICKED
1017 class WXDLLIMPEXP_CORE wxCommandEvent
: public wxEvent
1020 wxCommandEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0);
1022 wxCommandEvent(const wxCommandEvent
& event
)
1024 m_cmdString(event
.m_cmdString
),
1025 m_commandInt(event
.m_commandInt
),
1026 m_extraLong(event
.m_extraLong
),
1027 m_clientData(event
.m_clientData
),
1028 m_clientObject(event
.m_clientObject
)
1031 // Set/Get client data from controls
1032 void SetClientData(void* clientData
) { m_clientData
= clientData
; }
1033 void *GetClientData() const { return m_clientData
; }
1035 // Set/Get client object from controls
1036 void SetClientObject(wxClientData
* clientObject
) { m_clientObject
= clientObject
; }
1037 wxClientData
*GetClientObject() const { return m_clientObject
; }
1039 // Get listbox selection if single-choice
1040 int GetSelection() const { return m_commandInt
; }
1042 // Set/Get listbox/choice selection string
1043 void SetString(const wxString
& s
) { m_cmdString
= s
; }
1044 wxString
GetString() const;
1046 // Get checkbox value
1047 bool IsChecked() const { return m_commandInt
!= 0; }
1049 // true if the listbox event was a selection.
1050 bool IsSelection() const { return (m_extraLong
!= 0); }
1052 void SetExtraLong(long extraLong
) { m_extraLong
= extraLong
; }
1053 long GetExtraLong() const { return m_extraLong
; }
1055 void SetInt(int i
) { m_commandInt
= i
; }
1056 int GetInt() const { return m_commandInt
; }
1058 virtual wxEvent
*Clone() const { return new wxCommandEvent(*this); }
1059 virtual wxEventCategory
GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT
; }
1062 wxString m_cmdString
; // String event argument
1064 long m_extraLong
; // Additional information (e.g. select/deselect)
1065 void* m_clientData
; // Arbitrary client data
1066 wxClientData
* m_clientObject
; // Arbitrary client object
1069 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCommandEvent
)
1072 // this class adds a possibility to react (from the user) code to a control
1073 // notification: allow or veto the operation being reported.
1074 class WXDLLIMPEXP_CORE wxNotifyEvent
: public wxCommandEvent
1077 wxNotifyEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0)
1078 : wxCommandEvent(commandType
, winid
)
1079 { m_bAllow
= true; }
1081 wxNotifyEvent(const wxNotifyEvent
& event
)
1082 : wxCommandEvent(event
)
1083 { m_bAllow
= event
.m_bAllow
; }
1085 // veto the operation (usually it's allowed by default)
1086 void Veto() { m_bAllow
= false; }
1088 // allow the operation if it was disabled by default
1089 void Allow() { m_bAllow
= true; }
1091 // for implementation code only: is the operation allowed?
1092 bool IsAllowed() const { return m_bAllow
; }
1094 virtual wxEvent
*Clone() const { return new wxNotifyEvent(*this); }
1100 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNotifyEvent
)
1106 class WXDLLIMPEXP_CORE wxThreadEvent
: public wxCommandEvent
1109 wxThreadEvent(wxEventType eventType
= wxEVT_COMMAND_THREAD
, int id
= wxID_ANY
)
1110 : wxCommandEvent(eventType
, id
)
1113 virtual wxEvent
*Clone() const
1115 wxThreadEvent
* ev
= new wxThreadEvent(*this);
1117 // make sure our string member (which uses COW, aka refcounting) is not
1118 // shared by other wxString instances:
1119 ev
->SetString(GetString().c_str());
1123 // this is important to avoid that calling wxEventLoopBase::YieldFor thread events
1124 // gets processed when this is unwanted:
1125 virtual wxEventCategory
GetEventCategory() const
1126 { return wxEVT_CATEGORY_THREAD
; }
1129 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxThreadEvent
)
1134 // Scroll event class, derived form wxCommandEvent. wxScrollEvents are
1135 // sent by wxSlider and wxScrollBar.
1140 wxEVT_SCROLL_LINEDOWN
1142 wxEVT_SCROLL_PAGEDOWN
1143 wxEVT_SCROLL_THUMBTRACK
1144 wxEVT_SCROLL_THUMBRELEASE
1145 wxEVT_SCROLL_CHANGED
1148 class WXDLLIMPEXP_CORE wxScrollEvent
: public wxCommandEvent
1151 wxScrollEvent(wxEventType commandType
= wxEVT_NULL
,
1152 int winid
= 0, int pos
= 0, int orient
= 0);
1154 int GetOrientation() const { return (int) m_extraLong
; }
1155 int GetPosition() const { return m_commandInt
; }
1156 void SetOrientation(int orient
) { m_extraLong
= (long) orient
; }
1157 void SetPosition(int pos
) { m_commandInt
= pos
; }
1159 virtual wxEvent
*Clone() const { return new wxScrollEvent(*this); }
1162 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollEvent
)
1165 // ScrollWin event class, derived fom wxEvent. wxScrollWinEvents
1166 // are sent by wxWindow.
1169 wxEVT_SCROLLWIN_BOTTOM
1170 wxEVT_SCROLLWIN_LINEUP
1171 wxEVT_SCROLLWIN_LINEDOWN
1172 wxEVT_SCROLLWIN_PAGEUP
1173 wxEVT_SCROLLWIN_PAGEDOWN
1174 wxEVT_SCROLLWIN_THUMBTRACK
1175 wxEVT_SCROLLWIN_THUMBRELEASE
1178 class WXDLLIMPEXP_CORE wxScrollWinEvent
: public wxEvent
1181 wxScrollWinEvent(wxEventType commandType
= wxEVT_NULL
,
1182 int pos
= 0, int orient
= 0);
1183 wxScrollWinEvent(const wxScrollWinEvent
& event
) : wxEvent(event
)
1184 { m_commandInt
= event
.m_commandInt
;
1185 m_extraLong
= event
.m_extraLong
; }
1187 int GetOrientation() const { return (int) m_extraLong
; }
1188 int GetPosition() const { return m_commandInt
; }
1189 void SetOrientation(int orient
) { m_extraLong
= (long) orient
; }
1190 void SetPosition(int pos
) { m_commandInt
= pos
; }
1192 virtual wxEvent
*Clone() const { return new wxScrollWinEvent(*this); }
1199 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollWinEvent
)
1204 // Mouse event class
1221 wxEVT_NC_MIDDLE_DOWN,
1223 wxEVT_NC_RIGHT_DOWN,
1226 wxEVT_NC_ENTER_WINDOW,
1227 wxEVT_NC_LEAVE_WINDOW,
1228 wxEVT_NC_LEFT_DCLICK,
1229 wxEVT_NC_MIDDLE_DCLICK,
1230 wxEVT_NC_RIGHT_DCLICK,
1233 // the symbolic names for the mouse buttons
1236 wxMOUSE_BTN_ANY
= -1,
1237 wxMOUSE_BTN_NONE
= 0,
1238 wxMOUSE_BTN_LEFT
= 1,
1239 wxMOUSE_BTN_MIDDLE
= 2,
1240 wxMOUSE_BTN_RIGHT
= 3,
1241 wxMOUSE_BTN_AUX1
= 4,
1242 wxMOUSE_BTN_AUX2
= 5,
1246 class WXDLLIMPEXP_CORE wxMouseEvent
: public wxEvent
,
1250 wxMouseEvent(wxEventType mouseType
= wxEVT_NULL
);
1251 wxMouseEvent(const wxMouseEvent
& event
)
1258 // Was it a button event? (*doesn't* mean: is any button *down*?)
1259 bool IsButton() const { return Button(wxMOUSE_BTN_ANY
); }
1261 // Was it a down event from this (or any) button?
1262 bool ButtonDown(int but
= wxMOUSE_BTN_ANY
) const;
1264 // Was it a dclick event from this (or any) button?
1265 bool ButtonDClick(int but
= wxMOUSE_BTN_ANY
) const;
1267 // Was it a up event from this (or any) button?
1268 bool ButtonUp(int but
= wxMOUSE_BTN_ANY
) const;
1270 // Was the given button?
1271 bool Button(int but
) const;
1273 // Was the given button in Down state?
1274 bool ButtonIsDown(int but
) const;
1276 // Get the button which is changing state (wxMOUSE_BTN_NONE if none)
1277 int GetButton() const;
1279 // Find which event was just generated
1280 bool LeftDown() const { return (m_eventType
== wxEVT_LEFT_DOWN
); }
1281 bool MiddleDown() const { return (m_eventType
== wxEVT_MIDDLE_DOWN
); }
1282 bool RightDown() const { return (m_eventType
== wxEVT_RIGHT_DOWN
); }
1283 bool Aux1Down() const { return (m_eventType
== wxEVT_AUX1_DOWN
); }
1284 bool Aux2Down() const { return (m_eventType
== wxEVT_AUX2_DOWN
); }
1286 bool LeftUp() const { return (m_eventType
== wxEVT_LEFT_UP
); }
1287 bool MiddleUp() const { return (m_eventType
== wxEVT_MIDDLE_UP
); }
1288 bool RightUp() const { return (m_eventType
== wxEVT_RIGHT_UP
); }
1289 bool Aux1Up() const { return (m_eventType
== wxEVT_AUX1_UP
); }
1290 bool Aux2Up() const { return (m_eventType
== wxEVT_AUX2_UP
); }
1292 bool LeftDClick() const { return (m_eventType
== wxEVT_LEFT_DCLICK
); }
1293 bool MiddleDClick() const { return (m_eventType
== wxEVT_MIDDLE_DCLICK
); }
1294 bool RightDClick() const { return (m_eventType
== wxEVT_RIGHT_DCLICK
); }
1295 bool Aux1DClick() const { return (m_eventType
== wxEVT_AUX1_UP
); }
1296 bool Aux2DClick() const { return (m_eventType
== wxEVT_AUX2_UP
); }
1298 // Find the current state of the mouse buttons (regardless
1299 // of current event type)
1300 bool LeftIsDown() const { return m_leftDown
; }
1301 bool MiddleIsDown() const { return m_middleDown
; }
1302 bool RightIsDown() const { return m_rightDown
; }
1303 bool Aux1IsDown() const { return m_aux1Down
; }
1304 bool Aux2IsDown() const { return m_aux2Down
; }
1306 // True if a button is down and the mouse is moving
1307 bool Dragging() const
1309 return (m_eventType
== wxEVT_MOTION
) && ButtonIsDown(wxMOUSE_BTN_ANY
);
1312 // True if the mouse is moving, and no button is down
1315 return (m_eventType
== wxEVT_MOTION
) && !ButtonIsDown(wxMOUSE_BTN_ANY
);
1318 // True if the mouse is just entering the window
1319 bool Entering() const { return (m_eventType
== wxEVT_ENTER_WINDOW
); }
1321 // True if the mouse is just leaving the window
1322 bool Leaving() const { return (m_eventType
== wxEVT_LEAVE_WINDOW
); }
1324 // Returns the number of mouse clicks associated with this event.
1325 int GetClickCount() const { return m_clickCount
; }
1328 // Find the position of the event
1329 void GetPosition(wxCoord
*xpos
, wxCoord
*ypos
) const
1337 void GetPosition(long *xpos
, long *ypos
) const
1345 // Find the position of the event
1346 wxPoint
GetPosition() const { return wxPoint(m_x
, m_y
); }
1348 // Find the logical position of the event given the DC
1349 wxPoint
GetLogicalPosition(const wxDC
& dc
) const;
1352 wxCoord
GetX() const { return m_x
; }
1355 wxCoord
GetY() const { return m_y
; }
1357 // Get wheel rotation, positive or negative indicates direction of
1358 // rotation. Current devices all send an event when rotation is equal to
1359 // +/-WheelDelta, but this allows for finer resolution devices to be
1360 // created in the future. Because of this you shouldn't assume that one
1361 // event is equal to 1 line or whatever, but you should be able to either
1362 // do partial line scrolling or wait until +/-WheelDelta rotation values
1363 // have been accumulated before scrolling.
1364 int GetWheelRotation() const { return m_wheelRotation
; }
1366 // Get wheel delta, normally 120. This is the threshold for action to be
1367 // taken, and one such action (for example, scrolling one increment)
1368 // should occur for each delta.
1369 int GetWheelDelta() const { return m_wheelDelta
; }
1371 // Gets the axis the wheel operation concerns, 0 being the y axis as on
1372 // most mouse wheels, 1 is the x axis for things like MightyMouse scrolls
1373 // or horizontal trackpad scrolling
1374 int GetWheelAxis() const { return m_wheelAxis
; }
1376 // Returns the configured number of lines (or whatever) to be scrolled per
1377 // wheel action. Defaults to one.
1378 int GetLinesPerAction() const { return m_linesPerAction
; }
1380 // Is the system set to do page scrolling?
1381 bool IsPageScroll() const { return ((unsigned int)m_linesPerAction
== UINT_MAX
); }
1383 virtual wxEvent
*Clone() const { return new wxMouseEvent(*this); }
1384 virtual wxEventCategory
GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT
; }
1386 wxMouseEvent
& operator=(const wxMouseEvent
& event
)
1405 int m_wheelRotation
;
1407 int m_linesPerAction
;
1410 void Assign(const wxMouseEvent
& evt
);
1413 DECLARE_DYNAMIC_CLASS(wxMouseEvent
)
1422 class WXDLLIMPEXP_CORE wxSetCursorEvent
: public wxEvent
1425 wxSetCursorEvent(wxCoord x
= 0, wxCoord y
= 0)
1426 : wxEvent(0, wxEVT_SET_CURSOR
),
1427 m_x(x
), m_y(y
), m_cursor()
1430 wxSetCursorEvent(const wxSetCursorEvent
& event
)
1434 m_cursor(event
.m_cursor
)
1437 wxCoord
GetX() const { return m_x
; }
1438 wxCoord
GetY() const { return m_y
; }
1440 void SetCursor(const wxCursor
& cursor
) { m_cursor
= cursor
; }
1441 const wxCursor
& GetCursor() const { return m_cursor
; }
1442 bool HasCursor() const { return m_cursor
.Ok(); }
1444 virtual wxEvent
*Clone() const { return new wxSetCursorEvent(*this); }
1451 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSetCursorEvent
)
1454 // Keyboard input event class
1464 class WXDLLIMPEXP_CORE wxKeyEvent
: public wxEvent
,
1465 public wxKeyboardState
1468 wxKeyEvent(wxEventType keyType
= wxEVT_NULL
);
1469 wxKeyEvent(const wxKeyEvent
& evt
);
1471 // get the key code: an ASCII7 char or an element of wxKeyCode enum
1472 int GetKeyCode() const { return (int)m_keyCode
; }
1475 // get the Unicode character corresponding to this key
1476 wxChar
GetUnicodeKey() const { return m_uniChar
; }
1477 #endif // wxUSE_UNICODE
1479 // get the raw key code (platform-dependent)
1480 wxUint32
GetRawKeyCode() const { return m_rawCode
; }
1482 // get the raw key flags (platform-dependent)
1483 wxUint32
GetRawKeyFlags() const { return m_rawFlags
; }
1485 // Find the position of the event
1486 void GetPosition(wxCoord
*xpos
, wxCoord
*ypos
) const
1488 if (xpos
) *xpos
= m_x
;
1489 if (ypos
) *ypos
= m_y
;
1492 void GetPosition(long *xpos
, long *ypos
) const
1494 if (xpos
) *xpos
= (long)m_x
;
1495 if (ypos
) *ypos
= (long)m_y
;
1498 wxPoint
GetPosition() const
1499 { return wxPoint(m_x
, m_y
); }
1502 wxCoord
GetX() const { return m_x
; }
1505 wxCoord
GetY() const { return m_y
; }
1507 virtual wxEvent
*Clone() const { return new wxKeyEvent(*this); }
1508 virtual wxEventCategory
GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT
; }
1510 // we do need to copy wxKeyEvent sometimes (in wxTreeCtrl code, for
1512 wxKeyEvent
& operator=(const wxKeyEvent
& evt
)
1516 wxEvent::operator=(evt
);
1518 // Borland C++ 5.82 doesn't compile an explicit call to an
1519 // implicitly defined operator=() so need to do it this way:
1520 *static_cast<wxKeyboardState
*>(this) = evt
;
1525 m_keyCode
= evt
.m_keyCode
;
1527 m_rawCode
= evt
.m_rawCode
;
1528 m_rawFlags
= evt
.m_rawFlags
;
1530 m_uniChar
= evt
.m_uniChar
;
1542 // This contains the full Unicode character
1543 // in a character events in Unicode mode
1547 // these fields contain the platform-specific information about
1548 // key that was pressed
1550 wxUint32 m_rawFlags
;
1553 DECLARE_DYNAMIC_CLASS(wxKeyEvent
)
1561 class WXDLLIMPEXP_CORE wxSizeEvent
: public wxEvent
1564 wxSizeEvent() : wxEvent(0, wxEVT_SIZE
)
1566 wxSizeEvent(const wxSize
& sz
, int winid
= 0)
1567 : wxEvent(winid
, wxEVT_SIZE
),
1570 wxSizeEvent(const wxSizeEvent
& event
)
1572 m_size(event
.m_size
), m_rect(event
.m_rect
)
1574 wxSizeEvent(const wxRect
& rect
, int id
= 0)
1575 : m_size(rect
.GetSize()), m_rect(rect
)
1576 { m_eventType
= wxEVT_SIZING
; m_id
= id
; }
1578 wxSize
GetSize() const { return m_size
; }
1579 wxRect
GetRect() const { return m_rect
; }
1580 void SetRect(const wxRect
& rect
) { m_rect
= rect
; }
1582 virtual wxEvent
*Clone() const { return new wxSizeEvent(*this); }
1585 // For internal usage only. Will be converted to protected members.
1587 wxRect m_rect
; // Used for wxEVT_SIZING
1590 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSizeEvent
)
1599 class WXDLLIMPEXP_CORE wxMoveEvent
: public wxEvent
1603 : wxEvent(0, wxEVT_MOVE
)
1605 wxMoveEvent(const wxPoint
& pos
, int winid
= 0)
1606 : wxEvent(winid
, wxEVT_MOVE
),
1609 wxMoveEvent(const wxMoveEvent
& event
)
1613 wxMoveEvent(const wxRect
& rect
, int id
= 0)
1614 : m_pos(rect
.GetPosition()), m_rect(rect
)
1615 { m_eventType
= wxEVT_MOVING
; m_id
= id
; }
1617 wxPoint
GetPosition() const { return m_pos
; }
1618 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
1619 wxRect
GetRect() const { return m_rect
; }
1620 void SetRect(const wxRect
& rect
) { m_rect
= rect
; }
1622 virtual wxEvent
*Clone() const { return new wxMoveEvent(*this); }
1629 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMoveEvent
)
1632 // Paint event class
1639 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1640 // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined
1641 extern WXDLLIMPEXP_CORE
int g_isPainting
;
1644 class WXDLLIMPEXP_CORE wxPaintEvent
: public wxEvent
1647 wxPaintEvent(int Id
= 0)
1648 : wxEvent(Id
, wxEVT_PAINT
)
1650 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1651 // set the internal flag for the duration of processing of WM_PAINT
1656 // default copy ctor and dtor are normally fine, we only need them to keep
1657 // g_isPainting updated in debug build
1658 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1659 wxPaintEvent(const wxPaintEvent
& event
)
1665 virtual ~wxPaintEvent()
1671 virtual wxEvent
*Clone() const { return new wxPaintEvent(*this); }
1674 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaintEvent
)
1677 class WXDLLIMPEXP_CORE wxNcPaintEvent
: public wxEvent
1680 wxNcPaintEvent(int winid
= 0)
1681 : wxEvent(winid
, wxEVT_NC_PAINT
)
1684 virtual wxEvent
*Clone() const { return new wxNcPaintEvent(*this); }
1687 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNcPaintEvent
)
1690 // Erase background event class
1692 wxEVT_ERASE_BACKGROUND
1695 class WXDLLIMPEXP_CORE wxEraseEvent
: public wxEvent
1698 wxEraseEvent(int Id
= 0, wxDC
*dc
= NULL
)
1699 : wxEvent(Id
, wxEVT_ERASE_BACKGROUND
),
1703 wxEraseEvent(const wxEraseEvent
& event
)
1708 wxDC
*GetDC() const { return m_dc
; }
1710 virtual wxEvent
*Clone() const { return new wxEraseEvent(*this); }
1716 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxEraseEvent
)
1719 // Focus event class
1725 class WXDLLIMPEXP_CORE wxFocusEvent
: public wxEvent
1728 wxFocusEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0)
1729 : wxEvent(winid
, type
)
1732 wxFocusEvent(const wxFocusEvent
& event
)
1734 { m_win
= event
.m_win
; }
1736 // The window associated with this event is the window which had focus
1737 // before for SET event and the window which will have focus for the KILL
1738 // one. NB: it may be NULL in both cases!
1739 wxWindow
*GetWindow() const { return m_win
; }
1740 void SetWindow(wxWindow
*win
) { m_win
= win
; }
1742 virtual wxEvent
*Clone() const { return new wxFocusEvent(*this); }
1748 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFocusEvent
)
1751 // wxChildFocusEvent notifies the parent that a child has got the focus: unlike
1752 // wxFocusEvent it is propagated upwards the window chain
1753 class WXDLLIMPEXP_CORE wxChildFocusEvent
: public wxCommandEvent
1756 wxChildFocusEvent(wxWindow
*win
= NULL
);
1758 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
1760 virtual wxEvent
*Clone() const { return new wxChildFocusEvent(*this); }
1763 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxChildFocusEvent
)
1766 // Activate event class
1773 class WXDLLIMPEXP_CORE wxActivateEvent
: public wxEvent
1776 wxActivateEvent(wxEventType type
= wxEVT_NULL
, bool active
= true, int Id
= 0)
1778 { m_active
= active
; }
1779 wxActivateEvent(const wxActivateEvent
& event
)
1781 { m_active
= event
.m_active
; }
1783 bool GetActive() const { return m_active
; }
1785 virtual wxEvent
*Clone() const { return new wxActivateEvent(*this); }
1791 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxActivateEvent
)
1794 // InitDialog event class
1799 class WXDLLIMPEXP_CORE wxInitDialogEvent
: public wxEvent
1802 wxInitDialogEvent(int Id
= 0)
1803 : wxEvent(Id
, wxEVT_INIT_DIALOG
)
1806 virtual wxEvent
*Clone() const { return new wxInitDialogEvent(*this); }
1809 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxInitDialogEvent
)
1812 // Miscellaneous menu event class
1816 wxEVT_MENU_HIGHLIGHT,
1819 class WXDLLIMPEXP_CORE wxMenuEvent
: public wxEvent
1822 wxMenuEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0, wxMenu
* menu
= NULL
)
1823 : wxEvent(winid
, type
)
1824 { m_menuId
= winid
; m_menu
= menu
; }
1825 wxMenuEvent(const wxMenuEvent
& event
)
1827 { m_menuId
= event
.m_menuId
; m_menu
= event
.m_menu
; }
1829 // only for wxEVT_MENU_HIGHLIGHT
1830 int GetMenuId() const { return m_menuId
; }
1832 // only for wxEVT_MENU_OPEN/CLOSE
1833 bool IsPopup() const { return m_menuId
== wxID_ANY
; }
1835 // only for wxEVT_MENU_OPEN/CLOSE
1836 wxMenu
* GetMenu() const { return m_menu
; }
1838 virtual wxEvent
*Clone() const { return new wxMenuEvent(*this); }
1844 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMenuEvent
)
1847 // Window close or session close event class
1851 wxEVT_QUERY_END_SESSION
1854 class WXDLLIMPEXP_CORE wxCloseEvent
: public wxEvent
1857 wxCloseEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0)
1858 : wxEvent(winid
, type
),
1860 m_veto(false), // should be false by default
1863 wxCloseEvent(const wxCloseEvent
& event
)
1865 m_loggingOff(event
.m_loggingOff
),
1866 m_veto(event
.m_veto
),
1867 m_canVeto(event
.m_canVeto
) {}
1869 void SetLoggingOff(bool logOff
) { m_loggingOff
= logOff
; }
1870 bool GetLoggingOff() const
1872 // m_loggingOff flag is only used by wxEVT_[QUERY_]END_SESSION, it
1873 // doesn't make sense for wxEVT_CLOSE_WINDOW
1874 wxASSERT_MSG( m_eventType
!= wxEVT_CLOSE_WINDOW
,
1875 _T("this flag is for end session events only") );
1877 return m_loggingOff
;
1880 void Veto(bool veto
= true)
1882 // GetVeto() will return false anyhow...
1883 wxCHECK_RET( m_canVeto
,
1884 wxT("call to Veto() ignored (can't veto this event)") );
1888 void SetCanVeto(bool canVeto
) { m_canVeto
= canVeto
; }
1889 bool CanVeto() const { return m_canVeto
; }
1890 bool GetVeto() const { return m_canVeto
&& m_veto
; }
1892 virtual wxEvent
*Clone() const { return new wxCloseEvent(*this); }
1900 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCloseEvent
)
1907 class WXDLLIMPEXP_CORE wxShowEvent
: public wxEvent
1910 wxShowEvent(int winid
= 0, bool show
= false)
1911 : wxEvent(winid
, wxEVT_SHOW
)
1913 wxShowEvent(const wxShowEvent
& event
)
1915 { m_show
= event
.m_show
; }
1917 void SetShow(bool show
) { m_show
= show
; }
1919 // return true if the window was shown, false if hidden
1920 bool IsShown() const { return m_show
; }
1922 #if WXWIN_COMPATIBILITY_2_8
1923 wxDEPRECATED( bool GetShow() const { return IsShown(); } )
1926 virtual wxEvent
*Clone() const { return new wxShowEvent(*this); }
1932 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxShowEvent
)
1939 class WXDLLIMPEXP_CORE wxIconizeEvent
: public wxEvent
1942 wxIconizeEvent(int winid
= 0, bool iconized
= true)
1943 : wxEvent(winid
, wxEVT_ICONIZE
)
1944 { m_iconized
= iconized
; }
1945 wxIconizeEvent(const wxIconizeEvent
& event
)
1947 { m_iconized
= event
.m_iconized
; }
1949 #if WXWIN_COMPATIBILITY_2_8
1950 wxDEPRECATED( bool Iconized() const { return IsIconized(); } )
1952 // return true if the frame was iconized, false if restored
1953 bool IsIconized() const { return m_iconized
; }
1955 virtual wxEvent
*Clone() const { return new wxIconizeEvent(*this); }
1961 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIconizeEvent
)
1967 class WXDLLIMPEXP_CORE wxMaximizeEvent
: public wxEvent
1970 wxMaximizeEvent(int winid
= 0)
1971 : wxEvent(winid
, wxEVT_MAXIMIZE
)
1974 virtual wxEvent
*Clone() const { return new wxMaximizeEvent(*this); }
1977 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMaximizeEvent
)
1980 // Joystick event class
1982 wxEVT_JOY_BUTTON_DOWN,
1983 wxEVT_JOY_BUTTON_UP,
1988 // Which joystick? Same as Windows ids so no conversion necessary.
1995 // Which button is down?
1998 wxJOY_BUTTON_ANY
= -1,
2005 class WXDLLIMPEXP_CORE wxJoystickEvent
: public wxEvent
2010 int m_buttonChange
; // Which button changed?
2011 int m_buttonState
; // Which buttons are down?
2012 int m_joyStick
; // Which joystick?
2015 wxJoystickEvent(wxEventType type
= wxEVT_NULL
,
2017 int joystick
= wxJOYSTICK1
,
2022 m_buttonChange(change
),
2023 m_buttonState(state
),
2024 m_joyStick(joystick
)
2027 wxJoystickEvent(const wxJoystickEvent
& event
)
2030 m_zPosition(event
.m_zPosition
),
2031 m_buttonChange(event
.m_buttonChange
),
2032 m_buttonState(event
.m_buttonState
),
2033 m_joyStick(event
.m_joyStick
)
2036 wxPoint
GetPosition() const { return m_pos
; }
2037 int GetZPosition() const { return m_zPosition
; }
2038 int GetButtonState() const { return m_buttonState
; }
2039 int GetButtonChange() const { return m_buttonChange
; }
2040 int GetJoystick() const { return m_joyStick
; }
2042 void SetJoystick(int stick
) { m_joyStick
= stick
; }
2043 void SetButtonState(int state
) { m_buttonState
= state
; }
2044 void SetButtonChange(int change
) { m_buttonChange
= change
; }
2045 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2046 void SetZPosition(int zPos
) { m_zPosition
= zPos
; }
2048 // Was it a button event? (*doesn't* mean: is any button *down*?)
2049 bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN
) ||
2050 (GetEventType() == wxEVT_JOY_BUTTON_UP
)); }
2052 // Was it a move event?
2053 bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE
); }
2055 // Was it a zmove event?
2056 bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE
); }
2058 // Was it a down event from button 1, 2, 3, 4 or any?
2059 bool ButtonDown(int but
= wxJOY_BUTTON_ANY
) const
2060 { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN
) &&
2061 ((but
== wxJOY_BUTTON_ANY
) || (but
== m_buttonChange
))); }
2063 // Was it a up event from button 1, 2, 3 or any?
2064 bool ButtonUp(int but
= wxJOY_BUTTON_ANY
) const
2065 { return ((GetEventType() == wxEVT_JOY_BUTTON_UP
) &&
2066 ((but
== wxJOY_BUTTON_ANY
) || (but
== m_buttonChange
))); }
2068 // Was the given button 1,2,3,4 or any in Down state?
2069 bool ButtonIsDown(int but
= wxJOY_BUTTON_ANY
) const
2070 { return (((but
== wxJOY_BUTTON_ANY
) && (m_buttonState
!= 0)) ||
2071 ((m_buttonState
& but
) == but
)); }
2073 virtual wxEvent
*Clone() const { return new wxJoystickEvent(*this); }
2076 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxJoystickEvent
)
2079 // Drop files event class
2084 class WXDLLIMPEXP_CORE wxDropFilesEvent
: public wxEvent
2091 wxDropFilesEvent(wxEventType type
= wxEVT_NULL
,
2093 wxString
*files
= NULL
)
2100 // we need a copy ctor to avoid deleting m_files pointer twice
2101 wxDropFilesEvent(const wxDropFilesEvent
& other
)
2103 m_noFiles(other
.m_noFiles
),
2107 m_files
= new wxString
[m_noFiles
];
2108 for ( int n
= 0; n
< m_noFiles
; n
++ )
2110 m_files
[n
] = other
.m_files
[n
];
2114 virtual ~wxDropFilesEvent()
2119 wxPoint
GetPosition() const { return m_pos
; }
2120 int GetNumberOfFiles() const { return m_noFiles
; }
2121 wxString
*GetFiles() const { return m_files
; }
2123 virtual wxEvent
*Clone() const { return new wxDropFilesEvent(*this); }
2126 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDropFilesEvent
)
2134 // Whether to always send update events to windows, or
2135 // to only send update events to those with the
2136 // wxWS_EX_PROCESS_UI_UPDATES style.
2140 // Send UI update events to all windows
2141 wxUPDATE_UI_PROCESS_ALL
,
2143 // Send UI update events to windows that have
2144 // the wxWS_EX_PROCESS_UI_UPDATES flag specified
2145 wxUPDATE_UI_PROCESS_SPECIFIED
2148 class WXDLLIMPEXP_CORE wxUpdateUIEvent
: public wxCommandEvent
2151 wxUpdateUIEvent(wxWindowID commandId
= 0)
2152 : wxCommandEvent(wxEVT_UPDATE_UI
, commandId
)
2160 m_setChecked
= false;
2162 wxUpdateUIEvent(const wxUpdateUIEvent
& event
)
2163 : wxCommandEvent(event
),
2164 m_checked(event
.m_checked
),
2165 m_enabled(event
.m_enabled
),
2166 m_shown(event
.m_shown
),
2167 m_setEnabled(event
.m_setEnabled
),
2168 m_setShown(event
.m_setShown
),
2169 m_setText(event
.m_setText
),
2170 m_setChecked(event
.m_setChecked
),
2171 m_text(event
.m_text
)
2174 bool GetChecked() const { return m_checked
; }
2175 bool GetEnabled() const { return m_enabled
; }
2176 bool GetShown() const { return m_shown
; }
2177 wxString
GetText() const { return m_text
; }
2178 bool GetSetText() const { return m_setText
; }
2179 bool GetSetChecked() const { return m_setChecked
; }
2180 bool GetSetEnabled() const { return m_setEnabled
; }
2181 bool GetSetShown() const { return m_setShown
; }
2183 void Check(bool check
) { m_checked
= check
; m_setChecked
= true; }
2184 void Enable(bool enable
) { m_enabled
= enable
; m_setEnabled
= true; }
2185 void Show(bool show
) { m_shown
= show
; m_setShown
= true; }
2186 void SetText(const wxString
& text
) { m_text
= text
; m_setText
= true; }
2188 // Sets the interval between updates in milliseconds.
2189 // Set to -1 to disable updates, or to 0 to update as frequently as possible.
2190 static void SetUpdateInterval(long updateInterval
) { sm_updateInterval
= updateInterval
; }
2192 // Returns the current interval between updates in milliseconds
2193 static long GetUpdateInterval() { return sm_updateInterval
; }
2195 // Can we update this window?
2196 static bool CanUpdate(wxWindowBase
*win
);
2198 // Reset the update time to provide a delay until the next
2199 // time we should update
2200 static void ResetUpdateTime();
2202 // Specify how wxWidgets will send update events: to
2203 // all windows, or only to those which specify that they
2204 // will process the events.
2205 static void SetMode(wxUpdateUIMode mode
) { sm_updateMode
= mode
; }
2207 // Returns the UI update mode
2208 static wxUpdateUIMode
GetMode() { return sm_updateMode
; }
2210 virtual wxEvent
*Clone() const { return new wxUpdateUIEvent(*this); }
2222 static wxLongLong sm_lastUpdate
;
2224 static long sm_updateInterval
;
2225 static wxUpdateUIMode sm_updateMode
;
2228 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxUpdateUIEvent
)
2232 wxEVT_SYS_COLOUR_CHANGED
2235 // TODO: shouldn't all events record the window ID?
2236 class WXDLLIMPEXP_CORE wxSysColourChangedEvent
: public wxEvent
2239 wxSysColourChangedEvent()
2240 : wxEvent(0, wxEVT_SYS_COLOUR_CHANGED
)
2243 virtual wxEvent
*Clone() const { return new wxSysColourChangedEvent(*this); }
2246 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSysColourChangedEvent
)
2250 wxEVT_MOUSE_CAPTURE_CHANGED
2251 The window losing the capture receives this message
2252 (even if it released the capture itself).
2255 class WXDLLIMPEXP_CORE wxMouseCaptureChangedEvent
: public wxEvent
2258 wxMouseCaptureChangedEvent(wxWindowID winid
= 0, wxWindow
* gainedCapture
= NULL
)
2259 : wxEvent(winid
, wxEVT_MOUSE_CAPTURE_CHANGED
),
2260 m_gainedCapture(gainedCapture
)
2263 wxMouseCaptureChangedEvent(const wxMouseCaptureChangedEvent
& event
)
2265 m_gainedCapture(event
.m_gainedCapture
)
2268 virtual wxEvent
*Clone() const { return new wxMouseCaptureChangedEvent(*this); }
2270 wxWindow
* GetCapturedWindow() const { return m_gainedCapture
; }
2273 wxWindow
* m_gainedCapture
;
2275 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureChangedEvent
)
2279 wxEVT_MOUSE_CAPTURE_LOST
2280 The window losing the capture receives this message, unless it released it
2281 it itself or unless wxWindow::CaptureMouse was called on another window
2282 (and so capture will be restored when the new capturer releases it).
2285 class WXDLLIMPEXP_CORE wxMouseCaptureLostEvent
: public wxEvent
2288 wxMouseCaptureLostEvent(wxWindowID winid
= 0)
2289 : wxEvent(winid
, wxEVT_MOUSE_CAPTURE_LOST
)
2292 wxMouseCaptureLostEvent(const wxMouseCaptureLostEvent
& event
)
2296 virtual wxEvent
*Clone() const { return new wxMouseCaptureLostEvent(*this); }
2298 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureLostEvent
)
2302 wxEVT_DISPLAY_CHANGED
2304 class WXDLLIMPEXP_CORE wxDisplayChangedEvent
: public wxEvent
2307 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDisplayChangedEvent
)
2310 wxDisplayChangedEvent()
2311 : wxEvent(0, wxEVT_DISPLAY_CHANGED
)
2314 virtual wxEvent
*Clone() const { return new wxDisplayChangedEvent(*this); }
2318 wxEVT_PALETTE_CHANGED
2321 class WXDLLIMPEXP_CORE wxPaletteChangedEvent
: public wxEvent
2324 wxPaletteChangedEvent(wxWindowID winid
= 0)
2325 : wxEvent(winid
, wxEVT_PALETTE_CHANGED
),
2326 m_changedWindow(NULL
)
2329 wxPaletteChangedEvent(const wxPaletteChangedEvent
& event
)
2331 m_changedWindow(event
.m_changedWindow
)
2334 void SetChangedWindow(wxWindow
* win
) { m_changedWindow
= win
; }
2335 wxWindow
* GetChangedWindow() const { return m_changedWindow
; }
2337 virtual wxEvent
*Clone() const { return new wxPaletteChangedEvent(*this); }
2340 wxWindow
* m_changedWindow
;
2343 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaletteChangedEvent
)
2347 wxEVT_QUERY_NEW_PALETTE
2348 Indicates the window is getting keyboard focus and should re-do its palette.
2351 class WXDLLIMPEXP_CORE wxQueryNewPaletteEvent
: public wxEvent
2354 wxQueryNewPaletteEvent(wxWindowID winid
= 0)
2355 : wxEvent(winid
, wxEVT_QUERY_NEW_PALETTE
),
2356 m_paletteRealized(false)
2358 wxQueryNewPaletteEvent(const wxQueryNewPaletteEvent
& event
)
2360 m_paletteRealized(event
.m_paletteRealized
)
2363 // App sets this if it changes the palette.
2364 void SetPaletteRealized(bool realized
) { m_paletteRealized
= realized
; }
2365 bool GetPaletteRealized() const { return m_paletteRealized
; }
2367 virtual wxEvent
*Clone() const { return new wxQueryNewPaletteEvent(*this); }
2370 bool m_paletteRealized
;
2373 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxQueryNewPaletteEvent
)
2377 Event generated by dialog navigation keys
2378 wxEVT_NAVIGATION_KEY
2380 // NB: don't derive from command event to avoid being propagated to the parent
2381 class WXDLLIMPEXP_CORE wxNavigationKeyEvent
: public wxEvent
2384 wxNavigationKeyEvent()
2385 : wxEvent(0, wxEVT_NAVIGATION_KEY
),
2386 m_flags(IsForward
| FromTab
), // defaults are for TAB
2389 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
2392 wxNavigationKeyEvent(const wxNavigationKeyEvent
& event
)
2394 m_flags(event
.m_flags
),
2395 m_focus(event
.m_focus
)
2398 // direction: forward (true) or backward (false)
2399 bool GetDirection() const
2400 { return (m_flags
& IsForward
) != 0; }
2401 void SetDirection(bool bForward
)
2402 { if ( bForward
) m_flags
|= IsForward
; else m_flags
&= ~IsForward
; }
2404 // it may be a window change event (MDI, notebook pages...) or a control
2406 bool IsWindowChange() const
2407 { return (m_flags
& WinChange
) != 0; }
2408 void SetWindowChange(bool bIs
)
2409 { if ( bIs
) m_flags
|= WinChange
; else m_flags
&= ~WinChange
; }
2411 // Set to true under MSW if the event was generated using the tab key.
2412 // This is required for proper navogation over radio buttons
2413 bool IsFromTab() const
2414 { return (m_flags
& FromTab
) != 0; }
2415 void SetFromTab(bool bIs
)
2416 { if ( bIs
) m_flags
|= FromTab
; else m_flags
&= ~FromTab
; }
2418 // the child which has the focus currently (may be NULL - use
2419 // wxWindow::FindFocus then)
2420 wxWindow
* GetCurrentFocus() const { return m_focus
; }
2421 void SetCurrentFocus(wxWindow
*win
) { m_focus
= win
; }
2424 void SetFlags(long flags
) { m_flags
= flags
; }
2426 virtual wxEvent
*Clone() const { return new wxNavigationKeyEvent(*this); }
2430 IsBackward
= 0x0000,
2440 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNavigationKeyEvent
)
2443 // Window creation/destruction events: the first is sent as soon as window is
2444 // created (i.e. the underlying GUI object exists), but when the C++ object is
2445 // fully initialized (so virtual functions may be called). The second,
2446 // wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
2447 // still safe to call virtual functions at this moment
2453 class WXDLLIMPEXP_CORE wxWindowCreateEvent
: public wxCommandEvent
2456 wxWindowCreateEvent(wxWindow
*win
= NULL
);
2458 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
2460 virtual wxEvent
*Clone() const { return new wxWindowCreateEvent(*this); }
2463 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowCreateEvent
)
2466 class WXDLLIMPEXP_CORE wxWindowDestroyEvent
: public wxCommandEvent
2469 wxWindowDestroyEvent(wxWindow
*win
= NULL
);
2471 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
2473 virtual wxEvent
*Clone() const { return new wxWindowDestroyEvent(*this); }
2476 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowDestroyEvent
)
2479 // A help event is sent when the user clicks on a window in context-help mode.
2485 class WXDLLIMPEXP_CORE wxHelpEvent
: public wxCommandEvent
2488 // how was this help event generated?
2491 Origin_Unknown
, // unrecognized event source
2492 Origin_Keyboard
, // event generated from F1 key press
2493 Origin_HelpButton
// event from [?] button on the title bar (Windows)
2496 wxHelpEvent(wxEventType type
= wxEVT_NULL
,
2497 wxWindowID winid
= 0,
2498 const wxPoint
& pt
= wxDefaultPosition
,
2499 Origin origin
= Origin_Unknown
)
2500 : wxCommandEvent(type
, winid
),
2502 m_origin(GuessOrigin(origin
))
2504 wxHelpEvent(const wxHelpEvent
& event
)
2505 : wxCommandEvent(event
),
2507 m_target(event
.m_target
),
2508 m_link(event
.m_link
),
2509 m_origin(event
.m_origin
)
2512 // Position of event (in screen coordinates)
2513 const wxPoint
& GetPosition() const { return m_pos
; }
2514 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2516 // Optional link to further help
2517 const wxString
& GetLink() const { return m_link
; }
2518 void SetLink(const wxString
& link
) { m_link
= link
; }
2520 // Optional target to display help in. E.g. a window specification
2521 const wxString
& GetTarget() const { return m_target
; }
2522 void SetTarget(const wxString
& target
) { m_target
= target
; }
2524 virtual wxEvent
*Clone() const { return new wxHelpEvent(*this); }
2526 // optional indication of the event source
2527 Origin
GetOrigin() const { return m_origin
; }
2528 void SetOrigin(Origin origin
) { m_origin
= origin
; }
2536 // we can try to guess the event origin ourselves, even if none is
2537 // specified in the ctor
2538 static Origin
GuessOrigin(Origin origin
);
2541 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHelpEvent
)
2544 // A Clipboard Text event is sent when a window intercepts text copy/cut/paste
2545 // message, i.e. the user has cut/copied/pasted data from/into a text control
2546 // via ctrl-C/X/V, ctrl/shift-del/insert, a popup menu command, etc.
2547 // NOTE : under windows these events are *NOT* generated automatically
2548 // for a Rich Edit text control.
2550 wxEVT_COMMAND_TEXT_COPY
2551 wxEVT_COMMAND_TEXT_CUT
2552 wxEVT_COMMAND_TEXT_PASTE
2555 class WXDLLIMPEXP_CORE wxClipboardTextEvent
: public wxCommandEvent
2558 wxClipboardTextEvent(wxEventType type
= wxEVT_NULL
,
2559 wxWindowID winid
= 0)
2560 : wxCommandEvent(type
, winid
)
2562 wxClipboardTextEvent(const wxClipboardTextEvent
& event
)
2563 : wxCommandEvent(event
)
2566 virtual wxEvent
*Clone() const { return new wxClipboardTextEvent(*this); }
2569 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxClipboardTextEvent
)
2572 // A Context event is sent when the user right clicks on a window or
2573 // presses Shift-F10
2574 // NOTE : Under windows this is a repackaged WM_CONTETXMENU message
2575 // Under other systems it may have to be generated from a right click event
2580 class WXDLLIMPEXP_CORE wxContextMenuEvent
: public wxCommandEvent
2583 wxContextMenuEvent(wxEventType type
= wxEVT_NULL
,
2584 wxWindowID winid
= 0,
2585 const wxPoint
& pt
= wxDefaultPosition
)
2586 : wxCommandEvent(type
, winid
),
2589 wxContextMenuEvent(const wxContextMenuEvent
& event
)
2590 : wxCommandEvent(event
),
2594 // Position of event (in screen coordinates)
2595 const wxPoint
& GetPosition() const { return m_pos
; }
2596 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2598 virtual wxEvent
*Clone() const { return new wxContextMenuEvent(*this); }
2604 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxContextMenuEvent
)
2614 // Whether to always send idle events to windows, or
2615 // to only send update events to those with the
2616 // wxWS_EX_PROCESS_IDLE style.
2620 // Send idle events to all windows
2623 // Send idle events to windows that have
2624 // the wxWS_EX_PROCESS_IDLE flag specified
2625 wxIDLE_PROCESS_SPECIFIED
2628 class WXDLLIMPEXP_BASE wxIdleEvent
: public wxEvent
2632 : wxEvent(0, wxEVT_IDLE
),
2633 m_requestMore(false)
2635 wxIdleEvent(const wxIdleEvent
& event
)
2637 m_requestMore(event
.m_requestMore
)
2640 void RequestMore(bool needMore
= true) { m_requestMore
= needMore
; }
2641 bool MoreRequested() const { return m_requestMore
; }
2643 virtual wxEvent
*Clone() const { return new wxIdleEvent(*this); }
2645 // Specify how wxWidgets will send idle events: to
2646 // all windows, or only to those which specify that they
2647 // will process the events.
2648 static void SetMode(wxIdleMode mode
) { sm_idleMode
= mode
; }
2650 // Returns the idle event mode
2651 static wxIdleMode
GetMode() { return sm_idleMode
; }
2655 static wxIdleMode sm_idleMode
;
2658 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIdleEvent
)
2662 wxEVT_MOUSE_CAPTURE_CHANGED,
2663 wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
2664 // wxEVT_FONT_CHANGED, // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
2665 // wxEVT_FONT_CHANGED to all other windows (maybe).
2666 wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
2673 // ============================================================================
2674 // event handler and related classes
2675 // ============================================================================
2678 // struct containing the members common to static and dynamic event tables
2680 struct WXDLLIMPEXP_BASE wxEventTableEntryBase
2682 wxEventTableEntryBase(int winid
, int idLast
,
2683 wxEventFunctor
* fn
, wxObject
*data
)
2687 m_callbackUserData(data
)
2690 wxEventTableEntryBase( const wxEventTableEntryBase
&entry
)
2691 : m_id( entry
.m_id
),
2692 m_lastId( entry
.m_lastId
),
2694 m_callbackUserData( entry
.m_callbackUserData
)
2696 // This is a 'hack' to ensure that only one instance tries to delete
2697 // the functor pointer. It is safe as long as the only place where the
2698 // copy constructor is being called is when the static event tables are
2699 // being initialized (a temporary instance is created and then this
2700 // constructor is called).
2702 const_cast<wxEventTableEntryBase
&>( entry
).m_fn
= NULL
;
2705 ~wxEventTableEntryBase()
2710 // the range of ids for this entry: if m_lastId == wxID_ANY, the range
2711 // consists only of m_id, otherwise it is m_id..m_lastId inclusive
2715 // function/method/functor to call
2716 wxEventFunctor
* m_fn
;
2718 // arbitrary user data associated with the callback
2719 wxObject
* m_callbackUserData
;
2722 wxDECLARE_NO_ASSIGN_CLASS(wxEventTableEntryBase
);
2725 // an entry from a static event table
2726 struct WXDLLIMPEXP_BASE wxEventTableEntry
: public wxEventTableEntryBase
2728 wxEventTableEntry(const int& evType
, int winid
, int idLast
,
2729 wxEventFunctor
* fn
, wxObject
*data
)
2730 : wxEventTableEntryBase(winid
, idLast
, fn
, data
),
2734 // the reference to event type: this allows us to not care about the
2735 // (undefined) order in which the event table entries and the event types
2736 // are initialized: initially the value of this reference might be
2737 // invalid, but by the time it is used for the first time, all global
2738 // objects will have been initialized (including the event type constants)
2739 // and so it will have the correct value when it is needed
2740 const int& m_eventType
;
2743 wxDECLARE_NO_ASSIGN_CLASS(wxEventTableEntry
);
2746 // an entry used in dynamic event table managed by wxEvtHandler::Connect()
2747 struct WXDLLIMPEXP_BASE wxDynamicEventTableEntry
: public wxEventTableEntryBase
2749 wxDynamicEventTableEntry(int evType
, int winid
, int idLast
,
2750 wxEventFunctor
* fn
, wxObject
*data
)
2751 : wxEventTableEntryBase(winid
, idLast
, fn
, data
),
2755 // not a reference here as we can't keep a reference to a temporary int
2756 // created to wrap the constant value typically passed to Connect() - nor
2761 wxDECLARE_NO_ASSIGN_CLASS(wxDynamicEventTableEntry
);
2764 // ----------------------------------------------------------------------------
2765 // wxEventTable: an array of event entries terminated with {0, 0, 0, 0, 0}
2766 // ----------------------------------------------------------------------------
2768 struct WXDLLIMPEXP_BASE wxEventTable
2770 const wxEventTable
*baseTable
; // base event table (next in chain)
2771 const wxEventTableEntry
*entries
; // bottom of entry array
2774 // ----------------------------------------------------------------------------
2775 // wxEventHashTable: a helper of wxEvtHandler to speed up wxEventTable lookups.
2776 // ----------------------------------------------------------------------------
2778 WX_DEFINE_ARRAY_PTR(const wxEventTableEntry
*, wxEventTableEntryPointerArray
);
2780 class WXDLLIMPEXP_BASE wxEventHashTable
2783 // Internal data structs
2784 struct EventTypeTable
2786 wxEventType eventType
;
2787 wxEventTableEntryPointerArray eventEntryTable
;
2789 typedef EventTypeTable
* EventTypeTablePointer
;
2792 // Constructor, needs the event table it needs to hash later on.
2793 // Note: hashing of the event table is not done in the constructor as it
2794 // can be that the event table is not yet full initialize, the hash
2795 // will gets initialized when handling the first event look-up request.
2796 wxEventHashTable(const wxEventTable
&table
);
2798 ~wxEventHashTable();
2800 // Handle the given event, in other words search the event table hash
2801 // and call self->ProcessEvent() if a match was found.
2802 bool HandleEvent(wxEvent
& event
, wxEvtHandler
*self
);
2807 #if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
2809 static void ClearAll();
2810 #endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING
2813 // Init the hash table with the entries of the static event table.
2814 void InitHashTable();
2815 // Helper funtion of InitHashTable() to insert 1 entry into the hash table.
2816 void AddEntry(const wxEventTableEntry
&entry
);
2817 // Allocate and init with null pointers the base hash table.
2818 void AllocEventTypeTable(size_t size
);
2819 // Grow the hash table in size and transfer all items currently
2820 // in the table to the correct location in the new table.
2821 void GrowEventTypeTable();
2824 const wxEventTable
&m_table
;
2828 EventTypeTablePointer
*m_eventTypeTable
;
2830 static wxEventHashTable
* sm_first
;
2831 wxEventHashTable
* m_previous
;
2832 wxEventHashTable
* m_next
;
2834 wxDECLARE_NO_COPY_CLASS(wxEventHashTable
);
2837 // ----------------------------------------------------------------------------
2838 // wxEvtHandler: the base class for all objects handling wxWidgets events
2839 // ----------------------------------------------------------------------------
2841 class WXDLLIMPEXP_BASE wxEvtHandler
: public wxObject
2842 , public wxTrackable
2846 virtual ~wxEvtHandler();
2849 // Event handler chain
2850 // -------------------
2852 wxEvtHandler
*GetNextHandler() const { return m_nextHandler
; }
2853 wxEvtHandler
*GetPreviousHandler() const { return m_previousHandler
; }
2854 virtual void SetNextHandler(wxEvtHandler
*handler
) { m_nextHandler
= handler
; }
2855 virtual void SetPreviousHandler(wxEvtHandler
*handler
) { m_previousHandler
= handler
; }
2857 void SetEvtHandlerEnabled(bool enabled
) { m_enabled
= enabled
; }
2858 bool GetEvtHandlerEnabled() const { return m_enabled
; }
2861 bool IsUnlinked() const;
2865 // Event queuing and processing
2866 // ----------------------------
2869 // Process an event right now: this can only be called from the main
2870 // thread, use QueueEvent() for scheduling the events for
2871 // processing from other threads.
2872 virtual bool ProcessEvent(wxEvent
& event
);
2874 // Process an event by calling ProcessEvent and handling any exceptions
2875 // thrown by event handlers. It's mostly useful when processing wx events
2876 // when called from C code (e.g. in GTK+ callback) when the exception
2877 // wouldn't correctly propagate to wxEventLoop.
2878 bool SafelyProcessEvent(wxEvent
& event
);
2879 // NOTE: uses ProcessEvent()
2881 // Schedule the given event to be processed later. It takes ownership of
2882 // the event pointer, i.e. it will be deleted later. This is safe to call
2883 // from multiple threads although you still need to ensure that wxString
2884 // fields of the event object are deep copies and not use the same string
2885 // buffer as other wxString objects in this thread.
2886 virtual void QueueEvent(wxEvent
*event
);
2888 // Add an event to be processed later: notice that this function is not
2889 // safe to call from threads other than main, use QueueEvent()
2890 virtual void AddPendingEvent(const wxEvent
& event
)
2892 // notice that the thread-safety problem comes from the fact that
2893 // Clone() doesn't make deep copies of wxString fields of wxEvent
2894 // object and so the same wxString could be used from both threads when
2895 // the event object is destroyed in this one -- QueueEvent() avoids
2896 // this problem as the event pointer is not used any more in this
2897 // thread at all after it is called.
2898 QueueEvent(event
.Clone());
2901 void ProcessPendingEvents();
2902 // NOTE: uses ProcessEvent()
2905 bool ProcessThreadEvent(const wxEvent
& event
);
2906 // NOTE: uses AddPendingEvent()
2910 // Connecting and disconnecting
2911 // ----------------------------
2913 // These functions are used for old, untyped, event handlers and don't
2914 // check that the type of the function passed to them actually matches the
2915 // type of the event. They also only allow connecting events to methods of
2916 // wxEvtHandler-derived classes.
2918 // The template Connect() methods below are safer and allow connecting
2919 // events to arbitrary functions or functors -- but require compiler
2920 // support for templates.
2922 // Dynamic association of a member function handler with the event handler,
2923 // winid and event type
2924 void Connect(int winid
,
2926 wxEventType eventType
,
2927 wxObjectEventFunction func
,
2928 wxObject
*userData
= NULL
,
2929 wxEvtHandler
*eventSink
= NULL
)
2931 DoConnect(winid
, lastId
, eventType
,
2932 wxNewEventFunctor(eventType
, func
, eventSink
),
2936 // Convenience function: take just one id
2937 void Connect(int winid
,
2938 wxEventType eventType
,
2939 wxObjectEventFunction func
,
2940 wxObject
*userData
= NULL
,
2941 wxEvtHandler
*eventSink
= NULL
)
2942 { Connect(winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
2944 // Even more convenient: without id (same as using id of wxID_ANY)
2945 void Connect(wxEventType eventType
,
2946 wxObjectEventFunction func
,
2947 wxObject
*userData
= NULL
,
2948 wxEvtHandler
*eventSink
= NULL
)
2949 { Connect(wxID_ANY
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
2951 bool Disconnect(int winid
,
2953 wxEventType eventType
,
2954 wxObjectEventFunction func
= NULL
,
2955 wxObject
*userData
= NULL
,
2956 wxEvtHandler
*eventSink
= NULL
)
2958 return DoDisconnect(winid
, lastId
, eventType
,
2959 wxMakeEventFunctor(eventType
, func
, eventSink
),
2963 bool Disconnect(int winid
= wxID_ANY
,
2964 wxEventType eventType
= wxEVT_NULL
,
2965 wxObjectEventFunction func
= NULL
,
2966 wxObject
*userData
= NULL
,
2967 wxEvtHandler
*eventSink
= NULL
)
2968 { return Disconnect(winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
2970 bool Disconnect(wxEventType eventType
,
2971 wxObjectEventFunction func
,
2972 wxObject
*userData
= NULL
,
2973 wxEvtHandler
*eventSink
= NULL
)
2974 { return Disconnect(wxID_ANY
, eventType
, func
, userData
, eventSink
); }
2976 #if !wxEVENTS_COMPATIBILITY_2_8
2977 // Event handling in functions (including generalized functors):
2979 template <typename EventTag
, typename Functor
>
2980 void Connect(int winid
,
2982 const EventTag
& eventType
,
2985 DoConnect(winid
, lastId
, eventType
,
2986 wxNewEventFunctor(eventType
, func
));
2989 template <typename EventTag
, typename Functor
>
2990 void Connect(int winid
, const EventTag
& eventType
, Functor func
)
2991 { Connect(winid
, wxID_ANY
, eventType
, func
); }
2993 template <typename EventTag
, typename Functor
>
2994 void Connect(const EventTag
& eventType
, Functor func
)
2995 { Connect(wxID_ANY
, eventType
, func
); }
2998 template <typename EventTag
, typename Functor
>
2999 bool Disconnect(int winid
,
3001 const EventTag
& eventType
,
3004 return DoDisconnect(winid
, lastId
, eventType
,
3005 wxMakeEventFunctor(eventType
, func
));
3008 template <typename EventTag
, typename Functor
>
3009 bool Disconnect(int winid
, const EventTag
& eventType
, Functor func
)
3010 { return Disconnect(winid
, wxID_ANY
, eventType
, func
); }
3012 template <typename EventTag
, typename Functor
>
3013 bool Disconnect(const EventTag
& eventType
, Functor func
)
3014 { return Disconnect(wxID_ANY
, eventType
, func
); }
3018 // Event handling in class methods: the object handling the event (i.e.
3019 // this object itself by default or eventSink if specified) must be
3020 // convertible to this class.
3022 // Notice that we need to have separate overloads for the versions with and
3023 // without eventSink because in the latter case we must check that this
3024 // object itself derives from Class while in the former this is not
3027 // Methods connecting/disconnecting event to this object itself
3029 template <typename EventTag
, typename Class
, typename EventArg
>
3030 void Connect(int winid
,
3032 const EventTag
& eventType
,
3033 void (Class::*func
)(EventArg
&),
3034 wxObject
*userData
= NULL
)
3036 DoConnect(winid
, lastId
, eventType
,
3037 wxNewEventFunctor(eventType
, func
, static_cast<Class
*>(this)),
3041 template <typename EventTag
, typename Class
, typename EventArg
>
3042 void Connect(int winid
,
3043 const EventTag
& eventType
,
3044 void (Class::*func
)(EventArg
&),
3045 wxObject
*userData
= NULL
)
3046 { Connect(winid
, wxID_ANY
, eventType
, func
, userData
); }
3048 template <typename EventTag
, typename Class
, typename EventArg
>
3049 void Connect(const EventTag
& eventType
,
3050 void (Class::*func
)(EventArg
&),
3051 wxObject
*userData
= NULL
)
3052 { Connect(wxID_ANY
, eventType
, func
, userData
); }
3055 template <typename EventTag
, typename Class
, typename EventArg
>
3056 bool Disconnect(int winid
,
3058 const EventTag
& eventType
,
3059 void (Class::*func
)(EventArg
&),
3060 wxObject
*userData
= NULL
)
3062 return DoDisconnect(winid
, lastId
, eventType
,
3063 wxMakeEventFunctor(eventType
, func
,
3064 static_cast<Class
*>(this)),
3068 template <typename EventTag
, typename Class
, typename EventArg
>
3069 bool Disconnect(int winid
,
3070 const EventTag
& eventType
,
3071 void (Class::*func
)(EventArg
&),
3072 wxObject
*userData
= NULL
)
3073 { return Disconnect(winid
, wxID_ANY
, eventType
, func
, userData
); }
3075 template <typename EventTag
, typename Class
, typename EventArg
>
3076 bool Disconnect(const EventTag
& eventType
,
3077 void (Class::*func
)(EventArg
&),
3078 wxObject
*userData
= NULL
)
3079 { return Disconnect(wxID_ANY
, eventType
, func
, userData
); }
3082 // Methods connecting/disconnecting event to another object
3085 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
3086 void Connect(int winid
,
3088 const EventTag
& eventType
,
3089 void (Class::*func
)(EventArg
&),
3091 ObjClass
*eventSink
)
3093 DoConnect(winid
, lastId
, eventType
,
3094 wxNewEventFunctor(eventType
, func
, eventSink
),
3099 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
3100 void Connect(int winid
,
3101 const EventTag
& eventType
,
3102 void (Class::*func
)(EventArg
&),
3104 ObjClass
*eventSink
)
3105 { Connect(winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3108 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
3109 void Connect(const EventTag
& eventType
,
3110 void (Class::*func
)(EventArg
&),
3112 ObjClass
*eventSink
)
3113 { Connect(wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3117 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
3118 bool Disconnect(int winid
,
3120 const EventTag
& eventType
,
3121 void (Class::*func
)(EventArg
&),
3123 ObjClass
*eventSink
)
3125 return DoDisconnect(winid
, lastId
, eventType
,
3126 wxMakeEventFunctor(eventType
, func
, eventSink
),
3131 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
3132 bool Disconnect(int winid
,
3133 const EventTag
& eventType
,
3134 void (Class::*func
)(EventArg
&),
3136 ObjClass
*eventSink
)
3137 { return Disconnect(winid
, wxID_ANY
, eventType
, func
,
3138 userData
, eventSink
); }
3141 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
3142 bool Disconnect(const EventTag
& eventType
,
3143 void (Class::*func
)(EventArg
&),
3145 ObjClass
*eventSink
)
3146 { return Disconnect(wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3150 // Static version of Connect() which allows to specify the event source and
3151 // event handler in a more symmetric way
3152 template <typename ObjSource
, typename EventTag
,
3153 typename Class
, typename EventArg
, typename ObjClass
>
3154 static void Connect(ObjSource
*eventSrc
,
3157 const EventTag
& eventType
,
3158 void (Class::*func
)(EventArg
&),
3159 wxObject
*userData
= NULL
,
3160 ObjClass
*eventSink
= NULL
)
3162 eventSrc
->Connect(winid
, lastId
, eventType
, func
, userData
, eventSink
);
3165 template <typename ObjSource
, typename EventTag
,
3166 typename Class
, typename EventArg
, typename ObjClass
>
3167 static void Connect(ObjSource
*eventSrc
,
3169 const EventTag
& eventType
,
3170 void (Class::*func
)(EventArg
&),
3171 wxObject
*userData
= NULL
,
3172 ObjClass
*eventSink
= NULL
)
3174 Connect(eventSrc
, winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
);
3177 template <typename ObjSource
, typename EventTag
,
3178 typename Class
, typename EventArg
, typename ObjClass
>
3179 static void Connect(ObjSource
*eventSrc
,
3180 const EventTag
& eventType
,
3181 void (Class::*func
)(EventArg
&),
3182 wxObject
*userData
= NULL
,
3183 ObjClass
*eventSink
= NULL
)
3185 Connect(eventSrc
, wxID_ANY
, eventType
, func
, userData
, eventSink
);
3189 template <typename ObjSource
, typename EventTag
,
3190 typename Class
, typename EventArg
, typename ObjClass
>
3191 static bool Disconnect(ObjSource
*eventSrc
,
3194 const EventTag
& eventType
,
3195 void (Class::*func
)(EventArg
&),
3196 wxObject
*userData
= NULL
,
3197 ObjClass
*eventSink
= NULL
)
3199 return eventSrc
->Disconnect(winid
, lastId
, eventType
, func
,
3200 userData
, eventSink
);
3203 template <typename ObjSource
, typename EventTag
,
3204 typename Class
, typename EventArg
, typename ObjClass
>
3205 static bool Disconnect(ObjSource
*eventSrc
,
3207 const EventTag
& eventType
,
3208 void (Class::*func
)(EventArg
&),
3209 wxObject
*userData
= NULL
,
3210 ObjClass
*eventSink
= NULL
)
3212 return Disconnect(eventSrc
, winid
, wxID_ANY
, eventType
, func
,
3213 userData
, eventSink
);
3216 template <typename ObjSource
, typename EventTag
,
3217 typename Class
, typename EventArg
, typename ObjClass
>
3218 static bool Disconnect(ObjSource
*eventSrc
,
3219 const EventTag
& eventType
,
3220 void (Class::*func
)(EventArg
&),
3221 wxObject
*userData
= NULL
,
3222 ObjClass
*eventSink
= NULL
)
3224 return Disconnect(eventSrc
, wxID_ANY
, eventType
, func
,
3225 userData
, eventSink
);
3227 #endif // !wxEVENTS_COMPATIBILITY_2_8
3230 wxList
* GetDynamicEventTable() const { return m_dynamicEvents
; }
3232 // User data can be associated with each wxEvtHandler
3233 void SetClientObject( wxClientData
*data
) { DoSetClientObject(data
); }
3234 wxClientData
*GetClientObject() const { return DoGetClientObject(); }
3236 void SetClientData( void *data
) { DoSetClientData(data
); }
3237 void *GetClientData() const { return DoGetClientData(); }
3240 // implementation from now on
3241 // --------------------------
3243 // check if the given event table entry matches this event by id (the check
3244 // for the event type should be done by caller) and call the handler if it
3247 // return true if the event was processed, false otherwise (no match or the
3248 // handler decided to skip the event)
3249 static bool ProcessEventIfMatchesId(const wxEventTableEntryBase
& tableEntry
,
3250 wxEvtHandler
*handler
,
3253 virtual bool SearchEventTable(wxEventTable
& table
, wxEvent
& event
);
3254 bool SearchDynamicEventTable( wxEvent
& event
);
3256 // Avoid problems at exit by cleaning up static hash table gracefully
3257 void ClearEventHashTable() { GetEventHashTable().Clear(); }
3258 void OnSinkDestroyed( wxEvtHandler
*sink
);
3261 // The method tries to process the event in this event handler.
3263 // It is meant to be called from ProcessEvent() only and is not virtual,
3264 // additional event handlers can be hooked into the normal event processing
3265 // logic using TryValidator() hook.
3266 bool ProcessEventHere(wxEvent
& event
);
3270 void DoConnect(int winid
,
3272 wxEventType eventType
,
3273 wxEventFunctor
*func
,
3274 wxObject
* userData
= NULL
);
3276 bool DoDisconnect(int winid
,
3278 wxEventType eventType
,
3279 const wxEventFunctor
& func
,
3280 wxObject
*userData
= NULL
);
3282 static const wxEventTableEntry sm_eventTableEntries
[];
3285 // hooks for wxWindow used by ProcessEvent()
3286 // -----------------------------------------
3288 // This one is called before trying our own event table to allow plugging
3289 // in the validators.
3291 // NB: This method is intentionally *not* inside wxUSE_VALIDATORS!
3292 // It is part of wxBase which doesn't use validators and the code
3293 // is compiled out when building wxBase w/o GUI classes, which affects
3294 // binary compatibility and wxBase library can't be used by GUI
3296 virtual bool TryValidator(wxEvent
& WXUNUSED(event
)) { return false; }
3298 // this one is called after failing to find the event handle in our own
3299 // table to give a chance to the other windows to process it
3301 // base class implementation passes the event to wxTheApp
3302 virtual bool TryParent(wxEvent
& event
);
3305 static const wxEventTable sm_eventTable
;
3306 virtual const wxEventTable
*GetEventTable() const;
3308 static wxEventHashTable sm_eventHashTable
;
3309 virtual wxEventHashTable
& GetEventHashTable() const;
3311 wxEvtHandler
* m_nextHandler
;
3312 wxEvtHandler
* m_previousHandler
;
3313 wxList
* m_dynamicEvents
;
3314 wxList
* m_pendingEvents
;
3317 // critical section protecting m_pendingEvents
3318 wxCriticalSection m_pendingEventsLock
;
3319 #endif // wxUSE_THREADS
3321 // Is event handler enabled?
3325 // The user data: either an object which will be deleted by the container
3326 // when it's deleted or some raw pointer which we do nothing with - only
3327 // one type of data can be used with the given window (i.e. you cannot set
3328 // the void data and then associate the container with wxClientData or vice
3332 wxClientData
*m_clientObject
;
3336 // what kind of data do we have?
3337 wxClientDataType m_clientDataType
;
3339 // client data accessors
3340 virtual void DoSetClientObject( wxClientData
*data
);
3341 virtual wxClientData
*DoGetClientObject() const;
3343 virtual void DoSetClientData( void *data
);
3344 virtual void *DoGetClientData() const;
3346 // Search tracker objects for event connection with this sink
3347 wxEventConnectionRef
*FindRefInTrackerList(wxEvtHandler
*eventSink
);
3350 DECLARE_DYNAMIC_CLASS_NO_COPY(wxEvtHandler
)
3353 WX_DEFINE_EXPORTED_ARRAY_PTR(wxEvtHandler
*, wxEvtHandlerArray
);
3355 // ----------------------------------------------------------------------------
3356 // wxEventConnectionRef represents all connections between two event handlers
3357 // and enables automatic disconnect when an event handler sink goes out of
3358 // scope. Each connection/disconnect increases/decreases ref count, and
3359 // when it reaches zero the node goes out of scope.
3360 // ----------------------------------------------------------------------------
3362 class wxEventConnectionRef
: public wxTrackerNode
3365 wxEventConnectionRef() : m_src(NULL
), m_sink(NULL
), m_refCount(0) { }
3366 wxEventConnectionRef(wxEvtHandler
*src
, wxEvtHandler
*sink
)
3367 : m_src(src
), m_sink(sink
), m_refCount(1)
3369 m_sink
->AddNode(this);
3372 // The sink is being destroyed
3373 virtual void OnObjectDestroy( )
3376 m_src
->OnSinkDestroyed( m_sink
);
3380 virtual wxEventConnectionRef
*ToEventConnection() { return this; }
3382 void IncRef() { m_refCount
++; }
3385 if ( !--m_refCount
)
3387 // The sink holds the only external pointer to this object
3389 m_sink
->RemoveNode(this);
3395 wxEvtHandler
*m_src
,
3399 friend class wxEvtHandler
;
3401 wxDECLARE_NO_ASSIGN_CLASS(wxEventConnectionRef
);
3404 // Post a message to the given event handler which will be processed during the
3405 // next event loop iteration.
3407 // Notice that this one is not thread-safe, use wxQueueEvent()
3408 inline void wxPostEvent(wxEvtHandler
*dest
, const wxEvent
& event
)
3410 wxCHECK_RET( dest
, "need an object to post event to" );
3412 dest
->AddPendingEvent(event
);
3415 // Wrapper around wxEvtHandler::QueueEvent(): adds an event for later
3416 // processing, unlike wxPostEvent it is safe to use from different thread even
3417 // for events with wxString members
3418 inline void wxQueueEvent(wxEvtHandler
*dest
, wxEvent
*event
)
3420 wxCHECK_RET( dest
, "need an object to queue event for" );
3422 dest
->QueueEvent(event
);
3425 typedef void (wxEvtHandler::*wxEventFunction
)(wxEvent
&);
3426 typedef void (wxEvtHandler::*wxIdleEventFunction
)(wxIdleEvent
&);
3428 #define wxEventHandler(func) \
3429 wxEVENT_HANDLER_CAST(wxEventFunction, func)
3430 #define wxIdleEventHandler(func) \
3431 wxEVENT_HANDLER_CAST(wxIdleEventFunction, func)
3435 // ----------------------------------------------------------------------------
3436 // wxEventBlocker: helper class to temporarily disable event handling for a window
3437 // ----------------------------------------------------------------------------
3439 class WXDLLIMPEXP_CORE wxEventBlocker
: public wxEvtHandler
3442 wxEventBlocker(wxWindow
*win
, wxEventType type
= wxEVT_ANY
);
3443 virtual ~wxEventBlocker();
3445 void Block(wxEventType type
)
3447 m_eventsToBlock
.push_back(type
);
3450 virtual bool ProcessEvent(wxEvent
& event
);
3453 wxArrayInt m_eventsToBlock
;
3456 wxDECLARE_NO_COPY_CLASS(wxEventBlocker
);
3459 typedef void (wxEvtHandler::*wxCommandEventFunction
)(wxCommandEvent
&);
3460 typedef void (wxEvtHandler::*wxThreadEventFunction
)(wxThreadEvent
&);
3461 typedef void (wxEvtHandler::*wxScrollEventFunction
)(wxScrollEvent
&);
3462 typedef void (wxEvtHandler::*wxScrollWinEventFunction
)(wxScrollWinEvent
&);
3463 typedef void (wxEvtHandler::*wxSizeEventFunction
)(wxSizeEvent
&);
3464 typedef void (wxEvtHandler::*wxMoveEventFunction
)(wxMoveEvent
&);
3465 typedef void (wxEvtHandler::*wxPaintEventFunction
)(wxPaintEvent
&);
3466 typedef void (wxEvtHandler::*wxNcPaintEventFunction
)(wxNcPaintEvent
&);
3467 typedef void (wxEvtHandler::*wxEraseEventFunction
)(wxEraseEvent
&);
3468 typedef void (wxEvtHandler::*wxMouseEventFunction
)(wxMouseEvent
&);
3469 typedef void (wxEvtHandler::*wxCharEventFunction
)(wxKeyEvent
&);
3470 typedef void (wxEvtHandler::*wxFocusEventFunction
)(wxFocusEvent
&);
3471 typedef void (wxEvtHandler::*wxChildFocusEventFunction
)(wxChildFocusEvent
&);
3472 typedef void (wxEvtHandler::*wxActivateEventFunction
)(wxActivateEvent
&);
3473 typedef void (wxEvtHandler::*wxMenuEventFunction
)(wxMenuEvent
&);
3474 typedef void (wxEvtHandler::*wxJoystickEventFunction
)(wxJoystickEvent
&);
3475 typedef void (wxEvtHandler::*wxDropFilesEventFunction
)(wxDropFilesEvent
&);
3476 typedef void (wxEvtHandler::*wxInitDialogEventFunction
)(wxInitDialogEvent
&);
3477 typedef void (wxEvtHandler::*wxSysColourChangedEventFunction
)(wxSysColourChangedEvent
&);
3478 typedef void (wxEvtHandler::*wxDisplayChangedEventFunction
)(wxDisplayChangedEvent
&);
3479 typedef void (wxEvtHandler::*wxUpdateUIEventFunction
)(wxUpdateUIEvent
&);
3480 typedef void (wxEvtHandler::*wxCloseEventFunction
)(wxCloseEvent
&);
3481 typedef void (wxEvtHandler::*wxShowEventFunction
)(wxShowEvent
&);
3482 typedef void (wxEvtHandler::*wxIconizeEventFunction
)(wxIconizeEvent
&);
3483 typedef void (wxEvtHandler::*wxMaximizeEventFunction
)(wxMaximizeEvent
&);
3484 typedef void (wxEvtHandler::*wxNavigationKeyEventFunction
)(wxNavigationKeyEvent
&);
3485 typedef void (wxEvtHandler::*wxPaletteChangedEventFunction
)(wxPaletteChangedEvent
&);
3486 typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction
)(wxQueryNewPaletteEvent
&);
3487 typedef void (wxEvtHandler::*wxWindowCreateEventFunction
)(wxWindowCreateEvent
&);
3488 typedef void (wxEvtHandler::*wxWindowDestroyEventFunction
)(wxWindowDestroyEvent
&);
3489 typedef void (wxEvtHandler::*wxSetCursorEventFunction
)(wxSetCursorEvent
&);
3490 typedef void (wxEvtHandler::*wxNotifyEventFunction
)(wxNotifyEvent
&);
3491 typedef void (wxEvtHandler::*wxHelpEventFunction
)(wxHelpEvent
&);
3492 typedef void (wxEvtHandler::*wxContextMenuEventFunction
)(wxContextMenuEvent
&);
3493 typedef void (wxEvtHandler::*wxMouseCaptureChangedEventFunction
)(wxMouseCaptureChangedEvent
&);
3494 typedef void (wxEvtHandler::*wxMouseCaptureLostEventFunction
)(wxMouseCaptureLostEvent
&);
3495 typedef void (wxEvtHandler::*wxClipboardTextEventFunction
)(wxClipboardTextEvent
&);
3498 #define wxCommandEventHandler(func) \
3499 wxEVENT_HANDLER_CAST(wxCommandEventFunction, func)
3500 #define wxThreadEventHandler(func) \
3501 wxEVENT_HANDLER_CAST(wxThreadEventFunction, func)
3502 #define wxScrollEventHandler(func) \
3503 wxEVENT_HANDLER_CAST(wxScrollEventFunction, func)
3504 #define wxScrollWinEventHandler(func) \
3505 wxEVENT_HANDLER_CAST(wxScrollWinEventFunction, func)
3506 #define wxSizeEventHandler(func) \
3507 wxEVENT_HANDLER_CAST(wxSizeEventFunction, func)
3508 #define wxMoveEventHandler(func) \
3509 wxEVENT_HANDLER_CAST(wxMoveEventFunction, func)
3510 #define wxPaintEventHandler(func) \
3511 wxEVENT_HANDLER_CAST(wxPaintEventFunction, func)
3512 #define wxNcPaintEventHandler(func) \
3513 wxEVENT_HANDLER_CAST(wxNcPaintEventFunction, func)
3514 #define wxEraseEventHandler(func) \
3515 wxEVENT_HANDLER_CAST(wxEraseEventFunction, func)
3516 #define wxMouseEventHandler(func) \
3517 wxEVENT_HANDLER_CAST(wxMouseEventFunction, func)
3518 #define wxCharEventHandler(func) \
3519 wxEVENT_HANDLER_CAST(wxCharEventFunction, func)
3520 #define wxKeyEventHandler(func) wxCharEventHandler(func)
3521 #define wxFocusEventHandler(func) \
3522 wxEVENT_HANDLER_CAST(wxFocusEventFunction, func)
3523 #define wxChildFocusEventHandler(func) \
3524 wxEVENT_HANDLER_CAST(wxChildFocusEventFunction, func)
3525 #define wxActivateEventHandler(func) \
3526 wxEVENT_HANDLER_CAST(wxActivateEventFunction, func)
3527 #define wxMenuEventHandler(func) \
3528 wxEVENT_HANDLER_CAST(wxMenuEventFunction, func)
3529 #define wxJoystickEventHandler(func) \
3530 wxEVENT_HANDLER_CAST(wxJoystickEventFunction, func)
3531 #define wxDropFilesEventHandler(func) \
3532 wxEVENT_HANDLER_CAST(wxDropFilesEventFunction, func)
3533 #define wxInitDialogEventHandler(func) \
3534 wxEVENT_HANDLER_CAST(wxInitDialogEventFunction, func)
3535 #define wxSysColourChangedEventHandler(func) \
3536 wxEVENT_HANDLER_CAST(wxSysColourChangedEventFunction, func)
3537 #define wxDisplayChangedEventHandler(func) \
3538 wxEVENT_HANDLER_CAST(wxDisplayChangedEventFunction, func)
3539 #define wxUpdateUIEventHandler(func) \
3540 wxEVENT_HANDLER_CAST(wxUpdateUIEventFunction, func)
3541 #define wxCloseEventHandler(func) \
3542 wxEVENT_HANDLER_CAST(wxCloseEventFunction, func)
3543 #define wxShowEventHandler(func) \
3544 wxEVENT_HANDLER_CAST(wxShowEventFunction, func)
3545 #define wxIconizeEventHandler(func) \
3546 wxEVENT_HANDLER_CAST(wxIconizeEventFunction, func)
3547 #define wxMaximizeEventHandler(func) \
3548 wxEVENT_HANDLER_CAST(wxMaximizeEventFunction, func)
3549 #define wxNavigationKeyEventHandler(func) \
3550 wxEVENT_HANDLER_CAST(wxNavigationKeyEventFunction, func)
3551 #define wxPaletteChangedEventHandler(func) \
3552 wxEVENT_HANDLER_CAST(wxPaletteChangedEventFunction, func)
3553 #define wxQueryNewPaletteEventHandler(func) \
3554 wxEVENT_HANDLER_CAST(wxQueryNewPaletteEventFunction, func)
3555 #define wxWindowCreateEventHandler(func) \
3556 wxEVENT_HANDLER_CAST(wxWindowCreateEventFunction, func)
3557 #define wxWindowDestroyEventHandler(func) \
3558 wxEVENT_HANDLER_CAST(wxWindowDestroyEventFunction, func)
3559 #define wxSetCursorEventHandler(func) \
3560 wxEVENT_HANDLER_CAST(wxSetCursorEventFunction, func)
3561 #define wxNotifyEventHandler(func) \
3562 wxEVENT_HANDLER_CAST(wxNotifyEventFunction, func)
3563 #define wxHelpEventHandler(func) \
3564 wxEVENT_HANDLER_CAST(wxHelpEventFunction, func)
3565 #define wxContextMenuEventHandler(func) \
3566 wxEVENT_HANDLER_CAST(wxContextMenuEventFunction, func)
3567 #define wxMouseCaptureChangedEventHandler(func) \
3568 wxEVENT_HANDLER_CAST(wxMouseCaptureChangedEventFunction, func)
3569 #define wxMouseCaptureLostEventHandler(func) \
3570 wxEVENT_HANDLER_CAST(wxMouseCaptureLostEventFunction, func)
3571 #define wxClipboardTextEventHandler(func) \
3572 wxEVENT_HANDLER_CAST(wxClipboardTextEventFunction, func)
3576 // N.B. In GNU-WIN32, you *have* to take the address of a member function
3577 // (use &) or the compiler crashes...
3579 #define DECLARE_EVENT_TABLE() \
3581 static const wxEventTableEntry sm_eventTableEntries[]; \
3583 static const wxEventTable sm_eventTable; \
3584 virtual const wxEventTable* GetEventTable() const; \
3585 static wxEventHashTable sm_eventHashTable; \
3586 virtual wxEventHashTable& GetEventHashTable() const;
3588 // N.B.: when building DLL with Borland C++ 5.5 compiler, you must initialize
3589 // sm_eventTable before using it in GetEventTable() or the compiler gives
3590 // E2233 (see http://groups.google.com/groups?selm=397dcc8a%241_2%40dnews)
3592 #define BEGIN_EVENT_TABLE(theClass, baseClass) \
3593 const wxEventTable theClass::sm_eventTable = \
3594 { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] }; \
3595 const wxEventTable *theClass::GetEventTable() const \
3596 { return &theClass::sm_eventTable; } \
3597 wxEventHashTable theClass::sm_eventHashTable(theClass::sm_eventTable); \
3598 wxEventHashTable &theClass::GetEventHashTable() const \
3599 { return theClass::sm_eventHashTable; } \
3600 const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
3602 #define BEGIN_EVENT_TABLE_TEMPLATE1(theClass, baseClass, T1) \
3603 template<typename T1> \
3604 const wxEventTable theClass<T1>::sm_eventTable = \
3605 { &baseClass::sm_eventTable, &theClass<T1>::sm_eventTableEntries[0] }; \
3606 template<typename T1> \
3607 const wxEventTable *theClass<T1>::GetEventTable() const \
3608 { return &theClass<T1>::sm_eventTable; } \
3609 template<typename T1> \
3610 wxEventHashTable theClass<T1>::sm_eventHashTable(theClass<T1>::sm_eventTable); \
3611 template<typename T1> \
3612 wxEventHashTable &theClass<T1>::GetEventHashTable() const \
3613 { return theClass<T1>::sm_eventHashTable; } \
3614 template<typename T1> \
3615 const wxEventTableEntry theClass<T1>::sm_eventTableEntries[] = { \
3617 #define BEGIN_EVENT_TABLE_TEMPLATE2(theClass, baseClass, T1, T2) \
3618 template<typename T1, typename T2> \
3619 const wxEventTable theClass<T1, T2>::sm_eventTable = \
3620 { &baseClass::sm_eventTable, &theClass<T1, T2>::sm_eventTableEntries[0] }; \
3621 template<typename T1, typename T2> \
3622 const wxEventTable *theClass<T1, T2>::GetEventTable() const \
3623 { return &theClass<T1, T2>::sm_eventTable; } \
3624 template<typename T1, typename T2> \
3625 wxEventHashTable theClass<T1, T2>::sm_eventHashTable(theClass<T1, T2>::sm_eventTable); \
3626 template<typename T1, typename T2> \
3627 wxEventHashTable &theClass<T1, T2>::GetEventHashTable() const \
3628 { return theClass<T1, T2>::sm_eventHashTable; } \
3629 template<typename T1, typename T2> \
3630 const wxEventTableEntry theClass<T1, T2>::sm_eventTableEntries[] = { \
3632 #define BEGIN_EVENT_TABLE_TEMPLATE3(theClass, baseClass, T1, T2, T3) \
3633 template<typename T1, typename T2, typename T3> \
3634 const wxEventTable theClass<T1, T2, T3>::sm_eventTable = \
3635 { &baseClass::sm_eventTable, &theClass<T1, T2, T3>::sm_eventTableEntries[0] }; \
3636 template<typename T1, typename T2, typename T3> \
3637 const wxEventTable *theClass<T1, T2, T3>::GetEventTable() const \
3638 { return &theClass<T1, T2, T3>::sm_eventTable; } \
3639 template<typename T1, typename T2, typename T3> \
3640 wxEventHashTable theClass<T1, T2, T3>::sm_eventHashTable(theClass<T1, T2, T3>::sm_eventTable); \
3641 template<typename T1, typename T2, typename T3> \
3642 wxEventHashTable &theClass<T1, T2, T3>::GetEventHashTable() const \
3643 { return theClass<T1, T2, T3>::sm_eventHashTable; } \
3644 template<typename T1, typename T2, typename T3> \
3645 const wxEventTableEntry theClass<T1, T2, T3>::sm_eventTableEntries[] = { \
3647 #define BEGIN_EVENT_TABLE_TEMPLATE4(theClass, baseClass, T1, T2, T3, T4) \
3648 template<typename T1, typename T2, typename T3, typename T4> \
3649 const wxEventTable theClass<T1, T2, T3, T4>::sm_eventTable = \
3650 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4>::sm_eventTableEntries[0] }; \
3651 template<typename T1, typename T2, typename T3, typename T4> \
3652 const wxEventTable *theClass<T1, T2, T3, T4>::GetEventTable() const \
3653 { return &theClass<T1, T2, T3, T4>::sm_eventTable; } \
3654 template<typename T1, typename T2, typename T3, typename T4> \
3655 wxEventHashTable theClass<T1, T2, T3, T4>::sm_eventHashTable(theClass<T1, T2, T3, T4>::sm_eventTable); \
3656 template<typename T1, typename T2, typename T3, typename T4> \
3657 wxEventHashTable &theClass<T1, T2, T3, T4>::GetEventHashTable() const \
3658 { return theClass<T1, T2, T3, T4>::sm_eventHashTable; } \
3659 template<typename T1, typename T2, typename T3, typename T4> \
3660 const wxEventTableEntry theClass<T1, T2, T3, T4>::sm_eventTableEntries[] = { \
3662 #define BEGIN_EVENT_TABLE_TEMPLATE5(theClass, baseClass, T1, T2, T3, T4, T5) \
3663 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3664 const wxEventTable theClass<T1, T2, T3, T4, T5>::sm_eventTable = \
3665 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[0] }; \
3666 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3667 const wxEventTable *theClass<T1, T2, T3, T4, T5>::GetEventTable() const \
3668 { return &theClass<T1, T2, T3, T4, T5>::sm_eventTable; } \
3669 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3670 wxEventHashTable theClass<T1, T2, T3, T4, T5>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5>::sm_eventTable); \
3671 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3672 wxEventHashTable &theClass<T1, T2, T3, T4, T5>::GetEventHashTable() const \
3673 { return theClass<T1, T2, T3, T4, T5>::sm_eventHashTable; } \
3674 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3675 const wxEventTableEntry theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[] = { \
3677 #define BEGIN_EVENT_TABLE_TEMPLATE7(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7) \
3678 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3679 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable = \
3680 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[0] }; \
3681 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3682 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventTable() const \
3683 { return &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable; } \
3684 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3685 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable); \
3686 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3687 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventHashTable() const \
3688 { return theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable; } \
3689 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3690 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[] = { \
3692 #define BEGIN_EVENT_TABLE_TEMPLATE8(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7, T8) \
3693 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3694 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable = \
3695 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[0] }; \
3696 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3697 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventTable() const \
3698 { return &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable; } \
3699 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3700 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable); \
3701 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3702 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventHashTable() const \
3703 { return theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable; } \
3704 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3705 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[] = { \
3707 #define END_EVENT_TABLE() DECLARE_EVENT_TABLE_TERMINATOR() };
3710 * Event table macros
3713 // helpers for writing shorter code below: declare an event macro taking 2, 1
3714 // or none ids (the missing ids default to wxID_ANY)
3717 // - evt one of wxEVT_XXX constants
3718 // - id1, id2 ids of the first/last id
3719 // - fn the function (should be cast to the right type)
3720 #define wx__DECLARE_EVT2(evt, id1, id2, fn) \
3721 DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
3722 #define wx__DECLARE_EVT1(evt, id, fn) \
3723 wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
3724 #define wx__DECLARE_EVT0(evt, fn) \
3725 wx__DECLARE_EVT1(evt, wxID_ANY, fn)
3729 #define EVT_CUSTOM(event, winid, func) \
3730 wx__DECLARE_EVT1(event, winid, wxEventHandler(func))
3731 #define EVT_CUSTOM_RANGE(event, id1, id2, func) \
3732 wx__DECLARE_EVT2(event, id1, id2, wxEventHandler(func))
3735 #define EVT_COMMAND(winid, event, func) \
3736 wx__DECLARE_EVT1(event, winid, wxCommandEventHandler(func))
3738 #define EVT_COMMAND_RANGE(id1, id2, event, func) \
3739 wx__DECLARE_EVT2(event, id1, id2, wxCommandEventHandler(func))
3741 #define EVT_NOTIFY(event, winid, func) \
3742 wx__DECLARE_EVT1(event, winid, wxNotifyEventHandler(func))
3744 #define EVT_NOTIFY_RANGE(event, id1, id2, func) \
3745 wx__DECLARE_EVT2(event, id1, id2, wxNotifyEventHandler(func))
3748 #define EVT_SIZE(func) wx__DECLARE_EVT0(wxEVT_SIZE, wxSizeEventHandler(func))
3749 #define EVT_SIZING(func) wx__DECLARE_EVT0(wxEVT_SIZING, wxSizeEventHandler(func))
3750 #define EVT_MOVE(func) wx__DECLARE_EVT0(wxEVT_MOVE, wxMoveEventHandler(func))
3751 #define EVT_MOVING(func) wx__DECLARE_EVT0(wxEVT_MOVING, wxMoveEventHandler(func))
3752 #define EVT_MOVE_START(func) wx__DECLARE_EVT0(wxEVT_MOVE_START, wxMoveEventHandler(func))
3753 #define EVT_MOVE_END(func) wx__DECLARE_EVT0(wxEVT_MOVE_END, wxMoveEventHandler(func))
3754 #define EVT_CLOSE(func) wx__DECLARE_EVT0(wxEVT_CLOSE_WINDOW, wxCloseEventHandler(func))
3755 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3756 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3757 #define EVT_PAINT(func) wx__DECLARE_EVT0(wxEVT_PAINT, wxPaintEventHandler(func))
3758 #define EVT_NC_PAINT(func) wx__DECLARE_EVT0(wxEVT_NC_PAINT, wxNcPaintEventHandler(func))
3759 #define EVT_ERASE_BACKGROUND(func) wx__DECLARE_EVT0(wxEVT_ERASE_BACKGROUND, wxEraseEventHandler(func))
3760 #define EVT_CHAR(func) wx__DECLARE_EVT0(wxEVT_CHAR, wxCharEventHandler(func))
3761 #define EVT_KEY_DOWN(func) wx__DECLARE_EVT0(wxEVT_KEY_DOWN, wxKeyEventHandler(func))
3762 #define EVT_KEY_UP(func) wx__DECLARE_EVT0(wxEVT_KEY_UP, wxKeyEventHandler(func))
3764 #define EVT_HOTKEY(winid, func) wx__DECLARE_EVT1(wxEVT_HOTKEY, winid, wxCharEventHandler(func))
3766 #define EVT_CHAR_HOOK(func) wx__DECLARE_EVT0(wxEVT_CHAR_HOOK, wxCharEventHandler(func))
3767 #define EVT_MENU_OPEN(func) wx__DECLARE_EVT0(wxEVT_MENU_OPEN, wxMenuEventHandler(func))
3768 #define EVT_MENU_CLOSE(func) wx__DECLARE_EVT0(wxEVT_MENU_CLOSE, wxMenuEventHandler(func))
3769 #define EVT_MENU_HIGHLIGHT(winid, func) wx__DECLARE_EVT1(wxEVT_MENU_HIGHLIGHT, winid, wxMenuEventHandler(func))
3770 #define EVT_MENU_HIGHLIGHT_ALL(func) wx__DECLARE_EVT0(wxEVT_MENU_HIGHLIGHT, wxMenuEventHandler(func))
3771 #define EVT_SET_FOCUS(func) wx__DECLARE_EVT0(wxEVT_SET_FOCUS, wxFocusEventHandler(func))
3772 #define EVT_KILL_FOCUS(func) wx__DECLARE_EVT0(wxEVT_KILL_FOCUS, wxFocusEventHandler(func))
3773 #define EVT_CHILD_FOCUS(func) wx__DECLARE_EVT0(wxEVT_CHILD_FOCUS, wxChildFocusEventHandler(func))
3774 #define EVT_ACTIVATE(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE, wxActivateEventHandler(func))
3775 #define EVT_ACTIVATE_APP(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE_APP, wxActivateEventHandler(func))
3776 #define EVT_HIBERNATE(func) wx__DECLARE_EVT0(wxEVT_HIBERNATE, wxActivateEventHandler(func))
3777 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3778 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3779 #define EVT_DROP_FILES(func) wx__DECLARE_EVT0(wxEVT_DROP_FILES, wxDropFilesEventHandler(func))
3780 #define EVT_INIT_DIALOG(func) wx__DECLARE_EVT0(wxEVT_INIT_DIALOG, wxInitDialogEventHandler(func))
3781 #define EVT_SYS_COLOUR_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEventHandler(func))
3782 #define EVT_DISPLAY_CHANGED(func) wx__DECLARE_EVT0(wxEVT_DISPLAY_CHANGED, wxDisplayChangedEventHandler(func))
3783 #define EVT_SHOW(func) wx__DECLARE_EVT0(wxEVT_SHOW, wxShowEventHandler(func))
3784 #define EVT_MAXIMIZE(func) wx__DECLARE_EVT0(wxEVT_MAXIMIZE, wxMaximizeEventHandler(func))
3785 #define EVT_ICONIZE(func) wx__DECLARE_EVT0(wxEVT_ICONIZE, wxIconizeEventHandler(func))
3786 #define EVT_NAVIGATION_KEY(func) wx__DECLARE_EVT0(wxEVT_NAVIGATION_KEY, wxNavigationKeyEventHandler(func))
3787 #define EVT_PALETTE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_PALETTE_CHANGED, wxPaletteChangedEventHandler(func))
3788 #define EVT_QUERY_NEW_PALETTE(func) wx__DECLARE_EVT0(wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEventHandler(func))
3789 #define EVT_WINDOW_CREATE(func) wx__DECLARE_EVT0(wxEVT_CREATE, wxWindowCreateEventHandler(func))
3790 #define EVT_WINDOW_DESTROY(func) wx__DECLARE_EVT0(wxEVT_DESTROY, wxWindowDestroyEventHandler(func))
3791 #define EVT_SET_CURSOR(func) wx__DECLARE_EVT0(wxEVT_SET_CURSOR, wxSetCursorEventHandler(func))
3792 #define EVT_MOUSE_CAPTURE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEventHandler(func))
3793 #define EVT_MOUSE_CAPTURE_LOST(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEventHandler(func))
3796 #define EVT_LEFT_DOWN(func) wx__DECLARE_EVT0(wxEVT_LEFT_DOWN, wxMouseEventHandler(func))
3797 #define EVT_LEFT_UP(func) wx__DECLARE_EVT0(wxEVT_LEFT_UP, wxMouseEventHandler(func))
3798 #define EVT_MIDDLE_DOWN(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DOWN, wxMouseEventHandler(func))
3799 #define EVT_MIDDLE_UP(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_UP, wxMouseEventHandler(func))
3800 #define EVT_RIGHT_DOWN(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DOWN, wxMouseEventHandler(func))
3801 #define EVT_RIGHT_UP(func) wx__DECLARE_EVT0(wxEVT_RIGHT_UP, wxMouseEventHandler(func))
3802 #define EVT_MOTION(func) wx__DECLARE_EVT0(wxEVT_MOTION, wxMouseEventHandler(func))
3803 #define EVT_LEFT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_LEFT_DCLICK, wxMouseEventHandler(func))
3804 #define EVT_MIDDLE_DCLICK(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DCLICK, wxMouseEventHandler(func))
3805 #define EVT_RIGHT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DCLICK, wxMouseEventHandler(func))
3806 #define EVT_LEAVE_WINDOW(func) wx__DECLARE_EVT0(wxEVT_LEAVE_WINDOW, wxMouseEventHandler(func))
3807 #define EVT_ENTER_WINDOW(func) wx__DECLARE_EVT0(wxEVT_ENTER_WINDOW, wxMouseEventHandler(func))
3808 #define EVT_MOUSEWHEEL(func) wx__DECLARE_EVT0(wxEVT_MOUSEWHEEL, wxMouseEventHandler(func))
3809 #define EVT_MOUSE_AUX1_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX1_DOWN, wxMouseEventHandler(func))
3810 #define EVT_MOUSE_AUX1_UP(func) wx__DECLARE_EVT0(wxEVT_AUX1_UP, wxMouseEventHandler(func))
3811 #define EVT_MOUSE_AUX1_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX1_DCLICK, wxMouseEventHandler(func))
3812 #define EVT_MOUSE_AUX2_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX2_DOWN, wxMouseEventHandler(func))
3813 #define EVT_MOUSE_AUX2_UP(func) wx__DECLARE_EVT0(wxEVT_AUX2_UP, wxMouseEventHandler(func))
3814 #define EVT_MOUSE_AUX2_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX2_DCLICK, wxMouseEventHandler(func))
3817 #define EVT_MOUSE_EVENTS(func) \
3818 EVT_LEFT_DOWN(func) \
3820 EVT_LEFT_DCLICK(func) \
3821 EVT_MIDDLE_DOWN(func) \
3822 EVT_MIDDLE_UP(func) \
3823 EVT_MIDDLE_DCLICK(func) \
3824 EVT_RIGHT_DOWN(func) \
3825 EVT_RIGHT_UP(func) \
3826 EVT_RIGHT_DCLICK(func) \
3827 EVT_MOUSE_AUX1_DOWN(func) \
3828 EVT_MOUSE_AUX1_UP(func) \
3829 EVT_MOUSE_AUX1_DCLICK(func) \
3830 EVT_MOUSE_AUX2_DOWN(func) \
3831 EVT_MOUSE_AUX2_UP(func) \
3832 EVT_MOUSE_AUX2_DCLICK(func) \
3834 EVT_LEAVE_WINDOW(func) \
3835 EVT_ENTER_WINDOW(func) \
3836 EVT_MOUSEWHEEL(func)
3838 // Scrolling from wxWindow (sent to wxScrolledWindow)
3839 #define EVT_SCROLLWIN_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_TOP, wxScrollWinEventHandler(func))
3840 #define EVT_SCROLLWIN_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEventHandler(func))
3841 #define EVT_SCROLLWIN_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEUP, wxScrollWinEventHandler(func))
3842 #define EVT_SCROLLWIN_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEventHandler(func))
3843 #define EVT_SCROLLWIN_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEventHandler(func))
3844 #define EVT_SCROLLWIN_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEventHandler(func))
3845 #define EVT_SCROLLWIN_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEventHandler(func))
3846 #define EVT_SCROLLWIN_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEventHandler(func))
3848 #define EVT_SCROLLWIN(func) \
3849 EVT_SCROLLWIN_TOP(func) \
3850 EVT_SCROLLWIN_BOTTOM(func) \
3851 EVT_SCROLLWIN_LINEUP(func) \
3852 EVT_SCROLLWIN_LINEDOWN(func) \
3853 EVT_SCROLLWIN_PAGEUP(func) \
3854 EVT_SCROLLWIN_PAGEDOWN(func) \
3855 EVT_SCROLLWIN_THUMBTRACK(func) \
3856 EVT_SCROLLWIN_THUMBRELEASE(func)
3858 // Scrolling from wxSlider and wxScrollBar
3859 #define EVT_SCROLL_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_TOP, wxScrollEventHandler(func))
3860 #define EVT_SCROLL_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLL_BOTTOM, wxScrollEventHandler(func))
3861 #define EVT_SCROLL_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEUP, wxScrollEventHandler(func))
3862 #define EVT_SCROLL_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEDOWN, wxScrollEventHandler(func))
3863 #define EVT_SCROLL_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEUP, wxScrollEventHandler(func))
3864 #define EVT_SCROLL_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler(func))
3865 #define EVT_SCROLL_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler(func))
3866 #define EVT_SCROLL_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBRELEASE, wxScrollEventHandler(func))
3867 #define EVT_SCROLL_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SCROLL_CHANGED, wxScrollEventHandler(func))
3869 #define EVT_SCROLL(func) \
3870 EVT_SCROLL_TOP(func) \
3871 EVT_SCROLL_BOTTOM(func) \
3872 EVT_SCROLL_LINEUP(func) \
3873 EVT_SCROLL_LINEDOWN(func) \
3874 EVT_SCROLL_PAGEUP(func) \
3875 EVT_SCROLL_PAGEDOWN(func) \
3876 EVT_SCROLL_THUMBTRACK(func) \
3877 EVT_SCROLL_THUMBRELEASE(func) \
3878 EVT_SCROLL_CHANGED(func)
3880 // Scrolling from wxSlider and wxScrollBar, with an id
3881 #define EVT_COMMAND_SCROLL_TOP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_TOP, winid, wxScrollEventHandler(func))
3882 #define EVT_COMMAND_SCROLL_BOTTOM(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_BOTTOM, winid, wxScrollEventHandler(func))
3883 #define EVT_COMMAND_SCROLL_LINEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEUP, winid, wxScrollEventHandler(func))
3884 #define EVT_COMMAND_SCROLL_LINEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEDOWN, winid, wxScrollEventHandler(func))
3885 #define EVT_COMMAND_SCROLL_PAGEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEUP, winid, wxScrollEventHandler(func))
3886 #define EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEDOWN, winid, wxScrollEventHandler(func))
3887 #define EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBTRACK, winid, wxScrollEventHandler(func))
3888 #define EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBRELEASE, winid, wxScrollEventHandler(func))
3889 #define EVT_COMMAND_SCROLL_CHANGED(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_CHANGED, winid, wxScrollEventHandler(func))
3891 #define EVT_COMMAND_SCROLL(winid, func) \
3892 EVT_COMMAND_SCROLL_TOP(winid, func) \
3893 EVT_COMMAND_SCROLL_BOTTOM(winid, func) \
3894 EVT_COMMAND_SCROLL_LINEUP(winid, func) \
3895 EVT_COMMAND_SCROLL_LINEDOWN(winid, func) \
3896 EVT_COMMAND_SCROLL_PAGEUP(winid, func) \
3897 EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) \
3898 EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) \
3899 EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) \
3900 EVT_COMMAND_SCROLL_CHANGED(winid, func)
3902 #if WXWIN_COMPATIBILITY_2_6
3903 // compatibility macros for the old name, deprecated in 2.8
3904 #define wxEVT_SCROLL_ENDSCROLL wxEVT_SCROLL_CHANGED
3905 #define EVT_COMMAND_SCROLL_ENDSCROLL EVT_COMMAND_SCROLL_CHANGED
3906 #define EVT_SCROLL_ENDSCROLL EVT_SCROLL_CHANGED
3907 #endif // WXWIN_COMPATIBILITY_2_6
3909 // Convenience macros for commonly-used commands
3910 #define EVT_CHECKBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKBOX_CLICKED, winid, wxCommandEventHandler(func))
3911 #define EVT_CHOICE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHOICE_SELECTED, winid, wxCommandEventHandler(func))
3912 #define EVT_LISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_SELECTED, winid, wxCommandEventHandler(func))
3913 #define EVT_LISTBOX_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, winid, wxCommandEventHandler(func))
3914 #define EVT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_MENU_SELECTED, winid, wxCommandEventHandler(func))
3915 #define EVT_MENU_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_MENU_SELECTED, id1, id2, wxCommandEventHandler(func))
3916 #if defined(__SMARTPHONE__)
3917 # define EVT_BUTTON(winid, func) EVT_MENU(winid, func)
3919 # define EVT_BUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_BUTTON_CLICKED, winid, wxCommandEventHandler(func))
3921 #define EVT_SLIDER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SLIDER_UPDATED, winid, wxCommandEventHandler(func))
3922 #define EVT_RADIOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBOX_SELECTED, winid, wxCommandEventHandler(func))
3923 #define EVT_RADIOBUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBUTTON_SELECTED, winid, wxCommandEventHandler(func))
3924 // EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events
3925 #define EVT_SCROLLBAR(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SCROLLBAR_UPDATED, winid, wxCommandEventHandler(func))
3926 #define EVT_VLBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_VLBOX_SELECTED, winid, wxCommandEventHandler(func))
3927 #define EVT_COMBOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_SELECTED, winid, wxCommandEventHandler(func))
3928 #define EVT_TOOL(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_CLICKED, winid, wxCommandEventHandler(func))
3929 #define EVT_TOOL_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, winid, wxCommandEventHandler(func))
3930 #define EVT_TOOL_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_CLICKED, id1, id2, wxCommandEventHandler(func))
3931 #define EVT_TOOL_RCLICKED(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_RCLICKED, winid, wxCommandEventHandler(func))
3932 #define EVT_TOOL_RCLICKED_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, wxCommandEventHandler(func))
3933 #define EVT_TOOL_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_ENTER, winid, wxCommandEventHandler(func))
3934 #define EVT_CHECKLISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, winid, wxCommandEventHandler(func))
3936 // Generic command events
3937 #define EVT_COMMAND_LEFT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_CLICK, winid, wxCommandEventHandler(func))
3938 #define EVT_COMMAND_LEFT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_DCLICK, winid, wxCommandEventHandler(func))
3939 #define EVT_COMMAND_RIGHT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_CLICK, winid, wxCommandEventHandler(func))
3940 #define EVT_COMMAND_RIGHT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_DCLICK, winid, wxCommandEventHandler(func))
3941 #define EVT_COMMAND_SET_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SET_FOCUS, winid, wxCommandEventHandler(func))
3942 #define EVT_COMMAND_KILL_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_KILL_FOCUS, winid, wxCommandEventHandler(func))
3943 #define EVT_COMMAND_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_ENTER, winid, wxCommandEventHandler(func))
3947 #define EVT_JOY_BUTTON_DOWN(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_DOWN, wxJoystickEventHandler(func))
3948 #define EVT_JOY_BUTTON_UP(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_UP, wxJoystickEventHandler(func))
3949 #define EVT_JOY_MOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_MOVE, wxJoystickEventHandler(func))
3950 #define EVT_JOY_ZMOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_ZMOVE, wxJoystickEventHandler(func))
3952 // All joystick events
3953 #define EVT_JOYSTICK_EVENTS(func) \
3954 EVT_JOY_BUTTON_DOWN(func) \
3955 EVT_JOY_BUTTON_UP(func) \
3956 EVT_JOY_MOVE(func) \
3960 #define EVT_IDLE(func) wx__DECLARE_EVT0(wxEVT_IDLE, wxIdleEventHandler(func))
3963 #define EVT_UPDATE_UI(winid, func) wx__DECLARE_EVT1(wxEVT_UPDATE_UI, winid, wxUpdateUIEventHandler(func))
3964 #define EVT_UPDATE_UI_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_UPDATE_UI, id1, id2, wxUpdateUIEventHandler(func))
3967 #define EVT_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_HELP, winid, wxHelpEventHandler(func))
3968 #define EVT_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_HELP, id1, id2, wxHelpEventHandler(func))
3969 #define EVT_DETAILED_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_DETAILED_HELP, winid, wxHelpEventHandler(func))
3970 #define EVT_DETAILED_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_DETAILED_HELP, id1, id2, wxHelpEventHandler(func))
3972 // Context Menu Events
3973 #define EVT_CONTEXT_MENU(func) wx__DECLARE_EVT0(wxEVT_CONTEXT_MENU, wxContextMenuEventHandler(func))
3974 #define EVT_COMMAND_CONTEXT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_CONTEXT_MENU, winid, wxContextMenuEventHandler(func))
3976 // Clipboard text Events
3977 #define EVT_TEXT_CUT(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_CUT, winid, wxClipboardTextEventHandler(func))
3978 #define EVT_TEXT_COPY(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_COPY, winid, wxClipboardTextEventHandler(func))
3979 #define EVT_TEXT_PASTE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_PASTE, winid, wxClipboardTextEventHandler(func))
3982 #define EVT_THREAD(id, func) wx__DECLARE_EVT1(wxEVT_COMMAND_THREAD, id, wxThreadEventHandler(func))
3984 // ----------------------------------------------------------------------------
3986 // ----------------------------------------------------------------------------
3990 // Find a window with the focus, that is also a descendant of the given window.
3991 // This is used to determine the window to initially send commands to.
3992 WXDLLIMPEXP_CORE wxWindow
* wxFindFocusDescendant(wxWindow
* ancestor
);
3996 #endif // _WX_EVENT_H_