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 // define macros to create new event types:
103 #ifdef wxHAS_EVENT_BIND
104 // events are represented by an instance of wxEventTypeTag and the
105 // corresponding type must be specified for type-safety checks
107 // define a new custom event type, can be used alone or after event
108 // declaration in the header using one of the macros below
109 #define wxDEFINE_EVENT( name, type ) \
110 const wxEventTypeTag< type > name( wxNewEventType() )
112 // the general version allowing exporting the event type from DLL, used by
114 #define wxDECLARE_EXPORTED_EVENT( expdecl, name, type ) \
115 extern const expdecl wxEventTypeTag< type > name
117 // this is the version which will normally be used in the user code
118 #define wxDECLARE_EVENT( name, type ) \
119 wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type )
122 // these macros are only used internally for backwards compatibility and
123 // allow to define an alias for an existing event type (this is used by
125 #define wxDEFINE_EVENT_ALIAS( name, type, value ) \
126 const wxEventTypeTag< type > name( value )
128 #define wxDECLARE_EXPORTED_EVENT_ALIAS( expdecl, name, type ) \
129 extern const expdecl wxEventTypeTag< type > name
130 #else // !wxHAS_EVENT_BIND
131 // the macros are the same ones as above but defined differently as we only
132 // use the integer event type values to identify events in this case
134 #define wxDEFINE_EVENT( name, type ) \
135 const wxEventType name( wxNewEventType() )
137 #define wxDECLARE_EXPORTED_EVENT( expdecl, name, type ) \
138 extern const expdecl wxEventType name
139 #define wxDECLARE_EVENT( name, type ) \
140 wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type )
142 #define wxDEFINE_EVENT_ALIAS( name, type, value ) \
143 const wxEventType name = value
144 #define wxDECLARE_EXPORTED_EVENT_ALIAS( expdecl, name, type ) \
145 extern const expdecl wxEventType name
146 #endif // wxHAS_EVENT_BIND/!wxHAS_EVENT_BIND
148 // Try to cast the given event handler to the correct handler type:
150 #define wxEVENT_HANDLER_CAST( functype, func ) \
151 ( wxObjectEventFunction )( wxEventFunction )wxStaticCastEvent( functype, &func )
154 #ifdef wxHAS_EVENT_BIND
156 // The tag is a type associated to the event type (which is an integer itself,
157 // in spite of its name) value. It exists in order to be used as a template
158 // parameter and provide a mapping between the event type values and their
159 // corresponding wxEvent-derived classes.
160 template <typename T
>
164 // The class of wxEvent-derived class carried by the events of this type.
165 typedef T EventClass
;
167 wxEventTypeTag(wxEventType type
) { m_type
= type
; }
169 // Return a wxEventType reference for the initialization of the static
170 // event tables. See wxEventTableEntry::m_eventType for a more thorough
172 operator const wxEventType
&() const { return m_type
; }
178 #endif // wxHAS_EVENT_BIND
180 // These are needed for the functor definitions
181 typedef void (wxEvtHandler::*wxEventFunction
)(wxEvent
&);
183 // We had some trouble (specifically with eVC for ARM WinCE build) with using
184 // wxEventFunction in the past so we had introduced wxObjectEventFunction which
185 // used to be a typedef for a member of wxObject and not wxEvtHandler to work
186 // around this but as eVC is not really supported any longer we now only keep
187 // this for backwards compatibility and, despite its name, this is a typedef
188 // for wxEvtHandler member now -- but if we have the same problem with another
189 // compiler we can restore its old definition for it.
190 typedef wxEventFunction wxObjectEventFunction
;
193 // wxEventFunctorClassInfo is used as a unique identifier for wxEventFunctor-
194 // derived classes; it is more light weight than wxClassInfo and can be used in
196 typedef void (*wxEventFunctorClassInfo
)();
198 // this macro must be used in wxEventFunctor-derived classes
199 #define wxDEFINE_EVENT_FUNCTOR_CLASS_INFO( classInfoName ) \
200 static void classInfoName() {}
202 // The event functor which is stored in the static and dynamic event tables:
203 class WXDLLIMPEXP_BASE wxEventFunctor
206 virtual ~wxEventFunctor();
208 // Invoke the actual event handler:
209 virtual void operator()(wxEvtHandler
*, wxEvent
&) = 0;
211 // this function tests whether this functor is matched, for the purpose of
212 // finding it in an event table in Unbind(), by the given functor:
213 virtual bool IsMatching(const wxEventFunctor
& functor
) const = 0;
215 // Test whether the given class info is the same as from this functor. This
216 // allows us in IsMatching to safely downcast the given wxEventFunctor without
217 // the usage of dynamic_cast<>().
218 virtual bool IsSameClass(wxEventFunctorClassInfo classInfo
) const = 0;
220 // If the functor holds an wxEvtHandler, then get access to it and track
221 // its lifetime with wxEventConnectionRef:
222 virtual wxEvtHandler
*GetEvtHandler() const
225 // This is only used to maintain backward compatibility in
226 // wxAppConsoleBase::CallEventHandler and ensures that an overwritten
227 // wxAppConsoleBase::HandleEvent is still called for functors which hold an
229 virtual wxEventFunction
GetEvtMethod() const
233 // A plain method functor for the untyped legacy event types:
234 class WXDLLIMPEXP_BASE wxObjectEventFunctor
: public wxEventFunctor
237 wxObjectEventFunctor(wxObjectEventFunction method
, wxEvtHandler
*handler
)
238 : m_handler( handler
), m_method( method
)
241 virtual void operator()(wxEvtHandler
*handler
, wxEvent
& event
)
243 wxEvtHandler
* const realHandler
= m_handler
? m_handler
: handler
;
245 (realHandler
->*m_method
)(event
);
248 virtual bool IsMatching(const wxEventFunctor
& functor
) const
250 if ( functor
.IsSameClass( sm_classInfo
))
252 const wxObjectEventFunctor
&other
=
253 static_cast< const wxObjectEventFunctor
& >( functor
);
255 // FIXME-VC6: amazing but true: replacing "method == NULL" here
256 // with "!method" makes VC6 crash with an ICE in DLL build (only!)
258 return ( m_method
== other
.m_method
|| other
.m_method
== NULL
) &&
259 ( m_handler
== other
.m_handler
|| other
.m_handler
== NULL
);
265 virtual bool IsSameClass( wxEventFunctorClassInfo otherClassInfo
) const
266 { return sm_classInfo
== otherClassInfo
; }
268 virtual wxEvtHandler
*GetEvtHandler() const
269 { return m_handler
; }
271 virtual wxEventFunction
GetEvtMethod() const
275 wxEvtHandler
*m_handler
;
276 wxEventFunction m_method
;
278 wxDEFINE_EVENT_FUNCTOR_CLASS_INFO( sm_classInfo
);
281 // Create a functor for the legacy events: used by Connect()
282 inline wxObjectEventFunctor
*
283 wxNewEventFunctor(const wxEventType
& WXUNUSED(evtType
),
284 wxObjectEventFunction method
,
285 wxEvtHandler
*handler
)
287 return new wxObjectEventFunctor(method
, handler
);
290 // This version is used by DECLARE_EVENT_TABLE_ENTRY()
291 inline wxObjectEventFunctor
*
292 wxNewEventTableFunctor(const wxEventType
& WXUNUSED(evtType
),
293 wxObjectEventFunction method
)
295 return new wxObjectEventFunctor(method
, NULL
);
298 inline wxObjectEventFunctor
299 wxMakeEventFunctor(const wxEventType
& WXUNUSED(evtType
),
300 wxObjectEventFunction method
,
301 wxEvtHandler
*handler
)
303 return wxObjectEventFunctor(method
, handler
);
306 #ifdef wxHAS_EVENT_BIND
311 // helper template defining nested "type" typedef as the event class
312 // corresponding to the given event type
313 template <typename T
> struct EventClassOf
;
315 // the typed events provide the information about the class of the events they
317 template <typename T
>
318 struct EventClassOf
< wxEventTypeTag
<T
> >
320 typedef typename wxEventTypeTag
<T
>::EventClass type
;
323 // for the old untyped events we don't have information about the exact event
324 // class carried by them
326 struct EventClassOf
<wxEventType
>
328 typedef wxEvent type
;
332 // helper class defining operations different for method functors using an
333 // object of wxEvtHandler-derived class as handler and the others
334 template <typename T
, typename A
, bool> struct HandlerImpl
;
336 // specialization for handlers deriving from wxEvtHandler
337 template <typename T
, typename A
>
338 struct HandlerImpl
<T
, A
, true>
340 static bool IsEvtHandler()
342 static T
*ConvertFromEvtHandler(wxEvtHandler
*p
)
343 { return static_cast<T
*>(p
); }
344 static wxEvtHandler
*ConvertToEvtHandler(T
*p
)
346 static wxEventFunction
ConvertToEvtMethod(void (T::*f
)(A
&))
347 { return static_cast<wxEventFunction
>(
348 reinterpret_cast<void (T::*)(wxEvent
&)>(f
)); }
351 // specialization for handlers not deriving from wxEvtHandler
352 template <typename T
, typename A
>
353 struct HandlerImpl
<T
, A
, false>
355 static bool IsEvtHandler()
357 static T
*ConvertFromEvtHandler(wxEvtHandler
*)
359 static wxEvtHandler
*ConvertToEvtHandler(T
*)
361 static wxEventFunction
ConvertToEvtMethod(void (T::*)(A
&))
365 } // namespace wxPrivate
367 // functor forwarding the event to a method of the given object
369 // notice that the object class may be different from the class in which the
370 // method is defined but it must be convertible to this class
372 // also, the type of the handler parameter doesn't need to be exactly the same
373 // as EventTag::EventClass but it must be its base class -- this is explicitly
374 // allowed to handle different events in the same handler taking wxEvent&, for
377 <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
378 class wxEventFunctorMethod
379 : public wxEventFunctor
,
380 private wxPrivate::HandlerImpl
384 wxConvertibleTo
<Class
, wxEvtHandler
>::value
!= 0
388 static void CheckHandlerArgument(EventArg
*) { }
391 // the event class associated with the given event tag
392 typedef typename
wxPrivate::EventClassOf
<EventTag
>::type EventClass
;
395 wxEventFunctorMethod(void (Class::*method
)(EventArg
&), EventHandler
*handler
)
396 : m_handler( handler
), m_method( method
)
398 wxASSERT_MSG( handler
|| this->IsEvtHandler(),
399 "handlers defined in non-wxEvtHandler-derived classes "
400 "must be connected with a valid sink object" );
402 // if you get an error here it means that the signature of the handler
403 // you're trying to use is not compatible with (i.e. is not the same as
404 // or a base class of) the real event class used for this event type
405 CheckHandlerArgument(static_cast<EventClass
*>(NULL
));
408 virtual void operator()(wxEvtHandler
*handler
, wxEvent
& event
)
410 Class
* realHandler
= m_handler
;
413 realHandler
= this->ConvertFromEvtHandler(handler
);
415 // this is not supposed to happen but check for it nevertheless
416 wxCHECK_RET( realHandler
, "invalid event handler" );
419 // the real (run-time) type of event is EventClass and we checked in
420 // the ctor that EventClass can be converted to EventArg, so this cast
422 (realHandler
->*m_method
)(static_cast<EventArg
&>(event
));
425 virtual bool IsMatching(const wxEventFunctor
& functor
) const
427 if ( !functor
.IsSameClass(sm_classInfo
) )
430 typedef wxEventFunctorMethod
<EventTag
, Class
, EventArg
, EventHandler
>
433 // the cast is valid because IsSameClass() returned true above
434 const ThisFunctor
& other
= static_cast<const ThisFunctor
&>(functor
);
436 return (m_method
== other
.m_method
|| other
.m_method
== NULL
) &&
437 (m_handler
== other
.m_handler
|| other
.m_handler
== NULL
);
440 virtual bool IsSameClass( wxEventFunctorClassInfo otherClassInfo
) const
441 { return sm_classInfo
== otherClassInfo
; }
443 virtual wxEvtHandler
*GetEvtHandler() const
444 { return this->ConvertToEvtHandler(m_handler
); }
446 virtual wxEventFunction
GetEvtMethod() const
447 { return this->ConvertToEvtMethod(m_method
); }
450 EventHandler
*m_handler
;
451 void (Class::*m_method
)(EventArg
&);
453 wxDEFINE_EVENT_FUNCTOR_CLASS_INFO( sm_classInfo
);
457 // functor forwarding the event to function (function, static method)
458 template <typename EventTag
, typename EventArg
>
459 class wxEventFunctorFunction
: public wxEventFunctor
462 static void CheckHandlerArgument(EventArg
*) { }
465 // the event class associated with the given event tag
466 typedef typename
wxPrivate::EventClassOf
<EventTag
>::type EventClass
;
468 wxEventFunctorFunction( void ( *handler
)( EventArg
& ))
469 : m_handler( handler
)
471 // if you get an error here it means that the signature of the handler
472 // you're trying to use is not compatible with (i.e. is not the same as
473 // or a base class of) the real event class used for this event type
474 CheckHandlerArgument(static_cast<EventClass
*>(NULL
));
477 virtual void operator()(wxEvtHandler
*WXUNUSED(handler
), wxEvent
& event
)
479 // If you get an error here like "must use .* or ->* to call
480 // pointer-to-member function" then you probably tried to call
481 // Bind/Unbind with a method pointer but without a handler pointer or
482 // NULL as a handler e.g.:
483 // Unbind( wxEVT_XXX, &EventHandler::method );
485 // Unbind( wxEVT_XXX, &EventHandler::method, NULL )
486 m_handler(static_cast<EventArg
&>(event
));
489 virtual bool IsMatching(const wxEventFunctor
&functor
) const
491 if ( !functor
.IsSameClass(sm_classInfo
) )
494 typedef wxEventFunctorFunction
<EventTag
, EventArg
> ThisFunctor
;
496 const ThisFunctor
& other
= static_cast<const ThisFunctor
&>( functor
);
498 return m_handler
== other
.m_handler
;
501 virtual bool IsSameClass( wxEventFunctorClassInfo otherClassInfo
) const
502 { return sm_classInfo
== otherClassInfo
; }
505 void (*m_handler
)(EventArg
&);
507 wxDEFINE_EVENT_FUNCTOR_CLASS_INFO( sm_classInfo
);
511 template <typename EventTag
, typename Functor
>
512 class wxEventFunctorFunctor
: public wxEventFunctor
515 typedef typename
EventTag::EventClass EventArg
;
517 wxEventFunctorFunctor(const Functor
& handler
)
518 : m_handler(handler
), m_handlerAddr(&handler
)
521 virtual void operator()(wxEvtHandler
*WXUNUSED(handler
), wxEvent
& event
)
523 // If you get an error here like "must use '.*' or '->*' to call
524 // pointer-to-member function" then you probably tried to call
525 // Bind/Unbind with a method pointer but without a handler pointer or
526 // NULL as a handler e.g.:
527 // Unbind( wxEVT_XXX, &EventHandler::method );
529 // Unbind( wxEVT_XXX, &EventHandler::method, NULL )
530 m_handler(static_cast<EventArg
&>(event
));
533 virtual bool IsMatching(const wxEventFunctor
&functor
) const
535 if ( !functor
.IsSameClass(sm_classInfo
) )
538 typedef wxEventFunctorFunctor
<EventTag
, Functor
> FunctorThis
;
540 const FunctorThis
& other
= static_cast<const FunctorThis
&>(functor
);
542 // The only reliable/portable way to compare two functors is by
544 return m_handlerAddr
== other
.m_handlerAddr
;
547 virtual bool IsSameClass( wxEventFunctorClassInfo otherClassInfo
) const
548 { return sm_classInfo
== otherClassInfo
; }
551 // Store a copy of the functor to prevent using/calling an already
552 // destroyed instance:
555 // Use the address of the original functor for comparison in IsMatching:
556 const void *m_handlerAddr
;
558 wxDEFINE_EVENT_FUNCTOR_CLASS_INFO( sm_classInfo
);
561 // Create functors for the templatized events, either allocated on the heap for
562 // wxNewXXX() variants (this is needed in wxEvtHandler::Bind<>() to store them
563 // in dynamic event table) or just by returning them as temporary objects (this
564 // is enough for Unbind<>() and we avoid unnecessary heap allocation like this).
567 // Create functors wrapping functions:
568 template <typename EventTag
, typename EventArg
>
569 inline wxEventFunctorFunction
<EventTag
, EventArg
> *
570 wxNewEventFunctor(const EventTag
&, void (*func
)(EventArg
&))
572 return new wxEventFunctorFunction
<EventTag
, EventArg
>(func
);
575 template <typename EventTag
, typename EventArg
>
576 inline wxEventFunctorFunction
<EventTag
, EventArg
>
577 wxMakeEventFunctor(const EventTag
&, void (*func
)(EventArg
&))
579 return wxEventFunctorFunction
<EventTag
, EventArg
>(func
);
582 // Create functors wrapping other functors:
583 template <typename EventTag
, typename Functor
>
584 inline wxEventFunctorFunctor
<EventTag
, Functor
> *
585 wxNewEventFunctor(const EventTag
&, const Functor
&func
)
587 return new wxEventFunctorFunctor
<EventTag
, Functor
>(func
);
590 template <typename EventTag
, typename Functor
>
591 inline wxEventFunctorFunctor
<EventTag
, Functor
>
592 wxMakeEventFunctor(const EventTag
&, const Functor
&func
)
594 return wxEventFunctorFunctor
<EventTag
, Functor
>(func
);
597 // Create functors wrapping methods:
599 <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
600 inline wxEventFunctorMethod
<EventTag
, Class
, EventArg
, EventHandler
> *
601 wxNewEventFunctor(const EventTag
&,
602 void (Class::*method
)(EventArg
&),
603 EventHandler
*handler
)
605 return new wxEventFunctorMethod
<EventTag
, Class
, EventArg
, EventHandler
>(
610 <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
611 inline wxEventFunctorMethod
<EventTag
, Class
, EventArg
, EventHandler
>
612 wxMakeEventFunctor(const EventTag
&,
613 void (Class::*method
)(EventArg
&),
614 EventHandler
*handler
)
616 return wxEventFunctorMethod
<EventTag
, Class
, EventArg
, EventHandler
>(
620 // Create an event functor for the event table via DECLARE_EVENT_TABLE_ENTRY:
621 // in this case we don't have the handler (as it's always the same as the
622 // object which generated the event) so we must use Class as its type
623 template <typename EventTag
, typename Class
, typename EventArg
>
624 inline wxEventFunctorMethod
<EventTag
, Class
, EventArg
, Class
> *
625 wxNewEventTableFunctor(const EventTag
&, void (Class::*method
)(EventArg
&))
627 return new wxEventFunctorMethod
<EventTag
, Class
, EventArg
, Class
>(
631 #endif // wxHAS_EVENT_BIND
634 // many, but not all, standard event types
636 // some generic events
637 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_NULL
;
638 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_FIRST
;
639 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_USER_FIRST
;
641 // Need events declared to do this
642 class WXDLLIMPEXP_FWD_CORE wxCommandEvent
;
643 class WXDLLIMPEXP_FWD_CORE wxThreadEvent
;
644 class WXDLLIMPEXP_FWD_CORE wxMouseEvent
;
645 class WXDLLIMPEXP_FWD_CORE wxFocusEvent
;
646 class WXDLLIMPEXP_FWD_CORE wxChildFocusEvent
;
647 class WXDLLIMPEXP_FWD_CORE wxKeyEvent
;
648 class WXDLLIMPEXP_FWD_CORE wxNavigationKeyEvent
;
649 class WXDLLIMPEXP_FWD_CORE wxSetCursorEvent
;
650 class WXDLLIMPEXP_FWD_CORE wxScrollEvent
;
651 class WXDLLIMPEXP_FWD_CORE wxSpinEvent
;
652 class WXDLLIMPEXP_FWD_CORE wxScrollWinEvent
;
653 class WXDLLIMPEXP_FWD_CORE wxSizeEvent
;
654 class WXDLLIMPEXP_FWD_CORE wxMoveEvent
;
655 class WXDLLIMPEXP_FWD_CORE wxCloseEvent
;
656 class WXDLLIMPEXP_FWD_CORE wxActivateEvent
;
657 class WXDLLIMPEXP_FWD_CORE wxWindowCreateEvent
;
658 class WXDLLIMPEXP_FWD_CORE wxWindowDestroyEvent
;
659 class WXDLLIMPEXP_FWD_CORE wxShowEvent
;
660 class WXDLLIMPEXP_FWD_CORE wxIconizeEvent
;
661 class WXDLLIMPEXP_FWD_CORE wxMaximizeEvent
;
662 class WXDLLIMPEXP_FWD_CORE wxMouseCaptureChangedEvent
;
663 class WXDLLIMPEXP_FWD_CORE wxMouseCaptureLostEvent
;
664 class WXDLLIMPEXP_FWD_CORE wxPaintEvent
;
665 class WXDLLIMPEXP_FWD_CORE wxEraseEvent
;
666 class WXDLLIMPEXP_FWD_CORE wxNcPaintEvent
;
667 class WXDLLIMPEXP_FWD_CORE wxMenuEvent
;
668 class WXDLLIMPEXP_FWD_CORE wxContextMenuEvent
;
669 class WXDLLIMPEXP_FWD_CORE wxSysColourChangedEvent
;
670 class WXDLLIMPEXP_FWD_CORE wxDisplayChangedEvent
;
671 class WXDLLIMPEXP_FWD_CORE wxQueryNewPaletteEvent
;
672 class WXDLLIMPEXP_FWD_CORE wxPaletteChangedEvent
;
673 class WXDLLIMPEXP_FWD_CORE wxJoystickEvent
;
674 class WXDLLIMPEXP_FWD_CORE wxDropFilesEvent
;
675 class WXDLLIMPEXP_FWD_CORE wxInitDialogEvent
;
676 class WXDLLIMPEXP_FWD_CORE wxIdleEvent
;
677 class WXDLLIMPEXP_FWD_CORE wxUpdateUIEvent
;
678 class WXDLLIMPEXP_FWD_CORE wxClipboardTextEvent
;
679 class WXDLLIMPEXP_FWD_CORE wxHelpEvent
;
683 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_BUTTON_CLICKED
, wxCommandEvent
);
684 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHECKBOX_CLICKED
, wxCommandEvent
);
685 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHOICE_SELECTED
, wxCommandEvent
);
686 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LISTBOX_SELECTED
, wxCommandEvent
);
687 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
, wxCommandEvent
);
688 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
, wxCommandEvent
);
689 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_MENU_SELECTED
, wxCommandEvent
);
690 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SLIDER_UPDATED
, wxCommandEvent
);
691 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RADIOBOX_SELECTED
, wxCommandEvent
);
692 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RADIOBUTTON_SELECTED
, wxCommandEvent
);
694 // wxEVT_COMMAND_SCROLLBAR_UPDATED is deprecated, use wxEVT_SCROLL... events
695 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SCROLLBAR_UPDATED
, wxCommandEvent
);
696 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_VLBOX_SELECTED
, wxCommandEvent
);
697 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_COMBOBOX_SELECTED
, wxCommandEvent
);
698 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_RCLICKED
, wxCommandEvent
);
699 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED
, wxCommandEvent
);
700 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_ENTER
, wxCommandEvent
);
701 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_COMBOBOX_DROPDOWN
, wxCommandEvent
);
702 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_COMBOBOX_CLOSEUP
, wxCommandEvent
);
705 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_THREAD
, wxThreadEvent
);
708 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_DOWN
, wxMouseEvent
);
709 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_UP
, wxMouseEvent
);
710 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_DOWN
, wxMouseEvent
);
711 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_UP
, wxMouseEvent
);
712 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_DOWN
, wxMouseEvent
);
713 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_UP
, wxMouseEvent
);
714 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOTION
, wxMouseEvent
);
715 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ENTER_WINDOW
, wxMouseEvent
);
716 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEAVE_WINDOW
, wxMouseEvent
);
717 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_DCLICK
, wxMouseEvent
);
718 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_DCLICK
, wxMouseEvent
);
719 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_DCLICK
, wxMouseEvent
);
720 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SET_FOCUS
, wxFocusEvent
);
721 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KILL_FOCUS
, wxFocusEvent
);
722 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHILD_FOCUS
, wxChildFocusEvent
);
723 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSEWHEEL
, wxMouseEvent
);
724 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_DOWN
, wxMouseEvent
);
725 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_UP
, wxMouseEvent
);
726 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_DCLICK
, wxMouseEvent
);
727 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_DOWN
, wxMouseEvent
);
728 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_UP
, wxMouseEvent
);
729 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_DCLICK
, wxMouseEvent
);
731 // Character input event type
732 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHAR
, wxKeyEvent
);
733 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHAR_HOOK
, wxKeyEvent
);
734 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_NAVIGATION_KEY
, wxNavigationKeyEvent
);
735 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KEY_DOWN
, wxKeyEvent
);
736 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KEY_UP
, wxKeyEvent
);
738 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HOTKEY
, wxKeyEvent
);
741 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SET_CURSOR
, wxSetCursorEvent
);
743 // wxScrollBar and wxSlider event identifiers
744 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_TOP
, wxScrollEvent
);
745 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_BOTTOM
, wxScrollEvent
);
746 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_LINEUP
, wxScrollEvent
);
747 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_LINEDOWN
, wxScrollEvent
);
748 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_PAGEUP
, wxScrollEvent
);
749 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_PAGEDOWN
, wxScrollEvent
);
750 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_THUMBTRACK
, wxScrollEvent
);
751 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_THUMBRELEASE
, wxScrollEvent
);
752 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_CHANGED
, wxScrollEvent
);
754 // Due to a bug in older wx versions, wxSpinEvents were being sent with type of
755 // wxEVT_SCROLL_LINEUP, wxEVT_SCROLL_LINEDOWN and wxEVT_SCROLL_THUMBTRACK. But
756 // with the type-safe events in place, these event types are associated with
757 // wxScrollEvent. To allow handling of spin events, new event types have been
758 // defined in spinbutt.h/spinnbuttcmn.cpp. To maintain backward compatibility
759 // the spin event types are being initialized with the scroll event types.
763 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN_UP
, wxSpinEvent
);
764 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN_DOWN
, wxSpinEvent
);
765 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN
, wxSpinEvent
);
769 // Scroll events from wxWindow
770 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_TOP
, wxScrollWinEvent
);
771 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_BOTTOM
, wxScrollWinEvent
);
772 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_LINEUP
, wxScrollWinEvent
);
773 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_LINEDOWN
, wxScrollWinEvent
);
774 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_PAGEUP
, wxScrollWinEvent
);
775 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_PAGEDOWN
, wxScrollWinEvent
);
776 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_THUMBTRACK
, wxScrollWinEvent
);
777 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_THUMBRELEASE
, wxScrollWinEvent
);
780 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SIZE
, wxSizeEvent
);
781 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE
, wxMoveEvent
);
782 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CLOSE_WINDOW
, wxCloseEvent
);
783 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_END_SESSION
, wxCloseEvent
);
784 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_QUERY_END_SESSION
, wxCloseEvent
);
785 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ACTIVATE_APP
, wxActivateEvent
);
786 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ACTIVATE
, wxActivateEvent
);
787 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CREATE
, wxWindowCreateEvent
);
788 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DESTROY
, wxWindowDestroyEvent
);
789 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SHOW
, wxShowEvent
);
790 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ICONIZE
, wxIconizeEvent
);
791 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MAXIMIZE
, wxMaximizeEvent
);
792 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSE_CAPTURE_CHANGED
, wxMouseCaptureChangedEvent
);
793 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSE_CAPTURE_LOST
, wxMouseCaptureLostEvent
);
794 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_PAINT
, wxPaintEvent
);
795 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ERASE_BACKGROUND
, wxEraseEvent
);
796 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_NC_PAINT
, wxNcPaintEvent
);
797 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_OPEN
, wxMenuEvent
);
798 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_CLOSE
, wxMenuEvent
);
799 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_HIGHLIGHT
, wxMenuEvent
);
800 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CONTEXT_MENU
, wxContextMenuEvent
);
801 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SYS_COLOUR_CHANGED
, wxSysColourChangedEvent
);
802 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DISPLAY_CHANGED
, wxDisplayChangedEvent
);
803 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_QUERY_NEW_PALETTE
, wxQueryNewPaletteEvent
);
804 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_PALETTE_CHANGED
, wxPaletteChangedEvent
);
805 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_BUTTON_DOWN
, wxJoystickEvent
);
806 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_BUTTON_UP
, wxJoystickEvent
);
807 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_MOVE
, wxJoystickEvent
);
808 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_ZMOVE
, wxJoystickEvent
);
809 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DROP_FILES
, wxDropFilesEvent
);
810 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_INIT_DIALOG
, wxInitDialogEvent
);
811 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_BASE
, wxEVT_IDLE
, wxIdleEvent
);
812 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_UPDATE_UI
, wxUpdateUIEvent
);
813 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SIZING
, wxSizeEvent
);
814 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVING
, wxMoveEvent
);
815 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE_START
, wxMoveEvent
);
816 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE_END
, wxMoveEvent
);
817 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HIBERNATE
, wxActivateEvent
);
820 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_COPY
, wxClipboardTextEvent
);
821 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_CUT
, wxClipboardTextEvent
);
822 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_PASTE
, wxClipboardTextEvent
);
824 // Generic command events
825 // Note: a click is a higher-level event than button down/up
826 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LEFT_CLICK
, wxCommandEvent
);
827 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LEFT_DCLICK
, wxCommandEvent
);
828 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RIGHT_CLICK
, wxCommandEvent
);
829 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RIGHT_DCLICK
, wxCommandEvent
);
830 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SET_FOCUS
, wxCommandEvent
);
831 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_KILL_FOCUS
, wxCommandEvent
);
832 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_ENTER
, wxCommandEvent
);
835 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HELP
, wxHelpEvent
);
836 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DETAILED_HELP
, wxHelpEvent
);
838 // these 2 events are the same
839 #define wxEVT_COMMAND_TOOL_CLICKED wxEVT_COMMAND_MENU_SELECTED
841 // ----------------------------------------------------------------------------
843 // ----------------------------------------------------------------------------
845 // this event is also used by wxComboBox and wxSpinCtrl which don't include
846 // wx/textctrl.h in all ports [yet], so declare it here as well
848 // still, any new code using it should include wx/textctrl.h explicitly
849 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_UPDATED
, wxCommandEvent
);
852 // ----------------------------------------------------------------------------
853 // wxEvent(-derived) classes
854 // ----------------------------------------------------------------------------
856 // the predefined constants for the number of times we propagate event
857 // upwards window child-parent chain
858 enum wxEventPropagation
860 // don't propagate it at all
861 wxEVENT_PROPAGATE_NONE
= 0,
863 // propagate it until it is processed
864 wxEVENT_PROPAGATE_MAX
= INT_MAX
867 // The different categories for a wxEvent; see wxEvent::GetEventCategory.
868 // NOTE: they are used as OR-combinable flags by wxEventLoopBase::YieldFor
871 // this is the category for those events which are generated to update
872 // the appearance of the GUI but which (usually) do not comport data
873 // processing, i.e. which do not provide input or output data
874 // (e.g. size events, scroll events, etc).
875 // They are events NOT directly generated by the user's input devices.
876 wxEVT_CATEGORY_UI
= 1,
878 // this category groups those events which are generated directly from the
879 // user through input devices like mouse and keyboard and usually result in
880 // data to be processed from the application.
881 // (e.g. mouse clicks, key presses, etc)
882 wxEVT_CATEGORY_USER_INPUT
= 2,
884 // this category is for wxSocketEvent
885 wxEVT_CATEGORY_SOCKET
= 4,
887 // this category is for wxTimerEvent
888 wxEVT_CATEGORY_TIMER
= 8,
890 // this category is for any event used to send notifications from the
891 // secondary threads to the main one or in general for notifications among
892 // different threads (which may or may not be user-generated)
893 wxEVT_CATEGORY_THREAD
= 16,
896 // implementation only
898 // used in the implementations of wxEventLoopBase::YieldFor
899 wxEVT_CATEGORY_UNKNOWN
= 32,
901 // a special category used as an argument to wxEventLoopBase::YieldFor to indicate that
902 // Yield() should leave all wxEvents on the queue while emptying the native event queue
903 // (native events will be processed but the wxEvents they generate will be queued)
904 wxEVT_CATEGORY_CLIPBOARD
= 64,
909 // this category groups those events which are emitted in response to
910 // events of the native toolkit and which typically are not-"delayable".
911 wxEVT_CATEGORY_NATIVE_EVENTS
= wxEVT_CATEGORY_UI
|wxEVT_CATEGORY_USER_INPUT
,
913 // used in wxEventLoopBase::YieldFor to specify all event categories should be processed:
915 wxEVT_CATEGORY_UI
|wxEVT_CATEGORY_USER_INPUT
|wxEVT_CATEGORY_SOCKET
| \
916 wxEVT_CATEGORY_TIMER
|wxEVT_CATEGORY_THREAD
|wxEVT_CATEGORY_UNKNOWN
| \
917 wxEVT_CATEGORY_CLIPBOARD
921 * wxWidgets events, covering all interesting things that might happen
922 * (button clicking, resizing, setting text in widgets, etc.).
924 * For each completely new event type, derive a new event class.
925 * An event CLASS represents a C++ class defining a range of similar event TYPES;
926 * examples are canvas events, panel item command events.
927 * An event TYPE is a unique identifier for a particular system event,
928 * such as a button press or a listbox deselection.
932 class WXDLLIMPEXP_BASE wxEvent
: public wxObject
935 wxEvent(int winid
= 0, wxEventType commandType
= wxEVT_NULL
);
937 void SetEventType(wxEventType typ
) { m_eventType
= typ
; }
938 wxEventType
GetEventType() const { return m_eventType
; }
940 wxObject
*GetEventObject() const { return m_eventObject
; }
941 void SetEventObject(wxObject
*obj
) { m_eventObject
= obj
; }
943 long GetTimestamp() const { return m_timeStamp
; }
944 void SetTimestamp(long ts
= 0) { m_timeStamp
= ts
; }
946 int GetId() const { return m_id
; }
947 void SetId(int Id
) { m_id
= Id
; }
949 // Can instruct event processor that we wish to ignore this event
950 // (treat as if the event table entry had not been found): this must be done
951 // to allow the event processing by the base classes (calling event.Skip()
952 // is the analog of calling the base class version of a virtual function)
953 void Skip(bool skip
= true) { m_skipped
= skip
; }
954 bool GetSkipped() const { return m_skipped
; }
956 // This function is used to create a copy of the event polymorphically and
957 // all derived classes must implement it because otherwise wxPostEvent()
958 // for them wouldn't work (it needs to do a copy of the event)
959 virtual wxEvent
*Clone() const = 0;
961 // this function is used to selectively process events in wxEventLoopBase::YieldFor
962 // NOTE: by default it returns wxEVT_CATEGORY_UI just because the major
963 // part of wxWidgets events belong to that category.
964 virtual wxEventCategory
GetEventCategory() const
965 { return wxEVT_CATEGORY_UI
; }
967 // Implementation only: this test is explicitly anti OO and this function
968 // exists only for optimization purposes.
969 bool IsCommandEvent() const { return m_isCommandEvent
; }
971 // Determine if this event should be propagating to the parent window.
972 bool ShouldPropagate() const
973 { return m_propagationLevel
!= wxEVENT_PROPAGATE_NONE
; }
975 // Stop an event from propagating to its parent window, returns the old
976 // propagation level value
977 int StopPropagation()
979 int propagationLevel
= m_propagationLevel
;
980 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
981 return propagationLevel
;
984 // Resume the event propagation by restoring the propagation level
985 // (returned by StopPropagation())
986 void ResumePropagation(int propagationLevel
)
988 m_propagationLevel
= propagationLevel
;
992 // This is for internal use only and is only called by
993 // wxEvtHandler::ProcessEvent() to check whether it's the first time this
994 // event is being processed
997 if ( m_wasProcessed
)
1000 m_wasProcessed
= true;
1006 wxObject
* m_eventObject
;
1007 wxEventType m_eventType
;
1012 // m_callbackUserData is for internal usage only
1013 wxObject
* m_callbackUserData
;
1016 // the propagation level: while it is positive, we propagate the event to
1017 // the parent window (if any)
1018 int m_propagationLevel
;
1021 bool m_isCommandEvent
;
1023 // initially false but becomes true as soon as WasProcessed() is called for
1024 // the first time, as this is done only by ProcessEvent() it explains the
1025 // variable name: it becomes true after ProcessEvent() was called at least
1026 // once for this event
1027 bool m_wasProcessed
;
1030 wxEvent(const wxEvent
&); // for implementing Clone()
1031 wxEvent
& operator=(const wxEvent
&); // for derived classes operator=()
1034 // it needs to access our m_propagationLevel
1035 friend class WXDLLIMPEXP_FWD_BASE wxPropagateOnce
;
1037 DECLARE_ABSTRACT_CLASS(wxEvent
)
1041 * Helper class to temporarily change an event not to propagate.
1043 class WXDLLIMPEXP_BASE wxPropagationDisabler
1046 wxPropagationDisabler(wxEvent
& event
) : m_event(event
)
1048 m_propagationLevelOld
= m_event
.StopPropagation();
1051 ~wxPropagationDisabler()
1053 m_event
.ResumePropagation(m_propagationLevelOld
);
1058 int m_propagationLevelOld
;
1060 wxDECLARE_NO_COPY_CLASS(wxPropagationDisabler
);
1064 * Another one to temporarily lower propagation level.
1066 class WXDLLIMPEXP_BASE wxPropagateOnce
1069 wxPropagateOnce(wxEvent
& event
) : m_event(event
)
1071 wxASSERT_MSG( m_event
.m_propagationLevel
> 0,
1072 wxT("shouldn't be used unless ShouldPropagate()!") );
1074 m_event
.m_propagationLevel
--;
1079 m_event
.m_propagationLevel
++;
1085 wxDECLARE_NO_COPY_CLASS(wxPropagateOnce
);
1092 // Item or menu event class
1094 wxEVT_COMMAND_BUTTON_CLICKED
1095 wxEVT_COMMAND_CHECKBOX_CLICKED
1096 wxEVT_COMMAND_CHOICE_SELECTED
1097 wxEVT_COMMAND_LISTBOX_SELECTED
1098 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
1099 wxEVT_COMMAND_TEXT_UPDATED
1100 wxEVT_COMMAND_TEXT_ENTER
1101 wxEVT_COMMAND_MENU_SELECTED
1102 wxEVT_COMMAND_SLIDER_UPDATED
1103 wxEVT_COMMAND_RADIOBOX_SELECTED
1104 wxEVT_COMMAND_RADIOBUTTON_SELECTED
1105 wxEVT_COMMAND_SCROLLBAR_UPDATED
1106 wxEVT_COMMAND_VLBOX_SELECTED
1107 wxEVT_COMMAND_COMBOBOX_SELECTED
1108 wxEVT_COMMAND_TOGGLEBUTTON_CLICKED
1111 class WXDLLIMPEXP_CORE wxCommandEvent
: public wxEvent
1114 wxCommandEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0);
1116 wxCommandEvent(const wxCommandEvent
& event
)
1118 m_cmdString(event
.m_cmdString
),
1119 m_commandInt(event
.m_commandInt
),
1120 m_extraLong(event
.m_extraLong
),
1121 m_clientData(event
.m_clientData
),
1122 m_clientObject(event
.m_clientObject
)
1125 // Set/Get client data from controls
1126 void SetClientData(void* clientData
) { m_clientData
= clientData
; }
1127 void *GetClientData() const { return m_clientData
; }
1129 // Set/Get client object from controls
1130 void SetClientObject(wxClientData
* clientObject
) { m_clientObject
= clientObject
; }
1131 wxClientData
*GetClientObject() const { return m_clientObject
; }
1133 // Get listbox selection if single-choice
1134 int GetSelection() const { return m_commandInt
; }
1136 // Set/Get listbox/choice selection string
1137 void SetString(const wxString
& s
) { m_cmdString
= s
; }
1138 wxString
GetString() const;
1140 // Get checkbox value
1141 bool IsChecked() const { return m_commandInt
!= 0; }
1143 // true if the listbox event was a selection.
1144 bool IsSelection() const { return (m_extraLong
!= 0); }
1146 void SetExtraLong(long extraLong
) { m_extraLong
= extraLong
; }
1147 long GetExtraLong() const { return m_extraLong
; }
1149 void SetInt(int i
) { m_commandInt
= i
; }
1150 int GetInt() const { return m_commandInt
; }
1152 virtual wxEvent
*Clone() const { return new wxCommandEvent(*this); }
1153 virtual wxEventCategory
GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT
; }
1156 wxString m_cmdString
; // String event argument
1158 long m_extraLong
; // Additional information (e.g. select/deselect)
1159 void* m_clientData
; // Arbitrary client data
1160 wxClientData
* m_clientObject
; // Arbitrary client object
1163 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCommandEvent
)
1166 // this class adds a possibility to react (from the user) code to a control
1167 // notification: allow or veto the operation being reported.
1168 class WXDLLIMPEXP_CORE wxNotifyEvent
: public wxCommandEvent
1171 wxNotifyEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0)
1172 : wxCommandEvent(commandType
, winid
)
1173 { m_bAllow
= true; }
1175 wxNotifyEvent(const wxNotifyEvent
& event
)
1176 : wxCommandEvent(event
)
1177 { m_bAllow
= event
.m_bAllow
; }
1179 // veto the operation (usually it's allowed by default)
1180 void Veto() { m_bAllow
= false; }
1182 // allow the operation if it was disabled by default
1183 void Allow() { m_bAllow
= true; }
1185 // for implementation code only: is the operation allowed?
1186 bool IsAllowed() const { return m_bAllow
; }
1188 virtual wxEvent
*Clone() const { return new wxNotifyEvent(*this); }
1194 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNotifyEvent
)
1200 class WXDLLIMPEXP_CORE wxThreadEvent
: public wxCommandEvent
1203 wxThreadEvent(wxEventType eventType
= wxEVT_COMMAND_THREAD
, int id
= wxID_ANY
)
1204 : wxCommandEvent(eventType
, id
)
1207 wxThreadEvent(const wxThreadEvent
& event
)
1208 : wxCommandEvent(event
)
1210 // make sure our string member (which uses COW, aka refcounting) is not
1211 // shared by other wxString instances:
1212 SetString(GetString().c_str());
1215 virtual wxEvent
*Clone() const
1217 wxThreadEvent
* ev
= new wxThreadEvent(*this);
1219 // make sure our string member (which uses COW, aka refcounting) is not
1220 // shared by other wxString instances:
1221 ev
->SetString(GetString().c_str());
1225 // this is important to avoid that calling wxEventLoopBase::YieldFor thread events
1226 // gets processed when this is unwanted:
1227 virtual wxEventCategory
GetEventCategory() const
1228 { return wxEVT_CATEGORY_THREAD
; }
1231 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxThreadEvent
)
1236 // Scroll event class, derived form wxCommandEvent. wxScrollEvents are
1237 // sent by wxSlider and wxScrollBar.
1242 wxEVT_SCROLL_LINEDOWN
1244 wxEVT_SCROLL_PAGEDOWN
1245 wxEVT_SCROLL_THUMBTRACK
1246 wxEVT_SCROLL_THUMBRELEASE
1247 wxEVT_SCROLL_CHANGED
1250 class WXDLLIMPEXP_CORE wxScrollEvent
: public wxCommandEvent
1253 wxScrollEvent(wxEventType commandType
= wxEVT_NULL
,
1254 int winid
= 0, int pos
= 0, int orient
= 0);
1256 int GetOrientation() const { return (int) m_extraLong
; }
1257 int GetPosition() const { return m_commandInt
; }
1258 void SetOrientation(int orient
) { m_extraLong
= (long) orient
; }
1259 void SetPosition(int pos
) { m_commandInt
= pos
; }
1261 virtual wxEvent
*Clone() const { return new wxScrollEvent(*this); }
1264 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollEvent
)
1267 // ScrollWin event class, derived fom wxEvent. wxScrollWinEvents
1268 // are sent by wxWindow.
1271 wxEVT_SCROLLWIN_BOTTOM
1272 wxEVT_SCROLLWIN_LINEUP
1273 wxEVT_SCROLLWIN_LINEDOWN
1274 wxEVT_SCROLLWIN_PAGEUP
1275 wxEVT_SCROLLWIN_PAGEDOWN
1276 wxEVT_SCROLLWIN_THUMBTRACK
1277 wxEVT_SCROLLWIN_THUMBRELEASE
1280 class WXDLLIMPEXP_CORE wxScrollWinEvent
: public wxEvent
1283 wxScrollWinEvent(wxEventType commandType
= wxEVT_NULL
,
1284 int pos
= 0, int orient
= 0);
1285 wxScrollWinEvent(const wxScrollWinEvent
& event
) : wxEvent(event
)
1286 { m_commandInt
= event
.m_commandInt
;
1287 m_extraLong
= event
.m_extraLong
; }
1289 int GetOrientation() const { return (int) m_extraLong
; }
1290 int GetPosition() const { return m_commandInt
; }
1291 void SetOrientation(int orient
) { m_extraLong
= (long) orient
; }
1292 void SetPosition(int pos
) { m_commandInt
= pos
; }
1294 virtual wxEvent
*Clone() const { return new wxScrollWinEvent(*this); }
1301 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollWinEvent
)
1306 // Mouse event class
1323 wxEVT_NC_MIDDLE_DOWN,
1325 wxEVT_NC_RIGHT_DOWN,
1328 wxEVT_NC_ENTER_WINDOW,
1329 wxEVT_NC_LEAVE_WINDOW,
1330 wxEVT_NC_LEFT_DCLICK,
1331 wxEVT_NC_MIDDLE_DCLICK,
1332 wxEVT_NC_RIGHT_DCLICK,
1335 class WXDLLIMPEXP_CORE wxMouseEvent
: public wxEvent
,
1339 wxMouseEvent(wxEventType mouseType
= wxEVT_NULL
);
1340 wxMouseEvent(const wxMouseEvent
& event
)
1347 // Was it a button event? (*doesn't* mean: is any button *down*?)
1348 bool IsButton() const { return Button(wxMOUSE_BTN_ANY
); }
1350 // Was it a down event from this (or any) button?
1351 bool ButtonDown(int but
= wxMOUSE_BTN_ANY
) const;
1353 // Was it a dclick event from this (or any) button?
1354 bool ButtonDClick(int but
= wxMOUSE_BTN_ANY
) const;
1356 // Was it a up event from this (or any) button?
1357 bool ButtonUp(int but
= wxMOUSE_BTN_ANY
) const;
1359 // Was this event generated by the given button?
1360 bool Button(int but
) const;
1362 // Get the button which is changing state (wxMOUSE_BTN_NONE if none)
1363 int GetButton() const;
1365 // Find which event was just generated
1366 bool LeftDown() const { return (m_eventType
== wxEVT_LEFT_DOWN
); }
1367 bool MiddleDown() const { return (m_eventType
== wxEVT_MIDDLE_DOWN
); }
1368 bool RightDown() const { return (m_eventType
== wxEVT_RIGHT_DOWN
); }
1369 bool Aux1Down() const { return (m_eventType
== wxEVT_AUX1_DOWN
); }
1370 bool Aux2Down() const { return (m_eventType
== wxEVT_AUX2_DOWN
); }
1372 bool LeftUp() const { return (m_eventType
== wxEVT_LEFT_UP
); }
1373 bool MiddleUp() const { return (m_eventType
== wxEVT_MIDDLE_UP
); }
1374 bool RightUp() const { return (m_eventType
== wxEVT_RIGHT_UP
); }
1375 bool Aux1Up() const { return (m_eventType
== wxEVT_AUX1_UP
); }
1376 bool Aux2Up() const { return (m_eventType
== wxEVT_AUX2_UP
); }
1378 bool LeftDClick() const { return (m_eventType
== wxEVT_LEFT_DCLICK
); }
1379 bool MiddleDClick() const { return (m_eventType
== wxEVT_MIDDLE_DCLICK
); }
1380 bool RightDClick() const { return (m_eventType
== wxEVT_RIGHT_DCLICK
); }
1381 bool Aux1DClick() const { return (m_eventType
== wxEVT_AUX1_UP
); }
1382 bool Aux2DClick() const { return (m_eventType
== wxEVT_AUX2_UP
); }
1384 // True if a button is down and the mouse is moving
1385 bool Dragging() const
1387 return (m_eventType
== wxEVT_MOTION
) && ButtonIsDown(wxMOUSE_BTN_ANY
);
1390 // True if the mouse is moving, and no button is down
1393 return (m_eventType
== wxEVT_MOTION
) && !ButtonIsDown(wxMOUSE_BTN_ANY
);
1396 // True if the mouse is just entering the window
1397 bool Entering() const { return (m_eventType
== wxEVT_ENTER_WINDOW
); }
1399 // True if the mouse is just leaving the window
1400 bool Leaving() const { return (m_eventType
== wxEVT_LEAVE_WINDOW
); }
1402 // Returns the number of mouse clicks associated with this event.
1403 int GetClickCount() const { return m_clickCount
; }
1405 // Find the logical position of the event given the DC
1406 wxPoint
GetLogicalPosition(const wxDC
& dc
) const;
1408 // Get wheel rotation, positive or negative indicates direction of
1409 // rotation. Current devices all send an event when rotation is equal to
1410 // +/-WheelDelta, but this allows for finer resolution devices to be
1411 // created in the future. Because of this you shouldn't assume that one
1412 // event is equal to 1 line or whatever, but you should be able to either
1413 // do partial line scrolling or wait until +/-WheelDelta rotation values
1414 // have been accumulated before scrolling.
1415 int GetWheelRotation() const { return m_wheelRotation
; }
1417 // Get wheel delta, normally 120. This is the threshold for action to be
1418 // taken, and one such action (for example, scrolling one increment)
1419 // should occur for each delta.
1420 int GetWheelDelta() const { return m_wheelDelta
; }
1422 // Gets the axis the wheel operation concerns, 0 being the y axis as on
1423 // most mouse wheels, 1 is the x axis for things like MightyMouse scrolls
1424 // or horizontal trackpad scrolling
1425 int GetWheelAxis() const { return m_wheelAxis
; }
1427 // Returns the configured number of lines (or whatever) to be scrolled per
1428 // wheel action. Defaults to one.
1429 int GetLinesPerAction() const { return m_linesPerAction
; }
1431 // Is the system set to do page scrolling?
1432 bool IsPageScroll() const { return ((unsigned int)m_linesPerAction
== UINT_MAX
); }
1434 virtual wxEvent
*Clone() const { return new wxMouseEvent(*this); }
1435 virtual wxEventCategory
GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT
; }
1437 wxMouseEvent
& operator=(const wxMouseEvent
& event
)
1448 int m_wheelRotation
;
1450 int m_linesPerAction
;
1453 void Assign(const wxMouseEvent
& evt
);
1456 DECLARE_DYNAMIC_CLASS(wxMouseEvent
)
1465 class WXDLLIMPEXP_CORE wxSetCursorEvent
: public wxEvent
1468 wxSetCursorEvent(wxCoord x
= 0, wxCoord y
= 0)
1469 : wxEvent(0, wxEVT_SET_CURSOR
),
1470 m_x(x
), m_y(y
), m_cursor()
1473 wxSetCursorEvent(const wxSetCursorEvent
& event
)
1477 m_cursor(event
.m_cursor
)
1480 wxCoord
GetX() const { return m_x
; }
1481 wxCoord
GetY() const { return m_y
; }
1483 void SetCursor(const wxCursor
& cursor
) { m_cursor
= cursor
; }
1484 const wxCursor
& GetCursor() const { return m_cursor
; }
1485 bool HasCursor() const { return m_cursor
.Ok(); }
1487 virtual wxEvent
*Clone() const { return new wxSetCursorEvent(*this); }
1494 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSetCursorEvent
)
1497 // Keyboard input event class
1507 // key categories: the bit flags for IsKeyInCategory() function
1509 // the enum values used may change in future version of wx
1510 // use the named constants only, or bitwise combinations thereof
1511 enum wxKeyCategoryFlags
1513 // arrow keys, on and off numeric keypads
1514 WXK_CATEGORY_ARROW
= 1,
1516 // page up and page down keys, on and off numeric keypads
1517 WXK_CATEGORY_PAGING
= 2,
1519 // home and end keys, on and off numeric keypads
1520 WXK_CATEGORY_JUMP
= 4,
1522 // tab key, on and off numeric keypads
1523 WXK_CATEGORY_TAB
= 8,
1525 // backspace and delete keys, on and off numeric keypads
1526 WXK_CATEGORY_CUT
= 16,
1528 // all keys usually used for navigation
1529 WXK_CATEGORY_NAVIGATION
= WXK_CATEGORY_ARROW
|
1530 WXK_CATEGORY_PAGING
|
1534 class WXDLLIMPEXP_CORE wxKeyEvent
: public wxEvent
,
1535 public wxKeyboardState
1538 wxKeyEvent(wxEventType keyType
= wxEVT_NULL
);
1539 wxKeyEvent(const wxKeyEvent
& evt
);
1541 // get the key code: an ASCII7 char or an element of wxKeyCode enum
1542 int GetKeyCode() const { return (int)m_keyCode
; }
1544 // returns true iff this event's key code is of a certain type
1545 bool IsKeyInCategory(int category
) const;
1548 // get the Unicode character corresponding to this key
1549 wxChar
GetUnicodeKey() const { return m_uniChar
; }
1550 #endif // wxUSE_UNICODE
1552 // get the raw key code (platform-dependent)
1553 wxUint32
GetRawKeyCode() const { return m_rawCode
; }
1555 // get the raw key flags (platform-dependent)
1556 wxUint32
GetRawKeyFlags() const { return m_rawFlags
; }
1558 // Find the position of the event
1559 void GetPosition(wxCoord
*xpos
, wxCoord
*ypos
) const
1561 if (xpos
) *xpos
= m_x
;
1562 if (ypos
) *ypos
= m_y
;
1565 void GetPosition(long *xpos
, long *ypos
) const
1567 if (xpos
) *xpos
= (long)m_x
;
1568 if (ypos
) *ypos
= (long)m_y
;
1571 wxPoint
GetPosition() const
1572 { return wxPoint(m_x
, m_y
); }
1575 wxCoord
GetX() const { return m_x
; }
1578 wxCoord
GetY() const { return m_y
; }
1580 virtual wxEvent
*Clone() const { return new wxKeyEvent(*this); }
1581 virtual wxEventCategory
GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT
; }
1583 // we do need to copy wxKeyEvent sometimes (in wxTreeCtrl code, for
1585 wxKeyEvent
& operator=(const wxKeyEvent
& evt
)
1589 wxEvent::operator=(evt
);
1591 // Borland C++ 5.82 doesn't compile an explicit call to an
1592 // implicitly defined operator=() so need to do it this way:
1593 *static_cast<wxKeyboardState
*>(this) = evt
;
1598 m_keyCode
= evt
.m_keyCode
;
1600 m_rawCode
= evt
.m_rawCode
;
1601 m_rawFlags
= evt
.m_rawFlags
;
1603 m_uniChar
= evt
.m_uniChar
;
1615 // This contains the full Unicode character
1616 // in a character events in Unicode mode
1620 // these fields contain the platform-specific information about
1621 // key that was pressed
1623 wxUint32 m_rawFlags
;
1626 DECLARE_DYNAMIC_CLASS(wxKeyEvent
)
1634 class WXDLLIMPEXP_CORE wxSizeEvent
: public wxEvent
1637 wxSizeEvent() : wxEvent(0, wxEVT_SIZE
)
1639 wxSizeEvent(const wxSize
& sz
, int winid
= 0)
1640 : wxEvent(winid
, wxEVT_SIZE
),
1643 wxSizeEvent(const wxSizeEvent
& event
)
1645 m_size(event
.m_size
), m_rect(event
.m_rect
)
1647 wxSizeEvent(const wxRect
& rect
, int id
= 0)
1648 : m_size(rect
.GetSize()), m_rect(rect
)
1649 { m_eventType
= wxEVT_SIZING
; m_id
= id
; }
1651 wxSize
GetSize() const { return m_size
; }
1652 wxRect
GetRect() const { return m_rect
; }
1653 void SetRect(const wxRect
& rect
) { m_rect
= rect
; }
1655 virtual wxEvent
*Clone() const { return new wxSizeEvent(*this); }
1658 // For internal usage only. Will be converted to protected members.
1660 wxRect m_rect
; // Used for wxEVT_SIZING
1663 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSizeEvent
)
1672 class WXDLLIMPEXP_CORE wxMoveEvent
: public wxEvent
1676 : wxEvent(0, wxEVT_MOVE
)
1678 wxMoveEvent(const wxPoint
& pos
, int winid
= 0)
1679 : wxEvent(winid
, wxEVT_MOVE
),
1682 wxMoveEvent(const wxMoveEvent
& event
)
1686 wxMoveEvent(const wxRect
& rect
, int id
= 0)
1687 : m_pos(rect
.GetPosition()), m_rect(rect
)
1688 { m_eventType
= wxEVT_MOVING
; m_id
= id
; }
1690 wxPoint
GetPosition() const { return m_pos
; }
1691 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
1692 wxRect
GetRect() const { return m_rect
; }
1693 void SetRect(const wxRect
& rect
) { m_rect
= rect
; }
1695 virtual wxEvent
*Clone() const { return new wxMoveEvent(*this); }
1702 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMoveEvent
)
1705 // Paint event class
1712 #if wxDEBUG_LEVEL && (defined(__WXMSW__) || defined(__WXPM__))
1713 #define wxHAS_PAINT_DEBUG
1715 // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined
1716 extern WXDLLIMPEXP_CORE
int g_isPainting
;
1719 class WXDLLIMPEXP_CORE wxPaintEvent
: public wxEvent
1722 wxPaintEvent(int Id
= 0)
1723 : wxEvent(Id
, wxEVT_PAINT
)
1725 #ifdef wxHAS_PAINT_DEBUG
1726 // set the internal flag for the duration of redrawing
1731 // default copy ctor and dtor are normally fine, we only need them to keep
1732 // g_isPainting updated in debug build
1733 #ifdef wxHAS_PAINT_DEBUG
1734 wxPaintEvent(const wxPaintEvent
& event
)
1740 virtual ~wxPaintEvent()
1746 virtual wxEvent
*Clone() const { return new wxPaintEvent(*this); }
1749 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaintEvent
)
1752 class WXDLLIMPEXP_CORE wxNcPaintEvent
: public wxEvent
1755 wxNcPaintEvent(int winid
= 0)
1756 : wxEvent(winid
, wxEVT_NC_PAINT
)
1759 virtual wxEvent
*Clone() const { return new wxNcPaintEvent(*this); }
1762 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNcPaintEvent
)
1765 // Erase background event class
1767 wxEVT_ERASE_BACKGROUND
1770 class WXDLLIMPEXP_CORE wxEraseEvent
: public wxEvent
1773 wxEraseEvent(int Id
= 0, wxDC
*dc
= NULL
)
1774 : wxEvent(Id
, wxEVT_ERASE_BACKGROUND
),
1778 wxEraseEvent(const wxEraseEvent
& event
)
1783 wxDC
*GetDC() const { return m_dc
; }
1785 virtual wxEvent
*Clone() const { return new wxEraseEvent(*this); }
1791 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxEraseEvent
)
1794 // Focus event class
1800 class WXDLLIMPEXP_CORE wxFocusEvent
: public wxEvent
1803 wxFocusEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0)
1804 : wxEvent(winid
, type
)
1807 wxFocusEvent(const wxFocusEvent
& event
)
1809 { m_win
= event
.m_win
; }
1811 // The window associated with this event is the window which had focus
1812 // before for SET event and the window which will have focus for the KILL
1813 // one. NB: it may be NULL in both cases!
1814 wxWindow
*GetWindow() const { return m_win
; }
1815 void SetWindow(wxWindow
*win
) { m_win
= win
; }
1817 virtual wxEvent
*Clone() const { return new wxFocusEvent(*this); }
1823 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFocusEvent
)
1826 // wxChildFocusEvent notifies the parent that a child has got the focus: unlike
1827 // wxFocusEvent it is propagated upwards the window chain
1828 class WXDLLIMPEXP_CORE wxChildFocusEvent
: public wxCommandEvent
1831 wxChildFocusEvent(wxWindow
*win
= NULL
);
1833 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
1835 virtual wxEvent
*Clone() const { return new wxChildFocusEvent(*this); }
1838 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxChildFocusEvent
)
1841 // Activate event class
1848 class WXDLLIMPEXP_CORE wxActivateEvent
: public wxEvent
1851 wxActivateEvent(wxEventType type
= wxEVT_NULL
, bool active
= true, int Id
= 0)
1853 { m_active
= active
; }
1854 wxActivateEvent(const wxActivateEvent
& event
)
1856 { m_active
= event
.m_active
; }
1858 bool GetActive() const { return m_active
; }
1860 virtual wxEvent
*Clone() const { return new wxActivateEvent(*this); }
1866 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxActivateEvent
)
1869 // InitDialog event class
1874 class WXDLLIMPEXP_CORE wxInitDialogEvent
: public wxEvent
1877 wxInitDialogEvent(int Id
= 0)
1878 : wxEvent(Id
, wxEVT_INIT_DIALOG
)
1881 virtual wxEvent
*Clone() const { return new wxInitDialogEvent(*this); }
1884 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxInitDialogEvent
)
1887 // Miscellaneous menu event class
1891 wxEVT_MENU_HIGHLIGHT,
1894 class WXDLLIMPEXP_CORE wxMenuEvent
: public wxEvent
1897 wxMenuEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0, wxMenu
* menu
= NULL
)
1898 : wxEvent(winid
, type
)
1899 { m_menuId
= winid
; m_menu
= menu
; }
1900 wxMenuEvent(const wxMenuEvent
& event
)
1902 { m_menuId
= event
.m_menuId
; m_menu
= event
.m_menu
; }
1904 // only for wxEVT_MENU_HIGHLIGHT
1905 int GetMenuId() const { return m_menuId
; }
1907 // only for wxEVT_MENU_OPEN/CLOSE
1908 bool IsPopup() const { return m_menuId
== wxID_ANY
; }
1910 // only for wxEVT_MENU_OPEN/CLOSE
1911 wxMenu
* GetMenu() const { return m_menu
; }
1913 virtual wxEvent
*Clone() const { return new wxMenuEvent(*this); }
1919 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMenuEvent
)
1922 // Window close or session close event class
1926 wxEVT_QUERY_END_SESSION
1929 class WXDLLIMPEXP_CORE wxCloseEvent
: public wxEvent
1932 wxCloseEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0)
1933 : wxEvent(winid
, type
),
1935 m_veto(false), // should be false by default
1938 wxCloseEvent(const wxCloseEvent
& event
)
1940 m_loggingOff(event
.m_loggingOff
),
1941 m_veto(event
.m_veto
),
1942 m_canVeto(event
.m_canVeto
) {}
1944 void SetLoggingOff(bool logOff
) { m_loggingOff
= logOff
; }
1945 bool GetLoggingOff() const
1947 // m_loggingOff flag is only used by wxEVT_[QUERY_]END_SESSION, it
1948 // doesn't make sense for wxEVT_CLOSE_WINDOW
1949 wxASSERT_MSG( m_eventType
!= wxEVT_CLOSE_WINDOW
,
1950 wxT("this flag is for end session events only") );
1952 return m_loggingOff
;
1955 void Veto(bool veto
= true)
1957 // GetVeto() will return false anyhow...
1958 wxCHECK_RET( m_canVeto
,
1959 wxT("call to Veto() ignored (can't veto this event)") );
1963 void SetCanVeto(bool canVeto
) { m_canVeto
= canVeto
; }
1964 bool CanVeto() const { return m_canVeto
; }
1965 bool GetVeto() const { return m_canVeto
&& m_veto
; }
1967 virtual wxEvent
*Clone() const { return new wxCloseEvent(*this); }
1975 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCloseEvent
)
1982 class WXDLLIMPEXP_CORE wxShowEvent
: public wxEvent
1985 wxShowEvent(int winid
= 0, bool show
= false)
1986 : wxEvent(winid
, wxEVT_SHOW
)
1988 wxShowEvent(const wxShowEvent
& event
)
1990 { m_show
= event
.m_show
; }
1992 void SetShow(bool show
) { m_show
= show
; }
1994 // return true if the window was shown, false if hidden
1995 bool IsShown() const { return m_show
; }
1997 #if WXWIN_COMPATIBILITY_2_8
1998 wxDEPRECATED( bool GetShow() const { return IsShown(); } )
2001 virtual wxEvent
*Clone() const { return new wxShowEvent(*this); }
2007 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxShowEvent
)
2014 class WXDLLIMPEXP_CORE wxIconizeEvent
: public wxEvent
2017 wxIconizeEvent(int winid
= 0, bool iconized
= true)
2018 : wxEvent(winid
, wxEVT_ICONIZE
)
2019 { m_iconized
= iconized
; }
2020 wxIconizeEvent(const wxIconizeEvent
& event
)
2022 { m_iconized
= event
.m_iconized
; }
2024 #if WXWIN_COMPATIBILITY_2_8
2025 wxDEPRECATED( bool Iconized() const { return IsIconized(); } )
2027 // return true if the frame was iconized, false if restored
2028 bool IsIconized() const { return m_iconized
; }
2030 virtual wxEvent
*Clone() const { return new wxIconizeEvent(*this); }
2036 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIconizeEvent
)
2042 class WXDLLIMPEXP_CORE wxMaximizeEvent
: public wxEvent
2045 wxMaximizeEvent(int winid
= 0)
2046 : wxEvent(winid
, wxEVT_MAXIMIZE
)
2049 virtual wxEvent
*Clone() const { return new wxMaximizeEvent(*this); }
2052 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMaximizeEvent
)
2055 // Joystick event class
2057 wxEVT_JOY_BUTTON_DOWN,
2058 wxEVT_JOY_BUTTON_UP,
2063 // Which joystick? Same as Windows ids so no conversion necessary.
2070 // Which button is down?
2073 wxJOY_BUTTON_ANY
= -1,
2080 class WXDLLIMPEXP_CORE wxJoystickEvent
: public wxEvent
2085 int m_buttonChange
; // Which button changed?
2086 int m_buttonState
; // Which buttons are down?
2087 int m_joyStick
; // Which joystick?
2090 wxJoystickEvent(wxEventType type
= wxEVT_NULL
,
2092 int joystick
= wxJOYSTICK1
,
2097 m_buttonChange(change
),
2098 m_buttonState(state
),
2099 m_joyStick(joystick
)
2102 wxJoystickEvent(const wxJoystickEvent
& event
)
2105 m_zPosition(event
.m_zPosition
),
2106 m_buttonChange(event
.m_buttonChange
),
2107 m_buttonState(event
.m_buttonState
),
2108 m_joyStick(event
.m_joyStick
)
2111 wxPoint
GetPosition() const { return m_pos
; }
2112 int GetZPosition() const { return m_zPosition
; }
2113 int GetButtonState() const { return m_buttonState
; }
2114 int GetButtonChange() const { return m_buttonChange
; }
2115 int GetJoystick() const { return m_joyStick
; }
2117 void SetJoystick(int stick
) { m_joyStick
= stick
; }
2118 void SetButtonState(int state
) { m_buttonState
= state
; }
2119 void SetButtonChange(int change
) { m_buttonChange
= change
; }
2120 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2121 void SetZPosition(int zPos
) { m_zPosition
= zPos
; }
2123 // Was it a button event? (*doesn't* mean: is any button *down*?)
2124 bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN
) ||
2125 (GetEventType() == wxEVT_JOY_BUTTON_UP
)); }
2127 // Was it a move event?
2128 bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE
); }
2130 // Was it a zmove event?
2131 bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE
); }
2133 // Was it a down event from button 1, 2, 3, 4 or any?
2134 bool ButtonDown(int but
= wxJOY_BUTTON_ANY
) const
2135 { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN
) &&
2136 ((but
== wxJOY_BUTTON_ANY
) || (but
== m_buttonChange
))); }
2138 // Was it a up event from button 1, 2, 3 or any?
2139 bool ButtonUp(int but
= wxJOY_BUTTON_ANY
) const
2140 { return ((GetEventType() == wxEVT_JOY_BUTTON_UP
) &&
2141 ((but
== wxJOY_BUTTON_ANY
) || (but
== m_buttonChange
))); }
2143 // Was the given button 1,2,3,4 or any in Down state?
2144 bool ButtonIsDown(int but
= wxJOY_BUTTON_ANY
) const
2145 { return (((but
== wxJOY_BUTTON_ANY
) && (m_buttonState
!= 0)) ||
2146 ((m_buttonState
& but
) == but
)); }
2148 virtual wxEvent
*Clone() const { return new wxJoystickEvent(*this); }
2151 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxJoystickEvent
)
2154 // Drop files event class
2159 class WXDLLIMPEXP_CORE wxDropFilesEvent
: public wxEvent
2166 wxDropFilesEvent(wxEventType type
= wxEVT_NULL
,
2168 wxString
*files
= NULL
)
2175 // we need a copy ctor to avoid deleting m_files pointer twice
2176 wxDropFilesEvent(const wxDropFilesEvent
& other
)
2178 m_noFiles(other
.m_noFiles
),
2182 m_files
= new wxString
[m_noFiles
];
2183 for ( int n
= 0; n
< m_noFiles
; n
++ )
2185 m_files
[n
] = other
.m_files
[n
];
2189 virtual ~wxDropFilesEvent()
2194 wxPoint
GetPosition() const { return m_pos
; }
2195 int GetNumberOfFiles() const { return m_noFiles
; }
2196 wxString
*GetFiles() const { return m_files
; }
2198 virtual wxEvent
*Clone() const { return new wxDropFilesEvent(*this); }
2201 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDropFilesEvent
)
2209 // Whether to always send update events to windows, or
2210 // to only send update events to those with the
2211 // wxWS_EX_PROCESS_UI_UPDATES style.
2215 // Send UI update events to all windows
2216 wxUPDATE_UI_PROCESS_ALL
,
2218 // Send UI update events to windows that have
2219 // the wxWS_EX_PROCESS_UI_UPDATES flag specified
2220 wxUPDATE_UI_PROCESS_SPECIFIED
2223 class WXDLLIMPEXP_CORE wxUpdateUIEvent
: public wxCommandEvent
2226 wxUpdateUIEvent(wxWindowID commandId
= 0)
2227 : wxCommandEvent(wxEVT_UPDATE_UI
, commandId
)
2235 m_setChecked
= false;
2237 wxUpdateUIEvent(const wxUpdateUIEvent
& event
)
2238 : wxCommandEvent(event
),
2239 m_checked(event
.m_checked
),
2240 m_enabled(event
.m_enabled
),
2241 m_shown(event
.m_shown
),
2242 m_setEnabled(event
.m_setEnabled
),
2243 m_setShown(event
.m_setShown
),
2244 m_setText(event
.m_setText
),
2245 m_setChecked(event
.m_setChecked
),
2246 m_text(event
.m_text
)
2249 bool GetChecked() const { return m_checked
; }
2250 bool GetEnabled() const { return m_enabled
; }
2251 bool GetShown() const { return m_shown
; }
2252 wxString
GetText() const { return m_text
; }
2253 bool GetSetText() const { return m_setText
; }
2254 bool GetSetChecked() const { return m_setChecked
; }
2255 bool GetSetEnabled() const { return m_setEnabled
; }
2256 bool GetSetShown() const { return m_setShown
; }
2258 void Check(bool check
) { m_checked
= check
; m_setChecked
= true; }
2259 void Enable(bool enable
) { m_enabled
= enable
; m_setEnabled
= true; }
2260 void Show(bool show
) { m_shown
= show
; m_setShown
= true; }
2261 void SetText(const wxString
& text
) { m_text
= text
; m_setText
= true; }
2263 // Sets the interval between updates in milliseconds.
2264 // Set to -1 to disable updates, or to 0 to update as frequently as possible.
2265 static void SetUpdateInterval(long updateInterval
) { sm_updateInterval
= updateInterval
; }
2267 // Returns the current interval between updates in milliseconds
2268 static long GetUpdateInterval() { return sm_updateInterval
; }
2270 // Can we update this window?
2271 static bool CanUpdate(wxWindowBase
*win
);
2273 // Reset the update time to provide a delay until the next
2274 // time we should update
2275 static void ResetUpdateTime();
2277 // Specify how wxWidgets will send update events: to
2278 // all windows, or only to those which specify that they
2279 // will process the events.
2280 static void SetMode(wxUpdateUIMode mode
) { sm_updateMode
= mode
; }
2282 // Returns the UI update mode
2283 static wxUpdateUIMode
GetMode() { return sm_updateMode
; }
2285 virtual wxEvent
*Clone() const { return new wxUpdateUIEvent(*this); }
2297 static wxLongLong sm_lastUpdate
;
2299 static long sm_updateInterval
;
2300 static wxUpdateUIMode sm_updateMode
;
2303 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxUpdateUIEvent
)
2307 wxEVT_SYS_COLOUR_CHANGED
2310 // TODO: shouldn't all events record the window ID?
2311 class WXDLLIMPEXP_CORE wxSysColourChangedEvent
: public wxEvent
2314 wxSysColourChangedEvent()
2315 : wxEvent(0, wxEVT_SYS_COLOUR_CHANGED
)
2318 virtual wxEvent
*Clone() const { return new wxSysColourChangedEvent(*this); }
2321 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSysColourChangedEvent
)
2325 wxEVT_MOUSE_CAPTURE_CHANGED
2326 The window losing the capture receives this message
2327 (even if it released the capture itself).
2330 class WXDLLIMPEXP_CORE wxMouseCaptureChangedEvent
: public wxEvent
2333 wxMouseCaptureChangedEvent(wxWindowID winid
= 0, wxWindow
* gainedCapture
= NULL
)
2334 : wxEvent(winid
, wxEVT_MOUSE_CAPTURE_CHANGED
),
2335 m_gainedCapture(gainedCapture
)
2338 wxMouseCaptureChangedEvent(const wxMouseCaptureChangedEvent
& event
)
2340 m_gainedCapture(event
.m_gainedCapture
)
2343 virtual wxEvent
*Clone() const { return new wxMouseCaptureChangedEvent(*this); }
2345 wxWindow
* GetCapturedWindow() const { return m_gainedCapture
; }
2348 wxWindow
* m_gainedCapture
;
2350 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureChangedEvent
)
2354 wxEVT_MOUSE_CAPTURE_LOST
2355 The window losing the capture receives this message, unless it released it
2356 it itself or unless wxWindow::CaptureMouse was called on another window
2357 (and so capture will be restored when the new capturer releases it).
2360 class WXDLLIMPEXP_CORE wxMouseCaptureLostEvent
: public wxEvent
2363 wxMouseCaptureLostEvent(wxWindowID winid
= 0)
2364 : wxEvent(winid
, wxEVT_MOUSE_CAPTURE_LOST
)
2367 wxMouseCaptureLostEvent(const wxMouseCaptureLostEvent
& event
)
2371 virtual wxEvent
*Clone() const { return new wxMouseCaptureLostEvent(*this); }
2373 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureLostEvent
)
2377 wxEVT_DISPLAY_CHANGED
2379 class WXDLLIMPEXP_CORE wxDisplayChangedEvent
: public wxEvent
2382 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDisplayChangedEvent
)
2385 wxDisplayChangedEvent()
2386 : wxEvent(0, wxEVT_DISPLAY_CHANGED
)
2389 virtual wxEvent
*Clone() const { return new wxDisplayChangedEvent(*this); }
2393 wxEVT_PALETTE_CHANGED
2396 class WXDLLIMPEXP_CORE wxPaletteChangedEvent
: public wxEvent
2399 wxPaletteChangedEvent(wxWindowID winid
= 0)
2400 : wxEvent(winid
, wxEVT_PALETTE_CHANGED
),
2401 m_changedWindow(NULL
)
2404 wxPaletteChangedEvent(const wxPaletteChangedEvent
& event
)
2406 m_changedWindow(event
.m_changedWindow
)
2409 void SetChangedWindow(wxWindow
* win
) { m_changedWindow
= win
; }
2410 wxWindow
* GetChangedWindow() const { return m_changedWindow
; }
2412 virtual wxEvent
*Clone() const { return new wxPaletteChangedEvent(*this); }
2415 wxWindow
* m_changedWindow
;
2418 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaletteChangedEvent
)
2422 wxEVT_QUERY_NEW_PALETTE
2423 Indicates the window is getting keyboard focus and should re-do its palette.
2426 class WXDLLIMPEXP_CORE wxQueryNewPaletteEvent
: public wxEvent
2429 wxQueryNewPaletteEvent(wxWindowID winid
= 0)
2430 : wxEvent(winid
, wxEVT_QUERY_NEW_PALETTE
),
2431 m_paletteRealized(false)
2433 wxQueryNewPaletteEvent(const wxQueryNewPaletteEvent
& event
)
2435 m_paletteRealized(event
.m_paletteRealized
)
2438 // App sets this if it changes the palette.
2439 void SetPaletteRealized(bool realized
) { m_paletteRealized
= realized
; }
2440 bool GetPaletteRealized() const { return m_paletteRealized
; }
2442 virtual wxEvent
*Clone() const { return new wxQueryNewPaletteEvent(*this); }
2445 bool m_paletteRealized
;
2448 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxQueryNewPaletteEvent
)
2452 Event generated by dialog navigation keys
2453 wxEVT_NAVIGATION_KEY
2455 // NB: don't derive from command event to avoid being propagated to the parent
2456 class WXDLLIMPEXP_CORE wxNavigationKeyEvent
: public wxEvent
2459 wxNavigationKeyEvent()
2460 : wxEvent(0, wxEVT_NAVIGATION_KEY
),
2461 m_flags(IsForward
| FromTab
), // defaults are for TAB
2464 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
2467 wxNavigationKeyEvent(const wxNavigationKeyEvent
& event
)
2469 m_flags(event
.m_flags
),
2470 m_focus(event
.m_focus
)
2473 // direction: forward (true) or backward (false)
2474 bool GetDirection() const
2475 { return (m_flags
& IsForward
) != 0; }
2476 void SetDirection(bool bForward
)
2477 { if ( bForward
) m_flags
|= IsForward
; else m_flags
&= ~IsForward
; }
2479 // it may be a window change event (MDI, notebook pages...) or a control
2481 bool IsWindowChange() const
2482 { return (m_flags
& WinChange
) != 0; }
2483 void SetWindowChange(bool bIs
)
2484 { if ( bIs
) m_flags
|= WinChange
; else m_flags
&= ~WinChange
; }
2486 // Set to true under MSW if the event was generated using the tab key.
2487 // This is required for proper navogation over radio buttons
2488 bool IsFromTab() const
2489 { return (m_flags
& FromTab
) != 0; }
2490 void SetFromTab(bool bIs
)
2491 { if ( bIs
) m_flags
|= FromTab
; else m_flags
&= ~FromTab
; }
2493 // the child which has the focus currently (may be NULL - use
2494 // wxWindow::FindFocus then)
2495 wxWindow
* GetCurrentFocus() const { return m_focus
; }
2496 void SetCurrentFocus(wxWindow
*win
) { m_focus
= win
; }
2499 void SetFlags(long flags
) { m_flags
= flags
; }
2501 virtual wxEvent
*Clone() const { return new wxNavigationKeyEvent(*this); }
2503 enum wxNavigationKeyEventFlags
2505 IsBackward
= 0x0000,
2515 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNavigationKeyEvent
)
2518 // Window creation/destruction events: the first is sent as soon as window is
2519 // created (i.e. the underlying GUI object exists), but when the C++ object is
2520 // fully initialized (so virtual functions may be called). The second,
2521 // wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
2522 // still safe to call virtual functions at this moment
2528 class WXDLLIMPEXP_CORE wxWindowCreateEvent
: public wxCommandEvent
2531 wxWindowCreateEvent(wxWindow
*win
= NULL
);
2533 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
2535 virtual wxEvent
*Clone() const { return new wxWindowCreateEvent(*this); }
2538 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowCreateEvent
)
2541 class WXDLLIMPEXP_CORE wxWindowDestroyEvent
: public wxCommandEvent
2544 wxWindowDestroyEvent(wxWindow
*win
= NULL
);
2546 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
2548 virtual wxEvent
*Clone() const { return new wxWindowDestroyEvent(*this); }
2551 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowDestroyEvent
)
2554 // A help event is sent when the user clicks on a window in context-help mode.
2560 class WXDLLIMPEXP_CORE wxHelpEvent
: public wxCommandEvent
2563 // how was this help event generated?
2566 Origin_Unknown
, // unrecognized event source
2567 Origin_Keyboard
, // event generated from F1 key press
2568 Origin_HelpButton
// event from [?] button on the title bar (Windows)
2571 wxHelpEvent(wxEventType type
= wxEVT_NULL
,
2572 wxWindowID winid
= 0,
2573 const wxPoint
& pt
= wxDefaultPosition
,
2574 Origin origin
= Origin_Unknown
)
2575 : wxCommandEvent(type
, winid
),
2577 m_origin(GuessOrigin(origin
))
2579 wxHelpEvent(const wxHelpEvent
& event
)
2580 : wxCommandEvent(event
),
2582 m_target(event
.m_target
),
2583 m_link(event
.m_link
),
2584 m_origin(event
.m_origin
)
2587 // Position of event (in screen coordinates)
2588 const wxPoint
& GetPosition() const { return m_pos
; }
2589 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2591 // Optional link to further help
2592 const wxString
& GetLink() const { return m_link
; }
2593 void SetLink(const wxString
& link
) { m_link
= link
; }
2595 // Optional target to display help in. E.g. a window specification
2596 const wxString
& GetTarget() const { return m_target
; }
2597 void SetTarget(const wxString
& target
) { m_target
= target
; }
2599 virtual wxEvent
*Clone() const { return new wxHelpEvent(*this); }
2601 // optional indication of the event source
2602 Origin
GetOrigin() const { return m_origin
; }
2603 void SetOrigin(Origin origin
) { m_origin
= origin
; }
2611 // we can try to guess the event origin ourselves, even if none is
2612 // specified in the ctor
2613 static Origin
GuessOrigin(Origin origin
);
2616 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHelpEvent
)
2619 // A Clipboard Text event is sent when a window intercepts text copy/cut/paste
2620 // message, i.e. the user has cut/copied/pasted data from/into a text control
2621 // via ctrl-C/X/V, ctrl/shift-del/insert, a popup menu command, etc.
2622 // NOTE : under windows these events are *NOT* generated automatically
2623 // for a Rich Edit text control.
2625 wxEVT_COMMAND_TEXT_COPY
2626 wxEVT_COMMAND_TEXT_CUT
2627 wxEVT_COMMAND_TEXT_PASTE
2630 class WXDLLIMPEXP_CORE wxClipboardTextEvent
: public wxCommandEvent
2633 wxClipboardTextEvent(wxEventType type
= wxEVT_NULL
,
2634 wxWindowID winid
= 0)
2635 : wxCommandEvent(type
, winid
)
2637 wxClipboardTextEvent(const wxClipboardTextEvent
& event
)
2638 : wxCommandEvent(event
)
2641 virtual wxEvent
*Clone() const { return new wxClipboardTextEvent(*this); }
2644 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxClipboardTextEvent
)
2647 // A Context event is sent when the user right clicks on a window or
2648 // presses Shift-F10
2649 // NOTE : Under windows this is a repackaged WM_CONTETXMENU message
2650 // Under other systems it may have to be generated from a right click event
2655 class WXDLLIMPEXP_CORE wxContextMenuEvent
: public wxCommandEvent
2658 wxContextMenuEvent(wxEventType type
= wxEVT_NULL
,
2659 wxWindowID winid
= 0,
2660 const wxPoint
& pt
= wxDefaultPosition
)
2661 : wxCommandEvent(type
, winid
),
2664 wxContextMenuEvent(const wxContextMenuEvent
& event
)
2665 : wxCommandEvent(event
),
2669 // Position of event (in screen coordinates)
2670 const wxPoint
& GetPosition() const { return m_pos
; }
2671 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2673 virtual wxEvent
*Clone() const { return new wxContextMenuEvent(*this); }
2679 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxContextMenuEvent
)
2689 // Whether to always send idle events to windows, or
2690 // to only send update events to those with the
2691 // wxWS_EX_PROCESS_IDLE style.
2695 // Send idle events to all windows
2698 // Send idle events to windows that have
2699 // the wxWS_EX_PROCESS_IDLE flag specified
2700 wxIDLE_PROCESS_SPECIFIED
2703 class WXDLLIMPEXP_BASE wxIdleEvent
: public wxEvent
2707 : wxEvent(0, wxEVT_IDLE
),
2708 m_requestMore(false)
2710 wxIdleEvent(const wxIdleEvent
& event
)
2712 m_requestMore(event
.m_requestMore
)
2715 void RequestMore(bool needMore
= true) { m_requestMore
= needMore
; }
2716 bool MoreRequested() const { return m_requestMore
; }
2718 virtual wxEvent
*Clone() const { return new wxIdleEvent(*this); }
2720 // Specify how wxWidgets will send idle events: to
2721 // all windows, or only to those which specify that they
2722 // will process the events.
2723 static void SetMode(wxIdleMode mode
) { sm_idleMode
= mode
; }
2725 // Returns the idle event mode
2726 static wxIdleMode
GetMode() { return sm_idleMode
; }
2730 static wxIdleMode sm_idleMode
;
2733 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIdleEvent
)
2737 wxEVT_MOUSE_CAPTURE_CHANGED,
2738 wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
2739 // wxEVT_FONT_CHANGED, // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
2740 // wxEVT_FONT_CHANGED to all other windows (maybe).
2741 wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
2748 // ============================================================================
2749 // event handler and related classes
2750 // ============================================================================
2753 // struct containing the members common to static and dynamic event tables
2755 struct WXDLLIMPEXP_BASE wxEventTableEntryBase
2757 wxEventTableEntryBase(int winid
, int idLast
,
2758 wxEventFunctor
* fn
, wxObject
*data
)
2762 m_callbackUserData(data
)
2765 wxEventTableEntryBase( const wxEventTableEntryBase
&entry
)
2766 : m_id( entry
.m_id
),
2767 m_lastId( entry
.m_lastId
),
2769 m_callbackUserData( entry
.m_callbackUserData
)
2771 // This is a 'hack' to ensure that only one instance tries to delete
2772 // the functor pointer. It is safe as long as the only place where the
2773 // copy constructor is being called is when the static event tables are
2774 // being initialized (a temporary instance is created and then this
2775 // constructor is called).
2777 const_cast<wxEventTableEntryBase
&>( entry
).m_fn
= NULL
;
2780 ~wxEventTableEntryBase()
2785 // the range of ids for this entry: if m_lastId == wxID_ANY, the range
2786 // consists only of m_id, otherwise it is m_id..m_lastId inclusive
2790 // function/method/functor to call
2791 wxEventFunctor
* m_fn
;
2793 // arbitrary user data associated with the callback
2794 wxObject
* m_callbackUserData
;
2797 wxDECLARE_NO_ASSIGN_CLASS(wxEventTableEntryBase
);
2800 // an entry from a static event table
2801 struct WXDLLIMPEXP_BASE wxEventTableEntry
: public wxEventTableEntryBase
2803 wxEventTableEntry(const int& evType
, int winid
, int idLast
,
2804 wxEventFunctor
* fn
, wxObject
*data
)
2805 : wxEventTableEntryBase(winid
, idLast
, fn
, data
),
2809 // the reference to event type: this allows us to not care about the
2810 // (undefined) order in which the event table entries and the event types
2811 // are initialized: initially the value of this reference might be
2812 // invalid, but by the time it is used for the first time, all global
2813 // objects will have been initialized (including the event type constants)
2814 // and so it will have the correct value when it is needed
2815 const int& m_eventType
;
2818 wxDECLARE_NO_ASSIGN_CLASS(wxEventTableEntry
);
2821 // an entry used in dynamic event table managed by wxEvtHandler::Connect()
2822 struct WXDLLIMPEXP_BASE wxDynamicEventTableEntry
: public wxEventTableEntryBase
2824 wxDynamicEventTableEntry(int evType
, int winid
, int idLast
,
2825 wxEventFunctor
* fn
, wxObject
*data
)
2826 : wxEventTableEntryBase(winid
, idLast
, fn
, data
),
2830 // not a reference here as we can't keep a reference to a temporary int
2831 // created to wrap the constant value typically passed to Connect() - nor
2836 wxDECLARE_NO_ASSIGN_CLASS(wxDynamicEventTableEntry
);
2839 // ----------------------------------------------------------------------------
2840 // wxEventTable: an array of event entries terminated with {0, 0, 0, 0, 0}
2841 // ----------------------------------------------------------------------------
2843 struct WXDLLIMPEXP_BASE wxEventTable
2845 const wxEventTable
*baseTable
; // base event table (next in chain)
2846 const wxEventTableEntry
*entries
; // bottom of entry array
2849 // ----------------------------------------------------------------------------
2850 // wxEventHashTable: a helper of wxEvtHandler to speed up wxEventTable lookups.
2851 // ----------------------------------------------------------------------------
2853 WX_DEFINE_ARRAY_PTR(const wxEventTableEntry
*, wxEventTableEntryPointerArray
);
2855 class WXDLLIMPEXP_BASE wxEventHashTable
2858 // Internal data structs
2859 struct EventTypeTable
2861 wxEventType eventType
;
2862 wxEventTableEntryPointerArray eventEntryTable
;
2864 typedef EventTypeTable
* EventTypeTablePointer
;
2867 // Constructor, needs the event table it needs to hash later on.
2868 // Note: hashing of the event table is not done in the constructor as it
2869 // can be that the event table is not yet full initialize, the hash
2870 // will gets initialized when handling the first event look-up request.
2871 wxEventHashTable(const wxEventTable
&table
);
2873 ~wxEventHashTable();
2875 // Handle the given event, in other words search the event table hash
2876 // and call self->ProcessEvent() if a match was found.
2877 bool HandleEvent(wxEvent
& event
, wxEvtHandler
*self
);
2882 #if wxUSE_MEMORY_TRACING
2883 // Clear all tables: only used to work around problems in memory tracing
2885 static void ClearAll();
2886 #endif // wxUSE_MEMORY_TRACING
2889 // Init the hash table with the entries of the static event table.
2890 void InitHashTable();
2891 // Helper funtion of InitHashTable() to insert 1 entry into the hash table.
2892 void AddEntry(const wxEventTableEntry
&entry
);
2893 // Allocate and init with null pointers the base hash table.
2894 void AllocEventTypeTable(size_t size
);
2895 // Grow the hash table in size and transfer all items currently
2896 // in the table to the correct location in the new table.
2897 void GrowEventTypeTable();
2900 const wxEventTable
&m_table
;
2904 EventTypeTablePointer
*m_eventTypeTable
;
2906 static wxEventHashTable
* sm_first
;
2907 wxEventHashTable
* m_previous
;
2908 wxEventHashTable
* m_next
;
2910 wxDECLARE_NO_COPY_CLASS(wxEventHashTable
);
2913 // ----------------------------------------------------------------------------
2914 // wxEvtHandler: the base class for all objects handling wxWidgets events
2915 // ----------------------------------------------------------------------------
2917 class WXDLLIMPEXP_BASE wxEvtHandler
: public wxObject
2918 , public wxTrackable
2922 virtual ~wxEvtHandler();
2925 // Event handler chain
2926 // -------------------
2928 wxEvtHandler
*GetNextHandler() const { return m_nextHandler
; }
2929 wxEvtHandler
*GetPreviousHandler() const { return m_previousHandler
; }
2930 virtual void SetNextHandler(wxEvtHandler
*handler
) { m_nextHandler
= handler
; }
2931 virtual void SetPreviousHandler(wxEvtHandler
*handler
) { m_previousHandler
= handler
; }
2933 void SetEvtHandlerEnabled(bool enabled
) { m_enabled
= enabled
; }
2934 bool GetEvtHandlerEnabled() const { return m_enabled
; }
2937 bool IsUnlinked() const;
2941 // Event queuing and processing
2942 // ----------------------------
2944 // Process an event right now: this can only be called from the main
2945 // thread, use QueueEvent() for scheduling the events for
2946 // processing from other threads.
2947 virtual bool ProcessEvent(wxEvent
& event
);
2949 // Process an event by calling ProcessEvent and handling any exceptions
2950 // thrown by event handlers. It's mostly useful when processing wx events
2951 // when called from C code (e.g. in GTK+ callback) when the exception
2952 // wouldn't correctly propagate to wxEventLoop.
2953 bool SafelyProcessEvent(wxEvent
& event
);
2954 // NOTE: uses ProcessEvent()
2956 // Schedule the given event to be processed later. It takes ownership of
2957 // the event pointer, i.e. it will be deleted later. This is safe to call
2958 // from multiple threads although you still need to ensure that wxString
2959 // fields of the event object are deep copies and not use the same string
2960 // buffer as other wxString objects in this thread.
2961 virtual void QueueEvent(wxEvent
*event
);
2963 // Add an event to be processed later: notice that this function is not
2964 // safe to call from threads other than main, use QueueEvent()
2965 virtual void AddPendingEvent(const wxEvent
& event
)
2967 // notice that the thread-safety problem comes from the fact that
2968 // Clone() doesn't make deep copies of wxString fields of wxEvent
2969 // object and so the same wxString could be used from both threads when
2970 // the event object is destroyed in this one -- QueueEvent() avoids
2971 // this problem as the event pointer is not used any more in this
2972 // thread at all after it is called.
2973 QueueEvent(event
.Clone());
2976 void ProcessPendingEvents();
2977 // NOTE: uses ProcessEvent()
2979 void DeletePendingEvents();
2982 bool ProcessThreadEvent(const wxEvent
& event
);
2983 // NOTE: uses AddPendingEvent(); call only from secondary threads
2987 // Connecting and disconnecting
2988 // ----------------------------
2990 // These functions are used for old, untyped, event handlers and don't
2991 // check that the type of the function passed to them actually matches the
2992 // type of the event. They also only allow connecting events to methods of
2993 // wxEvtHandler-derived classes.
2995 // The template Connect() methods below are safer and allow connecting
2996 // events to arbitrary functions or functors -- but require compiler
2997 // support for templates.
2999 // Dynamic association of a member function handler with the event handler,
3000 // winid and event type
3001 void Connect(int winid
,
3003 wxEventType eventType
,
3004 wxObjectEventFunction func
,
3005 wxObject
*userData
= NULL
,
3006 wxEvtHandler
*eventSink
= NULL
)
3008 DoBind(winid
, lastId
, eventType
,
3009 wxNewEventFunctor(eventType
, func
, eventSink
),
3013 // Convenience function: take just one id
3014 void Connect(int winid
,
3015 wxEventType eventType
,
3016 wxObjectEventFunction func
,
3017 wxObject
*userData
= NULL
,
3018 wxEvtHandler
*eventSink
= NULL
)
3019 { Connect(winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3021 // Even more convenient: without id (same as using id of wxID_ANY)
3022 void Connect(wxEventType eventType
,
3023 wxObjectEventFunction func
,
3024 wxObject
*userData
= NULL
,
3025 wxEvtHandler
*eventSink
= NULL
)
3026 { Connect(wxID_ANY
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3028 bool Disconnect(int winid
,
3030 wxEventType eventType
,
3031 wxObjectEventFunction func
= NULL
,
3032 wxObject
*userData
= NULL
,
3033 wxEvtHandler
*eventSink
= NULL
)
3035 return DoUnbind(winid
, lastId
, eventType
,
3036 wxMakeEventFunctor(eventType
, func
, eventSink
),
3040 bool Disconnect(int winid
= wxID_ANY
,
3041 wxEventType eventType
= wxEVT_NULL
,
3042 wxObjectEventFunction func
= NULL
,
3043 wxObject
*userData
= NULL
,
3044 wxEvtHandler
*eventSink
= NULL
)
3045 { return Disconnect(winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3047 bool Disconnect(wxEventType eventType
,
3048 wxObjectEventFunction func
,
3049 wxObject
*userData
= NULL
,
3050 wxEvtHandler
*eventSink
= NULL
)
3051 { return Disconnect(wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3053 #ifdef wxHAS_EVENT_BIND
3054 // Bind functions to an event:
3055 template <typename EventTag
, typename EventArg
>
3056 void Bind(const EventTag
& eventType
,
3057 void (*function
)(EventArg
&),
3058 int winid
= wxID_ANY
,
3059 int lastId
= wxID_ANY
,
3060 wxObject
*userData
= NULL
)
3062 DoBind(winid
, lastId
, eventType
,
3063 wxNewEventFunctor(eventType
, function
),
3068 template <typename EventTag
, typename EventArg
>
3069 bool Unbind(const EventTag
& eventType
,
3070 void (*function
)(EventArg
&),
3071 int winid
= wxID_ANY
,
3072 int lastId
= wxID_ANY
,
3073 wxObject
*userData
= NULL
)
3075 return DoUnbind(winid
, lastId
, eventType
,
3076 wxMakeEventFunctor(eventType
, function
),
3080 // Bind functors to an event:
3081 template <typename EventTag
, typename Functor
>
3082 void Bind(const EventTag
& eventType
,
3083 const Functor
&functor
,
3084 int winid
= wxID_ANY
,
3085 int lastId
= wxID_ANY
,
3086 wxObject
*userData
= NULL
)
3088 DoBind(winid
, lastId
, eventType
,
3089 wxNewEventFunctor(eventType
, functor
),
3094 template <typename EventTag
, typename Functor
>
3095 bool Unbind(const EventTag
& eventType
,
3096 const Functor
&functor
,
3097 int winid
= wxID_ANY
,
3098 int lastId
= wxID_ANY
,
3099 wxObject
*userData
= NULL
)
3101 return DoUnbind(winid
, lastId
, eventType
,
3102 wxMakeEventFunctor(eventType
, functor
),
3107 // Bind a method of a class (called on the specified handler which must
3108 // be convertible to this class) object to an event:
3110 template <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
3111 void Bind(const EventTag
&eventType
,
3112 void (Class::*method
)(EventArg
&),
3113 EventHandler
*handler
,
3114 int winid
= wxID_ANY
,
3115 int lastId
= wxID_ANY
,
3116 wxObject
*userData
= NULL
)
3118 DoBind(winid
, lastId
, eventType
,
3119 wxNewEventFunctor(eventType
, method
, handler
),
3123 template <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
3124 bool Unbind(const EventTag
&eventType
,
3125 void (Class::*method
)(EventArg
&),
3126 EventHandler
*handler
,
3127 int winid
= wxID_ANY
,
3128 int lastId
= wxID_ANY
,
3129 wxObject
*userData
= NULL
)
3131 return DoUnbind(winid
, lastId
, eventType
,
3132 wxMakeEventFunctor(eventType
, method
, handler
),
3135 #endif // wxHAS_EVENT_BIND
3137 wxList
* GetDynamicEventTable() const { return m_dynamicEvents
; }
3139 // User data can be associated with each wxEvtHandler
3140 void SetClientObject( wxClientData
*data
) { DoSetClientObject(data
); }
3141 wxClientData
*GetClientObject() const { return DoGetClientObject(); }
3143 void SetClientData( void *data
) { DoSetClientData(data
); }
3144 void *GetClientData() const { return DoGetClientData(); }
3147 // implementation from now on
3148 // --------------------------
3150 // check if the given event table entry matches this event by id (the check
3151 // for the event type should be done by caller) and call the handler if it
3154 // return true if the event was processed, false otherwise (no match or the
3155 // handler decided to skip the event)
3156 static bool ProcessEventIfMatchesId(const wxEventTableEntryBase
& tableEntry
,
3157 wxEvtHandler
*handler
,
3160 virtual bool SearchEventTable(wxEventTable
& table
, wxEvent
& event
);
3161 bool SearchDynamicEventTable( wxEvent
& event
);
3163 // Avoid problems at exit by cleaning up static hash table gracefully
3164 void ClearEventHashTable() { GetEventHashTable().Clear(); }
3165 void OnSinkDestroyed( wxEvtHandler
*sink
);
3168 // The method tries to process the event in this event handler.
3170 // It is meant to be called from ProcessEvent() only and is not virtual,
3171 // additional event handlers can be hooked into the normal event processing
3172 // logic using TryBefore() and TryAfter() hooks.
3173 bool ProcessEventHere(wxEvent
& event
);
3177 void DoBind(int winid
,
3179 wxEventType eventType
,
3180 wxEventFunctor
*func
,
3181 wxObject
* userData
= NULL
);
3183 bool DoUnbind(int winid
,
3185 wxEventType eventType
,
3186 const wxEventFunctor
& func
,
3187 wxObject
*userData
= NULL
);
3189 static const wxEventTableEntry sm_eventTableEntries
[];
3192 // hooks for wxWindow used by ProcessEvent()
3193 // -----------------------------------------
3195 // this one is called before trying our own event table to allow plugging
3196 // in the event handlers overriding the default logic, this is used by e.g.
3198 virtual bool TryBefore(wxEvent
& event
);
3200 // this one is called after failing to find the event handle in our own
3201 // table to give a chance to the other windows to process it
3203 // base class implementation passes the event to wxTheApp
3204 virtual bool TryAfter(wxEvent
& event
);
3206 #ifdef WXWIN_COMPATIBILITY_2_8
3207 // deprecated method: override TryBefore() instead of this one
3208 wxDEPRECATED_BUT_USED_INTERNALLY_INLINE(
3209 virtual bool TryValidator(wxEvent
& WXUNUSED(event
)), return false; )
3211 wxDEPRECATED_BUT_USED_INTERNALLY_INLINE(
3212 virtual bool TryParent(wxEvent
& event
), return DoTryApp(event
); )
3213 #endif // WXWIN_COMPATIBILITY_2_8
3216 static const wxEventTable sm_eventTable
;
3217 virtual const wxEventTable
*GetEventTable() const;
3219 static wxEventHashTable sm_eventHashTable
;
3220 virtual wxEventHashTable
& GetEventHashTable() const;
3222 wxEvtHandler
* m_nextHandler
;
3223 wxEvtHandler
* m_previousHandler
;
3224 wxList
* m_dynamicEvents
;
3225 wxList
* m_pendingEvents
;
3228 // critical section protecting m_pendingEvents
3229 wxCriticalSection m_pendingEventsLock
;
3230 #endif // wxUSE_THREADS
3232 // Is event handler enabled?
3236 // The user data: either an object which will be deleted by the container
3237 // when it's deleted or some raw pointer which we do nothing with - only
3238 // one type of data can be used with the given window (i.e. you cannot set
3239 // the void data and then associate the container with wxClientData or vice
3243 wxClientData
*m_clientObject
;
3247 // what kind of data do we have?
3248 wxClientDataType m_clientDataType
;
3250 // client data accessors
3251 virtual void DoSetClientObject( wxClientData
*data
);
3252 virtual wxClientData
*DoGetClientObject() const;
3254 virtual void DoSetClientData( void *data
);
3255 virtual void *DoGetClientData() const;
3257 // Search tracker objects for event connection with this sink
3258 wxEventConnectionRef
*FindRefInTrackerList(wxEvtHandler
*handler
);
3261 // pass the event to wxTheApp instance, called from TryAfter()
3262 bool DoTryApp(wxEvent
& event
);
3264 DECLARE_DYNAMIC_CLASS_NO_COPY(wxEvtHandler
)
3267 WX_DEFINE_ARRAY_WITH_DECL_PTR(wxEvtHandler
*, wxEvtHandlerArray
, class WXDLLIMPEXP_BASE
);
3269 // ----------------------------------------------------------------------------
3270 // wxEventConnectionRef represents all connections between two event handlers
3271 // and enables automatic disconnect when an event handler sink goes out of
3272 // scope. Each connection/disconnect increases/decreases ref count, and
3273 // when it reaches zero the node goes out of scope.
3274 // ----------------------------------------------------------------------------
3276 class wxEventConnectionRef
: public wxTrackerNode
3279 wxEventConnectionRef() : m_src(NULL
), m_sink(NULL
), m_refCount(0) { }
3280 wxEventConnectionRef(wxEvtHandler
*src
, wxEvtHandler
*sink
)
3281 : m_src(src
), m_sink(sink
), m_refCount(1)
3283 m_sink
->AddNode(this);
3286 // The sink is being destroyed
3287 virtual void OnObjectDestroy( )
3290 m_src
->OnSinkDestroyed( m_sink
);
3294 virtual wxEventConnectionRef
*ToEventConnection() { return this; }
3296 void IncRef() { m_refCount
++; }
3299 if ( !--m_refCount
)
3301 // The sink holds the only external pointer to this object
3303 m_sink
->RemoveNode(this);
3309 wxEvtHandler
*m_src
,
3313 friend class wxEvtHandler
;
3315 wxDECLARE_NO_ASSIGN_CLASS(wxEventConnectionRef
);
3318 // Post a message to the given event handler which will be processed during the
3319 // next event loop iteration.
3321 // Notice that this one is not thread-safe, use wxQueueEvent()
3322 inline void wxPostEvent(wxEvtHandler
*dest
, const wxEvent
& event
)
3324 wxCHECK_RET( dest
, "need an object to post event to" );
3326 dest
->AddPendingEvent(event
);
3329 // Wrapper around wxEvtHandler::QueueEvent(): adds an event for later
3330 // processing, unlike wxPostEvent it is safe to use from different thread even
3331 // for events with wxString members
3332 inline void wxQueueEvent(wxEvtHandler
*dest
, wxEvent
*event
)
3334 wxCHECK_RET( dest
, "need an object to queue event for" );
3336 dest
->QueueEvent(event
);
3339 typedef void (wxEvtHandler::*wxEventFunction
)(wxEvent
&);
3340 typedef void (wxEvtHandler::*wxIdleEventFunction
)(wxIdleEvent
&);
3342 #define wxEventHandler(func) \
3343 wxEVENT_HANDLER_CAST(wxEventFunction, func)
3344 #define wxIdleEventHandler(func) \
3345 wxEVENT_HANDLER_CAST(wxIdleEventFunction, func)
3349 // ----------------------------------------------------------------------------
3350 // wxEventBlocker: helper class to temporarily disable event handling for a window
3351 // ----------------------------------------------------------------------------
3353 class WXDLLIMPEXP_CORE wxEventBlocker
: public wxEvtHandler
3356 wxEventBlocker(wxWindow
*win
, wxEventType type
= wxEVT_ANY
);
3357 virtual ~wxEventBlocker();
3359 void Block(wxEventType type
)
3361 m_eventsToBlock
.push_back(type
);
3364 virtual bool ProcessEvent(wxEvent
& event
);
3367 wxArrayInt m_eventsToBlock
;
3370 wxDECLARE_NO_COPY_CLASS(wxEventBlocker
);
3373 typedef void (wxEvtHandler::*wxCommandEventFunction
)(wxCommandEvent
&);
3374 typedef void (wxEvtHandler::*wxThreadEventFunction
)(wxThreadEvent
&);
3375 typedef void (wxEvtHandler::*wxScrollEventFunction
)(wxScrollEvent
&);
3376 typedef void (wxEvtHandler::*wxScrollWinEventFunction
)(wxScrollWinEvent
&);
3377 typedef void (wxEvtHandler::*wxSizeEventFunction
)(wxSizeEvent
&);
3378 typedef void (wxEvtHandler::*wxMoveEventFunction
)(wxMoveEvent
&);
3379 typedef void (wxEvtHandler::*wxPaintEventFunction
)(wxPaintEvent
&);
3380 typedef void (wxEvtHandler::*wxNcPaintEventFunction
)(wxNcPaintEvent
&);
3381 typedef void (wxEvtHandler::*wxEraseEventFunction
)(wxEraseEvent
&);
3382 typedef void (wxEvtHandler::*wxMouseEventFunction
)(wxMouseEvent
&);
3383 typedef void (wxEvtHandler::*wxCharEventFunction
)(wxKeyEvent
&);
3384 typedef void (wxEvtHandler::*wxFocusEventFunction
)(wxFocusEvent
&);
3385 typedef void (wxEvtHandler::*wxChildFocusEventFunction
)(wxChildFocusEvent
&);
3386 typedef void (wxEvtHandler::*wxActivateEventFunction
)(wxActivateEvent
&);
3387 typedef void (wxEvtHandler::*wxMenuEventFunction
)(wxMenuEvent
&);
3388 typedef void (wxEvtHandler::*wxJoystickEventFunction
)(wxJoystickEvent
&);
3389 typedef void (wxEvtHandler::*wxDropFilesEventFunction
)(wxDropFilesEvent
&);
3390 typedef void (wxEvtHandler::*wxInitDialogEventFunction
)(wxInitDialogEvent
&);
3391 typedef void (wxEvtHandler::*wxSysColourChangedEventFunction
)(wxSysColourChangedEvent
&);
3392 typedef void (wxEvtHandler::*wxDisplayChangedEventFunction
)(wxDisplayChangedEvent
&);
3393 typedef void (wxEvtHandler::*wxUpdateUIEventFunction
)(wxUpdateUIEvent
&);
3394 typedef void (wxEvtHandler::*wxCloseEventFunction
)(wxCloseEvent
&);
3395 typedef void (wxEvtHandler::*wxShowEventFunction
)(wxShowEvent
&);
3396 typedef void (wxEvtHandler::*wxIconizeEventFunction
)(wxIconizeEvent
&);
3397 typedef void (wxEvtHandler::*wxMaximizeEventFunction
)(wxMaximizeEvent
&);
3398 typedef void (wxEvtHandler::*wxNavigationKeyEventFunction
)(wxNavigationKeyEvent
&);
3399 typedef void (wxEvtHandler::*wxPaletteChangedEventFunction
)(wxPaletteChangedEvent
&);
3400 typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction
)(wxQueryNewPaletteEvent
&);
3401 typedef void (wxEvtHandler::*wxWindowCreateEventFunction
)(wxWindowCreateEvent
&);
3402 typedef void (wxEvtHandler::*wxWindowDestroyEventFunction
)(wxWindowDestroyEvent
&);
3403 typedef void (wxEvtHandler::*wxSetCursorEventFunction
)(wxSetCursorEvent
&);
3404 typedef void (wxEvtHandler::*wxNotifyEventFunction
)(wxNotifyEvent
&);
3405 typedef void (wxEvtHandler::*wxHelpEventFunction
)(wxHelpEvent
&);
3406 typedef void (wxEvtHandler::*wxContextMenuEventFunction
)(wxContextMenuEvent
&);
3407 typedef void (wxEvtHandler::*wxMouseCaptureChangedEventFunction
)(wxMouseCaptureChangedEvent
&);
3408 typedef void (wxEvtHandler::*wxMouseCaptureLostEventFunction
)(wxMouseCaptureLostEvent
&);
3409 typedef void (wxEvtHandler::*wxClipboardTextEventFunction
)(wxClipboardTextEvent
&);
3412 #define wxCommandEventHandler(func) \
3413 wxEVENT_HANDLER_CAST(wxCommandEventFunction, func)
3414 #define wxThreadEventHandler(func) \
3415 wxEVENT_HANDLER_CAST(wxThreadEventFunction, func)
3416 #define wxScrollEventHandler(func) \
3417 wxEVENT_HANDLER_CAST(wxScrollEventFunction, func)
3418 #define wxScrollWinEventHandler(func) \
3419 wxEVENT_HANDLER_CAST(wxScrollWinEventFunction, func)
3420 #define wxSizeEventHandler(func) \
3421 wxEVENT_HANDLER_CAST(wxSizeEventFunction, func)
3422 #define wxMoveEventHandler(func) \
3423 wxEVENT_HANDLER_CAST(wxMoveEventFunction, func)
3424 #define wxPaintEventHandler(func) \
3425 wxEVENT_HANDLER_CAST(wxPaintEventFunction, func)
3426 #define wxNcPaintEventHandler(func) \
3427 wxEVENT_HANDLER_CAST(wxNcPaintEventFunction, func)
3428 #define wxEraseEventHandler(func) \
3429 wxEVENT_HANDLER_CAST(wxEraseEventFunction, func)
3430 #define wxMouseEventHandler(func) \
3431 wxEVENT_HANDLER_CAST(wxMouseEventFunction, func)
3432 #define wxCharEventHandler(func) \
3433 wxEVENT_HANDLER_CAST(wxCharEventFunction, func)
3434 #define wxKeyEventHandler(func) wxCharEventHandler(func)
3435 #define wxFocusEventHandler(func) \
3436 wxEVENT_HANDLER_CAST(wxFocusEventFunction, func)
3437 #define wxChildFocusEventHandler(func) \
3438 wxEVENT_HANDLER_CAST(wxChildFocusEventFunction, func)
3439 #define wxActivateEventHandler(func) \
3440 wxEVENT_HANDLER_CAST(wxActivateEventFunction, func)
3441 #define wxMenuEventHandler(func) \
3442 wxEVENT_HANDLER_CAST(wxMenuEventFunction, func)
3443 #define wxJoystickEventHandler(func) \
3444 wxEVENT_HANDLER_CAST(wxJoystickEventFunction, func)
3445 #define wxDropFilesEventHandler(func) \
3446 wxEVENT_HANDLER_CAST(wxDropFilesEventFunction, func)
3447 #define wxInitDialogEventHandler(func) \
3448 wxEVENT_HANDLER_CAST(wxInitDialogEventFunction, func)
3449 #define wxSysColourChangedEventHandler(func) \
3450 wxEVENT_HANDLER_CAST(wxSysColourChangedEventFunction, func)
3451 #define wxDisplayChangedEventHandler(func) \
3452 wxEVENT_HANDLER_CAST(wxDisplayChangedEventFunction, func)
3453 #define wxUpdateUIEventHandler(func) \
3454 wxEVENT_HANDLER_CAST(wxUpdateUIEventFunction, func)
3455 #define wxCloseEventHandler(func) \
3456 wxEVENT_HANDLER_CAST(wxCloseEventFunction, func)
3457 #define wxShowEventHandler(func) \
3458 wxEVENT_HANDLER_CAST(wxShowEventFunction, func)
3459 #define wxIconizeEventHandler(func) \
3460 wxEVENT_HANDLER_CAST(wxIconizeEventFunction, func)
3461 #define wxMaximizeEventHandler(func) \
3462 wxEVENT_HANDLER_CAST(wxMaximizeEventFunction, func)
3463 #define wxNavigationKeyEventHandler(func) \
3464 wxEVENT_HANDLER_CAST(wxNavigationKeyEventFunction, func)
3465 #define wxPaletteChangedEventHandler(func) \
3466 wxEVENT_HANDLER_CAST(wxPaletteChangedEventFunction, func)
3467 #define wxQueryNewPaletteEventHandler(func) \
3468 wxEVENT_HANDLER_CAST(wxQueryNewPaletteEventFunction, func)
3469 #define wxWindowCreateEventHandler(func) \
3470 wxEVENT_HANDLER_CAST(wxWindowCreateEventFunction, func)
3471 #define wxWindowDestroyEventHandler(func) \
3472 wxEVENT_HANDLER_CAST(wxWindowDestroyEventFunction, func)
3473 #define wxSetCursorEventHandler(func) \
3474 wxEVENT_HANDLER_CAST(wxSetCursorEventFunction, func)
3475 #define wxNotifyEventHandler(func) \
3476 wxEVENT_HANDLER_CAST(wxNotifyEventFunction, func)
3477 #define wxHelpEventHandler(func) \
3478 wxEVENT_HANDLER_CAST(wxHelpEventFunction, func)
3479 #define wxContextMenuEventHandler(func) \
3480 wxEVENT_HANDLER_CAST(wxContextMenuEventFunction, func)
3481 #define wxMouseCaptureChangedEventHandler(func) \
3482 wxEVENT_HANDLER_CAST(wxMouseCaptureChangedEventFunction, func)
3483 #define wxMouseCaptureLostEventHandler(func) \
3484 wxEVENT_HANDLER_CAST(wxMouseCaptureLostEventFunction, func)
3485 #define wxClipboardTextEventHandler(func) \
3486 wxEVENT_HANDLER_CAST(wxClipboardTextEventFunction, func)
3490 // N.B. In GNU-WIN32, you *have* to take the address of a member function
3491 // (use &) or the compiler crashes...
3493 #define DECLARE_EVENT_TABLE() \
3495 static const wxEventTableEntry sm_eventTableEntries[]; \
3497 static const wxEventTable sm_eventTable; \
3498 virtual const wxEventTable* GetEventTable() const; \
3499 static wxEventHashTable sm_eventHashTable; \
3500 virtual wxEventHashTable& GetEventHashTable() const;
3502 // N.B.: when building DLL with Borland C++ 5.5 compiler, you must initialize
3503 // sm_eventTable before using it in GetEventTable() or the compiler gives
3504 // E2233 (see http://groups.google.com/groups?selm=397dcc8a%241_2%40dnews)
3506 #define BEGIN_EVENT_TABLE(theClass, baseClass) \
3507 const wxEventTable theClass::sm_eventTable = \
3508 { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] }; \
3509 const wxEventTable *theClass::GetEventTable() const \
3510 { return &theClass::sm_eventTable; } \
3511 wxEventHashTable theClass::sm_eventHashTable(theClass::sm_eventTable); \
3512 wxEventHashTable &theClass::GetEventHashTable() const \
3513 { return theClass::sm_eventHashTable; } \
3514 const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
3516 #define BEGIN_EVENT_TABLE_TEMPLATE1(theClass, baseClass, T1) \
3517 template<typename T1> \
3518 const wxEventTable theClass<T1>::sm_eventTable = \
3519 { &baseClass::sm_eventTable, &theClass<T1>::sm_eventTableEntries[0] }; \
3520 template<typename T1> \
3521 const wxEventTable *theClass<T1>::GetEventTable() const \
3522 { return &theClass<T1>::sm_eventTable; } \
3523 template<typename T1> \
3524 wxEventHashTable theClass<T1>::sm_eventHashTable(theClass<T1>::sm_eventTable); \
3525 template<typename T1> \
3526 wxEventHashTable &theClass<T1>::GetEventHashTable() const \
3527 { return theClass<T1>::sm_eventHashTable; } \
3528 template<typename T1> \
3529 const wxEventTableEntry theClass<T1>::sm_eventTableEntries[] = { \
3531 #define BEGIN_EVENT_TABLE_TEMPLATE2(theClass, baseClass, T1, T2) \
3532 template<typename T1, typename T2> \
3533 const wxEventTable theClass<T1, T2>::sm_eventTable = \
3534 { &baseClass::sm_eventTable, &theClass<T1, T2>::sm_eventTableEntries[0] }; \
3535 template<typename T1, typename T2> \
3536 const wxEventTable *theClass<T1, T2>::GetEventTable() const \
3537 { return &theClass<T1, T2>::sm_eventTable; } \
3538 template<typename T1, typename T2> \
3539 wxEventHashTable theClass<T1, T2>::sm_eventHashTable(theClass<T1, T2>::sm_eventTable); \
3540 template<typename T1, typename T2> \
3541 wxEventHashTable &theClass<T1, T2>::GetEventHashTable() const \
3542 { return theClass<T1, T2>::sm_eventHashTable; } \
3543 template<typename T1, typename T2> \
3544 const wxEventTableEntry theClass<T1, T2>::sm_eventTableEntries[] = { \
3546 #define BEGIN_EVENT_TABLE_TEMPLATE3(theClass, baseClass, T1, T2, T3) \
3547 template<typename T1, typename T2, typename T3> \
3548 const wxEventTable theClass<T1, T2, T3>::sm_eventTable = \
3549 { &baseClass::sm_eventTable, &theClass<T1, T2, T3>::sm_eventTableEntries[0] }; \
3550 template<typename T1, typename T2, typename T3> \
3551 const wxEventTable *theClass<T1, T2, T3>::GetEventTable() const \
3552 { return &theClass<T1, T2, T3>::sm_eventTable; } \
3553 template<typename T1, typename T2, typename T3> \
3554 wxEventHashTable theClass<T1, T2, T3>::sm_eventHashTable(theClass<T1, T2, T3>::sm_eventTable); \
3555 template<typename T1, typename T2, typename T3> \
3556 wxEventHashTable &theClass<T1, T2, T3>::GetEventHashTable() const \
3557 { return theClass<T1, T2, T3>::sm_eventHashTable; } \
3558 template<typename T1, typename T2, typename T3> \
3559 const wxEventTableEntry theClass<T1, T2, T3>::sm_eventTableEntries[] = { \
3561 #define BEGIN_EVENT_TABLE_TEMPLATE4(theClass, baseClass, T1, T2, T3, T4) \
3562 template<typename T1, typename T2, typename T3, typename T4> \
3563 const wxEventTable theClass<T1, T2, T3, T4>::sm_eventTable = \
3564 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4>::sm_eventTableEntries[0] }; \
3565 template<typename T1, typename T2, typename T3, typename T4> \
3566 const wxEventTable *theClass<T1, T2, T3, T4>::GetEventTable() const \
3567 { return &theClass<T1, T2, T3, T4>::sm_eventTable; } \
3568 template<typename T1, typename T2, typename T3, typename T4> \
3569 wxEventHashTable theClass<T1, T2, T3, T4>::sm_eventHashTable(theClass<T1, T2, T3, T4>::sm_eventTable); \
3570 template<typename T1, typename T2, typename T3, typename T4> \
3571 wxEventHashTable &theClass<T1, T2, T3, T4>::GetEventHashTable() const \
3572 { return theClass<T1, T2, T3, T4>::sm_eventHashTable; } \
3573 template<typename T1, typename T2, typename T3, typename T4> \
3574 const wxEventTableEntry theClass<T1, T2, T3, T4>::sm_eventTableEntries[] = { \
3576 #define BEGIN_EVENT_TABLE_TEMPLATE5(theClass, baseClass, T1, T2, T3, T4, T5) \
3577 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3578 const wxEventTable theClass<T1, T2, T3, T4, T5>::sm_eventTable = \
3579 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[0] }; \
3580 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3581 const wxEventTable *theClass<T1, T2, T3, T4, T5>::GetEventTable() const \
3582 { return &theClass<T1, T2, T3, T4, T5>::sm_eventTable; } \
3583 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3584 wxEventHashTable theClass<T1, T2, T3, T4, T5>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5>::sm_eventTable); \
3585 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3586 wxEventHashTable &theClass<T1, T2, T3, T4, T5>::GetEventHashTable() const \
3587 { return theClass<T1, T2, T3, T4, T5>::sm_eventHashTable; } \
3588 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3589 const wxEventTableEntry theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[] = { \
3591 #define BEGIN_EVENT_TABLE_TEMPLATE7(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7) \
3592 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3593 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable = \
3594 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[0] }; \
3595 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3596 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventTable() const \
3597 { return &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable; } \
3598 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3599 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable); \
3600 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3601 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventHashTable() const \
3602 { return theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable; } \
3603 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3604 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[] = { \
3606 #define BEGIN_EVENT_TABLE_TEMPLATE8(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7, T8) \
3607 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3608 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable = \
3609 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[0] }; \
3610 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3611 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventTable() const \
3612 { return &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable; } \
3613 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3614 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable); \
3615 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3616 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventHashTable() const \
3617 { return theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable; } \
3618 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3619 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[] = { \
3621 #define END_EVENT_TABLE() DECLARE_EVENT_TABLE_TERMINATOR() };
3624 * Event table macros
3627 // helpers for writing shorter code below: declare an event macro taking 2, 1
3628 // or none ids (the missing ids default to wxID_ANY)
3631 // - evt one of wxEVT_XXX constants
3632 // - id1, id2 ids of the first/last id
3633 // - fn the function (should be cast to the right type)
3634 #define wx__DECLARE_EVT2(evt, id1, id2, fn) \
3635 DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
3636 #define wx__DECLARE_EVT1(evt, id, fn) \
3637 wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
3638 #define wx__DECLARE_EVT0(evt, fn) \
3639 wx__DECLARE_EVT1(evt, wxID_ANY, fn)
3643 #define EVT_CUSTOM(event, winid, func) \
3644 wx__DECLARE_EVT1(event, winid, wxEventHandler(func))
3645 #define EVT_CUSTOM_RANGE(event, id1, id2, func) \
3646 wx__DECLARE_EVT2(event, id1, id2, wxEventHandler(func))
3649 #define EVT_COMMAND(winid, event, func) \
3650 wx__DECLARE_EVT1(event, winid, wxCommandEventHandler(func))
3652 #define EVT_COMMAND_RANGE(id1, id2, event, func) \
3653 wx__DECLARE_EVT2(event, id1, id2, wxCommandEventHandler(func))
3655 #define EVT_NOTIFY(event, winid, func) \
3656 wx__DECLARE_EVT1(event, winid, wxNotifyEventHandler(func))
3658 #define EVT_NOTIFY_RANGE(event, id1, id2, func) \
3659 wx__DECLARE_EVT2(event, id1, id2, wxNotifyEventHandler(func))
3662 #define EVT_SIZE(func) wx__DECLARE_EVT0(wxEVT_SIZE, wxSizeEventHandler(func))
3663 #define EVT_SIZING(func) wx__DECLARE_EVT0(wxEVT_SIZING, wxSizeEventHandler(func))
3664 #define EVT_MOVE(func) wx__DECLARE_EVT0(wxEVT_MOVE, wxMoveEventHandler(func))
3665 #define EVT_MOVING(func) wx__DECLARE_EVT0(wxEVT_MOVING, wxMoveEventHandler(func))
3666 #define EVT_MOVE_START(func) wx__DECLARE_EVT0(wxEVT_MOVE_START, wxMoveEventHandler(func))
3667 #define EVT_MOVE_END(func) wx__DECLARE_EVT0(wxEVT_MOVE_END, wxMoveEventHandler(func))
3668 #define EVT_CLOSE(func) wx__DECLARE_EVT0(wxEVT_CLOSE_WINDOW, wxCloseEventHandler(func))
3669 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3670 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3671 #define EVT_PAINT(func) wx__DECLARE_EVT0(wxEVT_PAINT, wxPaintEventHandler(func))
3672 #define EVT_NC_PAINT(func) wx__DECLARE_EVT0(wxEVT_NC_PAINT, wxNcPaintEventHandler(func))
3673 #define EVT_ERASE_BACKGROUND(func) wx__DECLARE_EVT0(wxEVT_ERASE_BACKGROUND, wxEraseEventHandler(func))
3674 #define EVT_CHAR(func) wx__DECLARE_EVT0(wxEVT_CHAR, wxCharEventHandler(func))
3675 #define EVT_KEY_DOWN(func) wx__DECLARE_EVT0(wxEVT_KEY_DOWN, wxKeyEventHandler(func))
3676 #define EVT_KEY_UP(func) wx__DECLARE_EVT0(wxEVT_KEY_UP, wxKeyEventHandler(func))
3678 #define EVT_HOTKEY(winid, func) wx__DECLARE_EVT1(wxEVT_HOTKEY, winid, wxCharEventHandler(func))
3680 #define EVT_CHAR_HOOK(func) wx__DECLARE_EVT0(wxEVT_CHAR_HOOK, wxCharEventHandler(func))
3681 #define EVT_MENU_OPEN(func) wx__DECLARE_EVT0(wxEVT_MENU_OPEN, wxMenuEventHandler(func))
3682 #define EVT_MENU_CLOSE(func) wx__DECLARE_EVT0(wxEVT_MENU_CLOSE, wxMenuEventHandler(func))
3683 #define EVT_MENU_HIGHLIGHT(winid, func) wx__DECLARE_EVT1(wxEVT_MENU_HIGHLIGHT, winid, wxMenuEventHandler(func))
3684 #define EVT_MENU_HIGHLIGHT_ALL(func) wx__DECLARE_EVT0(wxEVT_MENU_HIGHLIGHT, wxMenuEventHandler(func))
3685 #define EVT_SET_FOCUS(func) wx__DECLARE_EVT0(wxEVT_SET_FOCUS, wxFocusEventHandler(func))
3686 #define EVT_KILL_FOCUS(func) wx__DECLARE_EVT0(wxEVT_KILL_FOCUS, wxFocusEventHandler(func))
3687 #define EVT_CHILD_FOCUS(func) wx__DECLARE_EVT0(wxEVT_CHILD_FOCUS, wxChildFocusEventHandler(func))
3688 #define EVT_ACTIVATE(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE, wxActivateEventHandler(func))
3689 #define EVT_ACTIVATE_APP(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE_APP, wxActivateEventHandler(func))
3690 #define EVT_HIBERNATE(func) wx__DECLARE_EVT0(wxEVT_HIBERNATE, wxActivateEventHandler(func))
3691 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3692 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3693 #define EVT_DROP_FILES(func) wx__DECLARE_EVT0(wxEVT_DROP_FILES, wxDropFilesEventHandler(func))
3694 #define EVT_INIT_DIALOG(func) wx__DECLARE_EVT0(wxEVT_INIT_DIALOG, wxInitDialogEventHandler(func))
3695 #define EVT_SYS_COLOUR_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEventHandler(func))
3696 #define EVT_DISPLAY_CHANGED(func) wx__DECLARE_EVT0(wxEVT_DISPLAY_CHANGED, wxDisplayChangedEventHandler(func))
3697 #define EVT_SHOW(func) wx__DECLARE_EVT0(wxEVT_SHOW, wxShowEventHandler(func))
3698 #define EVT_MAXIMIZE(func) wx__DECLARE_EVT0(wxEVT_MAXIMIZE, wxMaximizeEventHandler(func))
3699 #define EVT_ICONIZE(func) wx__DECLARE_EVT0(wxEVT_ICONIZE, wxIconizeEventHandler(func))
3700 #define EVT_NAVIGATION_KEY(func) wx__DECLARE_EVT0(wxEVT_NAVIGATION_KEY, wxNavigationKeyEventHandler(func))
3701 #define EVT_PALETTE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_PALETTE_CHANGED, wxPaletteChangedEventHandler(func))
3702 #define EVT_QUERY_NEW_PALETTE(func) wx__DECLARE_EVT0(wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEventHandler(func))
3703 #define EVT_WINDOW_CREATE(func) wx__DECLARE_EVT0(wxEVT_CREATE, wxWindowCreateEventHandler(func))
3704 #define EVT_WINDOW_DESTROY(func) wx__DECLARE_EVT0(wxEVT_DESTROY, wxWindowDestroyEventHandler(func))
3705 #define EVT_SET_CURSOR(func) wx__DECLARE_EVT0(wxEVT_SET_CURSOR, wxSetCursorEventHandler(func))
3706 #define EVT_MOUSE_CAPTURE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEventHandler(func))
3707 #define EVT_MOUSE_CAPTURE_LOST(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEventHandler(func))
3710 #define EVT_LEFT_DOWN(func) wx__DECLARE_EVT0(wxEVT_LEFT_DOWN, wxMouseEventHandler(func))
3711 #define EVT_LEFT_UP(func) wx__DECLARE_EVT0(wxEVT_LEFT_UP, wxMouseEventHandler(func))
3712 #define EVT_MIDDLE_DOWN(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DOWN, wxMouseEventHandler(func))
3713 #define EVT_MIDDLE_UP(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_UP, wxMouseEventHandler(func))
3714 #define EVT_RIGHT_DOWN(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DOWN, wxMouseEventHandler(func))
3715 #define EVT_RIGHT_UP(func) wx__DECLARE_EVT0(wxEVT_RIGHT_UP, wxMouseEventHandler(func))
3716 #define EVT_MOTION(func) wx__DECLARE_EVT0(wxEVT_MOTION, wxMouseEventHandler(func))
3717 #define EVT_LEFT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_LEFT_DCLICK, wxMouseEventHandler(func))
3718 #define EVT_MIDDLE_DCLICK(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DCLICK, wxMouseEventHandler(func))
3719 #define EVT_RIGHT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DCLICK, wxMouseEventHandler(func))
3720 #define EVT_LEAVE_WINDOW(func) wx__DECLARE_EVT0(wxEVT_LEAVE_WINDOW, wxMouseEventHandler(func))
3721 #define EVT_ENTER_WINDOW(func) wx__DECLARE_EVT0(wxEVT_ENTER_WINDOW, wxMouseEventHandler(func))
3722 #define EVT_MOUSEWHEEL(func) wx__DECLARE_EVT0(wxEVT_MOUSEWHEEL, wxMouseEventHandler(func))
3723 #define EVT_MOUSE_AUX1_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX1_DOWN, wxMouseEventHandler(func))
3724 #define EVT_MOUSE_AUX1_UP(func) wx__DECLARE_EVT0(wxEVT_AUX1_UP, wxMouseEventHandler(func))
3725 #define EVT_MOUSE_AUX1_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX1_DCLICK, wxMouseEventHandler(func))
3726 #define EVT_MOUSE_AUX2_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX2_DOWN, wxMouseEventHandler(func))
3727 #define EVT_MOUSE_AUX2_UP(func) wx__DECLARE_EVT0(wxEVT_AUX2_UP, wxMouseEventHandler(func))
3728 #define EVT_MOUSE_AUX2_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX2_DCLICK, wxMouseEventHandler(func))
3731 #define EVT_MOUSE_EVENTS(func) \
3732 EVT_LEFT_DOWN(func) \
3734 EVT_LEFT_DCLICK(func) \
3735 EVT_MIDDLE_DOWN(func) \
3736 EVT_MIDDLE_UP(func) \
3737 EVT_MIDDLE_DCLICK(func) \
3738 EVT_RIGHT_DOWN(func) \
3739 EVT_RIGHT_UP(func) \
3740 EVT_RIGHT_DCLICK(func) \
3741 EVT_MOUSE_AUX1_DOWN(func) \
3742 EVT_MOUSE_AUX1_UP(func) \
3743 EVT_MOUSE_AUX1_DCLICK(func) \
3744 EVT_MOUSE_AUX2_DOWN(func) \
3745 EVT_MOUSE_AUX2_UP(func) \
3746 EVT_MOUSE_AUX2_DCLICK(func) \
3748 EVT_LEAVE_WINDOW(func) \
3749 EVT_ENTER_WINDOW(func) \
3750 EVT_MOUSEWHEEL(func)
3752 // Scrolling from wxWindow (sent to wxScrolledWindow)
3753 #define EVT_SCROLLWIN_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_TOP, wxScrollWinEventHandler(func))
3754 #define EVT_SCROLLWIN_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEventHandler(func))
3755 #define EVT_SCROLLWIN_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEUP, wxScrollWinEventHandler(func))
3756 #define EVT_SCROLLWIN_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEventHandler(func))
3757 #define EVT_SCROLLWIN_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEventHandler(func))
3758 #define EVT_SCROLLWIN_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEventHandler(func))
3759 #define EVT_SCROLLWIN_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEventHandler(func))
3760 #define EVT_SCROLLWIN_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEventHandler(func))
3762 #define EVT_SCROLLWIN(func) \
3763 EVT_SCROLLWIN_TOP(func) \
3764 EVT_SCROLLWIN_BOTTOM(func) \
3765 EVT_SCROLLWIN_LINEUP(func) \
3766 EVT_SCROLLWIN_LINEDOWN(func) \
3767 EVT_SCROLLWIN_PAGEUP(func) \
3768 EVT_SCROLLWIN_PAGEDOWN(func) \
3769 EVT_SCROLLWIN_THUMBTRACK(func) \
3770 EVT_SCROLLWIN_THUMBRELEASE(func)
3772 // Scrolling from wxSlider and wxScrollBar
3773 #define EVT_SCROLL_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_TOP, wxScrollEventHandler(func))
3774 #define EVT_SCROLL_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLL_BOTTOM, wxScrollEventHandler(func))
3775 #define EVT_SCROLL_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEUP, wxScrollEventHandler(func))
3776 #define EVT_SCROLL_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEDOWN, wxScrollEventHandler(func))
3777 #define EVT_SCROLL_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEUP, wxScrollEventHandler(func))
3778 #define EVT_SCROLL_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler(func))
3779 #define EVT_SCROLL_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler(func))
3780 #define EVT_SCROLL_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBRELEASE, wxScrollEventHandler(func))
3781 #define EVT_SCROLL_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SCROLL_CHANGED, wxScrollEventHandler(func))
3783 #define EVT_SCROLL(func) \
3784 EVT_SCROLL_TOP(func) \
3785 EVT_SCROLL_BOTTOM(func) \
3786 EVT_SCROLL_LINEUP(func) \
3787 EVT_SCROLL_LINEDOWN(func) \
3788 EVT_SCROLL_PAGEUP(func) \
3789 EVT_SCROLL_PAGEDOWN(func) \
3790 EVT_SCROLL_THUMBTRACK(func) \
3791 EVT_SCROLL_THUMBRELEASE(func) \
3792 EVT_SCROLL_CHANGED(func)
3794 // Scrolling from wxSlider and wxScrollBar, with an id
3795 #define EVT_COMMAND_SCROLL_TOP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_TOP, winid, wxScrollEventHandler(func))
3796 #define EVT_COMMAND_SCROLL_BOTTOM(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_BOTTOM, winid, wxScrollEventHandler(func))
3797 #define EVT_COMMAND_SCROLL_LINEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEUP, winid, wxScrollEventHandler(func))
3798 #define EVT_COMMAND_SCROLL_LINEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEDOWN, winid, wxScrollEventHandler(func))
3799 #define EVT_COMMAND_SCROLL_PAGEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEUP, winid, wxScrollEventHandler(func))
3800 #define EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEDOWN, winid, wxScrollEventHandler(func))
3801 #define EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBTRACK, winid, wxScrollEventHandler(func))
3802 #define EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBRELEASE, winid, wxScrollEventHandler(func))
3803 #define EVT_COMMAND_SCROLL_CHANGED(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_CHANGED, winid, wxScrollEventHandler(func))
3805 #define EVT_COMMAND_SCROLL(winid, func) \
3806 EVT_COMMAND_SCROLL_TOP(winid, func) \
3807 EVT_COMMAND_SCROLL_BOTTOM(winid, func) \
3808 EVT_COMMAND_SCROLL_LINEUP(winid, func) \
3809 EVT_COMMAND_SCROLL_LINEDOWN(winid, func) \
3810 EVT_COMMAND_SCROLL_PAGEUP(winid, func) \
3811 EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) \
3812 EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) \
3813 EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) \
3814 EVT_COMMAND_SCROLL_CHANGED(winid, func)
3816 #if WXWIN_COMPATIBILITY_2_6
3817 // compatibility macros for the old name, deprecated in 2.8
3818 #define wxEVT_SCROLL_ENDSCROLL wxEVT_SCROLL_CHANGED
3819 #define EVT_COMMAND_SCROLL_ENDSCROLL EVT_COMMAND_SCROLL_CHANGED
3820 #define EVT_SCROLL_ENDSCROLL EVT_SCROLL_CHANGED
3821 #endif // WXWIN_COMPATIBILITY_2_6
3823 // Convenience macros for commonly-used commands
3824 #define EVT_CHECKBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKBOX_CLICKED, winid, wxCommandEventHandler(func))
3825 #define EVT_CHOICE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHOICE_SELECTED, winid, wxCommandEventHandler(func))
3826 #define EVT_LISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_SELECTED, winid, wxCommandEventHandler(func))
3827 #define EVT_LISTBOX_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, winid, wxCommandEventHandler(func))
3828 #define EVT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_MENU_SELECTED, winid, wxCommandEventHandler(func))
3829 #define EVT_MENU_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_MENU_SELECTED, id1, id2, wxCommandEventHandler(func))
3830 #if defined(__SMARTPHONE__)
3831 # define EVT_BUTTON(winid, func) EVT_MENU(winid, func)
3833 # define EVT_BUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_BUTTON_CLICKED, winid, wxCommandEventHandler(func))
3835 #define EVT_SLIDER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SLIDER_UPDATED, winid, wxCommandEventHandler(func))
3836 #define EVT_RADIOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBOX_SELECTED, winid, wxCommandEventHandler(func))
3837 #define EVT_RADIOBUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBUTTON_SELECTED, winid, wxCommandEventHandler(func))
3838 // EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events
3839 #define EVT_SCROLLBAR(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SCROLLBAR_UPDATED, winid, wxCommandEventHandler(func))
3840 #define EVT_VLBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_VLBOX_SELECTED, winid, wxCommandEventHandler(func))
3841 #define EVT_COMBOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_SELECTED, winid, wxCommandEventHandler(func))
3842 #define EVT_TOOL(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_CLICKED, winid, wxCommandEventHandler(func))
3843 #define EVT_TOOL_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, winid, wxCommandEventHandler(func))
3844 #define EVT_TOOL_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_CLICKED, id1, id2, wxCommandEventHandler(func))
3845 #define EVT_TOOL_RCLICKED(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_RCLICKED, winid, wxCommandEventHandler(func))
3846 #define EVT_TOOL_RCLICKED_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, wxCommandEventHandler(func))
3847 #define EVT_TOOL_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_ENTER, winid, wxCommandEventHandler(func))
3848 #define EVT_CHECKLISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, winid, wxCommandEventHandler(func))
3849 #define EVT_COMBOBOX_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_DROPDOWN, winid, wxCommandEventHandler(func))
3850 #define EVT_COMBOBOX_CLOSEUP(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_CLOSEUP, winid, wxCommandEventHandler(func))
3852 // Generic command events
3853 #define EVT_COMMAND_LEFT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_CLICK, winid, wxCommandEventHandler(func))
3854 #define EVT_COMMAND_LEFT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_DCLICK, winid, wxCommandEventHandler(func))
3855 #define EVT_COMMAND_RIGHT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_CLICK, winid, wxCommandEventHandler(func))
3856 #define EVT_COMMAND_RIGHT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_DCLICK, winid, wxCommandEventHandler(func))
3857 #define EVT_COMMAND_SET_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SET_FOCUS, winid, wxCommandEventHandler(func))
3858 #define EVT_COMMAND_KILL_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_KILL_FOCUS, winid, wxCommandEventHandler(func))
3859 #define EVT_COMMAND_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_ENTER, winid, wxCommandEventHandler(func))
3863 #define EVT_JOY_BUTTON_DOWN(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_DOWN, wxJoystickEventHandler(func))
3864 #define EVT_JOY_BUTTON_UP(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_UP, wxJoystickEventHandler(func))
3865 #define EVT_JOY_MOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_MOVE, wxJoystickEventHandler(func))
3866 #define EVT_JOY_ZMOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_ZMOVE, wxJoystickEventHandler(func))
3868 // All joystick events
3869 #define EVT_JOYSTICK_EVENTS(func) \
3870 EVT_JOY_BUTTON_DOWN(func) \
3871 EVT_JOY_BUTTON_UP(func) \
3872 EVT_JOY_MOVE(func) \
3876 #define EVT_IDLE(func) wx__DECLARE_EVT0(wxEVT_IDLE, wxIdleEventHandler(func))
3879 #define EVT_UPDATE_UI(winid, func) wx__DECLARE_EVT1(wxEVT_UPDATE_UI, winid, wxUpdateUIEventHandler(func))
3880 #define EVT_UPDATE_UI_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_UPDATE_UI, id1, id2, wxUpdateUIEventHandler(func))
3883 #define EVT_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_HELP, winid, wxHelpEventHandler(func))
3884 #define EVT_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_HELP, id1, id2, wxHelpEventHandler(func))
3885 #define EVT_DETAILED_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_DETAILED_HELP, winid, wxHelpEventHandler(func))
3886 #define EVT_DETAILED_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_DETAILED_HELP, id1, id2, wxHelpEventHandler(func))
3888 // Context Menu Events
3889 #define EVT_CONTEXT_MENU(func) wx__DECLARE_EVT0(wxEVT_CONTEXT_MENU, wxContextMenuEventHandler(func))
3890 #define EVT_COMMAND_CONTEXT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_CONTEXT_MENU, winid, wxContextMenuEventHandler(func))
3892 // Clipboard text Events
3893 #define EVT_TEXT_CUT(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_CUT, winid, wxClipboardTextEventHandler(func))
3894 #define EVT_TEXT_COPY(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_COPY, winid, wxClipboardTextEventHandler(func))
3895 #define EVT_TEXT_PASTE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_PASTE, winid, wxClipboardTextEventHandler(func))
3898 #define EVT_THREAD(id, func) wx__DECLARE_EVT1(wxEVT_COMMAND_THREAD, id, wxThreadEventHandler(func))
3900 // ----------------------------------------------------------------------------
3902 // ----------------------------------------------------------------------------
3904 // This is an ugly hack to allow the use of Bind() instead of Connect() inside
3905 // the library code if the library was built with support for it, here is how
3908 // class SomeEventHandlingClass : wxBIND_OR_CONNECT_HACK_BASE_CLASS
3909 // public SomeBaseClass
3912 // SomeEventHandlingClass(wxWindow *win)
3914 // // connect to the event for the given window
3915 // wxBIND_OR_CONNECT_HACK(win, wxEVT_SOMETHING, wxSomeEventHandler,
3916 // SomeEventHandlingClass::OnSomeEvent, this);
3920 // void OnSomeEvent(wxSomeEvent&) { ... }
3923 // This is *not* meant to be used by library users, it is only defined here
3924 // (and not in a private header) because the base class must be visible from
3925 // other public headers, please do NOT use this in your code, it will be
3926 // removed from future wx versions without warning.
3927 #ifdef wxHAS_EVENT_BIND
3928 #define wxBIND_OR_CONNECT_HACK_BASE_CLASS
3929 #define wxBIND_OR_CONNECT_HACK_ONLY_BASE_CLASS
3930 #define wxBIND_OR_CONNECT_HACK(w, evt, handler, func, obj) \
3931 win->Bind(evt, &func, obj)
3932 #else // wxHAS_EVENT_BIND
3933 #define wxBIND_OR_CONNECT_HACK_BASE_CLASS public wxEvtHandler,
3934 #define wxBIND_OR_CONNECT_HACK_ONLY_BASE_CLASS : public wxEvtHandler
3935 #define wxBIND_OR_CONNECT_HACK(w, evt, handler, func, obj) \
3936 win->Connect(evt, handler(func), NULL, obj)
3937 #endif // wxHAS_EVENT_BIND
3941 // Find a window with the focus, that is also a descendant of the given window.
3942 // This is used to determine the window to initially send commands to.
3943 WXDLLIMPEXP_CORE wxWindow
* wxFindFocusDescendant(wxWindow
* ancestor
);
3947 #endif // _WX_EVENT_H_