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
;
42 class WXDLLIMPEXP_FWD_BASE wxEventFilter
;
44 class WXDLLIMPEXP_FWD_CORE wxDC
;
45 class WXDLLIMPEXP_FWD_CORE wxMenu
;
46 class WXDLLIMPEXP_FWD_CORE wxWindow
;
47 class WXDLLIMPEXP_FWD_CORE wxWindowBase
;
50 // We operate with pointer to members of wxEvtHandler (such functions are used
51 // as event handlers in the event tables or as arguments to Connect()) but by
52 // default MSVC uses a restricted (but more efficient) representation of
53 // pointers to members which can't deal with multiple base classes. To avoid
54 // mysterious (as the compiler is not good enough to detect this and give a
55 // sensible error message) errors in the user code as soon as it defines
56 // classes inheriting from both wxEvtHandler (possibly indirectly, e.g. via
57 // wxWindow) and something else (including our own wxTrackable but not limited
58 // to it), we use the special MSVC keyword telling the compiler to use a more
59 // general pointer to member representation for the classes inheriting from
62 #define wxMSVC_FWD_MULTIPLE_BASES __multiple_inheritance
64 #define wxMSVC_FWD_MULTIPLE_BASES
67 class WXDLLIMPEXP_FWD_BASE wxMSVC_FWD_MULTIPLE_BASES wxEvtHandler
;
68 class wxEventConnectionRef
;
70 // ----------------------------------------------------------------------------
72 // ----------------------------------------------------------------------------
74 typedef int wxEventType
;
76 #define wxEVT_ANY ((wxEventType)-1)
78 // this is used to make the event table entry type safe, so that for an event
79 // handler only a function with proper parameter list can be given. See also
80 // the wxEVENT_HANDLER_CAST-macro.
81 #define wxStaticCastEvent(type, val) static_cast<type>(val)
83 #define wxDECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj) \
84 wxEventTableEntry(type, winid, idLast, wxNewEventTableFunctor(type, fn), obj)
86 #define wxDECLARE_EVENT_TABLE_TERMINATOR() \
87 wxEventTableEntry(wxEVT_NULL, 0, 0, 0, 0)
89 // generate a new unique event type
90 extern WXDLLIMPEXP_BASE wxEventType
wxNewEventType();
92 // define macros to create new event types:
93 #ifdef wxHAS_EVENT_BIND
94 // events are represented by an instance of wxEventTypeTag and the
95 // corresponding type must be specified for type-safety checks
97 // define a new custom event type, can be used alone or after event
98 // declaration in the header using one of the macros below
99 #define wxDEFINE_EVENT( name, type ) \
100 const wxEventTypeTag< type > name( wxNewEventType() )
102 // the general version allowing exporting the event type from DLL, used by
104 #define wxDECLARE_EXPORTED_EVENT( expdecl, name, type ) \
105 extern const expdecl wxEventTypeTag< type > name
107 // this is the version which will normally be used in the user code
108 #define wxDECLARE_EVENT( name, type ) \
109 wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type )
112 // these macros are only used internally for backwards compatibility and
113 // allow to define an alias for an existing event type (this is used by
115 #define wxDEFINE_EVENT_ALIAS( name, type, value ) \
116 const wxEventTypeTag< type > name( value )
118 #define wxDECLARE_EXPORTED_EVENT_ALIAS( expdecl, name, type ) \
119 extern const expdecl wxEventTypeTag< type > name
120 #else // !wxHAS_EVENT_BIND
121 // the macros are the same ones as above but defined differently as we only
122 // use the integer event type values to identify events in this case
124 #define wxDEFINE_EVENT( name, type ) \
125 const wxEventType name( wxNewEventType() )
127 #define wxDECLARE_EXPORTED_EVENT( expdecl, name, type ) \
128 extern const expdecl wxEventType name
129 #define wxDECLARE_EVENT( name, type ) \
130 wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type )
132 #define wxDEFINE_EVENT_ALIAS( name, type, value ) \
133 const wxEventType name = value
134 #define wxDECLARE_EXPORTED_EVENT_ALIAS( expdecl, name, type ) \
135 extern const expdecl wxEventType name
136 #endif // wxHAS_EVENT_BIND/!wxHAS_EVENT_BIND
138 // Try to cast the given event handler to the correct handler type:
140 #define wxEVENT_HANDLER_CAST( functype, func ) \
141 ( wxObjectEventFunction )( wxEventFunction )wxStaticCastEvent( functype, &func )
144 #ifdef wxHAS_EVENT_BIND
146 // The tag is a type associated to the event type (which is an integer itself,
147 // in spite of its name) value. It exists in order to be used as a template
148 // parameter and provide a mapping between the event type values and their
149 // corresponding wxEvent-derived classes.
150 template <typename T
>
154 // The class of wxEvent-derived class carried by the events of this type.
155 typedef T EventClass
;
157 wxEventTypeTag(wxEventType type
) { m_type
= type
; }
159 // Return a wxEventType reference for the initialization of the static
160 // event tables. See wxEventTableEntry::m_eventType for a more thorough
162 operator const wxEventType
&() const { return m_type
; }
168 #endif // wxHAS_EVENT_BIND
170 // These are needed for the functor definitions
171 typedef void (wxEvtHandler::*wxEventFunction
)(wxEvent
&);
173 // We had some trouble (specifically with eVC for ARM WinCE build) with using
174 // wxEventFunction in the past so we had introduced wxObjectEventFunction which
175 // used to be a typedef for a member of wxObject and not wxEvtHandler to work
176 // around this but as eVC is not really supported any longer we now only keep
177 // this for backwards compatibility and, despite its name, this is a typedef
178 // for wxEvtHandler member now -- but if we have the same problem with another
179 // compiler we can restore its old definition for it.
180 typedef wxEventFunction wxObjectEventFunction
;
182 // The event functor which is stored in the static and dynamic event tables:
183 class WXDLLIMPEXP_BASE wxEventFunctor
186 virtual ~wxEventFunctor();
188 // Invoke the actual event handler:
189 virtual void operator()(wxEvtHandler
*, wxEvent
&) = 0;
191 // this function tests whether this functor is matched, for the purpose of
192 // finding it in an event table in Unbind(), by the given functor:
193 virtual bool IsMatching(const wxEventFunctor
& functor
) const = 0;
195 // If the functor holds an wxEvtHandler, then get access to it and track
196 // its lifetime with wxEventConnectionRef:
197 virtual wxEvtHandler
*GetEvtHandler() const
200 // This is only used to maintain backward compatibility in
201 // wxAppConsoleBase::CallEventHandler and ensures that an overwritten
202 // wxAppConsoleBase::HandleEvent is still called for functors which hold an
204 virtual wxEventFunction
GetEvtMethod() const
208 WX_DECLARE_ABSTRACT_TYPEINFO(wxEventFunctor
)
211 // A plain method functor for the untyped legacy event types:
212 class WXDLLIMPEXP_BASE wxObjectEventFunctor
: public wxEventFunctor
215 wxObjectEventFunctor(wxObjectEventFunction method
, wxEvtHandler
*handler
)
216 : m_handler( handler
), m_method( method
)
219 virtual void operator()(wxEvtHandler
*handler
, wxEvent
& event
);
221 virtual bool IsMatching(const wxEventFunctor
& functor
) const
223 if ( wxTypeId(functor
) == wxTypeId(*this) )
225 const wxObjectEventFunctor
&other
=
226 static_cast< const wxObjectEventFunctor
& >( functor
);
228 // FIXME-VC6: amazing but true: replacing "method == NULL" here
229 // with "!method" makes VC6 crash with an ICE in DLL build (only!)
231 return ( m_method
== other
.m_method
|| other
.m_method
== NULL
) &&
232 ( m_handler
== other
.m_handler
|| other
.m_handler
== NULL
);
238 virtual wxEvtHandler
*GetEvtHandler() const
239 { return m_handler
; }
241 virtual wxEventFunction
GetEvtMethod() const
245 wxEvtHandler
*m_handler
;
246 wxEventFunction m_method
;
248 // Provide a dummy default ctor for type info purposes
249 wxObjectEventFunctor() { }
251 WX_DECLARE_TYPEINFO_INLINE(wxObjectEventFunctor
)
254 // Create a functor for the legacy events: used by Connect()
255 inline wxObjectEventFunctor
*
256 wxNewEventFunctor(const wxEventType
& WXUNUSED(evtType
),
257 wxObjectEventFunction method
,
258 wxEvtHandler
*handler
)
260 return new wxObjectEventFunctor(method
, handler
);
263 // This version is used by wxDECLARE_EVENT_TABLE_ENTRY()
264 inline wxObjectEventFunctor
*
265 wxNewEventTableFunctor(const wxEventType
& WXUNUSED(evtType
),
266 wxObjectEventFunction method
)
268 return new wxObjectEventFunctor(method
, NULL
);
271 inline wxObjectEventFunctor
272 wxMakeEventFunctor(const wxEventType
& WXUNUSED(evtType
),
273 wxObjectEventFunction method
,
274 wxEvtHandler
*handler
)
276 return wxObjectEventFunctor(method
, handler
);
279 #ifdef wxHAS_EVENT_BIND
284 // helper template defining nested "type" typedef as the event class
285 // corresponding to the given event type
286 template <typename T
> struct EventClassOf
;
288 // the typed events provide the information about the class of the events they
290 template <typename T
>
291 struct EventClassOf
< wxEventTypeTag
<T
> >
293 typedef typename wxEventTypeTag
<T
>::EventClass type
;
296 // for the old untyped events we don't have information about the exact event
297 // class carried by them
299 struct EventClassOf
<wxEventType
>
301 typedef wxEvent type
;
305 // helper class defining operations different for method functors using an
306 // object of wxEvtHandler-derived class as handler and the others
307 template <typename T
, typename A
, bool> struct HandlerImpl
;
309 // specialization for handlers deriving from wxEvtHandler
310 template <typename T
, typename A
>
311 struct HandlerImpl
<T
, A
, true>
313 static bool IsEvtHandler()
315 static T
*ConvertFromEvtHandler(wxEvtHandler
*p
)
316 { return static_cast<T
*>(p
); }
317 static wxEvtHandler
*ConvertToEvtHandler(T
*p
)
319 static wxEventFunction
ConvertToEvtMethod(void (T::*f
)(A
&))
320 { return static_cast<wxEventFunction
>(
321 reinterpret_cast<void (T::*)(wxEvent
&)>(f
)); }
324 // specialization for handlers not deriving from wxEvtHandler
325 template <typename T
, typename A
>
326 struct HandlerImpl
<T
, A
, false>
328 static bool IsEvtHandler()
330 static T
*ConvertFromEvtHandler(wxEvtHandler
*)
332 static wxEvtHandler
*ConvertToEvtHandler(T
*)
334 static wxEventFunction
ConvertToEvtMethod(void (T::*)(A
&))
338 } // namespace wxPrivate
340 // functor forwarding the event to a method of the given object
342 // notice that the object class may be different from the class in which the
343 // method is defined but it must be convertible to this class
345 // also, the type of the handler parameter doesn't need to be exactly the same
346 // as EventTag::EventClass but it must be its base class -- this is explicitly
347 // allowed to handle different events in the same handler taking wxEvent&, for
350 <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
351 class wxEventFunctorMethod
352 : public wxEventFunctor
,
353 private wxPrivate::HandlerImpl
357 wxConvertibleTo
<Class
, wxEvtHandler
>::value
!= 0
361 static void CheckHandlerArgument(EventArg
*) { }
364 // the event class associated with the given event tag
365 typedef typename
wxPrivate::EventClassOf
<EventTag
>::type EventClass
;
368 wxEventFunctorMethod(void (Class::*method
)(EventArg
&), EventHandler
*handler
)
369 : m_handler( handler
), m_method( method
)
371 wxASSERT_MSG( handler
|| this->IsEvtHandler(),
372 "handlers defined in non-wxEvtHandler-derived classes "
373 "must be connected with a valid sink object" );
375 // if you get an error here it means that the signature of the handler
376 // you're trying to use is not compatible with (i.e. is not the same as
377 // or a base class of) the real event class used for this event type
378 CheckHandlerArgument(static_cast<EventClass
*>(NULL
));
381 virtual void operator()(wxEvtHandler
*handler
, wxEvent
& event
)
383 Class
* realHandler
= m_handler
;
386 realHandler
= this->ConvertFromEvtHandler(handler
);
388 // this is not supposed to happen but check for it nevertheless
389 wxCHECK_RET( realHandler
, "invalid event handler" );
392 // the real (run-time) type of event is EventClass and we checked in
393 // the ctor that EventClass can be converted to EventArg, so this cast
395 (realHandler
->*m_method
)(static_cast<EventArg
&>(event
));
398 virtual bool IsMatching(const wxEventFunctor
& functor
) const
400 if ( wxTypeId(functor
) != wxTypeId(*this) )
403 typedef wxEventFunctorMethod
<EventTag
, Class
, EventArg
, EventHandler
>
406 // the cast is valid because wxTypeId()s matched above
407 const ThisFunctor
& other
= static_cast<const ThisFunctor
&>(functor
);
409 return (m_method
== other
.m_method
|| other
.m_method
== NULL
) &&
410 (m_handler
== other
.m_handler
|| other
.m_handler
== NULL
);
413 virtual wxEvtHandler
*GetEvtHandler() const
414 { return this->ConvertToEvtHandler(m_handler
); }
416 virtual wxEventFunction
GetEvtMethod() const
417 { return this->ConvertToEvtMethod(m_method
); }
420 EventHandler
*m_handler
;
421 void (Class::*m_method
)(EventArg
&);
423 // Provide a dummy default ctor for type info purposes
424 wxEventFunctorMethod() { }
426 typedef wxEventFunctorMethod
<EventTag
, Class
,
427 EventArg
, EventHandler
> thisClass
;
428 WX_DECLARE_TYPEINFO_INLINE(thisClass
)
432 // functor forwarding the event to function (function, static method)
433 template <typename EventTag
, typename EventArg
>
434 class wxEventFunctorFunction
: public wxEventFunctor
437 static void CheckHandlerArgument(EventArg
*) { }
440 // the event class associated with the given event tag
441 typedef typename
wxPrivate::EventClassOf
<EventTag
>::type EventClass
;
443 wxEventFunctorFunction( void ( *handler
)( EventArg
& ))
444 : m_handler( handler
)
446 // if you get an error here it means that the signature of the handler
447 // you're trying to use is not compatible with (i.e. is not the same as
448 // or a base class of) the real event class used for this event type
449 CheckHandlerArgument(static_cast<EventClass
*>(NULL
));
452 virtual void operator()(wxEvtHandler
*WXUNUSED(handler
), wxEvent
& event
)
454 // If you get an error here like "must use .* or ->* to call
455 // pointer-to-member function" then you probably tried to call
456 // Bind/Unbind with a method pointer but without a handler pointer or
457 // NULL as a handler e.g.:
458 // Unbind( wxEVT_XXX, &EventHandler::method );
460 // Unbind( wxEVT_XXX, &EventHandler::method, NULL )
461 m_handler(static_cast<EventArg
&>(event
));
464 virtual bool IsMatching(const wxEventFunctor
&functor
) const
466 if ( wxTypeId(functor
) != wxTypeId(*this) )
469 typedef wxEventFunctorFunction
<EventTag
, EventArg
> ThisFunctor
;
471 const ThisFunctor
& other
= static_cast<const ThisFunctor
&>( functor
);
473 return m_handler
== other
.m_handler
;
477 void (*m_handler
)(EventArg
&);
479 // Provide a dummy default ctor for type info purposes
480 wxEventFunctorFunction() { }
482 typedef wxEventFunctorFunction
<EventTag
, EventArg
> thisClass
;
483 WX_DECLARE_TYPEINFO_INLINE(thisClass
)
487 template <typename EventTag
, typename Functor
>
488 class wxEventFunctorFunctor
: public wxEventFunctor
491 typedef typename
EventTag::EventClass EventArg
;
493 wxEventFunctorFunctor(const Functor
& handler
)
494 : m_handler(handler
), m_handlerAddr(&handler
)
497 virtual void operator()(wxEvtHandler
*WXUNUSED(handler
), wxEvent
& event
)
499 // If you get an error here like "must use '.*' or '->*' to call
500 // pointer-to-member function" then you probably tried to call
501 // Bind/Unbind with a method pointer but without a handler pointer or
502 // NULL as a handler e.g.:
503 // Unbind( wxEVT_XXX, &EventHandler::method );
505 // Unbind( wxEVT_XXX, &EventHandler::method, NULL )
506 m_handler(static_cast<EventArg
&>(event
));
509 virtual bool IsMatching(const wxEventFunctor
&functor
) const
511 if ( wxTypeId(functor
) != wxTypeId(*this) )
514 typedef wxEventFunctorFunctor
<EventTag
, Functor
> FunctorThis
;
516 const FunctorThis
& other
= static_cast<const FunctorThis
&>(functor
);
518 // The only reliable/portable way to compare two functors is by
520 return m_handlerAddr
== other
.m_handlerAddr
;
524 // Store a copy of the functor to prevent using/calling an already
525 // destroyed instance:
528 // Use the address of the original functor for comparison in IsMatching:
529 const void *m_handlerAddr
;
531 // Provide a dummy default ctor for type info purposes
532 wxEventFunctorFunctor() { }
534 typedef wxEventFunctorFunctor
<EventTag
, Functor
> thisClass
;
535 WX_DECLARE_TYPEINFO_INLINE(thisClass
)
538 // Create functors for the templatized events, either allocated on the heap for
539 // wxNewXXX() variants (this is needed in wxEvtHandler::Bind<>() to store them
540 // in dynamic event table) or just by returning them as temporary objects (this
541 // is enough for Unbind<>() and we avoid unnecessary heap allocation like this).
544 // Create functors wrapping functions:
545 template <typename EventTag
, typename EventArg
>
546 inline wxEventFunctorFunction
<EventTag
, EventArg
> *
547 wxNewEventFunctor(const EventTag
&, void (*func
)(EventArg
&))
549 return new wxEventFunctorFunction
<EventTag
, EventArg
>(func
);
552 template <typename EventTag
, typename EventArg
>
553 inline wxEventFunctorFunction
<EventTag
, EventArg
>
554 wxMakeEventFunctor(const EventTag
&, void (*func
)(EventArg
&))
556 return wxEventFunctorFunction
<EventTag
, EventArg
>(func
);
559 // Create functors wrapping other functors:
560 template <typename EventTag
, typename Functor
>
561 inline wxEventFunctorFunctor
<EventTag
, Functor
> *
562 wxNewEventFunctor(const EventTag
&, const Functor
&func
)
564 return new wxEventFunctorFunctor
<EventTag
, Functor
>(func
);
567 template <typename EventTag
, typename Functor
>
568 inline wxEventFunctorFunctor
<EventTag
, Functor
>
569 wxMakeEventFunctor(const EventTag
&, const Functor
&func
)
571 return wxEventFunctorFunctor
<EventTag
, Functor
>(func
);
574 // Create functors wrapping methods:
576 <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
577 inline wxEventFunctorMethod
<EventTag
, Class
, EventArg
, EventHandler
> *
578 wxNewEventFunctor(const EventTag
&,
579 void (Class::*method
)(EventArg
&),
580 EventHandler
*handler
)
582 return new wxEventFunctorMethod
<EventTag
, Class
, EventArg
, EventHandler
>(
587 <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
588 inline wxEventFunctorMethod
<EventTag
, Class
, EventArg
, EventHandler
>
589 wxMakeEventFunctor(const EventTag
&,
590 void (Class::*method
)(EventArg
&),
591 EventHandler
*handler
)
593 return wxEventFunctorMethod
<EventTag
, Class
, EventArg
, EventHandler
>(
597 // Create an event functor for the event table via wxDECLARE_EVENT_TABLE_ENTRY:
598 // in this case we don't have the handler (as it's always the same as the
599 // object which generated the event) so we must use Class as its type
600 template <typename EventTag
, typename Class
, typename EventArg
>
601 inline wxEventFunctorMethod
<EventTag
, Class
, EventArg
, Class
> *
602 wxNewEventTableFunctor(const EventTag
&, void (Class::*method
)(EventArg
&))
604 return new wxEventFunctorMethod
<EventTag
, Class
, EventArg
, Class
>(
608 #endif // wxHAS_EVENT_BIND
611 // many, but not all, standard event types
613 // some generic events
614 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_NULL
;
615 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_FIRST
;
616 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_USER_FIRST
;
618 // Need events declared to do this
619 class WXDLLIMPEXP_FWD_BASE wxIdleEvent
;
620 class WXDLLIMPEXP_FWD_BASE wxThreadEvent
;
621 class WXDLLIMPEXP_FWD_CORE wxCommandEvent
;
622 class WXDLLIMPEXP_FWD_CORE wxMouseEvent
;
623 class WXDLLIMPEXP_FWD_CORE wxFocusEvent
;
624 class WXDLLIMPEXP_FWD_CORE wxChildFocusEvent
;
625 class WXDLLIMPEXP_FWD_CORE wxKeyEvent
;
626 class WXDLLIMPEXP_FWD_CORE wxNavigationKeyEvent
;
627 class WXDLLIMPEXP_FWD_CORE wxSetCursorEvent
;
628 class WXDLLIMPEXP_FWD_CORE wxScrollEvent
;
629 class WXDLLIMPEXP_FWD_CORE wxSpinEvent
;
630 class WXDLLIMPEXP_FWD_CORE wxScrollWinEvent
;
631 class WXDLLIMPEXP_FWD_CORE wxSizeEvent
;
632 class WXDLLIMPEXP_FWD_CORE wxMoveEvent
;
633 class WXDLLIMPEXP_FWD_CORE wxCloseEvent
;
634 class WXDLLIMPEXP_FWD_CORE wxActivateEvent
;
635 class WXDLLIMPEXP_FWD_CORE wxWindowCreateEvent
;
636 class WXDLLIMPEXP_FWD_CORE wxWindowDestroyEvent
;
637 class WXDLLIMPEXP_FWD_CORE wxShowEvent
;
638 class WXDLLIMPEXP_FWD_CORE wxIconizeEvent
;
639 class WXDLLIMPEXP_FWD_CORE wxMaximizeEvent
;
640 class WXDLLIMPEXP_FWD_CORE wxMouseCaptureChangedEvent
;
641 class WXDLLIMPEXP_FWD_CORE wxMouseCaptureLostEvent
;
642 class WXDLLIMPEXP_FWD_CORE wxPaintEvent
;
643 class WXDLLIMPEXP_FWD_CORE wxEraseEvent
;
644 class WXDLLIMPEXP_FWD_CORE wxNcPaintEvent
;
645 class WXDLLIMPEXP_FWD_CORE wxMenuEvent
;
646 class WXDLLIMPEXP_FWD_CORE wxContextMenuEvent
;
647 class WXDLLIMPEXP_FWD_CORE wxSysColourChangedEvent
;
648 class WXDLLIMPEXP_FWD_CORE wxDisplayChangedEvent
;
649 class WXDLLIMPEXP_FWD_CORE wxQueryNewPaletteEvent
;
650 class WXDLLIMPEXP_FWD_CORE wxPaletteChangedEvent
;
651 class WXDLLIMPEXP_FWD_CORE wxJoystickEvent
;
652 class WXDLLIMPEXP_FWD_CORE wxDropFilesEvent
;
653 class WXDLLIMPEXP_FWD_CORE wxInitDialogEvent
;
654 class WXDLLIMPEXP_FWD_CORE wxUpdateUIEvent
;
655 class WXDLLIMPEXP_FWD_CORE wxClipboardTextEvent
;
656 class WXDLLIMPEXP_FWD_CORE wxHelpEvent
;
660 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_BUTTON_CLICKED
, wxCommandEvent
);
661 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHECKBOX_CLICKED
, wxCommandEvent
);
662 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHOICE_SELECTED
, wxCommandEvent
);
663 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LISTBOX_SELECTED
, wxCommandEvent
);
664 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
, wxCommandEvent
);
665 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
, wxCommandEvent
);
666 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_MENU_SELECTED
, wxCommandEvent
);
667 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SLIDER_UPDATED
, wxCommandEvent
);
668 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RADIOBOX_SELECTED
, wxCommandEvent
);
669 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RADIOBUTTON_SELECTED
, wxCommandEvent
);
671 // wxEVT_COMMAND_SCROLLBAR_UPDATED is deprecated, use wxEVT_SCROLL... events
672 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SCROLLBAR_UPDATED
, wxCommandEvent
);
673 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_VLBOX_SELECTED
, wxCommandEvent
);
674 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_COMBOBOX_SELECTED
, wxCommandEvent
);
675 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_RCLICKED
, wxCommandEvent
);
676 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED
, wxCommandEvent
);
677 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_ENTER
, wxCommandEvent
);
678 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_COMBOBOX_DROPDOWN
, wxCommandEvent
);
679 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_COMBOBOX_CLOSEUP
, wxCommandEvent
);
682 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_BASE
, wxEVT_THREAD
, wxThreadEvent
);
685 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_DOWN
, wxMouseEvent
);
686 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_UP
, wxMouseEvent
);
687 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_DOWN
, wxMouseEvent
);
688 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_UP
, wxMouseEvent
);
689 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_DOWN
, wxMouseEvent
);
690 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_UP
, wxMouseEvent
);
691 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOTION
, wxMouseEvent
);
692 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ENTER_WINDOW
, wxMouseEvent
);
693 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEAVE_WINDOW
, wxMouseEvent
);
694 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_DCLICK
, wxMouseEvent
);
695 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_DCLICK
, wxMouseEvent
);
696 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_DCLICK
, wxMouseEvent
);
697 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SET_FOCUS
, wxFocusEvent
);
698 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KILL_FOCUS
, wxFocusEvent
);
699 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHILD_FOCUS
, wxChildFocusEvent
);
700 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSEWHEEL
, wxMouseEvent
);
701 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_DOWN
, wxMouseEvent
);
702 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_UP
, wxMouseEvent
);
703 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_DCLICK
, wxMouseEvent
);
704 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_DOWN
, wxMouseEvent
);
705 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_UP
, wxMouseEvent
);
706 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_DCLICK
, wxMouseEvent
);
708 // Character input event type
709 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHAR
, wxKeyEvent
);
710 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHAR_HOOK
, wxKeyEvent
);
711 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_NAVIGATION_KEY
, wxNavigationKeyEvent
);
712 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KEY_DOWN
, wxKeyEvent
);
713 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KEY_UP
, wxKeyEvent
);
715 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HOTKEY
, wxKeyEvent
);
717 // This is a private event used by wxMSW code only and subject to change or
718 // disappear in the future. Don't use.
719 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AFTER_CHAR
, wxKeyEvent
);
722 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SET_CURSOR
, wxSetCursorEvent
);
724 // wxScrollBar and wxSlider event identifiers
725 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_TOP
, wxScrollEvent
);
726 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_BOTTOM
, wxScrollEvent
);
727 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_LINEUP
, wxScrollEvent
);
728 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_LINEDOWN
, wxScrollEvent
);
729 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_PAGEUP
, wxScrollEvent
);
730 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_PAGEDOWN
, wxScrollEvent
);
731 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_THUMBTRACK
, wxScrollEvent
);
732 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_THUMBRELEASE
, wxScrollEvent
);
733 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_CHANGED
, wxScrollEvent
);
735 // Due to a bug in older wx versions, wxSpinEvents were being sent with type of
736 // wxEVT_SCROLL_LINEUP, wxEVT_SCROLL_LINEDOWN and wxEVT_SCROLL_THUMBTRACK. But
737 // with the type-safe events in place, these event types are associated with
738 // wxScrollEvent. To allow handling of spin events, new event types have been
739 // defined in spinbutt.h/spinnbuttcmn.cpp. To maintain backward compatibility
740 // the spin event types are being initialized with the scroll event types.
744 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN_UP
, wxSpinEvent
);
745 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN_DOWN
, wxSpinEvent
);
746 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN
, wxSpinEvent
);
750 // Scroll events from wxWindow
751 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_TOP
, wxScrollWinEvent
);
752 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_BOTTOM
, wxScrollWinEvent
);
753 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_LINEUP
, wxScrollWinEvent
);
754 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_LINEDOWN
, wxScrollWinEvent
);
755 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_PAGEUP
, wxScrollWinEvent
);
756 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_PAGEDOWN
, wxScrollWinEvent
);
757 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_THUMBTRACK
, wxScrollWinEvent
);
758 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_THUMBRELEASE
, wxScrollWinEvent
);
761 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SIZE
, wxSizeEvent
);
762 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE
, wxMoveEvent
);
763 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CLOSE_WINDOW
, wxCloseEvent
);
764 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_END_SESSION
, wxCloseEvent
);
765 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_QUERY_END_SESSION
, wxCloseEvent
);
766 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ACTIVATE_APP
, wxActivateEvent
);
767 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ACTIVATE
, wxActivateEvent
);
768 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CREATE
, wxWindowCreateEvent
);
769 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DESTROY
, wxWindowDestroyEvent
);
770 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SHOW
, wxShowEvent
);
771 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ICONIZE
, wxIconizeEvent
);
772 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MAXIMIZE
, wxMaximizeEvent
);
773 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSE_CAPTURE_CHANGED
, wxMouseCaptureChangedEvent
);
774 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSE_CAPTURE_LOST
, wxMouseCaptureLostEvent
);
775 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_PAINT
, wxPaintEvent
);
776 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ERASE_BACKGROUND
, wxEraseEvent
);
777 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_NC_PAINT
, wxNcPaintEvent
);
778 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_OPEN
, wxMenuEvent
);
779 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_CLOSE
, wxMenuEvent
);
780 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_HIGHLIGHT
, wxMenuEvent
);
781 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CONTEXT_MENU
, wxContextMenuEvent
);
782 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SYS_COLOUR_CHANGED
, wxSysColourChangedEvent
);
783 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DISPLAY_CHANGED
, wxDisplayChangedEvent
);
784 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_QUERY_NEW_PALETTE
, wxQueryNewPaletteEvent
);
785 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_PALETTE_CHANGED
, wxPaletteChangedEvent
);
786 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_BUTTON_DOWN
, wxJoystickEvent
);
787 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_BUTTON_UP
, wxJoystickEvent
);
788 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_MOVE
, wxJoystickEvent
);
789 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_ZMOVE
, wxJoystickEvent
);
790 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DROP_FILES
, wxDropFilesEvent
);
791 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_INIT_DIALOG
, wxInitDialogEvent
);
792 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_BASE
, wxEVT_IDLE
, wxIdleEvent
);
793 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_UPDATE_UI
, wxUpdateUIEvent
);
794 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SIZING
, wxSizeEvent
);
795 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVING
, wxMoveEvent
);
796 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE_START
, wxMoveEvent
);
797 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE_END
, wxMoveEvent
);
798 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HIBERNATE
, wxActivateEvent
);
801 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_COPY
, wxClipboardTextEvent
);
802 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_CUT
, wxClipboardTextEvent
);
803 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_PASTE
, wxClipboardTextEvent
);
805 // Generic command events
806 // Note: a click is a higher-level event than button down/up
807 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LEFT_CLICK
, wxCommandEvent
);
808 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LEFT_DCLICK
, wxCommandEvent
);
809 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RIGHT_CLICK
, wxCommandEvent
);
810 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RIGHT_DCLICK
, wxCommandEvent
);
811 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SET_FOCUS
, wxCommandEvent
);
812 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_KILL_FOCUS
, wxCommandEvent
);
813 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_ENTER
, wxCommandEvent
);
816 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HELP
, wxHelpEvent
);
817 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DETAILED_HELP
, wxHelpEvent
);
819 // these 2 events are the same
820 #define wxEVT_COMMAND_TOOL_CLICKED wxEVT_COMMAND_MENU_SELECTED
822 // ----------------------------------------------------------------------------
824 // ----------------------------------------------------------------------------
826 // this event is also used by wxComboBox and wxSpinCtrl which don't include
827 // wx/textctrl.h in all ports [yet], so declare it here as well
829 // still, any new code using it should include wx/textctrl.h explicitly
830 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_UPDATED
, wxCommandEvent
);
833 // ----------------------------------------------------------------------------
834 // wxEvent(-derived) classes
835 // ----------------------------------------------------------------------------
837 // the predefined constants for the number of times we propagate event
838 // upwards window child-parent chain
839 enum wxEventPropagation
841 // don't propagate it at all
842 wxEVENT_PROPAGATE_NONE
= 0,
844 // propagate it until it is processed
845 wxEVENT_PROPAGATE_MAX
= INT_MAX
848 // The different categories for a wxEvent; see wxEvent::GetEventCategory.
849 // NOTE: they are used as OR-combinable flags by wxEventLoopBase::YieldFor
852 // this is the category for those events which are generated to update
853 // the appearance of the GUI but which (usually) do not comport data
854 // processing, i.e. which do not provide input or output data
855 // (e.g. size events, scroll events, etc).
856 // They are events NOT directly generated by the user's input devices.
857 wxEVT_CATEGORY_UI
= 1,
859 // this category groups those events which are generated directly from the
860 // user through input devices like mouse and keyboard and usually result in
861 // data to be processed from the application.
862 // (e.g. mouse clicks, key presses, etc)
863 wxEVT_CATEGORY_USER_INPUT
= 2,
865 // this category is for wxSocketEvent
866 wxEVT_CATEGORY_SOCKET
= 4,
868 // this category is for wxTimerEvent
869 wxEVT_CATEGORY_TIMER
= 8,
871 // this category is for any event used to send notifications from the
872 // secondary threads to the main one or in general for notifications among
873 // different threads (which may or may not be user-generated)
874 wxEVT_CATEGORY_THREAD
= 16,
877 // implementation only
879 // used in the implementations of wxEventLoopBase::YieldFor
880 wxEVT_CATEGORY_UNKNOWN
= 32,
882 // a special category used as an argument to wxEventLoopBase::YieldFor to indicate that
883 // Yield() should leave all wxEvents on the queue while emptying the native event queue
884 // (native events will be processed but the wxEvents they generate will be queued)
885 wxEVT_CATEGORY_CLIPBOARD
= 64,
890 // this category groups those events which are emitted in response to
891 // events of the native toolkit and which typically are not-"delayable".
892 wxEVT_CATEGORY_NATIVE_EVENTS
= wxEVT_CATEGORY_UI
|wxEVT_CATEGORY_USER_INPUT
,
894 // used in wxEventLoopBase::YieldFor to specify all event categories should be processed:
896 wxEVT_CATEGORY_UI
|wxEVT_CATEGORY_USER_INPUT
|wxEVT_CATEGORY_SOCKET
| \
897 wxEVT_CATEGORY_TIMER
|wxEVT_CATEGORY_THREAD
|wxEVT_CATEGORY_UNKNOWN
| \
898 wxEVT_CATEGORY_CLIPBOARD
902 * wxWidgets events, covering all interesting things that might happen
903 * (button clicking, resizing, setting text in widgets, etc.).
905 * For each completely new event type, derive a new event class.
906 * An event CLASS represents a C++ class defining a range of similar event TYPES;
907 * examples are canvas events, panel item command events.
908 * An event TYPE is a unique identifier for a particular system event,
909 * such as a button press or a listbox deselection.
913 class WXDLLIMPEXP_BASE wxEvent
: public wxObject
916 wxEvent(int winid
= 0, wxEventType commandType
= wxEVT_NULL
);
918 void SetEventType(wxEventType typ
) { m_eventType
= typ
; }
919 wxEventType
GetEventType() const { return m_eventType
; }
921 wxObject
*GetEventObject() const { return m_eventObject
; }
922 void SetEventObject(wxObject
*obj
) { m_eventObject
= obj
; }
924 long GetTimestamp() const { return m_timeStamp
; }
925 void SetTimestamp(long ts
= 0) { m_timeStamp
= ts
; }
927 int GetId() const { return m_id
; }
928 void SetId(int Id
) { m_id
= Id
; }
930 // Can instruct event processor that we wish to ignore this event
931 // (treat as if the event table entry had not been found): this must be done
932 // to allow the event processing by the base classes (calling event.Skip()
933 // is the analog of calling the base class version of a virtual function)
934 void Skip(bool skip
= true) { m_skipped
= skip
; }
935 bool GetSkipped() const { return m_skipped
; }
937 // This function is used to create a copy of the event polymorphically and
938 // all derived classes must implement it because otherwise wxPostEvent()
939 // for them wouldn't work (it needs to do a copy of the event)
940 virtual wxEvent
*Clone() const = 0;
942 // this function is used to selectively process events in wxEventLoopBase::YieldFor
943 // NOTE: by default it returns wxEVT_CATEGORY_UI just because the major
944 // part of wxWidgets events belong to that category.
945 virtual wxEventCategory
GetEventCategory() const
946 { return wxEVT_CATEGORY_UI
; }
948 // Implementation only: this test is explicitly anti OO and this function
949 // exists only for optimization purposes.
950 bool IsCommandEvent() const { return m_isCommandEvent
; }
952 // Determine if this event should be propagating to the parent window.
953 bool ShouldPropagate() const
954 { return m_propagationLevel
!= wxEVENT_PROPAGATE_NONE
; }
956 // Stop an event from propagating to its parent window, returns the old
957 // propagation level value
958 int StopPropagation()
960 int propagationLevel
= m_propagationLevel
;
961 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
962 return propagationLevel
;
965 // Resume the event propagation by restoring the propagation level
966 // (returned by StopPropagation())
967 void ResumePropagation(int propagationLevel
)
969 m_propagationLevel
= propagationLevel
;
973 // This is for internal use only and is only called by
974 // wxEvtHandler::ProcessEvent() to check whether it's the first time this
975 // event is being processed
978 if ( m_wasProcessed
)
981 m_wasProcessed
= true;
986 // This is also used only internally by ProcessEvent() to check if it
987 // should process the event normally or only restrict the search for the
988 // event handler to this object itself.
989 bool ShouldProcessOnlyIn(wxEvtHandler
*h
) const
991 return h
== m_handlerToProcessOnlyIn
;
994 // Called to indicate that the result of ShouldProcessOnlyIn() wasn't taken
995 // into account. The existence of this function may seem counterintuitive
996 // but unfortunately it's needed by wxScrollHelperEvtHandler, see comments
997 // there. Don't even think of using this in your own code, this is a gross
998 // hack and is only needed because of wx complicated history and should
999 // never be used anywhere else.
1000 void DidntHonourProcessOnlyIn()
1002 m_handlerToProcessOnlyIn
= NULL
;
1006 wxObject
* m_eventObject
;
1007 wxEventType m_eventType
;
1012 // m_callbackUserData is for internal usage only
1013 wxObject
* m_callbackUserData
;
1017 wxEvtHandler
*m_handlerToProcessOnlyIn
;
1020 // the propagation level: while it is positive, we propagate the event to
1021 // the parent window (if any)
1022 int m_propagationLevel
;
1025 bool m_isCommandEvent
;
1027 // initially false but becomes true as soon as WasProcessed() is called for
1028 // the first time, as this is done only by ProcessEvent() it explains the
1029 // variable name: it becomes true after ProcessEvent() was called at least
1030 // once for this event
1031 bool m_wasProcessed
;
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_handlerToProcessOnlyIn
1042 friend class WXDLLIMPEXP_FWD_BASE wxEventProcessInHandlerOnly
;
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 object used to temporarily make wxEvent::ShouldProcessOnlyIn()
1097 // return true for the handler passed to its ctor.
1098 class wxEventProcessInHandlerOnly
1101 wxEventProcessInHandlerOnly(wxEvent
& event
, wxEvtHandler
*handler
)
1103 m_handlerToProcessOnlyInOld(event
.m_handlerToProcessOnlyIn
)
1105 m_event
.m_handlerToProcessOnlyIn
= handler
;
1108 ~wxEventProcessInHandlerOnly()
1110 m_event
.m_handlerToProcessOnlyIn
= m_handlerToProcessOnlyInOld
;
1115 wxEvtHandler
* const m_handlerToProcessOnlyInOld
;
1117 wxDECLARE_NO_COPY_CLASS(wxEventProcessInHandlerOnly
);
1121 class WXDLLIMPEXP_BASE wxEventBasicPayloadMixin
1124 wxEventBasicPayloadMixin()
1130 void SetString(const wxString
& s
) { m_cmdString
= s
; }
1131 const wxString
& GetString() const { return m_cmdString
; }
1133 void SetInt(int i
) { m_commandInt
= i
; }
1134 int GetInt() const { return m_commandInt
; }
1136 void SetExtraLong(long extraLong
) { m_extraLong
= extraLong
; }
1137 long GetExtraLong() const { return m_extraLong
; }
1140 // Note: these variables have "cmd" or "command" in their name for backward compatibility:
1141 // they used to be part of wxCommandEvent, not this mixin.
1142 wxString m_cmdString
; // String event argument
1144 long m_extraLong
; // Additional information (e.g. select/deselect)
1146 wxDECLARE_NO_ASSIGN_CLASS(wxEventBasicPayloadMixin
);
1149 class WXDLLIMPEXP_BASE wxEventAnyPayloadMixin
: public wxEventBasicPayloadMixin
1152 wxEventAnyPayloadMixin() : wxEventBasicPayloadMixin() {}
1154 #if wxUSE_ANY && (!defined(__VISUALC__) || wxCHECK_VISUALC_VERSION(7))
1155 template<typename T
>
1156 void SetPayload(const T
& payload
)
1158 m_payload
= payload
;
1161 template<typename T
>
1162 T
GetPayload() const
1164 return m_payload
.As
<T
>();
1169 #endif // wxUSE_ANY && (!defined(__VISUALC__) || wxCHECK_VISUALC_VERSION(7))
1171 wxDECLARE_NO_ASSIGN_CLASS(wxEventBasicPayloadMixin
);
1180 // Whether to always send idle events to windows, or
1181 // to only send update events to those with the
1182 // wxWS_EX_PROCESS_IDLE style.
1186 // Send idle events to all windows
1189 // Send idle events to windows that have
1190 // the wxWS_EX_PROCESS_IDLE flag specified
1191 wxIDLE_PROCESS_SPECIFIED
1194 class WXDLLIMPEXP_BASE wxIdleEvent
: public wxEvent
1198 : wxEvent(0, wxEVT_IDLE
),
1199 m_requestMore(false)
1201 wxIdleEvent(const wxIdleEvent
& event
)
1203 m_requestMore(event
.m_requestMore
)
1206 void RequestMore(bool needMore
= true) { m_requestMore
= needMore
; }
1207 bool MoreRequested() const { return m_requestMore
; }
1209 virtual wxEvent
*Clone() const { return new wxIdleEvent(*this); }
1211 // Specify how wxWidgets will send idle events: to
1212 // all windows, or only to those which specify that they
1213 // will process the events.
1214 static void SetMode(wxIdleMode mode
) { sm_idleMode
= mode
; }
1216 // Returns the idle event mode
1217 static wxIdleMode
GetMode() { return sm_idleMode
; }
1221 static wxIdleMode sm_idleMode
;
1224 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIdleEvent
)
1230 class WXDLLIMPEXP_BASE wxThreadEvent
: public wxEvent
,
1231 public wxEventAnyPayloadMixin
1234 wxThreadEvent(wxEventType eventType
= wxEVT_THREAD
, int id
= wxID_ANY
)
1235 : wxEvent(id
, eventType
)
1238 wxThreadEvent(const wxThreadEvent
& event
)
1240 wxEventAnyPayloadMixin(event
)
1242 // make sure our string member (which uses COW, aka refcounting) is not
1243 // shared by other wxString instances:
1244 SetString(GetString().c_str());
1247 virtual wxEvent
*Clone() const
1249 return new wxThreadEvent(*this);
1252 // this is important to avoid that calling wxEventLoopBase::YieldFor thread events
1253 // gets processed when this is unwanted:
1254 virtual wxEventCategory
GetEventCategory() const
1255 { return wxEVT_CATEGORY_THREAD
; }
1258 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxThreadEvent
)
1265 // Item or menu event class
1267 wxEVT_COMMAND_BUTTON_CLICKED
1268 wxEVT_COMMAND_CHECKBOX_CLICKED
1269 wxEVT_COMMAND_CHOICE_SELECTED
1270 wxEVT_COMMAND_LISTBOX_SELECTED
1271 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
1272 wxEVT_COMMAND_TEXT_UPDATED
1273 wxEVT_COMMAND_TEXT_ENTER
1274 wxEVT_COMMAND_MENU_SELECTED
1275 wxEVT_COMMAND_SLIDER_UPDATED
1276 wxEVT_COMMAND_RADIOBOX_SELECTED
1277 wxEVT_COMMAND_RADIOBUTTON_SELECTED
1278 wxEVT_COMMAND_SCROLLBAR_UPDATED
1279 wxEVT_COMMAND_VLBOX_SELECTED
1280 wxEVT_COMMAND_COMBOBOX_SELECTED
1281 wxEVT_COMMAND_TOGGLEBUTTON_CLICKED
1284 class WXDLLIMPEXP_CORE wxCommandEvent
: public wxEvent
,
1285 public wxEventBasicPayloadMixin
1288 wxCommandEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0);
1290 wxCommandEvent(const wxCommandEvent
& event
)
1292 wxEventBasicPayloadMixin(event
),
1293 m_clientData(event
.m_clientData
),
1294 m_clientObject(event
.m_clientObject
)
1297 // Set/Get client data from controls
1298 void SetClientData(void* clientData
) { m_clientData
= clientData
; }
1299 void *GetClientData() const { return m_clientData
; }
1301 // Set/Get client object from controls
1302 void SetClientObject(wxClientData
* clientObject
) { m_clientObject
= clientObject
; }
1303 wxClientData
*GetClientObject() const { return m_clientObject
; }
1305 // Note: this shadows wxEventBasicPayloadMixin::GetString(), because it does some
1306 // GUI-specific hacks
1307 wxString
GetString() const;
1309 // Get listbox selection if single-choice
1310 int GetSelection() const { return m_commandInt
; }
1312 // Get checkbox value
1313 bool IsChecked() const { return m_commandInt
!= 0; }
1315 // true if the listbox event was a selection.
1316 bool IsSelection() const { return (m_extraLong
!= 0); }
1318 virtual wxEvent
*Clone() const { return new wxCommandEvent(*this); }
1319 virtual wxEventCategory
GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT
; }
1322 void* m_clientData
; // Arbitrary client data
1323 wxClientData
* m_clientObject
; // Arbitrary client object
1326 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCommandEvent
)
1329 // this class adds a possibility to react (from the user) code to a control
1330 // notification: allow or veto the operation being reported.
1331 class WXDLLIMPEXP_CORE wxNotifyEvent
: public wxCommandEvent
1334 wxNotifyEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0)
1335 : wxCommandEvent(commandType
, winid
)
1336 { m_bAllow
= true; }
1338 wxNotifyEvent(const wxNotifyEvent
& event
)
1339 : wxCommandEvent(event
)
1340 { m_bAllow
= event
.m_bAllow
; }
1342 // veto the operation (usually it's allowed by default)
1343 void Veto() { m_bAllow
= false; }
1345 // allow the operation if it was disabled by default
1346 void Allow() { m_bAllow
= true; }
1348 // for implementation code only: is the operation allowed?
1349 bool IsAllowed() const { return m_bAllow
; }
1351 virtual wxEvent
*Clone() const { return new wxNotifyEvent(*this); }
1357 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNotifyEvent
)
1361 // Scroll event class, derived form wxCommandEvent. wxScrollEvents are
1362 // sent by wxSlider and wxScrollBar.
1367 wxEVT_SCROLL_LINEDOWN
1369 wxEVT_SCROLL_PAGEDOWN
1370 wxEVT_SCROLL_THUMBTRACK
1371 wxEVT_SCROLL_THUMBRELEASE
1372 wxEVT_SCROLL_CHANGED
1375 class WXDLLIMPEXP_CORE wxScrollEvent
: public wxCommandEvent
1378 wxScrollEvent(wxEventType commandType
= wxEVT_NULL
,
1379 int winid
= 0, int pos
= 0, int orient
= 0);
1381 int GetOrientation() const { return (int) m_extraLong
; }
1382 int GetPosition() const { return m_commandInt
; }
1383 void SetOrientation(int orient
) { m_extraLong
= (long) orient
; }
1384 void SetPosition(int pos
) { m_commandInt
= pos
; }
1386 virtual wxEvent
*Clone() const { return new wxScrollEvent(*this); }
1389 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollEvent
)
1392 // ScrollWin event class, derived fom wxEvent. wxScrollWinEvents
1393 // are sent by wxWindow.
1396 wxEVT_SCROLLWIN_BOTTOM
1397 wxEVT_SCROLLWIN_LINEUP
1398 wxEVT_SCROLLWIN_LINEDOWN
1399 wxEVT_SCROLLWIN_PAGEUP
1400 wxEVT_SCROLLWIN_PAGEDOWN
1401 wxEVT_SCROLLWIN_THUMBTRACK
1402 wxEVT_SCROLLWIN_THUMBRELEASE
1405 class WXDLLIMPEXP_CORE wxScrollWinEvent
: public wxEvent
1408 wxScrollWinEvent(wxEventType commandType
= wxEVT_NULL
,
1409 int pos
= 0, int orient
= 0);
1410 wxScrollWinEvent(const wxScrollWinEvent
& event
) : wxEvent(event
)
1411 { m_commandInt
= event
.m_commandInt
;
1412 m_extraLong
= event
.m_extraLong
; }
1414 int GetOrientation() const { return (int) m_extraLong
; }
1415 int GetPosition() const { return m_commandInt
; }
1416 void SetOrientation(int orient
) { m_extraLong
= (long) orient
; }
1417 void SetPosition(int pos
) { m_commandInt
= pos
; }
1419 virtual wxEvent
*Clone() const { return new wxScrollWinEvent(*this); }
1426 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollWinEvent
)
1431 // Mouse event class
1448 wxEVT_NC_MIDDLE_DOWN,
1450 wxEVT_NC_RIGHT_DOWN,
1453 wxEVT_NC_ENTER_WINDOW,
1454 wxEVT_NC_LEAVE_WINDOW,
1455 wxEVT_NC_LEFT_DCLICK,
1456 wxEVT_NC_MIDDLE_DCLICK,
1457 wxEVT_NC_RIGHT_DCLICK,
1460 class WXDLLIMPEXP_CORE wxMouseEvent
: public wxEvent
,
1464 wxMouseEvent(wxEventType mouseType
= wxEVT_NULL
);
1465 wxMouseEvent(const wxMouseEvent
& event
)
1472 // Was it a button event? (*doesn't* mean: is any button *down*?)
1473 bool IsButton() const { return Button(wxMOUSE_BTN_ANY
); }
1475 // Was it a down event from this (or any) button?
1476 bool ButtonDown(int but
= wxMOUSE_BTN_ANY
) const;
1478 // Was it a dclick event from this (or any) button?
1479 bool ButtonDClick(int but
= wxMOUSE_BTN_ANY
) const;
1481 // Was it a up event from this (or any) button?
1482 bool ButtonUp(int but
= wxMOUSE_BTN_ANY
) const;
1484 // Was this event generated by the given button?
1485 bool Button(int but
) const;
1487 // Get the button which is changing state (wxMOUSE_BTN_NONE if none)
1488 int GetButton() const;
1490 // Find which event was just generated
1491 bool LeftDown() const { return (m_eventType
== wxEVT_LEFT_DOWN
); }
1492 bool MiddleDown() const { return (m_eventType
== wxEVT_MIDDLE_DOWN
); }
1493 bool RightDown() const { return (m_eventType
== wxEVT_RIGHT_DOWN
); }
1494 bool Aux1Down() const { return (m_eventType
== wxEVT_AUX1_DOWN
); }
1495 bool Aux2Down() const { return (m_eventType
== wxEVT_AUX2_DOWN
); }
1497 bool LeftUp() const { return (m_eventType
== wxEVT_LEFT_UP
); }
1498 bool MiddleUp() const { return (m_eventType
== wxEVT_MIDDLE_UP
); }
1499 bool RightUp() const { return (m_eventType
== wxEVT_RIGHT_UP
); }
1500 bool Aux1Up() const { return (m_eventType
== wxEVT_AUX1_UP
); }
1501 bool Aux2Up() const { return (m_eventType
== wxEVT_AUX2_UP
); }
1503 bool LeftDClick() const { return (m_eventType
== wxEVT_LEFT_DCLICK
); }
1504 bool MiddleDClick() const { return (m_eventType
== wxEVT_MIDDLE_DCLICK
); }
1505 bool RightDClick() const { return (m_eventType
== wxEVT_RIGHT_DCLICK
); }
1506 bool Aux1DClick() const { return (m_eventType
== wxEVT_AUX1_DCLICK
); }
1507 bool Aux2DClick() const { return (m_eventType
== wxEVT_AUX2_DCLICK
); }
1509 // True if a button is down and the mouse is moving
1510 bool Dragging() const
1512 return (m_eventType
== wxEVT_MOTION
) && ButtonIsDown(wxMOUSE_BTN_ANY
);
1515 // True if the mouse is moving, and no button is down
1518 return (m_eventType
== wxEVT_MOTION
) && !ButtonIsDown(wxMOUSE_BTN_ANY
);
1521 // True if the mouse is just entering the window
1522 bool Entering() const { return (m_eventType
== wxEVT_ENTER_WINDOW
); }
1524 // True if the mouse is just leaving the window
1525 bool Leaving() const { return (m_eventType
== wxEVT_LEAVE_WINDOW
); }
1527 // Returns the number of mouse clicks associated with this event.
1528 int GetClickCount() const { return m_clickCount
; }
1530 // Find the logical position of the event given the DC
1531 wxPoint
GetLogicalPosition(const wxDC
& dc
) const;
1533 // Get wheel rotation, positive or negative indicates direction of
1534 // rotation. Current devices all send an event when rotation is equal to
1535 // +/-WheelDelta, but this allows for finer resolution devices to be
1536 // created in the future. Because of this you shouldn't assume that one
1537 // event is equal to 1 line or whatever, but you should be able to either
1538 // do partial line scrolling or wait until +/-WheelDelta rotation values
1539 // have been accumulated before scrolling.
1540 int GetWheelRotation() const { return m_wheelRotation
; }
1542 // Get wheel delta, normally 120. This is the threshold for action to be
1543 // taken, and one such action (for example, scrolling one increment)
1544 // should occur for each delta.
1545 int GetWheelDelta() const { return m_wheelDelta
; }
1547 // Gets the axis the wheel operation concerns, 0 being the y axis as on
1548 // most mouse wheels, 1 is the x axis for things like MightyMouse scrolls
1549 // or horizontal trackpad scrolling
1550 int GetWheelAxis() const { return m_wheelAxis
; }
1552 // Returns the configured number of lines (or whatever) to be scrolled per
1553 // wheel action. Defaults to one.
1554 int GetLinesPerAction() const { return m_linesPerAction
; }
1556 // Is the system set to do page scrolling?
1557 bool IsPageScroll() const { return ((unsigned int)m_linesPerAction
== UINT_MAX
); }
1559 virtual wxEvent
*Clone() const { return new wxMouseEvent(*this); }
1560 virtual wxEventCategory
GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT
; }
1562 wxMouseEvent
& operator=(const wxMouseEvent
& event
)
1573 int m_wheelRotation
;
1575 int m_linesPerAction
;
1578 void Assign(const wxMouseEvent
& evt
);
1581 DECLARE_DYNAMIC_CLASS(wxMouseEvent
)
1590 class WXDLLIMPEXP_CORE wxSetCursorEvent
: public wxEvent
1593 wxSetCursorEvent(wxCoord x
= 0, wxCoord y
= 0)
1594 : wxEvent(0, wxEVT_SET_CURSOR
),
1595 m_x(x
), m_y(y
), m_cursor()
1598 wxSetCursorEvent(const wxSetCursorEvent
& event
)
1602 m_cursor(event
.m_cursor
)
1605 wxCoord
GetX() const { return m_x
; }
1606 wxCoord
GetY() const { return m_y
; }
1608 void SetCursor(const wxCursor
& cursor
) { m_cursor
= cursor
; }
1609 const wxCursor
& GetCursor() const { return m_cursor
; }
1610 bool HasCursor() const { return m_cursor
.IsOk(); }
1612 virtual wxEvent
*Clone() const { return new wxSetCursorEvent(*this); }
1619 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSetCursorEvent
)
1622 // Keyboard input event class
1632 // key categories: the bit flags for IsKeyInCategory() function
1634 // the enum values used may change in future version of wx
1635 // use the named constants only, or bitwise combinations thereof
1636 enum wxKeyCategoryFlags
1638 // arrow keys, on and off numeric keypads
1639 WXK_CATEGORY_ARROW
= 1,
1641 // page up and page down keys, on and off numeric keypads
1642 WXK_CATEGORY_PAGING
= 2,
1644 // home and end keys, on and off numeric keypads
1645 WXK_CATEGORY_JUMP
= 4,
1647 // tab key, on and off numeric keypads
1648 WXK_CATEGORY_TAB
= 8,
1650 // backspace and delete keys, on and off numeric keypads
1651 WXK_CATEGORY_CUT
= 16,
1653 // all keys usually used for navigation
1654 WXK_CATEGORY_NAVIGATION
= WXK_CATEGORY_ARROW
|
1655 WXK_CATEGORY_PAGING
|
1659 class WXDLLIMPEXP_CORE wxKeyEvent
: public wxEvent
,
1660 public wxKeyboardState
1663 wxKeyEvent(wxEventType keyType
= wxEVT_NULL
);
1665 // Normal copy ctor and a ctor creating a new event for the same key as the
1666 // given one but a different event type (this is used in implementation
1667 // code only, do not use outside of the library).
1668 wxKeyEvent(const wxKeyEvent
& evt
);
1669 wxKeyEvent(wxEventType eventType
, const wxKeyEvent
& evt
);
1671 // get the key code: an ASCII7 char or an element of wxKeyCode enum
1672 int GetKeyCode() const { return (int)m_keyCode
; }
1674 // returns true iff this event's key code is of a certain type
1675 bool IsKeyInCategory(int category
) const;
1678 // get the Unicode character corresponding to this key
1679 wxChar
GetUnicodeKey() const { return m_uniChar
; }
1680 #endif // wxUSE_UNICODE
1682 // get the raw key code (platform-dependent)
1683 wxUint32
GetRawKeyCode() const { return m_rawCode
; }
1685 // get the raw key flags (platform-dependent)
1686 wxUint32
GetRawKeyFlags() const { return m_rawFlags
; }
1688 // Find the position of the event
1689 void GetPosition(wxCoord
*xpos
, wxCoord
*ypos
) const
1691 if (xpos
) *xpos
= m_x
;
1692 if (ypos
) *ypos
= m_y
;
1695 void GetPosition(long *xpos
, long *ypos
) const
1697 if (xpos
) *xpos
= (long)m_x
;
1698 if (ypos
) *ypos
= (long)m_y
;
1701 wxPoint
GetPosition() const
1702 { return wxPoint(m_x
, m_y
); }
1705 wxCoord
GetX() const { return m_x
; }
1708 wxCoord
GetY() const { return m_y
; }
1710 virtual wxEvent
*Clone() const { return new wxKeyEvent(*this); }
1711 virtual wxEventCategory
GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT
; }
1713 // we do need to copy wxKeyEvent sometimes (in wxTreeCtrl code, for
1715 wxKeyEvent
& operator=(const wxKeyEvent
& evt
)
1719 wxEvent::operator=(evt
);
1721 // Borland C++ 5.82 doesn't compile an explicit call to an
1722 // implicitly defined operator=() so need to do it this way:
1723 *static_cast<wxKeyboardState
*>(this) = evt
;
1725 DoAssignMembers(evt
);
1736 // This contains the full Unicode character
1737 // in a character events in Unicode mode
1741 // these fields contain the platform-specific information about
1742 // key that was pressed
1744 wxUint32 m_rawFlags
;
1747 // Copy only the event data present in this class, this is used by
1748 // AssignKeyData() and copy ctor.
1749 void DoAssignMembers(const wxKeyEvent
& evt
)
1754 m_keyCode
= evt
.m_keyCode
;
1756 m_rawCode
= evt
.m_rawCode
;
1757 m_rawFlags
= evt
.m_rawFlags
;
1759 m_uniChar
= evt
.m_uniChar
;
1763 DECLARE_DYNAMIC_CLASS(wxKeyEvent
)
1771 class WXDLLIMPEXP_CORE wxSizeEvent
: public wxEvent
1774 wxSizeEvent() : wxEvent(0, wxEVT_SIZE
)
1776 wxSizeEvent(const wxSize
& sz
, int winid
= 0)
1777 : wxEvent(winid
, wxEVT_SIZE
),
1780 wxSizeEvent(const wxSizeEvent
& event
)
1782 m_size(event
.m_size
), m_rect(event
.m_rect
)
1784 wxSizeEvent(const wxRect
& rect
, int id
= 0)
1785 : m_size(rect
.GetSize()), m_rect(rect
)
1786 { m_eventType
= wxEVT_SIZING
; m_id
= id
; }
1788 wxSize
GetSize() const { return m_size
; }
1789 void SetSize(wxSize size
) { m_size
= size
; }
1790 wxRect
GetRect() const { return m_rect
; }
1791 void SetRect(const wxRect
& rect
) { m_rect
= rect
; }
1793 virtual wxEvent
*Clone() const { return new wxSizeEvent(*this); }
1796 // For internal usage only. Will be converted to protected members.
1798 wxRect m_rect
; // Used for wxEVT_SIZING
1801 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSizeEvent
)
1810 class WXDLLIMPEXP_CORE wxMoveEvent
: public wxEvent
1814 : wxEvent(0, wxEVT_MOVE
)
1816 wxMoveEvent(const wxPoint
& pos
, int winid
= 0)
1817 : wxEvent(winid
, wxEVT_MOVE
),
1820 wxMoveEvent(const wxMoveEvent
& event
)
1824 wxMoveEvent(const wxRect
& rect
, int id
= 0)
1825 : m_pos(rect
.GetPosition()), m_rect(rect
)
1826 { m_eventType
= wxEVT_MOVING
; m_id
= id
; }
1828 wxPoint
GetPosition() const { return m_pos
; }
1829 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
1830 wxRect
GetRect() const { return m_rect
; }
1831 void SetRect(const wxRect
& rect
) { m_rect
= rect
; }
1833 virtual wxEvent
*Clone() const { return new wxMoveEvent(*this); }
1840 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMoveEvent
)
1843 // Paint event class
1850 #if wxDEBUG_LEVEL && (defined(__WXMSW__) || defined(__WXPM__))
1851 #define wxHAS_PAINT_DEBUG
1853 // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined
1854 extern WXDLLIMPEXP_CORE
int g_isPainting
;
1857 class WXDLLIMPEXP_CORE wxPaintEvent
: public wxEvent
1860 wxPaintEvent(int Id
= 0)
1861 : wxEvent(Id
, wxEVT_PAINT
)
1863 #ifdef wxHAS_PAINT_DEBUG
1864 // set the internal flag for the duration of redrawing
1869 // default copy ctor and dtor are normally fine, we only need them to keep
1870 // g_isPainting updated in debug build
1871 #ifdef wxHAS_PAINT_DEBUG
1872 wxPaintEvent(const wxPaintEvent
& event
)
1878 virtual ~wxPaintEvent()
1884 virtual wxEvent
*Clone() const { return new wxPaintEvent(*this); }
1887 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaintEvent
)
1890 class WXDLLIMPEXP_CORE wxNcPaintEvent
: public wxEvent
1893 wxNcPaintEvent(int winid
= 0)
1894 : wxEvent(winid
, wxEVT_NC_PAINT
)
1897 virtual wxEvent
*Clone() const { return new wxNcPaintEvent(*this); }
1900 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNcPaintEvent
)
1903 // Erase background event class
1905 wxEVT_ERASE_BACKGROUND
1908 class WXDLLIMPEXP_CORE wxEraseEvent
: public wxEvent
1911 wxEraseEvent(int Id
= 0, wxDC
*dc
= NULL
)
1912 : wxEvent(Id
, wxEVT_ERASE_BACKGROUND
),
1916 wxEraseEvent(const wxEraseEvent
& event
)
1921 wxDC
*GetDC() const { return m_dc
; }
1923 virtual wxEvent
*Clone() const { return new wxEraseEvent(*this); }
1929 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxEraseEvent
)
1932 // Focus event class
1938 class WXDLLIMPEXP_CORE wxFocusEvent
: public wxEvent
1941 wxFocusEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0)
1942 : wxEvent(winid
, type
)
1945 wxFocusEvent(const wxFocusEvent
& event
)
1947 { m_win
= event
.m_win
; }
1949 // The window associated with this event is the window which had focus
1950 // before for SET event and the window which will have focus for the KILL
1951 // one. NB: it may be NULL in both cases!
1952 wxWindow
*GetWindow() const { return m_win
; }
1953 void SetWindow(wxWindow
*win
) { m_win
= win
; }
1955 virtual wxEvent
*Clone() const { return new wxFocusEvent(*this); }
1961 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFocusEvent
)
1964 // wxChildFocusEvent notifies the parent that a child has got the focus: unlike
1965 // wxFocusEvent it is propagated upwards the window chain
1966 class WXDLLIMPEXP_CORE wxChildFocusEvent
: public wxCommandEvent
1969 wxChildFocusEvent(wxWindow
*win
= NULL
);
1971 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
1973 virtual wxEvent
*Clone() const { return new wxChildFocusEvent(*this); }
1976 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxChildFocusEvent
)
1979 // Activate event class
1986 class WXDLLIMPEXP_CORE wxActivateEvent
: public wxEvent
1989 wxActivateEvent(wxEventType type
= wxEVT_NULL
, bool active
= true, int Id
= 0)
1991 { m_active
= active
; }
1992 wxActivateEvent(const wxActivateEvent
& event
)
1994 { m_active
= event
.m_active
; }
1996 bool GetActive() const { return m_active
; }
1998 virtual wxEvent
*Clone() const { return new wxActivateEvent(*this); }
2004 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxActivateEvent
)
2007 // InitDialog event class
2012 class WXDLLIMPEXP_CORE wxInitDialogEvent
: public wxEvent
2015 wxInitDialogEvent(int Id
= 0)
2016 : wxEvent(Id
, wxEVT_INIT_DIALOG
)
2019 virtual wxEvent
*Clone() const { return new wxInitDialogEvent(*this); }
2022 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxInitDialogEvent
)
2025 // Miscellaneous menu event class
2029 wxEVT_MENU_HIGHLIGHT,
2032 class WXDLLIMPEXP_CORE wxMenuEvent
: public wxEvent
2035 wxMenuEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0, wxMenu
* menu
= NULL
)
2036 : wxEvent(winid
, type
)
2037 { m_menuId
= winid
; m_menu
= menu
; }
2038 wxMenuEvent(const wxMenuEvent
& event
)
2040 { m_menuId
= event
.m_menuId
; m_menu
= event
.m_menu
; }
2042 // only for wxEVT_MENU_HIGHLIGHT
2043 int GetMenuId() const { return m_menuId
; }
2045 // only for wxEVT_MENU_OPEN/CLOSE
2046 bool IsPopup() const { return m_menuId
== wxID_ANY
; }
2048 // only for wxEVT_MENU_OPEN/CLOSE
2049 wxMenu
* GetMenu() const { return m_menu
; }
2051 virtual wxEvent
*Clone() const { return new wxMenuEvent(*this); }
2057 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMenuEvent
)
2060 // Window close or session close event class
2064 wxEVT_QUERY_END_SESSION
2067 class WXDLLIMPEXP_CORE wxCloseEvent
: public wxEvent
2070 wxCloseEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0)
2071 : wxEvent(winid
, type
),
2073 m_veto(false), // should be false by default
2076 wxCloseEvent(const wxCloseEvent
& event
)
2078 m_loggingOff(event
.m_loggingOff
),
2079 m_veto(event
.m_veto
),
2080 m_canVeto(event
.m_canVeto
) {}
2082 void SetLoggingOff(bool logOff
) { m_loggingOff
= logOff
; }
2083 bool GetLoggingOff() const
2085 // m_loggingOff flag is only used by wxEVT_[QUERY_]END_SESSION, it
2086 // doesn't make sense for wxEVT_CLOSE_WINDOW
2087 wxASSERT_MSG( m_eventType
!= wxEVT_CLOSE_WINDOW
,
2088 wxT("this flag is for end session events only") );
2090 return m_loggingOff
;
2093 void Veto(bool veto
= true)
2095 // GetVeto() will return false anyhow...
2096 wxCHECK_RET( m_canVeto
,
2097 wxT("call to Veto() ignored (can't veto this event)") );
2101 void SetCanVeto(bool canVeto
) { m_canVeto
= canVeto
; }
2102 bool CanVeto() const { return m_canVeto
; }
2103 bool GetVeto() const { return m_canVeto
&& m_veto
; }
2105 virtual wxEvent
*Clone() const { return new wxCloseEvent(*this); }
2113 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCloseEvent
)
2120 class WXDLLIMPEXP_CORE wxShowEvent
: public wxEvent
2123 wxShowEvent(int winid
= 0, bool show
= false)
2124 : wxEvent(winid
, wxEVT_SHOW
)
2126 wxShowEvent(const wxShowEvent
& event
)
2128 { m_show
= event
.m_show
; }
2130 void SetShow(bool show
) { m_show
= show
; }
2132 // return true if the window was shown, false if hidden
2133 bool IsShown() const { return m_show
; }
2135 #if WXWIN_COMPATIBILITY_2_8
2136 wxDEPRECATED( bool GetShow() const { return IsShown(); } )
2139 virtual wxEvent
*Clone() const { return new wxShowEvent(*this); }
2145 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxShowEvent
)
2152 class WXDLLIMPEXP_CORE wxIconizeEvent
: public wxEvent
2155 wxIconizeEvent(int winid
= 0, bool iconized
= true)
2156 : wxEvent(winid
, wxEVT_ICONIZE
)
2157 { m_iconized
= iconized
; }
2158 wxIconizeEvent(const wxIconizeEvent
& event
)
2160 { m_iconized
= event
.m_iconized
; }
2162 #if WXWIN_COMPATIBILITY_2_8
2163 wxDEPRECATED( bool Iconized() const { return IsIconized(); } )
2165 // return true if the frame was iconized, false if restored
2166 bool IsIconized() const { return m_iconized
; }
2168 virtual wxEvent
*Clone() const { return new wxIconizeEvent(*this); }
2174 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIconizeEvent
)
2180 class WXDLLIMPEXP_CORE wxMaximizeEvent
: public wxEvent
2183 wxMaximizeEvent(int winid
= 0)
2184 : wxEvent(winid
, wxEVT_MAXIMIZE
)
2187 virtual wxEvent
*Clone() const { return new wxMaximizeEvent(*this); }
2190 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMaximizeEvent
)
2193 // Joystick event class
2195 wxEVT_JOY_BUTTON_DOWN,
2196 wxEVT_JOY_BUTTON_UP,
2201 // Which joystick? Same as Windows ids so no conversion necessary.
2208 // Which button is down?
2211 wxJOY_BUTTON_ANY
= -1,
2218 class WXDLLIMPEXP_CORE wxJoystickEvent
: public wxEvent
2223 int m_buttonChange
; // Which button changed?
2224 int m_buttonState
; // Which buttons are down?
2225 int m_joyStick
; // Which joystick?
2228 wxJoystickEvent(wxEventType type
= wxEVT_NULL
,
2230 int joystick
= wxJOYSTICK1
,
2235 m_buttonChange(change
),
2236 m_buttonState(state
),
2237 m_joyStick(joystick
)
2240 wxJoystickEvent(const wxJoystickEvent
& event
)
2243 m_zPosition(event
.m_zPosition
),
2244 m_buttonChange(event
.m_buttonChange
),
2245 m_buttonState(event
.m_buttonState
),
2246 m_joyStick(event
.m_joyStick
)
2249 wxPoint
GetPosition() const { return m_pos
; }
2250 int GetZPosition() const { return m_zPosition
; }
2251 int GetButtonState() const { return m_buttonState
; }
2252 int GetButtonChange() const { return m_buttonChange
; }
2253 int GetJoystick() const { return m_joyStick
; }
2255 void SetJoystick(int stick
) { m_joyStick
= stick
; }
2256 void SetButtonState(int state
) { m_buttonState
= state
; }
2257 void SetButtonChange(int change
) { m_buttonChange
= change
; }
2258 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2259 void SetZPosition(int zPos
) { m_zPosition
= zPos
; }
2261 // Was it a button event? (*doesn't* mean: is any button *down*?)
2262 bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN
) ||
2263 (GetEventType() == wxEVT_JOY_BUTTON_UP
)); }
2265 // Was it a move event?
2266 bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE
); }
2268 // Was it a zmove event?
2269 bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE
); }
2271 // Was it a down event from button 1, 2, 3, 4 or any?
2272 bool ButtonDown(int but
= wxJOY_BUTTON_ANY
) const
2273 { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN
) &&
2274 ((but
== wxJOY_BUTTON_ANY
) || (but
== m_buttonChange
))); }
2276 // Was it a up event from button 1, 2, 3 or any?
2277 bool ButtonUp(int but
= wxJOY_BUTTON_ANY
) const
2278 { return ((GetEventType() == wxEVT_JOY_BUTTON_UP
) &&
2279 ((but
== wxJOY_BUTTON_ANY
) || (but
== m_buttonChange
))); }
2281 // Was the given button 1,2,3,4 or any in Down state?
2282 bool ButtonIsDown(int but
= wxJOY_BUTTON_ANY
) const
2283 { return (((but
== wxJOY_BUTTON_ANY
) && (m_buttonState
!= 0)) ||
2284 ((m_buttonState
& but
) == but
)); }
2286 virtual wxEvent
*Clone() const { return new wxJoystickEvent(*this); }
2289 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxJoystickEvent
)
2292 // Drop files event class
2297 class WXDLLIMPEXP_CORE wxDropFilesEvent
: public wxEvent
2304 wxDropFilesEvent(wxEventType type
= wxEVT_NULL
,
2306 wxString
*files
= NULL
)
2313 // we need a copy ctor to avoid deleting m_files pointer twice
2314 wxDropFilesEvent(const wxDropFilesEvent
& other
)
2316 m_noFiles(other
.m_noFiles
),
2320 m_files
= new wxString
[m_noFiles
];
2321 for ( int n
= 0; n
< m_noFiles
; n
++ )
2323 m_files
[n
] = other
.m_files
[n
];
2327 virtual ~wxDropFilesEvent()
2332 wxPoint
GetPosition() const { return m_pos
; }
2333 int GetNumberOfFiles() const { return m_noFiles
; }
2334 wxString
*GetFiles() const { return m_files
; }
2336 virtual wxEvent
*Clone() const { return new wxDropFilesEvent(*this); }
2339 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDropFilesEvent
)
2347 // Whether to always send update events to windows, or
2348 // to only send update events to those with the
2349 // wxWS_EX_PROCESS_UI_UPDATES style.
2353 // Send UI update events to all windows
2354 wxUPDATE_UI_PROCESS_ALL
,
2356 // Send UI update events to windows that have
2357 // the wxWS_EX_PROCESS_UI_UPDATES flag specified
2358 wxUPDATE_UI_PROCESS_SPECIFIED
2361 class WXDLLIMPEXP_CORE wxUpdateUIEvent
: public wxCommandEvent
2364 wxUpdateUIEvent(wxWindowID commandId
= 0)
2365 : wxCommandEvent(wxEVT_UPDATE_UI
, commandId
)
2373 m_setChecked
= false;
2375 wxUpdateUIEvent(const wxUpdateUIEvent
& event
)
2376 : wxCommandEvent(event
),
2377 m_checked(event
.m_checked
),
2378 m_enabled(event
.m_enabled
),
2379 m_shown(event
.m_shown
),
2380 m_setEnabled(event
.m_setEnabled
),
2381 m_setShown(event
.m_setShown
),
2382 m_setText(event
.m_setText
),
2383 m_setChecked(event
.m_setChecked
),
2384 m_text(event
.m_text
)
2387 bool GetChecked() const { return m_checked
; }
2388 bool GetEnabled() const { return m_enabled
; }
2389 bool GetShown() const { return m_shown
; }
2390 wxString
GetText() const { return m_text
; }
2391 bool GetSetText() const { return m_setText
; }
2392 bool GetSetChecked() const { return m_setChecked
; }
2393 bool GetSetEnabled() const { return m_setEnabled
; }
2394 bool GetSetShown() const { return m_setShown
; }
2396 void Check(bool check
) { m_checked
= check
; m_setChecked
= true; }
2397 void Enable(bool enable
) { m_enabled
= enable
; m_setEnabled
= true; }
2398 void Show(bool show
) { m_shown
= show
; m_setShown
= true; }
2399 void SetText(const wxString
& text
) { m_text
= text
; m_setText
= true; }
2401 // Sets the interval between updates in milliseconds.
2402 // Set to -1 to disable updates, or to 0 to update as frequently as possible.
2403 static void SetUpdateInterval(long updateInterval
) { sm_updateInterval
= updateInterval
; }
2405 // Returns the current interval between updates in milliseconds
2406 static long GetUpdateInterval() { return sm_updateInterval
; }
2408 // Can we update this window?
2409 static bool CanUpdate(wxWindowBase
*win
);
2411 // Reset the update time to provide a delay until the next
2412 // time we should update
2413 static void ResetUpdateTime();
2415 // Specify how wxWidgets will send update events: to
2416 // all windows, or only to those which specify that they
2417 // will process the events.
2418 static void SetMode(wxUpdateUIMode mode
) { sm_updateMode
= mode
; }
2420 // Returns the UI update mode
2421 static wxUpdateUIMode
GetMode() { return sm_updateMode
; }
2423 virtual wxEvent
*Clone() const { return new wxUpdateUIEvent(*this); }
2435 static wxLongLong sm_lastUpdate
;
2437 static long sm_updateInterval
;
2438 static wxUpdateUIMode sm_updateMode
;
2441 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxUpdateUIEvent
)
2445 wxEVT_SYS_COLOUR_CHANGED
2448 // TODO: shouldn't all events record the window ID?
2449 class WXDLLIMPEXP_CORE wxSysColourChangedEvent
: public wxEvent
2452 wxSysColourChangedEvent()
2453 : wxEvent(0, wxEVT_SYS_COLOUR_CHANGED
)
2456 virtual wxEvent
*Clone() const { return new wxSysColourChangedEvent(*this); }
2459 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSysColourChangedEvent
)
2463 wxEVT_MOUSE_CAPTURE_CHANGED
2464 The window losing the capture receives this message
2465 (even if it released the capture itself).
2468 class WXDLLIMPEXP_CORE wxMouseCaptureChangedEvent
: public wxEvent
2471 wxMouseCaptureChangedEvent(wxWindowID winid
= 0, wxWindow
* gainedCapture
= NULL
)
2472 : wxEvent(winid
, wxEVT_MOUSE_CAPTURE_CHANGED
),
2473 m_gainedCapture(gainedCapture
)
2476 wxMouseCaptureChangedEvent(const wxMouseCaptureChangedEvent
& event
)
2478 m_gainedCapture(event
.m_gainedCapture
)
2481 virtual wxEvent
*Clone() const { return new wxMouseCaptureChangedEvent(*this); }
2483 wxWindow
* GetCapturedWindow() const { return m_gainedCapture
; }
2486 wxWindow
* m_gainedCapture
;
2488 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureChangedEvent
)
2492 wxEVT_MOUSE_CAPTURE_LOST
2493 The window losing the capture receives this message, unless it released it
2494 it itself or unless wxWindow::CaptureMouse was called on another window
2495 (and so capture will be restored when the new capturer releases it).
2498 class WXDLLIMPEXP_CORE wxMouseCaptureLostEvent
: public wxEvent
2501 wxMouseCaptureLostEvent(wxWindowID winid
= 0)
2502 : wxEvent(winid
, wxEVT_MOUSE_CAPTURE_LOST
)
2505 wxMouseCaptureLostEvent(const wxMouseCaptureLostEvent
& event
)
2509 virtual wxEvent
*Clone() const { return new wxMouseCaptureLostEvent(*this); }
2511 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureLostEvent
)
2515 wxEVT_DISPLAY_CHANGED
2517 class WXDLLIMPEXP_CORE wxDisplayChangedEvent
: public wxEvent
2520 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDisplayChangedEvent
)
2523 wxDisplayChangedEvent()
2524 : wxEvent(0, wxEVT_DISPLAY_CHANGED
)
2527 virtual wxEvent
*Clone() const { return new wxDisplayChangedEvent(*this); }
2531 wxEVT_PALETTE_CHANGED
2534 class WXDLLIMPEXP_CORE wxPaletteChangedEvent
: public wxEvent
2537 wxPaletteChangedEvent(wxWindowID winid
= 0)
2538 : wxEvent(winid
, wxEVT_PALETTE_CHANGED
),
2539 m_changedWindow(NULL
)
2542 wxPaletteChangedEvent(const wxPaletteChangedEvent
& event
)
2544 m_changedWindow(event
.m_changedWindow
)
2547 void SetChangedWindow(wxWindow
* win
) { m_changedWindow
= win
; }
2548 wxWindow
* GetChangedWindow() const { return m_changedWindow
; }
2550 virtual wxEvent
*Clone() const { return new wxPaletteChangedEvent(*this); }
2553 wxWindow
* m_changedWindow
;
2556 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaletteChangedEvent
)
2560 wxEVT_QUERY_NEW_PALETTE
2561 Indicates the window is getting keyboard focus and should re-do its palette.
2564 class WXDLLIMPEXP_CORE wxQueryNewPaletteEvent
: public wxEvent
2567 wxQueryNewPaletteEvent(wxWindowID winid
= 0)
2568 : wxEvent(winid
, wxEVT_QUERY_NEW_PALETTE
),
2569 m_paletteRealized(false)
2571 wxQueryNewPaletteEvent(const wxQueryNewPaletteEvent
& event
)
2573 m_paletteRealized(event
.m_paletteRealized
)
2576 // App sets this if it changes the palette.
2577 void SetPaletteRealized(bool realized
) { m_paletteRealized
= realized
; }
2578 bool GetPaletteRealized() const { return m_paletteRealized
; }
2580 virtual wxEvent
*Clone() const { return new wxQueryNewPaletteEvent(*this); }
2583 bool m_paletteRealized
;
2586 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxQueryNewPaletteEvent
)
2590 Event generated by dialog navigation keys
2591 wxEVT_NAVIGATION_KEY
2593 // NB: don't derive from command event to avoid being propagated to the parent
2594 class WXDLLIMPEXP_CORE wxNavigationKeyEvent
: public wxEvent
2597 wxNavigationKeyEvent()
2598 : wxEvent(0, wxEVT_NAVIGATION_KEY
),
2599 m_flags(IsForward
| FromTab
), // defaults are for TAB
2602 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
2605 wxNavigationKeyEvent(const wxNavigationKeyEvent
& event
)
2607 m_flags(event
.m_flags
),
2608 m_focus(event
.m_focus
)
2611 // direction: forward (true) or backward (false)
2612 bool GetDirection() const
2613 { return (m_flags
& IsForward
) != 0; }
2614 void SetDirection(bool bForward
)
2615 { if ( bForward
) m_flags
|= IsForward
; else m_flags
&= ~IsForward
; }
2617 // it may be a window change event (MDI, notebook pages...) or a control
2619 bool IsWindowChange() const
2620 { return (m_flags
& WinChange
) != 0; }
2621 void SetWindowChange(bool bIs
)
2622 { if ( bIs
) m_flags
|= WinChange
; else m_flags
&= ~WinChange
; }
2624 // Set to true under MSW if the event was generated using the tab key.
2625 // This is required for proper navogation over radio buttons
2626 bool IsFromTab() const
2627 { return (m_flags
& FromTab
) != 0; }
2628 void SetFromTab(bool bIs
)
2629 { if ( bIs
) m_flags
|= FromTab
; else m_flags
&= ~FromTab
; }
2631 // the child which has the focus currently (may be NULL - use
2632 // wxWindow::FindFocus then)
2633 wxWindow
* GetCurrentFocus() const { return m_focus
; }
2634 void SetCurrentFocus(wxWindow
*win
) { m_focus
= win
; }
2637 void SetFlags(long flags
) { m_flags
= flags
; }
2639 virtual wxEvent
*Clone() const { return new wxNavigationKeyEvent(*this); }
2641 enum wxNavigationKeyEventFlags
2643 IsBackward
= 0x0000,
2653 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNavigationKeyEvent
)
2656 // Window creation/destruction events: the first is sent as soon as window is
2657 // created (i.e. the underlying GUI object exists), but when the C++ object is
2658 // fully initialized (so virtual functions may be called). The second,
2659 // wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
2660 // still safe to call virtual functions at this moment
2666 class WXDLLIMPEXP_CORE wxWindowCreateEvent
: public wxCommandEvent
2669 wxWindowCreateEvent(wxWindow
*win
= NULL
);
2671 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
2673 virtual wxEvent
*Clone() const { return new wxWindowCreateEvent(*this); }
2676 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowCreateEvent
)
2679 class WXDLLIMPEXP_CORE wxWindowDestroyEvent
: public wxCommandEvent
2682 wxWindowDestroyEvent(wxWindow
*win
= NULL
);
2684 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
2686 virtual wxEvent
*Clone() const { return new wxWindowDestroyEvent(*this); }
2689 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowDestroyEvent
)
2692 // A help event is sent when the user clicks on a window in context-help mode.
2698 class WXDLLIMPEXP_CORE wxHelpEvent
: public wxCommandEvent
2701 // how was this help event generated?
2704 Origin_Unknown
, // unrecognized event source
2705 Origin_Keyboard
, // event generated from F1 key press
2706 Origin_HelpButton
// event from [?] button on the title bar (Windows)
2709 wxHelpEvent(wxEventType type
= wxEVT_NULL
,
2710 wxWindowID winid
= 0,
2711 const wxPoint
& pt
= wxDefaultPosition
,
2712 Origin origin
= Origin_Unknown
)
2713 : wxCommandEvent(type
, winid
),
2715 m_origin(GuessOrigin(origin
))
2717 wxHelpEvent(const wxHelpEvent
& event
)
2718 : wxCommandEvent(event
),
2720 m_target(event
.m_target
),
2721 m_link(event
.m_link
),
2722 m_origin(event
.m_origin
)
2725 // Position of event (in screen coordinates)
2726 const wxPoint
& GetPosition() const { return m_pos
; }
2727 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2729 // Optional link to further help
2730 const wxString
& GetLink() const { return m_link
; }
2731 void SetLink(const wxString
& link
) { m_link
= link
; }
2733 // Optional target to display help in. E.g. a window specification
2734 const wxString
& GetTarget() const { return m_target
; }
2735 void SetTarget(const wxString
& target
) { m_target
= target
; }
2737 virtual wxEvent
*Clone() const { return new wxHelpEvent(*this); }
2739 // optional indication of the event source
2740 Origin
GetOrigin() const { return m_origin
; }
2741 void SetOrigin(Origin origin
) { m_origin
= origin
; }
2749 // we can try to guess the event origin ourselves, even if none is
2750 // specified in the ctor
2751 static Origin
GuessOrigin(Origin origin
);
2754 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHelpEvent
)
2757 // A Clipboard Text event is sent when a window intercepts text copy/cut/paste
2758 // message, i.e. the user has cut/copied/pasted data from/into a text control
2759 // via ctrl-C/X/V, ctrl/shift-del/insert, a popup menu command, etc.
2760 // NOTE : under windows these events are *NOT* generated automatically
2761 // for a Rich Edit text control.
2763 wxEVT_COMMAND_TEXT_COPY
2764 wxEVT_COMMAND_TEXT_CUT
2765 wxEVT_COMMAND_TEXT_PASTE
2768 class WXDLLIMPEXP_CORE wxClipboardTextEvent
: public wxCommandEvent
2771 wxClipboardTextEvent(wxEventType type
= wxEVT_NULL
,
2772 wxWindowID winid
= 0)
2773 : wxCommandEvent(type
, winid
)
2775 wxClipboardTextEvent(const wxClipboardTextEvent
& event
)
2776 : wxCommandEvent(event
)
2779 virtual wxEvent
*Clone() const { return new wxClipboardTextEvent(*this); }
2782 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxClipboardTextEvent
)
2785 // A Context event is sent when the user right clicks on a window or
2786 // presses Shift-F10
2787 // NOTE : Under windows this is a repackaged WM_CONTETXMENU message
2788 // Under other systems it may have to be generated from a right click event
2793 class WXDLLIMPEXP_CORE wxContextMenuEvent
: public wxCommandEvent
2796 wxContextMenuEvent(wxEventType type
= wxEVT_NULL
,
2797 wxWindowID winid
= 0,
2798 const wxPoint
& pt
= wxDefaultPosition
)
2799 : wxCommandEvent(type
, winid
),
2802 wxContextMenuEvent(const wxContextMenuEvent
& event
)
2803 : wxCommandEvent(event
),
2807 // Position of event (in screen coordinates)
2808 const wxPoint
& GetPosition() const { return m_pos
; }
2809 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2811 virtual wxEvent
*Clone() const { return new wxContextMenuEvent(*this); }
2817 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxContextMenuEvent
)
2822 wxEVT_MOUSE_CAPTURE_CHANGED,
2823 wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
2824 // wxEVT_FONT_CHANGED, // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
2825 // wxEVT_FONT_CHANGED to all other windows (maybe).
2826 wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
2834 // ============================================================================
2835 // event handler and related classes
2836 // ============================================================================
2839 // struct containing the members common to static and dynamic event tables
2841 struct WXDLLIMPEXP_BASE wxEventTableEntryBase
2843 wxEventTableEntryBase(int winid
, int idLast
,
2844 wxEventFunctor
* fn
, wxObject
*data
)
2848 m_callbackUserData(data
)
2850 wxASSERT_MSG( idLast
== wxID_ANY
|| winid
<= idLast
,
2851 "invalid IDs range: lower bound > upper bound" );
2854 wxEventTableEntryBase( const wxEventTableEntryBase
&entry
)
2855 : m_id( entry
.m_id
),
2856 m_lastId( entry
.m_lastId
),
2858 m_callbackUserData( entry
.m_callbackUserData
)
2860 // This is a 'hack' to ensure that only one instance tries to delete
2861 // the functor pointer. It is safe as long as the only place where the
2862 // copy constructor is being called is when the static event tables are
2863 // being initialized (a temporary instance is created and then this
2864 // constructor is called).
2866 const_cast<wxEventTableEntryBase
&>( entry
).m_fn
= NULL
;
2869 ~wxEventTableEntryBase()
2874 // the range of ids for this entry: if m_lastId == wxID_ANY, the range
2875 // consists only of m_id, otherwise it is m_id..m_lastId inclusive
2879 // function/method/functor to call
2880 wxEventFunctor
* m_fn
;
2882 // arbitrary user data associated with the callback
2883 wxObject
* m_callbackUserData
;
2886 wxDECLARE_NO_ASSIGN_CLASS(wxEventTableEntryBase
);
2889 // an entry from a static event table
2890 struct WXDLLIMPEXP_BASE wxEventTableEntry
: public wxEventTableEntryBase
2892 wxEventTableEntry(const int& evType
, int winid
, int idLast
,
2893 wxEventFunctor
* fn
, wxObject
*data
)
2894 : wxEventTableEntryBase(winid
, idLast
, fn
, data
),
2898 // the reference to event type: this allows us to not care about the
2899 // (undefined) order in which the event table entries and the event types
2900 // are initialized: initially the value of this reference might be
2901 // invalid, but by the time it is used for the first time, all global
2902 // objects will have been initialized (including the event type constants)
2903 // and so it will have the correct value when it is needed
2904 const int& m_eventType
;
2907 wxDECLARE_NO_ASSIGN_CLASS(wxEventTableEntry
);
2910 // an entry used in dynamic event table managed by wxEvtHandler::Connect()
2911 struct WXDLLIMPEXP_BASE wxDynamicEventTableEntry
: public wxEventTableEntryBase
2913 wxDynamicEventTableEntry(int evType
, int winid
, int idLast
,
2914 wxEventFunctor
* fn
, wxObject
*data
)
2915 : wxEventTableEntryBase(winid
, idLast
, fn
, data
),
2919 // not a reference here as we can't keep a reference to a temporary int
2920 // created to wrap the constant value typically passed to Connect() - nor
2925 wxDECLARE_NO_ASSIGN_CLASS(wxDynamicEventTableEntry
);
2928 // ----------------------------------------------------------------------------
2929 // wxEventTable: an array of event entries terminated with {0, 0, 0, 0, 0}
2930 // ----------------------------------------------------------------------------
2932 struct WXDLLIMPEXP_BASE wxEventTable
2934 const wxEventTable
*baseTable
; // base event table (next in chain)
2935 const wxEventTableEntry
*entries
; // bottom of entry array
2938 // ----------------------------------------------------------------------------
2939 // wxEventHashTable: a helper of wxEvtHandler to speed up wxEventTable lookups.
2940 // ----------------------------------------------------------------------------
2942 WX_DEFINE_ARRAY_PTR(const wxEventTableEntry
*, wxEventTableEntryPointerArray
);
2944 class WXDLLIMPEXP_BASE wxEventHashTable
2947 // Internal data structs
2948 struct EventTypeTable
2950 wxEventType eventType
;
2951 wxEventTableEntryPointerArray eventEntryTable
;
2953 typedef EventTypeTable
* EventTypeTablePointer
;
2956 // Constructor, needs the event table it needs to hash later on.
2957 // Note: hashing of the event table is not done in the constructor as it
2958 // can be that the event table is not yet full initialize, the hash
2959 // will gets initialized when handling the first event look-up request.
2960 wxEventHashTable(const wxEventTable
&table
);
2962 ~wxEventHashTable();
2964 // Handle the given event, in other words search the event table hash
2965 // and call self->ProcessEvent() if a match was found.
2966 bool HandleEvent(wxEvent
& event
, wxEvtHandler
*self
);
2971 #if wxUSE_MEMORY_TRACING
2972 // Clear all tables: only used to work around problems in memory tracing
2974 static void ClearAll();
2975 #endif // wxUSE_MEMORY_TRACING
2978 // Init the hash table with the entries of the static event table.
2979 void InitHashTable();
2980 // Helper funtion of InitHashTable() to insert 1 entry into the hash table.
2981 void AddEntry(const wxEventTableEntry
&entry
);
2982 // Allocate and init with null pointers the base hash table.
2983 void AllocEventTypeTable(size_t size
);
2984 // Grow the hash table in size and transfer all items currently
2985 // in the table to the correct location in the new table.
2986 void GrowEventTypeTable();
2989 const wxEventTable
&m_table
;
2993 EventTypeTablePointer
*m_eventTypeTable
;
2995 static wxEventHashTable
* sm_first
;
2996 wxEventHashTable
* m_previous
;
2997 wxEventHashTable
* m_next
;
2999 wxDECLARE_NO_COPY_CLASS(wxEventHashTable
);
3002 // ----------------------------------------------------------------------------
3003 // wxEvtHandler: the base class for all objects handling wxWidgets events
3004 // ----------------------------------------------------------------------------
3006 class WXDLLIMPEXP_BASE wxEvtHandler
: public wxObject
3007 , public wxTrackable
3011 virtual ~wxEvtHandler();
3014 // Event handler chain
3015 // -------------------
3017 wxEvtHandler
*GetNextHandler() const { return m_nextHandler
; }
3018 wxEvtHandler
*GetPreviousHandler() const { return m_previousHandler
; }
3019 virtual void SetNextHandler(wxEvtHandler
*handler
) { m_nextHandler
= handler
; }
3020 virtual void SetPreviousHandler(wxEvtHandler
*handler
) { m_previousHandler
= handler
; }
3022 void SetEvtHandlerEnabled(bool enabled
) { m_enabled
= enabled
; }
3023 bool GetEvtHandlerEnabled() const { return m_enabled
; }
3026 bool IsUnlinked() const;
3029 // Global event filters
3030 // --------------------
3032 // Add an event filter whose FilterEvent() method will be called for each
3033 // and every event processed by wxWidgets. The filters are called in LIFO
3034 // order and wxApp is registered as an event filter by default. The pointer
3035 // must remain valid until it's removed with RemoveFilter() and is not
3036 // deleted by wxEvtHandler.
3037 static void AddFilter(wxEventFilter
* filter
);
3039 // Remove a filter previously installed with AddFilter().
3040 static void RemoveFilter(wxEventFilter
* filter
);
3043 // Event queuing and processing
3044 // ----------------------------
3046 // Process an event right now: this can only be called from the main
3047 // thread, use QueueEvent() for scheduling the events for
3048 // processing from other threads.
3049 virtual bool ProcessEvent(wxEvent
& event
);
3051 // Process an event by calling ProcessEvent and handling any exceptions
3052 // thrown by event handlers. It's mostly useful when processing wx events
3053 // when called from C code (e.g. in GTK+ callback) when the exception
3054 // wouldn't correctly propagate to wxEventLoop.
3055 bool SafelyProcessEvent(wxEvent
& event
);
3056 // NOTE: uses ProcessEvent()
3058 // This method tries to process the event in this event handler, including
3059 // any preprocessing done by TryBefore() and all the handlers chained to
3060 // it, but excluding the post-processing done in TryAfter().
3062 // It is meant to be called from ProcessEvent() only and is not virtual,
3063 // additional event handlers can be hooked into the normal event processing
3064 // logic using TryBefore() and TryAfter() hooks.
3066 // You can also call it yourself to forward an event to another handler but
3067 // without propagating it upwards if it's unhandled (this is usually
3068 // unwanted when forwarding as the original handler would already do it if
3069 // needed normally).
3070 bool ProcessEventLocally(wxEvent
& event
);
3072 // Schedule the given event to be processed later. It takes ownership of
3073 // the event pointer, i.e. it will be deleted later. This is safe to call
3074 // from multiple threads although you still need to ensure that wxString
3075 // fields of the event object are deep copies and not use the same string
3076 // buffer as other wxString objects in this thread.
3077 virtual void QueueEvent(wxEvent
*event
);
3079 // Add an event to be processed later: notice that this function is not
3080 // safe to call from threads other than main, use QueueEvent()
3081 virtual void AddPendingEvent(const wxEvent
& event
)
3083 // notice that the thread-safety problem comes from the fact that
3084 // Clone() doesn't make deep copies of wxString fields of wxEvent
3085 // object and so the same wxString could be used from both threads when
3086 // the event object is destroyed in this one -- QueueEvent() avoids
3087 // this problem as the event pointer is not used any more in this
3088 // thread at all after it is called.
3089 QueueEvent(event
.Clone());
3092 void ProcessPendingEvents();
3093 // NOTE: uses ProcessEvent()
3095 void DeletePendingEvents();
3098 bool ProcessThreadEvent(const wxEvent
& event
);
3099 // NOTE: uses AddPendingEvent(); call only from secondary threads
3103 // Connecting and disconnecting
3104 // ----------------------------
3106 // These functions are used for old, untyped, event handlers and don't
3107 // check that the type of the function passed to them actually matches the
3108 // type of the event. They also only allow connecting events to methods of
3109 // wxEvtHandler-derived classes.
3111 // The template Connect() methods below are safer and allow connecting
3112 // events to arbitrary functions or functors -- but require compiler
3113 // support for templates.
3115 // Dynamic association of a member function handler with the event handler,
3116 // winid and event type
3117 void Connect(int winid
,
3119 wxEventType eventType
,
3120 wxObjectEventFunction func
,
3121 wxObject
*userData
= NULL
,
3122 wxEvtHandler
*eventSink
= NULL
)
3124 DoBind(winid
, lastId
, eventType
,
3125 wxNewEventFunctor(eventType
, func
, eventSink
),
3129 // Convenience function: take just one id
3130 void Connect(int winid
,
3131 wxEventType eventType
,
3132 wxObjectEventFunction func
,
3133 wxObject
*userData
= NULL
,
3134 wxEvtHandler
*eventSink
= NULL
)
3135 { Connect(winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3137 // Even more convenient: without id (same as using id of wxID_ANY)
3138 void Connect(wxEventType eventType
,
3139 wxObjectEventFunction func
,
3140 wxObject
*userData
= NULL
,
3141 wxEvtHandler
*eventSink
= NULL
)
3142 { Connect(wxID_ANY
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3144 bool Disconnect(int winid
,
3146 wxEventType eventType
,
3147 wxObjectEventFunction func
= NULL
,
3148 wxObject
*userData
= NULL
,
3149 wxEvtHandler
*eventSink
= NULL
)
3151 return DoUnbind(winid
, lastId
, eventType
,
3152 wxMakeEventFunctor(eventType
, func
, eventSink
),
3156 bool Disconnect(int winid
= wxID_ANY
,
3157 wxEventType eventType
= wxEVT_NULL
,
3158 wxObjectEventFunction func
= NULL
,
3159 wxObject
*userData
= NULL
,
3160 wxEvtHandler
*eventSink
= NULL
)
3161 { return Disconnect(winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3163 bool Disconnect(wxEventType eventType
,
3164 wxObjectEventFunction func
,
3165 wxObject
*userData
= NULL
,
3166 wxEvtHandler
*eventSink
= NULL
)
3167 { return Disconnect(wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3169 #ifdef wxHAS_EVENT_BIND
3170 // Bind functions to an event:
3171 template <typename EventTag
, typename EventArg
>
3172 void Bind(const EventTag
& eventType
,
3173 void (*function
)(EventArg
&),
3174 int winid
= wxID_ANY
,
3175 int lastId
= wxID_ANY
,
3176 wxObject
*userData
= NULL
)
3178 DoBind(winid
, lastId
, eventType
,
3179 wxNewEventFunctor(eventType
, function
),
3184 template <typename EventTag
, typename EventArg
>
3185 bool Unbind(const EventTag
& eventType
,
3186 void (*function
)(EventArg
&),
3187 int winid
= wxID_ANY
,
3188 int lastId
= wxID_ANY
,
3189 wxObject
*userData
= NULL
)
3191 return DoUnbind(winid
, lastId
, eventType
,
3192 wxMakeEventFunctor(eventType
, function
),
3196 // Bind functors to an event:
3197 template <typename EventTag
, typename Functor
>
3198 void Bind(const EventTag
& eventType
,
3199 const Functor
&functor
,
3200 int winid
= wxID_ANY
,
3201 int lastId
= wxID_ANY
,
3202 wxObject
*userData
= NULL
)
3204 DoBind(winid
, lastId
, eventType
,
3205 wxNewEventFunctor(eventType
, functor
),
3210 template <typename EventTag
, typename Functor
>
3211 bool Unbind(const EventTag
& eventType
,
3212 const Functor
&functor
,
3213 int winid
= wxID_ANY
,
3214 int lastId
= wxID_ANY
,
3215 wxObject
*userData
= NULL
)
3217 return DoUnbind(winid
, lastId
, eventType
,
3218 wxMakeEventFunctor(eventType
, functor
),
3223 // Bind a method of a class (called on the specified handler which must
3224 // be convertible to this class) object to an event:
3226 template <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
3227 void Bind(const EventTag
&eventType
,
3228 void (Class::*method
)(EventArg
&),
3229 EventHandler
*handler
,
3230 int winid
= wxID_ANY
,
3231 int lastId
= wxID_ANY
,
3232 wxObject
*userData
= NULL
)
3234 DoBind(winid
, lastId
, eventType
,
3235 wxNewEventFunctor(eventType
, method
, handler
),
3239 template <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
3240 bool Unbind(const EventTag
&eventType
,
3241 void (Class::*method
)(EventArg
&),
3242 EventHandler
*handler
,
3243 int winid
= wxID_ANY
,
3244 int lastId
= wxID_ANY
,
3245 wxObject
*userData
= NULL
)
3247 return DoUnbind(winid
, lastId
, eventType
,
3248 wxMakeEventFunctor(eventType
, method
, handler
),
3251 #endif // wxHAS_EVENT_BIND
3253 wxList
* GetDynamicEventTable() const { return m_dynamicEvents
; }
3255 // User data can be associated with each wxEvtHandler
3256 void SetClientObject( wxClientData
*data
) { DoSetClientObject(data
); }
3257 wxClientData
*GetClientObject() const { return DoGetClientObject(); }
3259 void SetClientData( void *data
) { DoSetClientData(data
); }
3260 void *GetClientData() const { return DoGetClientData(); }
3263 // implementation from now on
3264 // --------------------------
3266 // check if the given event table entry matches this event by id (the check
3267 // for the event type should be done by caller) and call the handler if it
3270 // return true if the event was processed, false otherwise (no match or the
3271 // handler decided to skip the event)
3272 static bool ProcessEventIfMatchesId(const wxEventTableEntryBase
& tableEntry
,
3273 wxEvtHandler
*handler
,
3276 virtual bool SearchEventTable(wxEventTable
& table
, wxEvent
& event
);
3277 bool SearchDynamicEventTable( wxEvent
& event
);
3279 // Avoid problems at exit by cleaning up static hash table gracefully
3280 void ClearEventHashTable() { GetEventHashTable().Clear(); }
3281 void OnSinkDestroyed( wxEvtHandler
*sink
);
3285 void DoBind(int winid
,
3287 wxEventType eventType
,
3288 wxEventFunctor
*func
,
3289 wxObject
* userData
= NULL
);
3291 bool DoUnbind(int winid
,
3293 wxEventType eventType
,
3294 const wxEventFunctor
& func
,
3295 wxObject
*userData
= NULL
);
3297 static const wxEventTableEntry sm_eventTableEntries
[];
3300 // hooks for wxWindow used by ProcessEvent()
3301 // -----------------------------------------
3303 // this one is called before trying our own event table to allow plugging
3304 // in the event handlers overriding the default logic, this is used by e.g.
3306 virtual bool TryBefore(wxEvent
& event
);
3308 // This one is not a hook but just a helper which looks up the handler in
3309 // this object itself.
3311 // It is called from ProcessEventLocally() and normally shouldn't be called
3312 // directly as doing it would ignore any chained event handlers
3313 bool TryHereOnly(wxEvent
& event
);
3315 // Another helper which simply calls pre-processing hook and then tries to
3316 // handle the event at this handler level.
3317 bool TryBeforeAndHere(wxEvent
& event
)
3319 return TryBefore(event
) || TryHereOnly(event
);
3322 // this one is called after failing to find the event handle in our own
3323 // table to give a chance to the other windows to process it
3325 // base class implementation passes the event to wxTheApp
3326 virtual bool TryAfter(wxEvent
& event
);
3328 #ifdef WXWIN_COMPATIBILITY_2_8
3329 // deprecated method: override TryBefore() instead of this one
3330 wxDEPRECATED_BUT_USED_INTERNALLY_INLINE(
3331 virtual bool TryValidator(wxEvent
& WXUNUSED(event
)), return false; )
3333 wxDEPRECATED_BUT_USED_INTERNALLY_INLINE(
3334 virtual bool TryParent(wxEvent
& event
), return DoTryApp(event
); )
3335 #endif // WXWIN_COMPATIBILITY_2_8
3338 static const wxEventTable sm_eventTable
;
3339 virtual const wxEventTable
*GetEventTable() const;
3341 static wxEventHashTable sm_eventHashTable
;
3342 virtual wxEventHashTable
& GetEventHashTable() const;
3344 wxEvtHandler
* m_nextHandler
;
3345 wxEvtHandler
* m_previousHandler
;
3346 wxList
* m_dynamicEvents
;
3347 wxList
* m_pendingEvents
;
3350 // critical section protecting m_pendingEvents
3351 wxCriticalSection m_pendingEventsLock
;
3352 #endif // wxUSE_THREADS
3354 // Is event handler enabled?
3358 // The user data: either an object which will be deleted by the container
3359 // when it's deleted or some raw pointer which we do nothing with - only
3360 // one type of data can be used with the given window (i.e. you cannot set
3361 // the void data and then associate the container with wxClientData or vice
3365 wxClientData
*m_clientObject
;
3369 // what kind of data do we have?
3370 wxClientDataType m_clientDataType
;
3372 // client data accessors
3373 virtual void DoSetClientObject( wxClientData
*data
);
3374 virtual wxClientData
*DoGetClientObject() const;
3376 virtual void DoSetClientData( void *data
);
3377 virtual void *DoGetClientData() const;
3379 // Search tracker objects for event connection with this sink
3380 wxEventConnectionRef
*FindRefInTrackerList(wxEvtHandler
*handler
);
3383 // pass the event to wxTheApp instance, called from TryAfter()
3384 bool DoTryApp(wxEvent
& event
);
3386 // try to process events in all handlers chained to this one
3387 bool DoTryChain(wxEvent
& event
);
3389 // Head of the event filter linked list.
3390 static wxEventFilter
* ms_filterList
;
3392 DECLARE_DYNAMIC_CLASS_NO_COPY(wxEvtHandler
)
3395 WX_DEFINE_ARRAY_WITH_DECL_PTR(wxEvtHandler
*, wxEvtHandlerArray
, class WXDLLIMPEXP_BASE
);
3398 // Define an inline method of wxObjectEventFunctor which couldn't be defined
3399 // before wxEvtHandler declaration: at least Sun CC refuses to compile function
3400 // calls through pointer to member for forward-declared classes (see #12452).
3401 inline void wxObjectEventFunctor::operator()(wxEvtHandler
*handler
, wxEvent
& event
)
3403 wxEvtHandler
* const realHandler
= m_handler
? m_handler
: handler
;
3405 (realHandler
->*m_method
)(event
);
3408 // ----------------------------------------------------------------------------
3409 // wxEventConnectionRef represents all connections between two event handlers
3410 // and enables automatic disconnect when an event handler sink goes out of
3411 // scope. Each connection/disconnect increases/decreases ref count, and
3412 // when it reaches zero the node goes out of scope.
3413 // ----------------------------------------------------------------------------
3415 class wxEventConnectionRef
: public wxTrackerNode
3418 wxEventConnectionRef() : m_src(NULL
), m_sink(NULL
), m_refCount(0) { }
3419 wxEventConnectionRef(wxEvtHandler
*src
, wxEvtHandler
*sink
)
3420 : m_src(src
), m_sink(sink
), m_refCount(1)
3422 m_sink
->AddNode(this);
3425 // The sink is being destroyed
3426 virtual void OnObjectDestroy( )
3429 m_src
->OnSinkDestroyed( m_sink
);
3433 virtual wxEventConnectionRef
*ToEventConnection() { return this; }
3435 void IncRef() { m_refCount
++; }
3438 if ( !--m_refCount
)
3440 // The sink holds the only external pointer to this object
3442 m_sink
->RemoveNode(this);
3448 wxEvtHandler
*m_src
,
3452 friend class wxEvtHandler
;
3454 wxDECLARE_NO_ASSIGN_CLASS(wxEventConnectionRef
);
3457 // Post a message to the given event handler which will be processed during the
3458 // next event loop iteration.
3460 // Notice that this one is not thread-safe, use wxQueueEvent()
3461 inline void wxPostEvent(wxEvtHandler
*dest
, const wxEvent
& event
)
3463 wxCHECK_RET( dest
, "need an object to post event to" );
3465 dest
->AddPendingEvent(event
);
3468 // Wrapper around wxEvtHandler::QueueEvent(): adds an event for later
3469 // processing, unlike wxPostEvent it is safe to use from different thread even
3470 // for events with wxString members
3471 inline void wxQueueEvent(wxEvtHandler
*dest
, wxEvent
*event
)
3473 wxCHECK_RET( dest
, "need an object to queue event for" );
3475 dest
->QueueEvent(event
);
3478 typedef void (wxEvtHandler::*wxEventFunction
)(wxEvent
&);
3479 typedef void (wxEvtHandler::*wxIdleEventFunction
)(wxIdleEvent
&);
3480 typedef void (wxEvtHandler::*wxThreadEventFunction
)(wxThreadEvent
&);
3482 #define wxEventHandler(func) \
3483 wxEVENT_HANDLER_CAST(wxEventFunction, func)
3484 #define wxIdleEventHandler(func) \
3485 wxEVENT_HANDLER_CAST(wxIdleEventFunction, func)
3486 #define wxThreadEventHandler(func) \
3487 wxEVENT_HANDLER_CAST(wxThreadEventFunction, func)
3491 // ----------------------------------------------------------------------------
3492 // wxEventBlocker: helper class to temporarily disable event handling for a window
3493 // ----------------------------------------------------------------------------
3495 class WXDLLIMPEXP_CORE wxEventBlocker
: public wxEvtHandler
3498 wxEventBlocker(wxWindow
*win
, wxEventType type
= wxEVT_ANY
);
3499 virtual ~wxEventBlocker();
3501 void Block(wxEventType type
)
3503 m_eventsToBlock
.push_back(type
);
3506 virtual bool ProcessEvent(wxEvent
& event
);
3509 wxArrayInt m_eventsToBlock
;
3512 wxDECLARE_NO_COPY_CLASS(wxEventBlocker
);
3515 typedef void (wxEvtHandler::*wxCommandEventFunction
)(wxCommandEvent
&);
3516 typedef void (wxEvtHandler::*wxScrollEventFunction
)(wxScrollEvent
&);
3517 typedef void (wxEvtHandler::*wxScrollWinEventFunction
)(wxScrollWinEvent
&);
3518 typedef void (wxEvtHandler::*wxSizeEventFunction
)(wxSizeEvent
&);
3519 typedef void (wxEvtHandler::*wxMoveEventFunction
)(wxMoveEvent
&);
3520 typedef void (wxEvtHandler::*wxPaintEventFunction
)(wxPaintEvent
&);
3521 typedef void (wxEvtHandler::*wxNcPaintEventFunction
)(wxNcPaintEvent
&);
3522 typedef void (wxEvtHandler::*wxEraseEventFunction
)(wxEraseEvent
&);
3523 typedef void (wxEvtHandler::*wxMouseEventFunction
)(wxMouseEvent
&);
3524 typedef void (wxEvtHandler::*wxCharEventFunction
)(wxKeyEvent
&);
3525 typedef void (wxEvtHandler::*wxFocusEventFunction
)(wxFocusEvent
&);
3526 typedef void (wxEvtHandler::*wxChildFocusEventFunction
)(wxChildFocusEvent
&);
3527 typedef void (wxEvtHandler::*wxActivateEventFunction
)(wxActivateEvent
&);
3528 typedef void (wxEvtHandler::*wxMenuEventFunction
)(wxMenuEvent
&);
3529 typedef void (wxEvtHandler::*wxJoystickEventFunction
)(wxJoystickEvent
&);
3530 typedef void (wxEvtHandler::*wxDropFilesEventFunction
)(wxDropFilesEvent
&);
3531 typedef void (wxEvtHandler::*wxInitDialogEventFunction
)(wxInitDialogEvent
&);
3532 typedef void (wxEvtHandler::*wxSysColourChangedEventFunction
)(wxSysColourChangedEvent
&);
3533 typedef void (wxEvtHandler::*wxDisplayChangedEventFunction
)(wxDisplayChangedEvent
&);
3534 typedef void (wxEvtHandler::*wxUpdateUIEventFunction
)(wxUpdateUIEvent
&);
3535 typedef void (wxEvtHandler::*wxCloseEventFunction
)(wxCloseEvent
&);
3536 typedef void (wxEvtHandler::*wxShowEventFunction
)(wxShowEvent
&);
3537 typedef void (wxEvtHandler::*wxIconizeEventFunction
)(wxIconizeEvent
&);
3538 typedef void (wxEvtHandler::*wxMaximizeEventFunction
)(wxMaximizeEvent
&);
3539 typedef void (wxEvtHandler::*wxNavigationKeyEventFunction
)(wxNavigationKeyEvent
&);
3540 typedef void (wxEvtHandler::*wxPaletteChangedEventFunction
)(wxPaletteChangedEvent
&);
3541 typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction
)(wxQueryNewPaletteEvent
&);
3542 typedef void (wxEvtHandler::*wxWindowCreateEventFunction
)(wxWindowCreateEvent
&);
3543 typedef void (wxEvtHandler::*wxWindowDestroyEventFunction
)(wxWindowDestroyEvent
&);
3544 typedef void (wxEvtHandler::*wxSetCursorEventFunction
)(wxSetCursorEvent
&);
3545 typedef void (wxEvtHandler::*wxNotifyEventFunction
)(wxNotifyEvent
&);
3546 typedef void (wxEvtHandler::*wxHelpEventFunction
)(wxHelpEvent
&);
3547 typedef void (wxEvtHandler::*wxContextMenuEventFunction
)(wxContextMenuEvent
&);
3548 typedef void (wxEvtHandler::*wxMouseCaptureChangedEventFunction
)(wxMouseCaptureChangedEvent
&);
3549 typedef void (wxEvtHandler::*wxMouseCaptureLostEventFunction
)(wxMouseCaptureLostEvent
&);
3550 typedef void (wxEvtHandler::*wxClipboardTextEventFunction
)(wxClipboardTextEvent
&);
3553 #define wxCommandEventHandler(func) \
3554 wxEVENT_HANDLER_CAST(wxCommandEventFunction, func)
3555 #define wxScrollEventHandler(func) \
3556 wxEVENT_HANDLER_CAST(wxScrollEventFunction, func)
3557 #define wxScrollWinEventHandler(func) \
3558 wxEVENT_HANDLER_CAST(wxScrollWinEventFunction, func)
3559 #define wxSizeEventHandler(func) \
3560 wxEVENT_HANDLER_CAST(wxSizeEventFunction, func)
3561 #define wxMoveEventHandler(func) \
3562 wxEVENT_HANDLER_CAST(wxMoveEventFunction, func)
3563 #define wxPaintEventHandler(func) \
3564 wxEVENT_HANDLER_CAST(wxPaintEventFunction, func)
3565 #define wxNcPaintEventHandler(func) \
3566 wxEVENT_HANDLER_CAST(wxNcPaintEventFunction, func)
3567 #define wxEraseEventHandler(func) \
3568 wxEVENT_HANDLER_CAST(wxEraseEventFunction, func)
3569 #define wxMouseEventHandler(func) \
3570 wxEVENT_HANDLER_CAST(wxMouseEventFunction, func)
3571 #define wxCharEventHandler(func) \
3572 wxEVENT_HANDLER_CAST(wxCharEventFunction, func)
3573 #define wxKeyEventHandler(func) wxCharEventHandler(func)
3574 #define wxFocusEventHandler(func) \
3575 wxEVENT_HANDLER_CAST(wxFocusEventFunction, func)
3576 #define wxChildFocusEventHandler(func) \
3577 wxEVENT_HANDLER_CAST(wxChildFocusEventFunction, func)
3578 #define wxActivateEventHandler(func) \
3579 wxEVENT_HANDLER_CAST(wxActivateEventFunction, func)
3580 #define wxMenuEventHandler(func) \
3581 wxEVENT_HANDLER_CAST(wxMenuEventFunction, func)
3582 #define wxJoystickEventHandler(func) \
3583 wxEVENT_HANDLER_CAST(wxJoystickEventFunction, func)
3584 #define wxDropFilesEventHandler(func) \
3585 wxEVENT_HANDLER_CAST(wxDropFilesEventFunction, func)
3586 #define wxInitDialogEventHandler(func) \
3587 wxEVENT_HANDLER_CAST(wxInitDialogEventFunction, func)
3588 #define wxSysColourChangedEventHandler(func) \
3589 wxEVENT_HANDLER_CAST(wxSysColourChangedEventFunction, func)
3590 #define wxDisplayChangedEventHandler(func) \
3591 wxEVENT_HANDLER_CAST(wxDisplayChangedEventFunction, func)
3592 #define wxUpdateUIEventHandler(func) \
3593 wxEVENT_HANDLER_CAST(wxUpdateUIEventFunction, func)
3594 #define wxCloseEventHandler(func) \
3595 wxEVENT_HANDLER_CAST(wxCloseEventFunction, func)
3596 #define wxShowEventHandler(func) \
3597 wxEVENT_HANDLER_CAST(wxShowEventFunction, func)
3598 #define wxIconizeEventHandler(func) \
3599 wxEVENT_HANDLER_CAST(wxIconizeEventFunction, func)
3600 #define wxMaximizeEventHandler(func) \
3601 wxEVENT_HANDLER_CAST(wxMaximizeEventFunction, func)
3602 #define wxNavigationKeyEventHandler(func) \
3603 wxEVENT_HANDLER_CAST(wxNavigationKeyEventFunction, func)
3604 #define wxPaletteChangedEventHandler(func) \
3605 wxEVENT_HANDLER_CAST(wxPaletteChangedEventFunction, func)
3606 #define wxQueryNewPaletteEventHandler(func) \
3607 wxEVENT_HANDLER_CAST(wxQueryNewPaletteEventFunction, func)
3608 #define wxWindowCreateEventHandler(func) \
3609 wxEVENT_HANDLER_CAST(wxWindowCreateEventFunction, func)
3610 #define wxWindowDestroyEventHandler(func) \
3611 wxEVENT_HANDLER_CAST(wxWindowDestroyEventFunction, func)
3612 #define wxSetCursorEventHandler(func) \
3613 wxEVENT_HANDLER_CAST(wxSetCursorEventFunction, func)
3614 #define wxNotifyEventHandler(func) \
3615 wxEVENT_HANDLER_CAST(wxNotifyEventFunction, func)
3616 #define wxHelpEventHandler(func) \
3617 wxEVENT_HANDLER_CAST(wxHelpEventFunction, func)
3618 #define wxContextMenuEventHandler(func) \
3619 wxEVENT_HANDLER_CAST(wxContextMenuEventFunction, func)
3620 #define wxMouseCaptureChangedEventHandler(func) \
3621 wxEVENT_HANDLER_CAST(wxMouseCaptureChangedEventFunction, func)
3622 #define wxMouseCaptureLostEventHandler(func) \
3623 wxEVENT_HANDLER_CAST(wxMouseCaptureLostEventFunction, func)
3624 #define wxClipboardTextEventHandler(func) \
3625 wxEVENT_HANDLER_CAST(wxClipboardTextEventFunction, func)
3629 // N.B. In GNU-WIN32, you *have* to take the address of a member function
3630 // (use &) or the compiler crashes...
3632 #define wxDECLARE_EVENT_TABLE() \
3634 static const wxEventTableEntry sm_eventTableEntries[]; \
3636 static const wxEventTable sm_eventTable; \
3637 virtual const wxEventTable* GetEventTable() const; \
3638 static wxEventHashTable sm_eventHashTable; \
3639 virtual wxEventHashTable& GetEventHashTable() const
3641 // N.B.: when building DLL with Borland C++ 5.5 compiler, you must initialize
3642 // sm_eventTable before using it in GetEventTable() or the compiler gives
3643 // E2233 (see http://groups.google.com/groups?selm=397dcc8a%241_2%40dnews)
3645 #define wxBEGIN_EVENT_TABLE(theClass, baseClass) \
3646 const wxEventTable theClass::sm_eventTable = \
3647 { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] }; \
3648 const wxEventTable *theClass::GetEventTable() const \
3649 { return &theClass::sm_eventTable; } \
3650 wxEventHashTable theClass::sm_eventHashTable(theClass::sm_eventTable); \
3651 wxEventHashTable &theClass::GetEventHashTable() const \
3652 { return theClass::sm_eventHashTable; } \
3653 const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
3655 #define wxBEGIN_EVENT_TABLE_TEMPLATE1(theClass, baseClass, T1) \
3656 template<typename T1> \
3657 const wxEventTable theClass<T1>::sm_eventTable = \
3658 { &baseClass::sm_eventTable, &theClass<T1>::sm_eventTableEntries[0] }; \
3659 template<typename T1> \
3660 const wxEventTable *theClass<T1>::GetEventTable() const \
3661 { return &theClass<T1>::sm_eventTable; } \
3662 template<typename T1> \
3663 wxEventHashTable theClass<T1>::sm_eventHashTable(theClass<T1>::sm_eventTable); \
3664 template<typename T1> \
3665 wxEventHashTable &theClass<T1>::GetEventHashTable() const \
3666 { return theClass<T1>::sm_eventHashTable; } \
3667 template<typename T1> \
3668 const wxEventTableEntry theClass<T1>::sm_eventTableEntries[] = { \
3670 #define wxBEGIN_EVENT_TABLE_TEMPLATE2(theClass, baseClass, T1, T2) \
3671 template<typename T1, typename T2> \
3672 const wxEventTable theClass<T1, T2>::sm_eventTable = \
3673 { &baseClass::sm_eventTable, &theClass<T1, T2>::sm_eventTableEntries[0] }; \
3674 template<typename T1, typename T2> \
3675 const wxEventTable *theClass<T1, T2>::GetEventTable() const \
3676 { return &theClass<T1, T2>::sm_eventTable; } \
3677 template<typename T1, typename T2> \
3678 wxEventHashTable theClass<T1, T2>::sm_eventHashTable(theClass<T1, T2>::sm_eventTable); \
3679 template<typename T1, typename T2> \
3680 wxEventHashTable &theClass<T1, T2>::GetEventHashTable() const \
3681 { return theClass<T1, T2>::sm_eventHashTable; } \
3682 template<typename T1, typename T2> \
3683 const wxEventTableEntry theClass<T1, T2>::sm_eventTableEntries[] = { \
3685 #define wxBEGIN_EVENT_TABLE_TEMPLATE3(theClass, baseClass, T1, T2, T3) \
3686 template<typename T1, typename T2, typename T3> \
3687 const wxEventTable theClass<T1, T2, T3>::sm_eventTable = \
3688 { &baseClass::sm_eventTable, &theClass<T1, T2, T3>::sm_eventTableEntries[0] }; \
3689 template<typename T1, typename T2, typename T3> \
3690 const wxEventTable *theClass<T1, T2, T3>::GetEventTable() const \
3691 { return &theClass<T1, T2, T3>::sm_eventTable; } \
3692 template<typename T1, typename T2, typename T3> \
3693 wxEventHashTable theClass<T1, T2, T3>::sm_eventHashTable(theClass<T1, T2, T3>::sm_eventTable); \
3694 template<typename T1, typename T2, typename T3> \
3695 wxEventHashTable &theClass<T1, T2, T3>::GetEventHashTable() const \
3696 { return theClass<T1, T2, T3>::sm_eventHashTable; } \
3697 template<typename T1, typename T2, typename T3> \
3698 const wxEventTableEntry theClass<T1, T2, T3>::sm_eventTableEntries[] = { \
3700 #define wxBEGIN_EVENT_TABLE_TEMPLATE4(theClass, baseClass, T1, T2, T3, T4) \
3701 template<typename T1, typename T2, typename T3, typename T4> \
3702 const wxEventTable theClass<T1, T2, T3, T4>::sm_eventTable = \
3703 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4>::sm_eventTableEntries[0] }; \
3704 template<typename T1, typename T2, typename T3, typename T4> \
3705 const wxEventTable *theClass<T1, T2, T3, T4>::GetEventTable() const \
3706 { return &theClass<T1, T2, T3, T4>::sm_eventTable; } \
3707 template<typename T1, typename T2, typename T3, typename T4> \
3708 wxEventHashTable theClass<T1, T2, T3, T4>::sm_eventHashTable(theClass<T1, T2, T3, T4>::sm_eventTable); \
3709 template<typename T1, typename T2, typename T3, typename T4> \
3710 wxEventHashTable &theClass<T1, T2, T3, T4>::GetEventHashTable() const \
3711 { return theClass<T1, T2, T3, T4>::sm_eventHashTable; } \
3712 template<typename T1, typename T2, typename T3, typename T4> \
3713 const wxEventTableEntry theClass<T1, T2, T3, T4>::sm_eventTableEntries[] = { \
3715 #define wxBEGIN_EVENT_TABLE_TEMPLATE5(theClass, baseClass, T1, T2, T3, T4, T5) \
3716 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3717 const wxEventTable theClass<T1, T2, T3, T4, T5>::sm_eventTable = \
3718 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[0] }; \
3719 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3720 const wxEventTable *theClass<T1, T2, T3, T4, T5>::GetEventTable() const \
3721 { return &theClass<T1, T2, T3, T4, T5>::sm_eventTable; } \
3722 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3723 wxEventHashTable theClass<T1, T2, T3, T4, T5>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5>::sm_eventTable); \
3724 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3725 wxEventHashTable &theClass<T1, T2, T3, T4, T5>::GetEventHashTable() const \
3726 { return theClass<T1, T2, T3, T4, T5>::sm_eventHashTable; } \
3727 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3728 const wxEventTableEntry theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[] = { \
3730 #define wxBEGIN_EVENT_TABLE_TEMPLATE7(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7) \
3731 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3732 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable = \
3733 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[0] }; \
3734 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3735 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventTable() const \
3736 { return &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable; } \
3737 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3738 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable); \
3739 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3740 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventHashTable() const \
3741 { return theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable; } \
3742 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3743 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[] = { \
3745 #define wxBEGIN_EVENT_TABLE_TEMPLATE8(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7, T8) \
3746 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3747 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable = \
3748 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[0] }; \
3749 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3750 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventTable() const \
3751 { return &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable; } \
3752 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3753 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable); \
3754 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3755 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventHashTable() const \
3756 { return theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable; } \
3757 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3758 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[] = { \
3760 #define wxEND_EVENT_TABLE() \
3761 wxDECLARE_EVENT_TABLE_TERMINATOR() };
3764 * Event table macros
3767 // helpers for writing shorter code below: declare an event macro taking 2, 1
3768 // or none ids (the missing ids default to wxID_ANY)
3771 // - evt one of wxEVT_XXX constants
3772 // - id1, id2 ids of the first/last id
3773 // - fn the function (should be cast to the right type)
3774 #define wx__DECLARE_EVT2(evt, id1, id2, fn) \
3775 wxDECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
3776 #define wx__DECLARE_EVT1(evt, id, fn) \
3777 wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
3778 #define wx__DECLARE_EVT0(evt, fn) \
3779 wx__DECLARE_EVT1(evt, wxID_ANY, fn)
3783 #define EVT_CUSTOM(event, winid, func) \
3784 wx__DECLARE_EVT1(event, winid, wxEventHandler(func))
3785 #define EVT_CUSTOM_RANGE(event, id1, id2, func) \
3786 wx__DECLARE_EVT2(event, id1, id2, wxEventHandler(func))
3789 #define EVT_COMMAND(winid, event, func) \
3790 wx__DECLARE_EVT1(event, winid, wxCommandEventHandler(func))
3792 #define EVT_COMMAND_RANGE(id1, id2, event, func) \
3793 wx__DECLARE_EVT2(event, id1, id2, wxCommandEventHandler(func))
3795 #define EVT_NOTIFY(event, winid, func) \
3796 wx__DECLARE_EVT1(event, winid, wxNotifyEventHandler(func))
3798 #define EVT_NOTIFY_RANGE(event, id1, id2, func) \
3799 wx__DECLARE_EVT2(event, id1, id2, wxNotifyEventHandler(func))
3802 #define EVT_SIZE(func) wx__DECLARE_EVT0(wxEVT_SIZE, wxSizeEventHandler(func))
3803 #define EVT_SIZING(func) wx__DECLARE_EVT0(wxEVT_SIZING, wxSizeEventHandler(func))
3804 #define EVT_MOVE(func) wx__DECLARE_EVT0(wxEVT_MOVE, wxMoveEventHandler(func))
3805 #define EVT_MOVING(func) wx__DECLARE_EVT0(wxEVT_MOVING, wxMoveEventHandler(func))
3806 #define EVT_MOVE_START(func) wx__DECLARE_EVT0(wxEVT_MOVE_START, wxMoveEventHandler(func))
3807 #define EVT_MOVE_END(func) wx__DECLARE_EVT0(wxEVT_MOVE_END, wxMoveEventHandler(func))
3808 #define EVT_CLOSE(func) wx__DECLARE_EVT0(wxEVT_CLOSE_WINDOW, wxCloseEventHandler(func))
3809 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3810 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3811 #define EVT_PAINT(func) wx__DECLARE_EVT0(wxEVT_PAINT, wxPaintEventHandler(func))
3812 #define EVT_NC_PAINT(func) wx__DECLARE_EVT0(wxEVT_NC_PAINT, wxNcPaintEventHandler(func))
3813 #define EVT_ERASE_BACKGROUND(func) wx__DECLARE_EVT0(wxEVT_ERASE_BACKGROUND, wxEraseEventHandler(func))
3814 #define EVT_CHAR(func) wx__DECLARE_EVT0(wxEVT_CHAR, wxCharEventHandler(func))
3815 #define EVT_KEY_DOWN(func) wx__DECLARE_EVT0(wxEVT_KEY_DOWN, wxKeyEventHandler(func))
3816 #define EVT_KEY_UP(func) wx__DECLARE_EVT0(wxEVT_KEY_UP, wxKeyEventHandler(func))
3818 #define EVT_HOTKEY(winid, func) wx__DECLARE_EVT1(wxEVT_HOTKEY, winid, wxCharEventHandler(func))
3820 #define EVT_CHAR_HOOK(func) wx__DECLARE_EVT0(wxEVT_CHAR_HOOK, wxCharEventHandler(func))
3821 #define EVT_MENU_OPEN(func) wx__DECLARE_EVT0(wxEVT_MENU_OPEN, wxMenuEventHandler(func))
3822 #define EVT_MENU_CLOSE(func) wx__DECLARE_EVT0(wxEVT_MENU_CLOSE, wxMenuEventHandler(func))
3823 #define EVT_MENU_HIGHLIGHT(winid, func) wx__DECLARE_EVT1(wxEVT_MENU_HIGHLIGHT, winid, wxMenuEventHandler(func))
3824 #define EVT_MENU_HIGHLIGHT_ALL(func) wx__DECLARE_EVT0(wxEVT_MENU_HIGHLIGHT, wxMenuEventHandler(func))
3825 #define EVT_SET_FOCUS(func) wx__DECLARE_EVT0(wxEVT_SET_FOCUS, wxFocusEventHandler(func))
3826 #define EVT_KILL_FOCUS(func) wx__DECLARE_EVT0(wxEVT_KILL_FOCUS, wxFocusEventHandler(func))
3827 #define EVT_CHILD_FOCUS(func) wx__DECLARE_EVT0(wxEVT_CHILD_FOCUS, wxChildFocusEventHandler(func))
3828 #define EVT_ACTIVATE(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE, wxActivateEventHandler(func))
3829 #define EVT_ACTIVATE_APP(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE_APP, wxActivateEventHandler(func))
3830 #define EVT_HIBERNATE(func) wx__DECLARE_EVT0(wxEVT_HIBERNATE, wxActivateEventHandler(func))
3831 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3832 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3833 #define EVT_DROP_FILES(func) wx__DECLARE_EVT0(wxEVT_DROP_FILES, wxDropFilesEventHandler(func))
3834 #define EVT_INIT_DIALOG(func) wx__DECLARE_EVT0(wxEVT_INIT_DIALOG, wxInitDialogEventHandler(func))
3835 #define EVT_SYS_COLOUR_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEventHandler(func))
3836 #define EVT_DISPLAY_CHANGED(func) wx__DECLARE_EVT0(wxEVT_DISPLAY_CHANGED, wxDisplayChangedEventHandler(func))
3837 #define EVT_SHOW(func) wx__DECLARE_EVT0(wxEVT_SHOW, wxShowEventHandler(func))
3838 #define EVT_MAXIMIZE(func) wx__DECLARE_EVT0(wxEVT_MAXIMIZE, wxMaximizeEventHandler(func))
3839 #define EVT_ICONIZE(func) wx__DECLARE_EVT0(wxEVT_ICONIZE, wxIconizeEventHandler(func))
3840 #define EVT_NAVIGATION_KEY(func) wx__DECLARE_EVT0(wxEVT_NAVIGATION_KEY, wxNavigationKeyEventHandler(func))
3841 #define EVT_PALETTE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_PALETTE_CHANGED, wxPaletteChangedEventHandler(func))
3842 #define EVT_QUERY_NEW_PALETTE(func) wx__DECLARE_EVT0(wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEventHandler(func))
3843 #define EVT_WINDOW_CREATE(func) wx__DECLARE_EVT0(wxEVT_CREATE, wxWindowCreateEventHandler(func))
3844 #define EVT_WINDOW_DESTROY(func) wx__DECLARE_EVT0(wxEVT_DESTROY, wxWindowDestroyEventHandler(func))
3845 #define EVT_SET_CURSOR(func) wx__DECLARE_EVT0(wxEVT_SET_CURSOR, wxSetCursorEventHandler(func))
3846 #define EVT_MOUSE_CAPTURE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEventHandler(func))
3847 #define EVT_MOUSE_CAPTURE_LOST(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEventHandler(func))
3850 #define EVT_LEFT_DOWN(func) wx__DECLARE_EVT0(wxEVT_LEFT_DOWN, wxMouseEventHandler(func))
3851 #define EVT_LEFT_UP(func) wx__DECLARE_EVT0(wxEVT_LEFT_UP, wxMouseEventHandler(func))
3852 #define EVT_MIDDLE_DOWN(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DOWN, wxMouseEventHandler(func))
3853 #define EVT_MIDDLE_UP(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_UP, wxMouseEventHandler(func))
3854 #define EVT_RIGHT_DOWN(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DOWN, wxMouseEventHandler(func))
3855 #define EVT_RIGHT_UP(func) wx__DECLARE_EVT0(wxEVT_RIGHT_UP, wxMouseEventHandler(func))
3856 #define EVT_MOTION(func) wx__DECLARE_EVT0(wxEVT_MOTION, wxMouseEventHandler(func))
3857 #define EVT_LEFT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_LEFT_DCLICK, wxMouseEventHandler(func))
3858 #define EVT_MIDDLE_DCLICK(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DCLICK, wxMouseEventHandler(func))
3859 #define EVT_RIGHT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DCLICK, wxMouseEventHandler(func))
3860 #define EVT_LEAVE_WINDOW(func) wx__DECLARE_EVT0(wxEVT_LEAVE_WINDOW, wxMouseEventHandler(func))
3861 #define EVT_ENTER_WINDOW(func) wx__DECLARE_EVT0(wxEVT_ENTER_WINDOW, wxMouseEventHandler(func))
3862 #define EVT_MOUSEWHEEL(func) wx__DECLARE_EVT0(wxEVT_MOUSEWHEEL, wxMouseEventHandler(func))
3863 #define EVT_MOUSE_AUX1_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX1_DOWN, wxMouseEventHandler(func))
3864 #define EVT_MOUSE_AUX1_UP(func) wx__DECLARE_EVT0(wxEVT_AUX1_UP, wxMouseEventHandler(func))
3865 #define EVT_MOUSE_AUX1_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX1_DCLICK, wxMouseEventHandler(func))
3866 #define EVT_MOUSE_AUX2_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX2_DOWN, wxMouseEventHandler(func))
3867 #define EVT_MOUSE_AUX2_UP(func) wx__DECLARE_EVT0(wxEVT_AUX2_UP, wxMouseEventHandler(func))
3868 #define EVT_MOUSE_AUX2_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX2_DCLICK, wxMouseEventHandler(func))
3871 #define EVT_MOUSE_EVENTS(func) \
3872 EVT_LEFT_DOWN(func) \
3874 EVT_LEFT_DCLICK(func) \
3875 EVT_MIDDLE_DOWN(func) \
3876 EVT_MIDDLE_UP(func) \
3877 EVT_MIDDLE_DCLICK(func) \
3878 EVT_RIGHT_DOWN(func) \
3879 EVT_RIGHT_UP(func) \
3880 EVT_RIGHT_DCLICK(func) \
3881 EVT_MOUSE_AUX1_DOWN(func) \
3882 EVT_MOUSE_AUX1_UP(func) \
3883 EVT_MOUSE_AUX1_DCLICK(func) \
3884 EVT_MOUSE_AUX2_DOWN(func) \
3885 EVT_MOUSE_AUX2_UP(func) \
3886 EVT_MOUSE_AUX2_DCLICK(func) \
3888 EVT_LEAVE_WINDOW(func) \
3889 EVT_ENTER_WINDOW(func) \
3890 EVT_MOUSEWHEEL(func)
3892 // Scrolling from wxWindow (sent to wxScrolledWindow)
3893 #define EVT_SCROLLWIN_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_TOP, wxScrollWinEventHandler(func))
3894 #define EVT_SCROLLWIN_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEventHandler(func))
3895 #define EVT_SCROLLWIN_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEUP, wxScrollWinEventHandler(func))
3896 #define EVT_SCROLLWIN_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEventHandler(func))
3897 #define EVT_SCROLLWIN_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEventHandler(func))
3898 #define EVT_SCROLLWIN_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEventHandler(func))
3899 #define EVT_SCROLLWIN_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEventHandler(func))
3900 #define EVT_SCROLLWIN_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEventHandler(func))
3902 #define EVT_SCROLLWIN(func) \
3903 EVT_SCROLLWIN_TOP(func) \
3904 EVT_SCROLLWIN_BOTTOM(func) \
3905 EVT_SCROLLWIN_LINEUP(func) \
3906 EVT_SCROLLWIN_LINEDOWN(func) \
3907 EVT_SCROLLWIN_PAGEUP(func) \
3908 EVT_SCROLLWIN_PAGEDOWN(func) \
3909 EVT_SCROLLWIN_THUMBTRACK(func) \
3910 EVT_SCROLLWIN_THUMBRELEASE(func)
3912 // Scrolling from wxSlider and wxScrollBar
3913 #define EVT_SCROLL_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_TOP, wxScrollEventHandler(func))
3914 #define EVT_SCROLL_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLL_BOTTOM, wxScrollEventHandler(func))
3915 #define EVT_SCROLL_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEUP, wxScrollEventHandler(func))
3916 #define EVT_SCROLL_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEDOWN, wxScrollEventHandler(func))
3917 #define EVT_SCROLL_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEUP, wxScrollEventHandler(func))
3918 #define EVT_SCROLL_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler(func))
3919 #define EVT_SCROLL_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler(func))
3920 #define EVT_SCROLL_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBRELEASE, wxScrollEventHandler(func))
3921 #define EVT_SCROLL_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SCROLL_CHANGED, wxScrollEventHandler(func))
3923 #define EVT_SCROLL(func) \
3924 EVT_SCROLL_TOP(func) \
3925 EVT_SCROLL_BOTTOM(func) \
3926 EVT_SCROLL_LINEUP(func) \
3927 EVT_SCROLL_LINEDOWN(func) \
3928 EVT_SCROLL_PAGEUP(func) \
3929 EVT_SCROLL_PAGEDOWN(func) \
3930 EVT_SCROLL_THUMBTRACK(func) \
3931 EVT_SCROLL_THUMBRELEASE(func) \
3932 EVT_SCROLL_CHANGED(func)
3934 // Scrolling from wxSlider and wxScrollBar, with an id
3935 #define EVT_COMMAND_SCROLL_TOP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_TOP, winid, wxScrollEventHandler(func))
3936 #define EVT_COMMAND_SCROLL_BOTTOM(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_BOTTOM, winid, wxScrollEventHandler(func))
3937 #define EVT_COMMAND_SCROLL_LINEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEUP, winid, wxScrollEventHandler(func))
3938 #define EVT_COMMAND_SCROLL_LINEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEDOWN, winid, wxScrollEventHandler(func))
3939 #define EVT_COMMAND_SCROLL_PAGEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEUP, winid, wxScrollEventHandler(func))
3940 #define EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEDOWN, winid, wxScrollEventHandler(func))
3941 #define EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBTRACK, winid, wxScrollEventHandler(func))
3942 #define EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBRELEASE, winid, wxScrollEventHandler(func))
3943 #define EVT_COMMAND_SCROLL_CHANGED(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_CHANGED, winid, wxScrollEventHandler(func))
3945 #define EVT_COMMAND_SCROLL(winid, func) \
3946 EVT_COMMAND_SCROLL_TOP(winid, func) \
3947 EVT_COMMAND_SCROLL_BOTTOM(winid, func) \
3948 EVT_COMMAND_SCROLL_LINEUP(winid, func) \
3949 EVT_COMMAND_SCROLL_LINEDOWN(winid, func) \
3950 EVT_COMMAND_SCROLL_PAGEUP(winid, func) \
3951 EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) \
3952 EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) \
3953 EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) \
3954 EVT_COMMAND_SCROLL_CHANGED(winid, func)
3956 #if WXWIN_COMPATIBILITY_2_6
3957 // compatibility macros for the old name, deprecated in 2.8
3958 #define wxEVT_SCROLL_ENDSCROLL wxEVT_SCROLL_CHANGED
3959 #define EVT_COMMAND_SCROLL_ENDSCROLL EVT_COMMAND_SCROLL_CHANGED
3960 #define EVT_SCROLL_ENDSCROLL EVT_SCROLL_CHANGED
3961 #endif // WXWIN_COMPATIBILITY_2_6
3963 // Convenience macros for commonly-used commands
3964 #define EVT_CHECKBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKBOX_CLICKED, winid, wxCommandEventHandler(func))
3965 #define EVT_CHOICE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHOICE_SELECTED, winid, wxCommandEventHandler(func))
3966 #define EVT_LISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_SELECTED, winid, wxCommandEventHandler(func))
3967 #define EVT_LISTBOX_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, winid, wxCommandEventHandler(func))
3968 #define EVT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_MENU_SELECTED, winid, wxCommandEventHandler(func))
3969 #define EVT_MENU_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_MENU_SELECTED, id1, id2, wxCommandEventHandler(func))
3970 #if defined(__SMARTPHONE__)
3971 # define EVT_BUTTON(winid, func) EVT_MENU(winid, func)
3973 # define EVT_BUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_BUTTON_CLICKED, winid, wxCommandEventHandler(func))
3975 #define EVT_SLIDER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SLIDER_UPDATED, winid, wxCommandEventHandler(func))
3976 #define EVT_RADIOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBOX_SELECTED, winid, wxCommandEventHandler(func))
3977 #define EVT_RADIOBUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBUTTON_SELECTED, winid, wxCommandEventHandler(func))
3978 // EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events
3979 #define EVT_SCROLLBAR(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SCROLLBAR_UPDATED, winid, wxCommandEventHandler(func))
3980 #define EVT_VLBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_VLBOX_SELECTED, winid, wxCommandEventHandler(func))
3981 #define EVT_COMBOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_SELECTED, winid, wxCommandEventHandler(func))
3982 #define EVT_TOOL(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_CLICKED, winid, wxCommandEventHandler(func))
3983 #define EVT_TOOL_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, winid, wxCommandEventHandler(func))
3984 #define EVT_TOOL_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_CLICKED, id1, id2, wxCommandEventHandler(func))
3985 #define EVT_TOOL_RCLICKED(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_RCLICKED, winid, wxCommandEventHandler(func))
3986 #define EVT_TOOL_RCLICKED_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, wxCommandEventHandler(func))
3987 #define EVT_TOOL_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_ENTER, winid, wxCommandEventHandler(func))
3988 #define EVT_CHECKLISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, winid, wxCommandEventHandler(func))
3989 #define EVT_COMBOBOX_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_DROPDOWN, winid, wxCommandEventHandler(func))
3990 #define EVT_COMBOBOX_CLOSEUP(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_CLOSEUP, winid, wxCommandEventHandler(func))
3992 // Generic command events
3993 #define EVT_COMMAND_LEFT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_CLICK, winid, wxCommandEventHandler(func))
3994 #define EVT_COMMAND_LEFT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_DCLICK, winid, wxCommandEventHandler(func))
3995 #define EVT_COMMAND_RIGHT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_CLICK, winid, wxCommandEventHandler(func))
3996 #define EVT_COMMAND_RIGHT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_DCLICK, winid, wxCommandEventHandler(func))
3997 #define EVT_COMMAND_SET_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SET_FOCUS, winid, wxCommandEventHandler(func))
3998 #define EVT_COMMAND_KILL_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_KILL_FOCUS, winid, wxCommandEventHandler(func))
3999 #define EVT_COMMAND_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_ENTER, winid, wxCommandEventHandler(func))
4003 #define EVT_JOY_BUTTON_DOWN(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_DOWN, wxJoystickEventHandler(func))
4004 #define EVT_JOY_BUTTON_UP(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_UP, wxJoystickEventHandler(func))
4005 #define EVT_JOY_MOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_MOVE, wxJoystickEventHandler(func))
4006 #define EVT_JOY_ZMOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_ZMOVE, wxJoystickEventHandler(func))
4008 // All joystick events
4009 #define EVT_JOYSTICK_EVENTS(func) \
4010 EVT_JOY_BUTTON_DOWN(func) \
4011 EVT_JOY_BUTTON_UP(func) \
4012 EVT_JOY_MOVE(func) \
4016 #define EVT_IDLE(func) wx__DECLARE_EVT0(wxEVT_IDLE, wxIdleEventHandler(func))
4019 #define EVT_UPDATE_UI(winid, func) wx__DECLARE_EVT1(wxEVT_UPDATE_UI, winid, wxUpdateUIEventHandler(func))
4020 #define EVT_UPDATE_UI_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_UPDATE_UI, id1, id2, wxUpdateUIEventHandler(func))
4023 #define EVT_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_HELP, winid, wxHelpEventHandler(func))
4024 #define EVT_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_HELP, id1, id2, wxHelpEventHandler(func))
4025 #define EVT_DETAILED_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_DETAILED_HELP, winid, wxHelpEventHandler(func))
4026 #define EVT_DETAILED_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_DETAILED_HELP, id1, id2, wxHelpEventHandler(func))
4028 // Context Menu Events
4029 #define EVT_CONTEXT_MENU(func) wx__DECLARE_EVT0(wxEVT_CONTEXT_MENU, wxContextMenuEventHandler(func))
4030 #define EVT_COMMAND_CONTEXT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_CONTEXT_MENU, winid, wxContextMenuEventHandler(func))
4032 // Clipboard text Events
4033 #define EVT_TEXT_CUT(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_CUT, winid, wxClipboardTextEventHandler(func))
4034 #define EVT_TEXT_COPY(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_COPY, winid, wxClipboardTextEventHandler(func))
4035 #define EVT_TEXT_PASTE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_PASTE, winid, wxClipboardTextEventHandler(func))
4038 #define EVT_THREAD(id, func) wx__DECLARE_EVT1(wxEVT_THREAD, id, wxThreadEventHandler(func))
4039 // alias for backward compatibility with 2.9.0:
4040 #define wxEVT_COMMAND_THREAD wxEVT_THREAD
4042 // ----------------------------------------------------------------------------
4044 // ----------------------------------------------------------------------------
4046 // This is an ugly hack to allow the use of Bind() instead of Connect() inside
4047 // the library code if the library was built with support for it, here is how
4050 // class SomeEventHandlingClass : wxBIND_OR_CONNECT_HACK_BASE_CLASS
4051 // public SomeBaseClass
4054 // SomeEventHandlingClass(wxWindow *win)
4056 // // connect to the event for the given window
4057 // wxBIND_OR_CONNECT_HACK(win, wxEVT_SOMETHING, wxSomeEventHandler,
4058 // SomeEventHandlingClass::OnSomeEvent, this);
4062 // void OnSomeEvent(wxSomeEvent&) { ... }
4065 // This is *not* meant to be used by library users, it is only defined here
4066 // (and not in a private header) because the base class must be visible from
4067 // other public headers, please do NOT use this in your code, it will be
4068 // removed from future wx versions without warning.
4069 #ifdef wxHAS_EVENT_BIND
4070 #define wxBIND_OR_CONNECT_HACK_BASE_CLASS
4071 #define wxBIND_OR_CONNECT_HACK_ONLY_BASE_CLASS
4072 #define wxBIND_OR_CONNECT_HACK(win, evt, handler, func, obj) \
4073 win->Bind(evt, &func, obj)
4074 #else // wxHAS_EVENT_BIND
4075 #define wxBIND_OR_CONNECT_HACK_BASE_CLASS public wxEvtHandler,
4076 #define wxBIND_OR_CONNECT_HACK_ONLY_BASE_CLASS : public wxEvtHandler
4077 #define wxBIND_OR_CONNECT_HACK(win, evt, handler, func, obj) \
4078 win->Connect(evt, handler(func), NULL, obj)
4079 #endif // wxHAS_EVENT_BIND
4083 // Find a window with the focus, that is also a descendant of the given window.
4084 // This is used to determine the window to initially send commands to.
4085 WXDLLIMPEXP_CORE wxWindow
* wxFindFocusDescendant(wxWindow
* ancestor
);
4090 // ----------------------------------------------------------------------------
4091 // Compatibility macro aliases
4092 // ----------------------------------------------------------------------------
4094 // deprecated variants _not_ requiring a semicolon after them and without wx prefix
4095 // (note that also some wx-prefixed macro do _not_ require a semicolon because
4096 // it's not always possible to force the compire to require it)
4098 #define DECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj) \
4099 wxDECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj)
4100 #define DECLARE_EVENT_TABLE_TERMINATOR() wxDECLARE_EVENT_TABLE_TERMINATOR()
4101 #define DECLARE_EVENT_TABLE() wxDECLARE_EVENT_TABLE();
4102 #define BEGIN_EVENT_TABLE(a,b) wxBEGIN_EVENT_TABLE(a,b)
4103 #define BEGIN_EVENT_TABLE_TEMPLATE1(a,b,c) wxBEGIN_EVENT_TABLE_TEMPLATE1(a,b,c)
4104 #define BEGIN_EVENT_TABLE_TEMPLATE2(a,b,c,d) wxBEGIN_EVENT_TABLE_TEMPLATE1(a,b,c,d)
4105 #define BEGIN_EVENT_TABLE_TEMPLATE3(a,b,c,d,e) wxBEGIN_EVENT_TABLE_TEMPLATE1(a,b,c,d,e)
4106 #define BEGIN_EVENT_TABLE_TEMPLATE4(a,b,c,d,e,f) wxBEGIN_EVENT_TABLE_TEMPLATE1(a,b,c,d,e,f)
4107 #define BEGIN_EVENT_TABLE_TEMPLATE5(a,b,c,d,e,f,g) wxBEGIN_EVENT_TABLE_TEMPLATE1(a,b,c,d,e,f,g)
4108 #define BEGIN_EVENT_TABLE_TEMPLATE6(a,b,c,d,e,f,g,h) wxBEGIN_EVENT_TABLE_TEMPLATE1(a,b,c,d,e,f,g,h)
4109 #define END_EVENT_TABLE() wxEND_EVENT_TABLE()
4111 // other obsolete event declaration/definition macros; we don't need them any longer
4112 // but we keep them for compatibility as it doesn't cost us anything anyhow
4113 #define BEGIN_DECLARE_EVENT_TYPES()
4114 #define END_DECLARE_EVENT_TYPES()
4115 #define DECLARE_EXPORTED_EVENT_TYPE(expdecl, name, value) \
4116 extern expdecl const wxEventType name;
4117 #define DECLARE_EVENT_TYPE(name, value) \
4118 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_CORE, name, value)
4119 #define DECLARE_LOCAL_EVENT_TYPE(name, value) \
4120 DECLARE_EXPORTED_EVENT_TYPE(wxEMPTY_PARAMETER_VALUE, name, value)
4121 #define DEFINE_EVENT_TYPE(name) const wxEventType name = wxNewEventType();
4122 #define DEFINE_LOCAL_EVENT_TYPE(name) DEFINE_EVENT_TYPE(name)
4124 #endif // _WX_EVENT_H_