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 #ifdef wxHAS_EVENT_BIND
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, wxNewEventTableFunctor(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 #ifndef wxHAS_EVENT_BIND
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 #else // wxHAS_EVENT_BIND
131 // Define/Declare a templatized event type with the corresponding event as
134 #define wxDEFINE_EVENT( name, type ) \
135 const wxEventTypeTag< type > name( wxNewEventType() )
137 #define wxDECLARE_EXPORTED_EVENT( expdecl, name, type ) \
138 extern const expdecl wxEventTypeTag< type > name
140 // Define/Declare a templatized event type and initialize it with a
141 // predefined event type. (Only used for wxEVT_SPIN_XXX for backward
144 #define wxDEFINE_EVENT_ALIAS( name, type, value ) \
145 const wxEventTypeTag< type > name( value )
147 #define wxDECLARE_EXPORTED_EVENT_ALIAS( expdecl, name, type ) \
148 extern const expdecl wxEventTypeTag< type > name
150 // Declare a local (not exported) templatized event type:
152 #define wxDECLARE_EVENT( name, type ) \
153 wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type )
155 #endif // wxHAS_EVENT_BIND
157 // Try to cast the given event handler to the correct handler type:
159 #define wxEVENT_HANDLER_CAST( functype, func ) \
160 ( wxObjectEventFunction )( wxEventFunction )wxStaticCastEvent( functype, &func )
163 #ifdef wxHAS_EVENT_BIND
165 // The tag is a type associated to the event type (which is an integer itself,
166 // in spite of its name) value. It exists in order to be used as a template
167 // parameter and provide a mapping between the event type values and their
168 // corresponding wxEvent-derived classes.
169 template <typename T
>
173 // The class of wxEvent-derived class carried by the events of this type.
174 typedef T EventClass
;
176 wxEventTypeTag(wxEventType type
) { m_type
= type
; }
178 // Return a wxEventType reference for the initialization of the static
179 // event tables. See wxEventTableEntry::m_eventType for a more thorough
181 operator const wxEventType
&() const { return m_type
; }
187 #endif // wxHAS_EVENT_BIND
189 // These are needed for the functor definitions
190 typedef void (wxEvtHandler::*wxEventFunction
)(wxEvent
&);
192 // We had some trouble (specifically with eVC for ARM WinCE build) with using
193 // wxEventFunction in the past so we had introduced wxObjectEventFunction which
194 // used to be a typedef for a member of wxObject and not wxEvtHandler to work
195 // around this but as eVC is not really supported any longer we now only keep
196 // this for backwards compatibility and, despite its name, this is a typedef
197 // for wxEvtHandler member now -- but if we have the same problem with another
198 // compiler we can restore its old definition for it.
199 typedef wxEventFunction wxObjectEventFunction
;
202 // wxEventFunctorClassInfo is used as a unique identifier for wxEventFunctor-
203 // derived classes; it is more light weight than wxClassInfo and can be used in
205 typedef void (*wxEventFunctorClassInfo
)();
207 // this macro must be used in wxEventFunctor-derived classes
208 #define wxDEFINE_EVENT_FUNCTOR_CLASS_INFO( classInfoName ) \
209 static void classInfoName() {}
211 // The event functor which is stored in the static and dynamic event tables:
212 class WXDLLIMPEXP_BASE wxEventFunctor
215 virtual ~wxEventFunctor();
217 // Invoke the actual event handler:
218 virtual void operator()(wxEvtHandler
*, wxEvent
&) = 0;
220 // this function tests whether this functor is matched, for the purpose of
221 // finding it in an event table in Unbind(), by the given functor:
222 virtual bool IsMatching(const wxEventFunctor
& functor
) const = 0;
224 // Test whether the given class info is the same as from this functor. This
225 // allows us in IsMatching to safely downcast the given wxEventFunctor without
226 // the usage of dynamic_cast<>().
227 virtual bool IsSameClass(wxEventFunctorClassInfo classInfo
) const = 0;
229 // If the functor holds an wxEvtHandler, then get access to it and track
230 // its lifetime with wxEventConnectionRef:
231 virtual wxEvtHandler
*GetEvtHandler() const
234 // This is only used to maintain backward compatibility in
235 // wxAppConsoleBase::CallEventHandler and ensures that an overwritten
236 // wxAppConsoleBase::HandleEvent is still called for functors which hold an
238 virtual wxEventFunction
GetEvtMethod() const
242 // A plain method functor for the untyped legacy event types:
243 class WXDLLIMPEXP_BASE wxObjectEventFunctor
: public wxEventFunctor
246 wxObjectEventFunctor(wxObjectEventFunction method
, wxEvtHandler
*handler
)
247 : m_handler( handler
), m_method( method
)
250 virtual void operator()(wxEvtHandler
*handler
, wxEvent
& event
)
252 wxEvtHandler
* const realHandler
= m_handler
? m_handler
: handler
;
254 (realHandler
->*m_method
)(event
);
257 virtual bool IsMatching(const wxEventFunctor
& functor
) const
259 if ( functor
.IsSameClass( sm_classInfo
))
261 const wxObjectEventFunctor
&other
=
262 static_cast< const wxObjectEventFunctor
& >( functor
);
264 // FIXME-VC6: amazing but true: replacing "method == NULL" here
265 // with "!method" makes VC6 crash with an ICE in DLL build (only!)
267 return ( m_method
== other
.m_method
|| other
.m_method
== NULL
) &&
268 ( m_handler
== other
.m_handler
|| other
.m_handler
== NULL
);
274 virtual bool IsSameClass( wxEventFunctorClassInfo otherClassInfo
) const
275 { return sm_classInfo
== otherClassInfo
; }
277 virtual wxEvtHandler
*GetEvtHandler() const
278 { return m_handler
; }
280 virtual wxEventFunction
GetEvtMethod() const
284 wxEvtHandler
*m_handler
;
285 wxEventFunction m_method
;
287 wxDEFINE_EVENT_FUNCTOR_CLASS_INFO( sm_classInfo
);
290 // Create a functor for the legacy events: used by Connect()
291 inline wxObjectEventFunctor
*
292 wxNewEventFunctor(const wxEventType
& WXUNUSED(evtType
),
293 wxObjectEventFunction method
,
294 wxEvtHandler
*handler
)
296 return new wxObjectEventFunctor(method
, handler
);
299 // This version is used by DECLARE_EVENT_TABLE_ENTRY()
300 inline wxObjectEventFunctor
*
301 wxNewEventTableFunctor(const wxEventType
& WXUNUSED(evtType
),
302 wxObjectEventFunction method
)
304 return new wxObjectEventFunctor(method
, NULL
);
307 inline wxObjectEventFunctor
308 wxMakeEventFunctor(const wxEventType
& WXUNUSED(evtType
),
309 wxObjectEventFunction method
,
310 wxEvtHandler
*handler
)
312 return wxObjectEventFunctor(method
, handler
);
315 #ifdef wxHAS_EVENT_BIND
320 // helper template defining nested "type" typedef as the event class
321 // corresponding to the given event type
322 template <typename T
> struct EventClassOf
;
324 // the typed events provide the information about the class of the events they
326 template <typename T
>
327 struct EventClassOf
< wxEventTypeTag
<T
> >
329 typedef typename wxEventTypeTag
<T
>::EventClass type
;
332 // for the old untyped events we don't have information about the exact event
333 // class carried by them
335 struct EventClassOf
<wxEventType
>
337 typedef wxEvent type
;
341 // helper class defining operations different for method functors using an
342 // object of wxEvtHandler-derived class as handler and the others
343 template <typename T
, typename A
, bool> struct HandlerImpl
;
345 // specialization for handlers deriving from wxEvtHandler
346 template <typename T
, typename A
>
347 struct HandlerImpl
<T
, A
, true>
349 static bool IsEvtHandler()
351 static T
*ConvertFromEvtHandler(wxEvtHandler
*p
)
352 { return static_cast<T
*>(p
); }
353 static wxEvtHandler
*ConvertToEvtHandler(T
*p
)
355 static wxEventFunction
ConvertToEvtMethod(void (T::*f
)(A
&))
356 { return static_cast<wxEventFunction
>(
357 reinterpret_cast<void (T::*)(wxEvent
&)>(f
)); }
360 // specialization for handlers not deriving from wxEvtHandler
361 template <typename T
, typename A
>
362 struct HandlerImpl
<T
, A
, false>
364 static bool IsEvtHandler()
366 static T
*ConvertFromEvtHandler(wxEvtHandler
*)
368 static wxEvtHandler
*ConvertToEvtHandler(T
*)
370 static wxEventFunction
ConvertToEvtMethod(void (T::*)(A
&))
374 } // namespace wxPrivate
376 // functor forwarding the event to a method of the given object
378 // notice that the object class may be different from the class in which the
379 // method is defined but it must be convertible to this class
381 // also, the type of the handler parameter doesn't need to be exactly the same
382 // as EventTag::EventClass but it must be its base class -- this is explicitly
383 // allowed to handle different events in the same handler taking wxEvent&, for
386 <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
387 class wxEventFunctorMethod
388 : public wxEventFunctor
,
389 private wxPrivate::HandlerImpl
393 wxConvertibleTo
<Class
, wxEvtHandler
>::value
!= 0
397 static void CheckHandlerArgument(EventArg
*) { }
400 // the event class associated with the given event tag
401 typedef typename
wxPrivate::EventClassOf
<EventTag
>::type EventClass
;
404 wxEventFunctorMethod(void (Class::*method
)(EventArg
&), EventHandler
*handler
)
405 : m_handler( handler
), m_method( method
)
407 wxASSERT_MSG( handler
|| this->IsEvtHandler(),
408 "handlers defined in non-wxEvtHandler-derived classes "
409 "must be connected with a valid sink object" );
411 // if you get an error here it means that the signature of the handler
412 // you're trying to use is not compatible with (i.e. is not the same as
413 // or a base class of) the real event class used for this event type
414 CheckHandlerArgument(static_cast<EventClass
*>(NULL
));
417 virtual void operator()(wxEvtHandler
*handler
, wxEvent
& event
)
419 Class
* realHandler
= m_handler
;
422 realHandler
= this->ConvertFromEvtHandler(handler
);
424 // this is not supposed to happen but check for it nevertheless
425 wxCHECK_RET( realHandler
, "invalid event handler" );
428 // the real (run-time) type of event is EventClass and we checked in
429 // the ctor that EventClass can be converted to EventArg, so this cast
431 (realHandler
->*m_method
)(static_cast<EventArg
&>(event
));
434 virtual bool IsMatching(const wxEventFunctor
& functor
) const
436 if ( !functor
.IsSameClass(sm_classInfo
) )
439 typedef wxEventFunctorMethod
<EventTag
, Class
, EventArg
, EventHandler
>
442 // the cast is valid because IsSameClass() returned true above
443 const ThisFunctor
& other
= static_cast<const ThisFunctor
&>(functor
);
445 return (m_method
== other
.m_method
|| other
.m_method
== NULL
) &&
446 (m_handler
== other
.m_handler
|| other
.m_handler
== NULL
);
449 virtual bool IsSameClass( wxEventFunctorClassInfo otherClassInfo
) const
450 { return sm_classInfo
== otherClassInfo
; }
452 virtual wxEvtHandler
*GetEvtHandler() const
453 { return this->ConvertToEvtHandler(m_handler
); }
455 virtual wxEventFunction
GetEvtMethod() const
456 { return this->ConvertToEvtMethod(m_method
); }
459 EventHandler
*m_handler
;
460 void (Class::*m_method
)(EventArg
&);
462 wxDEFINE_EVENT_FUNCTOR_CLASS_INFO( sm_classInfo
);
466 // functor forwarding the event to function (function, static method)
467 template <typename EventTag
, typename EventArg
>
468 class wxEventFunctorFunction
: public wxEventFunctor
471 static void CheckHandlerArgument(EventArg
*) { }
474 // the event class associated with the given event tag
475 typedef typename
wxPrivate::EventClassOf
<EventTag
>::type EventClass
;
477 wxEventFunctorFunction( void ( *handler
)( EventArg
& ))
478 : m_handler( handler
)
480 // if you get an error here it means that the signature of the handler
481 // you're trying to use is not compatible with (i.e. is not the same as
482 // or a base class of) the real event class used for this event type
483 CheckHandlerArgument(static_cast<EventClass
*>(NULL
));
486 virtual void operator()(wxEvtHandler
*WXUNUSED(handler
), wxEvent
& event
)
488 // If you get an error here like "must use .* or ->* to call
489 // pointer-to-member function" then you probably tried to call
490 // Bind/Unbind with a method pointer but without a handler pointer or
491 // NULL as a handler e.g.:
492 // Unbind( wxEVT_XXX, &EventHandler::method );
494 // Unbind( wxEVT_XXX, &EventHandler::method, NULL )
495 m_handler(static_cast<EventArg
&>(event
));
498 virtual bool IsMatching(const wxEventFunctor
&functor
) const
500 if ( !functor
.IsSameClass(sm_classInfo
) )
503 typedef wxEventFunctorFunction
<EventTag
, EventArg
> ThisFunctor
;
505 const ThisFunctor
& other
= static_cast<const ThisFunctor
&>( functor
);
507 return m_handler
== other
.m_handler
;
510 virtual bool IsSameClass( wxEventFunctorClassInfo otherClassInfo
) const
511 { return sm_classInfo
== otherClassInfo
; }
514 void (*m_handler
)(EventArg
&);
516 wxDEFINE_EVENT_FUNCTOR_CLASS_INFO( sm_classInfo
);
520 template <typename EventTag
, typename Functor
>
521 class wxEventFunctorFunctor
: public wxEventFunctor
524 typedef typename
EventTag::EventClass EventArg
;
526 wxEventFunctorFunctor(Functor
& handler
)
527 : m_handler(handler
), m_handlerAddr(&handler
)
530 virtual void operator()(wxEvtHandler
*WXUNUSED(handler
), wxEvent
& event
)
532 // If you get an error here like "must use '.*' or '->*' to call
533 // pointer-to-member function" then you probably tried to call
534 // Bind/Unbind with a method pointer but without a handler pointer or
535 // NULL as a handler e.g.:
536 // Unbind( wxEVT_XXX, &EventHandler::method );
538 // Unbind( wxEVT_XXX, &EventHandler::method, NULL )
539 m_handler(static_cast<EventArg
&>(event
));
542 virtual bool IsMatching(const wxEventFunctor
&functor
) const
544 if ( !functor
.IsSameClass(sm_classInfo
) )
547 typedef wxEventFunctorFunctor
<EventTag
, Functor
> FunctorThis
;
549 const FunctorThis
& other
= static_cast<const FunctorThis
&>(functor
);
551 // The only reliable/portable way to compare two functors is by
553 return m_handlerAddr
== other
.m_handlerAddr
;
556 virtual bool IsSameClass( wxEventFunctorClassInfo otherClassInfo
) const
557 { return sm_classInfo
== otherClassInfo
; }
560 // Store a copy of the functor to prevent using/calling an already
561 // destroyed instance:
564 // Use the address of the original functor for comparison in IsMatching:
565 const void *m_handlerAddr
;
567 wxDEFINE_EVENT_FUNCTOR_CLASS_INFO( sm_classInfo
);
570 // Create functors for the templatized events, either allocated on the heap for
571 // wxNewXXX() variants (this is needed in wxEvtHandler::Bind<>() to store them
572 // in dynamic event table) or just by returning them as a temporary objects (this
573 // is enough for Unbind<>() and we avoid unnecessary heap allocation like this).
576 // Create functors wrapping functions:
577 template <typename EventTag
, typename EventArg
>
578 inline wxEventFunctorFunction
<EventTag
, EventArg
> *
579 wxNewEventFunctor(const EventTag
&, void (*func
)(EventArg
&))
581 return new wxEventFunctorFunction
<EventTag
, EventArg
>(func
);
584 template <typename EventTag
, typename EventArg
>
585 inline wxEventFunctorFunction
<EventTag
, EventArg
>
586 wxMakeEventFunctor(const EventTag
&, void (*func
)(EventArg
&))
588 return wxEventFunctorFunction
<EventTag
, EventArg
>(func
);
591 // Create functors wrapping other functors:
592 template <typename EventTag
, typename Functor
>
593 inline wxEventFunctorFunctor
<EventTag
, Functor
> *
594 wxNewEventFunctor(const EventTag
&, Functor
&func
)
596 return new wxEventFunctorFunctor
<EventTag
, Functor
>(func
);
599 template <typename EventTag
, typename Functor
>
600 inline wxEventFunctorFunctor
<EventTag
, Functor
>
601 wxMakeEventFunctor(const EventTag
&, Functor
&func
)
603 return wxEventFunctorFunctor
<EventTag
, Functor
>(func
);
606 // Create functors wrapping methods:
608 <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
609 inline wxEventFunctorMethod
<EventTag
, Class
, EventArg
, EventHandler
> *
610 wxNewEventFunctor(const EventTag
&,
611 void (Class::*method
)(EventArg
&),
612 EventHandler
*handler
)
614 return new wxEventFunctorMethod
<EventTag
, Class
, EventArg
, EventHandler
>(
619 <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
620 inline wxEventFunctorMethod
<EventTag
, Class
, EventArg
, EventHandler
>
621 wxMakeEventFunctor(const EventTag
&,
622 void (Class::*method
)(EventArg
&),
623 EventHandler
*handler
)
625 return wxEventFunctorMethod
<EventTag
, Class
, EventArg
, EventHandler
>(
629 // Create an event functor for the event table via DECLARE_EVENT_TABLE_ENTRY:
630 // in this case we don't have the handler (as it's always the same as the
631 // object which generated the event) so we must use Class as its type
632 template <typename EventTag
, typename Class
, typename EventArg
>
633 inline wxEventFunctorMethod
<EventTag
, Class
, EventArg
, Class
> *
634 wxNewEventTableFunctor(const EventTag
&, void (Class::*method
)(EventArg
&))
636 return new wxEventFunctorMethod
<EventTag
, Class
, EventArg
, Class
>(
640 #endif // wxHAS_EVENT_BIND
643 // many, but not all, standard event types
645 // some generic events
646 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_NULL
;
647 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_FIRST
;
648 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_USER_FIRST
;
650 // Need events declared to do this
651 class WXDLLIMPEXP_FWD_CORE wxCommandEvent
;
652 class WXDLLIMPEXP_FWD_CORE wxThreadEvent
;
653 class WXDLLIMPEXP_FWD_CORE wxMouseEvent
;
654 class WXDLLIMPEXP_FWD_CORE wxFocusEvent
;
655 class WXDLLIMPEXP_FWD_CORE wxChildFocusEvent
;
656 class WXDLLIMPEXP_FWD_CORE wxKeyEvent
;
657 class WXDLLIMPEXP_FWD_CORE wxNavigationKeyEvent
;
658 class WXDLLIMPEXP_FWD_CORE wxSetCursorEvent
;
659 class WXDLLIMPEXP_FWD_CORE wxScrollEvent
;
660 class WXDLLIMPEXP_FWD_CORE wxSpinEvent
;
661 class WXDLLIMPEXP_FWD_CORE wxScrollWinEvent
;
662 class WXDLLIMPEXP_FWD_CORE wxSizeEvent
;
663 class WXDLLIMPEXP_FWD_CORE wxMoveEvent
;
664 class WXDLLIMPEXP_FWD_CORE wxCloseEvent
;
665 class WXDLLIMPEXP_FWD_CORE wxActivateEvent
;
666 class WXDLLIMPEXP_FWD_CORE wxWindowCreateEvent
;
667 class WXDLLIMPEXP_FWD_CORE wxWindowDestroyEvent
;
668 class WXDLLIMPEXP_FWD_CORE wxShowEvent
;
669 class WXDLLIMPEXP_FWD_CORE wxIconizeEvent
;
670 class WXDLLIMPEXP_FWD_CORE wxMaximizeEvent
;
671 class WXDLLIMPEXP_FWD_CORE wxMouseCaptureChangedEvent
;
672 class WXDLLIMPEXP_FWD_CORE wxMouseCaptureLostEvent
;
673 class WXDLLIMPEXP_FWD_CORE wxPaintEvent
;
674 class WXDLLIMPEXP_FWD_CORE wxEraseEvent
;
675 class WXDLLIMPEXP_FWD_CORE wxNcPaintEvent
;
676 class WXDLLIMPEXP_FWD_CORE wxMenuEvent
;
677 class WXDLLIMPEXP_FWD_CORE wxContextMenuEvent
;
678 class WXDLLIMPEXP_FWD_CORE wxSysColourChangedEvent
;
679 class WXDLLIMPEXP_FWD_CORE wxDisplayChangedEvent
;
680 class WXDLLIMPEXP_FWD_CORE wxQueryNewPaletteEvent
;
681 class WXDLLIMPEXP_FWD_CORE wxPaletteChangedEvent
;
682 class WXDLLIMPEXP_FWD_CORE wxJoystickEvent
;
683 class WXDLLIMPEXP_FWD_CORE wxDropFilesEvent
;
684 class WXDLLIMPEXP_FWD_CORE wxInitDialogEvent
;
685 class WXDLLIMPEXP_FWD_CORE wxIdleEvent
;
686 class WXDLLIMPEXP_FWD_CORE wxUpdateUIEvent
;
687 class WXDLLIMPEXP_FWD_CORE wxClipboardTextEvent
;
688 class WXDLLIMPEXP_FWD_CORE wxHelpEvent
;
692 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_BUTTON_CLICKED
, wxCommandEvent
);
693 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHECKBOX_CLICKED
, wxCommandEvent
);
694 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHOICE_SELECTED
, wxCommandEvent
);
695 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LISTBOX_SELECTED
, wxCommandEvent
);
696 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
, wxCommandEvent
);
697 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
, wxCommandEvent
);
698 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_MENU_SELECTED
, wxCommandEvent
);
699 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SLIDER_UPDATED
, wxCommandEvent
);
700 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RADIOBOX_SELECTED
, wxCommandEvent
);
701 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RADIOBUTTON_SELECTED
, wxCommandEvent
);
703 // wxEVT_COMMAND_SCROLLBAR_UPDATED is deprecated, use wxEVT_SCROLL... events
704 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SCROLLBAR_UPDATED
, wxCommandEvent
);
705 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_VLBOX_SELECTED
, wxCommandEvent
);
706 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_COMBOBOX_SELECTED
, wxCommandEvent
);
707 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_RCLICKED
, wxCommandEvent
);
708 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED
, wxCommandEvent
);
709 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_ENTER
, wxCommandEvent
);
710 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_COMBOBOX_DROPDOWN
, wxCommandEvent
);
711 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_COMBOBOX_CLOSEUP
, wxCommandEvent
);
714 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_THREAD
, wxThreadEvent
);
717 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_DOWN
, wxMouseEvent
);
718 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_UP
, wxMouseEvent
);
719 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_DOWN
, wxMouseEvent
);
720 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_UP
, wxMouseEvent
);
721 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_DOWN
, wxMouseEvent
);
722 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_UP
, wxMouseEvent
);
723 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOTION
, wxMouseEvent
);
724 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ENTER_WINDOW
, wxMouseEvent
);
725 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEAVE_WINDOW
, wxMouseEvent
);
726 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_DCLICK
, wxMouseEvent
);
727 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_DCLICK
, wxMouseEvent
);
728 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_DCLICK
, wxMouseEvent
);
729 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SET_FOCUS
, wxFocusEvent
);
730 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KILL_FOCUS
, wxFocusEvent
);
731 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHILD_FOCUS
, wxChildFocusEvent
);
732 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSEWHEEL
, wxMouseEvent
);
733 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_DOWN
, wxMouseEvent
);
734 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_UP
, wxMouseEvent
);
735 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_DCLICK
, wxMouseEvent
);
736 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_DOWN
, wxMouseEvent
);
737 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_UP
, wxMouseEvent
);
738 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_DCLICK
, wxMouseEvent
);
740 // Character input event type
741 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHAR
, wxKeyEvent
);
742 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHAR_HOOK
, wxKeyEvent
);
743 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_NAVIGATION_KEY
, wxNavigationKeyEvent
);
744 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KEY_DOWN
, wxKeyEvent
);
745 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KEY_UP
, wxKeyEvent
);
747 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HOTKEY
, wxKeyEvent
);
750 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SET_CURSOR
, wxSetCursorEvent
);
752 // wxScrollBar and wxSlider event identifiers
753 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_TOP
, wxScrollEvent
);
754 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_BOTTOM
, wxScrollEvent
);
755 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_LINEUP
, wxScrollEvent
);
756 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_LINEDOWN
, wxScrollEvent
);
757 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_PAGEUP
, wxScrollEvent
);
758 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_PAGEDOWN
, wxScrollEvent
);
759 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_THUMBTRACK
, wxScrollEvent
);
760 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_THUMBRELEASE
, wxScrollEvent
);
761 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_CHANGED
, wxScrollEvent
);
763 // Due to a bug in older wx versions, wxSpinEvents were being sent with type of
764 // wxEVT_SCROLL_LINEUP, wxEVT_SCROLL_LINEDOWN and wxEVT_SCROLL_THUMBTRACK. But
765 // with the type-safe events in place, these event types are associated with
766 // wxScrollEvent. To allow handling of spin events, new event types have been
767 // defined in spinbutt.h/spinnbuttcmn.cpp. To maintain backward compatibility
768 // the spin event types are being initialized with the scroll event types.
772 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN_UP
, wxSpinEvent
);
773 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN_DOWN
, wxSpinEvent
);
774 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN
, wxSpinEvent
);
778 // Scroll events from wxWindow
779 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_TOP
, wxScrollWinEvent
);
780 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_BOTTOM
, wxScrollWinEvent
);
781 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_LINEUP
, wxScrollWinEvent
);
782 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_LINEDOWN
, wxScrollWinEvent
);
783 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_PAGEUP
, wxScrollWinEvent
);
784 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_PAGEDOWN
, wxScrollWinEvent
);
785 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_THUMBTRACK
, wxScrollWinEvent
);
786 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_THUMBRELEASE
, wxScrollWinEvent
);
789 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SIZE
, wxSizeEvent
);
790 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE
, wxMoveEvent
);
791 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CLOSE_WINDOW
, wxCloseEvent
);
792 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_END_SESSION
, wxCloseEvent
);
793 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_QUERY_END_SESSION
, wxCloseEvent
);
794 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ACTIVATE_APP
, wxActivateEvent
);
795 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ACTIVATE
, wxActivateEvent
);
796 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CREATE
, wxWindowCreateEvent
);
797 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DESTROY
, wxWindowDestroyEvent
);
798 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SHOW
, wxShowEvent
);
799 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ICONIZE
, wxIconizeEvent
);
800 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MAXIMIZE
, wxMaximizeEvent
);
801 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSE_CAPTURE_CHANGED
, wxMouseCaptureChangedEvent
);
802 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSE_CAPTURE_LOST
, wxMouseCaptureLostEvent
);
803 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_PAINT
, wxPaintEvent
);
804 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ERASE_BACKGROUND
, wxEraseEvent
);
805 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_NC_PAINT
, wxNcPaintEvent
);
806 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_OPEN
, wxMenuEvent
);
807 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_CLOSE
, wxMenuEvent
);
808 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_HIGHLIGHT
, wxMenuEvent
);
809 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CONTEXT_MENU
, wxContextMenuEvent
);
810 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SYS_COLOUR_CHANGED
, wxSysColourChangedEvent
);
811 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DISPLAY_CHANGED
, wxDisplayChangedEvent
);
812 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_QUERY_NEW_PALETTE
, wxQueryNewPaletteEvent
);
813 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_PALETTE_CHANGED
, wxPaletteChangedEvent
);
814 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_BUTTON_DOWN
, wxJoystickEvent
);
815 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_BUTTON_UP
, wxJoystickEvent
);
816 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_MOVE
, wxJoystickEvent
);
817 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_ZMOVE
, wxJoystickEvent
);
818 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DROP_FILES
, wxDropFilesEvent
);
819 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_INIT_DIALOG
, wxInitDialogEvent
);
820 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_BASE
, wxEVT_IDLE
, wxIdleEvent
);
821 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_UPDATE_UI
, wxUpdateUIEvent
);
822 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SIZING
, wxSizeEvent
);
823 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVING
, wxMoveEvent
);
824 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE_START
, wxMoveEvent
);
825 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE_END
, wxMoveEvent
);
826 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HIBERNATE
, wxActivateEvent
);
829 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_COPY
, wxClipboardTextEvent
);
830 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_CUT
, wxClipboardTextEvent
);
831 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_PASTE
, wxClipboardTextEvent
);
833 // Generic command events
834 // Note: a click is a higher-level event than button down/up
835 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LEFT_CLICK
, wxCommandEvent
);
836 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LEFT_DCLICK
, wxCommandEvent
);
837 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RIGHT_CLICK
, wxCommandEvent
);
838 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RIGHT_DCLICK
, wxCommandEvent
);
839 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SET_FOCUS
, wxCommandEvent
);
840 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_KILL_FOCUS
, wxCommandEvent
);
841 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_ENTER
, wxCommandEvent
);
844 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HELP
, wxHelpEvent
);
845 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DETAILED_HELP
, wxHelpEvent
);
847 // these 2 events are the same
848 #define wxEVT_COMMAND_TOOL_CLICKED wxEVT_COMMAND_MENU_SELECTED
850 // ----------------------------------------------------------------------------
852 // ----------------------------------------------------------------------------
854 // this event is also used by wxComboBox and wxSpinCtrl which don't include
855 // wx/textctrl.h in all ports [yet], so declare it here as well
857 // still, any new code using it should include wx/textctrl.h explicitly
858 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_UPDATED
, wxCommandEvent
);
861 // ----------------------------------------------------------------------------
862 // wxEvent(-derived) classes
863 // ----------------------------------------------------------------------------
865 // the predefined constants for the number of times we propagate event
866 // upwards window child-parent chain
867 enum wxEventPropagation
869 // don't propagate it at all
870 wxEVENT_PROPAGATE_NONE
= 0,
872 // propagate it until it is processed
873 wxEVENT_PROPAGATE_MAX
= INT_MAX
876 // The different categories for a wxEvent; see wxEvent::GetEventCategory.
877 // NOTE: they are used as OR-combinable flags by wxEventLoopBase::YieldFor
880 // this is the category for those events which are generated to update
881 // the appearance of the GUI but which (usually) do not comport data
882 // processing, i.e. which do not provide input or output data
883 // (e.g. size events, scroll events, etc).
884 // They are events NOT directly generated by the user's input devices.
885 wxEVT_CATEGORY_UI
= 1,
887 // this category groups those events which are generated directly from the
888 // user through input devices like mouse and keyboard and usually result in
889 // data to be processed from the application.
890 // (e.g. mouse clicks, key presses, etc)
891 wxEVT_CATEGORY_USER_INPUT
= 2,
893 // this category is for wxSocketEvent
894 wxEVT_CATEGORY_SOCKET
= 4,
896 // this category is for wxTimerEvent
897 wxEVT_CATEGORY_TIMER
= 8,
899 // this category is for any event used to send notifications from the
900 // secondary threads to the main one or in general for notifications among
901 // different threads (which may or may not be user-generated)
902 wxEVT_CATEGORY_THREAD
= 16,
905 // implementation only
907 // used in the implementations of wxEventLoopBase::YieldFor
908 wxEVT_CATEGORY_UNKNOWN
= 32,
910 // a special category used as an argument to wxEventLoopBase::YieldFor to indicate that
911 // Yield() should leave all wxEvents on the queue while emptying the native event queue
912 // (native events will be processed but the wxEvents they generate will be queued)
913 wxEVT_CATEGORY_CLIPBOARD
= 64,
918 // this category groups those events which are emitted in response to
919 // events of the native toolkit and which typically are not-"delayable".
920 wxEVT_CATEGORY_NATIVE_EVENTS
= wxEVT_CATEGORY_UI
|wxEVT_CATEGORY_USER_INPUT
,
922 // used in wxEventLoopBase::YieldFor to specify all event categories should be processed:
924 wxEVT_CATEGORY_UI
|wxEVT_CATEGORY_USER_INPUT
|wxEVT_CATEGORY_SOCKET
| \
925 wxEVT_CATEGORY_TIMER
|wxEVT_CATEGORY_THREAD
|wxEVT_CATEGORY_UNKNOWN
| \
926 wxEVT_CATEGORY_CLIPBOARD
930 * wxWidgets events, covering all interesting things that might happen
931 * (button clicking, resizing, setting text in widgets, etc.).
933 * For each completely new event type, derive a new event class.
934 * An event CLASS represents a C++ class defining a range of similar event TYPES;
935 * examples are canvas events, panel item command events.
936 * An event TYPE is a unique identifier for a particular system event,
937 * such as a button press or a listbox deselection.
941 class WXDLLIMPEXP_BASE wxEvent
: public wxObject
944 wxEvent(int winid
= 0, wxEventType commandType
= wxEVT_NULL
);
946 void SetEventType(wxEventType typ
) { m_eventType
= typ
; }
947 wxEventType
GetEventType() const { return m_eventType
; }
949 wxObject
*GetEventObject() const { return m_eventObject
; }
950 void SetEventObject(wxObject
*obj
) { m_eventObject
= obj
; }
952 long GetTimestamp() const { return m_timeStamp
; }
953 void SetTimestamp(long ts
= 0) { m_timeStamp
= ts
; }
955 int GetId() const { return m_id
; }
956 void SetId(int Id
) { m_id
= Id
; }
958 // Can instruct event processor that we wish to ignore this event
959 // (treat as if the event table entry had not been found): this must be done
960 // to allow the event processing by the base classes (calling event.Skip()
961 // is the analog of calling the base class version of a virtual function)
962 void Skip(bool skip
= true) { m_skipped
= skip
; }
963 bool GetSkipped() const { return m_skipped
; }
965 // This function is used to create a copy of the event polymorphically and
966 // all derived classes must implement it because otherwise wxPostEvent()
967 // for them wouldn't work (it needs to do a copy of the event)
968 virtual wxEvent
*Clone() const = 0;
970 // this function is used to selectively process events in wxEventLoopBase::YieldFor
971 // NOTE: by default it returns wxEVT_CATEGORY_UI just because the major
972 // part of wxWidgets events belong to that category.
973 virtual wxEventCategory
GetEventCategory() const
974 { return wxEVT_CATEGORY_UI
; }
976 // Implementation only: this test is explicitly anti OO and this function
977 // exists only for optimization purposes.
978 bool IsCommandEvent() const { return m_isCommandEvent
; }
980 // Determine if this event should be propagating to the parent window.
981 bool ShouldPropagate() const
982 { return m_propagationLevel
!= wxEVENT_PROPAGATE_NONE
; }
984 // Stop an event from propagating to its parent window, returns the old
985 // propagation level value
986 int StopPropagation()
988 int propagationLevel
= m_propagationLevel
;
989 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
990 return propagationLevel
;
993 // Resume the event propagation by restoring the propagation level
994 // (returned by StopPropagation())
995 void ResumePropagation(int propagationLevel
)
997 m_propagationLevel
= propagationLevel
;
1001 // This is for internal use only and is only called by
1002 // wxEvtHandler::ProcessEvent() to check whether it's the first time this
1003 // event is being processed
1006 if ( m_wasProcessed
)
1009 m_wasProcessed
= true;
1015 wxObject
* m_eventObject
;
1016 wxEventType m_eventType
;
1021 // m_callbackUserData is for internal usage only
1022 wxObject
* m_callbackUserData
;
1025 // the propagation level: while it is positive, we propagate the event to
1026 // the parent window (if any)
1027 int m_propagationLevel
;
1030 bool m_isCommandEvent
;
1032 // initially false but becomes true as soon as WasProcessed() is called for
1033 // the first time, as this is done only by ProcessEvent() it explains the
1034 // variable name: it becomes true after ProcessEvent() was called at least
1035 // once for this event
1036 bool m_wasProcessed
;
1039 wxEvent(const wxEvent
&); // for implementing Clone()
1040 wxEvent
& operator=(const wxEvent
&); // for derived classes operator=()
1043 // it needs to access our m_propagationLevel
1044 friend class WXDLLIMPEXP_FWD_BASE wxPropagateOnce
;
1046 DECLARE_ABSTRACT_CLASS(wxEvent
)
1050 * Helper class to temporarily change an event not to propagate.
1052 class WXDLLIMPEXP_BASE wxPropagationDisabler
1055 wxPropagationDisabler(wxEvent
& event
) : m_event(event
)
1057 m_propagationLevelOld
= m_event
.StopPropagation();
1060 ~wxPropagationDisabler()
1062 m_event
.ResumePropagation(m_propagationLevelOld
);
1067 int m_propagationLevelOld
;
1069 wxDECLARE_NO_COPY_CLASS(wxPropagationDisabler
);
1073 * Another one to temporarily lower propagation level.
1075 class WXDLLIMPEXP_BASE wxPropagateOnce
1078 wxPropagateOnce(wxEvent
& event
) : m_event(event
)
1080 wxASSERT_MSG( m_event
.m_propagationLevel
> 0,
1081 _T("shouldn't be used unless ShouldPropagate()!") );
1083 m_event
.m_propagationLevel
--;
1088 m_event
.m_propagationLevel
++;
1094 wxDECLARE_NO_COPY_CLASS(wxPropagateOnce
);
1101 // Item or menu event class
1103 wxEVT_COMMAND_BUTTON_CLICKED
1104 wxEVT_COMMAND_CHECKBOX_CLICKED
1105 wxEVT_COMMAND_CHOICE_SELECTED
1106 wxEVT_COMMAND_LISTBOX_SELECTED
1107 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
1108 wxEVT_COMMAND_TEXT_UPDATED
1109 wxEVT_COMMAND_TEXT_ENTER
1110 wxEVT_COMMAND_MENU_SELECTED
1111 wxEVT_COMMAND_SLIDER_UPDATED
1112 wxEVT_COMMAND_RADIOBOX_SELECTED
1113 wxEVT_COMMAND_RADIOBUTTON_SELECTED
1114 wxEVT_COMMAND_SCROLLBAR_UPDATED
1115 wxEVT_COMMAND_VLBOX_SELECTED
1116 wxEVT_COMMAND_COMBOBOX_SELECTED
1117 wxEVT_COMMAND_TOGGLEBUTTON_CLICKED
1120 class WXDLLIMPEXP_CORE wxCommandEvent
: public wxEvent
1123 wxCommandEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0);
1125 wxCommandEvent(const wxCommandEvent
& event
)
1127 m_cmdString(event
.m_cmdString
),
1128 m_commandInt(event
.m_commandInt
),
1129 m_extraLong(event
.m_extraLong
),
1130 m_clientData(event
.m_clientData
),
1131 m_clientObject(event
.m_clientObject
)
1134 // Set/Get client data from controls
1135 void SetClientData(void* clientData
) { m_clientData
= clientData
; }
1136 void *GetClientData() const { return m_clientData
; }
1138 // Set/Get client object from controls
1139 void SetClientObject(wxClientData
* clientObject
) { m_clientObject
= clientObject
; }
1140 wxClientData
*GetClientObject() const { return m_clientObject
; }
1142 // Get listbox selection if single-choice
1143 int GetSelection() const { return m_commandInt
; }
1145 // Set/Get listbox/choice selection string
1146 void SetString(const wxString
& s
) { m_cmdString
= s
; }
1147 wxString
GetString() const;
1149 // Get checkbox value
1150 bool IsChecked() const { return m_commandInt
!= 0; }
1152 // true if the listbox event was a selection.
1153 bool IsSelection() const { return (m_extraLong
!= 0); }
1155 void SetExtraLong(long extraLong
) { m_extraLong
= extraLong
; }
1156 long GetExtraLong() const { return m_extraLong
; }
1158 void SetInt(int i
) { m_commandInt
= i
; }
1159 int GetInt() const { return m_commandInt
; }
1161 virtual wxEvent
*Clone() const { return new wxCommandEvent(*this); }
1162 virtual wxEventCategory
GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT
; }
1165 wxString m_cmdString
; // String event argument
1167 long m_extraLong
; // Additional information (e.g. select/deselect)
1168 void* m_clientData
; // Arbitrary client data
1169 wxClientData
* m_clientObject
; // Arbitrary client object
1172 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCommandEvent
)
1175 // this class adds a possibility to react (from the user) code to a control
1176 // notification: allow or veto the operation being reported.
1177 class WXDLLIMPEXP_CORE wxNotifyEvent
: public wxCommandEvent
1180 wxNotifyEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0)
1181 : wxCommandEvent(commandType
, winid
)
1182 { m_bAllow
= true; }
1184 wxNotifyEvent(const wxNotifyEvent
& event
)
1185 : wxCommandEvent(event
)
1186 { m_bAllow
= event
.m_bAllow
; }
1188 // veto the operation (usually it's allowed by default)
1189 void Veto() { m_bAllow
= false; }
1191 // allow the operation if it was disabled by default
1192 void Allow() { m_bAllow
= true; }
1194 // for implementation code only: is the operation allowed?
1195 bool IsAllowed() const { return m_bAllow
; }
1197 virtual wxEvent
*Clone() const { return new wxNotifyEvent(*this); }
1203 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNotifyEvent
)
1209 class WXDLLIMPEXP_CORE wxThreadEvent
: public wxCommandEvent
1212 wxThreadEvent(wxEventType eventType
= wxEVT_COMMAND_THREAD
, int id
= wxID_ANY
)
1213 : wxCommandEvent(eventType
, id
)
1216 wxThreadEvent(const wxThreadEvent
& event
)
1217 : wxCommandEvent(event
)
1219 // make sure our string member (which uses COW, aka refcounting) is not
1220 // shared by other wxString instances:
1221 SetString(GetString().c_str());
1224 virtual wxEvent
*Clone() const
1226 wxThreadEvent
* ev
= new wxThreadEvent(*this);
1228 // make sure our string member (which uses COW, aka refcounting) is not
1229 // shared by other wxString instances:
1230 ev
->SetString(GetString().c_str());
1234 // this is important to avoid that calling wxEventLoopBase::YieldFor thread events
1235 // gets processed when this is unwanted:
1236 virtual wxEventCategory
GetEventCategory() const
1237 { return wxEVT_CATEGORY_THREAD
; }
1240 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxThreadEvent
)
1245 // Scroll event class, derived form wxCommandEvent. wxScrollEvents are
1246 // sent by wxSlider and wxScrollBar.
1251 wxEVT_SCROLL_LINEDOWN
1253 wxEVT_SCROLL_PAGEDOWN
1254 wxEVT_SCROLL_THUMBTRACK
1255 wxEVT_SCROLL_THUMBRELEASE
1256 wxEVT_SCROLL_CHANGED
1259 class WXDLLIMPEXP_CORE wxScrollEvent
: public wxCommandEvent
1262 wxScrollEvent(wxEventType commandType
= wxEVT_NULL
,
1263 int winid
= 0, int pos
= 0, int orient
= 0);
1265 int GetOrientation() const { return (int) m_extraLong
; }
1266 int GetPosition() const { return m_commandInt
; }
1267 void SetOrientation(int orient
) { m_extraLong
= (long) orient
; }
1268 void SetPosition(int pos
) { m_commandInt
= pos
; }
1270 virtual wxEvent
*Clone() const { return new wxScrollEvent(*this); }
1273 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollEvent
)
1276 // ScrollWin event class, derived fom wxEvent. wxScrollWinEvents
1277 // are sent by wxWindow.
1280 wxEVT_SCROLLWIN_BOTTOM
1281 wxEVT_SCROLLWIN_LINEUP
1282 wxEVT_SCROLLWIN_LINEDOWN
1283 wxEVT_SCROLLWIN_PAGEUP
1284 wxEVT_SCROLLWIN_PAGEDOWN
1285 wxEVT_SCROLLWIN_THUMBTRACK
1286 wxEVT_SCROLLWIN_THUMBRELEASE
1289 class WXDLLIMPEXP_CORE wxScrollWinEvent
: public wxEvent
1292 wxScrollWinEvent(wxEventType commandType
= wxEVT_NULL
,
1293 int pos
= 0, int orient
= 0);
1294 wxScrollWinEvent(const wxScrollWinEvent
& event
) : wxEvent(event
)
1295 { m_commandInt
= event
.m_commandInt
;
1296 m_extraLong
= event
.m_extraLong
; }
1298 int GetOrientation() const { return (int) m_extraLong
; }
1299 int GetPosition() const { return m_commandInt
; }
1300 void SetOrientation(int orient
) { m_extraLong
= (long) orient
; }
1301 void SetPosition(int pos
) { m_commandInt
= pos
; }
1303 virtual wxEvent
*Clone() const { return new wxScrollWinEvent(*this); }
1310 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollWinEvent
)
1315 // Mouse event class
1332 wxEVT_NC_MIDDLE_DOWN,
1334 wxEVT_NC_RIGHT_DOWN,
1337 wxEVT_NC_ENTER_WINDOW,
1338 wxEVT_NC_LEAVE_WINDOW,
1339 wxEVT_NC_LEFT_DCLICK,
1340 wxEVT_NC_MIDDLE_DCLICK,
1341 wxEVT_NC_RIGHT_DCLICK,
1344 class WXDLLIMPEXP_CORE wxMouseEvent
: public wxEvent
,
1348 wxMouseEvent(wxEventType mouseType
= wxEVT_NULL
);
1349 wxMouseEvent(const wxMouseEvent
& event
)
1356 // Was it a button event? (*doesn't* mean: is any button *down*?)
1357 bool IsButton() const { return Button(wxMOUSE_BTN_ANY
); }
1359 // Was it a down event from this (or any) button?
1360 bool ButtonDown(int but
= wxMOUSE_BTN_ANY
) const;
1362 // Was it a dclick event from this (or any) button?
1363 bool ButtonDClick(int but
= wxMOUSE_BTN_ANY
) const;
1365 // Was it a up event from this (or any) button?
1366 bool ButtonUp(int but
= wxMOUSE_BTN_ANY
) const;
1368 // Was this event generated by the given button?
1369 bool Button(int but
) const;
1371 // Get the button which is changing state (wxMOUSE_BTN_NONE if none)
1372 int GetButton() const;
1374 // Find which event was just generated
1375 bool LeftDown() const { return (m_eventType
== wxEVT_LEFT_DOWN
); }
1376 bool MiddleDown() const { return (m_eventType
== wxEVT_MIDDLE_DOWN
); }
1377 bool RightDown() const { return (m_eventType
== wxEVT_RIGHT_DOWN
); }
1378 bool Aux1Down() const { return (m_eventType
== wxEVT_AUX1_DOWN
); }
1379 bool Aux2Down() const { return (m_eventType
== wxEVT_AUX2_DOWN
); }
1381 bool LeftUp() const { return (m_eventType
== wxEVT_LEFT_UP
); }
1382 bool MiddleUp() const { return (m_eventType
== wxEVT_MIDDLE_UP
); }
1383 bool RightUp() const { return (m_eventType
== wxEVT_RIGHT_UP
); }
1384 bool Aux1Up() const { return (m_eventType
== wxEVT_AUX1_UP
); }
1385 bool Aux2Up() const { return (m_eventType
== wxEVT_AUX2_UP
); }
1387 bool LeftDClick() const { return (m_eventType
== wxEVT_LEFT_DCLICK
); }
1388 bool MiddleDClick() const { return (m_eventType
== wxEVT_MIDDLE_DCLICK
); }
1389 bool RightDClick() const { return (m_eventType
== wxEVT_RIGHT_DCLICK
); }
1390 bool Aux1DClick() const { return (m_eventType
== wxEVT_AUX1_UP
); }
1391 bool Aux2DClick() const { return (m_eventType
== wxEVT_AUX2_UP
); }
1393 // True if a button is down and the mouse is moving
1394 bool Dragging() const
1396 return (m_eventType
== wxEVT_MOTION
) && ButtonIsDown(wxMOUSE_BTN_ANY
);
1399 // True if the mouse is moving, and no button is down
1402 return (m_eventType
== wxEVT_MOTION
) && !ButtonIsDown(wxMOUSE_BTN_ANY
);
1405 // True if the mouse is just entering the window
1406 bool Entering() const { return (m_eventType
== wxEVT_ENTER_WINDOW
); }
1408 // True if the mouse is just leaving the window
1409 bool Leaving() const { return (m_eventType
== wxEVT_LEAVE_WINDOW
); }
1411 // Returns the number of mouse clicks associated with this event.
1412 int GetClickCount() const { return m_clickCount
; }
1414 // Find the logical position of the event given the DC
1415 wxPoint
GetLogicalPosition(const wxDC
& dc
) const;
1417 // Get wheel rotation, positive or negative indicates direction of
1418 // rotation. Current devices all send an event when rotation is equal to
1419 // +/-WheelDelta, but this allows for finer resolution devices to be
1420 // created in the future. Because of this you shouldn't assume that one
1421 // event is equal to 1 line or whatever, but you should be able to either
1422 // do partial line scrolling or wait until +/-WheelDelta rotation values
1423 // have been accumulated before scrolling.
1424 int GetWheelRotation() const { return m_wheelRotation
; }
1426 // Get wheel delta, normally 120. This is the threshold for action to be
1427 // taken, and one such action (for example, scrolling one increment)
1428 // should occur for each delta.
1429 int GetWheelDelta() const { return m_wheelDelta
; }
1431 // Gets the axis the wheel operation concerns, 0 being the y axis as on
1432 // most mouse wheels, 1 is the x axis for things like MightyMouse scrolls
1433 // or horizontal trackpad scrolling
1434 int GetWheelAxis() const { return m_wheelAxis
; }
1436 // Returns the configured number of lines (or whatever) to be scrolled per
1437 // wheel action. Defaults to one.
1438 int GetLinesPerAction() const { return m_linesPerAction
; }
1440 // Is the system set to do page scrolling?
1441 bool IsPageScroll() const { return ((unsigned int)m_linesPerAction
== UINT_MAX
); }
1443 virtual wxEvent
*Clone() const { return new wxMouseEvent(*this); }
1444 virtual wxEventCategory
GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT
; }
1446 wxMouseEvent
& operator=(const wxMouseEvent
& event
)
1457 int m_wheelRotation
;
1459 int m_linesPerAction
;
1462 void Assign(const wxMouseEvent
& evt
);
1465 DECLARE_DYNAMIC_CLASS(wxMouseEvent
)
1474 class WXDLLIMPEXP_CORE wxSetCursorEvent
: public wxEvent
1477 wxSetCursorEvent(wxCoord x
= 0, wxCoord y
= 0)
1478 : wxEvent(0, wxEVT_SET_CURSOR
),
1479 m_x(x
), m_y(y
), m_cursor()
1482 wxSetCursorEvent(const wxSetCursorEvent
& event
)
1486 m_cursor(event
.m_cursor
)
1489 wxCoord
GetX() const { return m_x
; }
1490 wxCoord
GetY() const { return m_y
; }
1492 void SetCursor(const wxCursor
& cursor
) { m_cursor
= cursor
; }
1493 const wxCursor
& GetCursor() const { return m_cursor
; }
1494 bool HasCursor() const { return m_cursor
.Ok(); }
1496 virtual wxEvent
*Clone() const { return new wxSetCursorEvent(*this); }
1503 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSetCursorEvent
)
1506 // Keyboard input event class
1516 class WXDLLIMPEXP_CORE wxKeyEvent
: public wxEvent
,
1517 public wxKeyboardState
1520 wxKeyEvent(wxEventType keyType
= wxEVT_NULL
);
1521 wxKeyEvent(const wxKeyEvent
& evt
);
1523 // get the key code: an ASCII7 char or an element of wxKeyCode enum
1524 int GetKeyCode() const { return (int)m_keyCode
; }
1527 // get the Unicode character corresponding to this key
1528 wxChar
GetUnicodeKey() const { return m_uniChar
; }
1529 #endif // wxUSE_UNICODE
1531 // get the raw key code (platform-dependent)
1532 wxUint32
GetRawKeyCode() const { return m_rawCode
; }
1534 // get the raw key flags (platform-dependent)
1535 wxUint32
GetRawKeyFlags() const { return m_rawFlags
; }
1537 // Find the position of the event
1538 void GetPosition(wxCoord
*xpos
, wxCoord
*ypos
) const
1540 if (xpos
) *xpos
= m_x
;
1541 if (ypos
) *ypos
= m_y
;
1544 void GetPosition(long *xpos
, long *ypos
) const
1546 if (xpos
) *xpos
= (long)m_x
;
1547 if (ypos
) *ypos
= (long)m_y
;
1550 wxPoint
GetPosition() const
1551 { return wxPoint(m_x
, m_y
); }
1554 wxCoord
GetX() const { return m_x
; }
1557 wxCoord
GetY() const { return m_y
; }
1559 virtual wxEvent
*Clone() const { return new wxKeyEvent(*this); }
1560 virtual wxEventCategory
GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT
; }
1562 // we do need to copy wxKeyEvent sometimes (in wxTreeCtrl code, for
1564 wxKeyEvent
& operator=(const wxKeyEvent
& evt
)
1568 wxEvent::operator=(evt
);
1570 // Borland C++ 5.82 doesn't compile an explicit call to an
1571 // implicitly defined operator=() so need to do it this way:
1572 *static_cast<wxKeyboardState
*>(this) = evt
;
1577 m_keyCode
= evt
.m_keyCode
;
1579 m_rawCode
= evt
.m_rawCode
;
1580 m_rawFlags
= evt
.m_rawFlags
;
1582 m_uniChar
= evt
.m_uniChar
;
1594 // This contains the full Unicode character
1595 // in a character events in Unicode mode
1599 // these fields contain the platform-specific information about
1600 // key that was pressed
1602 wxUint32 m_rawFlags
;
1605 DECLARE_DYNAMIC_CLASS(wxKeyEvent
)
1613 class WXDLLIMPEXP_CORE wxSizeEvent
: public wxEvent
1616 wxSizeEvent() : wxEvent(0, wxEVT_SIZE
)
1618 wxSizeEvent(const wxSize
& sz
, int winid
= 0)
1619 : wxEvent(winid
, wxEVT_SIZE
),
1622 wxSizeEvent(const wxSizeEvent
& event
)
1624 m_size(event
.m_size
), m_rect(event
.m_rect
)
1626 wxSizeEvent(const wxRect
& rect
, int id
= 0)
1627 : m_size(rect
.GetSize()), m_rect(rect
)
1628 { m_eventType
= wxEVT_SIZING
; m_id
= id
; }
1630 wxSize
GetSize() const { return m_size
; }
1631 wxRect
GetRect() const { return m_rect
; }
1632 void SetRect(const wxRect
& rect
) { m_rect
= rect
; }
1634 virtual wxEvent
*Clone() const { return new wxSizeEvent(*this); }
1637 // For internal usage only. Will be converted to protected members.
1639 wxRect m_rect
; // Used for wxEVT_SIZING
1642 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSizeEvent
)
1651 class WXDLLIMPEXP_CORE wxMoveEvent
: public wxEvent
1655 : wxEvent(0, wxEVT_MOVE
)
1657 wxMoveEvent(const wxPoint
& pos
, int winid
= 0)
1658 : wxEvent(winid
, wxEVT_MOVE
),
1661 wxMoveEvent(const wxMoveEvent
& event
)
1665 wxMoveEvent(const wxRect
& rect
, int id
= 0)
1666 : m_pos(rect
.GetPosition()), m_rect(rect
)
1667 { m_eventType
= wxEVT_MOVING
; m_id
= id
; }
1669 wxPoint
GetPosition() const { return m_pos
; }
1670 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
1671 wxRect
GetRect() const { return m_rect
; }
1672 void SetRect(const wxRect
& rect
) { m_rect
= rect
; }
1674 virtual wxEvent
*Clone() const { return new wxMoveEvent(*this); }
1681 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMoveEvent
)
1684 // Paint event class
1691 #if wxDEBUG_LEVEL && (defined(__WXMSW__) || defined(__WXPM__))
1692 #define wxHAS_PAINT_DEBUG
1694 // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined
1695 extern WXDLLIMPEXP_CORE
int g_isPainting
;
1698 class WXDLLIMPEXP_CORE wxPaintEvent
: public wxEvent
1701 wxPaintEvent(int Id
= 0)
1702 : wxEvent(Id
, wxEVT_PAINT
)
1704 #ifdef wxHAS_PAINT_DEBUG
1705 // set the internal flag for the duration of redrawing
1710 // default copy ctor and dtor are normally fine, we only need them to keep
1711 // g_isPainting updated in debug build
1712 #ifdef wxHAS_PAINT_DEBUG
1713 wxPaintEvent(const wxPaintEvent
& event
)
1719 virtual ~wxPaintEvent()
1725 virtual wxEvent
*Clone() const { return new wxPaintEvent(*this); }
1728 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaintEvent
)
1731 class WXDLLIMPEXP_CORE wxNcPaintEvent
: public wxEvent
1734 wxNcPaintEvent(int winid
= 0)
1735 : wxEvent(winid
, wxEVT_NC_PAINT
)
1738 virtual wxEvent
*Clone() const { return new wxNcPaintEvent(*this); }
1741 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNcPaintEvent
)
1744 // Erase background event class
1746 wxEVT_ERASE_BACKGROUND
1749 class WXDLLIMPEXP_CORE wxEraseEvent
: public wxEvent
1752 wxEraseEvent(int Id
= 0, wxDC
*dc
= NULL
)
1753 : wxEvent(Id
, wxEVT_ERASE_BACKGROUND
),
1757 wxEraseEvent(const wxEraseEvent
& event
)
1762 wxDC
*GetDC() const { return m_dc
; }
1764 virtual wxEvent
*Clone() const { return new wxEraseEvent(*this); }
1770 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxEraseEvent
)
1773 // Focus event class
1779 class WXDLLIMPEXP_CORE wxFocusEvent
: public wxEvent
1782 wxFocusEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0)
1783 : wxEvent(winid
, type
)
1786 wxFocusEvent(const wxFocusEvent
& event
)
1788 { m_win
= event
.m_win
; }
1790 // The window associated with this event is the window which had focus
1791 // before for SET event and the window which will have focus for the KILL
1792 // one. NB: it may be NULL in both cases!
1793 wxWindow
*GetWindow() const { return m_win
; }
1794 void SetWindow(wxWindow
*win
) { m_win
= win
; }
1796 virtual wxEvent
*Clone() const { return new wxFocusEvent(*this); }
1802 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFocusEvent
)
1805 // wxChildFocusEvent notifies the parent that a child has got the focus: unlike
1806 // wxFocusEvent it is propagated upwards the window chain
1807 class WXDLLIMPEXP_CORE wxChildFocusEvent
: public wxCommandEvent
1810 wxChildFocusEvent(wxWindow
*win
= NULL
);
1812 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
1814 virtual wxEvent
*Clone() const { return new wxChildFocusEvent(*this); }
1817 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxChildFocusEvent
)
1820 // Activate event class
1827 class WXDLLIMPEXP_CORE wxActivateEvent
: public wxEvent
1830 wxActivateEvent(wxEventType type
= wxEVT_NULL
, bool active
= true, int Id
= 0)
1832 { m_active
= active
; }
1833 wxActivateEvent(const wxActivateEvent
& event
)
1835 { m_active
= event
.m_active
; }
1837 bool GetActive() const { return m_active
; }
1839 virtual wxEvent
*Clone() const { return new wxActivateEvent(*this); }
1845 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxActivateEvent
)
1848 // InitDialog event class
1853 class WXDLLIMPEXP_CORE wxInitDialogEvent
: public wxEvent
1856 wxInitDialogEvent(int Id
= 0)
1857 : wxEvent(Id
, wxEVT_INIT_DIALOG
)
1860 virtual wxEvent
*Clone() const { return new wxInitDialogEvent(*this); }
1863 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxInitDialogEvent
)
1866 // Miscellaneous menu event class
1870 wxEVT_MENU_HIGHLIGHT,
1873 class WXDLLIMPEXP_CORE wxMenuEvent
: public wxEvent
1876 wxMenuEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0, wxMenu
* menu
= NULL
)
1877 : wxEvent(winid
, type
)
1878 { m_menuId
= winid
; m_menu
= menu
; }
1879 wxMenuEvent(const wxMenuEvent
& event
)
1881 { m_menuId
= event
.m_menuId
; m_menu
= event
.m_menu
; }
1883 // only for wxEVT_MENU_HIGHLIGHT
1884 int GetMenuId() const { return m_menuId
; }
1886 // only for wxEVT_MENU_OPEN/CLOSE
1887 bool IsPopup() const { return m_menuId
== wxID_ANY
; }
1889 // only for wxEVT_MENU_OPEN/CLOSE
1890 wxMenu
* GetMenu() const { return m_menu
; }
1892 virtual wxEvent
*Clone() const { return new wxMenuEvent(*this); }
1898 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMenuEvent
)
1901 // Window close or session close event class
1905 wxEVT_QUERY_END_SESSION
1908 class WXDLLIMPEXP_CORE wxCloseEvent
: public wxEvent
1911 wxCloseEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0)
1912 : wxEvent(winid
, type
),
1914 m_veto(false), // should be false by default
1917 wxCloseEvent(const wxCloseEvent
& event
)
1919 m_loggingOff(event
.m_loggingOff
),
1920 m_veto(event
.m_veto
),
1921 m_canVeto(event
.m_canVeto
) {}
1923 void SetLoggingOff(bool logOff
) { m_loggingOff
= logOff
; }
1924 bool GetLoggingOff() const
1926 // m_loggingOff flag is only used by wxEVT_[QUERY_]END_SESSION, it
1927 // doesn't make sense for wxEVT_CLOSE_WINDOW
1928 wxASSERT_MSG( m_eventType
!= wxEVT_CLOSE_WINDOW
,
1929 _T("this flag is for end session events only") );
1931 return m_loggingOff
;
1934 void Veto(bool veto
= true)
1936 // GetVeto() will return false anyhow...
1937 wxCHECK_RET( m_canVeto
,
1938 wxT("call to Veto() ignored (can't veto this event)") );
1942 void SetCanVeto(bool canVeto
) { m_canVeto
= canVeto
; }
1943 bool CanVeto() const { return m_canVeto
; }
1944 bool GetVeto() const { return m_canVeto
&& m_veto
; }
1946 virtual wxEvent
*Clone() const { return new wxCloseEvent(*this); }
1954 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCloseEvent
)
1961 class WXDLLIMPEXP_CORE wxShowEvent
: public wxEvent
1964 wxShowEvent(int winid
= 0, bool show
= false)
1965 : wxEvent(winid
, wxEVT_SHOW
)
1967 wxShowEvent(const wxShowEvent
& event
)
1969 { m_show
= event
.m_show
; }
1971 void SetShow(bool show
) { m_show
= show
; }
1973 // return true if the window was shown, false if hidden
1974 bool IsShown() const { return m_show
; }
1976 #if WXWIN_COMPATIBILITY_2_8
1977 wxDEPRECATED( bool GetShow() const { return IsShown(); } )
1980 virtual wxEvent
*Clone() const { return new wxShowEvent(*this); }
1986 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxShowEvent
)
1993 class WXDLLIMPEXP_CORE wxIconizeEvent
: public wxEvent
1996 wxIconizeEvent(int winid
= 0, bool iconized
= true)
1997 : wxEvent(winid
, wxEVT_ICONIZE
)
1998 { m_iconized
= iconized
; }
1999 wxIconizeEvent(const wxIconizeEvent
& event
)
2001 { m_iconized
= event
.m_iconized
; }
2003 #if WXWIN_COMPATIBILITY_2_8
2004 wxDEPRECATED( bool Iconized() const { return IsIconized(); } )
2006 // return true if the frame was iconized, false if restored
2007 bool IsIconized() const { return m_iconized
; }
2009 virtual wxEvent
*Clone() const { return new wxIconizeEvent(*this); }
2015 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIconizeEvent
)
2021 class WXDLLIMPEXP_CORE wxMaximizeEvent
: public wxEvent
2024 wxMaximizeEvent(int winid
= 0)
2025 : wxEvent(winid
, wxEVT_MAXIMIZE
)
2028 virtual wxEvent
*Clone() const { return new wxMaximizeEvent(*this); }
2031 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMaximizeEvent
)
2034 // Joystick event class
2036 wxEVT_JOY_BUTTON_DOWN,
2037 wxEVT_JOY_BUTTON_UP,
2042 // Which joystick? Same as Windows ids so no conversion necessary.
2049 // Which button is down?
2052 wxJOY_BUTTON_ANY
= -1,
2059 class WXDLLIMPEXP_CORE wxJoystickEvent
: public wxEvent
2064 int m_buttonChange
; // Which button changed?
2065 int m_buttonState
; // Which buttons are down?
2066 int m_joyStick
; // Which joystick?
2069 wxJoystickEvent(wxEventType type
= wxEVT_NULL
,
2071 int joystick
= wxJOYSTICK1
,
2076 m_buttonChange(change
),
2077 m_buttonState(state
),
2078 m_joyStick(joystick
)
2081 wxJoystickEvent(const wxJoystickEvent
& event
)
2084 m_zPosition(event
.m_zPosition
),
2085 m_buttonChange(event
.m_buttonChange
),
2086 m_buttonState(event
.m_buttonState
),
2087 m_joyStick(event
.m_joyStick
)
2090 wxPoint
GetPosition() const { return m_pos
; }
2091 int GetZPosition() const { return m_zPosition
; }
2092 int GetButtonState() const { return m_buttonState
; }
2093 int GetButtonChange() const { return m_buttonChange
; }
2094 int GetJoystick() const { return m_joyStick
; }
2096 void SetJoystick(int stick
) { m_joyStick
= stick
; }
2097 void SetButtonState(int state
) { m_buttonState
= state
; }
2098 void SetButtonChange(int change
) { m_buttonChange
= change
; }
2099 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2100 void SetZPosition(int zPos
) { m_zPosition
= zPos
; }
2102 // Was it a button event? (*doesn't* mean: is any button *down*?)
2103 bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN
) ||
2104 (GetEventType() == wxEVT_JOY_BUTTON_UP
)); }
2106 // Was it a move event?
2107 bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE
); }
2109 // Was it a zmove event?
2110 bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE
); }
2112 // Was it a down event from button 1, 2, 3, 4 or any?
2113 bool ButtonDown(int but
= wxJOY_BUTTON_ANY
) const
2114 { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN
) &&
2115 ((but
== wxJOY_BUTTON_ANY
) || (but
== m_buttonChange
))); }
2117 // Was it a up event from button 1, 2, 3 or any?
2118 bool ButtonUp(int but
= wxJOY_BUTTON_ANY
) const
2119 { return ((GetEventType() == wxEVT_JOY_BUTTON_UP
) &&
2120 ((but
== wxJOY_BUTTON_ANY
) || (but
== m_buttonChange
))); }
2122 // Was the given button 1,2,3,4 or any in Down state?
2123 bool ButtonIsDown(int but
= wxJOY_BUTTON_ANY
) const
2124 { return (((but
== wxJOY_BUTTON_ANY
) && (m_buttonState
!= 0)) ||
2125 ((m_buttonState
& but
) == but
)); }
2127 virtual wxEvent
*Clone() const { return new wxJoystickEvent(*this); }
2130 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxJoystickEvent
)
2133 // Drop files event class
2138 class WXDLLIMPEXP_CORE wxDropFilesEvent
: public wxEvent
2145 wxDropFilesEvent(wxEventType type
= wxEVT_NULL
,
2147 wxString
*files
= NULL
)
2154 // we need a copy ctor to avoid deleting m_files pointer twice
2155 wxDropFilesEvent(const wxDropFilesEvent
& other
)
2157 m_noFiles(other
.m_noFiles
),
2161 m_files
= new wxString
[m_noFiles
];
2162 for ( int n
= 0; n
< m_noFiles
; n
++ )
2164 m_files
[n
] = other
.m_files
[n
];
2168 virtual ~wxDropFilesEvent()
2173 wxPoint
GetPosition() const { return m_pos
; }
2174 int GetNumberOfFiles() const { return m_noFiles
; }
2175 wxString
*GetFiles() const { return m_files
; }
2177 virtual wxEvent
*Clone() const { return new wxDropFilesEvent(*this); }
2180 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDropFilesEvent
)
2188 // Whether to always send update events to windows, or
2189 // to only send update events to those with the
2190 // wxWS_EX_PROCESS_UI_UPDATES style.
2194 // Send UI update events to all windows
2195 wxUPDATE_UI_PROCESS_ALL
,
2197 // Send UI update events to windows that have
2198 // the wxWS_EX_PROCESS_UI_UPDATES flag specified
2199 wxUPDATE_UI_PROCESS_SPECIFIED
2202 class WXDLLIMPEXP_CORE wxUpdateUIEvent
: public wxCommandEvent
2205 wxUpdateUIEvent(wxWindowID commandId
= 0)
2206 : wxCommandEvent(wxEVT_UPDATE_UI
, commandId
)
2214 m_setChecked
= false;
2216 wxUpdateUIEvent(const wxUpdateUIEvent
& event
)
2217 : wxCommandEvent(event
),
2218 m_checked(event
.m_checked
),
2219 m_enabled(event
.m_enabled
),
2220 m_shown(event
.m_shown
),
2221 m_setEnabled(event
.m_setEnabled
),
2222 m_setShown(event
.m_setShown
),
2223 m_setText(event
.m_setText
),
2224 m_setChecked(event
.m_setChecked
),
2225 m_text(event
.m_text
)
2228 bool GetChecked() const { return m_checked
; }
2229 bool GetEnabled() const { return m_enabled
; }
2230 bool GetShown() const { return m_shown
; }
2231 wxString
GetText() const { return m_text
; }
2232 bool GetSetText() const { return m_setText
; }
2233 bool GetSetChecked() const { return m_setChecked
; }
2234 bool GetSetEnabled() const { return m_setEnabled
; }
2235 bool GetSetShown() const { return m_setShown
; }
2237 void Check(bool check
) { m_checked
= check
; m_setChecked
= true; }
2238 void Enable(bool enable
) { m_enabled
= enable
; m_setEnabled
= true; }
2239 void Show(bool show
) { m_shown
= show
; m_setShown
= true; }
2240 void SetText(const wxString
& text
) { m_text
= text
; m_setText
= true; }
2242 // Sets the interval between updates in milliseconds.
2243 // Set to -1 to disable updates, or to 0 to update as frequently as possible.
2244 static void SetUpdateInterval(long updateInterval
) { sm_updateInterval
= updateInterval
; }
2246 // Returns the current interval between updates in milliseconds
2247 static long GetUpdateInterval() { return sm_updateInterval
; }
2249 // Can we update this window?
2250 static bool CanUpdate(wxWindowBase
*win
);
2252 // Reset the update time to provide a delay until the next
2253 // time we should update
2254 static void ResetUpdateTime();
2256 // Specify how wxWidgets will send update events: to
2257 // all windows, or only to those which specify that they
2258 // will process the events.
2259 static void SetMode(wxUpdateUIMode mode
) { sm_updateMode
= mode
; }
2261 // Returns the UI update mode
2262 static wxUpdateUIMode
GetMode() { return sm_updateMode
; }
2264 virtual wxEvent
*Clone() const { return new wxUpdateUIEvent(*this); }
2276 static wxLongLong sm_lastUpdate
;
2278 static long sm_updateInterval
;
2279 static wxUpdateUIMode sm_updateMode
;
2282 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxUpdateUIEvent
)
2286 wxEVT_SYS_COLOUR_CHANGED
2289 // TODO: shouldn't all events record the window ID?
2290 class WXDLLIMPEXP_CORE wxSysColourChangedEvent
: public wxEvent
2293 wxSysColourChangedEvent()
2294 : wxEvent(0, wxEVT_SYS_COLOUR_CHANGED
)
2297 virtual wxEvent
*Clone() const { return new wxSysColourChangedEvent(*this); }
2300 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSysColourChangedEvent
)
2304 wxEVT_MOUSE_CAPTURE_CHANGED
2305 The window losing the capture receives this message
2306 (even if it released the capture itself).
2309 class WXDLLIMPEXP_CORE wxMouseCaptureChangedEvent
: public wxEvent
2312 wxMouseCaptureChangedEvent(wxWindowID winid
= 0, wxWindow
* gainedCapture
= NULL
)
2313 : wxEvent(winid
, wxEVT_MOUSE_CAPTURE_CHANGED
),
2314 m_gainedCapture(gainedCapture
)
2317 wxMouseCaptureChangedEvent(const wxMouseCaptureChangedEvent
& event
)
2319 m_gainedCapture(event
.m_gainedCapture
)
2322 virtual wxEvent
*Clone() const { return new wxMouseCaptureChangedEvent(*this); }
2324 wxWindow
* GetCapturedWindow() const { return m_gainedCapture
; }
2327 wxWindow
* m_gainedCapture
;
2329 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureChangedEvent
)
2333 wxEVT_MOUSE_CAPTURE_LOST
2334 The window losing the capture receives this message, unless it released it
2335 it itself or unless wxWindow::CaptureMouse was called on another window
2336 (and so capture will be restored when the new capturer releases it).
2339 class WXDLLIMPEXP_CORE wxMouseCaptureLostEvent
: public wxEvent
2342 wxMouseCaptureLostEvent(wxWindowID winid
= 0)
2343 : wxEvent(winid
, wxEVT_MOUSE_CAPTURE_LOST
)
2346 wxMouseCaptureLostEvent(const wxMouseCaptureLostEvent
& event
)
2350 virtual wxEvent
*Clone() const { return new wxMouseCaptureLostEvent(*this); }
2352 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureLostEvent
)
2356 wxEVT_DISPLAY_CHANGED
2358 class WXDLLIMPEXP_CORE wxDisplayChangedEvent
: public wxEvent
2361 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDisplayChangedEvent
)
2364 wxDisplayChangedEvent()
2365 : wxEvent(0, wxEVT_DISPLAY_CHANGED
)
2368 virtual wxEvent
*Clone() const { return new wxDisplayChangedEvent(*this); }
2372 wxEVT_PALETTE_CHANGED
2375 class WXDLLIMPEXP_CORE wxPaletteChangedEvent
: public wxEvent
2378 wxPaletteChangedEvent(wxWindowID winid
= 0)
2379 : wxEvent(winid
, wxEVT_PALETTE_CHANGED
),
2380 m_changedWindow(NULL
)
2383 wxPaletteChangedEvent(const wxPaletteChangedEvent
& event
)
2385 m_changedWindow(event
.m_changedWindow
)
2388 void SetChangedWindow(wxWindow
* win
) { m_changedWindow
= win
; }
2389 wxWindow
* GetChangedWindow() const { return m_changedWindow
; }
2391 virtual wxEvent
*Clone() const { return new wxPaletteChangedEvent(*this); }
2394 wxWindow
* m_changedWindow
;
2397 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaletteChangedEvent
)
2401 wxEVT_QUERY_NEW_PALETTE
2402 Indicates the window is getting keyboard focus and should re-do its palette.
2405 class WXDLLIMPEXP_CORE wxQueryNewPaletteEvent
: public wxEvent
2408 wxQueryNewPaletteEvent(wxWindowID winid
= 0)
2409 : wxEvent(winid
, wxEVT_QUERY_NEW_PALETTE
),
2410 m_paletteRealized(false)
2412 wxQueryNewPaletteEvent(const wxQueryNewPaletteEvent
& event
)
2414 m_paletteRealized(event
.m_paletteRealized
)
2417 // App sets this if it changes the palette.
2418 void SetPaletteRealized(bool realized
) { m_paletteRealized
= realized
; }
2419 bool GetPaletteRealized() const { return m_paletteRealized
; }
2421 virtual wxEvent
*Clone() const { return new wxQueryNewPaletteEvent(*this); }
2424 bool m_paletteRealized
;
2427 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxQueryNewPaletteEvent
)
2431 Event generated by dialog navigation keys
2432 wxEVT_NAVIGATION_KEY
2434 // NB: don't derive from command event to avoid being propagated to the parent
2435 class WXDLLIMPEXP_CORE wxNavigationKeyEvent
: public wxEvent
2438 wxNavigationKeyEvent()
2439 : wxEvent(0, wxEVT_NAVIGATION_KEY
),
2440 m_flags(IsForward
| FromTab
), // defaults are for TAB
2443 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
2446 wxNavigationKeyEvent(const wxNavigationKeyEvent
& event
)
2448 m_flags(event
.m_flags
),
2449 m_focus(event
.m_focus
)
2452 // direction: forward (true) or backward (false)
2453 bool GetDirection() const
2454 { return (m_flags
& IsForward
) != 0; }
2455 void SetDirection(bool bForward
)
2456 { if ( bForward
) m_flags
|= IsForward
; else m_flags
&= ~IsForward
; }
2458 // it may be a window change event (MDI, notebook pages...) or a control
2460 bool IsWindowChange() const
2461 { return (m_flags
& WinChange
) != 0; }
2462 void SetWindowChange(bool bIs
)
2463 { if ( bIs
) m_flags
|= WinChange
; else m_flags
&= ~WinChange
; }
2465 // Set to true under MSW if the event was generated using the tab key.
2466 // This is required for proper navogation over radio buttons
2467 bool IsFromTab() const
2468 { return (m_flags
& FromTab
) != 0; }
2469 void SetFromTab(bool bIs
)
2470 { if ( bIs
) m_flags
|= FromTab
; else m_flags
&= ~FromTab
; }
2472 // the child which has the focus currently (may be NULL - use
2473 // wxWindow::FindFocus then)
2474 wxWindow
* GetCurrentFocus() const { return m_focus
; }
2475 void SetCurrentFocus(wxWindow
*win
) { m_focus
= win
; }
2478 void SetFlags(long flags
) { m_flags
= flags
; }
2480 virtual wxEvent
*Clone() const { return new wxNavigationKeyEvent(*this); }
2482 enum wxNavigationKeyEventFlags
2484 IsBackward
= 0x0000,
2494 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNavigationKeyEvent
)
2497 // Window creation/destruction events: the first is sent as soon as window is
2498 // created (i.e. the underlying GUI object exists), but when the C++ object is
2499 // fully initialized (so virtual functions may be called). The second,
2500 // wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
2501 // still safe to call virtual functions at this moment
2507 class WXDLLIMPEXP_CORE wxWindowCreateEvent
: public wxCommandEvent
2510 wxWindowCreateEvent(wxWindow
*win
= NULL
);
2512 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
2514 virtual wxEvent
*Clone() const { return new wxWindowCreateEvent(*this); }
2517 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowCreateEvent
)
2520 class WXDLLIMPEXP_CORE wxWindowDestroyEvent
: public wxCommandEvent
2523 wxWindowDestroyEvent(wxWindow
*win
= NULL
);
2525 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
2527 virtual wxEvent
*Clone() const { return new wxWindowDestroyEvent(*this); }
2530 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowDestroyEvent
)
2533 // A help event is sent when the user clicks on a window in context-help mode.
2539 class WXDLLIMPEXP_CORE wxHelpEvent
: public wxCommandEvent
2542 // how was this help event generated?
2545 Origin_Unknown
, // unrecognized event source
2546 Origin_Keyboard
, // event generated from F1 key press
2547 Origin_HelpButton
// event from [?] button on the title bar (Windows)
2550 wxHelpEvent(wxEventType type
= wxEVT_NULL
,
2551 wxWindowID winid
= 0,
2552 const wxPoint
& pt
= wxDefaultPosition
,
2553 Origin origin
= Origin_Unknown
)
2554 : wxCommandEvent(type
, winid
),
2556 m_origin(GuessOrigin(origin
))
2558 wxHelpEvent(const wxHelpEvent
& event
)
2559 : wxCommandEvent(event
),
2561 m_target(event
.m_target
),
2562 m_link(event
.m_link
),
2563 m_origin(event
.m_origin
)
2566 // Position of event (in screen coordinates)
2567 const wxPoint
& GetPosition() const { return m_pos
; }
2568 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2570 // Optional link to further help
2571 const wxString
& GetLink() const { return m_link
; }
2572 void SetLink(const wxString
& link
) { m_link
= link
; }
2574 // Optional target to display help in. E.g. a window specification
2575 const wxString
& GetTarget() const { return m_target
; }
2576 void SetTarget(const wxString
& target
) { m_target
= target
; }
2578 virtual wxEvent
*Clone() const { return new wxHelpEvent(*this); }
2580 // optional indication of the event source
2581 Origin
GetOrigin() const { return m_origin
; }
2582 void SetOrigin(Origin origin
) { m_origin
= origin
; }
2590 // we can try to guess the event origin ourselves, even if none is
2591 // specified in the ctor
2592 static Origin
GuessOrigin(Origin origin
);
2595 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHelpEvent
)
2598 // A Clipboard Text event is sent when a window intercepts text copy/cut/paste
2599 // message, i.e. the user has cut/copied/pasted data from/into a text control
2600 // via ctrl-C/X/V, ctrl/shift-del/insert, a popup menu command, etc.
2601 // NOTE : under windows these events are *NOT* generated automatically
2602 // for a Rich Edit text control.
2604 wxEVT_COMMAND_TEXT_COPY
2605 wxEVT_COMMAND_TEXT_CUT
2606 wxEVT_COMMAND_TEXT_PASTE
2609 class WXDLLIMPEXP_CORE wxClipboardTextEvent
: public wxCommandEvent
2612 wxClipboardTextEvent(wxEventType type
= wxEVT_NULL
,
2613 wxWindowID winid
= 0)
2614 : wxCommandEvent(type
, winid
)
2616 wxClipboardTextEvent(const wxClipboardTextEvent
& event
)
2617 : wxCommandEvent(event
)
2620 virtual wxEvent
*Clone() const { return new wxClipboardTextEvent(*this); }
2623 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxClipboardTextEvent
)
2626 // A Context event is sent when the user right clicks on a window or
2627 // presses Shift-F10
2628 // NOTE : Under windows this is a repackaged WM_CONTETXMENU message
2629 // Under other systems it may have to be generated from a right click event
2634 class WXDLLIMPEXP_CORE wxContextMenuEvent
: public wxCommandEvent
2637 wxContextMenuEvent(wxEventType type
= wxEVT_NULL
,
2638 wxWindowID winid
= 0,
2639 const wxPoint
& pt
= wxDefaultPosition
)
2640 : wxCommandEvent(type
, winid
),
2643 wxContextMenuEvent(const wxContextMenuEvent
& event
)
2644 : wxCommandEvent(event
),
2648 // Position of event (in screen coordinates)
2649 const wxPoint
& GetPosition() const { return m_pos
; }
2650 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2652 virtual wxEvent
*Clone() const { return new wxContextMenuEvent(*this); }
2658 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxContextMenuEvent
)
2668 // Whether to always send idle events to windows, or
2669 // to only send update events to those with the
2670 // wxWS_EX_PROCESS_IDLE style.
2674 // Send idle events to all windows
2677 // Send idle events to windows that have
2678 // the wxWS_EX_PROCESS_IDLE flag specified
2679 wxIDLE_PROCESS_SPECIFIED
2682 class WXDLLIMPEXP_BASE wxIdleEvent
: public wxEvent
2686 : wxEvent(0, wxEVT_IDLE
),
2687 m_requestMore(false)
2689 wxIdleEvent(const wxIdleEvent
& event
)
2691 m_requestMore(event
.m_requestMore
)
2694 void RequestMore(bool needMore
= true) { m_requestMore
= needMore
; }
2695 bool MoreRequested() const { return m_requestMore
; }
2697 virtual wxEvent
*Clone() const { return new wxIdleEvent(*this); }
2699 // Specify how wxWidgets will send idle events: to
2700 // all windows, or only to those which specify that they
2701 // will process the events.
2702 static void SetMode(wxIdleMode mode
) { sm_idleMode
= mode
; }
2704 // Returns the idle event mode
2705 static wxIdleMode
GetMode() { return sm_idleMode
; }
2709 static wxIdleMode sm_idleMode
;
2712 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIdleEvent
)
2716 wxEVT_MOUSE_CAPTURE_CHANGED,
2717 wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
2718 // wxEVT_FONT_CHANGED, // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
2719 // wxEVT_FONT_CHANGED to all other windows (maybe).
2720 wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
2727 // ============================================================================
2728 // event handler and related classes
2729 // ============================================================================
2732 // struct containing the members common to static and dynamic event tables
2734 struct WXDLLIMPEXP_BASE wxEventTableEntryBase
2736 wxEventTableEntryBase(int winid
, int idLast
,
2737 wxEventFunctor
* fn
, wxObject
*data
)
2741 m_callbackUserData(data
)
2744 wxEventTableEntryBase( const wxEventTableEntryBase
&entry
)
2745 : m_id( entry
.m_id
),
2746 m_lastId( entry
.m_lastId
),
2748 m_callbackUserData( entry
.m_callbackUserData
)
2750 // This is a 'hack' to ensure that only one instance tries to delete
2751 // the functor pointer. It is safe as long as the only place where the
2752 // copy constructor is being called is when the static event tables are
2753 // being initialized (a temporary instance is created and then this
2754 // constructor is called).
2756 const_cast<wxEventTableEntryBase
&>( entry
).m_fn
= NULL
;
2759 ~wxEventTableEntryBase()
2764 // the range of ids for this entry: if m_lastId == wxID_ANY, the range
2765 // consists only of m_id, otherwise it is m_id..m_lastId inclusive
2769 // function/method/functor to call
2770 wxEventFunctor
* m_fn
;
2772 // arbitrary user data associated with the callback
2773 wxObject
* m_callbackUserData
;
2776 wxDECLARE_NO_ASSIGN_CLASS(wxEventTableEntryBase
);
2779 // an entry from a static event table
2780 struct WXDLLIMPEXP_BASE wxEventTableEntry
: public wxEventTableEntryBase
2782 wxEventTableEntry(const int& evType
, int winid
, int idLast
,
2783 wxEventFunctor
* fn
, wxObject
*data
)
2784 : wxEventTableEntryBase(winid
, idLast
, fn
, data
),
2788 // the reference to event type: this allows us to not care about the
2789 // (undefined) order in which the event table entries and the event types
2790 // are initialized: initially the value of this reference might be
2791 // invalid, but by the time it is used for the first time, all global
2792 // objects will have been initialized (including the event type constants)
2793 // and so it will have the correct value when it is needed
2794 const int& m_eventType
;
2797 wxDECLARE_NO_ASSIGN_CLASS(wxEventTableEntry
);
2800 // an entry used in dynamic event table managed by wxEvtHandler::Connect()
2801 struct WXDLLIMPEXP_BASE wxDynamicEventTableEntry
: public wxEventTableEntryBase
2803 wxDynamicEventTableEntry(int evType
, int winid
, int idLast
,
2804 wxEventFunctor
* fn
, wxObject
*data
)
2805 : wxEventTableEntryBase(winid
, idLast
, fn
, data
),
2809 // not a reference here as we can't keep a reference to a temporary int
2810 // created to wrap the constant value typically passed to Connect() - nor
2815 wxDECLARE_NO_ASSIGN_CLASS(wxDynamicEventTableEntry
);
2818 // ----------------------------------------------------------------------------
2819 // wxEventTable: an array of event entries terminated with {0, 0, 0, 0, 0}
2820 // ----------------------------------------------------------------------------
2822 struct WXDLLIMPEXP_BASE wxEventTable
2824 const wxEventTable
*baseTable
; // base event table (next in chain)
2825 const wxEventTableEntry
*entries
; // bottom of entry array
2828 // ----------------------------------------------------------------------------
2829 // wxEventHashTable: a helper of wxEvtHandler to speed up wxEventTable lookups.
2830 // ----------------------------------------------------------------------------
2832 WX_DEFINE_ARRAY_PTR(const wxEventTableEntry
*, wxEventTableEntryPointerArray
);
2834 class WXDLLIMPEXP_BASE wxEventHashTable
2837 // Internal data structs
2838 struct EventTypeTable
2840 wxEventType eventType
;
2841 wxEventTableEntryPointerArray eventEntryTable
;
2843 typedef EventTypeTable
* EventTypeTablePointer
;
2846 // Constructor, needs the event table it needs to hash later on.
2847 // Note: hashing of the event table is not done in the constructor as it
2848 // can be that the event table is not yet full initialize, the hash
2849 // will gets initialized when handling the first event look-up request.
2850 wxEventHashTable(const wxEventTable
&table
);
2852 ~wxEventHashTable();
2854 // Handle the given event, in other words search the event table hash
2855 // and call self->ProcessEvent() if a match was found.
2856 bool HandleEvent(wxEvent
& event
, wxEvtHandler
*self
);
2861 #if wxUSE_MEMORY_TRACING
2862 // Clear all tables: only used to work around problems in memory tracing
2864 static void ClearAll();
2865 #endif // wxUSE_MEMORY_TRACING
2868 // Init the hash table with the entries of the static event table.
2869 void InitHashTable();
2870 // Helper funtion of InitHashTable() to insert 1 entry into the hash table.
2871 void AddEntry(const wxEventTableEntry
&entry
);
2872 // Allocate and init with null pointers the base hash table.
2873 void AllocEventTypeTable(size_t size
);
2874 // Grow the hash table in size and transfer all items currently
2875 // in the table to the correct location in the new table.
2876 void GrowEventTypeTable();
2879 const wxEventTable
&m_table
;
2883 EventTypeTablePointer
*m_eventTypeTable
;
2885 static wxEventHashTable
* sm_first
;
2886 wxEventHashTable
* m_previous
;
2887 wxEventHashTable
* m_next
;
2889 wxDECLARE_NO_COPY_CLASS(wxEventHashTable
);
2892 // ----------------------------------------------------------------------------
2893 // wxEvtHandler: the base class for all objects handling wxWidgets events
2894 // ----------------------------------------------------------------------------
2896 class WXDLLIMPEXP_BASE wxEvtHandler
: public wxObject
2897 , public wxTrackable
2901 virtual ~wxEvtHandler();
2904 // Event handler chain
2905 // -------------------
2907 wxEvtHandler
*GetNextHandler() const { return m_nextHandler
; }
2908 wxEvtHandler
*GetPreviousHandler() const { return m_previousHandler
; }
2909 virtual void SetNextHandler(wxEvtHandler
*handler
) { m_nextHandler
= handler
; }
2910 virtual void SetPreviousHandler(wxEvtHandler
*handler
) { m_previousHandler
= handler
; }
2912 void SetEvtHandlerEnabled(bool enabled
) { m_enabled
= enabled
; }
2913 bool GetEvtHandlerEnabled() const { return m_enabled
; }
2916 bool IsUnlinked() const;
2920 // Event queuing and processing
2921 // ----------------------------
2923 // Process an event right now: this can only be called from the main
2924 // thread, use QueueEvent() for scheduling the events for
2925 // processing from other threads.
2926 virtual bool ProcessEvent(wxEvent
& event
);
2928 // Process an event by calling ProcessEvent and handling any exceptions
2929 // thrown by event handlers. It's mostly useful when processing wx events
2930 // when called from C code (e.g. in GTK+ callback) when the exception
2931 // wouldn't correctly propagate to wxEventLoop.
2932 bool SafelyProcessEvent(wxEvent
& event
);
2933 // NOTE: uses ProcessEvent()
2935 // Schedule the given event to be processed later. It takes ownership of
2936 // the event pointer, i.e. it will be deleted later. This is safe to call
2937 // from multiple threads although you still need to ensure that wxString
2938 // fields of the event object are deep copies and not use the same string
2939 // buffer as other wxString objects in this thread.
2940 virtual void QueueEvent(wxEvent
*event
);
2942 // Add an event to be processed later: notice that this function is not
2943 // safe to call from threads other than main, use QueueEvent()
2944 virtual void AddPendingEvent(const wxEvent
& event
)
2946 // notice that the thread-safety problem comes from the fact that
2947 // Clone() doesn't make deep copies of wxString fields of wxEvent
2948 // object and so the same wxString could be used from both threads when
2949 // the event object is destroyed in this one -- QueueEvent() avoids
2950 // this problem as the event pointer is not used any more in this
2951 // thread at all after it is called.
2952 QueueEvent(event
.Clone());
2955 void ProcessPendingEvents();
2956 // NOTE: uses ProcessEvent()
2958 void DeletePendingEvents();
2961 bool ProcessThreadEvent(const wxEvent
& event
);
2962 // NOTE: uses AddPendingEvent(); call only from secondary threads
2966 // Connecting and disconnecting
2967 // ----------------------------
2969 // These functions are used for old, untyped, event handlers and don't
2970 // check that the type of the function passed to them actually matches the
2971 // type of the event. They also only allow connecting events to methods of
2972 // wxEvtHandler-derived classes.
2974 // The template Connect() methods below are safer and allow connecting
2975 // events to arbitrary functions or functors -- but require compiler
2976 // support for templates.
2978 // Dynamic association of a member function handler with the event handler,
2979 // winid and event type
2980 void Connect(int winid
,
2982 wxEventType eventType
,
2983 wxObjectEventFunction func
,
2984 wxObject
*userData
= NULL
,
2985 wxEvtHandler
*eventSink
= NULL
)
2987 DoBind(winid
, lastId
, eventType
,
2988 wxNewEventFunctor(eventType
, func
, eventSink
),
2992 // Convenience function: take just one id
2993 void Connect(int winid
,
2994 wxEventType eventType
,
2995 wxObjectEventFunction func
,
2996 wxObject
*userData
= NULL
,
2997 wxEvtHandler
*eventSink
= NULL
)
2998 { Connect(winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3000 // Even more convenient: without id (same as using id of wxID_ANY)
3001 void Connect(wxEventType eventType
,
3002 wxObjectEventFunction func
,
3003 wxObject
*userData
= NULL
,
3004 wxEvtHandler
*eventSink
= NULL
)
3005 { Connect(wxID_ANY
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3007 bool Disconnect(int winid
,
3009 wxEventType eventType
,
3010 wxObjectEventFunction func
= NULL
,
3011 wxObject
*userData
= NULL
,
3012 wxEvtHandler
*eventSink
= NULL
)
3014 return DoUnbind(winid
, lastId
, eventType
,
3015 wxMakeEventFunctor(eventType
, func
, eventSink
),
3019 bool Disconnect(int winid
= wxID_ANY
,
3020 wxEventType eventType
= wxEVT_NULL
,
3021 wxObjectEventFunction func
= NULL
,
3022 wxObject
*userData
= NULL
,
3023 wxEvtHandler
*eventSink
= NULL
)
3024 { return Disconnect(winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3026 bool Disconnect(wxEventType eventType
,
3027 wxObjectEventFunction func
,
3028 wxObject
*userData
= NULL
,
3029 wxEvtHandler
*eventSink
= NULL
)
3030 { return Disconnect(wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3032 #ifdef wxHAS_EVENT_BIND
3033 // Bind functions to an event:
3034 template <typename EventTag
, typename EventArg
>
3035 void Bind(const EventTag
& eventType
,
3036 void (*function
)(EventArg
&),
3037 int winid
= wxID_ANY
,
3038 int lastId
= wxID_ANY
,
3039 wxObject
*userData
= NULL
)
3041 DoBind(winid
, lastId
, eventType
,
3042 wxNewEventFunctor(eventType
, function
),
3047 template <typename EventTag
, typename EventArg
>
3048 bool Unbind(const EventTag
& eventType
,
3049 void (*function
)(EventArg
&),
3050 int winid
= wxID_ANY
,
3051 int lastId
= wxID_ANY
,
3052 wxObject
*userData
= NULL
)
3054 return DoUnbind(winid
, lastId
, eventType
,
3055 wxMakeEventFunctor(eventType
, function
),
3059 // Bind functors to an event:
3060 template <typename EventTag
, typename Functor
>
3061 void Bind(const EventTag
& eventType
,
3063 int winid
= wxID_ANY
,
3064 int lastId
= wxID_ANY
,
3065 wxObject
*userData
= NULL
)
3067 DoBind(winid
, lastId
, eventType
,
3068 wxNewEventFunctor(eventType
, functor
),
3073 template <typename EventTag
, typename Functor
>
3074 bool Unbind(const EventTag
& eventType
,
3076 int winid
= wxID_ANY
,
3077 int lastId
= wxID_ANY
,
3078 wxObject
*userData
= NULL
)
3080 return DoUnbind(winid
, lastId
, eventType
,
3081 wxMakeEventFunctor(eventType
, functor
),
3086 // Bind a method of a class (called on the specified handler which must
3087 // be convertible to this class) object to an event:
3089 template <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
3090 void Bind(const EventTag
&eventType
,
3091 void (Class::*method
)(EventArg
&),
3092 EventHandler
*handler
,
3093 int winid
= wxID_ANY
,
3094 int lastId
= wxID_ANY
,
3095 wxObject
*userData
= NULL
)
3097 DoBind(winid
, lastId
, eventType
,
3098 wxNewEventFunctor(eventType
, method
, handler
),
3102 template <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
3103 bool Unbind(const EventTag
&eventType
,
3104 void (Class::*method
)(EventArg
&),
3105 EventHandler
*handler
,
3106 int winid
= wxID_ANY
,
3107 int lastId
= wxID_ANY
,
3108 wxObject
*userData
= NULL
)
3110 return DoUnbind(winid
, lastId
, eventType
,
3111 wxMakeEventFunctor(eventType
, method
, handler
),
3114 #endif // wxHAS_EVENT_BIND
3116 wxList
* GetDynamicEventTable() const { return m_dynamicEvents
; }
3118 // User data can be associated with each wxEvtHandler
3119 void SetClientObject( wxClientData
*data
) { DoSetClientObject(data
); }
3120 wxClientData
*GetClientObject() const { return DoGetClientObject(); }
3122 void SetClientData( void *data
) { DoSetClientData(data
); }
3123 void *GetClientData() const { return DoGetClientData(); }
3126 // implementation from now on
3127 // --------------------------
3129 // check if the given event table entry matches this event by id (the check
3130 // for the event type should be done by caller) and call the handler if it
3133 // return true if the event was processed, false otherwise (no match or the
3134 // handler decided to skip the event)
3135 static bool ProcessEventIfMatchesId(const wxEventTableEntryBase
& tableEntry
,
3136 wxEvtHandler
*handler
,
3139 virtual bool SearchEventTable(wxEventTable
& table
, wxEvent
& event
);
3140 bool SearchDynamicEventTable( wxEvent
& event
);
3142 // Avoid problems at exit by cleaning up static hash table gracefully
3143 void ClearEventHashTable() { GetEventHashTable().Clear(); }
3144 void OnSinkDestroyed( wxEvtHandler
*sink
);
3147 // The method tries to process the event in this event handler.
3149 // It is meant to be called from ProcessEvent() only and is not virtual,
3150 // additional event handlers can be hooked into the normal event processing
3151 // logic using TryBefore() and TryAfter() hooks.
3152 bool ProcessEventHere(wxEvent
& event
);
3156 void DoBind(int winid
,
3158 wxEventType eventType
,
3159 wxEventFunctor
*func
,
3160 wxObject
* userData
= NULL
);
3162 bool DoUnbind(int winid
,
3164 wxEventType eventType
,
3165 const wxEventFunctor
& func
,
3166 wxObject
*userData
= NULL
);
3168 static const wxEventTableEntry sm_eventTableEntries
[];
3171 // hooks for wxWindow used by ProcessEvent()
3172 // -----------------------------------------
3174 // this one is called before trying our own event table to allow plugging
3175 // in the event handlers overriding the default logic, this is used by e.g.
3177 virtual bool TryBefore(wxEvent
& event
);
3179 // this one is called after failing to find the event handle in our own
3180 // table to give a chance to the other windows to process it
3182 // base class implementation passes the event to wxTheApp
3183 virtual bool TryAfter(wxEvent
& event
);
3185 #ifdef WXWIN_COMPATIBILITY_2_8
3186 // deprecated method: override TryBefore() instead of this one
3187 wxDEPRECATED_BUT_USED_INTERNALLY_INLINE(
3188 virtual bool TryValidator(wxEvent
& WXUNUSED(event
)), return false; )
3190 wxDEPRECATED_BUT_USED_INTERNALLY_INLINE(
3191 virtual bool TryParent(wxEvent
& event
), return DoTryApp(event
); )
3192 #endif // WXWIN_COMPATIBILITY_2_8
3195 static const wxEventTable sm_eventTable
;
3196 virtual const wxEventTable
*GetEventTable() const;
3198 static wxEventHashTable sm_eventHashTable
;
3199 virtual wxEventHashTable
& GetEventHashTable() const;
3201 wxEvtHandler
* m_nextHandler
;
3202 wxEvtHandler
* m_previousHandler
;
3203 wxList
* m_dynamicEvents
;
3204 wxList
* m_pendingEvents
;
3207 // critical section protecting m_pendingEvents
3208 wxCriticalSection m_pendingEventsLock
;
3209 #endif // wxUSE_THREADS
3211 // Is event handler enabled?
3215 // The user data: either an object which will be deleted by the container
3216 // when it's deleted or some raw pointer which we do nothing with - only
3217 // one type of data can be used with the given window (i.e. you cannot set
3218 // the void data and then associate the container with wxClientData or vice
3222 wxClientData
*m_clientObject
;
3226 // what kind of data do we have?
3227 wxClientDataType m_clientDataType
;
3229 // client data accessors
3230 virtual void DoSetClientObject( wxClientData
*data
);
3231 virtual wxClientData
*DoGetClientObject() const;
3233 virtual void DoSetClientData( void *data
);
3234 virtual void *DoGetClientData() const;
3236 // Search tracker objects for event connection with this sink
3237 wxEventConnectionRef
*FindRefInTrackerList(wxEvtHandler
*handler
);
3240 // pass the event to wxTheApp instance, called from TryAfter()
3241 bool DoTryApp(wxEvent
& event
);
3243 DECLARE_DYNAMIC_CLASS_NO_COPY(wxEvtHandler
)
3246 WX_DEFINE_ARRAY_WITH_DECL_PTR(wxEvtHandler
*, wxEvtHandlerArray
, class WXDLLIMPEXP_BASE
);
3248 // ----------------------------------------------------------------------------
3249 // wxEventConnectionRef represents all connections between two event handlers
3250 // and enables automatic disconnect when an event handler sink goes out of
3251 // scope. Each connection/disconnect increases/decreases ref count, and
3252 // when it reaches zero the node goes out of scope.
3253 // ----------------------------------------------------------------------------
3255 class wxEventConnectionRef
: public wxTrackerNode
3258 wxEventConnectionRef() : m_src(NULL
), m_sink(NULL
), m_refCount(0) { }
3259 wxEventConnectionRef(wxEvtHandler
*src
, wxEvtHandler
*sink
)
3260 : m_src(src
), m_sink(sink
), m_refCount(1)
3262 m_sink
->AddNode(this);
3265 // The sink is being destroyed
3266 virtual void OnObjectDestroy( )
3269 m_src
->OnSinkDestroyed( m_sink
);
3273 virtual wxEventConnectionRef
*ToEventConnection() { return this; }
3275 void IncRef() { m_refCount
++; }
3278 if ( !--m_refCount
)
3280 // The sink holds the only external pointer to this object
3282 m_sink
->RemoveNode(this);
3288 wxEvtHandler
*m_src
,
3292 friend class wxEvtHandler
;
3294 wxDECLARE_NO_ASSIGN_CLASS(wxEventConnectionRef
);
3297 // Post a message to the given event handler which will be processed during the
3298 // next event loop iteration.
3300 // Notice that this one is not thread-safe, use wxQueueEvent()
3301 inline void wxPostEvent(wxEvtHandler
*dest
, const wxEvent
& event
)
3303 wxCHECK_RET( dest
, "need an object to post event to" );
3305 dest
->AddPendingEvent(event
);
3308 // Wrapper around wxEvtHandler::QueueEvent(): adds an event for later
3309 // processing, unlike wxPostEvent it is safe to use from different thread even
3310 // for events with wxString members
3311 inline void wxQueueEvent(wxEvtHandler
*dest
, wxEvent
*event
)
3313 wxCHECK_RET( dest
, "need an object to queue event for" );
3315 dest
->QueueEvent(event
);
3318 typedef void (wxEvtHandler::*wxEventFunction
)(wxEvent
&);
3319 typedef void (wxEvtHandler::*wxIdleEventFunction
)(wxIdleEvent
&);
3321 #define wxEventHandler(func) \
3322 wxEVENT_HANDLER_CAST(wxEventFunction, func)
3323 #define wxIdleEventHandler(func) \
3324 wxEVENT_HANDLER_CAST(wxIdleEventFunction, func)
3328 // ----------------------------------------------------------------------------
3329 // wxEventBlocker: helper class to temporarily disable event handling for a window
3330 // ----------------------------------------------------------------------------
3332 class WXDLLIMPEXP_CORE wxEventBlocker
: public wxEvtHandler
3335 wxEventBlocker(wxWindow
*win
, wxEventType type
= wxEVT_ANY
);
3336 virtual ~wxEventBlocker();
3338 void Block(wxEventType type
)
3340 m_eventsToBlock
.push_back(type
);
3343 virtual bool ProcessEvent(wxEvent
& event
);
3346 wxArrayInt m_eventsToBlock
;
3349 wxDECLARE_NO_COPY_CLASS(wxEventBlocker
);
3352 typedef void (wxEvtHandler::*wxCommandEventFunction
)(wxCommandEvent
&);
3353 typedef void (wxEvtHandler::*wxThreadEventFunction
)(wxThreadEvent
&);
3354 typedef void (wxEvtHandler::*wxScrollEventFunction
)(wxScrollEvent
&);
3355 typedef void (wxEvtHandler::*wxScrollWinEventFunction
)(wxScrollWinEvent
&);
3356 typedef void (wxEvtHandler::*wxSizeEventFunction
)(wxSizeEvent
&);
3357 typedef void (wxEvtHandler::*wxMoveEventFunction
)(wxMoveEvent
&);
3358 typedef void (wxEvtHandler::*wxPaintEventFunction
)(wxPaintEvent
&);
3359 typedef void (wxEvtHandler::*wxNcPaintEventFunction
)(wxNcPaintEvent
&);
3360 typedef void (wxEvtHandler::*wxEraseEventFunction
)(wxEraseEvent
&);
3361 typedef void (wxEvtHandler::*wxMouseEventFunction
)(wxMouseEvent
&);
3362 typedef void (wxEvtHandler::*wxCharEventFunction
)(wxKeyEvent
&);
3363 typedef void (wxEvtHandler::*wxFocusEventFunction
)(wxFocusEvent
&);
3364 typedef void (wxEvtHandler::*wxChildFocusEventFunction
)(wxChildFocusEvent
&);
3365 typedef void (wxEvtHandler::*wxActivateEventFunction
)(wxActivateEvent
&);
3366 typedef void (wxEvtHandler::*wxMenuEventFunction
)(wxMenuEvent
&);
3367 typedef void (wxEvtHandler::*wxJoystickEventFunction
)(wxJoystickEvent
&);
3368 typedef void (wxEvtHandler::*wxDropFilesEventFunction
)(wxDropFilesEvent
&);
3369 typedef void (wxEvtHandler::*wxInitDialogEventFunction
)(wxInitDialogEvent
&);
3370 typedef void (wxEvtHandler::*wxSysColourChangedEventFunction
)(wxSysColourChangedEvent
&);
3371 typedef void (wxEvtHandler::*wxDisplayChangedEventFunction
)(wxDisplayChangedEvent
&);
3372 typedef void (wxEvtHandler::*wxUpdateUIEventFunction
)(wxUpdateUIEvent
&);
3373 typedef void (wxEvtHandler::*wxCloseEventFunction
)(wxCloseEvent
&);
3374 typedef void (wxEvtHandler::*wxShowEventFunction
)(wxShowEvent
&);
3375 typedef void (wxEvtHandler::*wxIconizeEventFunction
)(wxIconizeEvent
&);
3376 typedef void (wxEvtHandler::*wxMaximizeEventFunction
)(wxMaximizeEvent
&);
3377 typedef void (wxEvtHandler::*wxNavigationKeyEventFunction
)(wxNavigationKeyEvent
&);
3378 typedef void (wxEvtHandler::*wxPaletteChangedEventFunction
)(wxPaletteChangedEvent
&);
3379 typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction
)(wxQueryNewPaletteEvent
&);
3380 typedef void (wxEvtHandler::*wxWindowCreateEventFunction
)(wxWindowCreateEvent
&);
3381 typedef void (wxEvtHandler::*wxWindowDestroyEventFunction
)(wxWindowDestroyEvent
&);
3382 typedef void (wxEvtHandler::*wxSetCursorEventFunction
)(wxSetCursorEvent
&);
3383 typedef void (wxEvtHandler::*wxNotifyEventFunction
)(wxNotifyEvent
&);
3384 typedef void (wxEvtHandler::*wxHelpEventFunction
)(wxHelpEvent
&);
3385 typedef void (wxEvtHandler::*wxContextMenuEventFunction
)(wxContextMenuEvent
&);
3386 typedef void (wxEvtHandler::*wxMouseCaptureChangedEventFunction
)(wxMouseCaptureChangedEvent
&);
3387 typedef void (wxEvtHandler::*wxMouseCaptureLostEventFunction
)(wxMouseCaptureLostEvent
&);
3388 typedef void (wxEvtHandler::*wxClipboardTextEventFunction
)(wxClipboardTextEvent
&);
3391 #define wxCommandEventHandler(func) \
3392 wxEVENT_HANDLER_CAST(wxCommandEventFunction, func)
3393 #define wxThreadEventHandler(func) \
3394 wxEVENT_HANDLER_CAST(wxThreadEventFunction, func)
3395 #define wxScrollEventHandler(func) \
3396 wxEVENT_HANDLER_CAST(wxScrollEventFunction, func)
3397 #define wxScrollWinEventHandler(func) \
3398 wxEVENT_HANDLER_CAST(wxScrollWinEventFunction, func)
3399 #define wxSizeEventHandler(func) \
3400 wxEVENT_HANDLER_CAST(wxSizeEventFunction, func)
3401 #define wxMoveEventHandler(func) \
3402 wxEVENT_HANDLER_CAST(wxMoveEventFunction, func)
3403 #define wxPaintEventHandler(func) \
3404 wxEVENT_HANDLER_CAST(wxPaintEventFunction, func)
3405 #define wxNcPaintEventHandler(func) \
3406 wxEVENT_HANDLER_CAST(wxNcPaintEventFunction, func)
3407 #define wxEraseEventHandler(func) \
3408 wxEVENT_HANDLER_CAST(wxEraseEventFunction, func)
3409 #define wxMouseEventHandler(func) \
3410 wxEVENT_HANDLER_CAST(wxMouseEventFunction, func)
3411 #define wxCharEventHandler(func) \
3412 wxEVENT_HANDLER_CAST(wxCharEventFunction, func)
3413 #define wxKeyEventHandler(func) wxCharEventHandler(func)
3414 #define wxFocusEventHandler(func) \
3415 wxEVENT_HANDLER_CAST(wxFocusEventFunction, func)
3416 #define wxChildFocusEventHandler(func) \
3417 wxEVENT_HANDLER_CAST(wxChildFocusEventFunction, func)
3418 #define wxActivateEventHandler(func) \
3419 wxEVENT_HANDLER_CAST(wxActivateEventFunction, func)
3420 #define wxMenuEventHandler(func) \
3421 wxEVENT_HANDLER_CAST(wxMenuEventFunction, func)
3422 #define wxJoystickEventHandler(func) \
3423 wxEVENT_HANDLER_CAST(wxJoystickEventFunction, func)
3424 #define wxDropFilesEventHandler(func) \
3425 wxEVENT_HANDLER_CAST(wxDropFilesEventFunction, func)
3426 #define wxInitDialogEventHandler(func) \
3427 wxEVENT_HANDLER_CAST(wxInitDialogEventFunction, func)
3428 #define wxSysColourChangedEventHandler(func) \
3429 wxEVENT_HANDLER_CAST(wxSysColourChangedEventFunction, func)
3430 #define wxDisplayChangedEventHandler(func) \
3431 wxEVENT_HANDLER_CAST(wxDisplayChangedEventFunction, func)
3432 #define wxUpdateUIEventHandler(func) \
3433 wxEVENT_HANDLER_CAST(wxUpdateUIEventFunction, func)
3434 #define wxCloseEventHandler(func) \
3435 wxEVENT_HANDLER_CAST(wxCloseEventFunction, func)
3436 #define wxShowEventHandler(func) \
3437 wxEVENT_HANDLER_CAST(wxShowEventFunction, func)
3438 #define wxIconizeEventHandler(func) \
3439 wxEVENT_HANDLER_CAST(wxIconizeEventFunction, func)
3440 #define wxMaximizeEventHandler(func) \
3441 wxEVENT_HANDLER_CAST(wxMaximizeEventFunction, func)
3442 #define wxNavigationKeyEventHandler(func) \
3443 wxEVENT_HANDLER_CAST(wxNavigationKeyEventFunction, func)
3444 #define wxPaletteChangedEventHandler(func) \
3445 wxEVENT_HANDLER_CAST(wxPaletteChangedEventFunction, func)
3446 #define wxQueryNewPaletteEventHandler(func) \
3447 wxEVENT_HANDLER_CAST(wxQueryNewPaletteEventFunction, func)
3448 #define wxWindowCreateEventHandler(func) \
3449 wxEVENT_HANDLER_CAST(wxWindowCreateEventFunction, func)
3450 #define wxWindowDestroyEventHandler(func) \
3451 wxEVENT_HANDLER_CAST(wxWindowDestroyEventFunction, func)
3452 #define wxSetCursorEventHandler(func) \
3453 wxEVENT_HANDLER_CAST(wxSetCursorEventFunction, func)
3454 #define wxNotifyEventHandler(func) \
3455 wxEVENT_HANDLER_CAST(wxNotifyEventFunction, func)
3456 #define wxHelpEventHandler(func) \
3457 wxEVENT_HANDLER_CAST(wxHelpEventFunction, func)
3458 #define wxContextMenuEventHandler(func) \
3459 wxEVENT_HANDLER_CAST(wxContextMenuEventFunction, func)
3460 #define wxMouseCaptureChangedEventHandler(func) \
3461 wxEVENT_HANDLER_CAST(wxMouseCaptureChangedEventFunction, func)
3462 #define wxMouseCaptureLostEventHandler(func) \
3463 wxEVENT_HANDLER_CAST(wxMouseCaptureLostEventFunction, func)
3464 #define wxClipboardTextEventHandler(func) \
3465 wxEVENT_HANDLER_CAST(wxClipboardTextEventFunction, func)
3469 // N.B. In GNU-WIN32, you *have* to take the address of a member function
3470 // (use &) or the compiler crashes...
3472 #define DECLARE_EVENT_TABLE() \
3474 static const wxEventTableEntry sm_eventTableEntries[]; \
3476 static const wxEventTable sm_eventTable; \
3477 virtual const wxEventTable* GetEventTable() const; \
3478 static wxEventHashTable sm_eventHashTable; \
3479 virtual wxEventHashTable& GetEventHashTable() const;
3481 // N.B.: when building DLL with Borland C++ 5.5 compiler, you must initialize
3482 // sm_eventTable before using it in GetEventTable() or the compiler gives
3483 // E2233 (see http://groups.google.com/groups?selm=397dcc8a%241_2%40dnews)
3485 #define BEGIN_EVENT_TABLE(theClass, baseClass) \
3486 const wxEventTable theClass::sm_eventTable = \
3487 { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] }; \
3488 const wxEventTable *theClass::GetEventTable() const \
3489 { return &theClass::sm_eventTable; } \
3490 wxEventHashTable theClass::sm_eventHashTable(theClass::sm_eventTable); \
3491 wxEventHashTable &theClass::GetEventHashTable() const \
3492 { return theClass::sm_eventHashTable; } \
3493 const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
3495 #define BEGIN_EVENT_TABLE_TEMPLATE1(theClass, baseClass, T1) \
3496 template<typename T1> \
3497 const wxEventTable theClass<T1>::sm_eventTable = \
3498 { &baseClass::sm_eventTable, &theClass<T1>::sm_eventTableEntries[0] }; \
3499 template<typename T1> \
3500 const wxEventTable *theClass<T1>::GetEventTable() const \
3501 { return &theClass<T1>::sm_eventTable; } \
3502 template<typename T1> \
3503 wxEventHashTable theClass<T1>::sm_eventHashTable(theClass<T1>::sm_eventTable); \
3504 template<typename T1> \
3505 wxEventHashTable &theClass<T1>::GetEventHashTable() const \
3506 { return theClass<T1>::sm_eventHashTable; } \
3507 template<typename T1> \
3508 const wxEventTableEntry theClass<T1>::sm_eventTableEntries[] = { \
3510 #define BEGIN_EVENT_TABLE_TEMPLATE2(theClass, baseClass, T1, T2) \
3511 template<typename T1, typename T2> \
3512 const wxEventTable theClass<T1, T2>::sm_eventTable = \
3513 { &baseClass::sm_eventTable, &theClass<T1, T2>::sm_eventTableEntries[0] }; \
3514 template<typename T1, typename T2> \
3515 const wxEventTable *theClass<T1, T2>::GetEventTable() const \
3516 { return &theClass<T1, T2>::sm_eventTable; } \
3517 template<typename T1, typename T2> \
3518 wxEventHashTable theClass<T1, T2>::sm_eventHashTable(theClass<T1, T2>::sm_eventTable); \
3519 template<typename T1, typename T2> \
3520 wxEventHashTable &theClass<T1, T2>::GetEventHashTable() const \
3521 { return theClass<T1, T2>::sm_eventHashTable; } \
3522 template<typename T1, typename T2> \
3523 const wxEventTableEntry theClass<T1, T2>::sm_eventTableEntries[] = { \
3525 #define BEGIN_EVENT_TABLE_TEMPLATE3(theClass, baseClass, T1, T2, T3) \
3526 template<typename T1, typename T2, typename T3> \
3527 const wxEventTable theClass<T1, T2, T3>::sm_eventTable = \
3528 { &baseClass::sm_eventTable, &theClass<T1, T2, T3>::sm_eventTableEntries[0] }; \
3529 template<typename T1, typename T2, typename T3> \
3530 const wxEventTable *theClass<T1, T2, T3>::GetEventTable() const \
3531 { return &theClass<T1, T2, T3>::sm_eventTable; } \
3532 template<typename T1, typename T2, typename T3> \
3533 wxEventHashTable theClass<T1, T2, T3>::sm_eventHashTable(theClass<T1, T2, T3>::sm_eventTable); \
3534 template<typename T1, typename T2, typename T3> \
3535 wxEventHashTable &theClass<T1, T2, T3>::GetEventHashTable() const \
3536 { return theClass<T1, T2, T3>::sm_eventHashTable; } \
3537 template<typename T1, typename T2, typename T3> \
3538 const wxEventTableEntry theClass<T1, T2, T3>::sm_eventTableEntries[] = { \
3540 #define BEGIN_EVENT_TABLE_TEMPLATE4(theClass, baseClass, T1, T2, T3, T4) \
3541 template<typename T1, typename T2, typename T3, typename T4> \
3542 const wxEventTable theClass<T1, T2, T3, T4>::sm_eventTable = \
3543 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4>::sm_eventTableEntries[0] }; \
3544 template<typename T1, typename T2, typename T3, typename T4> \
3545 const wxEventTable *theClass<T1, T2, T3, T4>::GetEventTable() const \
3546 { return &theClass<T1, T2, T3, T4>::sm_eventTable; } \
3547 template<typename T1, typename T2, typename T3, typename T4> \
3548 wxEventHashTable theClass<T1, T2, T3, T4>::sm_eventHashTable(theClass<T1, T2, T3, T4>::sm_eventTable); \
3549 template<typename T1, typename T2, typename T3, typename T4> \
3550 wxEventHashTable &theClass<T1, T2, T3, T4>::GetEventHashTable() const \
3551 { return theClass<T1, T2, T3, T4>::sm_eventHashTable; } \
3552 template<typename T1, typename T2, typename T3, typename T4> \
3553 const wxEventTableEntry theClass<T1, T2, T3, T4>::sm_eventTableEntries[] = { \
3555 #define BEGIN_EVENT_TABLE_TEMPLATE5(theClass, baseClass, T1, T2, T3, T4, T5) \
3556 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3557 const wxEventTable theClass<T1, T2, T3, T4, T5>::sm_eventTable = \
3558 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[0] }; \
3559 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3560 const wxEventTable *theClass<T1, T2, T3, T4, T5>::GetEventTable() const \
3561 { return &theClass<T1, T2, T3, T4, T5>::sm_eventTable; } \
3562 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3563 wxEventHashTable theClass<T1, T2, T3, T4, T5>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5>::sm_eventTable); \
3564 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3565 wxEventHashTable &theClass<T1, T2, T3, T4, T5>::GetEventHashTable() const \
3566 { return theClass<T1, T2, T3, T4, T5>::sm_eventHashTable; } \
3567 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3568 const wxEventTableEntry theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[] = { \
3570 #define BEGIN_EVENT_TABLE_TEMPLATE7(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7) \
3571 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3572 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable = \
3573 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[0] }; \
3574 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3575 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventTable() const \
3576 { return &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable; } \
3577 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3578 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable); \
3579 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3580 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventHashTable() const \
3581 { return theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable; } \
3582 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3583 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[] = { \
3585 #define BEGIN_EVENT_TABLE_TEMPLATE8(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7, T8) \
3586 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3587 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable = \
3588 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[0] }; \
3589 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3590 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventTable() const \
3591 { return &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable; } \
3592 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3593 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable); \
3594 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3595 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventHashTable() const \
3596 { return theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable; } \
3597 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3598 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[] = { \
3600 #define END_EVENT_TABLE() DECLARE_EVENT_TABLE_TERMINATOR() };
3603 * Event table macros
3606 // helpers for writing shorter code below: declare an event macro taking 2, 1
3607 // or none ids (the missing ids default to wxID_ANY)
3610 // - evt one of wxEVT_XXX constants
3611 // - id1, id2 ids of the first/last id
3612 // - fn the function (should be cast to the right type)
3613 #define wx__DECLARE_EVT2(evt, id1, id2, fn) \
3614 DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
3615 #define wx__DECLARE_EVT1(evt, id, fn) \
3616 wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
3617 #define wx__DECLARE_EVT0(evt, fn) \
3618 wx__DECLARE_EVT1(evt, wxID_ANY, fn)
3622 #define EVT_CUSTOM(event, winid, func) \
3623 wx__DECLARE_EVT1(event, winid, wxEventHandler(func))
3624 #define EVT_CUSTOM_RANGE(event, id1, id2, func) \
3625 wx__DECLARE_EVT2(event, id1, id2, wxEventHandler(func))
3628 #define EVT_COMMAND(winid, event, func) \
3629 wx__DECLARE_EVT1(event, winid, wxCommandEventHandler(func))
3631 #define EVT_COMMAND_RANGE(id1, id2, event, func) \
3632 wx__DECLARE_EVT2(event, id1, id2, wxCommandEventHandler(func))
3634 #define EVT_NOTIFY(event, winid, func) \
3635 wx__DECLARE_EVT1(event, winid, wxNotifyEventHandler(func))
3637 #define EVT_NOTIFY_RANGE(event, id1, id2, func) \
3638 wx__DECLARE_EVT2(event, id1, id2, wxNotifyEventHandler(func))
3641 #define EVT_SIZE(func) wx__DECLARE_EVT0(wxEVT_SIZE, wxSizeEventHandler(func))
3642 #define EVT_SIZING(func) wx__DECLARE_EVT0(wxEVT_SIZING, wxSizeEventHandler(func))
3643 #define EVT_MOVE(func) wx__DECLARE_EVT0(wxEVT_MOVE, wxMoveEventHandler(func))
3644 #define EVT_MOVING(func) wx__DECLARE_EVT0(wxEVT_MOVING, wxMoveEventHandler(func))
3645 #define EVT_MOVE_START(func) wx__DECLARE_EVT0(wxEVT_MOVE_START, wxMoveEventHandler(func))
3646 #define EVT_MOVE_END(func) wx__DECLARE_EVT0(wxEVT_MOVE_END, wxMoveEventHandler(func))
3647 #define EVT_CLOSE(func) wx__DECLARE_EVT0(wxEVT_CLOSE_WINDOW, wxCloseEventHandler(func))
3648 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3649 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3650 #define EVT_PAINT(func) wx__DECLARE_EVT0(wxEVT_PAINT, wxPaintEventHandler(func))
3651 #define EVT_NC_PAINT(func) wx__DECLARE_EVT0(wxEVT_NC_PAINT, wxNcPaintEventHandler(func))
3652 #define EVT_ERASE_BACKGROUND(func) wx__DECLARE_EVT0(wxEVT_ERASE_BACKGROUND, wxEraseEventHandler(func))
3653 #define EVT_CHAR(func) wx__DECLARE_EVT0(wxEVT_CHAR, wxCharEventHandler(func))
3654 #define EVT_KEY_DOWN(func) wx__DECLARE_EVT0(wxEVT_KEY_DOWN, wxKeyEventHandler(func))
3655 #define EVT_KEY_UP(func) wx__DECLARE_EVT0(wxEVT_KEY_UP, wxKeyEventHandler(func))
3657 #define EVT_HOTKEY(winid, func) wx__DECLARE_EVT1(wxEVT_HOTKEY, winid, wxCharEventHandler(func))
3659 #define EVT_CHAR_HOOK(func) wx__DECLARE_EVT0(wxEVT_CHAR_HOOK, wxCharEventHandler(func))
3660 #define EVT_MENU_OPEN(func) wx__DECLARE_EVT0(wxEVT_MENU_OPEN, wxMenuEventHandler(func))
3661 #define EVT_MENU_CLOSE(func) wx__DECLARE_EVT0(wxEVT_MENU_CLOSE, wxMenuEventHandler(func))
3662 #define EVT_MENU_HIGHLIGHT(winid, func) wx__DECLARE_EVT1(wxEVT_MENU_HIGHLIGHT, winid, wxMenuEventHandler(func))
3663 #define EVT_MENU_HIGHLIGHT_ALL(func) wx__DECLARE_EVT0(wxEVT_MENU_HIGHLIGHT, wxMenuEventHandler(func))
3664 #define EVT_SET_FOCUS(func) wx__DECLARE_EVT0(wxEVT_SET_FOCUS, wxFocusEventHandler(func))
3665 #define EVT_KILL_FOCUS(func) wx__DECLARE_EVT0(wxEVT_KILL_FOCUS, wxFocusEventHandler(func))
3666 #define EVT_CHILD_FOCUS(func) wx__DECLARE_EVT0(wxEVT_CHILD_FOCUS, wxChildFocusEventHandler(func))
3667 #define EVT_ACTIVATE(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE, wxActivateEventHandler(func))
3668 #define EVT_ACTIVATE_APP(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE_APP, wxActivateEventHandler(func))
3669 #define EVT_HIBERNATE(func) wx__DECLARE_EVT0(wxEVT_HIBERNATE, wxActivateEventHandler(func))
3670 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3671 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3672 #define EVT_DROP_FILES(func) wx__DECLARE_EVT0(wxEVT_DROP_FILES, wxDropFilesEventHandler(func))
3673 #define EVT_INIT_DIALOG(func) wx__DECLARE_EVT0(wxEVT_INIT_DIALOG, wxInitDialogEventHandler(func))
3674 #define EVT_SYS_COLOUR_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEventHandler(func))
3675 #define EVT_DISPLAY_CHANGED(func) wx__DECLARE_EVT0(wxEVT_DISPLAY_CHANGED, wxDisplayChangedEventHandler(func))
3676 #define EVT_SHOW(func) wx__DECLARE_EVT0(wxEVT_SHOW, wxShowEventHandler(func))
3677 #define EVT_MAXIMIZE(func) wx__DECLARE_EVT0(wxEVT_MAXIMIZE, wxMaximizeEventHandler(func))
3678 #define EVT_ICONIZE(func) wx__DECLARE_EVT0(wxEVT_ICONIZE, wxIconizeEventHandler(func))
3679 #define EVT_NAVIGATION_KEY(func) wx__DECLARE_EVT0(wxEVT_NAVIGATION_KEY, wxNavigationKeyEventHandler(func))
3680 #define EVT_PALETTE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_PALETTE_CHANGED, wxPaletteChangedEventHandler(func))
3681 #define EVT_QUERY_NEW_PALETTE(func) wx__DECLARE_EVT0(wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEventHandler(func))
3682 #define EVT_WINDOW_CREATE(func) wx__DECLARE_EVT0(wxEVT_CREATE, wxWindowCreateEventHandler(func))
3683 #define EVT_WINDOW_DESTROY(func) wx__DECLARE_EVT0(wxEVT_DESTROY, wxWindowDestroyEventHandler(func))
3684 #define EVT_SET_CURSOR(func) wx__DECLARE_EVT0(wxEVT_SET_CURSOR, wxSetCursorEventHandler(func))
3685 #define EVT_MOUSE_CAPTURE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEventHandler(func))
3686 #define EVT_MOUSE_CAPTURE_LOST(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEventHandler(func))
3689 #define EVT_LEFT_DOWN(func) wx__DECLARE_EVT0(wxEVT_LEFT_DOWN, wxMouseEventHandler(func))
3690 #define EVT_LEFT_UP(func) wx__DECLARE_EVT0(wxEVT_LEFT_UP, wxMouseEventHandler(func))
3691 #define EVT_MIDDLE_DOWN(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DOWN, wxMouseEventHandler(func))
3692 #define EVT_MIDDLE_UP(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_UP, wxMouseEventHandler(func))
3693 #define EVT_RIGHT_DOWN(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DOWN, wxMouseEventHandler(func))
3694 #define EVT_RIGHT_UP(func) wx__DECLARE_EVT0(wxEVT_RIGHT_UP, wxMouseEventHandler(func))
3695 #define EVT_MOTION(func) wx__DECLARE_EVT0(wxEVT_MOTION, wxMouseEventHandler(func))
3696 #define EVT_LEFT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_LEFT_DCLICK, wxMouseEventHandler(func))
3697 #define EVT_MIDDLE_DCLICK(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DCLICK, wxMouseEventHandler(func))
3698 #define EVT_RIGHT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DCLICK, wxMouseEventHandler(func))
3699 #define EVT_LEAVE_WINDOW(func) wx__DECLARE_EVT0(wxEVT_LEAVE_WINDOW, wxMouseEventHandler(func))
3700 #define EVT_ENTER_WINDOW(func) wx__DECLARE_EVT0(wxEVT_ENTER_WINDOW, wxMouseEventHandler(func))
3701 #define EVT_MOUSEWHEEL(func) wx__DECLARE_EVT0(wxEVT_MOUSEWHEEL, wxMouseEventHandler(func))
3702 #define EVT_MOUSE_AUX1_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX1_DOWN, wxMouseEventHandler(func))
3703 #define EVT_MOUSE_AUX1_UP(func) wx__DECLARE_EVT0(wxEVT_AUX1_UP, wxMouseEventHandler(func))
3704 #define EVT_MOUSE_AUX1_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX1_DCLICK, wxMouseEventHandler(func))
3705 #define EVT_MOUSE_AUX2_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX2_DOWN, wxMouseEventHandler(func))
3706 #define EVT_MOUSE_AUX2_UP(func) wx__DECLARE_EVT0(wxEVT_AUX2_UP, wxMouseEventHandler(func))
3707 #define EVT_MOUSE_AUX2_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX2_DCLICK, wxMouseEventHandler(func))
3710 #define EVT_MOUSE_EVENTS(func) \
3711 EVT_LEFT_DOWN(func) \
3713 EVT_LEFT_DCLICK(func) \
3714 EVT_MIDDLE_DOWN(func) \
3715 EVT_MIDDLE_UP(func) \
3716 EVT_MIDDLE_DCLICK(func) \
3717 EVT_RIGHT_DOWN(func) \
3718 EVT_RIGHT_UP(func) \
3719 EVT_RIGHT_DCLICK(func) \
3720 EVT_MOUSE_AUX1_DOWN(func) \
3721 EVT_MOUSE_AUX1_UP(func) \
3722 EVT_MOUSE_AUX1_DCLICK(func) \
3723 EVT_MOUSE_AUX2_DOWN(func) \
3724 EVT_MOUSE_AUX2_UP(func) \
3725 EVT_MOUSE_AUX2_DCLICK(func) \
3727 EVT_LEAVE_WINDOW(func) \
3728 EVT_ENTER_WINDOW(func) \
3729 EVT_MOUSEWHEEL(func)
3731 // Scrolling from wxWindow (sent to wxScrolledWindow)
3732 #define EVT_SCROLLWIN_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_TOP, wxScrollWinEventHandler(func))
3733 #define EVT_SCROLLWIN_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEventHandler(func))
3734 #define EVT_SCROLLWIN_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEUP, wxScrollWinEventHandler(func))
3735 #define EVT_SCROLLWIN_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEventHandler(func))
3736 #define EVT_SCROLLWIN_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEventHandler(func))
3737 #define EVT_SCROLLWIN_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEventHandler(func))
3738 #define EVT_SCROLLWIN_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEventHandler(func))
3739 #define EVT_SCROLLWIN_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEventHandler(func))
3741 #define EVT_SCROLLWIN(func) \
3742 EVT_SCROLLWIN_TOP(func) \
3743 EVT_SCROLLWIN_BOTTOM(func) \
3744 EVT_SCROLLWIN_LINEUP(func) \
3745 EVT_SCROLLWIN_LINEDOWN(func) \
3746 EVT_SCROLLWIN_PAGEUP(func) \
3747 EVT_SCROLLWIN_PAGEDOWN(func) \
3748 EVT_SCROLLWIN_THUMBTRACK(func) \
3749 EVT_SCROLLWIN_THUMBRELEASE(func)
3751 // Scrolling from wxSlider and wxScrollBar
3752 #define EVT_SCROLL_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_TOP, wxScrollEventHandler(func))
3753 #define EVT_SCROLL_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLL_BOTTOM, wxScrollEventHandler(func))
3754 #define EVT_SCROLL_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEUP, wxScrollEventHandler(func))
3755 #define EVT_SCROLL_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEDOWN, wxScrollEventHandler(func))
3756 #define EVT_SCROLL_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEUP, wxScrollEventHandler(func))
3757 #define EVT_SCROLL_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler(func))
3758 #define EVT_SCROLL_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler(func))
3759 #define EVT_SCROLL_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBRELEASE, wxScrollEventHandler(func))
3760 #define EVT_SCROLL_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SCROLL_CHANGED, wxScrollEventHandler(func))
3762 #define EVT_SCROLL(func) \
3763 EVT_SCROLL_TOP(func) \
3764 EVT_SCROLL_BOTTOM(func) \
3765 EVT_SCROLL_LINEUP(func) \
3766 EVT_SCROLL_LINEDOWN(func) \
3767 EVT_SCROLL_PAGEUP(func) \
3768 EVT_SCROLL_PAGEDOWN(func) \
3769 EVT_SCROLL_THUMBTRACK(func) \
3770 EVT_SCROLL_THUMBRELEASE(func) \
3771 EVT_SCROLL_CHANGED(func)
3773 // Scrolling from wxSlider and wxScrollBar, with an id
3774 #define EVT_COMMAND_SCROLL_TOP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_TOP, winid, wxScrollEventHandler(func))
3775 #define EVT_COMMAND_SCROLL_BOTTOM(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_BOTTOM, winid, wxScrollEventHandler(func))
3776 #define EVT_COMMAND_SCROLL_LINEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEUP, winid, wxScrollEventHandler(func))
3777 #define EVT_COMMAND_SCROLL_LINEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEDOWN, winid, wxScrollEventHandler(func))
3778 #define EVT_COMMAND_SCROLL_PAGEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEUP, winid, wxScrollEventHandler(func))
3779 #define EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEDOWN, winid, wxScrollEventHandler(func))
3780 #define EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBTRACK, winid, wxScrollEventHandler(func))
3781 #define EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBRELEASE, winid, wxScrollEventHandler(func))
3782 #define EVT_COMMAND_SCROLL_CHANGED(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_CHANGED, winid, wxScrollEventHandler(func))
3784 #define EVT_COMMAND_SCROLL(winid, func) \
3785 EVT_COMMAND_SCROLL_TOP(winid, func) \
3786 EVT_COMMAND_SCROLL_BOTTOM(winid, func) \
3787 EVT_COMMAND_SCROLL_LINEUP(winid, func) \
3788 EVT_COMMAND_SCROLL_LINEDOWN(winid, func) \
3789 EVT_COMMAND_SCROLL_PAGEUP(winid, func) \
3790 EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) \
3791 EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) \
3792 EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) \
3793 EVT_COMMAND_SCROLL_CHANGED(winid, func)
3795 #if WXWIN_COMPATIBILITY_2_6
3796 // compatibility macros for the old name, deprecated in 2.8
3797 #define wxEVT_SCROLL_ENDSCROLL wxEVT_SCROLL_CHANGED
3798 #define EVT_COMMAND_SCROLL_ENDSCROLL EVT_COMMAND_SCROLL_CHANGED
3799 #define EVT_SCROLL_ENDSCROLL EVT_SCROLL_CHANGED
3800 #endif // WXWIN_COMPATIBILITY_2_6
3802 // Convenience macros for commonly-used commands
3803 #define EVT_CHECKBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKBOX_CLICKED, winid, wxCommandEventHandler(func))
3804 #define EVT_CHOICE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHOICE_SELECTED, winid, wxCommandEventHandler(func))
3805 #define EVT_LISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_SELECTED, winid, wxCommandEventHandler(func))
3806 #define EVT_LISTBOX_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, winid, wxCommandEventHandler(func))
3807 #define EVT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_MENU_SELECTED, winid, wxCommandEventHandler(func))
3808 #define EVT_MENU_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_MENU_SELECTED, id1, id2, wxCommandEventHandler(func))
3809 #if defined(__SMARTPHONE__)
3810 # define EVT_BUTTON(winid, func) EVT_MENU(winid, func)
3812 # define EVT_BUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_BUTTON_CLICKED, winid, wxCommandEventHandler(func))
3814 #define EVT_SLIDER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SLIDER_UPDATED, winid, wxCommandEventHandler(func))
3815 #define EVT_RADIOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBOX_SELECTED, winid, wxCommandEventHandler(func))
3816 #define EVT_RADIOBUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBUTTON_SELECTED, winid, wxCommandEventHandler(func))
3817 // EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events
3818 #define EVT_SCROLLBAR(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SCROLLBAR_UPDATED, winid, wxCommandEventHandler(func))
3819 #define EVT_VLBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_VLBOX_SELECTED, winid, wxCommandEventHandler(func))
3820 #define EVT_COMBOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_SELECTED, winid, wxCommandEventHandler(func))
3821 #define EVT_TOOL(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_CLICKED, winid, wxCommandEventHandler(func))
3822 #define EVT_TOOL_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, winid, wxCommandEventHandler(func))
3823 #define EVT_TOOL_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_CLICKED, id1, id2, wxCommandEventHandler(func))
3824 #define EVT_TOOL_RCLICKED(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_RCLICKED, winid, wxCommandEventHandler(func))
3825 #define EVT_TOOL_RCLICKED_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, wxCommandEventHandler(func))
3826 #define EVT_TOOL_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_ENTER, winid, wxCommandEventHandler(func))
3827 #define EVT_CHECKLISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, winid, wxCommandEventHandler(func))
3828 #define EVT_COMBOBOX_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_DROPDOWN, winid, wxCommandEventHandler(func))
3829 #define EVT_COMBOBOX_CLOSEUP(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_CLOSEUP, winid, wxCommandEventHandler(func))
3831 // Generic command events
3832 #define EVT_COMMAND_LEFT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_CLICK, winid, wxCommandEventHandler(func))
3833 #define EVT_COMMAND_LEFT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_DCLICK, winid, wxCommandEventHandler(func))
3834 #define EVT_COMMAND_RIGHT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_CLICK, winid, wxCommandEventHandler(func))
3835 #define EVT_COMMAND_RIGHT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_DCLICK, winid, wxCommandEventHandler(func))
3836 #define EVT_COMMAND_SET_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SET_FOCUS, winid, wxCommandEventHandler(func))
3837 #define EVT_COMMAND_KILL_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_KILL_FOCUS, winid, wxCommandEventHandler(func))
3838 #define EVT_COMMAND_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_ENTER, winid, wxCommandEventHandler(func))
3842 #define EVT_JOY_BUTTON_DOWN(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_DOWN, wxJoystickEventHandler(func))
3843 #define EVT_JOY_BUTTON_UP(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_UP, wxJoystickEventHandler(func))
3844 #define EVT_JOY_MOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_MOVE, wxJoystickEventHandler(func))
3845 #define EVT_JOY_ZMOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_ZMOVE, wxJoystickEventHandler(func))
3847 // All joystick events
3848 #define EVT_JOYSTICK_EVENTS(func) \
3849 EVT_JOY_BUTTON_DOWN(func) \
3850 EVT_JOY_BUTTON_UP(func) \
3851 EVT_JOY_MOVE(func) \
3855 #define EVT_IDLE(func) wx__DECLARE_EVT0(wxEVT_IDLE, wxIdleEventHandler(func))
3858 #define EVT_UPDATE_UI(winid, func) wx__DECLARE_EVT1(wxEVT_UPDATE_UI, winid, wxUpdateUIEventHandler(func))
3859 #define EVT_UPDATE_UI_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_UPDATE_UI, id1, id2, wxUpdateUIEventHandler(func))
3862 #define EVT_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_HELP, winid, wxHelpEventHandler(func))
3863 #define EVT_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_HELP, id1, id2, wxHelpEventHandler(func))
3864 #define EVT_DETAILED_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_DETAILED_HELP, winid, wxHelpEventHandler(func))
3865 #define EVT_DETAILED_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_DETAILED_HELP, id1, id2, wxHelpEventHandler(func))
3867 // Context Menu Events
3868 #define EVT_CONTEXT_MENU(func) wx__DECLARE_EVT0(wxEVT_CONTEXT_MENU, wxContextMenuEventHandler(func))
3869 #define EVT_COMMAND_CONTEXT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_CONTEXT_MENU, winid, wxContextMenuEventHandler(func))
3871 // Clipboard text Events
3872 #define EVT_TEXT_CUT(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_CUT, winid, wxClipboardTextEventHandler(func))
3873 #define EVT_TEXT_COPY(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_COPY, winid, wxClipboardTextEventHandler(func))
3874 #define EVT_TEXT_PASTE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_PASTE, winid, wxClipboardTextEventHandler(func))
3877 #define EVT_THREAD(id, func) wx__DECLARE_EVT1(wxEVT_COMMAND_THREAD, id, wxThreadEventHandler(func))
3879 // ----------------------------------------------------------------------------
3881 // ----------------------------------------------------------------------------
3883 // This is an ugly hack to allow the use of Bind() instead of Connect() inside
3884 // the library code if the library was built with support for it, here is how
3887 // class SomeEventHandlingClass : wxBIND_OR_CONNECT_HACK_BASE_CLASS
3888 // public SomeBaseClass
3891 // SomeEventHandlingClass(wxWindow *win)
3893 // // connect to the event for the given window
3894 // wxBIND_OR_CONNECT_HACK(win, wxEVT_SOMETHING, wxSomeEventHandler,
3895 // SomeEventHandlingClass::OnSomeEvent, this);
3899 // void OnSomeEvent(wxSomeEvent&) { ... }
3902 // This is *not* meant to be used by library users, it is only defined here
3903 // (and not in a private header) because the base class must be visible from
3904 // other public headers, please do NOT use this in your code, it will be
3905 // removed from future wx versions without warning.
3906 #ifndef wxHAS_EVENT_BIND
3907 #define wxBIND_OR_CONNECT_HACK_BASE_CLASS public wxEvtHandler,
3908 #define wxBIND_OR_CONNECT_HACK_ONLY_BASE_CLASS : public wxEvtHandler
3909 #define wxBIND_OR_CONNECT_HACK(w, evt, handler, func, obj) \
3910 win->Connect(evt, handler(func), NULL, obj)
3911 #else // wxHAS_EVENT_BIND
3912 #define wxBIND_OR_CONNECT_HACK_BASE_CLASS
3913 #define wxBIND_OR_CONNECT_HACK_ONLY_BASE_CLASS
3914 #define wxBIND_OR_CONNECT_HACK(w, evt, handler, func, obj) \
3915 win->Bind(evt, &func, obj)
3916 #endif // wxHAS_EVENT_BIND
3920 // Find a window with the focus, that is also a descendant of the given window.
3921 // This is used to determine the window to initially send commands to.
3922 WXDLLIMPEXP_CORE wxWindow
* wxFindFocusDescendant(wxWindow
* ancestor
);
3926 #endif // _WX_EVENT_H_