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"
29 #include "wx/typeinfo.h"
32 #ifdef wxHAS_EVENT_BIND
33 #include "wx/meta/convertible.h"
36 // ----------------------------------------------------------------------------
37 // forward declarations
38 // ----------------------------------------------------------------------------
40 class WXDLLIMPEXP_FWD_BASE wxList
;
41 class WXDLLIMPEXP_FWD_BASE wxEvent
;
43 class WXDLLIMPEXP_FWD_CORE wxDC
;
44 class WXDLLIMPEXP_FWD_CORE wxMenu
;
45 class WXDLLIMPEXP_FWD_CORE wxWindow
;
46 class WXDLLIMPEXP_FWD_CORE wxWindowBase
;
49 // We operate with pointer to members of wxEvtHandler (such functions are used
50 // as event handlers in the event tables or as arguments to Connect()) but by
51 // default MSVC uses a restricted (but more efficient) representation of
52 // pointers to members which can't deal with multiple base classes. To avoid
53 // mysterious (as the compiler is not good enough to detect this and give a
54 // sensible error message) errors in the user code as soon as it defines
55 // classes inheriting from both wxEvtHandler (possibly indirectly, e.g. via
56 // wxWindow) and something else (including our own wxTrackable but not limited
57 // to it), we use the special MSVC keyword telling the compiler to use a more
58 // general pointer to member representation for the classes inheriting from
61 #define wxMSVC_FWD_MULTIPLE_BASES __multiple_inheritance
63 #define wxMSVC_FWD_MULTIPLE_BASES
66 class WXDLLIMPEXP_FWD_BASE wxMSVC_FWD_MULTIPLE_BASES wxEvtHandler
;
67 class wxEventConnectionRef
;
69 // ----------------------------------------------------------------------------
71 // ----------------------------------------------------------------------------
73 typedef int wxEventType
;
75 #define wxEVT_ANY ((wxEventType)-1)
77 // this is used to make the event table entry type safe, so that for an event
78 // handler only a function with proper parameter list can be given. See also
79 // the wxEVENT_HANDLER_CAST-macro.
80 #define wxStaticCastEvent(type, val) static_cast<type>(val)
82 #define DECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj) \
83 wxEventTableEntry(type, winid, idLast, wxNewEventTableFunctor(type, fn), obj)
85 #define DECLARE_EVENT_TABLE_TERMINATOR() \
86 wxEventTableEntry(wxEVT_NULL, 0, 0, 0, 0)
88 // obsolete event declaration/definition macros, we don't need them any longer
89 // but we keep them for compatibility as it doesn't cost us anything anyhow
90 #define BEGIN_DECLARE_EVENT_TYPES()
91 #define END_DECLARE_EVENT_TYPES()
92 #define DECLARE_EXPORTED_EVENT_TYPE(expdecl, name, value) \
93 extern expdecl const wxEventType name;
94 #define DECLARE_EVENT_TYPE(name, value) \
95 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_CORE, name, value)
96 #define DECLARE_LOCAL_EVENT_TYPE(name, value) \
97 DECLARE_EXPORTED_EVENT_TYPE(wxEMPTY_PARAMETER_VALUE, name, value)
98 #define DEFINE_EVENT_TYPE(name) const wxEventType name = wxNewEventType();
99 #define DEFINE_LOCAL_EVENT_TYPE(name) DEFINE_EVENT_TYPE(name)
101 // generate a new unique event type
102 extern WXDLLIMPEXP_BASE wxEventType
wxNewEventType();
104 // define macros to create new event types:
105 #ifdef wxHAS_EVENT_BIND
106 // events are represented by an instance of wxEventTypeTag and the
107 // corresponding type must be specified for type-safety checks
109 // define a new custom event type, can be used alone or after event
110 // declaration in the header using one of the macros below
111 #define wxDEFINE_EVENT( name, type ) \
112 const wxEventTypeTag< type > name( wxNewEventType() )
114 // the general version allowing exporting the event type from DLL, used by
116 #define wxDECLARE_EXPORTED_EVENT( expdecl, name, type ) \
117 extern const expdecl wxEventTypeTag< type > name
119 // this is the version which will normally be used in the user code
120 #define wxDECLARE_EVENT( name, type ) \
121 wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type )
124 // these macros are only used internally for backwards compatibility and
125 // allow to define an alias for an existing event type (this is used by
127 #define wxDEFINE_EVENT_ALIAS( name, type, value ) \
128 const wxEventTypeTag< type > name( value )
130 #define wxDECLARE_EXPORTED_EVENT_ALIAS( expdecl, name, type ) \
131 extern const expdecl wxEventTypeTag< type > name
132 #else // !wxHAS_EVENT_BIND
133 // the macros are the same ones as above but defined differently as we only
134 // use the integer event type values to identify events in this case
136 #define wxDEFINE_EVENT( name, type ) \
137 const wxEventType name( wxNewEventType() )
139 #define wxDECLARE_EXPORTED_EVENT( expdecl, name, type ) \
140 extern const expdecl wxEventType name
141 #define wxDECLARE_EVENT( name, type ) \
142 wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type )
144 #define wxDEFINE_EVENT_ALIAS( name, type, value ) \
145 const wxEventType name = value
146 #define wxDECLARE_EXPORTED_EVENT_ALIAS( expdecl, name, type ) \
147 extern const expdecl wxEventType name
148 #endif // wxHAS_EVENT_BIND/!wxHAS_EVENT_BIND
150 // Try to cast the given event handler to the correct handler type:
152 #define wxEVENT_HANDLER_CAST( functype, func ) \
153 ( wxObjectEventFunction )( wxEventFunction )wxStaticCastEvent( functype, &func )
156 #ifdef wxHAS_EVENT_BIND
158 // The tag is a type associated to the event type (which is an integer itself,
159 // in spite of its name) value. It exists in order to be used as a template
160 // parameter and provide a mapping between the event type values and their
161 // corresponding wxEvent-derived classes.
162 template <typename T
>
166 // The class of wxEvent-derived class carried by the events of this type.
167 typedef T EventClass
;
169 wxEventTypeTag(wxEventType type
) { m_type
= type
; }
171 // Return a wxEventType reference for the initialization of the static
172 // event tables. See wxEventTableEntry::m_eventType for a more thorough
174 operator const wxEventType
&() const { return m_type
; }
180 #endif // wxHAS_EVENT_BIND
182 // These are needed for the functor definitions
183 typedef void (wxEvtHandler::*wxEventFunction
)(wxEvent
&);
185 // We had some trouble (specifically with eVC for ARM WinCE build) with using
186 // wxEventFunction in the past so we had introduced wxObjectEventFunction which
187 // used to be a typedef for a member of wxObject and not wxEvtHandler to work
188 // around this but as eVC is not really supported any longer we now only keep
189 // this for backwards compatibility and, despite its name, this is a typedef
190 // for wxEvtHandler member now -- but if we have the same problem with another
191 // compiler we can restore its old definition for it.
192 typedef wxEventFunction wxObjectEventFunction
;
194 // The event functor which is stored in the static and dynamic event tables:
195 class WXDLLIMPEXP_BASE wxEventFunctor
198 virtual ~wxEventFunctor();
200 // Invoke the actual event handler:
201 virtual void operator()(wxEvtHandler
*, wxEvent
&) = 0;
203 // this function tests whether this functor is matched, for the purpose of
204 // finding it in an event table in Unbind(), by the given functor:
205 virtual bool IsMatching(const wxEventFunctor
& functor
) const = 0;
207 // If the functor holds an wxEvtHandler, then get access to it and track
208 // its lifetime with wxEventConnectionRef:
209 virtual wxEvtHandler
*GetEvtHandler() const
212 // This is only used to maintain backward compatibility in
213 // wxAppConsoleBase::CallEventHandler and ensures that an overwritten
214 // wxAppConsoleBase::HandleEvent is still called for functors which hold an
216 virtual wxEventFunction
GetEvtMethod() const
220 WX_DECLARE_ABSTRACT_TYPEINFO(wxEventFunctor
)
223 // A plain method functor for the untyped legacy event types:
224 class WXDLLIMPEXP_BASE wxObjectEventFunctor
: public wxEventFunctor
227 wxObjectEventFunctor(wxObjectEventFunction method
, wxEvtHandler
*handler
)
228 : m_handler( handler
), m_method( method
)
231 virtual void operator()(wxEvtHandler
*handler
, wxEvent
& event
)
233 wxEvtHandler
* const realHandler
= m_handler
? m_handler
: handler
;
235 (realHandler
->*m_method
)(event
);
238 virtual bool IsMatching(const wxEventFunctor
& functor
) const
240 if ( wxTypeId(functor
) == wxTypeId(*this) )
242 const wxObjectEventFunctor
&other
=
243 static_cast< const wxObjectEventFunctor
& >( functor
);
245 // FIXME-VC6: amazing but true: replacing "method == NULL" here
246 // with "!method" makes VC6 crash with an ICE in DLL build (only!)
248 return ( m_method
== other
.m_method
|| other
.m_method
== NULL
) &&
249 ( m_handler
== other
.m_handler
|| other
.m_handler
== NULL
);
255 virtual wxEvtHandler
*GetEvtHandler() const
256 { return m_handler
; }
258 virtual wxEventFunction
GetEvtMethod() const
262 wxEvtHandler
*m_handler
;
263 wxEventFunction m_method
;
265 // Provide a dummy default ctor for type info purposes
266 wxObjectEventFunctor() { }
268 WX_DECLARE_TYPEINFO_INLINE(wxObjectEventFunctor
)
271 // Create a functor for the legacy events: used by Connect()
272 inline wxObjectEventFunctor
*
273 wxNewEventFunctor(const wxEventType
& WXUNUSED(evtType
),
274 wxObjectEventFunction method
,
275 wxEvtHandler
*handler
)
277 return new wxObjectEventFunctor(method
, handler
);
280 // This version is used by DECLARE_EVENT_TABLE_ENTRY()
281 inline wxObjectEventFunctor
*
282 wxNewEventTableFunctor(const wxEventType
& WXUNUSED(evtType
),
283 wxObjectEventFunction method
)
285 return new wxObjectEventFunctor(method
, NULL
);
288 inline wxObjectEventFunctor
289 wxMakeEventFunctor(const wxEventType
& WXUNUSED(evtType
),
290 wxObjectEventFunction method
,
291 wxEvtHandler
*handler
)
293 return wxObjectEventFunctor(method
, handler
);
296 #ifdef wxHAS_EVENT_BIND
301 // helper template defining nested "type" typedef as the event class
302 // corresponding to the given event type
303 template <typename T
> struct EventClassOf
;
305 // the typed events provide the information about the class of the events they
307 template <typename T
>
308 struct EventClassOf
< wxEventTypeTag
<T
> >
310 typedef typename wxEventTypeTag
<T
>::EventClass type
;
313 // for the old untyped events we don't have information about the exact event
314 // class carried by them
316 struct EventClassOf
<wxEventType
>
318 typedef wxEvent type
;
322 // helper class defining operations different for method functors using an
323 // object of wxEvtHandler-derived class as handler and the others
324 template <typename T
, typename A
, bool> struct HandlerImpl
;
326 // specialization for handlers deriving from wxEvtHandler
327 template <typename T
, typename A
>
328 struct HandlerImpl
<T
, A
, true>
330 static bool IsEvtHandler()
332 static T
*ConvertFromEvtHandler(wxEvtHandler
*p
)
333 { return static_cast<T
*>(p
); }
334 static wxEvtHandler
*ConvertToEvtHandler(T
*p
)
336 static wxEventFunction
ConvertToEvtMethod(void (T::*f
)(A
&))
337 { return static_cast<wxEventFunction
>(
338 reinterpret_cast<void (T::*)(wxEvent
&)>(f
)); }
341 // specialization for handlers not deriving from wxEvtHandler
342 template <typename T
, typename A
>
343 struct HandlerImpl
<T
, A
, false>
345 static bool IsEvtHandler()
347 static T
*ConvertFromEvtHandler(wxEvtHandler
*)
349 static wxEvtHandler
*ConvertToEvtHandler(T
*)
351 static wxEventFunction
ConvertToEvtMethod(void (T::*)(A
&))
355 } // namespace wxPrivate
357 // functor forwarding the event to a method of the given object
359 // notice that the object class may be different from the class in which the
360 // method is defined but it must be convertible to this class
362 // also, the type of the handler parameter doesn't need to be exactly the same
363 // as EventTag::EventClass but it must be its base class -- this is explicitly
364 // allowed to handle different events in the same handler taking wxEvent&, for
367 <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
368 class wxEventFunctorMethod
369 : public wxEventFunctor
,
370 private wxPrivate::HandlerImpl
374 wxConvertibleTo
<Class
, wxEvtHandler
>::value
!= 0
378 static void CheckHandlerArgument(EventArg
*) { }
381 // the event class associated with the given event tag
382 typedef typename
wxPrivate::EventClassOf
<EventTag
>::type EventClass
;
385 wxEventFunctorMethod(void (Class::*method
)(EventArg
&), EventHandler
*handler
)
386 : m_handler( handler
), m_method( method
)
388 wxASSERT_MSG( handler
|| this->IsEvtHandler(),
389 "handlers defined in non-wxEvtHandler-derived classes "
390 "must be connected with a valid sink object" );
392 // if you get an error here it means that the signature of the handler
393 // you're trying to use is not compatible with (i.e. is not the same as
394 // or a base class of) the real event class used for this event type
395 CheckHandlerArgument(static_cast<EventClass
*>(NULL
));
398 virtual void operator()(wxEvtHandler
*handler
, wxEvent
& event
)
400 Class
* realHandler
= m_handler
;
403 realHandler
= this->ConvertFromEvtHandler(handler
);
405 // this is not supposed to happen but check for it nevertheless
406 wxCHECK_RET( realHandler
, "invalid event handler" );
409 // the real (run-time) type of event is EventClass and we checked in
410 // the ctor that EventClass can be converted to EventArg, so this cast
412 (realHandler
->*m_method
)(static_cast<EventArg
&>(event
));
415 virtual bool IsMatching(const wxEventFunctor
& functor
) const
417 if ( wxTypeId(functor
) != wxTypeId(*this) )
420 typedef wxEventFunctorMethod
<EventTag
, Class
, EventArg
, EventHandler
>
423 // the cast is valid because wxTypeId()s matched above
424 const ThisFunctor
& other
= static_cast<const ThisFunctor
&>(functor
);
426 return (m_method
== other
.m_method
|| other
.m_method
== NULL
) &&
427 (m_handler
== other
.m_handler
|| other
.m_handler
== NULL
);
430 virtual wxEvtHandler
*GetEvtHandler() const
431 { return this->ConvertToEvtHandler(m_handler
); }
433 virtual wxEventFunction
GetEvtMethod() const
434 { return this->ConvertToEvtMethod(m_method
); }
437 EventHandler
*m_handler
;
438 void (Class::*m_method
)(EventArg
&);
440 // Provide a dummy default ctor for type info purposes
441 wxEventFunctorMethod() { }
443 typedef wxEventFunctorMethod
<EventTag
, Class
,
444 EventArg
, EventHandler
> thisClass
;
445 WX_DECLARE_TYPEINFO_INLINE(thisClass
)
449 // functor forwarding the event to function (function, static method)
450 template <typename EventTag
, typename EventArg
>
451 class wxEventFunctorFunction
: public wxEventFunctor
454 static void CheckHandlerArgument(EventArg
*) { }
457 // the event class associated with the given event tag
458 typedef typename
wxPrivate::EventClassOf
<EventTag
>::type EventClass
;
460 wxEventFunctorFunction( void ( *handler
)( EventArg
& ))
461 : m_handler( handler
)
463 // if you get an error here it means that the signature of the handler
464 // you're trying to use is not compatible with (i.e. is not the same as
465 // or a base class of) the real event class used for this event type
466 CheckHandlerArgument(static_cast<EventClass
*>(NULL
));
469 virtual void operator()(wxEvtHandler
*WXUNUSED(handler
), wxEvent
& event
)
471 // If you get an error here like "must use .* or ->* to call
472 // pointer-to-member function" then you probably tried to call
473 // Bind/Unbind with a method pointer but without a handler pointer or
474 // NULL as a handler e.g.:
475 // Unbind( wxEVT_XXX, &EventHandler::method );
477 // Unbind( wxEVT_XXX, &EventHandler::method, NULL )
478 m_handler(static_cast<EventArg
&>(event
));
481 virtual bool IsMatching(const wxEventFunctor
&functor
) const
483 if ( wxTypeId(functor
) != wxTypeId(*this) )
486 typedef wxEventFunctorFunction
<EventTag
, EventArg
> ThisFunctor
;
488 const ThisFunctor
& other
= static_cast<const ThisFunctor
&>( functor
);
490 return m_handler
== other
.m_handler
;
494 void (*m_handler
)(EventArg
&);
496 // Provide a dummy default ctor for type info purposes
497 wxEventFunctorFunction() { }
499 typedef wxEventFunctorFunction
<EventTag
, EventArg
> thisClass
;
500 WX_DECLARE_TYPEINFO_INLINE(thisClass
)
504 template <typename EventTag
, typename Functor
>
505 class wxEventFunctorFunctor
: public wxEventFunctor
508 typedef typename
EventTag::EventClass EventArg
;
510 wxEventFunctorFunctor(const Functor
& handler
)
511 : m_handler(handler
), m_handlerAddr(&handler
)
514 virtual void operator()(wxEvtHandler
*WXUNUSED(handler
), wxEvent
& event
)
516 // If you get an error here like "must use '.*' or '->*' to call
517 // pointer-to-member function" then you probably tried to call
518 // Bind/Unbind with a method pointer but without a handler pointer or
519 // NULL as a handler e.g.:
520 // Unbind( wxEVT_XXX, &EventHandler::method );
522 // Unbind( wxEVT_XXX, &EventHandler::method, NULL )
523 m_handler(static_cast<EventArg
&>(event
));
526 virtual bool IsMatching(const wxEventFunctor
&functor
) const
528 if ( wxTypeId(functor
) != wxTypeId(*this) )
531 typedef wxEventFunctorFunctor
<EventTag
, Functor
> FunctorThis
;
533 const FunctorThis
& other
= static_cast<const FunctorThis
&>(functor
);
535 // The only reliable/portable way to compare two functors is by
537 return m_handlerAddr
== other
.m_handlerAddr
;
541 // Store a copy of the functor to prevent using/calling an already
542 // destroyed instance:
545 // Use the address of the original functor for comparison in IsMatching:
546 const void *m_handlerAddr
;
548 // Provide a dummy default ctor for type info purposes
549 wxEventFunctorFunctor() { }
551 typedef wxEventFunctorFunctor
<EventTag
, Functor
> thisClass
;
552 WX_DECLARE_TYPEINFO_INLINE(thisClass
)
555 // Create functors for the templatized events, either allocated on the heap for
556 // wxNewXXX() variants (this is needed in wxEvtHandler::Bind<>() to store them
557 // in dynamic event table) or just by returning them as temporary objects (this
558 // is enough for Unbind<>() and we avoid unnecessary heap allocation like this).
561 // Create functors wrapping functions:
562 template <typename EventTag
, typename EventArg
>
563 inline wxEventFunctorFunction
<EventTag
, EventArg
> *
564 wxNewEventFunctor(const EventTag
&, void (*func
)(EventArg
&))
566 return new wxEventFunctorFunction
<EventTag
, EventArg
>(func
);
569 template <typename EventTag
, typename EventArg
>
570 inline wxEventFunctorFunction
<EventTag
, EventArg
>
571 wxMakeEventFunctor(const EventTag
&, void (*func
)(EventArg
&))
573 return wxEventFunctorFunction
<EventTag
, EventArg
>(func
);
576 // Create functors wrapping other functors:
577 template <typename EventTag
, typename Functor
>
578 inline wxEventFunctorFunctor
<EventTag
, Functor
> *
579 wxNewEventFunctor(const EventTag
&, const Functor
&func
)
581 return new wxEventFunctorFunctor
<EventTag
, Functor
>(func
);
584 template <typename EventTag
, typename Functor
>
585 inline wxEventFunctorFunctor
<EventTag
, Functor
>
586 wxMakeEventFunctor(const EventTag
&, const Functor
&func
)
588 return wxEventFunctorFunctor
<EventTag
, Functor
>(func
);
591 // Create functors wrapping methods:
593 <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
594 inline wxEventFunctorMethod
<EventTag
, Class
, EventArg
, EventHandler
> *
595 wxNewEventFunctor(const EventTag
&,
596 void (Class::*method
)(EventArg
&),
597 EventHandler
*handler
)
599 return new wxEventFunctorMethod
<EventTag
, Class
, EventArg
, EventHandler
>(
604 <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
605 inline wxEventFunctorMethod
<EventTag
, Class
, EventArg
, EventHandler
>
606 wxMakeEventFunctor(const EventTag
&,
607 void (Class::*method
)(EventArg
&),
608 EventHandler
*handler
)
610 return wxEventFunctorMethod
<EventTag
, Class
, EventArg
, EventHandler
>(
614 // Create an event functor for the event table via DECLARE_EVENT_TABLE_ENTRY:
615 // in this case we don't have the handler (as it's always the same as the
616 // object which generated the event) so we must use Class as its type
617 template <typename EventTag
, typename Class
, typename EventArg
>
618 inline wxEventFunctorMethod
<EventTag
, Class
, EventArg
, Class
> *
619 wxNewEventTableFunctor(const EventTag
&, void (Class::*method
)(EventArg
&))
621 return new wxEventFunctorMethod
<EventTag
, Class
, EventArg
, Class
>(
625 #endif // wxHAS_EVENT_BIND
628 // many, but not all, standard event types
630 // some generic events
631 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_NULL
;
632 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_FIRST
;
633 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_USER_FIRST
;
635 // Need events declared to do this
636 class WXDLLIMPEXP_FWD_CORE wxCommandEvent
;
637 class WXDLLIMPEXP_FWD_CORE wxThreadEvent
;
638 class WXDLLIMPEXP_FWD_CORE wxMouseEvent
;
639 class WXDLLIMPEXP_FWD_CORE wxFocusEvent
;
640 class WXDLLIMPEXP_FWD_CORE wxChildFocusEvent
;
641 class WXDLLIMPEXP_FWD_CORE wxKeyEvent
;
642 class WXDLLIMPEXP_FWD_CORE wxNavigationKeyEvent
;
643 class WXDLLIMPEXP_FWD_CORE wxSetCursorEvent
;
644 class WXDLLIMPEXP_FWD_CORE wxScrollEvent
;
645 class WXDLLIMPEXP_FWD_CORE wxSpinEvent
;
646 class WXDLLIMPEXP_FWD_CORE wxScrollWinEvent
;
647 class WXDLLIMPEXP_FWD_CORE wxSizeEvent
;
648 class WXDLLIMPEXP_FWD_CORE wxMoveEvent
;
649 class WXDLLIMPEXP_FWD_CORE wxCloseEvent
;
650 class WXDLLIMPEXP_FWD_CORE wxActivateEvent
;
651 class WXDLLIMPEXP_FWD_CORE wxWindowCreateEvent
;
652 class WXDLLIMPEXP_FWD_CORE wxWindowDestroyEvent
;
653 class WXDLLIMPEXP_FWD_CORE wxShowEvent
;
654 class WXDLLIMPEXP_FWD_CORE wxIconizeEvent
;
655 class WXDLLIMPEXP_FWD_CORE wxMaximizeEvent
;
656 class WXDLLIMPEXP_FWD_CORE wxMouseCaptureChangedEvent
;
657 class WXDLLIMPEXP_FWD_CORE wxMouseCaptureLostEvent
;
658 class WXDLLIMPEXP_FWD_CORE wxPaintEvent
;
659 class WXDLLIMPEXP_FWD_CORE wxEraseEvent
;
660 class WXDLLIMPEXP_FWD_CORE wxNcPaintEvent
;
661 class WXDLLIMPEXP_FWD_CORE wxMenuEvent
;
662 class WXDLLIMPEXP_FWD_CORE wxContextMenuEvent
;
663 class WXDLLIMPEXP_FWD_CORE wxSysColourChangedEvent
;
664 class WXDLLIMPEXP_FWD_CORE wxDisplayChangedEvent
;
665 class WXDLLIMPEXP_FWD_CORE wxQueryNewPaletteEvent
;
666 class WXDLLIMPEXP_FWD_CORE wxPaletteChangedEvent
;
667 class WXDLLIMPEXP_FWD_CORE wxJoystickEvent
;
668 class WXDLLIMPEXP_FWD_CORE wxDropFilesEvent
;
669 class WXDLLIMPEXP_FWD_CORE wxInitDialogEvent
;
670 class WXDLLIMPEXP_FWD_CORE wxIdleEvent
;
671 class WXDLLIMPEXP_FWD_CORE wxUpdateUIEvent
;
672 class WXDLLIMPEXP_FWD_CORE wxClipboardTextEvent
;
673 class WXDLLIMPEXP_FWD_CORE wxHelpEvent
;
677 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_BUTTON_CLICKED
, wxCommandEvent
);
678 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHECKBOX_CLICKED
, wxCommandEvent
);
679 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHOICE_SELECTED
, wxCommandEvent
);
680 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LISTBOX_SELECTED
, wxCommandEvent
);
681 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
, wxCommandEvent
);
682 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
, wxCommandEvent
);
683 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_MENU_SELECTED
, wxCommandEvent
);
684 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SLIDER_UPDATED
, wxCommandEvent
);
685 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RADIOBOX_SELECTED
, wxCommandEvent
);
686 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RADIOBUTTON_SELECTED
, wxCommandEvent
);
688 // wxEVT_COMMAND_SCROLLBAR_UPDATED is deprecated, use wxEVT_SCROLL... events
689 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SCROLLBAR_UPDATED
, wxCommandEvent
);
690 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_VLBOX_SELECTED
, wxCommandEvent
);
691 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_COMBOBOX_SELECTED
, wxCommandEvent
);
692 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_RCLICKED
, wxCommandEvent
);
693 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED
, wxCommandEvent
);
694 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_ENTER
, wxCommandEvent
);
695 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_COMBOBOX_DROPDOWN
, wxCommandEvent
);
696 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_COMBOBOX_CLOSEUP
, wxCommandEvent
);
699 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_THREAD
, wxThreadEvent
);
702 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_DOWN
, wxMouseEvent
);
703 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_UP
, wxMouseEvent
);
704 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_DOWN
, wxMouseEvent
);
705 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_UP
, wxMouseEvent
);
706 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_DOWN
, wxMouseEvent
);
707 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_UP
, wxMouseEvent
);
708 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOTION
, wxMouseEvent
);
709 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ENTER_WINDOW
, wxMouseEvent
);
710 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEAVE_WINDOW
, wxMouseEvent
);
711 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_DCLICK
, wxMouseEvent
);
712 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_DCLICK
, wxMouseEvent
);
713 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_DCLICK
, wxMouseEvent
);
714 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SET_FOCUS
, wxFocusEvent
);
715 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KILL_FOCUS
, wxFocusEvent
);
716 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHILD_FOCUS
, wxChildFocusEvent
);
717 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSEWHEEL
, wxMouseEvent
);
718 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_DOWN
, wxMouseEvent
);
719 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_UP
, wxMouseEvent
);
720 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_DCLICK
, wxMouseEvent
);
721 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_DOWN
, wxMouseEvent
);
722 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_UP
, wxMouseEvent
);
723 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_DCLICK
, wxMouseEvent
);
725 // Character input event type
726 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHAR
, wxKeyEvent
);
727 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHAR_HOOK
, wxKeyEvent
);
728 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_NAVIGATION_KEY
, wxNavigationKeyEvent
);
729 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KEY_DOWN
, wxKeyEvent
);
730 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KEY_UP
, wxKeyEvent
);
732 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HOTKEY
, wxKeyEvent
);
735 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SET_CURSOR
, wxSetCursorEvent
);
737 // wxScrollBar and wxSlider event identifiers
738 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_TOP
, wxScrollEvent
);
739 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_BOTTOM
, wxScrollEvent
);
740 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_LINEUP
, wxScrollEvent
);
741 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_LINEDOWN
, wxScrollEvent
);
742 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_PAGEUP
, wxScrollEvent
);
743 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_PAGEDOWN
, wxScrollEvent
);
744 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_THUMBTRACK
, wxScrollEvent
);
745 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_THUMBRELEASE
, wxScrollEvent
);
746 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_CHANGED
, wxScrollEvent
);
748 // Due to a bug in older wx versions, wxSpinEvents were being sent with type of
749 // wxEVT_SCROLL_LINEUP, wxEVT_SCROLL_LINEDOWN and wxEVT_SCROLL_THUMBTRACK. But
750 // with the type-safe events in place, these event types are associated with
751 // wxScrollEvent. To allow handling of spin events, new event types have been
752 // defined in spinbutt.h/spinnbuttcmn.cpp. To maintain backward compatibility
753 // the spin event types are being initialized with the scroll event types.
757 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN_UP
, wxSpinEvent
);
758 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN_DOWN
, wxSpinEvent
);
759 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN
, wxSpinEvent
);
763 // Scroll events from wxWindow
764 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_TOP
, wxScrollWinEvent
);
765 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_BOTTOM
, wxScrollWinEvent
);
766 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_LINEUP
, wxScrollWinEvent
);
767 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_LINEDOWN
, wxScrollWinEvent
);
768 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_PAGEUP
, wxScrollWinEvent
);
769 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_PAGEDOWN
, wxScrollWinEvent
);
770 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_THUMBTRACK
, wxScrollWinEvent
);
771 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_THUMBRELEASE
, wxScrollWinEvent
);
774 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SIZE
, wxSizeEvent
);
775 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE
, wxMoveEvent
);
776 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CLOSE_WINDOW
, wxCloseEvent
);
777 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_END_SESSION
, wxCloseEvent
);
778 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_QUERY_END_SESSION
, wxCloseEvent
);
779 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ACTIVATE_APP
, wxActivateEvent
);
780 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ACTIVATE
, wxActivateEvent
);
781 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CREATE
, wxWindowCreateEvent
);
782 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DESTROY
, wxWindowDestroyEvent
);
783 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SHOW
, wxShowEvent
);
784 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ICONIZE
, wxIconizeEvent
);
785 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MAXIMIZE
, wxMaximizeEvent
);
786 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSE_CAPTURE_CHANGED
, wxMouseCaptureChangedEvent
);
787 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSE_CAPTURE_LOST
, wxMouseCaptureLostEvent
);
788 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_PAINT
, wxPaintEvent
);
789 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ERASE_BACKGROUND
, wxEraseEvent
);
790 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_NC_PAINT
, wxNcPaintEvent
);
791 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_OPEN
, wxMenuEvent
);
792 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_CLOSE
, wxMenuEvent
);
793 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_HIGHLIGHT
, wxMenuEvent
);
794 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CONTEXT_MENU
, wxContextMenuEvent
);
795 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SYS_COLOUR_CHANGED
, wxSysColourChangedEvent
);
796 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DISPLAY_CHANGED
, wxDisplayChangedEvent
);
797 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_QUERY_NEW_PALETTE
, wxQueryNewPaletteEvent
);
798 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_PALETTE_CHANGED
, wxPaletteChangedEvent
);
799 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_BUTTON_DOWN
, wxJoystickEvent
);
800 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_BUTTON_UP
, wxJoystickEvent
);
801 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_MOVE
, wxJoystickEvent
);
802 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_ZMOVE
, wxJoystickEvent
);
803 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DROP_FILES
, wxDropFilesEvent
);
804 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_INIT_DIALOG
, wxInitDialogEvent
);
805 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_BASE
, wxEVT_IDLE
, wxIdleEvent
);
806 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_UPDATE_UI
, wxUpdateUIEvent
);
807 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SIZING
, wxSizeEvent
);
808 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVING
, wxMoveEvent
);
809 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE_START
, wxMoveEvent
);
810 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE_END
, wxMoveEvent
);
811 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HIBERNATE
, wxActivateEvent
);
814 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_COPY
, wxClipboardTextEvent
);
815 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_CUT
, wxClipboardTextEvent
);
816 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_PASTE
, wxClipboardTextEvent
);
818 // Generic command events
819 // Note: a click is a higher-level event than button down/up
820 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LEFT_CLICK
, wxCommandEvent
);
821 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LEFT_DCLICK
, wxCommandEvent
);
822 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RIGHT_CLICK
, wxCommandEvent
);
823 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RIGHT_DCLICK
, wxCommandEvent
);
824 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SET_FOCUS
, wxCommandEvent
);
825 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_KILL_FOCUS
, wxCommandEvent
);
826 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_ENTER
, wxCommandEvent
);
829 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HELP
, wxHelpEvent
);
830 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DETAILED_HELP
, wxHelpEvent
);
832 // these 2 events are the same
833 #define wxEVT_COMMAND_TOOL_CLICKED wxEVT_COMMAND_MENU_SELECTED
835 // ----------------------------------------------------------------------------
837 // ----------------------------------------------------------------------------
839 // this event is also used by wxComboBox and wxSpinCtrl which don't include
840 // wx/textctrl.h in all ports [yet], so declare it here as well
842 // still, any new code using it should include wx/textctrl.h explicitly
843 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_UPDATED
, wxCommandEvent
);
846 // ----------------------------------------------------------------------------
847 // wxEvent(-derived) classes
848 // ----------------------------------------------------------------------------
850 // the predefined constants for the number of times we propagate event
851 // upwards window child-parent chain
852 enum wxEventPropagation
854 // don't propagate it at all
855 wxEVENT_PROPAGATE_NONE
= 0,
857 // propagate it until it is processed
858 wxEVENT_PROPAGATE_MAX
= INT_MAX
861 // The different categories for a wxEvent; see wxEvent::GetEventCategory.
862 // NOTE: they are used as OR-combinable flags by wxEventLoopBase::YieldFor
865 // this is the category for those events which are generated to update
866 // the appearance of the GUI but which (usually) do not comport data
867 // processing, i.e. which do not provide input or output data
868 // (e.g. size events, scroll events, etc).
869 // They are events NOT directly generated by the user's input devices.
870 wxEVT_CATEGORY_UI
= 1,
872 // this category groups those events which are generated directly from the
873 // user through input devices like mouse and keyboard and usually result in
874 // data to be processed from the application.
875 // (e.g. mouse clicks, key presses, etc)
876 wxEVT_CATEGORY_USER_INPUT
= 2,
878 // this category is for wxSocketEvent
879 wxEVT_CATEGORY_SOCKET
= 4,
881 // this category is for wxTimerEvent
882 wxEVT_CATEGORY_TIMER
= 8,
884 // this category is for any event used to send notifications from the
885 // secondary threads to the main one or in general for notifications among
886 // different threads (which may or may not be user-generated)
887 wxEVT_CATEGORY_THREAD
= 16,
890 // implementation only
892 // used in the implementations of wxEventLoopBase::YieldFor
893 wxEVT_CATEGORY_UNKNOWN
= 32,
895 // a special category used as an argument to wxEventLoopBase::YieldFor to indicate that
896 // Yield() should leave all wxEvents on the queue while emptying the native event queue
897 // (native events will be processed but the wxEvents they generate will be queued)
898 wxEVT_CATEGORY_CLIPBOARD
= 64,
903 // this category groups those events which are emitted in response to
904 // events of the native toolkit and which typically are not-"delayable".
905 wxEVT_CATEGORY_NATIVE_EVENTS
= wxEVT_CATEGORY_UI
|wxEVT_CATEGORY_USER_INPUT
,
907 // used in wxEventLoopBase::YieldFor to specify all event categories should be processed:
909 wxEVT_CATEGORY_UI
|wxEVT_CATEGORY_USER_INPUT
|wxEVT_CATEGORY_SOCKET
| \
910 wxEVT_CATEGORY_TIMER
|wxEVT_CATEGORY_THREAD
|wxEVT_CATEGORY_UNKNOWN
| \
911 wxEVT_CATEGORY_CLIPBOARD
915 * wxWidgets events, covering all interesting things that might happen
916 * (button clicking, resizing, setting text in widgets, etc.).
918 * For each completely new event type, derive a new event class.
919 * An event CLASS represents a C++ class defining a range of similar event TYPES;
920 * examples are canvas events, panel item command events.
921 * An event TYPE is a unique identifier for a particular system event,
922 * such as a button press or a listbox deselection.
926 class WXDLLIMPEXP_BASE wxEvent
: public wxObject
929 wxEvent(int winid
= 0, wxEventType commandType
= wxEVT_NULL
);
931 void SetEventType(wxEventType typ
) { m_eventType
= typ
; }
932 wxEventType
GetEventType() const { return m_eventType
; }
934 wxObject
*GetEventObject() const { return m_eventObject
; }
935 void SetEventObject(wxObject
*obj
) { m_eventObject
= obj
; }
937 long GetTimestamp() const { return m_timeStamp
; }
938 void SetTimestamp(long ts
= 0) { m_timeStamp
= ts
; }
940 int GetId() const { return m_id
; }
941 void SetId(int Id
) { m_id
= Id
; }
943 // Can instruct event processor that we wish to ignore this event
944 // (treat as if the event table entry had not been found): this must be done
945 // to allow the event processing by the base classes (calling event.Skip()
946 // is the analog of calling the base class version of a virtual function)
947 void Skip(bool skip
= true) { m_skipped
= skip
; }
948 bool GetSkipped() const { return m_skipped
; }
950 // This function is used to create a copy of the event polymorphically and
951 // all derived classes must implement it because otherwise wxPostEvent()
952 // for them wouldn't work (it needs to do a copy of the event)
953 virtual wxEvent
*Clone() const = 0;
955 // this function is used to selectively process events in wxEventLoopBase::YieldFor
956 // NOTE: by default it returns wxEVT_CATEGORY_UI just because the major
957 // part of wxWidgets events belong to that category.
958 virtual wxEventCategory
GetEventCategory() const
959 { return wxEVT_CATEGORY_UI
; }
961 // Implementation only: this test is explicitly anti OO and this function
962 // exists only for optimization purposes.
963 bool IsCommandEvent() const { return m_isCommandEvent
; }
965 // Determine if this event should be propagating to the parent window.
966 bool ShouldPropagate() const
967 { return m_propagationLevel
!= wxEVENT_PROPAGATE_NONE
; }
969 // Stop an event from propagating to its parent window, returns the old
970 // propagation level value
971 int StopPropagation()
973 int propagationLevel
= m_propagationLevel
;
974 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
975 return propagationLevel
;
978 // Resume the event propagation by restoring the propagation level
979 // (returned by StopPropagation())
980 void ResumePropagation(int propagationLevel
)
982 m_propagationLevel
= propagationLevel
;
986 // This is for internal use only and is only called by
987 // wxEvtHandler::ProcessEvent() to check whether it's the first time this
988 // event is being processed
991 if ( m_wasProcessed
)
994 m_wasProcessed
= true;
999 // This is also used only internally by ProcessEvent() to check if it
1000 // should process the event normally or only restrict the search for the
1001 // event handler to this object itself.
1002 bool ShouldProcessHereOnly() const { return m_processHereOnly
; }
1005 wxObject
* m_eventObject
;
1006 wxEventType m_eventType
;
1011 // m_callbackUserData is for internal usage only
1012 wxObject
* m_callbackUserData
;
1015 // the propagation level: while it is positive, we propagate the event to
1016 // the parent window (if any)
1017 int m_propagationLevel
;
1020 bool m_isCommandEvent
;
1022 // initially false but becomes true as soon as WasProcessed() is called for
1023 // the first time, as this is done only by ProcessEvent() it explains the
1024 // variable name: it becomes true after ProcessEvent() was called at least
1025 // once for this event
1026 bool m_wasProcessed
;
1028 // this flag is used by ProcessEventLocally() to prevent ProcessEvent()
1029 // from doing its usual stuff and force it to just call TryHere() instead,
1030 // see the comment there explaining why is this needed
1031 bool m_processHereOnly
;
1034 wxEvent(const wxEvent
&); // for implementing Clone()
1035 wxEvent
& operator=(const wxEvent
&); // for derived classes operator=()
1038 // it needs to access our m_propagationLevel
1039 friend class WXDLLIMPEXP_FWD_BASE wxPropagateOnce
;
1041 // and this one needs to access our m_processHereOnly
1042 friend class WXDLLIMPEXP_FWD_BASE wxEventProcessHereOnly
;
1045 DECLARE_ABSTRACT_CLASS(wxEvent
)
1049 * Helper class to temporarily change an event not to propagate.
1051 class WXDLLIMPEXP_BASE wxPropagationDisabler
1054 wxPropagationDisabler(wxEvent
& event
) : m_event(event
)
1056 m_propagationLevelOld
= m_event
.StopPropagation();
1059 ~wxPropagationDisabler()
1061 m_event
.ResumePropagation(m_propagationLevelOld
);
1066 int m_propagationLevelOld
;
1068 wxDECLARE_NO_COPY_CLASS(wxPropagationDisabler
);
1072 * Another one to temporarily lower propagation level.
1074 class WXDLLIMPEXP_BASE wxPropagateOnce
1077 wxPropagateOnce(wxEvent
& event
) : m_event(event
)
1079 wxASSERT_MSG( m_event
.m_propagationLevel
> 0,
1080 wxT("shouldn't be used unless ShouldPropagate()!") );
1082 m_event
.m_propagationLevel
--;
1087 m_event
.m_propagationLevel
++;
1093 wxDECLARE_NO_COPY_CLASS(wxPropagateOnce
);
1096 // A helper used by ProcessEventLocally() to restrict the event processing
1097 // to this handler only.
1098 class WXDLLIMPEXP_BASE wxEventProcessHereOnly
1101 wxEventProcessHereOnly(wxEvent
& event
) : m_event(event
)
1103 // This would be unexpected and would also restore the wrong value in
1104 // this class dtor so if even does happen legitimately we'd need to
1105 // store the value in ctor and restore it in dtor.
1106 wxASSERT_MSG( !m_event
.m_processHereOnly
,
1107 "shouldn't be used twice for the same event" );
1109 m_event
.m_processHereOnly
= true;
1112 ~wxEventProcessHereOnly()
1114 m_event
.m_processHereOnly
= false;
1120 wxDECLARE_NO_COPY_CLASS(wxEventProcessHereOnly
);
1126 // Item or menu event class
1128 wxEVT_COMMAND_BUTTON_CLICKED
1129 wxEVT_COMMAND_CHECKBOX_CLICKED
1130 wxEVT_COMMAND_CHOICE_SELECTED
1131 wxEVT_COMMAND_LISTBOX_SELECTED
1132 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
1133 wxEVT_COMMAND_TEXT_UPDATED
1134 wxEVT_COMMAND_TEXT_ENTER
1135 wxEVT_COMMAND_MENU_SELECTED
1136 wxEVT_COMMAND_SLIDER_UPDATED
1137 wxEVT_COMMAND_RADIOBOX_SELECTED
1138 wxEVT_COMMAND_RADIOBUTTON_SELECTED
1139 wxEVT_COMMAND_SCROLLBAR_UPDATED
1140 wxEVT_COMMAND_VLBOX_SELECTED
1141 wxEVT_COMMAND_COMBOBOX_SELECTED
1142 wxEVT_COMMAND_TOGGLEBUTTON_CLICKED
1145 class WXDLLIMPEXP_CORE wxCommandEvent
: public wxEvent
1148 wxCommandEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0);
1150 wxCommandEvent(const wxCommandEvent
& event
)
1152 m_cmdString(event
.m_cmdString
),
1153 m_commandInt(event
.m_commandInt
),
1154 m_extraLong(event
.m_extraLong
),
1155 m_clientData(event
.m_clientData
),
1156 m_clientObject(event
.m_clientObject
)
1159 // Set/Get client data from controls
1160 void SetClientData(void* clientData
) { m_clientData
= clientData
; }
1161 void *GetClientData() const { return m_clientData
; }
1163 // Set/Get client object from controls
1164 void SetClientObject(wxClientData
* clientObject
) { m_clientObject
= clientObject
; }
1165 wxClientData
*GetClientObject() const { return m_clientObject
; }
1167 // Get listbox selection if single-choice
1168 int GetSelection() const { return m_commandInt
; }
1170 // Set/Get listbox/choice selection string
1171 void SetString(const wxString
& s
) { m_cmdString
= s
; }
1172 wxString
GetString() const;
1174 // Get checkbox value
1175 bool IsChecked() const { return m_commandInt
!= 0; }
1177 // true if the listbox event was a selection.
1178 bool IsSelection() const { return (m_extraLong
!= 0); }
1180 void SetExtraLong(long extraLong
) { m_extraLong
= extraLong
; }
1181 long GetExtraLong() const { return m_extraLong
; }
1183 void SetInt(int i
) { m_commandInt
= i
; }
1184 int GetInt() const { return m_commandInt
; }
1186 virtual wxEvent
*Clone() const { return new wxCommandEvent(*this); }
1187 virtual wxEventCategory
GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT
; }
1190 wxString m_cmdString
; // String event argument
1192 long m_extraLong
; // Additional information (e.g. select/deselect)
1193 void* m_clientData
; // Arbitrary client data
1194 wxClientData
* m_clientObject
; // Arbitrary client object
1197 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCommandEvent
)
1200 // this class adds a possibility to react (from the user) code to a control
1201 // notification: allow or veto the operation being reported.
1202 class WXDLLIMPEXP_CORE wxNotifyEvent
: public wxCommandEvent
1205 wxNotifyEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0)
1206 : wxCommandEvent(commandType
, winid
)
1207 { m_bAllow
= true; }
1209 wxNotifyEvent(const wxNotifyEvent
& event
)
1210 : wxCommandEvent(event
)
1211 { m_bAllow
= event
.m_bAllow
; }
1213 // veto the operation (usually it's allowed by default)
1214 void Veto() { m_bAllow
= false; }
1216 // allow the operation if it was disabled by default
1217 void Allow() { m_bAllow
= true; }
1219 // for implementation code only: is the operation allowed?
1220 bool IsAllowed() const { return m_bAllow
; }
1222 virtual wxEvent
*Clone() const { return new wxNotifyEvent(*this); }
1228 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNotifyEvent
)
1234 class WXDLLIMPEXP_CORE wxThreadEvent
: public wxCommandEvent
1237 wxThreadEvent(wxEventType eventType
= wxEVT_COMMAND_THREAD
, int id
= wxID_ANY
)
1238 : wxCommandEvent(eventType
, id
)
1241 wxThreadEvent(const wxThreadEvent
& event
)
1242 : wxCommandEvent(event
)
1244 // make sure our string member (which uses COW, aka refcounting) is not
1245 // shared by other wxString instances:
1246 SetString(GetString().c_str());
1248 #if wxUSE_ANY && (!defined(__VISUALC__) || wxCHECK_VISUALC_VERSION(7))
1249 m_payload
= event
.m_payload
;
1253 virtual wxEvent
*Clone() const
1255 return new wxThreadEvent(*this);
1258 // this is important to avoid that calling wxEventLoopBase::YieldFor thread events
1259 // gets processed when this is unwanted:
1260 virtual wxEventCategory
GetEventCategory() const
1261 { return wxEVT_CATEGORY_THREAD
; }
1263 #if wxUSE_ANY && (!defined(__VISUALC__) || wxCHECK_VISUALC_VERSION(7))
1264 template<typename T
>
1265 void SetPayload(const T
& payload
)
1267 m_payload
= payload
;
1270 template<typename T
>
1271 T
GetPayload() const
1273 return m_payload
.As
<T
>();
1278 #endif // wxUSE_ANY && (!defined(__VISUALC__) || wxCHECK_VISUALC_VERSION(7))
1281 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxThreadEvent
)
1286 // Scroll event class, derived form wxCommandEvent. wxScrollEvents are
1287 // sent by wxSlider and wxScrollBar.
1292 wxEVT_SCROLL_LINEDOWN
1294 wxEVT_SCROLL_PAGEDOWN
1295 wxEVT_SCROLL_THUMBTRACK
1296 wxEVT_SCROLL_THUMBRELEASE
1297 wxEVT_SCROLL_CHANGED
1300 class WXDLLIMPEXP_CORE wxScrollEvent
: public wxCommandEvent
1303 wxScrollEvent(wxEventType commandType
= wxEVT_NULL
,
1304 int winid
= 0, int pos
= 0, int orient
= 0);
1306 int GetOrientation() const { return (int) m_extraLong
; }
1307 int GetPosition() const { return m_commandInt
; }
1308 void SetOrientation(int orient
) { m_extraLong
= (long) orient
; }
1309 void SetPosition(int pos
) { m_commandInt
= pos
; }
1311 virtual wxEvent
*Clone() const { return new wxScrollEvent(*this); }
1314 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollEvent
)
1317 // ScrollWin event class, derived fom wxEvent. wxScrollWinEvents
1318 // are sent by wxWindow.
1321 wxEVT_SCROLLWIN_BOTTOM
1322 wxEVT_SCROLLWIN_LINEUP
1323 wxEVT_SCROLLWIN_LINEDOWN
1324 wxEVT_SCROLLWIN_PAGEUP
1325 wxEVT_SCROLLWIN_PAGEDOWN
1326 wxEVT_SCROLLWIN_THUMBTRACK
1327 wxEVT_SCROLLWIN_THUMBRELEASE
1330 class WXDLLIMPEXP_CORE wxScrollWinEvent
: public wxEvent
1333 wxScrollWinEvent(wxEventType commandType
= wxEVT_NULL
,
1334 int pos
= 0, int orient
= 0);
1335 wxScrollWinEvent(const wxScrollWinEvent
& event
) : wxEvent(event
)
1336 { m_commandInt
= event
.m_commandInt
;
1337 m_extraLong
= event
.m_extraLong
; }
1339 int GetOrientation() const { return (int) m_extraLong
; }
1340 int GetPosition() const { return m_commandInt
; }
1341 void SetOrientation(int orient
) { m_extraLong
= (long) orient
; }
1342 void SetPosition(int pos
) { m_commandInt
= pos
; }
1344 virtual wxEvent
*Clone() const { return new wxScrollWinEvent(*this); }
1351 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollWinEvent
)
1356 // Mouse event class
1373 wxEVT_NC_MIDDLE_DOWN,
1375 wxEVT_NC_RIGHT_DOWN,
1378 wxEVT_NC_ENTER_WINDOW,
1379 wxEVT_NC_LEAVE_WINDOW,
1380 wxEVT_NC_LEFT_DCLICK,
1381 wxEVT_NC_MIDDLE_DCLICK,
1382 wxEVT_NC_RIGHT_DCLICK,
1385 class WXDLLIMPEXP_CORE wxMouseEvent
: public wxEvent
,
1389 wxMouseEvent(wxEventType mouseType
= wxEVT_NULL
);
1390 wxMouseEvent(const wxMouseEvent
& event
)
1397 // Was it a button event? (*doesn't* mean: is any button *down*?)
1398 bool IsButton() const { return Button(wxMOUSE_BTN_ANY
); }
1400 // Was it a down event from this (or any) button?
1401 bool ButtonDown(int but
= wxMOUSE_BTN_ANY
) const;
1403 // Was it a dclick event from this (or any) button?
1404 bool ButtonDClick(int but
= wxMOUSE_BTN_ANY
) const;
1406 // Was it a up event from this (or any) button?
1407 bool ButtonUp(int but
= wxMOUSE_BTN_ANY
) const;
1409 // Was this event generated by the given button?
1410 bool Button(int but
) const;
1412 // Get the button which is changing state (wxMOUSE_BTN_NONE if none)
1413 int GetButton() const;
1415 // Find which event was just generated
1416 bool LeftDown() const { return (m_eventType
== wxEVT_LEFT_DOWN
); }
1417 bool MiddleDown() const { return (m_eventType
== wxEVT_MIDDLE_DOWN
); }
1418 bool RightDown() const { return (m_eventType
== wxEVT_RIGHT_DOWN
); }
1419 bool Aux1Down() const { return (m_eventType
== wxEVT_AUX1_DOWN
); }
1420 bool Aux2Down() const { return (m_eventType
== wxEVT_AUX2_DOWN
); }
1422 bool LeftUp() const { return (m_eventType
== wxEVT_LEFT_UP
); }
1423 bool MiddleUp() const { return (m_eventType
== wxEVT_MIDDLE_UP
); }
1424 bool RightUp() const { return (m_eventType
== wxEVT_RIGHT_UP
); }
1425 bool Aux1Up() const { return (m_eventType
== wxEVT_AUX1_UP
); }
1426 bool Aux2Up() const { return (m_eventType
== wxEVT_AUX2_UP
); }
1428 bool LeftDClick() const { return (m_eventType
== wxEVT_LEFT_DCLICK
); }
1429 bool MiddleDClick() const { return (m_eventType
== wxEVT_MIDDLE_DCLICK
); }
1430 bool RightDClick() const { return (m_eventType
== wxEVT_RIGHT_DCLICK
); }
1431 bool Aux1DClick() const { return (m_eventType
== wxEVT_AUX1_UP
); }
1432 bool Aux2DClick() const { return (m_eventType
== wxEVT_AUX2_UP
); }
1434 // True if a button is down and the mouse is moving
1435 bool Dragging() const
1437 return (m_eventType
== wxEVT_MOTION
) && ButtonIsDown(wxMOUSE_BTN_ANY
);
1440 // True if the mouse is moving, and no button is down
1443 return (m_eventType
== wxEVT_MOTION
) && !ButtonIsDown(wxMOUSE_BTN_ANY
);
1446 // True if the mouse is just entering the window
1447 bool Entering() const { return (m_eventType
== wxEVT_ENTER_WINDOW
); }
1449 // True if the mouse is just leaving the window
1450 bool Leaving() const { return (m_eventType
== wxEVT_LEAVE_WINDOW
); }
1452 // Returns the number of mouse clicks associated with this event.
1453 int GetClickCount() const { return m_clickCount
; }
1455 // Find the logical position of the event given the DC
1456 wxPoint
GetLogicalPosition(const wxDC
& dc
) const;
1458 // Get wheel rotation, positive or negative indicates direction of
1459 // rotation. Current devices all send an event when rotation is equal to
1460 // +/-WheelDelta, but this allows for finer resolution devices to be
1461 // created in the future. Because of this you shouldn't assume that one
1462 // event is equal to 1 line or whatever, but you should be able to either
1463 // do partial line scrolling or wait until +/-WheelDelta rotation values
1464 // have been accumulated before scrolling.
1465 int GetWheelRotation() const { return m_wheelRotation
; }
1467 // Get wheel delta, normally 120. This is the threshold for action to be
1468 // taken, and one such action (for example, scrolling one increment)
1469 // should occur for each delta.
1470 int GetWheelDelta() const { return m_wheelDelta
; }
1472 // Gets the axis the wheel operation concerns, 0 being the y axis as on
1473 // most mouse wheels, 1 is the x axis for things like MightyMouse scrolls
1474 // or horizontal trackpad scrolling
1475 int GetWheelAxis() const { return m_wheelAxis
; }
1477 // Returns the configured number of lines (or whatever) to be scrolled per
1478 // wheel action. Defaults to one.
1479 int GetLinesPerAction() const { return m_linesPerAction
; }
1481 // Is the system set to do page scrolling?
1482 bool IsPageScroll() const { return ((unsigned int)m_linesPerAction
== UINT_MAX
); }
1484 virtual wxEvent
*Clone() const { return new wxMouseEvent(*this); }
1485 virtual wxEventCategory
GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT
; }
1487 wxMouseEvent
& operator=(const wxMouseEvent
& event
)
1498 int m_wheelRotation
;
1500 int m_linesPerAction
;
1503 void Assign(const wxMouseEvent
& evt
);
1506 DECLARE_DYNAMIC_CLASS(wxMouseEvent
)
1515 class WXDLLIMPEXP_CORE wxSetCursorEvent
: public wxEvent
1518 wxSetCursorEvent(wxCoord x
= 0, wxCoord y
= 0)
1519 : wxEvent(0, wxEVT_SET_CURSOR
),
1520 m_x(x
), m_y(y
), m_cursor()
1523 wxSetCursorEvent(const wxSetCursorEvent
& event
)
1527 m_cursor(event
.m_cursor
)
1530 wxCoord
GetX() const { return m_x
; }
1531 wxCoord
GetY() const { return m_y
; }
1533 void SetCursor(const wxCursor
& cursor
) { m_cursor
= cursor
; }
1534 const wxCursor
& GetCursor() const { return m_cursor
; }
1535 bool HasCursor() const { return m_cursor
.Ok(); }
1537 virtual wxEvent
*Clone() const { return new wxSetCursorEvent(*this); }
1544 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSetCursorEvent
)
1547 // Keyboard input event class
1557 // key categories: the bit flags for IsKeyInCategory() function
1559 // the enum values used may change in future version of wx
1560 // use the named constants only, or bitwise combinations thereof
1561 enum wxKeyCategoryFlags
1563 // arrow keys, on and off numeric keypads
1564 WXK_CATEGORY_ARROW
= 1,
1566 // page up and page down keys, on and off numeric keypads
1567 WXK_CATEGORY_PAGING
= 2,
1569 // home and end keys, on and off numeric keypads
1570 WXK_CATEGORY_JUMP
= 4,
1572 // tab key, on and off numeric keypads
1573 WXK_CATEGORY_TAB
= 8,
1575 // backspace and delete keys, on and off numeric keypads
1576 WXK_CATEGORY_CUT
= 16,
1578 // all keys usually used for navigation
1579 WXK_CATEGORY_NAVIGATION
= WXK_CATEGORY_ARROW
|
1580 WXK_CATEGORY_PAGING
|
1584 class WXDLLIMPEXP_CORE wxKeyEvent
: public wxEvent
,
1585 public wxKeyboardState
1588 wxKeyEvent(wxEventType keyType
= wxEVT_NULL
);
1589 wxKeyEvent(const wxKeyEvent
& evt
);
1591 // get the key code: an ASCII7 char or an element of wxKeyCode enum
1592 int GetKeyCode() const { return (int)m_keyCode
; }
1594 // returns true iff this event's key code is of a certain type
1595 bool IsKeyInCategory(int category
) const;
1598 // get the Unicode character corresponding to this key
1599 wxChar
GetUnicodeKey() const { return m_uniChar
; }
1600 #endif // wxUSE_UNICODE
1602 // get the raw key code (platform-dependent)
1603 wxUint32
GetRawKeyCode() const { return m_rawCode
; }
1605 // get the raw key flags (platform-dependent)
1606 wxUint32
GetRawKeyFlags() const { return m_rawFlags
; }
1608 // Find the position of the event
1609 void GetPosition(wxCoord
*xpos
, wxCoord
*ypos
) const
1611 if (xpos
) *xpos
= m_x
;
1612 if (ypos
) *ypos
= m_y
;
1615 void GetPosition(long *xpos
, long *ypos
) const
1617 if (xpos
) *xpos
= (long)m_x
;
1618 if (ypos
) *ypos
= (long)m_y
;
1621 wxPoint
GetPosition() const
1622 { return wxPoint(m_x
, m_y
); }
1625 wxCoord
GetX() const { return m_x
; }
1628 wxCoord
GetY() const { return m_y
; }
1630 virtual wxEvent
*Clone() const { return new wxKeyEvent(*this); }
1631 virtual wxEventCategory
GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT
; }
1633 // we do need to copy wxKeyEvent sometimes (in wxTreeCtrl code, for
1635 wxKeyEvent
& operator=(const wxKeyEvent
& evt
)
1639 wxEvent::operator=(evt
);
1641 // Borland C++ 5.82 doesn't compile an explicit call to an
1642 // implicitly defined operator=() so need to do it this way:
1643 *static_cast<wxKeyboardState
*>(this) = evt
;
1648 m_keyCode
= evt
.m_keyCode
;
1650 m_rawCode
= evt
.m_rawCode
;
1651 m_rawFlags
= evt
.m_rawFlags
;
1653 m_uniChar
= evt
.m_uniChar
;
1665 // This contains the full Unicode character
1666 // in a character events in Unicode mode
1670 // these fields contain the platform-specific information about
1671 // key that was pressed
1673 wxUint32 m_rawFlags
;
1676 DECLARE_DYNAMIC_CLASS(wxKeyEvent
)
1684 class WXDLLIMPEXP_CORE wxSizeEvent
: public wxEvent
1687 wxSizeEvent() : wxEvent(0, wxEVT_SIZE
)
1689 wxSizeEvent(const wxSize
& sz
, int winid
= 0)
1690 : wxEvent(winid
, wxEVT_SIZE
),
1693 wxSizeEvent(const wxSizeEvent
& event
)
1695 m_size(event
.m_size
), m_rect(event
.m_rect
)
1697 wxSizeEvent(const wxRect
& rect
, int id
= 0)
1698 : m_size(rect
.GetSize()), m_rect(rect
)
1699 { m_eventType
= wxEVT_SIZING
; m_id
= id
; }
1701 wxSize
GetSize() const { return m_size
; }
1702 wxRect
GetRect() const { return m_rect
; }
1703 void SetRect(const wxRect
& rect
) { m_rect
= rect
; }
1705 virtual wxEvent
*Clone() const { return new wxSizeEvent(*this); }
1708 // For internal usage only. Will be converted to protected members.
1710 wxRect m_rect
; // Used for wxEVT_SIZING
1713 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSizeEvent
)
1722 class WXDLLIMPEXP_CORE wxMoveEvent
: public wxEvent
1726 : wxEvent(0, wxEVT_MOVE
)
1728 wxMoveEvent(const wxPoint
& pos
, int winid
= 0)
1729 : wxEvent(winid
, wxEVT_MOVE
),
1732 wxMoveEvent(const wxMoveEvent
& event
)
1736 wxMoveEvent(const wxRect
& rect
, int id
= 0)
1737 : m_pos(rect
.GetPosition()), m_rect(rect
)
1738 { m_eventType
= wxEVT_MOVING
; m_id
= id
; }
1740 wxPoint
GetPosition() const { return m_pos
; }
1741 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
1742 wxRect
GetRect() const { return m_rect
; }
1743 void SetRect(const wxRect
& rect
) { m_rect
= rect
; }
1745 virtual wxEvent
*Clone() const { return new wxMoveEvent(*this); }
1752 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMoveEvent
)
1755 // Paint event class
1762 #if wxDEBUG_LEVEL && (defined(__WXMSW__) || defined(__WXPM__))
1763 #define wxHAS_PAINT_DEBUG
1765 // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined
1766 extern WXDLLIMPEXP_CORE
int g_isPainting
;
1769 class WXDLLIMPEXP_CORE wxPaintEvent
: public wxEvent
1772 wxPaintEvent(int Id
= 0)
1773 : wxEvent(Id
, wxEVT_PAINT
)
1775 #ifdef wxHAS_PAINT_DEBUG
1776 // set the internal flag for the duration of redrawing
1781 // default copy ctor and dtor are normally fine, we only need them to keep
1782 // g_isPainting updated in debug build
1783 #ifdef wxHAS_PAINT_DEBUG
1784 wxPaintEvent(const wxPaintEvent
& event
)
1790 virtual ~wxPaintEvent()
1796 virtual wxEvent
*Clone() const { return new wxPaintEvent(*this); }
1799 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaintEvent
)
1802 class WXDLLIMPEXP_CORE wxNcPaintEvent
: public wxEvent
1805 wxNcPaintEvent(int winid
= 0)
1806 : wxEvent(winid
, wxEVT_NC_PAINT
)
1809 virtual wxEvent
*Clone() const { return new wxNcPaintEvent(*this); }
1812 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNcPaintEvent
)
1815 // Erase background event class
1817 wxEVT_ERASE_BACKGROUND
1820 class WXDLLIMPEXP_CORE wxEraseEvent
: public wxEvent
1823 wxEraseEvent(int Id
= 0, wxDC
*dc
= NULL
)
1824 : wxEvent(Id
, wxEVT_ERASE_BACKGROUND
),
1828 wxEraseEvent(const wxEraseEvent
& event
)
1833 wxDC
*GetDC() const { return m_dc
; }
1835 virtual wxEvent
*Clone() const { return new wxEraseEvent(*this); }
1841 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxEraseEvent
)
1844 // Focus event class
1850 class WXDLLIMPEXP_CORE wxFocusEvent
: public wxEvent
1853 wxFocusEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0)
1854 : wxEvent(winid
, type
)
1857 wxFocusEvent(const wxFocusEvent
& event
)
1859 { m_win
= event
.m_win
; }
1861 // The window associated with this event is the window which had focus
1862 // before for SET event and the window which will have focus for the KILL
1863 // one. NB: it may be NULL in both cases!
1864 wxWindow
*GetWindow() const { return m_win
; }
1865 void SetWindow(wxWindow
*win
) { m_win
= win
; }
1867 virtual wxEvent
*Clone() const { return new wxFocusEvent(*this); }
1873 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFocusEvent
)
1876 // wxChildFocusEvent notifies the parent that a child has got the focus: unlike
1877 // wxFocusEvent it is propagated upwards the window chain
1878 class WXDLLIMPEXP_CORE wxChildFocusEvent
: public wxCommandEvent
1881 wxChildFocusEvent(wxWindow
*win
= NULL
);
1883 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
1885 virtual wxEvent
*Clone() const { return new wxChildFocusEvent(*this); }
1888 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxChildFocusEvent
)
1891 // Activate event class
1898 class WXDLLIMPEXP_CORE wxActivateEvent
: public wxEvent
1901 wxActivateEvent(wxEventType type
= wxEVT_NULL
, bool active
= true, int Id
= 0)
1903 { m_active
= active
; }
1904 wxActivateEvent(const wxActivateEvent
& event
)
1906 { m_active
= event
.m_active
; }
1908 bool GetActive() const { return m_active
; }
1910 virtual wxEvent
*Clone() const { return new wxActivateEvent(*this); }
1916 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxActivateEvent
)
1919 // InitDialog event class
1924 class WXDLLIMPEXP_CORE wxInitDialogEvent
: public wxEvent
1927 wxInitDialogEvent(int Id
= 0)
1928 : wxEvent(Id
, wxEVT_INIT_DIALOG
)
1931 virtual wxEvent
*Clone() const { return new wxInitDialogEvent(*this); }
1934 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxInitDialogEvent
)
1937 // Miscellaneous menu event class
1941 wxEVT_MENU_HIGHLIGHT,
1944 class WXDLLIMPEXP_CORE wxMenuEvent
: public wxEvent
1947 wxMenuEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0, wxMenu
* menu
= NULL
)
1948 : wxEvent(winid
, type
)
1949 { m_menuId
= winid
; m_menu
= menu
; }
1950 wxMenuEvent(const wxMenuEvent
& event
)
1952 { m_menuId
= event
.m_menuId
; m_menu
= event
.m_menu
; }
1954 // only for wxEVT_MENU_HIGHLIGHT
1955 int GetMenuId() const { return m_menuId
; }
1957 // only for wxEVT_MENU_OPEN/CLOSE
1958 bool IsPopup() const { return m_menuId
== wxID_ANY
; }
1960 // only for wxEVT_MENU_OPEN/CLOSE
1961 wxMenu
* GetMenu() const { return m_menu
; }
1963 virtual wxEvent
*Clone() const { return new wxMenuEvent(*this); }
1969 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMenuEvent
)
1972 // Window close or session close event class
1976 wxEVT_QUERY_END_SESSION
1979 class WXDLLIMPEXP_CORE wxCloseEvent
: public wxEvent
1982 wxCloseEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0)
1983 : wxEvent(winid
, type
),
1985 m_veto(false), // should be false by default
1988 wxCloseEvent(const wxCloseEvent
& event
)
1990 m_loggingOff(event
.m_loggingOff
),
1991 m_veto(event
.m_veto
),
1992 m_canVeto(event
.m_canVeto
) {}
1994 void SetLoggingOff(bool logOff
) { m_loggingOff
= logOff
; }
1995 bool GetLoggingOff() const
1997 // m_loggingOff flag is only used by wxEVT_[QUERY_]END_SESSION, it
1998 // doesn't make sense for wxEVT_CLOSE_WINDOW
1999 wxASSERT_MSG( m_eventType
!= wxEVT_CLOSE_WINDOW
,
2000 wxT("this flag is for end session events only") );
2002 return m_loggingOff
;
2005 void Veto(bool veto
= true)
2007 // GetVeto() will return false anyhow...
2008 wxCHECK_RET( m_canVeto
,
2009 wxT("call to Veto() ignored (can't veto this event)") );
2013 void SetCanVeto(bool canVeto
) { m_canVeto
= canVeto
; }
2014 bool CanVeto() const { return m_canVeto
; }
2015 bool GetVeto() const { return m_canVeto
&& m_veto
; }
2017 virtual wxEvent
*Clone() const { return new wxCloseEvent(*this); }
2025 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCloseEvent
)
2032 class WXDLLIMPEXP_CORE wxShowEvent
: public wxEvent
2035 wxShowEvent(int winid
= 0, bool show
= false)
2036 : wxEvent(winid
, wxEVT_SHOW
)
2038 wxShowEvent(const wxShowEvent
& event
)
2040 { m_show
= event
.m_show
; }
2042 void SetShow(bool show
) { m_show
= show
; }
2044 // return true if the window was shown, false if hidden
2045 bool IsShown() const { return m_show
; }
2047 #if WXWIN_COMPATIBILITY_2_8
2048 wxDEPRECATED( bool GetShow() const { return IsShown(); } )
2051 virtual wxEvent
*Clone() const { return new wxShowEvent(*this); }
2057 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxShowEvent
)
2064 class WXDLLIMPEXP_CORE wxIconizeEvent
: public wxEvent
2067 wxIconizeEvent(int winid
= 0, bool iconized
= true)
2068 : wxEvent(winid
, wxEVT_ICONIZE
)
2069 { m_iconized
= iconized
; }
2070 wxIconizeEvent(const wxIconizeEvent
& event
)
2072 { m_iconized
= event
.m_iconized
; }
2074 #if WXWIN_COMPATIBILITY_2_8
2075 wxDEPRECATED( bool Iconized() const { return IsIconized(); } )
2077 // return true if the frame was iconized, false if restored
2078 bool IsIconized() const { return m_iconized
; }
2080 virtual wxEvent
*Clone() const { return new wxIconizeEvent(*this); }
2086 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIconizeEvent
)
2092 class WXDLLIMPEXP_CORE wxMaximizeEvent
: public wxEvent
2095 wxMaximizeEvent(int winid
= 0)
2096 : wxEvent(winid
, wxEVT_MAXIMIZE
)
2099 virtual wxEvent
*Clone() const { return new wxMaximizeEvent(*this); }
2102 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMaximizeEvent
)
2105 // Joystick event class
2107 wxEVT_JOY_BUTTON_DOWN,
2108 wxEVT_JOY_BUTTON_UP,
2113 // Which joystick? Same as Windows ids so no conversion necessary.
2120 // Which button is down?
2123 wxJOY_BUTTON_ANY
= -1,
2130 class WXDLLIMPEXP_CORE wxJoystickEvent
: public wxEvent
2135 int m_buttonChange
; // Which button changed?
2136 int m_buttonState
; // Which buttons are down?
2137 int m_joyStick
; // Which joystick?
2140 wxJoystickEvent(wxEventType type
= wxEVT_NULL
,
2142 int joystick
= wxJOYSTICK1
,
2147 m_buttonChange(change
),
2148 m_buttonState(state
),
2149 m_joyStick(joystick
)
2152 wxJoystickEvent(const wxJoystickEvent
& event
)
2155 m_zPosition(event
.m_zPosition
),
2156 m_buttonChange(event
.m_buttonChange
),
2157 m_buttonState(event
.m_buttonState
),
2158 m_joyStick(event
.m_joyStick
)
2161 wxPoint
GetPosition() const { return m_pos
; }
2162 int GetZPosition() const { return m_zPosition
; }
2163 int GetButtonState() const { return m_buttonState
; }
2164 int GetButtonChange() const { return m_buttonChange
; }
2165 int GetJoystick() const { return m_joyStick
; }
2167 void SetJoystick(int stick
) { m_joyStick
= stick
; }
2168 void SetButtonState(int state
) { m_buttonState
= state
; }
2169 void SetButtonChange(int change
) { m_buttonChange
= change
; }
2170 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2171 void SetZPosition(int zPos
) { m_zPosition
= zPos
; }
2173 // Was it a button event? (*doesn't* mean: is any button *down*?)
2174 bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN
) ||
2175 (GetEventType() == wxEVT_JOY_BUTTON_UP
)); }
2177 // Was it a move event?
2178 bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE
); }
2180 // Was it a zmove event?
2181 bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE
); }
2183 // Was it a down event from button 1, 2, 3, 4 or any?
2184 bool ButtonDown(int but
= wxJOY_BUTTON_ANY
) const
2185 { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN
) &&
2186 ((but
== wxJOY_BUTTON_ANY
) || (but
== m_buttonChange
))); }
2188 // Was it a up event from button 1, 2, 3 or any?
2189 bool ButtonUp(int but
= wxJOY_BUTTON_ANY
) const
2190 { return ((GetEventType() == wxEVT_JOY_BUTTON_UP
) &&
2191 ((but
== wxJOY_BUTTON_ANY
) || (but
== m_buttonChange
))); }
2193 // Was the given button 1,2,3,4 or any in Down state?
2194 bool ButtonIsDown(int but
= wxJOY_BUTTON_ANY
) const
2195 { return (((but
== wxJOY_BUTTON_ANY
) && (m_buttonState
!= 0)) ||
2196 ((m_buttonState
& but
) == but
)); }
2198 virtual wxEvent
*Clone() const { return new wxJoystickEvent(*this); }
2201 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxJoystickEvent
)
2204 // Drop files event class
2209 class WXDLLIMPEXP_CORE wxDropFilesEvent
: public wxEvent
2216 wxDropFilesEvent(wxEventType type
= wxEVT_NULL
,
2218 wxString
*files
= NULL
)
2225 // we need a copy ctor to avoid deleting m_files pointer twice
2226 wxDropFilesEvent(const wxDropFilesEvent
& other
)
2228 m_noFiles(other
.m_noFiles
),
2232 m_files
= new wxString
[m_noFiles
];
2233 for ( int n
= 0; n
< m_noFiles
; n
++ )
2235 m_files
[n
] = other
.m_files
[n
];
2239 virtual ~wxDropFilesEvent()
2244 wxPoint
GetPosition() const { return m_pos
; }
2245 int GetNumberOfFiles() const { return m_noFiles
; }
2246 wxString
*GetFiles() const { return m_files
; }
2248 virtual wxEvent
*Clone() const { return new wxDropFilesEvent(*this); }
2251 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDropFilesEvent
)
2259 // Whether to always send update events to windows, or
2260 // to only send update events to those with the
2261 // wxWS_EX_PROCESS_UI_UPDATES style.
2265 // Send UI update events to all windows
2266 wxUPDATE_UI_PROCESS_ALL
,
2268 // Send UI update events to windows that have
2269 // the wxWS_EX_PROCESS_UI_UPDATES flag specified
2270 wxUPDATE_UI_PROCESS_SPECIFIED
2273 class WXDLLIMPEXP_CORE wxUpdateUIEvent
: public wxCommandEvent
2276 wxUpdateUIEvent(wxWindowID commandId
= 0)
2277 : wxCommandEvent(wxEVT_UPDATE_UI
, commandId
)
2285 m_setChecked
= false;
2287 wxUpdateUIEvent(const wxUpdateUIEvent
& event
)
2288 : wxCommandEvent(event
),
2289 m_checked(event
.m_checked
),
2290 m_enabled(event
.m_enabled
),
2291 m_shown(event
.m_shown
),
2292 m_setEnabled(event
.m_setEnabled
),
2293 m_setShown(event
.m_setShown
),
2294 m_setText(event
.m_setText
),
2295 m_setChecked(event
.m_setChecked
),
2296 m_text(event
.m_text
)
2299 bool GetChecked() const { return m_checked
; }
2300 bool GetEnabled() const { return m_enabled
; }
2301 bool GetShown() const { return m_shown
; }
2302 wxString
GetText() const { return m_text
; }
2303 bool GetSetText() const { return m_setText
; }
2304 bool GetSetChecked() const { return m_setChecked
; }
2305 bool GetSetEnabled() const { return m_setEnabled
; }
2306 bool GetSetShown() const { return m_setShown
; }
2308 void Check(bool check
) { m_checked
= check
; m_setChecked
= true; }
2309 void Enable(bool enable
) { m_enabled
= enable
; m_setEnabled
= true; }
2310 void Show(bool show
) { m_shown
= show
; m_setShown
= true; }
2311 void SetText(const wxString
& text
) { m_text
= text
; m_setText
= true; }
2313 // Sets the interval between updates in milliseconds.
2314 // Set to -1 to disable updates, or to 0 to update as frequently as possible.
2315 static void SetUpdateInterval(long updateInterval
) { sm_updateInterval
= updateInterval
; }
2317 // Returns the current interval between updates in milliseconds
2318 static long GetUpdateInterval() { return sm_updateInterval
; }
2320 // Can we update this window?
2321 static bool CanUpdate(wxWindowBase
*win
);
2323 // Reset the update time to provide a delay until the next
2324 // time we should update
2325 static void ResetUpdateTime();
2327 // Specify how wxWidgets will send update events: to
2328 // all windows, or only to those which specify that they
2329 // will process the events.
2330 static void SetMode(wxUpdateUIMode mode
) { sm_updateMode
= mode
; }
2332 // Returns the UI update mode
2333 static wxUpdateUIMode
GetMode() { return sm_updateMode
; }
2335 virtual wxEvent
*Clone() const { return new wxUpdateUIEvent(*this); }
2347 static wxLongLong sm_lastUpdate
;
2349 static long sm_updateInterval
;
2350 static wxUpdateUIMode sm_updateMode
;
2353 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxUpdateUIEvent
)
2357 wxEVT_SYS_COLOUR_CHANGED
2360 // TODO: shouldn't all events record the window ID?
2361 class WXDLLIMPEXP_CORE wxSysColourChangedEvent
: public wxEvent
2364 wxSysColourChangedEvent()
2365 : wxEvent(0, wxEVT_SYS_COLOUR_CHANGED
)
2368 virtual wxEvent
*Clone() const { return new wxSysColourChangedEvent(*this); }
2371 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSysColourChangedEvent
)
2375 wxEVT_MOUSE_CAPTURE_CHANGED
2376 The window losing the capture receives this message
2377 (even if it released the capture itself).
2380 class WXDLLIMPEXP_CORE wxMouseCaptureChangedEvent
: public wxEvent
2383 wxMouseCaptureChangedEvent(wxWindowID winid
= 0, wxWindow
* gainedCapture
= NULL
)
2384 : wxEvent(winid
, wxEVT_MOUSE_CAPTURE_CHANGED
),
2385 m_gainedCapture(gainedCapture
)
2388 wxMouseCaptureChangedEvent(const wxMouseCaptureChangedEvent
& event
)
2390 m_gainedCapture(event
.m_gainedCapture
)
2393 virtual wxEvent
*Clone() const { return new wxMouseCaptureChangedEvent(*this); }
2395 wxWindow
* GetCapturedWindow() const { return m_gainedCapture
; }
2398 wxWindow
* m_gainedCapture
;
2400 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureChangedEvent
)
2404 wxEVT_MOUSE_CAPTURE_LOST
2405 The window losing the capture receives this message, unless it released it
2406 it itself or unless wxWindow::CaptureMouse was called on another window
2407 (and so capture will be restored when the new capturer releases it).
2410 class WXDLLIMPEXP_CORE wxMouseCaptureLostEvent
: public wxEvent
2413 wxMouseCaptureLostEvent(wxWindowID winid
= 0)
2414 : wxEvent(winid
, wxEVT_MOUSE_CAPTURE_LOST
)
2417 wxMouseCaptureLostEvent(const wxMouseCaptureLostEvent
& event
)
2421 virtual wxEvent
*Clone() const { return new wxMouseCaptureLostEvent(*this); }
2423 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureLostEvent
)
2427 wxEVT_DISPLAY_CHANGED
2429 class WXDLLIMPEXP_CORE wxDisplayChangedEvent
: public wxEvent
2432 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDisplayChangedEvent
)
2435 wxDisplayChangedEvent()
2436 : wxEvent(0, wxEVT_DISPLAY_CHANGED
)
2439 virtual wxEvent
*Clone() const { return new wxDisplayChangedEvent(*this); }
2443 wxEVT_PALETTE_CHANGED
2446 class WXDLLIMPEXP_CORE wxPaletteChangedEvent
: public wxEvent
2449 wxPaletteChangedEvent(wxWindowID winid
= 0)
2450 : wxEvent(winid
, wxEVT_PALETTE_CHANGED
),
2451 m_changedWindow(NULL
)
2454 wxPaletteChangedEvent(const wxPaletteChangedEvent
& event
)
2456 m_changedWindow(event
.m_changedWindow
)
2459 void SetChangedWindow(wxWindow
* win
) { m_changedWindow
= win
; }
2460 wxWindow
* GetChangedWindow() const { return m_changedWindow
; }
2462 virtual wxEvent
*Clone() const { return new wxPaletteChangedEvent(*this); }
2465 wxWindow
* m_changedWindow
;
2468 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaletteChangedEvent
)
2472 wxEVT_QUERY_NEW_PALETTE
2473 Indicates the window is getting keyboard focus and should re-do its palette.
2476 class WXDLLIMPEXP_CORE wxQueryNewPaletteEvent
: public wxEvent
2479 wxQueryNewPaletteEvent(wxWindowID winid
= 0)
2480 : wxEvent(winid
, wxEVT_QUERY_NEW_PALETTE
),
2481 m_paletteRealized(false)
2483 wxQueryNewPaletteEvent(const wxQueryNewPaletteEvent
& event
)
2485 m_paletteRealized(event
.m_paletteRealized
)
2488 // App sets this if it changes the palette.
2489 void SetPaletteRealized(bool realized
) { m_paletteRealized
= realized
; }
2490 bool GetPaletteRealized() const { return m_paletteRealized
; }
2492 virtual wxEvent
*Clone() const { return new wxQueryNewPaletteEvent(*this); }
2495 bool m_paletteRealized
;
2498 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxQueryNewPaletteEvent
)
2502 Event generated by dialog navigation keys
2503 wxEVT_NAVIGATION_KEY
2505 // NB: don't derive from command event to avoid being propagated to the parent
2506 class WXDLLIMPEXP_CORE wxNavigationKeyEvent
: public wxEvent
2509 wxNavigationKeyEvent()
2510 : wxEvent(0, wxEVT_NAVIGATION_KEY
),
2511 m_flags(IsForward
| FromTab
), // defaults are for TAB
2514 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
2517 wxNavigationKeyEvent(const wxNavigationKeyEvent
& event
)
2519 m_flags(event
.m_flags
),
2520 m_focus(event
.m_focus
)
2523 // direction: forward (true) or backward (false)
2524 bool GetDirection() const
2525 { return (m_flags
& IsForward
) != 0; }
2526 void SetDirection(bool bForward
)
2527 { if ( bForward
) m_flags
|= IsForward
; else m_flags
&= ~IsForward
; }
2529 // it may be a window change event (MDI, notebook pages...) or a control
2531 bool IsWindowChange() const
2532 { return (m_flags
& WinChange
) != 0; }
2533 void SetWindowChange(bool bIs
)
2534 { if ( bIs
) m_flags
|= WinChange
; else m_flags
&= ~WinChange
; }
2536 // Set to true under MSW if the event was generated using the tab key.
2537 // This is required for proper navogation over radio buttons
2538 bool IsFromTab() const
2539 { return (m_flags
& FromTab
) != 0; }
2540 void SetFromTab(bool bIs
)
2541 { if ( bIs
) m_flags
|= FromTab
; else m_flags
&= ~FromTab
; }
2543 // the child which has the focus currently (may be NULL - use
2544 // wxWindow::FindFocus then)
2545 wxWindow
* GetCurrentFocus() const { return m_focus
; }
2546 void SetCurrentFocus(wxWindow
*win
) { m_focus
= win
; }
2549 void SetFlags(long flags
) { m_flags
= flags
; }
2551 virtual wxEvent
*Clone() const { return new wxNavigationKeyEvent(*this); }
2553 enum wxNavigationKeyEventFlags
2555 IsBackward
= 0x0000,
2565 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNavigationKeyEvent
)
2568 // Window creation/destruction events: the first is sent as soon as window is
2569 // created (i.e. the underlying GUI object exists), but when the C++ object is
2570 // fully initialized (so virtual functions may be called). The second,
2571 // wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
2572 // still safe to call virtual functions at this moment
2578 class WXDLLIMPEXP_CORE wxWindowCreateEvent
: public wxCommandEvent
2581 wxWindowCreateEvent(wxWindow
*win
= NULL
);
2583 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
2585 virtual wxEvent
*Clone() const { return new wxWindowCreateEvent(*this); }
2588 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowCreateEvent
)
2591 class WXDLLIMPEXP_CORE wxWindowDestroyEvent
: public wxCommandEvent
2594 wxWindowDestroyEvent(wxWindow
*win
= NULL
);
2596 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
2598 virtual wxEvent
*Clone() const { return new wxWindowDestroyEvent(*this); }
2601 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowDestroyEvent
)
2604 // A help event is sent when the user clicks on a window in context-help mode.
2610 class WXDLLIMPEXP_CORE wxHelpEvent
: public wxCommandEvent
2613 // how was this help event generated?
2616 Origin_Unknown
, // unrecognized event source
2617 Origin_Keyboard
, // event generated from F1 key press
2618 Origin_HelpButton
// event from [?] button on the title bar (Windows)
2621 wxHelpEvent(wxEventType type
= wxEVT_NULL
,
2622 wxWindowID winid
= 0,
2623 const wxPoint
& pt
= wxDefaultPosition
,
2624 Origin origin
= Origin_Unknown
)
2625 : wxCommandEvent(type
, winid
),
2627 m_origin(GuessOrigin(origin
))
2629 wxHelpEvent(const wxHelpEvent
& event
)
2630 : wxCommandEvent(event
),
2632 m_target(event
.m_target
),
2633 m_link(event
.m_link
),
2634 m_origin(event
.m_origin
)
2637 // Position of event (in screen coordinates)
2638 const wxPoint
& GetPosition() const { return m_pos
; }
2639 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2641 // Optional link to further help
2642 const wxString
& GetLink() const { return m_link
; }
2643 void SetLink(const wxString
& link
) { m_link
= link
; }
2645 // Optional target to display help in. E.g. a window specification
2646 const wxString
& GetTarget() const { return m_target
; }
2647 void SetTarget(const wxString
& target
) { m_target
= target
; }
2649 virtual wxEvent
*Clone() const { return new wxHelpEvent(*this); }
2651 // optional indication of the event source
2652 Origin
GetOrigin() const { return m_origin
; }
2653 void SetOrigin(Origin origin
) { m_origin
= origin
; }
2661 // we can try to guess the event origin ourselves, even if none is
2662 // specified in the ctor
2663 static Origin
GuessOrigin(Origin origin
);
2666 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHelpEvent
)
2669 // A Clipboard Text event is sent when a window intercepts text copy/cut/paste
2670 // message, i.e. the user has cut/copied/pasted data from/into a text control
2671 // via ctrl-C/X/V, ctrl/shift-del/insert, a popup menu command, etc.
2672 // NOTE : under windows these events are *NOT* generated automatically
2673 // for a Rich Edit text control.
2675 wxEVT_COMMAND_TEXT_COPY
2676 wxEVT_COMMAND_TEXT_CUT
2677 wxEVT_COMMAND_TEXT_PASTE
2680 class WXDLLIMPEXP_CORE wxClipboardTextEvent
: public wxCommandEvent
2683 wxClipboardTextEvent(wxEventType type
= wxEVT_NULL
,
2684 wxWindowID winid
= 0)
2685 : wxCommandEvent(type
, winid
)
2687 wxClipboardTextEvent(const wxClipboardTextEvent
& event
)
2688 : wxCommandEvent(event
)
2691 virtual wxEvent
*Clone() const { return new wxClipboardTextEvent(*this); }
2694 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxClipboardTextEvent
)
2697 // A Context event is sent when the user right clicks on a window or
2698 // presses Shift-F10
2699 // NOTE : Under windows this is a repackaged WM_CONTETXMENU message
2700 // Under other systems it may have to be generated from a right click event
2705 class WXDLLIMPEXP_CORE wxContextMenuEvent
: public wxCommandEvent
2708 wxContextMenuEvent(wxEventType type
= wxEVT_NULL
,
2709 wxWindowID winid
= 0,
2710 const wxPoint
& pt
= wxDefaultPosition
)
2711 : wxCommandEvent(type
, winid
),
2714 wxContextMenuEvent(const wxContextMenuEvent
& event
)
2715 : wxCommandEvent(event
),
2719 // Position of event (in screen coordinates)
2720 const wxPoint
& GetPosition() const { return m_pos
; }
2721 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2723 virtual wxEvent
*Clone() const { return new wxContextMenuEvent(*this); }
2729 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxContextMenuEvent
)
2739 // Whether to always send idle events to windows, or
2740 // to only send update events to those with the
2741 // wxWS_EX_PROCESS_IDLE style.
2745 // Send idle events to all windows
2748 // Send idle events to windows that have
2749 // the wxWS_EX_PROCESS_IDLE flag specified
2750 wxIDLE_PROCESS_SPECIFIED
2753 class WXDLLIMPEXP_BASE wxIdleEvent
: public wxEvent
2757 : wxEvent(0, wxEVT_IDLE
),
2758 m_requestMore(false)
2760 wxIdleEvent(const wxIdleEvent
& event
)
2762 m_requestMore(event
.m_requestMore
)
2765 void RequestMore(bool needMore
= true) { m_requestMore
= needMore
; }
2766 bool MoreRequested() const { return m_requestMore
; }
2768 virtual wxEvent
*Clone() const { return new wxIdleEvent(*this); }
2770 // Specify how wxWidgets will send idle events: to
2771 // all windows, or only to those which specify that they
2772 // will process the events.
2773 static void SetMode(wxIdleMode mode
) { sm_idleMode
= mode
; }
2775 // Returns the idle event mode
2776 static wxIdleMode
GetMode() { return sm_idleMode
; }
2780 static wxIdleMode sm_idleMode
;
2783 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIdleEvent
)
2787 wxEVT_MOUSE_CAPTURE_CHANGED,
2788 wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
2789 // wxEVT_FONT_CHANGED, // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
2790 // wxEVT_FONT_CHANGED to all other windows (maybe).
2791 wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
2798 // ============================================================================
2799 // event handler and related classes
2800 // ============================================================================
2803 // struct containing the members common to static and dynamic event tables
2805 struct WXDLLIMPEXP_BASE wxEventTableEntryBase
2807 wxEventTableEntryBase(int winid
, int idLast
,
2808 wxEventFunctor
* fn
, wxObject
*data
)
2812 m_callbackUserData(data
)
2814 wxASSERT_MSG( idLast
== wxID_ANY
|| winid
<= idLast
,
2815 "invalid IDs range: lower bound > upper bound" );
2818 wxEventTableEntryBase( const wxEventTableEntryBase
&entry
)
2819 : m_id( entry
.m_id
),
2820 m_lastId( entry
.m_lastId
),
2822 m_callbackUserData( entry
.m_callbackUserData
)
2824 // This is a 'hack' to ensure that only one instance tries to delete
2825 // the functor pointer. It is safe as long as the only place where the
2826 // copy constructor is being called is when the static event tables are
2827 // being initialized (a temporary instance is created and then this
2828 // constructor is called).
2830 const_cast<wxEventTableEntryBase
&>( entry
).m_fn
= NULL
;
2833 ~wxEventTableEntryBase()
2838 // the range of ids for this entry: if m_lastId == wxID_ANY, the range
2839 // consists only of m_id, otherwise it is m_id..m_lastId inclusive
2843 // function/method/functor to call
2844 wxEventFunctor
* m_fn
;
2846 // arbitrary user data associated with the callback
2847 wxObject
* m_callbackUserData
;
2850 wxDECLARE_NO_ASSIGN_CLASS(wxEventTableEntryBase
);
2853 // an entry from a static event table
2854 struct WXDLLIMPEXP_BASE wxEventTableEntry
: public wxEventTableEntryBase
2856 wxEventTableEntry(const int& evType
, int winid
, int idLast
,
2857 wxEventFunctor
* fn
, wxObject
*data
)
2858 : wxEventTableEntryBase(winid
, idLast
, fn
, data
),
2862 // the reference to event type: this allows us to not care about the
2863 // (undefined) order in which the event table entries and the event types
2864 // are initialized: initially the value of this reference might be
2865 // invalid, but by the time it is used for the first time, all global
2866 // objects will have been initialized (including the event type constants)
2867 // and so it will have the correct value when it is needed
2868 const int& m_eventType
;
2871 wxDECLARE_NO_ASSIGN_CLASS(wxEventTableEntry
);
2874 // an entry used in dynamic event table managed by wxEvtHandler::Connect()
2875 struct WXDLLIMPEXP_BASE wxDynamicEventTableEntry
: public wxEventTableEntryBase
2877 wxDynamicEventTableEntry(int evType
, int winid
, int idLast
,
2878 wxEventFunctor
* fn
, wxObject
*data
)
2879 : wxEventTableEntryBase(winid
, idLast
, fn
, data
),
2883 // not a reference here as we can't keep a reference to a temporary int
2884 // created to wrap the constant value typically passed to Connect() - nor
2889 wxDECLARE_NO_ASSIGN_CLASS(wxDynamicEventTableEntry
);
2892 // ----------------------------------------------------------------------------
2893 // wxEventTable: an array of event entries terminated with {0, 0, 0, 0, 0}
2894 // ----------------------------------------------------------------------------
2896 struct WXDLLIMPEXP_BASE wxEventTable
2898 const wxEventTable
*baseTable
; // base event table (next in chain)
2899 const wxEventTableEntry
*entries
; // bottom of entry array
2902 // ----------------------------------------------------------------------------
2903 // wxEventHashTable: a helper of wxEvtHandler to speed up wxEventTable lookups.
2904 // ----------------------------------------------------------------------------
2906 WX_DEFINE_ARRAY_PTR(const wxEventTableEntry
*, wxEventTableEntryPointerArray
);
2908 class WXDLLIMPEXP_BASE wxEventHashTable
2911 // Internal data structs
2912 struct EventTypeTable
2914 wxEventType eventType
;
2915 wxEventTableEntryPointerArray eventEntryTable
;
2917 typedef EventTypeTable
* EventTypeTablePointer
;
2920 // Constructor, needs the event table it needs to hash later on.
2921 // Note: hashing of the event table is not done in the constructor as it
2922 // can be that the event table is not yet full initialize, the hash
2923 // will gets initialized when handling the first event look-up request.
2924 wxEventHashTable(const wxEventTable
&table
);
2926 ~wxEventHashTable();
2928 // Handle the given event, in other words search the event table hash
2929 // and call self->ProcessEvent() if a match was found.
2930 bool HandleEvent(wxEvent
& event
, wxEvtHandler
*self
);
2935 #if wxUSE_MEMORY_TRACING
2936 // Clear all tables: only used to work around problems in memory tracing
2938 static void ClearAll();
2939 #endif // wxUSE_MEMORY_TRACING
2942 // Init the hash table with the entries of the static event table.
2943 void InitHashTable();
2944 // Helper funtion of InitHashTable() to insert 1 entry into the hash table.
2945 void AddEntry(const wxEventTableEntry
&entry
);
2946 // Allocate and init with null pointers the base hash table.
2947 void AllocEventTypeTable(size_t size
);
2948 // Grow the hash table in size and transfer all items currently
2949 // in the table to the correct location in the new table.
2950 void GrowEventTypeTable();
2953 const wxEventTable
&m_table
;
2957 EventTypeTablePointer
*m_eventTypeTable
;
2959 static wxEventHashTable
* sm_first
;
2960 wxEventHashTable
* m_previous
;
2961 wxEventHashTable
* m_next
;
2963 wxDECLARE_NO_COPY_CLASS(wxEventHashTable
);
2966 // ----------------------------------------------------------------------------
2967 // wxEvtHandler: the base class for all objects handling wxWidgets events
2968 // ----------------------------------------------------------------------------
2970 class WXDLLIMPEXP_BASE wxEvtHandler
: public wxObject
2971 , public wxTrackable
2975 virtual ~wxEvtHandler();
2978 // Event handler chain
2979 // -------------------
2981 wxEvtHandler
*GetNextHandler() const { return m_nextHandler
; }
2982 wxEvtHandler
*GetPreviousHandler() const { return m_previousHandler
; }
2983 virtual void SetNextHandler(wxEvtHandler
*handler
) { m_nextHandler
= handler
; }
2984 virtual void SetPreviousHandler(wxEvtHandler
*handler
) { m_previousHandler
= handler
; }
2986 void SetEvtHandlerEnabled(bool enabled
) { m_enabled
= enabled
; }
2987 bool GetEvtHandlerEnabled() const { return m_enabled
; }
2990 bool IsUnlinked() const;
2994 // Event queuing and processing
2995 // ----------------------------
2997 // Process an event right now: this can only be called from the main
2998 // thread, use QueueEvent() for scheduling the events for
2999 // processing from other threads.
3000 virtual bool ProcessEvent(wxEvent
& event
);
3002 // Process an event by calling ProcessEvent and handling any exceptions
3003 // thrown by event handlers. It's mostly useful when processing wx events
3004 // when called from C code (e.g. in GTK+ callback) when the exception
3005 // wouldn't correctly propagate to wxEventLoop.
3006 bool SafelyProcessEvent(wxEvent
& event
);
3007 // NOTE: uses ProcessEvent()
3009 // This method tries to process the event in this event handler, including
3010 // any preprocessing done by TryBefore() and all the handlers chained to
3011 // it, but excluding the post-processing done in TryAfter().
3013 // It is meant to be called from ProcessEvent() only and is not virtual,
3014 // additional event handlers can be hooked into the normal event processing
3015 // logic using TryBefore() and TryAfter() hooks.
3017 // You can also call it yourself to forward an event to another handler but
3018 // without propagating it upwards if it's unhandled (this is usually
3019 // unwanted when forwarding as the original handler would already do it if
3020 // needed normally).
3021 bool ProcessEventLocally(wxEvent
& event
);
3023 // Schedule the given event to be processed later. It takes ownership of
3024 // the event pointer, i.e. it will be deleted later. This is safe to call
3025 // from multiple threads although you still need to ensure that wxString
3026 // fields of the event object are deep copies and not use the same string
3027 // buffer as other wxString objects in this thread.
3028 virtual void QueueEvent(wxEvent
*event
);
3030 // Add an event to be processed later: notice that this function is not
3031 // safe to call from threads other than main, use QueueEvent()
3032 virtual void AddPendingEvent(const wxEvent
& event
)
3034 // notice that the thread-safety problem comes from the fact that
3035 // Clone() doesn't make deep copies of wxString fields of wxEvent
3036 // object and so the same wxString could be used from both threads when
3037 // the event object is destroyed in this one -- QueueEvent() avoids
3038 // this problem as the event pointer is not used any more in this
3039 // thread at all after it is called.
3040 QueueEvent(event
.Clone());
3043 void ProcessPendingEvents();
3044 // NOTE: uses ProcessEvent()
3046 void DeletePendingEvents();
3049 bool ProcessThreadEvent(const wxEvent
& event
);
3050 // NOTE: uses AddPendingEvent(); call only from secondary threads
3054 // Connecting and disconnecting
3055 // ----------------------------
3057 // These functions are used for old, untyped, event handlers and don't
3058 // check that the type of the function passed to them actually matches the
3059 // type of the event. They also only allow connecting events to methods of
3060 // wxEvtHandler-derived classes.
3062 // The template Connect() methods below are safer and allow connecting
3063 // events to arbitrary functions or functors -- but require compiler
3064 // support for templates.
3066 // Dynamic association of a member function handler with the event handler,
3067 // winid and event type
3068 void Connect(int winid
,
3070 wxEventType eventType
,
3071 wxObjectEventFunction func
,
3072 wxObject
*userData
= NULL
,
3073 wxEvtHandler
*eventSink
= NULL
)
3075 DoBind(winid
, lastId
, eventType
,
3076 wxNewEventFunctor(eventType
, func
, eventSink
),
3080 // Convenience function: take just one id
3081 void Connect(int winid
,
3082 wxEventType eventType
,
3083 wxObjectEventFunction func
,
3084 wxObject
*userData
= NULL
,
3085 wxEvtHandler
*eventSink
= NULL
)
3086 { Connect(winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3088 // Even more convenient: without id (same as using id of wxID_ANY)
3089 void Connect(wxEventType eventType
,
3090 wxObjectEventFunction func
,
3091 wxObject
*userData
= NULL
,
3092 wxEvtHandler
*eventSink
= NULL
)
3093 { Connect(wxID_ANY
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3095 bool Disconnect(int winid
,
3097 wxEventType eventType
,
3098 wxObjectEventFunction func
= NULL
,
3099 wxObject
*userData
= NULL
,
3100 wxEvtHandler
*eventSink
= NULL
)
3102 return DoUnbind(winid
, lastId
, eventType
,
3103 wxMakeEventFunctor(eventType
, func
, eventSink
),
3107 bool Disconnect(int winid
= wxID_ANY
,
3108 wxEventType eventType
= wxEVT_NULL
,
3109 wxObjectEventFunction func
= NULL
,
3110 wxObject
*userData
= NULL
,
3111 wxEvtHandler
*eventSink
= NULL
)
3112 { return Disconnect(winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3114 bool Disconnect(wxEventType eventType
,
3115 wxObjectEventFunction func
,
3116 wxObject
*userData
= NULL
,
3117 wxEvtHandler
*eventSink
= NULL
)
3118 { return Disconnect(wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3120 #ifdef wxHAS_EVENT_BIND
3121 // Bind functions to an event:
3122 template <typename EventTag
, typename EventArg
>
3123 void Bind(const EventTag
& eventType
,
3124 void (*function
)(EventArg
&),
3125 int winid
= wxID_ANY
,
3126 int lastId
= wxID_ANY
,
3127 wxObject
*userData
= NULL
)
3129 DoBind(winid
, lastId
, eventType
,
3130 wxNewEventFunctor(eventType
, function
),
3135 template <typename EventTag
, typename EventArg
>
3136 bool Unbind(const EventTag
& eventType
,
3137 void (*function
)(EventArg
&),
3138 int winid
= wxID_ANY
,
3139 int lastId
= wxID_ANY
,
3140 wxObject
*userData
= NULL
)
3142 return DoUnbind(winid
, lastId
, eventType
,
3143 wxMakeEventFunctor(eventType
, function
),
3147 // Bind functors to an event:
3148 template <typename EventTag
, typename Functor
>
3149 void Bind(const EventTag
& eventType
,
3150 const Functor
&functor
,
3151 int winid
= wxID_ANY
,
3152 int lastId
= wxID_ANY
,
3153 wxObject
*userData
= NULL
)
3155 DoBind(winid
, lastId
, eventType
,
3156 wxNewEventFunctor(eventType
, functor
),
3161 template <typename EventTag
, typename Functor
>
3162 bool Unbind(const EventTag
& eventType
,
3163 const Functor
&functor
,
3164 int winid
= wxID_ANY
,
3165 int lastId
= wxID_ANY
,
3166 wxObject
*userData
= NULL
)
3168 return DoUnbind(winid
, lastId
, eventType
,
3169 wxMakeEventFunctor(eventType
, functor
),
3174 // Bind a method of a class (called on the specified handler which must
3175 // be convertible to this class) object to an event:
3177 template <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
3178 void Bind(const EventTag
&eventType
,
3179 void (Class::*method
)(EventArg
&),
3180 EventHandler
*handler
,
3181 int winid
= wxID_ANY
,
3182 int lastId
= wxID_ANY
,
3183 wxObject
*userData
= NULL
)
3185 DoBind(winid
, lastId
, eventType
,
3186 wxNewEventFunctor(eventType
, method
, handler
),
3190 template <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
3191 bool Unbind(const EventTag
&eventType
,
3192 void (Class::*method
)(EventArg
&),
3193 EventHandler
*handler
,
3194 int winid
= wxID_ANY
,
3195 int lastId
= wxID_ANY
,
3196 wxObject
*userData
= NULL
)
3198 return DoUnbind(winid
, lastId
, eventType
,
3199 wxMakeEventFunctor(eventType
, method
, handler
),
3202 #endif // wxHAS_EVENT_BIND
3204 wxList
* GetDynamicEventTable() const { return m_dynamicEvents
; }
3206 // User data can be associated with each wxEvtHandler
3207 void SetClientObject( wxClientData
*data
) { DoSetClientObject(data
); }
3208 wxClientData
*GetClientObject() const { return DoGetClientObject(); }
3210 void SetClientData( void *data
) { DoSetClientData(data
); }
3211 void *GetClientData() const { return DoGetClientData(); }
3214 // implementation from now on
3215 // --------------------------
3217 // check if the given event table entry matches this event by id (the check
3218 // for the event type should be done by caller) and call the handler if it
3221 // return true if the event was processed, false otherwise (no match or the
3222 // handler decided to skip the event)
3223 static bool ProcessEventIfMatchesId(const wxEventTableEntryBase
& tableEntry
,
3224 wxEvtHandler
*handler
,
3227 virtual bool SearchEventTable(wxEventTable
& table
, wxEvent
& event
);
3228 bool SearchDynamicEventTable( wxEvent
& event
);
3230 // Avoid problems at exit by cleaning up static hash table gracefully
3231 void ClearEventHashTable() { GetEventHashTable().Clear(); }
3232 void OnSinkDestroyed( wxEvtHandler
*sink
);
3236 void DoBind(int winid
,
3238 wxEventType eventType
,
3239 wxEventFunctor
*func
,
3240 wxObject
* userData
= NULL
);
3242 bool DoUnbind(int winid
,
3244 wxEventType eventType
,
3245 const wxEventFunctor
& func
,
3246 wxObject
*userData
= NULL
);
3248 static const wxEventTableEntry sm_eventTableEntries
[];
3251 // hooks for wxWindow used by ProcessEvent()
3252 // -----------------------------------------
3254 // this one is called before trying our own event table to allow plugging
3255 // in the event handlers overriding the default logic, this is used by e.g.
3257 virtual bool TryBefore(wxEvent
& event
);
3259 // this one is not a hook but just a helper which looks up the handler in
3260 // this object itself called from ProcessEventLocally() and normally
3261 // shouldn't be called directly as doing it would ignore any chained event
3263 bool TryHere(wxEvent
& event
);
3265 // this one is called after failing to find the event handle in our own
3266 // table to give a chance to the other windows to process it
3268 // base class implementation passes the event to wxTheApp
3269 virtual bool TryAfter(wxEvent
& event
);
3271 #ifdef WXWIN_COMPATIBILITY_2_8
3272 // deprecated method: override TryBefore() instead of this one
3273 wxDEPRECATED_BUT_USED_INTERNALLY_INLINE(
3274 virtual bool TryValidator(wxEvent
& WXUNUSED(event
)), return false; )
3276 wxDEPRECATED_BUT_USED_INTERNALLY_INLINE(
3277 virtual bool TryParent(wxEvent
& event
), return DoTryApp(event
); )
3278 #endif // WXWIN_COMPATIBILITY_2_8
3281 static const wxEventTable sm_eventTable
;
3282 virtual const wxEventTable
*GetEventTable() const;
3284 static wxEventHashTable sm_eventHashTable
;
3285 virtual wxEventHashTable
& GetEventHashTable() const;
3287 wxEvtHandler
* m_nextHandler
;
3288 wxEvtHandler
* m_previousHandler
;
3289 wxList
* m_dynamicEvents
;
3290 wxList
* m_pendingEvents
;
3293 // critical section protecting m_pendingEvents
3294 wxCriticalSection m_pendingEventsLock
;
3295 #endif // wxUSE_THREADS
3297 // Is event handler enabled?
3301 // The user data: either an object which will be deleted by the container
3302 // when it's deleted or some raw pointer which we do nothing with - only
3303 // one type of data can be used with the given window (i.e. you cannot set
3304 // the void data and then associate the container with wxClientData or vice
3308 wxClientData
*m_clientObject
;
3312 // what kind of data do we have?
3313 wxClientDataType m_clientDataType
;
3315 // client data accessors
3316 virtual void DoSetClientObject( wxClientData
*data
);
3317 virtual wxClientData
*DoGetClientObject() const;
3319 virtual void DoSetClientData( void *data
);
3320 virtual void *DoGetClientData() const;
3322 // Search tracker objects for event connection with this sink
3323 wxEventConnectionRef
*FindRefInTrackerList(wxEvtHandler
*handler
);
3326 // pass the event to wxTheApp instance, called from TryAfter()
3327 bool DoTryApp(wxEvent
& event
);
3329 // try to process events in all handlers chained to this one
3330 bool DoTryChain(wxEvent
& event
);
3332 DECLARE_DYNAMIC_CLASS_NO_COPY(wxEvtHandler
)
3335 WX_DEFINE_ARRAY_WITH_DECL_PTR(wxEvtHandler
*, wxEvtHandlerArray
, class WXDLLIMPEXP_BASE
);
3337 // ----------------------------------------------------------------------------
3338 // wxEventConnectionRef represents all connections between two event handlers
3339 // and enables automatic disconnect when an event handler sink goes out of
3340 // scope. Each connection/disconnect increases/decreases ref count, and
3341 // when it reaches zero the node goes out of scope.
3342 // ----------------------------------------------------------------------------
3344 class wxEventConnectionRef
: public wxTrackerNode
3347 wxEventConnectionRef() : m_src(NULL
), m_sink(NULL
), m_refCount(0) { }
3348 wxEventConnectionRef(wxEvtHandler
*src
, wxEvtHandler
*sink
)
3349 : m_src(src
), m_sink(sink
), m_refCount(1)
3351 m_sink
->AddNode(this);
3354 // The sink is being destroyed
3355 virtual void OnObjectDestroy( )
3358 m_src
->OnSinkDestroyed( m_sink
);
3362 virtual wxEventConnectionRef
*ToEventConnection() { return this; }
3364 void IncRef() { m_refCount
++; }
3367 if ( !--m_refCount
)
3369 // The sink holds the only external pointer to this object
3371 m_sink
->RemoveNode(this);
3377 wxEvtHandler
*m_src
,
3381 friend class wxEvtHandler
;
3383 wxDECLARE_NO_ASSIGN_CLASS(wxEventConnectionRef
);
3386 // Post a message to the given event handler which will be processed during the
3387 // next event loop iteration.
3389 // Notice that this one is not thread-safe, use wxQueueEvent()
3390 inline void wxPostEvent(wxEvtHandler
*dest
, const wxEvent
& event
)
3392 wxCHECK_RET( dest
, "need an object to post event to" );
3394 dest
->AddPendingEvent(event
);
3397 // Wrapper around wxEvtHandler::QueueEvent(): adds an event for later
3398 // processing, unlike wxPostEvent it is safe to use from different thread even
3399 // for events with wxString members
3400 inline void wxQueueEvent(wxEvtHandler
*dest
, wxEvent
*event
)
3402 wxCHECK_RET( dest
, "need an object to queue event for" );
3404 dest
->QueueEvent(event
);
3407 typedef void (wxEvtHandler::*wxEventFunction
)(wxEvent
&);
3408 typedef void (wxEvtHandler::*wxIdleEventFunction
)(wxIdleEvent
&);
3410 #define wxEventHandler(func) \
3411 wxEVENT_HANDLER_CAST(wxEventFunction, func)
3412 #define wxIdleEventHandler(func) \
3413 wxEVENT_HANDLER_CAST(wxIdleEventFunction, func)
3417 // ----------------------------------------------------------------------------
3418 // wxEventBlocker: helper class to temporarily disable event handling for a window
3419 // ----------------------------------------------------------------------------
3421 class WXDLLIMPEXP_CORE wxEventBlocker
: public wxEvtHandler
3424 wxEventBlocker(wxWindow
*win
, wxEventType type
= wxEVT_ANY
);
3425 virtual ~wxEventBlocker();
3427 void Block(wxEventType type
)
3429 m_eventsToBlock
.push_back(type
);
3432 virtual bool ProcessEvent(wxEvent
& event
);
3435 wxArrayInt m_eventsToBlock
;
3438 wxDECLARE_NO_COPY_CLASS(wxEventBlocker
);
3441 typedef void (wxEvtHandler::*wxCommandEventFunction
)(wxCommandEvent
&);
3442 typedef void (wxEvtHandler::*wxThreadEventFunction
)(wxThreadEvent
&);
3443 typedef void (wxEvtHandler::*wxScrollEventFunction
)(wxScrollEvent
&);
3444 typedef void (wxEvtHandler::*wxScrollWinEventFunction
)(wxScrollWinEvent
&);
3445 typedef void (wxEvtHandler::*wxSizeEventFunction
)(wxSizeEvent
&);
3446 typedef void (wxEvtHandler::*wxMoveEventFunction
)(wxMoveEvent
&);
3447 typedef void (wxEvtHandler::*wxPaintEventFunction
)(wxPaintEvent
&);
3448 typedef void (wxEvtHandler::*wxNcPaintEventFunction
)(wxNcPaintEvent
&);
3449 typedef void (wxEvtHandler::*wxEraseEventFunction
)(wxEraseEvent
&);
3450 typedef void (wxEvtHandler::*wxMouseEventFunction
)(wxMouseEvent
&);
3451 typedef void (wxEvtHandler::*wxCharEventFunction
)(wxKeyEvent
&);
3452 typedef void (wxEvtHandler::*wxFocusEventFunction
)(wxFocusEvent
&);
3453 typedef void (wxEvtHandler::*wxChildFocusEventFunction
)(wxChildFocusEvent
&);
3454 typedef void (wxEvtHandler::*wxActivateEventFunction
)(wxActivateEvent
&);
3455 typedef void (wxEvtHandler::*wxMenuEventFunction
)(wxMenuEvent
&);
3456 typedef void (wxEvtHandler::*wxJoystickEventFunction
)(wxJoystickEvent
&);
3457 typedef void (wxEvtHandler::*wxDropFilesEventFunction
)(wxDropFilesEvent
&);
3458 typedef void (wxEvtHandler::*wxInitDialogEventFunction
)(wxInitDialogEvent
&);
3459 typedef void (wxEvtHandler::*wxSysColourChangedEventFunction
)(wxSysColourChangedEvent
&);
3460 typedef void (wxEvtHandler::*wxDisplayChangedEventFunction
)(wxDisplayChangedEvent
&);
3461 typedef void (wxEvtHandler::*wxUpdateUIEventFunction
)(wxUpdateUIEvent
&);
3462 typedef void (wxEvtHandler::*wxCloseEventFunction
)(wxCloseEvent
&);
3463 typedef void (wxEvtHandler::*wxShowEventFunction
)(wxShowEvent
&);
3464 typedef void (wxEvtHandler::*wxIconizeEventFunction
)(wxIconizeEvent
&);
3465 typedef void (wxEvtHandler::*wxMaximizeEventFunction
)(wxMaximizeEvent
&);
3466 typedef void (wxEvtHandler::*wxNavigationKeyEventFunction
)(wxNavigationKeyEvent
&);
3467 typedef void (wxEvtHandler::*wxPaletteChangedEventFunction
)(wxPaletteChangedEvent
&);
3468 typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction
)(wxQueryNewPaletteEvent
&);
3469 typedef void (wxEvtHandler::*wxWindowCreateEventFunction
)(wxWindowCreateEvent
&);
3470 typedef void (wxEvtHandler::*wxWindowDestroyEventFunction
)(wxWindowDestroyEvent
&);
3471 typedef void (wxEvtHandler::*wxSetCursorEventFunction
)(wxSetCursorEvent
&);
3472 typedef void (wxEvtHandler::*wxNotifyEventFunction
)(wxNotifyEvent
&);
3473 typedef void (wxEvtHandler::*wxHelpEventFunction
)(wxHelpEvent
&);
3474 typedef void (wxEvtHandler::*wxContextMenuEventFunction
)(wxContextMenuEvent
&);
3475 typedef void (wxEvtHandler::*wxMouseCaptureChangedEventFunction
)(wxMouseCaptureChangedEvent
&);
3476 typedef void (wxEvtHandler::*wxMouseCaptureLostEventFunction
)(wxMouseCaptureLostEvent
&);
3477 typedef void (wxEvtHandler::*wxClipboardTextEventFunction
)(wxClipboardTextEvent
&);
3480 #define wxCommandEventHandler(func) \
3481 wxEVENT_HANDLER_CAST(wxCommandEventFunction, func)
3482 #define wxThreadEventHandler(func) \
3483 wxEVENT_HANDLER_CAST(wxThreadEventFunction, func)
3484 #define wxScrollEventHandler(func) \
3485 wxEVENT_HANDLER_CAST(wxScrollEventFunction, func)
3486 #define wxScrollWinEventHandler(func) \
3487 wxEVENT_HANDLER_CAST(wxScrollWinEventFunction, func)
3488 #define wxSizeEventHandler(func) \
3489 wxEVENT_HANDLER_CAST(wxSizeEventFunction, func)
3490 #define wxMoveEventHandler(func) \
3491 wxEVENT_HANDLER_CAST(wxMoveEventFunction, func)
3492 #define wxPaintEventHandler(func) \
3493 wxEVENT_HANDLER_CAST(wxPaintEventFunction, func)
3494 #define wxNcPaintEventHandler(func) \
3495 wxEVENT_HANDLER_CAST(wxNcPaintEventFunction, func)
3496 #define wxEraseEventHandler(func) \
3497 wxEVENT_HANDLER_CAST(wxEraseEventFunction, func)
3498 #define wxMouseEventHandler(func) \
3499 wxEVENT_HANDLER_CAST(wxMouseEventFunction, func)
3500 #define wxCharEventHandler(func) \
3501 wxEVENT_HANDLER_CAST(wxCharEventFunction, func)
3502 #define wxKeyEventHandler(func) wxCharEventHandler(func)
3503 #define wxFocusEventHandler(func) \
3504 wxEVENT_HANDLER_CAST(wxFocusEventFunction, func)
3505 #define wxChildFocusEventHandler(func) \
3506 wxEVENT_HANDLER_CAST(wxChildFocusEventFunction, func)
3507 #define wxActivateEventHandler(func) \
3508 wxEVENT_HANDLER_CAST(wxActivateEventFunction, func)
3509 #define wxMenuEventHandler(func) \
3510 wxEVENT_HANDLER_CAST(wxMenuEventFunction, func)
3511 #define wxJoystickEventHandler(func) \
3512 wxEVENT_HANDLER_CAST(wxJoystickEventFunction, func)
3513 #define wxDropFilesEventHandler(func) \
3514 wxEVENT_HANDLER_CAST(wxDropFilesEventFunction, func)
3515 #define wxInitDialogEventHandler(func) \
3516 wxEVENT_HANDLER_CAST(wxInitDialogEventFunction, func)
3517 #define wxSysColourChangedEventHandler(func) \
3518 wxEVENT_HANDLER_CAST(wxSysColourChangedEventFunction, func)
3519 #define wxDisplayChangedEventHandler(func) \
3520 wxEVENT_HANDLER_CAST(wxDisplayChangedEventFunction, func)
3521 #define wxUpdateUIEventHandler(func) \
3522 wxEVENT_HANDLER_CAST(wxUpdateUIEventFunction, func)
3523 #define wxCloseEventHandler(func) \
3524 wxEVENT_HANDLER_CAST(wxCloseEventFunction, func)
3525 #define wxShowEventHandler(func) \
3526 wxEVENT_HANDLER_CAST(wxShowEventFunction, func)
3527 #define wxIconizeEventHandler(func) \
3528 wxEVENT_HANDLER_CAST(wxIconizeEventFunction, func)
3529 #define wxMaximizeEventHandler(func) \
3530 wxEVENT_HANDLER_CAST(wxMaximizeEventFunction, func)
3531 #define wxNavigationKeyEventHandler(func) \
3532 wxEVENT_HANDLER_CAST(wxNavigationKeyEventFunction, func)
3533 #define wxPaletteChangedEventHandler(func) \
3534 wxEVENT_HANDLER_CAST(wxPaletteChangedEventFunction, func)
3535 #define wxQueryNewPaletteEventHandler(func) \
3536 wxEVENT_HANDLER_CAST(wxQueryNewPaletteEventFunction, func)
3537 #define wxWindowCreateEventHandler(func) \
3538 wxEVENT_HANDLER_CAST(wxWindowCreateEventFunction, func)
3539 #define wxWindowDestroyEventHandler(func) \
3540 wxEVENT_HANDLER_CAST(wxWindowDestroyEventFunction, func)
3541 #define wxSetCursorEventHandler(func) \
3542 wxEVENT_HANDLER_CAST(wxSetCursorEventFunction, func)
3543 #define wxNotifyEventHandler(func) \
3544 wxEVENT_HANDLER_CAST(wxNotifyEventFunction, func)
3545 #define wxHelpEventHandler(func) \
3546 wxEVENT_HANDLER_CAST(wxHelpEventFunction, func)
3547 #define wxContextMenuEventHandler(func) \
3548 wxEVENT_HANDLER_CAST(wxContextMenuEventFunction, func)
3549 #define wxMouseCaptureChangedEventHandler(func) \
3550 wxEVENT_HANDLER_CAST(wxMouseCaptureChangedEventFunction, func)
3551 #define wxMouseCaptureLostEventHandler(func) \
3552 wxEVENT_HANDLER_CAST(wxMouseCaptureLostEventFunction, func)
3553 #define wxClipboardTextEventHandler(func) \
3554 wxEVENT_HANDLER_CAST(wxClipboardTextEventFunction, func)
3558 // N.B. In GNU-WIN32, you *have* to take the address of a member function
3559 // (use &) or the compiler crashes...
3561 #define DECLARE_EVENT_TABLE() \
3563 static const wxEventTableEntry sm_eventTableEntries[]; \
3565 static const wxEventTable sm_eventTable; \
3566 virtual const wxEventTable* GetEventTable() const; \
3567 static wxEventHashTable sm_eventHashTable; \
3568 virtual wxEventHashTable& GetEventHashTable() const;
3570 // N.B.: when building DLL with Borland C++ 5.5 compiler, you must initialize
3571 // sm_eventTable before using it in GetEventTable() or the compiler gives
3572 // E2233 (see http://groups.google.com/groups?selm=397dcc8a%241_2%40dnews)
3574 #define BEGIN_EVENT_TABLE(theClass, baseClass) \
3575 const wxEventTable theClass::sm_eventTable = \
3576 { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] }; \
3577 const wxEventTable *theClass::GetEventTable() const \
3578 { return &theClass::sm_eventTable; } \
3579 wxEventHashTable theClass::sm_eventHashTable(theClass::sm_eventTable); \
3580 wxEventHashTable &theClass::GetEventHashTable() const \
3581 { return theClass::sm_eventHashTable; } \
3582 const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
3584 #define BEGIN_EVENT_TABLE_TEMPLATE1(theClass, baseClass, T1) \
3585 template<typename T1> \
3586 const wxEventTable theClass<T1>::sm_eventTable = \
3587 { &baseClass::sm_eventTable, &theClass<T1>::sm_eventTableEntries[0] }; \
3588 template<typename T1> \
3589 const wxEventTable *theClass<T1>::GetEventTable() const \
3590 { return &theClass<T1>::sm_eventTable; } \
3591 template<typename T1> \
3592 wxEventHashTable theClass<T1>::sm_eventHashTable(theClass<T1>::sm_eventTable); \
3593 template<typename T1> \
3594 wxEventHashTable &theClass<T1>::GetEventHashTable() const \
3595 { return theClass<T1>::sm_eventHashTable; } \
3596 template<typename T1> \
3597 const wxEventTableEntry theClass<T1>::sm_eventTableEntries[] = { \
3599 #define BEGIN_EVENT_TABLE_TEMPLATE2(theClass, baseClass, T1, T2) \
3600 template<typename T1, typename T2> \
3601 const wxEventTable theClass<T1, T2>::sm_eventTable = \
3602 { &baseClass::sm_eventTable, &theClass<T1, T2>::sm_eventTableEntries[0] }; \
3603 template<typename T1, typename T2> \
3604 const wxEventTable *theClass<T1, T2>::GetEventTable() const \
3605 { return &theClass<T1, T2>::sm_eventTable; } \
3606 template<typename T1, typename T2> \
3607 wxEventHashTable theClass<T1, T2>::sm_eventHashTable(theClass<T1, T2>::sm_eventTable); \
3608 template<typename T1, typename T2> \
3609 wxEventHashTable &theClass<T1, T2>::GetEventHashTable() const \
3610 { return theClass<T1, T2>::sm_eventHashTable; } \
3611 template<typename T1, typename T2> \
3612 const wxEventTableEntry theClass<T1, T2>::sm_eventTableEntries[] = { \
3614 #define BEGIN_EVENT_TABLE_TEMPLATE3(theClass, baseClass, T1, T2, T3) \
3615 template<typename T1, typename T2, typename T3> \
3616 const wxEventTable theClass<T1, T2, T3>::sm_eventTable = \
3617 { &baseClass::sm_eventTable, &theClass<T1, T2, T3>::sm_eventTableEntries[0] }; \
3618 template<typename T1, typename T2, typename T3> \
3619 const wxEventTable *theClass<T1, T2, T3>::GetEventTable() const \
3620 { return &theClass<T1, T2, T3>::sm_eventTable; } \
3621 template<typename T1, typename T2, typename T3> \
3622 wxEventHashTable theClass<T1, T2, T3>::sm_eventHashTable(theClass<T1, T2, T3>::sm_eventTable); \
3623 template<typename T1, typename T2, typename T3> \
3624 wxEventHashTable &theClass<T1, T2, T3>::GetEventHashTable() const \
3625 { return theClass<T1, T2, T3>::sm_eventHashTable; } \
3626 template<typename T1, typename T2, typename T3> \
3627 const wxEventTableEntry theClass<T1, T2, T3>::sm_eventTableEntries[] = { \
3629 #define BEGIN_EVENT_TABLE_TEMPLATE4(theClass, baseClass, T1, T2, T3, T4) \
3630 template<typename T1, typename T2, typename T3, typename T4> \
3631 const wxEventTable theClass<T1, T2, T3, T4>::sm_eventTable = \
3632 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4>::sm_eventTableEntries[0] }; \
3633 template<typename T1, typename T2, typename T3, typename T4> \
3634 const wxEventTable *theClass<T1, T2, T3, T4>::GetEventTable() const \
3635 { return &theClass<T1, T2, T3, T4>::sm_eventTable; } \
3636 template<typename T1, typename T2, typename T3, typename T4> \
3637 wxEventHashTable theClass<T1, T2, T3, T4>::sm_eventHashTable(theClass<T1, T2, T3, T4>::sm_eventTable); \
3638 template<typename T1, typename T2, typename T3, typename T4> \
3639 wxEventHashTable &theClass<T1, T2, T3, T4>::GetEventHashTable() const \
3640 { return theClass<T1, T2, T3, T4>::sm_eventHashTable; } \
3641 template<typename T1, typename T2, typename T3, typename T4> \
3642 const wxEventTableEntry theClass<T1, T2, T3, T4>::sm_eventTableEntries[] = { \
3644 #define BEGIN_EVENT_TABLE_TEMPLATE5(theClass, baseClass, T1, T2, T3, T4, T5) \
3645 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3646 const wxEventTable theClass<T1, T2, T3, T4, T5>::sm_eventTable = \
3647 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[0] }; \
3648 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3649 const wxEventTable *theClass<T1, T2, T3, T4, T5>::GetEventTable() const \
3650 { return &theClass<T1, T2, T3, T4, T5>::sm_eventTable; } \
3651 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3652 wxEventHashTable theClass<T1, T2, T3, T4, T5>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5>::sm_eventTable); \
3653 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3654 wxEventHashTable &theClass<T1, T2, T3, T4, T5>::GetEventHashTable() const \
3655 { return theClass<T1, T2, T3, T4, T5>::sm_eventHashTable; } \
3656 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3657 const wxEventTableEntry theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[] = { \
3659 #define BEGIN_EVENT_TABLE_TEMPLATE7(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7) \
3660 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3661 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable = \
3662 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[0] }; \
3663 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3664 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventTable() const \
3665 { return &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable; } \
3666 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3667 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable); \
3668 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3669 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventHashTable() const \
3670 { return theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable; } \
3671 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3672 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[] = { \
3674 #define BEGIN_EVENT_TABLE_TEMPLATE8(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7, T8) \
3675 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3676 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable = \
3677 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[0] }; \
3678 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3679 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventTable() const \
3680 { return &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable; } \
3681 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3682 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable); \
3683 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3684 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventHashTable() const \
3685 { return theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable; } \
3686 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3687 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[] = { \
3689 #define END_EVENT_TABLE() DECLARE_EVENT_TABLE_TERMINATOR() };
3692 * Event table macros
3695 // helpers for writing shorter code below: declare an event macro taking 2, 1
3696 // or none ids (the missing ids default to wxID_ANY)
3699 // - evt one of wxEVT_XXX constants
3700 // - id1, id2 ids of the first/last id
3701 // - fn the function (should be cast to the right type)
3702 #define wx__DECLARE_EVT2(evt, id1, id2, fn) \
3703 DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
3704 #define wx__DECLARE_EVT1(evt, id, fn) \
3705 wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
3706 #define wx__DECLARE_EVT0(evt, fn) \
3707 wx__DECLARE_EVT1(evt, wxID_ANY, fn)
3711 #define EVT_CUSTOM(event, winid, func) \
3712 wx__DECLARE_EVT1(event, winid, wxEventHandler(func))
3713 #define EVT_CUSTOM_RANGE(event, id1, id2, func) \
3714 wx__DECLARE_EVT2(event, id1, id2, wxEventHandler(func))
3717 #define EVT_COMMAND(winid, event, func) \
3718 wx__DECLARE_EVT1(event, winid, wxCommandEventHandler(func))
3720 #define EVT_COMMAND_RANGE(id1, id2, event, func) \
3721 wx__DECLARE_EVT2(event, id1, id2, wxCommandEventHandler(func))
3723 #define EVT_NOTIFY(event, winid, func) \
3724 wx__DECLARE_EVT1(event, winid, wxNotifyEventHandler(func))
3726 #define EVT_NOTIFY_RANGE(event, id1, id2, func) \
3727 wx__DECLARE_EVT2(event, id1, id2, wxNotifyEventHandler(func))
3730 #define EVT_SIZE(func) wx__DECLARE_EVT0(wxEVT_SIZE, wxSizeEventHandler(func))
3731 #define EVT_SIZING(func) wx__DECLARE_EVT0(wxEVT_SIZING, wxSizeEventHandler(func))
3732 #define EVT_MOVE(func) wx__DECLARE_EVT0(wxEVT_MOVE, wxMoveEventHandler(func))
3733 #define EVT_MOVING(func) wx__DECLARE_EVT0(wxEVT_MOVING, wxMoveEventHandler(func))
3734 #define EVT_MOVE_START(func) wx__DECLARE_EVT0(wxEVT_MOVE_START, wxMoveEventHandler(func))
3735 #define EVT_MOVE_END(func) wx__DECLARE_EVT0(wxEVT_MOVE_END, wxMoveEventHandler(func))
3736 #define EVT_CLOSE(func) wx__DECLARE_EVT0(wxEVT_CLOSE_WINDOW, wxCloseEventHandler(func))
3737 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3738 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3739 #define EVT_PAINT(func) wx__DECLARE_EVT0(wxEVT_PAINT, wxPaintEventHandler(func))
3740 #define EVT_NC_PAINT(func) wx__DECLARE_EVT0(wxEVT_NC_PAINT, wxNcPaintEventHandler(func))
3741 #define EVT_ERASE_BACKGROUND(func) wx__DECLARE_EVT0(wxEVT_ERASE_BACKGROUND, wxEraseEventHandler(func))
3742 #define EVT_CHAR(func) wx__DECLARE_EVT0(wxEVT_CHAR, wxCharEventHandler(func))
3743 #define EVT_KEY_DOWN(func) wx__DECLARE_EVT0(wxEVT_KEY_DOWN, wxKeyEventHandler(func))
3744 #define EVT_KEY_UP(func) wx__DECLARE_EVT0(wxEVT_KEY_UP, wxKeyEventHandler(func))
3746 #define EVT_HOTKEY(winid, func) wx__DECLARE_EVT1(wxEVT_HOTKEY, winid, wxCharEventHandler(func))
3748 #define EVT_CHAR_HOOK(func) wx__DECLARE_EVT0(wxEVT_CHAR_HOOK, wxCharEventHandler(func))
3749 #define EVT_MENU_OPEN(func) wx__DECLARE_EVT0(wxEVT_MENU_OPEN, wxMenuEventHandler(func))
3750 #define EVT_MENU_CLOSE(func) wx__DECLARE_EVT0(wxEVT_MENU_CLOSE, wxMenuEventHandler(func))
3751 #define EVT_MENU_HIGHLIGHT(winid, func) wx__DECLARE_EVT1(wxEVT_MENU_HIGHLIGHT, winid, wxMenuEventHandler(func))
3752 #define EVT_MENU_HIGHLIGHT_ALL(func) wx__DECLARE_EVT0(wxEVT_MENU_HIGHLIGHT, wxMenuEventHandler(func))
3753 #define EVT_SET_FOCUS(func) wx__DECLARE_EVT0(wxEVT_SET_FOCUS, wxFocusEventHandler(func))
3754 #define EVT_KILL_FOCUS(func) wx__DECLARE_EVT0(wxEVT_KILL_FOCUS, wxFocusEventHandler(func))
3755 #define EVT_CHILD_FOCUS(func) wx__DECLARE_EVT0(wxEVT_CHILD_FOCUS, wxChildFocusEventHandler(func))
3756 #define EVT_ACTIVATE(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE, wxActivateEventHandler(func))
3757 #define EVT_ACTIVATE_APP(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE_APP, wxActivateEventHandler(func))
3758 #define EVT_HIBERNATE(func) wx__DECLARE_EVT0(wxEVT_HIBERNATE, wxActivateEventHandler(func))
3759 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3760 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3761 #define EVT_DROP_FILES(func) wx__DECLARE_EVT0(wxEVT_DROP_FILES, wxDropFilesEventHandler(func))
3762 #define EVT_INIT_DIALOG(func) wx__DECLARE_EVT0(wxEVT_INIT_DIALOG, wxInitDialogEventHandler(func))
3763 #define EVT_SYS_COLOUR_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEventHandler(func))
3764 #define EVT_DISPLAY_CHANGED(func) wx__DECLARE_EVT0(wxEVT_DISPLAY_CHANGED, wxDisplayChangedEventHandler(func))
3765 #define EVT_SHOW(func) wx__DECLARE_EVT0(wxEVT_SHOW, wxShowEventHandler(func))
3766 #define EVT_MAXIMIZE(func) wx__DECLARE_EVT0(wxEVT_MAXIMIZE, wxMaximizeEventHandler(func))
3767 #define EVT_ICONIZE(func) wx__DECLARE_EVT0(wxEVT_ICONIZE, wxIconizeEventHandler(func))
3768 #define EVT_NAVIGATION_KEY(func) wx__DECLARE_EVT0(wxEVT_NAVIGATION_KEY, wxNavigationKeyEventHandler(func))
3769 #define EVT_PALETTE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_PALETTE_CHANGED, wxPaletteChangedEventHandler(func))
3770 #define EVT_QUERY_NEW_PALETTE(func) wx__DECLARE_EVT0(wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEventHandler(func))
3771 #define EVT_WINDOW_CREATE(func) wx__DECLARE_EVT0(wxEVT_CREATE, wxWindowCreateEventHandler(func))
3772 #define EVT_WINDOW_DESTROY(func) wx__DECLARE_EVT0(wxEVT_DESTROY, wxWindowDestroyEventHandler(func))
3773 #define EVT_SET_CURSOR(func) wx__DECLARE_EVT0(wxEVT_SET_CURSOR, wxSetCursorEventHandler(func))
3774 #define EVT_MOUSE_CAPTURE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEventHandler(func))
3775 #define EVT_MOUSE_CAPTURE_LOST(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEventHandler(func))
3778 #define EVT_LEFT_DOWN(func) wx__DECLARE_EVT0(wxEVT_LEFT_DOWN, wxMouseEventHandler(func))
3779 #define EVT_LEFT_UP(func) wx__DECLARE_EVT0(wxEVT_LEFT_UP, wxMouseEventHandler(func))
3780 #define EVT_MIDDLE_DOWN(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DOWN, wxMouseEventHandler(func))
3781 #define EVT_MIDDLE_UP(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_UP, wxMouseEventHandler(func))
3782 #define EVT_RIGHT_DOWN(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DOWN, wxMouseEventHandler(func))
3783 #define EVT_RIGHT_UP(func) wx__DECLARE_EVT0(wxEVT_RIGHT_UP, wxMouseEventHandler(func))
3784 #define EVT_MOTION(func) wx__DECLARE_EVT0(wxEVT_MOTION, wxMouseEventHandler(func))
3785 #define EVT_LEFT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_LEFT_DCLICK, wxMouseEventHandler(func))
3786 #define EVT_MIDDLE_DCLICK(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DCLICK, wxMouseEventHandler(func))
3787 #define EVT_RIGHT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DCLICK, wxMouseEventHandler(func))
3788 #define EVT_LEAVE_WINDOW(func) wx__DECLARE_EVT0(wxEVT_LEAVE_WINDOW, wxMouseEventHandler(func))
3789 #define EVT_ENTER_WINDOW(func) wx__DECLARE_EVT0(wxEVT_ENTER_WINDOW, wxMouseEventHandler(func))
3790 #define EVT_MOUSEWHEEL(func) wx__DECLARE_EVT0(wxEVT_MOUSEWHEEL, wxMouseEventHandler(func))
3791 #define EVT_MOUSE_AUX1_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX1_DOWN, wxMouseEventHandler(func))
3792 #define EVT_MOUSE_AUX1_UP(func) wx__DECLARE_EVT0(wxEVT_AUX1_UP, wxMouseEventHandler(func))
3793 #define EVT_MOUSE_AUX1_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX1_DCLICK, wxMouseEventHandler(func))
3794 #define EVT_MOUSE_AUX2_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX2_DOWN, wxMouseEventHandler(func))
3795 #define EVT_MOUSE_AUX2_UP(func) wx__DECLARE_EVT0(wxEVT_AUX2_UP, wxMouseEventHandler(func))
3796 #define EVT_MOUSE_AUX2_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX2_DCLICK, wxMouseEventHandler(func))
3799 #define EVT_MOUSE_EVENTS(func) \
3800 EVT_LEFT_DOWN(func) \
3802 EVT_LEFT_DCLICK(func) \
3803 EVT_MIDDLE_DOWN(func) \
3804 EVT_MIDDLE_UP(func) \
3805 EVT_MIDDLE_DCLICK(func) \
3806 EVT_RIGHT_DOWN(func) \
3807 EVT_RIGHT_UP(func) \
3808 EVT_RIGHT_DCLICK(func) \
3809 EVT_MOUSE_AUX1_DOWN(func) \
3810 EVT_MOUSE_AUX1_UP(func) \
3811 EVT_MOUSE_AUX1_DCLICK(func) \
3812 EVT_MOUSE_AUX2_DOWN(func) \
3813 EVT_MOUSE_AUX2_UP(func) \
3814 EVT_MOUSE_AUX2_DCLICK(func) \
3816 EVT_LEAVE_WINDOW(func) \
3817 EVT_ENTER_WINDOW(func) \
3818 EVT_MOUSEWHEEL(func)
3820 // Scrolling from wxWindow (sent to wxScrolledWindow)
3821 #define EVT_SCROLLWIN_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_TOP, wxScrollWinEventHandler(func))
3822 #define EVT_SCROLLWIN_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEventHandler(func))
3823 #define EVT_SCROLLWIN_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEUP, wxScrollWinEventHandler(func))
3824 #define EVT_SCROLLWIN_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEventHandler(func))
3825 #define EVT_SCROLLWIN_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEventHandler(func))
3826 #define EVT_SCROLLWIN_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEventHandler(func))
3827 #define EVT_SCROLLWIN_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEventHandler(func))
3828 #define EVT_SCROLLWIN_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEventHandler(func))
3830 #define EVT_SCROLLWIN(func) \
3831 EVT_SCROLLWIN_TOP(func) \
3832 EVT_SCROLLWIN_BOTTOM(func) \
3833 EVT_SCROLLWIN_LINEUP(func) \
3834 EVT_SCROLLWIN_LINEDOWN(func) \
3835 EVT_SCROLLWIN_PAGEUP(func) \
3836 EVT_SCROLLWIN_PAGEDOWN(func) \
3837 EVT_SCROLLWIN_THUMBTRACK(func) \
3838 EVT_SCROLLWIN_THUMBRELEASE(func)
3840 // Scrolling from wxSlider and wxScrollBar
3841 #define EVT_SCROLL_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_TOP, wxScrollEventHandler(func))
3842 #define EVT_SCROLL_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLL_BOTTOM, wxScrollEventHandler(func))
3843 #define EVT_SCROLL_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEUP, wxScrollEventHandler(func))
3844 #define EVT_SCROLL_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEDOWN, wxScrollEventHandler(func))
3845 #define EVT_SCROLL_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEUP, wxScrollEventHandler(func))
3846 #define EVT_SCROLL_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler(func))
3847 #define EVT_SCROLL_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler(func))
3848 #define EVT_SCROLL_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBRELEASE, wxScrollEventHandler(func))
3849 #define EVT_SCROLL_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SCROLL_CHANGED, wxScrollEventHandler(func))
3851 #define EVT_SCROLL(func) \
3852 EVT_SCROLL_TOP(func) \
3853 EVT_SCROLL_BOTTOM(func) \
3854 EVT_SCROLL_LINEUP(func) \
3855 EVT_SCROLL_LINEDOWN(func) \
3856 EVT_SCROLL_PAGEUP(func) \
3857 EVT_SCROLL_PAGEDOWN(func) \
3858 EVT_SCROLL_THUMBTRACK(func) \
3859 EVT_SCROLL_THUMBRELEASE(func) \
3860 EVT_SCROLL_CHANGED(func)
3862 // Scrolling from wxSlider and wxScrollBar, with an id
3863 #define EVT_COMMAND_SCROLL_TOP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_TOP, winid, wxScrollEventHandler(func))
3864 #define EVT_COMMAND_SCROLL_BOTTOM(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_BOTTOM, winid, wxScrollEventHandler(func))
3865 #define EVT_COMMAND_SCROLL_LINEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEUP, winid, wxScrollEventHandler(func))
3866 #define EVT_COMMAND_SCROLL_LINEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEDOWN, winid, wxScrollEventHandler(func))
3867 #define EVT_COMMAND_SCROLL_PAGEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEUP, winid, wxScrollEventHandler(func))
3868 #define EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEDOWN, winid, wxScrollEventHandler(func))
3869 #define EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBTRACK, winid, wxScrollEventHandler(func))
3870 #define EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBRELEASE, winid, wxScrollEventHandler(func))
3871 #define EVT_COMMAND_SCROLL_CHANGED(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_CHANGED, winid, wxScrollEventHandler(func))
3873 #define EVT_COMMAND_SCROLL(winid, func) \
3874 EVT_COMMAND_SCROLL_TOP(winid, func) \
3875 EVT_COMMAND_SCROLL_BOTTOM(winid, func) \
3876 EVT_COMMAND_SCROLL_LINEUP(winid, func) \
3877 EVT_COMMAND_SCROLL_LINEDOWN(winid, func) \
3878 EVT_COMMAND_SCROLL_PAGEUP(winid, func) \
3879 EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) \
3880 EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) \
3881 EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) \
3882 EVT_COMMAND_SCROLL_CHANGED(winid, func)
3884 #if WXWIN_COMPATIBILITY_2_6
3885 // compatibility macros for the old name, deprecated in 2.8
3886 #define wxEVT_SCROLL_ENDSCROLL wxEVT_SCROLL_CHANGED
3887 #define EVT_COMMAND_SCROLL_ENDSCROLL EVT_COMMAND_SCROLL_CHANGED
3888 #define EVT_SCROLL_ENDSCROLL EVT_SCROLL_CHANGED
3889 #endif // WXWIN_COMPATIBILITY_2_6
3891 // Convenience macros for commonly-used commands
3892 #define EVT_CHECKBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKBOX_CLICKED, winid, wxCommandEventHandler(func))
3893 #define EVT_CHOICE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHOICE_SELECTED, winid, wxCommandEventHandler(func))
3894 #define EVT_LISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_SELECTED, winid, wxCommandEventHandler(func))
3895 #define EVT_LISTBOX_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, winid, wxCommandEventHandler(func))
3896 #define EVT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_MENU_SELECTED, winid, wxCommandEventHandler(func))
3897 #define EVT_MENU_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_MENU_SELECTED, id1, id2, wxCommandEventHandler(func))
3898 #if defined(__SMARTPHONE__)
3899 # define EVT_BUTTON(winid, func) EVT_MENU(winid, func)
3901 # define EVT_BUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_BUTTON_CLICKED, winid, wxCommandEventHandler(func))
3903 #define EVT_SLIDER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SLIDER_UPDATED, winid, wxCommandEventHandler(func))
3904 #define EVT_RADIOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBOX_SELECTED, winid, wxCommandEventHandler(func))
3905 #define EVT_RADIOBUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBUTTON_SELECTED, winid, wxCommandEventHandler(func))
3906 // EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events
3907 #define EVT_SCROLLBAR(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SCROLLBAR_UPDATED, winid, wxCommandEventHandler(func))
3908 #define EVT_VLBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_VLBOX_SELECTED, winid, wxCommandEventHandler(func))
3909 #define EVT_COMBOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_SELECTED, winid, wxCommandEventHandler(func))
3910 #define EVT_TOOL(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_CLICKED, winid, wxCommandEventHandler(func))
3911 #define EVT_TOOL_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, winid, wxCommandEventHandler(func))
3912 #define EVT_TOOL_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_CLICKED, id1, id2, wxCommandEventHandler(func))
3913 #define EVT_TOOL_RCLICKED(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_RCLICKED, winid, wxCommandEventHandler(func))
3914 #define EVT_TOOL_RCLICKED_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, wxCommandEventHandler(func))
3915 #define EVT_TOOL_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_ENTER, winid, wxCommandEventHandler(func))
3916 #define EVT_CHECKLISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, winid, wxCommandEventHandler(func))
3917 #define EVT_COMBOBOX_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_DROPDOWN, winid, wxCommandEventHandler(func))
3918 #define EVT_COMBOBOX_CLOSEUP(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_CLOSEUP, winid, wxCommandEventHandler(func))
3920 // Generic command events
3921 #define EVT_COMMAND_LEFT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_CLICK, winid, wxCommandEventHandler(func))
3922 #define EVT_COMMAND_LEFT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_DCLICK, winid, wxCommandEventHandler(func))
3923 #define EVT_COMMAND_RIGHT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_CLICK, winid, wxCommandEventHandler(func))
3924 #define EVT_COMMAND_RIGHT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_DCLICK, winid, wxCommandEventHandler(func))
3925 #define EVT_COMMAND_SET_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SET_FOCUS, winid, wxCommandEventHandler(func))
3926 #define EVT_COMMAND_KILL_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_KILL_FOCUS, winid, wxCommandEventHandler(func))
3927 #define EVT_COMMAND_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_ENTER, winid, wxCommandEventHandler(func))
3931 #define EVT_JOY_BUTTON_DOWN(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_DOWN, wxJoystickEventHandler(func))
3932 #define EVT_JOY_BUTTON_UP(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_UP, wxJoystickEventHandler(func))
3933 #define EVT_JOY_MOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_MOVE, wxJoystickEventHandler(func))
3934 #define EVT_JOY_ZMOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_ZMOVE, wxJoystickEventHandler(func))
3936 // All joystick events
3937 #define EVT_JOYSTICK_EVENTS(func) \
3938 EVT_JOY_BUTTON_DOWN(func) \
3939 EVT_JOY_BUTTON_UP(func) \
3940 EVT_JOY_MOVE(func) \
3944 #define EVT_IDLE(func) wx__DECLARE_EVT0(wxEVT_IDLE, wxIdleEventHandler(func))
3947 #define EVT_UPDATE_UI(winid, func) wx__DECLARE_EVT1(wxEVT_UPDATE_UI, winid, wxUpdateUIEventHandler(func))
3948 #define EVT_UPDATE_UI_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_UPDATE_UI, id1, id2, wxUpdateUIEventHandler(func))
3951 #define EVT_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_HELP, winid, wxHelpEventHandler(func))
3952 #define EVT_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_HELP, id1, id2, wxHelpEventHandler(func))
3953 #define EVT_DETAILED_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_DETAILED_HELP, winid, wxHelpEventHandler(func))
3954 #define EVT_DETAILED_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_DETAILED_HELP, id1, id2, wxHelpEventHandler(func))
3956 // Context Menu Events
3957 #define EVT_CONTEXT_MENU(func) wx__DECLARE_EVT0(wxEVT_CONTEXT_MENU, wxContextMenuEventHandler(func))
3958 #define EVT_COMMAND_CONTEXT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_CONTEXT_MENU, winid, wxContextMenuEventHandler(func))
3960 // Clipboard text Events
3961 #define EVT_TEXT_CUT(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_CUT, winid, wxClipboardTextEventHandler(func))
3962 #define EVT_TEXT_COPY(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_COPY, winid, wxClipboardTextEventHandler(func))
3963 #define EVT_TEXT_PASTE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_PASTE, winid, wxClipboardTextEventHandler(func))
3966 #define EVT_THREAD(id, func) wx__DECLARE_EVT1(wxEVT_COMMAND_THREAD, id, wxThreadEventHandler(func))
3968 // ----------------------------------------------------------------------------
3970 // ----------------------------------------------------------------------------
3972 // This is an ugly hack to allow the use of Bind() instead of Connect() inside
3973 // the library code if the library was built with support for it, here is how
3976 // class SomeEventHandlingClass : wxBIND_OR_CONNECT_HACK_BASE_CLASS
3977 // public SomeBaseClass
3980 // SomeEventHandlingClass(wxWindow *win)
3982 // // connect to the event for the given window
3983 // wxBIND_OR_CONNECT_HACK(win, wxEVT_SOMETHING, wxSomeEventHandler,
3984 // SomeEventHandlingClass::OnSomeEvent, this);
3988 // void OnSomeEvent(wxSomeEvent&) { ... }
3991 // This is *not* meant to be used by library users, it is only defined here
3992 // (and not in a private header) because the base class must be visible from
3993 // other public headers, please do NOT use this in your code, it will be
3994 // removed from future wx versions without warning.
3995 #ifdef wxHAS_EVENT_BIND
3996 #define wxBIND_OR_CONNECT_HACK_BASE_CLASS
3997 #define wxBIND_OR_CONNECT_HACK_ONLY_BASE_CLASS
3998 #define wxBIND_OR_CONNECT_HACK(win, evt, handler, func, obj) \
3999 win->Bind(evt, &func, obj)
4000 #else // wxHAS_EVENT_BIND
4001 #define wxBIND_OR_CONNECT_HACK_BASE_CLASS public wxEvtHandler,
4002 #define wxBIND_OR_CONNECT_HACK_ONLY_BASE_CLASS : public wxEvtHandler
4003 #define wxBIND_OR_CONNECT_HACK(win, evt, handler, func, obj) \
4004 win->Connect(evt, handler(func), NULL, obj)
4005 #endif // wxHAS_EVENT_BIND
4009 // Find a window with the focus, that is also a descendant of the given window.
4010 // This is used to determine the window to initially send commands to.
4011 WXDLLIMPEXP_CORE wxWindow
* wxFindFocusDescendant(wxWindow
* ancestor
);
4015 #endif // _WX_EVENT_H_