1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Event classes
4 // Author: Julian Smart
8 // Copyright: (c) wxWidgets team
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
17 #include "wx/object.h"
18 #include "wx/clntdata.h"
21 #include "wx/gdicmn.h"
22 #include "wx/cursor.h"
23 #include "wx/mousestate.h"
26 #include "wx/dynarray.h"
27 #include "wx/thread.h"
28 #include "wx/tracker.h"
29 #include "wx/typeinfo.h"
32 #ifdef wxHAS_EVENT_BIND
33 #include "wx/meta/convertible.h"
36 // ----------------------------------------------------------------------------
37 // forward declarations
38 // ----------------------------------------------------------------------------
40 class WXDLLIMPEXP_FWD_BASE wxList
;
41 class WXDLLIMPEXP_FWD_BASE wxEvent
;
43 class WXDLLIMPEXP_FWD_CORE wxDC
;
44 class WXDLLIMPEXP_FWD_CORE wxMenu
;
45 class WXDLLIMPEXP_FWD_CORE wxWindow
;
46 class WXDLLIMPEXP_FWD_CORE wxWindowBase
;
49 // We operate with pointer to members of wxEvtHandler (such functions are used
50 // as event handlers in the event tables or as arguments to Connect()) but by
51 // default MSVC uses a restricted (but more efficient) representation of
52 // pointers to members which can't deal with multiple base classes. To avoid
53 // mysterious (as the compiler is not good enough to detect this and give a
54 // sensible error message) errors in the user code as soon as it defines
55 // classes inheriting from both wxEvtHandler (possibly indirectly, e.g. via
56 // wxWindow) and something else (including our own wxTrackable but not limited
57 // to it), we use the special MSVC keyword telling the compiler to use a more
58 // general pointer to member representation for the classes inheriting from
61 #define wxMSVC_FWD_MULTIPLE_BASES __multiple_inheritance
63 #define wxMSVC_FWD_MULTIPLE_BASES
66 class WXDLLIMPEXP_FWD_BASE wxMSVC_FWD_MULTIPLE_BASES wxEvtHandler
;
67 class wxEventConnectionRef
;
69 // ----------------------------------------------------------------------------
71 // ----------------------------------------------------------------------------
73 typedef int wxEventType
;
75 #define wxEVT_ANY ((wxEventType)-1)
77 // this is used to make the event table entry type safe, so that for an event
78 // handler only a function with proper parameter list can be given. See also
79 // the wxEVENT_HANDLER_CAST-macro.
80 #define wxStaticCastEvent(type, val) static_cast<type>(val)
82 #define wxDECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj) \
83 wxEventTableEntry(type, winid, idLast, wxNewEventTableFunctor(type, fn), obj)
85 #define wxDECLARE_EVENT_TABLE_TERMINATOR() \
86 wxEventTableEntry(wxEVT_NULL, 0, 0, 0, 0)
88 // generate a new unique event type
89 extern WXDLLIMPEXP_BASE wxEventType
wxNewEventType();
91 // define macros to create new event types:
92 #ifdef wxHAS_EVENT_BIND
93 // events are represented by an instance of wxEventTypeTag and the
94 // corresponding type must be specified for type-safety checks
96 // define a new custom event type, can be used alone or after event
97 // declaration in the header using one of the macros below
98 #define wxDEFINE_EVENT( name, type ) \
99 const wxEventTypeTag< type > name( wxNewEventType() )
101 // the general version allowing exporting the event type from DLL, used by
103 #define wxDECLARE_EXPORTED_EVENT( expdecl, name, type ) \
104 extern const expdecl wxEventTypeTag< type > name
106 // this is the version which will normally be used in the user code
107 #define wxDECLARE_EVENT( name, type ) \
108 wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type )
111 // these macros are only used internally for backwards compatibility and
112 // allow to define an alias for an existing event type (this is used by
114 #define wxDEFINE_EVENT_ALIAS( name, type, value ) \
115 const wxEventTypeTag< type > name( value )
117 #define wxDECLARE_EXPORTED_EVENT_ALIAS( expdecl, name, type ) \
118 extern const expdecl wxEventTypeTag< type > name
119 #else // !wxHAS_EVENT_BIND
120 // the macros are the same ones as above but defined differently as we only
121 // use the integer event type values to identify events in this case
123 #define wxDEFINE_EVENT( name, type ) \
124 const wxEventType name( wxNewEventType() )
126 #define wxDECLARE_EXPORTED_EVENT( expdecl, name, type ) \
127 extern const expdecl wxEventType name
128 #define wxDECLARE_EVENT( name, type ) \
129 wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type )
131 #define wxDEFINE_EVENT_ALIAS( name, type, value ) \
132 const wxEventType name = value
133 #define wxDECLARE_EXPORTED_EVENT_ALIAS( expdecl, name, type ) \
134 extern const expdecl wxEventType name
135 #endif // wxHAS_EVENT_BIND/!wxHAS_EVENT_BIND
137 // Try to cast the given event handler to the correct handler type:
139 #define wxEVENT_HANDLER_CAST( functype, func ) \
140 ( wxObjectEventFunction )( wxEventFunction )wxStaticCastEvent( functype, &func )
143 #ifdef wxHAS_EVENT_BIND
145 // The tag is a type associated to the event type (which is an integer itself,
146 // in spite of its name) value. It exists in order to be used as a template
147 // parameter and provide a mapping between the event type values and their
148 // corresponding wxEvent-derived classes.
149 template <typename T
>
153 // The class of wxEvent-derived class carried by the events of this type.
154 typedef T EventClass
;
156 wxEventTypeTag(wxEventType type
) { m_type
= type
; }
158 // Return a wxEventType reference for the initialization of the static
159 // event tables. See wxEventTableEntry::m_eventType for a more thorough
161 operator const wxEventType
&() const { return m_type
; }
167 #endif // wxHAS_EVENT_BIND
169 // These are needed for the functor definitions
170 typedef void (wxEvtHandler::*wxEventFunction
)(wxEvent
&);
172 // We had some trouble (specifically with eVC for ARM WinCE build) with using
173 // wxEventFunction in the past so we had introduced wxObjectEventFunction which
174 // used to be a typedef for a member of wxObject and not wxEvtHandler to work
175 // around this but as eVC is not really supported any longer we now only keep
176 // this for backwards compatibility and, despite its name, this is a typedef
177 // for wxEvtHandler member now -- but if we have the same problem with another
178 // compiler we can restore its old definition for it.
179 typedef wxEventFunction wxObjectEventFunction
;
181 // The event functor which is stored in the static and dynamic event tables:
182 class WXDLLIMPEXP_BASE wxEventFunctor
185 virtual ~wxEventFunctor();
187 // Invoke the actual event handler:
188 virtual void operator()(wxEvtHandler
*, wxEvent
&) = 0;
190 // this function tests whether this functor is matched, for the purpose of
191 // finding it in an event table in Unbind(), by the given functor:
192 virtual bool IsMatching(const wxEventFunctor
& functor
) const = 0;
194 // If the functor holds an wxEvtHandler, then get access to it and track
195 // its lifetime with wxEventConnectionRef:
196 virtual wxEvtHandler
*GetEvtHandler() const
199 // This is only used to maintain backward compatibility in
200 // wxAppConsoleBase::CallEventHandler and ensures that an overwritten
201 // wxAppConsoleBase::HandleEvent is still called for functors which hold an
203 virtual wxEventFunction
GetEvtMethod() const
207 WX_DECLARE_ABSTRACT_TYPEINFO(wxEventFunctor
)
210 // A plain method functor for the untyped legacy event types:
211 class WXDLLIMPEXP_BASE wxObjectEventFunctor
: public wxEventFunctor
214 wxObjectEventFunctor(wxObjectEventFunction method
, wxEvtHandler
*handler
)
215 : m_handler( handler
), m_method( method
)
218 virtual void operator()(wxEvtHandler
*handler
, wxEvent
& event
);
220 virtual bool IsMatching(const wxEventFunctor
& functor
) const
222 if ( wxTypeId(functor
) == wxTypeId(*this) )
224 const wxObjectEventFunctor
&other
=
225 static_cast< const wxObjectEventFunctor
& >( functor
);
227 // FIXME-VC6: amazing but true: replacing "method == NULL" here
228 // with "!method" makes VC6 crash with an ICE in DLL build (only!)
230 return ( m_method
== other
.m_method
|| other
.m_method
== NULL
) &&
231 ( m_handler
== other
.m_handler
|| other
.m_handler
== NULL
);
237 virtual wxEvtHandler
*GetEvtHandler() const
238 { return m_handler
; }
240 virtual wxEventFunction
GetEvtMethod() const
244 wxEvtHandler
*m_handler
;
245 wxEventFunction m_method
;
247 // Provide a dummy default ctor for type info purposes
248 wxObjectEventFunctor() { }
250 WX_DECLARE_TYPEINFO_INLINE(wxObjectEventFunctor
)
253 // Create a functor for the legacy events: used by Connect()
254 inline wxObjectEventFunctor
*
255 wxNewEventFunctor(const wxEventType
& WXUNUSED(evtType
),
256 wxObjectEventFunction method
,
257 wxEvtHandler
*handler
)
259 return new wxObjectEventFunctor(method
, handler
);
262 // This version is used by wxDECLARE_EVENT_TABLE_ENTRY()
263 inline wxObjectEventFunctor
*
264 wxNewEventTableFunctor(const wxEventType
& WXUNUSED(evtType
),
265 wxObjectEventFunction method
)
267 return new wxObjectEventFunctor(method
, NULL
);
270 inline wxObjectEventFunctor
271 wxMakeEventFunctor(const wxEventType
& WXUNUSED(evtType
),
272 wxObjectEventFunction method
,
273 wxEvtHandler
*handler
)
275 return wxObjectEventFunctor(method
, handler
);
278 #ifdef wxHAS_EVENT_BIND
283 // helper template defining nested "type" typedef as the event class
284 // corresponding to the given event type
285 template <typename T
> struct EventClassOf
;
287 // the typed events provide the information about the class of the events they
289 template <typename T
>
290 struct EventClassOf
< wxEventTypeTag
<T
> >
292 typedef typename wxEventTypeTag
<T
>::EventClass type
;
295 // for the old untyped events we don't have information about the exact event
296 // class carried by them
298 struct EventClassOf
<wxEventType
>
300 typedef wxEvent type
;
304 // helper class defining operations different for method functors using an
305 // object of wxEvtHandler-derived class as handler and the others
306 template <typename T
, typename A
, bool> struct HandlerImpl
;
308 // specialization for handlers deriving from wxEvtHandler
309 template <typename T
, typename A
>
310 struct HandlerImpl
<T
, A
, true>
312 static bool IsEvtHandler()
314 static T
*ConvertFromEvtHandler(wxEvtHandler
*p
)
315 { return static_cast<T
*>(p
); }
316 static wxEvtHandler
*ConvertToEvtHandler(T
*p
)
318 static wxEventFunction
ConvertToEvtMethod(void (T::*f
)(A
&))
319 { return static_cast<wxEventFunction
>(
320 reinterpret_cast<void (T::*)(wxEvent
&)>(f
)); }
323 // specialization for handlers not deriving from wxEvtHandler
324 template <typename T
, typename A
>
325 struct HandlerImpl
<T
, A
, false>
327 static bool IsEvtHandler()
329 static T
*ConvertFromEvtHandler(wxEvtHandler
*)
331 static wxEvtHandler
*ConvertToEvtHandler(T
*)
333 static wxEventFunction
ConvertToEvtMethod(void (T::*)(A
&))
337 } // namespace wxPrivate
339 // functor forwarding the event to a method of the given object
341 // notice that the object class may be different from the class in which the
342 // method is defined but it must be convertible to this class
344 // also, the type of the handler parameter doesn't need to be exactly the same
345 // as EventTag::EventClass but it must be its base class -- this is explicitly
346 // allowed to handle different events in the same handler taking wxEvent&, for
349 <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
350 class wxEventFunctorMethod
351 : public wxEventFunctor
,
352 private wxPrivate::HandlerImpl
356 wxConvertibleTo
<Class
, wxEvtHandler
>::value
!= 0
360 static void CheckHandlerArgument(EventArg
*) { }
363 // the event class associated with the given event tag
364 typedef typename
wxPrivate::EventClassOf
<EventTag
>::type EventClass
;
367 wxEventFunctorMethod(void (Class::*method
)(EventArg
&), EventHandler
*handler
)
368 : m_handler( handler
), m_method( method
)
370 wxASSERT_MSG( handler
|| this->IsEvtHandler(),
371 "handlers defined in non-wxEvtHandler-derived classes "
372 "must be connected with a valid sink object" );
374 // if you get an error here it means that the signature of the handler
375 // you're trying to use is not compatible with (i.e. is not the same as
376 // or a base class of) the real event class used for this event type
377 CheckHandlerArgument(static_cast<EventClass
*>(NULL
));
380 virtual void operator()(wxEvtHandler
*handler
, wxEvent
& event
)
382 Class
* realHandler
= m_handler
;
385 realHandler
= this->ConvertFromEvtHandler(handler
);
387 // this is not supposed to happen but check for it nevertheless
388 wxCHECK_RET( realHandler
, "invalid event handler" );
391 // the real (run-time) type of event is EventClass and we checked in
392 // the ctor that EventClass can be converted to EventArg, so this cast
394 (realHandler
->*m_method
)(static_cast<EventArg
&>(event
));
397 virtual bool IsMatching(const wxEventFunctor
& functor
) const
399 if ( wxTypeId(functor
) != wxTypeId(*this) )
402 typedef wxEventFunctorMethod
<EventTag
, Class
, EventArg
, EventHandler
>
405 // the cast is valid because wxTypeId()s matched above
406 const ThisFunctor
& other
= static_cast<const ThisFunctor
&>(functor
);
408 return (m_method
== other
.m_method
|| other
.m_method
== NULL
) &&
409 (m_handler
== other
.m_handler
|| other
.m_handler
== NULL
);
412 virtual wxEvtHandler
*GetEvtHandler() const
413 { return this->ConvertToEvtHandler(m_handler
); }
415 virtual wxEventFunction
GetEvtMethod() const
416 { return this->ConvertToEvtMethod(m_method
); }
419 EventHandler
*m_handler
;
420 void (Class::*m_method
)(EventArg
&);
422 // Provide a dummy default ctor for type info purposes
423 wxEventFunctorMethod() { }
425 typedef wxEventFunctorMethod
<EventTag
, Class
,
426 EventArg
, EventHandler
> thisClass
;
427 WX_DECLARE_TYPEINFO_INLINE(thisClass
)
431 // functor forwarding the event to function (function, static method)
432 template <typename EventTag
, typename EventArg
>
433 class wxEventFunctorFunction
: public wxEventFunctor
436 static void CheckHandlerArgument(EventArg
*) { }
439 // the event class associated with the given event tag
440 typedef typename
wxPrivate::EventClassOf
<EventTag
>::type EventClass
;
442 wxEventFunctorFunction( void ( *handler
)( EventArg
& ))
443 : m_handler( handler
)
445 // if you get an error here it means that the signature of the handler
446 // you're trying to use is not compatible with (i.e. is not the same as
447 // or a base class of) the real event class used for this event type
448 CheckHandlerArgument(static_cast<EventClass
*>(NULL
));
451 virtual void operator()(wxEvtHandler
*WXUNUSED(handler
), wxEvent
& event
)
453 // If you get an error here like "must use .* or ->* to call
454 // pointer-to-member function" then you probably tried to call
455 // Bind/Unbind with a method pointer but without a handler pointer or
456 // NULL as a handler e.g.:
457 // Unbind( wxEVT_XXX, &EventHandler::method );
459 // Unbind( wxEVT_XXX, &EventHandler::method, NULL )
460 m_handler(static_cast<EventArg
&>(event
));
463 virtual bool IsMatching(const wxEventFunctor
&functor
) const
465 if ( wxTypeId(functor
) != wxTypeId(*this) )
468 typedef wxEventFunctorFunction
<EventTag
, EventArg
> ThisFunctor
;
470 const ThisFunctor
& other
= static_cast<const ThisFunctor
&>( functor
);
472 return m_handler
== other
.m_handler
;
476 void (*m_handler
)(EventArg
&);
478 // Provide a dummy default ctor for type info purposes
479 wxEventFunctorFunction() { }
481 typedef wxEventFunctorFunction
<EventTag
, EventArg
> thisClass
;
482 WX_DECLARE_TYPEINFO_INLINE(thisClass
)
486 template <typename EventTag
, typename Functor
>
487 class wxEventFunctorFunctor
: public wxEventFunctor
490 typedef typename
EventTag::EventClass EventArg
;
492 wxEventFunctorFunctor(const Functor
& handler
)
493 : m_handler(handler
), m_handlerAddr(&handler
)
496 virtual void operator()(wxEvtHandler
*WXUNUSED(handler
), wxEvent
& event
)
498 // If you get an error here like "must use '.*' or '->*' to call
499 // pointer-to-member function" then you probably tried to call
500 // Bind/Unbind with a method pointer but without a handler pointer or
501 // NULL as a handler e.g.:
502 // Unbind( wxEVT_XXX, &EventHandler::method );
504 // Unbind( wxEVT_XXX, &EventHandler::method, NULL )
505 m_handler(static_cast<EventArg
&>(event
));
508 virtual bool IsMatching(const wxEventFunctor
&functor
) const
510 if ( wxTypeId(functor
) != wxTypeId(*this) )
513 typedef wxEventFunctorFunctor
<EventTag
, Functor
> FunctorThis
;
515 const FunctorThis
& other
= static_cast<const FunctorThis
&>(functor
);
517 // The only reliable/portable way to compare two functors is by
519 return m_handlerAddr
== other
.m_handlerAddr
;
523 // Store a copy of the functor to prevent using/calling an already
524 // destroyed instance:
527 // Use the address of the original functor for comparison in IsMatching:
528 const void *m_handlerAddr
;
530 // Provide a dummy default ctor for type info purposes
531 wxEventFunctorFunctor() { }
533 typedef wxEventFunctorFunctor
<EventTag
, Functor
> thisClass
;
534 WX_DECLARE_TYPEINFO_INLINE(thisClass
)
537 // Create functors for the templatized events, either allocated on the heap for
538 // wxNewXXX() variants (this is needed in wxEvtHandler::Bind<>() to store them
539 // in dynamic event table) or just by returning them as temporary objects (this
540 // is enough for Unbind<>() and we avoid unnecessary heap allocation like this).
543 // Create functors wrapping functions:
544 template <typename EventTag
, typename EventArg
>
545 inline wxEventFunctorFunction
<EventTag
, EventArg
> *
546 wxNewEventFunctor(const EventTag
&, void (*func
)(EventArg
&))
548 return new wxEventFunctorFunction
<EventTag
, EventArg
>(func
);
551 template <typename EventTag
, typename EventArg
>
552 inline wxEventFunctorFunction
<EventTag
, EventArg
>
553 wxMakeEventFunctor(const EventTag
&, void (*func
)(EventArg
&))
555 return wxEventFunctorFunction
<EventTag
, EventArg
>(func
);
558 // Create functors wrapping other functors:
559 template <typename EventTag
, typename Functor
>
560 inline wxEventFunctorFunctor
<EventTag
, Functor
> *
561 wxNewEventFunctor(const EventTag
&, const Functor
&func
)
563 return new wxEventFunctorFunctor
<EventTag
, Functor
>(func
);
566 template <typename EventTag
, typename Functor
>
567 inline wxEventFunctorFunctor
<EventTag
, Functor
>
568 wxMakeEventFunctor(const EventTag
&, const Functor
&func
)
570 return wxEventFunctorFunctor
<EventTag
, Functor
>(func
);
573 // Create functors wrapping methods:
575 <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
576 inline wxEventFunctorMethod
<EventTag
, Class
, EventArg
, EventHandler
> *
577 wxNewEventFunctor(const EventTag
&,
578 void (Class::*method
)(EventArg
&),
579 EventHandler
*handler
)
581 return new wxEventFunctorMethod
<EventTag
, Class
, EventArg
, EventHandler
>(
586 <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
587 inline wxEventFunctorMethod
<EventTag
, Class
, EventArg
, EventHandler
>
588 wxMakeEventFunctor(const EventTag
&,
589 void (Class::*method
)(EventArg
&),
590 EventHandler
*handler
)
592 return wxEventFunctorMethod
<EventTag
, Class
, EventArg
, EventHandler
>(
596 // Create an event functor for the event table via wxDECLARE_EVENT_TABLE_ENTRY:
597 // in this case we don't have the handler (as it's always the same as the
598 // object which generated the event) so we must use Class as its type
599 template <typename EventTag
, typename Class
, typename EventArg
>
600 inline wxEventFunctorMethod
<EventTag
, Class
, EventArg
, Class
> *
601 wxNewEventTableFunctor(const EventTag
&, void (Class::*method
)(EventArg
&))
603 return new wxEventFunctorMethod
<EventTag
, Class
, EventArg
, Class
>(
607 #endif // wxHAS_EVENT_BIND
610 // many, but not all, standard event types
612 // some generic events
613 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_NULL
;
614 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_FIRST
;
615 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_USER_FIRST
;
617 // Need events declared to do this
618 class WXDLLIMPEXP_FWD_CORE wxCommandEvent
;
619 class WXDLLIMPEXP_FWD_CORE wxThreadEvent
;
620 class WXDLLIMPEXP_FWD_CORE wxMouseEvent
;
621 class WXDLLIMPEXP_FWD_CORE wxFocusEvent
;
622 class WXDLLIMPEXP_FWD_CORE wxChildFocusEvent
;
623 class WXDLLIMPEXP_FWD_CORE wxKeyEvent
;
624 class WXDLLIMPEXP_FWD_CORE wxNavigationKeyEvent
;
625 class WXDLLIMPEXP_FWD_CORE wxSetCursorEvent
;
626 class WXDLLIMPEXP_FWD_CORE wxScrollEvent
;
627 class WXDLLIMPEXP_FWD_CORE wxSpinEvent
;
628 class WXDLLIMPEXP_FWD_CORE wxScrollWinEvent
;
629 class WXDLLIMPEXP_FWD_CORE wxSizeEvent
;
630 class WXDLLIMPEXP_FWD_CORE wxMoveEvent
;
631 class WXDLLIMPEXP_FWD_CORE wxCloseEvent
;
632 class WXDLLIMPEXP_FWD_CORE wxActivateEvent
;
633 class WXDLLIMPEXP_FWD_CORE wxWindowCreateEvent
;
634 class WXDLLIMPEXP_FWD_CORE wxWindowDestroyEvent
;
635 class WXDLLIMPEXP_FWD_CORE wxShowEvent
;
636 class WXDLLIMPEXP_FWD_CORE wxIconizeEvent
;
637 class WXDLLIMPEXP_FWD_CORE wxMaximizeEvent
;
638 class WXDLLIMPEXP_FWD_CORE wxMouseCaptureChangedEvent
;
639 class WXDLLIMPEXP_FWD_CORE wxMouseCaptureLostEvent
;
640 class WXDLLIMPEXP_FWD_CORE wxPaintEvent
;
641 class WXDLLIMPEXP_FWD_CORE wxEraseEvent
;
642 class WXDLLIMPEXP_FWD_CORE wxNcPaintEvent
;
643 class WXDLLIMPEXP_FWD_CORE wxMenuEvent
;
644 class WXDLLIMPEXP_FWD_CORE wxContextMenuEvent
;
645 class WXDLLIMPEXP_FWD_CORE wxSysColourChangedEvent
;
646 class WXDLLIMPEXP_FWD_CORE wxDisplayChangedEvent
;
647 class WXDLLIMPEXP_FWD_CORE wxQueryNewPaletteEvent
;
648 class WXDLLIMPEXP_FWD_CORE wxPaletteChangedEvent
;
649 class WXDLLIMPEXP_FWD_CORE wxJoystickEvent
;
650 class WXDLLIMPEXP_FWD_CORE wxDropFilesEvent
;
651 class WXDLLIMPEXP_FWD_CORE wxInitDialogEvent
;
652 class WXDLLIMPEXP_FWD_CORE wxIdleEvent
;
653 class WXDLLIMPEXP_FWD_CORE wxUpdateUIEvent
;
654 class WXDLLIMPEXP_FWD_CORE wxClipboardTextEvent
;
655 class WXDLLIMPEXP_FWD_CORE wxHelpEvent
;
659 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_BUTTON_CLICKED
, wxCommandEvent
);
660 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHECKBOX_CLICKED
, wxCommandEvent
);
661 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHOICE_SELECTED
, wxCommandEvent
);
662 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LISTBOX_SELECTED
, wxCommandEvent
);
663 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
, wxCommandEvent
);
664 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
, wxCommandEvent
);
665 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_MENU_SELECTED
, wxCommandEvent
);
666 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SLIDER_UPDATED
, wxCommandEvent
);
667 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RADIOBOX_SELECTED
, wxCommandEvent
);
668 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RADIOBUTTON_SELECTED
, wxCommandEvent
);
670 // wxEVT_COMMAND_SCROLLBAR_UPDATED is deprecated, use wxEVT_SCROLL... events
671 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SCROLLBAR_UPDATED
, wxCommandEvent
);
672 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_VLBOX_SELECTED
, wxCommandEvent
);
673 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_COMBOBOX_SELECTED
, wxCommandEvent
);
674 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_RCLICKED
, wxCommandEvent
);
675 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED
, wxCommandEvent
);
676 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_ENTER
, wxCommandEvent
);
677 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_COMBOBOX_DROPDOWN
, wxCommandEvent
);
678 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_COMBOBOX_CLOSEUP
, wxCommandEvent
);
681 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_THREAD
, wxThreadEvent
);
684 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_DOWN
, wxMouseEvent
);
685 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_UP
, wxMouseEvent
);
686 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_DOWN
, wxMouseEvent
);
687 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_UP
, wxMouseEvent
);
688 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_DOWN
, wxMouseEvent
);
689 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_UP
, wxMouseEvent
);
690 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOTION
, wxMouseEvent
);
691 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ENTER_WINDOW
, wxMouseEvent
);
692 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEAVE_WINDOW
, wxMouseEvent
);
693 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_DCLICK
, wxMouseEvent
);
694 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_DCLICK
, wxMouseEvent
);
695 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_DCLICK
, wxMouseEvent
);
696 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SET_FOCUS
, wxFocusEvent
);
697 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KILL_FOCUS
, wxFocusEvent
);
698 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHILD_FOCUS
, wxChildFocusEvent
);
699 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSEWHEEL
, wxMouseEvent
);
700 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_DOWN
, wxMouseEvent
);
701 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_UP
, wxMouseEvent
);
702 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_DCLICK
, wxMouseEvent
);
703 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_DOWN
, wxMouseEvent
);
704 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_UP
, wxMouseEvent
);
705 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_DCLICK
, wxMouseEvent
);
707 // Character input event type
708 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHAR
, wxKeyEvent
);
709 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHAR_HOOK
, wxKeyEvent
);
710 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_NAVIGATION_KEY
, wxNavigationKeyEvent
);
711 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KEY_DOWN
, wxKeyEvent
);
712 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KEY_UP
, wxKeyEvent
);
714 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HOTKEY
, wxKeyEvent
);
716 // This is a private event used by wxMSW code only and subject to change or
717 // disappear in the future. Don't use.
718 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AFTER_CHAR
, wxKeyEvent
);
721 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SET_CURSOR
, wxSetCursorEvent
);
723 // wxScrollBar and wxSlider event identifiers
724 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_TOP
, wxScrollEvent
);
725 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_BOTTOM
, wxScrollEvent
);
726 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_LINEUP
, wxScrollEvent
);
727 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_LINEDOWN
, wxScrollEvent
);
728 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_PAGEUP
, wxScrollEvent
);
729 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_PAGEDOWN
, wxScrollEvent
);
730 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_THUMBTRACK
, wxScrollEvent
);
731 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_THUMBRELEASE
, wxScrollEvent
);
732 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_CHANGED
, wxScrollEvent
);
734 // Due to a bug in older wx versions, wxSpinEvents were being sent with type of
735 // wxEVT_SCROLL_LINEUP, wxEVT_SCROLL_LINEDOWN and wxEVT_SCROLL_THUMBTRACK. But
736 // with the type-safe events in place, these event types are associated with
737 // wxScrollEvent. To allow handling of spin events, new event types have been
738 // defined in spinbutt.h/spinnbuttcmn.cpp. To maintain backward compatibility
739 // the spin event types are being initialized with the scroll event types.
743 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN_UP
, wxSpinEvent
);
744 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN_DOWN
, wxSpinEvent
);
745 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN
, wxSpinEvent
);
749 // Scroll events from wxWindow
750 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_TOP
, wxScrollWinEvent
);
751 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_BOTTOM
, wxScrollWinEvent
);
752 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_LINEUP
, wxScrollWinEvent
);
753 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_LINEDOWN
, wxScrollWinEvent
);
754 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_PAGEUP
, wxScrollWinEvent
);
755 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_PAGEDOWN
, wxScrollWinEvent
);
756 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_THUMBTRACK
, wxScrollWinEvent
);
757 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_THUMBRELEASE
, wxScrollWinEvent
);
760 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SIZE
, wxSizeEvent
);
761 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE
, wxMoveEvent
);
762 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CLOSE_WINDOW
, wxCloseEvent
);
763 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_END_SESSION
, wxCloseEvent
);
764 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_QUERY_END_SESSION
, wxCloseEvent
);
765 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ACTIVATE_APP
, wxActivateEvent
);
766 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ACTIVATE
, wxActivateEvent
);
767 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CREATE
, wxWindowCreateEvent
);
768 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DESTROY
, wxWindowDestroyEvent
);
769 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SHOW
, wxShowEvent
);
770 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ICONIZE
, wxIconizeEvent
);
771 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MAXIMIZE
, wxMaximizeEvent
);
772 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSE_CAPTURE_CHANGED
, wxMouseCaptureChangedEvent
);
773 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSE_CAPTURE_LOST
, wxMouseCaptureLostEvent
);
774 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_PAINT
, wxPaintEvent
);
775 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ERASE_BACKGROUND
, wxEraseEvent
);
776 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_NC_PAINT
, wxNcPaintEvent
);
777 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_OPEN
, wxMenuEvent
);
778 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_CLOSE
, wxMenuEvent
);
779 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_HIGHLIGHT
, wxMenuEvent
);
780 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CONTEXT_MENU
, wxContextMenuEvent
);
781 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SYS_COLOUR_CHANGED
, wxSysColourChangedEvent
);
782 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DISPLAY_CHANGED
, wxDisplayChangedEvent
);
783 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_QUERY_NEW_PALETTE
, wxQueryNewPaletteEvent
);
784 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_PALETTE_CHANGED
, wxPaletteChangedEvent
);
785 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_BUTTON_DOWN
, wxJoystickEvent
);
786 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_BUTTON_UP
, wxJoystickEvent
);
787 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_MOVE
, wxJoystickEvent
);
788 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_ZMOVE
, wxJoystickEvent
);
789 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DROP_FILES
, wxDropFilesEvent
);
790 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_INIT_DIALOG
, wxInitDialogEvent
);
791 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_BASE
, wxEVT_IDLE
, wxIdleEvent
);
792 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_UPDATE_UI
, wxUpdateUIEvent
);
793 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SIZING
, wxSizeEvent
);
794 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVING
, wxMoveEvent
);
795 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE_START
, wxMoveEvent
);
796 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE_END
, wxMoveEvent
);
797 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HIBERNATE
, wxActivateEvent
);
800 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_COPY
, wxClipboardTextEvent
);
801 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_CUT
, wxClipboardTextEvent
);
802 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_PASTE
, wxClipboardTextEvent
);
804 // Generic command events
805 // Note: a click is a higher-level event than button down/up
806 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LEFT_CLICK
, wxCommandEvent
);
807 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LEFT_DCLICK
, wxCommandEvent
);
808 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RIGHT_CLICK
, wxCommandEvent
);
809 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RIGHT_DCLICK
, wxCommandEvent
);
810 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SET_FOCUS
, wxCommandEvent
);
811 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_KILL_FOCUS
, wxCommandEvent
);
812 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_ENTER
, wxCommandEvent
);
815 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HELP
, wxHelpEvent
);
816 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DETAILED_HELP
, wxHelpEvent
);
818 // these 2 events are the same
819 #define wxEVT_COMMAND_TOOL_CLICKED wxEVT_COMMAND_MENU_SELECTED
821 // ----------------------------------------------------------------------------
823 // ----------------------------------------------------------------------------
825 // this event is also used by wxComboBox and wxSpinCtrl which don't include
826 // wx/textctrl.h in all ports [yet], so declare it here as well
828 // still, any new code using it should include wx/textctrl.h explicitly
829 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_UPDATED
, wxCommandEvent
);
832 // ----------------------------------------------------------------------------
833 // wxEvent(-derived) classes
834 // ----------------------------------------------------------------------------
836 // the predefined constants for the number of times we propagate event
837 // upwards window child-parent chain
838 enum wxEventPropagation
840 // don't propagate it at all
841 wxEVENT_PROPAGATE_NONE
= 0,
843 // propagate it until it is processed
844 wxEVENT_PROPAGATE_MAX
= INT_MAX
847 // The different categories for a wxEvent; see wxEvent::GetEventCategory.
848 // NOTE: they are used as OR-combinable flags by wxEventLoopBase::YieldFor
851 // this is the category for those events which are generated to update
852 // the appearance of the GUI but which (usually) do not comport data
853 // processing, i.e. which do not provide input or output data
854 // (e.g. size events, scroll events, etc).
855 // They are events NOT directly generated by the user's input devices.
856 wxEVT_CATEGORY_UI
= 1,
858 // this category groups those events which are generated directly from the
859 // user through input devices like mouse and keyboard and usually result in
860 // data to be processed from the application.
861 // (e.g. mouse clicks, key presses, etc)
862 wxEVT_CATEGORY_USER_INPUT
= 2,
864 // this category is for wxSocketEvent
865 wxEVT_CATEGORY_SOCKET
= 4,
867 // this category is for wxTimerEvent
868 wxEVT_CATEGORY_TIMER
= 8,
870 // this category is for any event used to send notifications from the
871 // secondary threads to the main one or in general for notifications among
872 // different threads (which may or may not be user-generated)
873 wxEVT_CATEGORY_THREAD
= 16,
876 // implementation only
878 // used in the implementations of wxEventLoopBase::YieldFor
879 wxEVT_CATEGORY_UNKNOWN
= 32,
881 // a special category used as an argument to wxEventLoopBase::YieldFor to indicate that
882 // Yield() should leave all wxEvents on the queue while emptying the native event queue
883 // (native events will be processed but the wxEvents they generate will be queued)
884 wxEVT_CATEGORY_CLIPBOARD
= 64,
889 // this category groups those events which are emitted in response to
890 // events of the native toolkit and which typically are not-"delayable".
891 wxEVT_CATEGORY_NATIVE_EVENTS
= wxEVT_CATEGORY_UI
|wxEVT_CATEGORY_USER_INPUT
,
893 // used in wxEventLoopBase::YieldFor to specify all event categories should be processed:
895 wxEVT_CATEGORY_UI
|wxEVT_CATEGORY_USER_INPUT
|wxEVT_CATEGORY_SOCKET
| \
896 wxEVT_CATEGORY_TIMER
|wxEVT_CATEGORY_THREAD
|wxEVT_CATEGORY_UNKNOWN
| \
897 wxEVT_CATEGORY_CLIPBOARD
901 * wxWidgets events, covering all interesting things that might happen
902 * (button clicking, resizing, setting text in widgets, etc.).
904 * For each completely new event type, derive a new event class.
905 * An event CLASS represents a C++ class defining a range of similar event TYPES;
906 * examples are canvas events, panel item command events.
907 * An event TYPE is a unique identifier for a particular system event,
908 * such as a button press or a listbox deselection.
912 class WXDLLIMPEXP_BASE wxEvent
: public wxObject
915 wxEvent(int winid
= 0, wxEventType commandType
= wxEVT_NULL
);
917 void SetEventType(wxEventType typ
) { m_eventType
= typ
; }
918 wxEventType
GetEventType() const { return m_eventType
; }
920 wxObject
*GetEventObject() const { return m_eventObject
; }
921 void SetEventObject(wxObject
*obj
) { m_eventObject
= obj
; }
923 long GetTimestamp() const { return m_timeStamp
; }
924 void SetTimestamp(long ts
= 0) { m_timeStamp
= ts
; }
926 int GetId() const { return m_id
; }
927 void SetId(int Id
) { m_id
= Id
; }
929 // Can instruct event processor that we wish to ignore this event
930 // (treat as if the event table entry had not been found): this must be done
931 // to allow the event processing by the base classes (calling event.Skip()
932 // is the analog of calling the base class version of a virtual function)
933 void Skip(bool skip
= true) { m_skipped
= skip
; }
934 bool GetSkipped() const { return m_skipped
; }
936 // This function is used to create a copy of the event polymorphically and
937 // all derived classes must implement it because otherwise wxPostEvent()
938 // for them wouldn't work (it needs to do a copy of the event)
939 virtual wxEvent
*Clone() const = 0;
941 // this function is used to selectively process events in wxEventLoopBase::YieldFor
942 // NOTE: by default it returns wxEVT_CATEGORY_UI just because the major
943 // part of wxWidgets events belong to that category.
944 virtual wxEventCategory
GetEventCategory() const
945 { return wxEVT_CATEGORY_UI
; }
947 // Implementation only: this test is explicitly anti OO and this function
948 // exists only for optimization purposes.
949 bool IsCommandEvent() const { return m_isCommandEvent
; }
951 // Determine if this event should be propagating to the parent window.
952 bool ShouldPropagate() const
953 { return m_propagationLevel
!= wxEVENT_PROPAGATE_NONE
; }
955 // Stop an event from propagating to its parent window, returns the old
956 // propagation level value
957 int StopPropagation()
959 int propagationLevel
= m_propagationLevel
;
960 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
961 return propagationLevel
;
964 // Resume the event propagation by restoring the propagation level
965 // (returned by StopPropagation())
966 void ResumePropagation(int propagationLevel
)
968 m_propagationLevel
= propagationLevel
;
972 // This is for internal use only and is only called by
973 // wxEvtHandler::ProcessEvent() to check whether it's the first time this
974 // event is being processed
977 if ( m_wasProcessed
)
980 m_wasProcessed
= true;
985 // This is also used only internally by ProcessEvent() to check if it
986 // should process the event normally or only restrict the search for the
987 // event handler to this object itself.
988 bool ShouldProcessOnlyIn(wxEvtHandler
*h
) const
990 return h
== m_handlerToProcessOnlyIn
;
993 // Called to indicate that the result of ShouldProcessOnlyIn() wasn't taken
994 // into account. The existence of this function may seem counterintuitive
995 // but unfortunately it's needed by wxScrollHelperEvtHandler, see comments
996 // there. Don't even think of using this in your own code, this is a gross
997 // hack and is only needed because of wx complicated history and should
998 // never be used anywhere else.
999 void DidntHonourProcessOnlyIn()
1001 m_handlerToProcessOnlyIn
= NULL
;
1005 wxObject
* m_eventObject
;
1006 wxEventType m_eventType
;
1011 // m_callbackUserData is for internal usage only
1012 wxObject
* m_callbackUserData
;
1016 wxEvtHandler
*m_handlerToProcessOnlyIn
;
1019 // the propagation level: while it is positive, we propagate the event to
1020 // the parent window (if any)
1021 int m_propagationLevel
;
1024 bool m_isCommandEvent
;
1026 // initially false but becomes true as soon as WasProcessed() is called for
1027 // the first time, as this is done only by ProcessEvent() it explains the
1028 // variable name: it becomes true after ProcessEvent() was called at least
1029 // once for this event
1030 bool m_wasProcessed
;
1033 wxEvent(const wxEvent
&); // for implementing Clone()
1034 wxEvent
& operator=(const wxEvent
&); // for derived classes operator=()
1037 // it needs to access our m_propagationLevel
1038 friend class WXDLLIMPEXP_FWD_BASE wxPropagateOnce
;
1040 // and this one needs to access our m_handlerToProcessOnlyIn
1041 friend class WXDLLIMPEXP_FWD_BASE wxEventProcessInHandlerOnly
;
1044 DECLARE_ABSTRACT_CLASS(wxEvent
)
1048 * Helper class to temporarily change an event not to propagate.
1050 class WXDLLIMPEXP_BASE wxPropagationDisabler
1053 wxPropagationDisabler(wxEvent
& event
) : m_event(event
)
1055 m_propagationLevelOld
= m_event
.StopPropagation();
1058 ~wxPropagationDisabler()
1060 m_event
.ResumePropagation(m_propagationLevelOld
);
1065 int m_propagationLevelOld
;
1067 wxDECLARE_NO_COPY_CLASS(wxPropagationDisabler
);
1071 * Another one to temporarily lower propagation level.
1073 class WXDLLIMPEXP_BASE wxPropagateOnce
1076 wxPropagateOnce(wxEvent
& event
) : m_event(event
)
1078 wxASSERT_MSG( m_event
.m_propagationLevel
> 0,
1079 wxT("shouldn't be used unless ShouldPropagate()!") );
1081 m_event
.m_propagationLevel
--;
1086 m_event
.m_propagationLevel
++;
1092 wxDECLARE_NO_COPY_CLASS(wxPropagateOnce
);
1095 // A helper object used to temporarily make wxEvent::ShouldProcessOnlyIn()
1096 // return true for the handler passed to its ctor.
1097 class wxEventProcessInHandlerOnly
1100 wxEventProcessInHandlerOnly(wxEvent
& event
, wxEvtHandler
*handler
)
1102 m_handlerToProcessOnlyInOld(event
.m_handlerToProcessOnlyIn
)
1104 m_event
.m_handlerToProcessOnlyIn
= handler
;
1107 ~wxEventProcessInHandlerOnly()
1109 m_event
.m_handlerToProcessOnlyIn
= m_handlerToProcessOnlyInOld
;
1114 wxEvtHandler
* const m_handlerToProcessOnlyInOld
;
1116 wxDECLARE_NO_COPY_CLASS(wxEventProcessInHandlerOnly
);
1122 // Item or menu event class
1124 wxEVT_COMMAND_BUTTON_CLICKED
1125 wxEVT_COMMAND_CHECKBOX_CLICKED
1126 wxEVT_COMMAND_CHOICE_SELECTED
1127 wxEVT_COMMAND_LISTBOX_SELECTED
1128 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
1129 wxEVT_COMMAND_TEXT_UPDATED
1130 wxEVT_COMMAND_TEXT_ENTER
1131 wxEVT_COMMAND_MENU_SELECTED
1132 wxEVT_COMMAND_SLIDER_UPDATED
1133 wxEVT_COMMAND_RADIOBOX_SELECTED
1134 wxEVT_COMMAND_RADIOBUTTON_SELECTED
1135 wxEVT_COMMAND_SCROLLBAR_UPDATED
1136 wxEVT_COMMAND_VLBOX_SELECTED
1137 wxEVT_COMMAND_COMBOBOX_SELECTED
1138 wxEVT_COMMAND_TOGGLEBUTTON_CLICKED
1141 class WXDLLIMPEXP_CORE wxCommandEvent
: public wxEvent
1144 wxCommandEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0);
1146 wxCommandEvent(const wxCommandEvent
& event
)
1148 m_cmdString(event
.m_cmdString
),
1149 m_commandInt(event
.m_commandInt
),
1150 m_extraLong(event
.m_extraLong
),
1151 m_clientData(event
.m_clientData
),
1152 m_clientObject(event
.m_clientObject
)
1155 // Set/Get client data from controls
1156 void SetClientData(void* clientData
) { m_clientData
= clientData
; }
1157 void *GetClientData() const { return m_clientData
; }
1159 // Set/Get client object from controls
1160 void SetClientObject(wxClientData
* clientObject
) { m_clientObject
= clientObject
; }
1161 wxClientData
*GetClientObject() const { return m_clientObject
; }
1163 // Get listbox selection if single-choice
1164 int GetSelection() const { return m_commandInt
; }
1166 // Set/Get listbox/choice selection string
1167 void SetString(const wxString
& s
) { m_cmdString
= s
; }
1168 wxString
GetString() const;
1170 // Get checkbox value
1171 bool IsChecked() const { return m_commandInt
!= 0; }
1173 // true if the listbox event was a selection.
1174 bool IsSelection() const { return (m_extraLong
!= 0); }
1176 void SetExtraLong(long extraLong
) { m_extraLong
= extraLong
; }
1177 long GetExtraLong() const { return m_extraLong
; }
1179 void SetInt(int i
) { m_commandInt
= i
; }
1180 int GetInt() const { return m_commandInt
; }
1182 virtual wxEvent
*Clone() const { return new wxCommandEvent(*this); }
1183 virtual wxEventCategory
GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT
; }
1186 wxString m_cmdString
; // String event argument
1188 long m_extraLong
; // Additional information (e.g. select/deselect)
1189 void* m_clientData
; // Arbitrary client data
1190 wxClientData
* m_clientObject
; // Arbitrary client object
1193 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCommandEvent
)
1196 // this class adds a possibility to react (from the user) code to a control
1197 // notification: allow or veto the operation being reported.
1198 class WXDLLIMPEXP_CORE wxNotifyEvent
: public wxCommandEvent
1201 wxNotifyEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0)
1202 : wxCommandEvent(commandType
, winid
)
1203 { m_bAllow
= true; }
1205 wxNotifyEvent(const wxNotifyEvent
& event
)
1206 : wxCommandEvent(event
)
1207 { m_bAllow
= event
.m_bAllow
; }
1209 // veto the operation (usually it's allowed by default)
1210 void Veto() { m_bAllow
= false; }
1212 // allow the operation if it was disabled by default
1213 void Allow() { m_bAllow
= true; }
1215 // for implementation code only: is the operation allowed?
1216 bool IsAllowed() const { return m_bAllow
; }
1218 virtual wxEvent
*Clone() const { return new wxNotifyEvent(*this); }
1224 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNotifyEvent
)
1230 class WXDLLIMPEXP_CORE wxThreadEvent
: public wxCommandEvent
1233 wxThreadEvent(wxEventType eventType
= wxEVT_COMMAND_THREAD
, int id
= wxID_ANY
)
1234 : wxCommandEvent(eventType
, id
)
1237 wxThreadEvent(const wxThreadEvent
& event
)
1238 : wxCommandEvent(event
)
1240 // make sure our string member (which uses COW, aka refcounting) is not
1241 // shared by other wxString instances:
1242 SetString(GetString().c_str());
1244 #if wxUSE_ANY && (!defined(__VISUALC__) || wxCHECK_VISUALC_VERSION(7))
1245 m_payload
= event
.m_payload
;
1249 virtual wxEvent
*Clone() const
1251 return new wxThreadEvent(*this);
1254 // this is important to avoid that calling wxEventLoopBase::YieldFor thread events
1255 // gets processed when this is unwanted:
1256 virtual wxEventCategory
GetEventCategory() const
1257 { return wxEVT_CATEGORY_THREAD
; }
1259 #if wxUSE_ANY && (!defined(__VISUALC__) || wxCHECK_VISUALC_VERSION(7))
1260 template<typename T
>
1261 void SetPayload(const T
& payload
)
1263 m_payload
= payload
;
1266 template<typename T
>
1267 T
GetPayload() const
1269 return m_payload
.As
<T
>();
1274 #endif // wxUSE_ANY && (!defined(__VISUALC__) || wxCHECK_VISUALC_VERSION(7))
1277 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxThreadEvent
)
1282 // Scroll event class, derived form wxCommandEvent. wxScrollEvents are
1283 // sent by wxSlider and wxScrollBar.
1288 wxEVT_SCROLL_LINEDOWN
1290 wxEVT_SCROLL_PAGEDOWN
1291 wxEVT_SCROLL_THUMBTRACK
1292 wxEVT_SCROLL_THUMBRELEASE
1293 wxEVT_SCROLL_CHANGED
1296 class WXDLLIMPEXP_CORE wxScrollEvent
: public wxCommandEvent
1299 wxScrollEvent(wxEventType commandType
= wxEVT_NULL
,
1300 int winid
= 0, int pos
= 0, int orient
= 0);
1302 int GetOrientation() const { return (int) m_extraLong
; }
1303 int GetPosition() const { return m_commandInt
; }
1304 void SetOrientation(int orient
) { m_extraLong
= (long) orient
; }
1305 void SetPosition(int pos
) { m_commandInt
= pos
; }
1307 virtual wxEvent
*Clone() const { return new wxScrollEvent(*this); }
1310 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollEvent
)
1313 // ScrollWin event class, derived fom wxEvent. wxScrollWinEvents
1314 // are sent by wxWindow.
1317 wxEVT_SCROLLWIN_BOTTOM
1318 wxEVT_SCROLLWIN_LINEUP
1319 wxEVT_SCROLLWIN_LINEDOWN
1320 wxEVT_SCROLLWIN_PAGEUP
1321 wxEVT_SCROLLWIN_PAGEDOWN
1322 wxEVT_SCROLLWIN_THUMBTRACK
1323 wxEVT_SCROLLWIN_THUMBRELEASE
1326 class WXDLLIMPEXP_CORE wxScrollWinEvent
: public wxEvent
1329 wxScrollWinEvent(wxEventType commandType
= wxEVT_NULL
,
1330 int pos
= 0, int orient
= 0);
1331 wxScrollWinEvent(const wxScrollWinEvent
& event
) : wxEvent(event
)
1332 { m_commandInt
= event
.m_commandInt
;
1333 m_extraLong
= event
.m_extraLong
; }
1335 int GetOrientation() const { return (int) m_extraLong
; }
1336 int GetPosition() const { return m_commandInt
; }
1337 void SetOrientation(int orient
) { m_extraLong
= (long) orient
; }
1338 void SetPosition(int pos
) { m_commandInt
= pos
; }
1340 virtual wxEvent
*Clone() const { return new wxScrollWinEvent(*this); }
1347 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollWinEvent
)
1352 // Mouse event class
1369 wxEVT_NC_MIDDLE_DOWN,
1371 wxEVT_NC_RIGHT_DOWN,
1374 wxEVT_NC_ENTER_WINDOW,
1375 wxEVT_NC_LEAVE_WINDOW,
1376 wxEVT_NC_LEFT_DCLICK,
1377 wxEVT_NC_MIDDLE_DCLICK,
1378 wxEVT_NC_RIGHT_DCLICK,
1381 class WXDLLIMPEXP_CORE wxMouseEvent
: public wxEvent
,
1385 wxMouseEvent(wxEventType mouseType
= wxEVT_NULL
);
1386 wxMouseEvent(const wxMouseEvent
& event
)
1393 // Was it a button event? (*doesn't* mean: is any button *down*?)
1394 bool IsButton() const { return Button(wxMOUSE_BTN_ANY
); }
1396 // Was it a down event from this (or any) button?
1397 bool ButtonDown(int but
= wxMOUSE_BTN_ANY
) const;
1399 // Was it a dclick event from this (or any) button?
1400 bool ButtonDClick(int but
= wxMOUSE_BTN_ANY
) const;
1402 // Was it a up event from this (or any) button?
1403 bool ButtonUp(int but
= wxMOUSE_BTN_ANY
) const;
1405 // Was this event generated by the given button?
1406 bool Button(int but
) const;
1408 // Get the button which is changing state (wxMOUSE_BTN_NONE if none)
1409 int GetButton() const;
1411 // Find which event was just generated
1412 bool LeftDown() const { return (m_eventType
== wxEVT_LEFT_DOWN
); }
1413 bool MiddleDown() const { return (m_eventType
== wxEVT_MIDDLE_DOWN
); }
1414 bool RightDown() const { return (m_eventType
== wxEVT_RIGHT_DOWN
); }
1415 bool Aux1Down() const { return (m_eventType
== wxEVT_AUX1_DOWN
); }
1416 bool Aux2Down() const { return (m_eventType
== wxEVT_AUX2_DOWN
); }
1418 bool LeftUp() const { return (m_eventType
== wxEVT_LEFT_UP
); }
1419 bool MiddleUp() const { return (m_eventType
== wxEVT_MIDDLE_UP
); }
1420 bool RightUp() const { return (m_eventType
== wxEVT_RIGHT_UP
); }
1421 bool Aux1Up() const { return (m_eventType
== wxEVT_AUX1_UP
); }
1422 bool Aux2Up() const { return (m_eventType
== wxEVT_AUX2_UP
); }
1424 bool LeftDClick() const { return (m_eventType
== wxEVT_LEFT_DCLICK
); }
1425 bool MiddleDClick() const { return (m_eventType
== wxEVT_MIDDLE_DCLICK
); }
1426 bool RightDClick() const { return (m_eventType
== wxEVT_RIGHT_DCLICK
); }
1427 bool Aux1DClick() const { return (m_eventType
== wxEVT_AUX1_UP
); }
1428 bool Aux2DClick() const { return (m_eventType
== wxEVT_AUX2_UP
); }
1430 // True if a button is down and the mouse is moving
1431 bool Dragging() const
1433 return (m_eventType
== wxEVT_MOTION
) && ButtonIsDown(wxMOUSE_BTN_ANY
);
1436 // True if the mouse is moving, and no button is down
1439 return (m_eventType
== wxEVT_MOTION
) && !ButtonIsDown(wxMOUSE_BTN_ANY
);
1442 // True if the mouse is just entering the window
1443 bool Entering() const { return (m_eventType
== wxEVT_ENTER_WINDOW
); }
1445 // True if the mouse is just leaving the window
1446 bool Leaving() const { return (m_eventType
== wxEVT_LEAVE_WINDOW
); }
1448 // Returns the number of mouse clicks associated with this event.
1449 int GetClickCount() const { return m_clickCount
; }
1451 // Find the logical position of the event given the DC
1452 wxPoint
GetLogicalPosition(const wxDC
& dc
) const;
1454 // Get wheel rotation, positive or negative indicates direction of
1455 // rotation. Current devices all send an event when rotation is equal to
1456 // +/-WheelDelta, but this allows for finer resolution devices to be
1457 // created in the future. Because of this you shouldn't assume that one
1458 // event is equal to 1 line or whatever, but you should be able to either
1459 // do partial line scrolling or wait until +/-WheelDelta rotation values
1460 // have been accumulated before scrolling.
1461 int GetWheelRotation() const { return m_wheelRotation
; }
1463 // Get wheel delta, normally 120. This is the threshold for action to be
1464 // taken, and one such action (for example, scrolling one increment)
1465 // should occur for each delta.
1466 int GetWheelDelta() const { return m_wheelDelta
; }
1468 // Gets the axis the wheel operation concerns, 0 being the y axis as on
1469 // most mouse wheels, 1 is the x axis for things like MightyMouse scrolls
1470 // or horizontal trackpad scrolling
1471 int GetWheelAxis() const { return m_wheelAxis
; }
1473 // Returns the configured number of lines (or whatever) to be scrolled per
1474 // wheel action. Defaults to one.
1475 int GetLinesPerAction() const { return m_linesPerAction
; }
1477 // Is the system set to do page scrolling?
1478 bool IsPageScroll() const { return ((unsigned int)m_linesPerAction
== UINT_MAX
); }
1480 virtual wxEvent
*Clone() const { return new wxMouseEvent(*this); }
1481 virtual wxEventCategory
GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT
; }
1483 wxMouseEvent
& operator=(const wxMouseEvent
& event
)
1494 int m_wheelRotation
;
1496 int m_linesPerAction
;
1499 void Assign(const wxMouseEvent
& evt
);
1502 DECLARE_DYNAMIC_CLASS(wxMouseEvent
)
1511 class WXDLLIMPEXP_CORE wxSetCursorEvent
: public wxEvent
1514 wxSetCursorEvent(wxCoord x
= 0, wxCoord y
= 0)
1515 : wxEvent(0, wxEVT_SET_CURSOR
),
1516 m_x(x
), m_y(y
), m_cursor()
1519 wxSetCursorEvent(const wxSetCursorEvent
& event
)
1523 m_cursor(event
.m_cursor
)
1526 wxCoord
GetX() const { return m_x
; }
1527 wxCoord
GetY() const { return m_y
; }
1529 void SetCursor(const wxCursor
& cursor
) { m_cursor
= cursor
; }
1530 const wxCursor
& GetCursor() const { return m_cursor
; }
1531 bool HasCursor() const { return m_cursor
.Ok(); }
1533 virtual wxEvent
*Clone() const { return new wxSetCursorEvent(*this); }
1540 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSetCursorEvent
)
1543 // Keyboard input event class
1553 // key categories: the bit flags for IsKeyInCategory() function
1555 // the enum values used may change in future version of wx
1556 // use the named constants only, or bitwise combinations thereof
1557 enum wxKeyCategoryFlags
1559 // arrow keys, on and off numeric keypads
1560 WXK_CATEGORY_ARROW
= 1,
1562 // page up and page down keys, on and off numeric keypads
1563 WXK_CATEGORY_PAGING
= 2,
1565 // home and end keys, on and off numeric keypads
1566 WXK_CATEGORY_JUMP
= 4,
1568 // tab key, on and off numeric keypads
1569 WXK_CATEGORY_TAB
= 8,
1571 // backspace and delete keys, on and off numeric keypads
1572 WXK_CATEGORY_CUT
= 16,
1574 // all keys usually used for navigation
1575 WXK_CATEGORY_NAVIGATION
= WXK_CATEGORY_ARROW
|
1576 WXK_CATEGORY_PAGING
|
1580 class WXDLLIMPEXP_CORE wxKeyEvent
: public wxEvent
,
1581 public wxKeyboardState
1584 wxKeyEvent(wxEventType keyType
= wxEVT_NULL
);
1585 wxKeyEvent(const wxKeyEvent
& evt
);
1587 // get the key code: an ASCII7 char or an element of wxKeyCode enum
1588 int GetKeyCode() const { return (int)m_keyCode
; }
1590 // returns true iff this event's key code is of a certain type
1591 bool IsKeyInCategory(int category
) const;
1594 // get the Unicode character corresponding to this key
1595 wxChar
GetUnicodeKey() const { return m_uniChar
; }
1596 #endif // wxUSE_UNICODE
1598 // get the raw key code (platform-dependent)
1599 wxUint32
GetRawKeyCode() const { return m_rawCode
; }
1601 // get the raw key flags (platform-dependent)
1602 wxUint32
GetRawKeyFlags() const { return m_rawFlags
; }
1604 // Find the position of the event
1605 void GetPosition(wxCoord
*xpos
, wxCoord
*ypos
) const
1607 if (xpos
) *xpos
= m_x
;
1608 if (ypos
) *ypos
= m_y
;
1611 void GetPosition(long *xpos
, long *ypos
) const
1613 if (xpos
) *xpos
= (long)m_x
;
1614 if (ypos
) *ypos
= (long)m_y
;
1617 wxPoint
GetPosition() const
1618 { return wxPoint(m_x
, m_y
); }
1621 wxCoord
GetX() const { return m_x
; }
1624 wxCoord
GetY() const { return m_y
; }
1626 virtual wxEvent
*Clone() const { return new wxKeyEvent(*this); }
1627 virtual wxEventCategory
GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT
; }
1629 // we do need to copy wxKeyEvent sometimes (in wxTreeCtrl code, for
1631 wxKeyEvent
& operator=(const wxKeyEvent
& evt
)
1635 wxEvent::operator=(evt
);
1637 // Borland C++ 5.82 doesn't compile an explicit call to an
1638 // implicitly defined operator=() so need to do it this way:
1639 *static_cast<wxKeyboardState
*>(this) = evt
;
1644 m_keyCode
= evt
.m_keyCode
;
1646 m_rawCode
= evt
.m_rawCode
;
1647 m_rawFlags
= evt
.m_rawFlags
;
1649 m_uniChar
= evt
.m_uniChar
;
1661 // This contains the full Unicode character
1662 // in a character events in Unicode mode
1666 // these fields contain the platform-specific information about
1667 // key that was pressed
1669 wxUint32 m_rawFlags
;
1672 DECLARE_DYNAMIC_CLASS(wxKeyEvent
)
1680 class WXDLLIMPEXP_CORE wxSizeEvent
: public wxEvent
1683 wxSizeEvent() : wxEvent(0, wxEVT_SIZE
)
1685 wxSizeEvent(const wxSize
& sz
, int winid
= 0)
1686 : wxEvent(winid
, wxEVT_SIZE
),
1689 wxSizeEvent(const wxSizeEvent
& event
)
1691 m_size(event
.m_size
), m_rect(event
.m_rect
)
1693 wxSizeEvent(const wxRect
& rect
, int id
= 0)
1694 : m_size(rect
.GetSize()), m_rect(rect
)
1695 { m_eventType
= wxEVT_SIZING
; m_id
= id
; }
1697 wxSize
GetSize() const { return m_size
; }
1698 void SetSize(wxSize size
) { m_size
= size
; }
1699 wxRect
GetRect() const { return m_rect
; }
1700 void SetRect(const wxRect
& rect
) { m_rect
= rect
; }
1702 virtual wxEvent
*Clone() const { return new wxSizeEvent(*this); }
1705 // For internal usage only. Will be converted to protected members.
1707 wxRect m_rect
; // Used for wxEVT_SIZING
1710 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSizeEvent
)
1719 class WXDLLIMPEXP_CORE wxMoveEvent
: public wxEvent
1723 : wxEvent(0, wxEVT_MOVE
)
1725 wxMoveEvent(const wxPoint
& pos
, int winid
= 0)
1726 : wxEvent(winid
, wxEVT_MOVE
),
1729 wxMoveEvent(const wxMoveEvent
& event
)
1733 wxMoveEvent(const wxRect
& rect
, int id
= 0)
1734 : m_pos(rect
.GetPosition()), m_rect(rect
)
1735 { m_eventType
= wxEVT_MOVING
; m_id
= id
; }
1737 wxPoint
GetPosition() const { return m_pos
; }
1738 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
1739 wxRect
GetRect() const { return m_rect
; }
1740 void SetRect(const wxRect
& rect
) { m_rect
= rect
; }
1742 virtual wxEvent
*Clone() const { return new wxMoveEvent(*this); }
1749 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMoveEvent
)
1752 // Paint event class
1759 #if wxDEBUG_LEVEL && (defined(__WXMSW__) || defined(__WXPM__))
1760 #define wxHAS_PAINT_DEBUG
1762 // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined
1763 extern WXDLLIMPEXP_CORE
int g_isPainting
;
1766 class WXDLLIMPEXP_CORE wxPaintEvent
: public wxEvent
1769 wxPaintEvent(int Id
= 0)
1770 : wxEvent(Id
, wxEVT_PAINT
)
1772 #ifdef wxHAS_PAINT_DEBUG
1773 // set the internal flag for the duration of redrawing
1778 // default copy ctor and dtor are normally fine, we only need them to keep
1779 // g_isPainting updated in debug build
1780 #ifdef wxHAS_PAINT_DEBUG
1781 wxPaintEvent(const wxPaintEvent
& event
)
1787 virtual ~wxPaintEvent()
1793 virtual wxEvent
*Clone() const { return new wxPaintEvent(*this); }
1796 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaintEvent
)
1799 class WXDLLIMPEXP_CORE wxNcPaintEvent
: public wxEvent
1802 wxNcPaintEvent(int winid
= 0)
1803 : wxEvent(winid
, wxEVT_NC_PAINT
)
1806 virtual wxEvent
*Clone() const { return new wxNcPaintEvent(*this); }
1809 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNcPaintEvent
)
1812 // Erase background event class
1814 wxEVT_ERASE_BACKGROUND
1817 class WXDLLIMPEXP_CORE wxEraseEvent
: public wxEvent
1820 wxEraseEvent(int Id
= 0, wxDC
*dc
= NULL
)
1821 : wxEvent(Id
, wxEVT_ERASE_BACKGROUND
),
1825 wxEraseEvent(const wxEraseEvent
& event
)
1830 wxDC
*GetDC() const { return m_dc
; }
1832 virtual wxEvent
*Clone() const { return new wxEraseEvent(*this); }
1838 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxEraseEvent
)
1841 // Focus event class
1847 class WXDLLIMPEXP_CORE wxFocusEvent
: public wxEvent
1850 wxFocusEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0)
1851 : wxEvent(winid
, type
)
1854 wxFocusEvent(const wxFocusEvent
& event
)
1856 { m_win
= event
.m_win
; }
1858 // The window associated with this event is the window which had focus
1859 // before for SET event and the window which will have focus for the KILL
1860 // one. NB: it may be NULL in both cases!
1861 wxWindow
*GetWindow() const { return m_win
; }
1862 void SetWindow(wxWindow
*win
) { m_win
= win
; }
1864 virtual wxEvent
*Clone() const { return new wxFocusEvent(*this); }
1870 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFocusEvent
)
1873 // wxChildFocusEvent notifies the parent that a child has got the focus: unlike
1874 // wxFocusEvent it is propagated upwards the window chain
1875 class WXDLLIMPEXP_CORE wxChildFocusEvent
: public wxCommandEvent
1878 wxChildFocusEvent(wxWindow
*win
= NULL
);
1880 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
1882 virtual wxEvent
*Clone() const { return new wxChildFocusEvent(*this); }
1885 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxChildFocusEvent
)
1888 // Activate event class
1895 class WXDLLIMPEXP_CORE wxActivateEvent
: public wxEvent
1898 wxActivateEvent(wxEventType type
= wxEVT_NULL
, bool active
= true, int Id
= 0)
1900 { m_active
= active
; }
1901 wxActivateEvent(const wxActivateEvent
& event
)
1903 { m_active
= event
.m_active
; }
1905 bool GetActive() const { return m_active
; }
1907 virtual wxEvent
*Clone() const { return new wxActivateEvent(*this); }
1913 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxActivateEvent
)
1916 // InitDialog event class
1921 class WXDLLIMPEXP_CORE wxInitDialogEvent
: public wxEvent
1924 wxInitDialogEvent(int Id
= 0)
1925 : wxEvent(Id
, wxEVT_INIT_DIALOG
)
1928 virtual wxEvent
*Clone() const { return new wxInitDialogEvent(*this); }
1931 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxInitDialogEvent
)
1934 // Miscellaneous menu event class
1938 wxEVT_MENU_HIGHLIGHT,
1941 class WXDLLIMPEXP_CORE wxMenuEvent
: public wxEvent
1944 wxMenuEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0, wxMenu
* menu
= NULL
)
1945 : wxEvent(winid
, type
)
1946 { m_menuId
= winid
; m_menu
= menu
; }
1947 wxMenuEvent(const wxMenuEvent
& event
)
1949 { m_menuId
= event
.m_menuId
; m_menu
= event
.m_menu
; }
1951 // only for wxEVT_MENU_HIGHLIGHT
1952 int GetMenuId() const { return m_menuId
; }
1954 // only for wxEVT_MENU_OPEN/CLOSE
1955 bool IsPopup() const { return m_menuId
== wxID_ANY
; }
1957 // only for wxEVT_MENU_OPEN/CLOSE
1958 wxMenu
* GetMenu() const { return m_menu
; }
1960 virtual wxEvent
*Clone() const { return new wxMenuEvent(*this); }
1966 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMenuEvent
)
1969 // Window close or session close event class
1973 wxEVT_QUERY_END_SESSION
1976 class WXDLLIMPEXP_CORE wxCloseEvent
: public wxEvent
1979 wxCloseEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0)
1980 : wxEvent(winid
, type
),
1982 m_veto(false), // should be false by default
1985 wxCloseEvent(const wxCloseEvent
& event
)
1987 m_loggingOff(event
.m_loggingOff
),
1988 m_veto(event
.m_veto
),
1989 m_canVeto(event
.m_canVeto
) {}
1991 void SetLoggingOff(bool logOff
) { m_loggingOff
= logOff
; }
1992 bool GetLoggingOff() const
1994 // m_loggingOff flag is only used by wxEVT_[QUERY_]END_SESSION, it
1995 // doesn't make sense for wxEVT_CLOSE_WINDOW
1996 wxASSERT_MSG( m_eventType
!= wxEVT_CLOSE_WINDOW
,
1997 wxT("this flag is for end session events only") );
1999 return m_loggingOff
;
2002 void Veto(bool veto
= true)
2004 // GetVeto() will return false anyhow...
2005 wxCHECK_RET( m_canVeto
,
2006 wxT("call to Veto() ignored (can't veto this event)") );
2010 void SetCanVeto(bool canVeto
) { m_canVeto
= canVeto
; }
2011 bool CanVeto() const { return m_canVeto
; }
2012 bool GetVeto() const { return m_canVeto
&& m_veto
; }
2014 virtual wxEvent
*Clone() const { return new wxCloseEvent(*this); }
2022 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCloseEvent
)
2029 class WXDLLIMPEXP_CORE wxShowEvent
: public wxEvent
2032 wxShowEvent(int winid
= 0, bool show
= false)
2033 : wxEvent(winid
, wxEVT_SHOW
)
2035 wxShowEvent(const wxShowEvent
& event
)
2037 { m_show
= event
.m_show
; }
2039 void SetShow(bool show
) { m_show
= show
; }
2041 // return true if the window was shown, false if hidden
2042 bool IsShown() const { return m_show
; }
2044 #if WXWIN_COMPATIBILITY_2_8
2045 wxDEPRECATED( bool GetShow() const { return IsShown(); } )
2048 virtual wxEvent
*Clone() const { return new wxShowEvent(*this); }
2054 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxShowEvent
)
2061 class WXDLLIMPEXP_CORE wxIconizeEvent
: public wxEvent
2064 wxIconizeEvent(int winid
= 0, bool iconized
= true)
2065 : wxEvent(winid
, wxEVT_ICONIZE
)
2066 { m_iconized
= iconized
; }
2067 wxIconizeEvent(const wxIconizeEvent
& event
)
2069 { m_iconized
= event
.m_iconized
; }
2071 #if WXWIN_COMPATIBILITY_2_8
2072 wxDEPRECATED( bool Iconized() const { return IsIconized(); } )
2074 // return true if the frame was iconized, false if restored
2075 bool IsIconized() const { return m_iconized
; }
2077 virtual wxEvent
*Clone() const { return new wxIconizeEvent(*this); }
2083 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIconizeEvent
)
2089 class WXDLLIMPEXP_CORE wxMaximizeEvent
: public wxEvent
2092 wxMaximizeEvent(int winid
= 0)
2093 : wxEvent(winid
, wxEVT_MAXIMIZE
)
2096 virtual wxEvent
*Clone() const { return new wxMaximizeEvent(*this); }
2099 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMaximizeEvent
)
2102 // Joystick event class
2104 wxEVT_JOY_BUTTON_DOWN,
2105 wxEVT_JOY_BUTTON_UP,
2110 // Which joystick? Same as Windows ids so no conversion necessary.
2117 // Which button is down?
2120 wxJOY_BUTTON_ANY
= -1,
2127 class WXDLLIMPEXP_CORE wxJoystickEvent
: public wxEvent
2132 int m_buttonChange
; // Which button changed?
2133 int m_buttonState
; // Which buttons are down?
2134 int m_joyStick
; // Which joystick?
2137 wxJoystickEvent(wxEventType type
= wxEVT_NULL
,
2139 int joystick
= wxJOYSTICK1
,
2144 m_buttonChange(change
),
2145 m_buttonState(state
),
2146 m_joyStick(joystick
)
2149 wxJoystickEvent(const wxJoystickEvent
& event
)
2152 m_zPosition(event
.m_zPosition
),
2153 m_buttonChange(event
.m_buttonChange
),
2154 m_buttonState(event
.m_buttonState
),
2155 m_joyStick(event
.m_joyStick
)
2158 wxPoint
GetPosition() const { return m_pos
; }
2159 int GetZPosition() const { return m_zPosition
; }
2160 int GetButtonState() const { return m_buttonState
; }
2161 int GetButtonChange() const { return m_buttonChange
; }
2162 int GetJoystick() const { return m_joyStick
; }
2164 void SetJoystick(int stick
) { m_joyStick
= stick
; }
2165 void SetButtonState(int state
) { m_buttonState
= state
; }
2166 void SetButtonChange(int change
) { m_buttonChange
= change
; }
2167 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2168 void SetZPosition(int zPos
) { m_zPosition
= zPos
; }
2170 // Was it a button event? (*doesn't* mean: is any button *down*?)
2171 bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN
) ||
2172 (GetEventType() == wxEVT_JOY_BUTTON_UP
)); }
2174 // Was it a move event?
2175 bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE
); }
2177 // Was it a zmove event?
2178 bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE
); }
2180 // Was it a down event from button 1, 2, 3, 4 or any?
2181 bool ButtonDown(int but
= wxJOY_BUTTON_ANY
) const
2182 { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN
) &&
2183 ((but
== wxJOY_BUTTON_ANY
) || (but
== m_buttonChange
))); }
2185 // Was it a up event from button 1, 2, 3 or any?
2186 bool ButtonUp(int but
= wxJOY_BUTTON_ANY
) const
2187 { return ((GetEventType() == wxEVT_JOY_BUTTON_UP
) &&
2188 ((but
== wxJOY_BUTTON_ANY
) || (but
== m_buttonChange
))); }
2190 // Was the given button 1,2,3,4 or any in Down state?
2191 bool ButtonIsDown(int but
= wxJOY_BUTTON_ANY
) const
2192 { return (((but
== wxJOY_BUTTON_ANY
) && (m_buttonState
!= 0)) ||
2193 ((m_buttonState
& but
) == but
)); }
2195 virtual wxEvent
*Clone() const { return new wxJoystickEvent(*this); }
2198 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxJoystickEvent
)
2201 // Drop files event class
2206 class WXDLLIMPEXP_CORE wxDropFilesEvent
: public wxEvent
2213 wxDropFilesEvent(wxEventType type
= wxEVT_NULL
,
2215 wxString
*files
= NULL
)
2222 // we need a copy ctor to avoid deleting m_files pointer twice
2223 wxDropFilesEvent(const wxDropFilesEvent
& other
)
2225 m_noFiles(other
.m_noFiles
),
2229 m_files
= new wxString
[m_noFiles
];
2230 for ( int n
= 0; n
< m_noFiles
; n
++ )
2232 m_files
[n
] = other
.m_files
[n
];
2236 virtual ~wxDropFilesEvent()
2241 wxPoint
GetPosition() const { return m_pos
; }
2242 int GetNumberOfFiles() const { return m_noFiles
; }
2243 wxString
*GetFiles() const { return m_files
; }
2245 virtual wxEvent
*Clone() const { return new wxDropFilesEvent(*this); }
2248 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDropFilesEvent
)
2256 // Whether to always send update events to windows, or
2257 // to only send update events to those with the
2258 // wxWS_EX_PROCESS_UI_UPDATES style.
2262 // Send UI update events to all windows
2263 wxUPDATE_UI_PROCESS_ALL
,
2265 // Send UI update events to windows that have
2266 // the wxWS_EX_PROCESS_UI_UPDATES flag specified
2267 wxUPDATE_UI_PROCESS_SPECIFIED
2270 class WXDLLIMPEXP_CORE wxUpdateUIEvent
: public wxCommandEvent
2273 wxUpdateUIEvent(wxWindowID commandId
= 0)
2274 : wxCommandEvent(wxEVT_UPDATE_UI
, commandId
)
2282 m_setChecked
= false;
2284 wxUpdateUIEvent(const wxUpdateUIEvent
& event
)
2285 : wxCommandEvent(event
),
2286 m_checked(event
.m_checked
),
2287 m_enabled(event
.m_enabled
),
2288 m_shown(event
.m_shown
),
2289 m_setEnabled(event
.m_setEnabled
),
2290 m_setShown(event
.m_setShown
),
2291 m_setText(event
.m_setText
),
2292 m_setChecked(event
.m_setChecked
),
2293 m_text(event
.m_text
)
2296 bool GetChecked() const { return m_checked
; }
2297 bool GetEnabled() const { return m_enabled
; }
2298 bool GetShown() const { return m_shown
; }
2299 wxString
GetText() const { return m_text
; }
2300 bool GetSetText() const { return m_setText
; }
2301 bool GetSetChecked() const { return m_setChecked
; }
2302 bool GetSetEnabled() const { return m_setEnabled
; }
2303 bool GetSetShown() const { return m_setShown
; }
2305 void Check(bool check
) { m_checked
= check
; m_setChecked
= true; }
2306 void Enable(bool enable
) { m_enabled
= enable
; m_setEnabled
= true; }
2307 void Show(bool show
) { m_shown
= show
; m_setShown
= true; }
2308 void SetText(const wxString
& text
) { m_text
= text
; m_setText
= true; }
2310 // Sets the interval between updates in milliseconds.
2311 // Set to -1 to disable updates, or to 0 to update as frequently as possible.
2312 static void SetUpdateInterval(long updateInterval
) { sm_updateInterval
= updateInterval
; }
2314 // Returns the current interval between updates in milliseconds
2315 static long GetUpdateInterval() { return sm_updateInterval
; }
2317 // Can we update this window?
2318 static bool CanUpdate(wxWindowBase
*win
);
2320 // Reset the update time to provide a delay until the next
2321 // time we should update
2322 static void ResetUpdateTime();
2324 // Specify how wxWidgets will send update events: to
2325 // all windows, or only to those which specify that they
2326 // will process the events.
2327 static void SetMode(wxUpdateUIMode mode
) { sm_updateMode
= mode
; }
2329 // Returns the UI update mode
2330 static wxUpdateUIMode
GetMode() { return sm_updateMode
; }
2332 virtual wxEvent
*Clone() const { return new wxUpdateUIEvent(*this); }
2344 static wxLongLong sm_lastUpdate
;
2346 static long sm_updateInterval
;
2347 static wxUpdateUIMode sm_updateMode
;
2350 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxUpdateUIEvent
)
2354 wxEVT_SYS_COLOUR_CHANGED
2357 // TODO: shouldn't all events record the window ID?
2358 class WXDLLIMPEXP_CORE wxSysColourChangedEvent
: public wxEvent
2361 wxSysColourChangedEvent()
2362 : wxEvent(0, wxEVT_SYS_COLOUR_CHANGED
)
2365 virtual wxEvent
*Clone() const { return new wxSysColourChangedEvent(*this); }
2368 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSysColourChangedEvent
)
2372 wxEVT_MOUSE_CAPTURE_CHANGED
2373 The window losing the capture receives this message
2374 (even if it released the capture itself).
2377 class WXDLLIMPEXP_CORE wxMouseCaptureChangedEvent
: public wxEvent
2380 wxMouseCaptureChangedEvent(wxWindowID winid
= 0, wxWindow
* gainedCapture
= NULL
)
2381 : wxEvent(winid
, wxEVT_MOUSE_CAPTURE_CHANGED
),
2382 m_gainedCapture(gainedCapture
)
2385 wxMouseCaptureChangedEvent(const wxMouseCaptureChangedEvent
& event
)
2387 m_gainedCapture(event
.m_gainedCapture
)
2390 virtual wxEvent
*Clone() const { return new wxMouseCaptureChangedEvent(*this); }
2392 wxWindow
* GetCapturedWindow() const { return m_gainedCapture
; }
2395 wxWindow
* m_gainedCapture
;
2397 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureChangedEvent
)
2401 wxEVT_MOUSE_CAPTURE_LOST
2402 The window losing the capture receives this message, unless it released it
2403 it itself or unless wxWindow::CaptureMouse was called on another window
2404 (and so capture will be restored when the new capturer releases it).
2407 class WXDLLIMPEXP_CORE wxMouseCaptureLostEvent
: public wxEvent
2410 wxMouseCaptureLostEvent(wxWindowID winid
= 0)
2411 : wxEvent(winid
, wxEVT_MOUSE_CAPTURE_LOST
)
2414 wxMouseCaptureLostEvent(const wxMouseCaptureLostEvent
& event
)
2418 virtual wxEvent
*Clone() const { return new wxMouseCaptureLostEvent(*this); }
2420 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureLostEvent
)
2424 wxEVT_DISPLAY_CHANGED
2426 class WXDLLIMPEXP_CORE wxDisplayChangedEvent
: public wxEvent
2429 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDisplayChangedEvent
)
2432 wxDisplayChangedEvent()
2433 : wxEvent(0, wxEVT_DISPLAY_CHANGED
)
2436 virtual wxEvent
*Clone() const { return new wxDisplayChangedEvent(*this); }
2440 wxEVT_PALETTE_CHANGED
2443 class WXDLLIMPEXP_CORE wxPaletteChangedEvent
: public wxEvent
2446 wxPaletteChangedEvent(wxWindowID winid
= 0)
2447 : wxEvent(winid
, wxEVT_PALETTE_CHANGED
),
2448 m_changedWindow(NULL
)
2451 wxPaletteChangedEvent(const wxPaletteChangedEvent
& event
)
2453 m_changedWindow(event
.m_changedWindow
)
2456 void SetChangedWindow(wxWindow
* win
) { m_changedWindow
= win
; }
2457 wxWindow
* GetChangedWindow() const { return m_changedWindow
; }
2459 virtual wxEvent
*Clone() const { return new wxPaletteChangedEvent(*this); }
2462 wxWindow
* m_changedWindow
;
2465 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaletteChangedEvent
)
2469 wxEVT_QUERY_NEW_PALETTE
2470 Indicates the window is getting keyboard focus and should re-do its palette.
2473 class WXDLLIMPEXP_CORE wxQueryNewPaletteEvent
: public wxEvent
2476 wxQueryNewPaletteEvent(wxWindowID winid
= 0)
2477 : wxEvent(winid
, wxEVT_QUERY_NEW_PALETTE
),
2478 m_paletteRealized(false)
2480 wxQueryNewPaletteEvent(const wxQueryNewPaletteEvent
& event
)
2482 m_paletteRealized(event
.m_paletteRealized
)
2485 // App sets this if it changes the palette.
2486 void SetPaletteRealized(bool realized
) { m_paletteRealized
= realized
; }
2487 bool GetPaletteRealized() const { return m_paletteRealized
; }
2489 virtual wxEvent
*Clone() const { return new wxQueryNewPaletteEvent(*this); }
2492 bool m_paletteRealized
;
2495 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxQueryNewPaletteEvent
)
2499 Event generated by dialog navigation keys
2500 wxEVT_NAVIGATION_KEY
2502 // NB: don't derive from command event to avoid being propagated to the parent
2503 class WXDLLIMPEXP_CORE wxNavigationKeyEvent
: public wxEvent
2506 wxNavigationKeyEvent()
2507 : wxEvent(0, wxEVT_NAVIGATION_KEY
),
2508 m_flags(IsForward
| FromTab
), // defaults are for TAB
2511 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
2514 wxNavigationKeyEvent(const wxNavigationKeyEvent
& event
)
2516 m_flags(event
.m_flags
),
2517 m_focus(event
.m_focus
)
2520 // direction: forward (true) or backward (false)
2521 bool GetDirection() const
2522 { return (m_flags
& IsForward
) != 0; }
2523 void SetDirection(bool bForward
)
2524 { if ( bForward
) m_flags
|= IsForward
; else m_flags
&= ~IsForward
; }
2526 // it may be a window change event (MDI, notebook pages...) or a control
2528 bool IsWindowChange() const
2529 { return (m_flags
& WinChange
) != 0; }
2530 void SetWindowChange(bool bIs
)
2531 { if ( bIs
) m_flags
|= WinChange
; else m_flags
&= ~WinChange
; }
2533 // Set to true under MSW if the event was generated using the tab key.
2534 // This is required for proper navogation over radio buttons
2535 bool IsFromTab() const
2536 { return (m_flags
& FromTab
) != 0; }
2537 void SetFromTab(bool bIs
)
2538 { if ( bIs
) m_flags
|= FromTab
; else m_flags
&= ~FromTab
; }
2540 // the child which has the focus currently (may be NULL - use
2541 // wxWindow::FindFocus then)
2542 wxWindow
* GetCurrentFocus() const { return m_focus
; }
2543 void SetCurrentFocus(wxWindow
*win
) { m_focus
= win
; }
2546 void SetFlags(long flags
) { m_flags
= flags
; }
2548 virtual wxEvent
*Clone() const { return new wxNavigationKeyEvent(*this); }
2550 enum wxNavigationKeyEventFlags
2552 IsBackward
= 0x0000,
2562 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNavigationKeyEvent
)
2565 // Window creation/destruction events: the first is sent as soon as window is
2566 // created (i.e. the underlying GUI object exists), but when the C++ object is
2567 // fully initialized (so virtual functions may be called). The second,
2568 // wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
2569 // still safe to call virtual functions at this moment
2575 class WXDLLIMPEXP_CORE wxWindowCreateEvent
: public wxCommandEvent
2578 wxWindowCreateEvent(wxWindow
*win
= NULL
);
2580 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
2582 virtual wxEvent
*Clone() const { return new wxWindowCreateEvent(*this); }
2585 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowCreateEvent
)
2588 class WXDLLIMPEXP_CORE wxWindowDestroyEvent
: public wxCommandEvent
2591 wxWindowDestroyEvent(wxWindow
*win
= NULL
);
2593 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
2595 virtual wxEvent
*Clone() const { return new wxWindowDestroyEvent(*this); }
2598 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowDestroyEvent
)
2601 // A help event is sent when the user clicks on a window in context-help mode.
2607 class WXDLLIMPEXP_CORE wxHelpEvent
: public wxCommandEvent
2610 // how was this help event generated?
2613 Origin_Unknown
, // unrecognized event source
2614 Origin_Keyboard
, // event generated from F1 key press
2615 Origin_HelpButton
// event from [?] button on the title bar (Windows)
2618 wxHelpEvent(wxEventType type
= wxEVT_NULL
,
2619 wxWindowID winid
= 0,
2620 const wxPoint
& pt
= wxDefaultPosition
,
2621 Origin origin
= Origin_Unknown
)
2622 : wxCommandEvent(type
, winid
),
2624 m_origin(GuessOrigin(origin
))
2626 wxHelpEvent(const wxHelpEvent
& event
)
2627 : wxCommandEvent(event
),
2629 m_target(event
.m_target
),
2630 m_link(event
.m_link
),
2631 m_origin(event
.m_origin
)
2634 // Position of event (in screen coordinates)
2635 const wxPoint
& GetPosition() const { return m_pos
; }
2636 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2638 // Optional link to further help
2639 const wxString
& GetLink() const { return m_link
; }
2640 void SetLink(const wxString
& link
) { m_link
= link
; }
2642 // Optional target to display help in. E.g. a window specification
2643 const wxString
& GetTarget() const { return m_target
; }
2644 void SetTarget(const wxString
& target
) { m_target
= target
; }
2646 virtual wxEvent
*Clone() const { return new wxHelpEvent(*this); }
2648 // optional indication of the event source
2649 Origin
GetOrigin() const { return m_origin
; }
2650 void SetOrigin(Origin origin
) { m_origin
= origin
; }
2658 // we can try to guess the event origin ourselves, even if none is
2659 // specified in the ctor
2660 static Origin
GuessOrigin(Origin origin
);
2663 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHelpEvent
)
2666 // A Clipboard Text event is sent when a window intercepts text copy/cut/paste
2667 // message, i.e. the user has cut/copied/pasted data from/into a text control
2668 // via ctrl-C/X/V, ctrl/shift-del/insert, a popup menu command, etc.
2669 // NOTE : under windows these events are *NOT* generated automatically
2670 // for a Rich Edit text control.
2672 wxEVT_COMMAND_TEXT_COPY
2673 wxEVT_COMMAND_TEXT_CUT
2674 wxEVT_COMMAND_TEXT_PASTE
2677 class WXDLLIMPEXP_CORE wxClipboardTextEvent
: public wxCommandEvent
2680 wxClipboardTextEvent(wxEventType type
= wxEVT_NULL
,
2681 wxWindowID winid
= 0)
2682 : wxCommandEvent(type
, winid
)
2684 wxClipboardTextEvent(const wxClipboardTextEvent
& event
)
2685 : wxCommandEvent(event
)
2688 virtual wxEvent
*Clone() const { return new wxClipboardTextEvent(*this); }
2691 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxClipboardTextEvent
)
2694 // A Context event is sent when the user right clicks on a window or
2695 // presses Shift-F10
2696 // NOTE : Under windows this is a repackaged WM_CONTETXMENU message
2697 // Under other systems it may have to be generated from a right click event
2702 class WXDLLIMPEXP_CORE wxContextMenuEvent
: public wxCommandEvent
2705 wxContextMenuEvent(wxEventType type
= wxEVT_NULL
,
2706 wxWindowID winid
= 0,
2707 const wxPoint
& pt
= wxDefaultPosition
)
2708 : wxCommandEvent(type
, winid
),
2711 wxContextMenuEvent(const wxContextMenuEvent
& event
)
2712 : wxCommandEvent(event
),
2716 // Position of event (in screen coordinates)
2717 const wxPoint
& GetPosition() const { return m_pos
; }
2718 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2720 virtual wxEvent
*Clone() const { return new wxContextMenuEvent(*this); }
2726 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxContextMenuEvent
)
2736 // Whether to always send idle events to windows, or
2737 // to only send update events to those with the
2738 // wxWS_EX_PROCESS_IDLE style.
2742 // Send idle events to all windows
2745 // Send idle events to windows that have
2746 // the wxWS_EX_PROCESS_IDLE flag specified
2747 wxIDLE_PROCESS_SPECIFIED
2750 class WXDLLIMPEXP_BASE wxIdleEvent
: public wxEvent
2754 : wxEvent(0, wxEVT_IDLE
),
2755 m_requestMore(false)
2757 wxIdleEvent(const wxIdleEvent
& event
)
2759 m_requestMore(event
.m_requestMore
)
2762 void RequestMore(bool needMore
= true) { m_requestMore
= needMore
; }
2763 bool MoreRequested() const { return m_requestMore
; }
2765 virtual wxEvent
*Clone() const { return new wxIdleEvent(*this); }
2767 // Specify how wxWidgets will send idle events: to
2768 // all windows, or only to those which specify that they
2769 // will process the events.
2770 static void SetMode(wxIdleMode mode
) { sm_idleMode
= mode
; }
2772 // Returns the idle event mode
2773 static wxIdleMode
GetMode() { return sm_idleMode
; }
2777 static wxIdleMode sm_idleMode
;
2780 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIdleEvent
)
2784 wxEVT_MOUSE_CAPTURE_CHANGED,
2785 wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
2786 // wxEVT_FONT_CHANGED, // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
2787 // wxEVT_FONT_CHANGED to all other windows (maybe).
2788 wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
2795 // ============================================================================
2796 // event handler and related classes
2797 // ============================================================================
2800 // struct containing the members common to static and dynamic event tables
2802 struct WXDLLIMPEXP_BASE wxEventTableEntryBase
2804 wxEventTableEntryBase(int winid
, int idLast
,
2805 wxEventFunctor
* fn
, wxObject
*data
)
2809 m_callbackUserData(data
)
2811 wxASSERT_MSG( idLast
== wxID_ANY
|| winid
<= idLast
,
2812 "invalid IDs range: lower bound > upper bound" );
2815 wxEventTableEntryBase( const wxEventTableEntryBase
&entry
)
2816 : m_id( entry
.m_id
),
2817 m_lastId( entry
.m_lastId
),
2819 m_callbackUserData( entry
.m_callbackUserData
)
2821 // This is a 'hack' to ensure that only one instance tries to delete
2822 // the functor pointer. It is safe as long as the only place where the
2823 // copy constructor is being called is when the static event tables are
2824 // being initialized (a temporary instance is created and then this
2825 // constructor is called).
2827 const_cast<wxEventTableEntryBase
&>( entry
).m_fn
= NULL
;
2830 ~wxEventTableEntryBase()
2835 // the range of ids for this entry: if m_lastId == wxID_ANY, the range
2836 // consists only of m_id, otherwise it is m_id..m_lastId inclusive
2840 // function/method/functor to call
2841 wxEventFunctor
* m_fn
;
2843 // arbitrary user data associated with the callback
2844 wxObject
* m_callbackUserData
;
2847 wxDECLARE_NO_ASSIGN_CLASS(wxEventTableEntryBase
);
2850 // an entry from a static event table
2851 struct WXDLLIMPEXP_BASE wxEventTableEntry
: public wxEventTableEntryBase
2853 wxEventTableEntry(const int& evType
, int winid
, int idLast
,
2854 wxEventFunctor
* fn
, wxObject
*data
)
2855 : wxEventTableEntryBase(winid
, idLast
, fn
, data
),
2859 // the reference to event type: this allows us to not care about the
2860 // (undefined) order in which the event table entries and the event types
2861 // are initialized: initially the value of this reference might be
2862 // invalid, but by the time it is used for the first time, all global
2863 // objects will have been initialized (including the event type constants)
2864 // and so it will have the correct value when it is needed
2865 const int& m_eventType
;
2868 wxDECLARE_NO_ASSIGN_CLASS(wxEventTableEntry
);
2871 // an entry used in dynamic event table managed by wxEvtHandler::Connect()
2872 struct WXDLLIMPEXP_BASE wxDynamicEventTableEntry
: public wxEventTableEntryBase
2874 wxDynamicEventTableEntry(int evType
, int winid
, int idLast
,
2875 wxEventFunctor
* fn
, wxObject
*data
)
2876 : wxEventTableEntryBase(winid
, idLast
, fn
, data
),
2880 // not a reference here as we can't keep a reference to a temporary int
2881 // created to wrap the constant value typically passed to Connect() - nor
2886 wxDECLARE_NO_ASSIGN_CLASS(wxDynamicEventTableEntry
);
2889 // ----------------------------------------------------------------------------
2890 // wxEventTable: an array of event entries terminated with {0, 0, 0, 0, 0}
2891 // ----------------------------------------------------------------------------
2893 struct WXDLLIMPEXP_BASE wxEventTable
2895 const wxEventTable
*baseTable
; // base event table (next in chain)
2896 const wxEventTableEntry
*entries
; // bottom of entry array
2899 // ----------------------------------------------------------------------------
2900 // wxEventHashTable: a helper of wxEvtHandler to speed up wxEventTable lookups.
2901 // ----------------------------------------------------------------------------
2903 WX_DEFINE_ARRAY_PTR(const wxEventTableEntry
*, wxEventTableEntryPointerArray
);
2905 class WXDLLIMPEXP_BASE wxEventHashTable
2908 // Internal data structs
2909 struct EventTypeTable
2911 wxEventType eventType
;
2912 wxEventTableEntryPointerArray eventEntryTable
;
2914 typedef EventTypeTable
* EventTypeTablePointer
;
2917 // Constructor, needs the event table it needs to hash later on.
2918 // Note: hashing of the event table is not done in the constructor as it
2919 // can be that the event table is not yet full initialize, the hash
2920 // will gets initialized when handling the first event look-up request.
2921 wxEventHashTable(const wxEventTable
&table
);
2923 ~wxEventHashTable();
2925 // Handle the given event, in other words search the event table hash
2926 // and call self->ProcessEvent() if a match was found.
2927 bool HandleEvent(wxEvent
& event
, wxEvtHandler
*self
);
2932 #if wxUSE_MEMORY_TRACING
2933 // Clear all tables: only used to work around problems in memory tracing
2935 static void ClearAll();
2936 #endif // wxUSE_MEMORY_TRACING
2939 // Init the hash table with the entries of the static event table.
2940 void InitHashTable();
2941 // Helper funtion of InitHashTable() to insert 1 entry into the hash table.
2942 void AddEntry(const wxEventTableEntry
&entry
);
2943 // Allocate and init with null pointers the base hash table.
2944 void AllocEventTypeTable(size_t size
);
2945 // Grow the hash table in size and transfer all items currently
2946 // in the table to the correct location in the new table.
2947 void GrowEventTypeTable();
2950 const wxEventTable
&m_table
;
2954 EventTypeTablePointer
*m_eventTypeTable
;
2956 static wxEventHashTable
* sm_first
;
2957 wxEventHashTable
* m_previous
;
2958 wxEventHashTable
* m_next
;
2960 wxDECLARE_NO_COPY_CLASS(wxEventHashTable
);
2963 // ----------------------------------------------------------------------------
2964 // wxEvtHandler: the base class for all objects handling wxWidgets events
2965 // ----------------------------------------------------------------------------
2967 class WXDLLIMPEXP_BASE wxEvtHandler
: public wxObject
2968 , public wxTrackable
2972 virtual ~wxEvtHandler();
2975 // Event handler chain
2976 // -------------------
2978 wxEvtHandler
*GetNextHandler() const { return m_nextHandler
; }
2979 wxEvtHandler
*GetPreviousHandler() const { return m_previousHandler
; }
2980 virtual void SetNextHandler(wxEvtHandler
*handler
) { m_nextHandler
= handler
; }
2981 virtual void SetPreviousHandler(wxEvtHandler
*handler
) { m_previousHandler
= handler
; }
2983 void SetEvtHandlerEnabled(bool enabled
) { m_enabled
= enabled
; }
2984 bool GetEvtHandlerEnabled() const { return m_enabled
; }
2987 bool IsUnlinked() const;
2991 // Event queuing and processing
2992 // ----------------------------
2994 // Process an event right now: this can only be called from the main
2995 // thread, use QueueEvent() for scheduling the events for
2996 // processing from other threads.
2997 virtual bool ProcessEvent(wxEvent
& event
);
2999 // Process an event by calling ProcessEvent and handling any exceptions
3000 // thrown by event handlers. It's mostly useful when processing wx events
3001 // when called from C code (e.g. in GTK+ callback) when the exception
3002 // wouldn't correctly propagate to wxEventLoop.
3003 bool SafelyProcessEvent(wxEvent
& event
);
3004 // NOTE: uses ProcessEvent()
3006 // This method tries to process the event in this event handler, including
3007 // any preprocessing done by TryBefore() and all the handlers chained to
3008 // it, but excluding the post-processing done in TryAfter().
3010 // It is meant to be called from ProcessEvent() only and is not virtual,
3011 // additional event handlers can be hooked into the normal event processing
3012 // logic using TryBefore() and TryAfter() hooks.
3014 // You can also call it yourself to forward an event to another handler but
3015 // without propagating it upwards if it's unhandled (this is usually
3016 // unwanted when forwarding as the original handler would already do it if
3017 // needed normally).
3018 bool ProcessEventLocally(wxEvent
& event
);
3020 // Schedule the given event to be processed later. It takes ownership of
3021 // the event pointer, i.e. it will be deleted later. This is safe to call
3022 // from multiple threads although you still need to ensure that wxString
3023 // fields of the event object are deep copies and not use the same string
3024 // buffer as other wxString objects in this thread.
3025 virtual void QueueEvent(wxEvent
*event
);
3027 // Add an event to be processed later: notice that this function is not
3028 // safe to call from threads other than main, use QueueEvent()
3029 virtual void AddPendingEvent(const wxEvent
& event
)
3031 // notice that the thread-safety problem comes from the fact that
3032 // Clone() doesn't make deep copies of wxString fields of wxEvent
3033 // object and so the same wxString could be used from both threads when
3034 // the event object is destroyed in this one -- QueueEvent() avoids
3035 // this problem as the event pointer is not used any more in this
3036 // thread at all after it is called.
3037 QueueEvent(event
.Clone());
3040 void ProcessPendingEvents();
3041 // NOTE: uses ProcessEvent()
3043 void DeletePendingEvents();
3046 bool ProcessThreadEvent(const wxEvent
& event
);
3047 // NOTE: uses AddPendingEvent(); call only from secondary threads
3051 // Connecting and disconnecting
3052 // ----------------------------
3054 // These functions are used for old, untyped, event handlers and don't
3055 // check that the type of the function passed to them actually matches the
3056 // type of the event. They also only allow connecting events to methods of
3057 // wxEvtHandler-derived classes.
3059 // The template Connect() methods below are safer and allow connecting
3060 // events to arbitrary functions or functors -- but require compiler
3061 // support for templates.
3063 // Dynamic association of a member function handler with the event handler,
3064 // winid and event type
3065 void Connect(int winid
,
3067 wxEventType eventType
,
3068 wxObjectEventFunction func
,
3069 wxObject
*userData
= NULL
,
3070 wxEvtHandler
*eventSink
= NULL
)
3072 DoBind(winid
, lastId
, eventType
,
3073 wxNewEventFunctor(eventType
, func
, eventSink
),
3077 // Convenience function: take just one id
3078 void Connect(int winid
,
3079 wxEventType eventType
,
3080 wxObjectEventFunction func
,
3081 wxObject
*userData
= NULL
,
3082 wxEvtHandler
*eventSink
= NULL
)
3083 { Connect(winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3085 // Even more convenient: without id (same as using id of wxID_ANY)
3086 void Connect(wxEventType eventType
,
3087 wxObjectEventFunction func
,
3088 wxObject
*userData
= NULL
,
3089 wxEvtHandler
*eventSink
= NULL
)
3090 { Connect(wxID_ANY
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3092 bool Disconnect(int winid
,
3094 wxEventType eventType
,
3095 wxObjectEventFunction func
= NULL
,
3096 wxObject
*userData
= NULL
,
3097 wxEvtHandler
*eventSink
= NULL
)
3099 return DoUnbind(winid
, lastId
, eventType
,
3100 wxMakeEventFunctor(eventType
, func
, eventSink
),
3104 bool Disconnect(int winid
= wxID_ANY
,
3105 wxEventType eventType
= wxEVT_NULL
,
3106 wxObjectEventFunction func
= NULL
,
3107 wxObject
*userData
= NULL
,
3108 wxEvtHandler
*eventSink
= NULL
)
3109 { return Disconnect(winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3111 bool Disconnect(wxEventType eventType
,
3112 wxObjectEventFunction func
,
3113 wxObject
*userData
= NULL
,
3114 wxEvtHandler
*eventSink
= NULL
)
3115 { return Disconnect(wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3117 #ifdef wxHAS_EVENT_BIND
3118 // Bind functions to an event:
3119 template <typename EventTag
, typename EventArg
>
3120 void Bind(const EventTag
& eventType
,
3121 void (*function
)(EventArg
&),
3122 int winid
= wxID_ANY
,
3123 int lastId
= wxID_ANY
,
3124 wxObject
*userData
= NULL
)
3126 DoBind(winid
, lastId
, eventType
,
3127 wxNewEventFunctor(eventType
, function
),
3132 template <typename EventTag
, typename EventArg
>
3133 bool Unbind(const EventTag
& eventType
,
3134 void (*function
)(EventArg
&),
3135 int winid
= wxID_ANY
,
3136 int lastId
= wxID_ANY
,
3137 wxObject
*userData
= NULL
)
3139 return DoUnbind(winid
, lastId
, eventType
,
3140 wxMakeEventFunctor(eventType
, function
),
3144 // Bind functors to an event:
3145 template <typename EventTag
, typename Functor
>
3146 void Bind(const EventTag
& eventType
,
3147 const Functor
&functor
,
3148 int winid
= wxID_ANY
,
3149 int lastId
= wxID_ANY
,
3150 wxObject
*userData
= NULL
)
3152 DoBind(winid
, lastId
, eventType
,
3153 wxNewEventFunctor(eventType
, functor
),
3158 template <typename EventTag
, typename Functor
>
3159 bool Unbind(const EventTag
& eventType
,
3160 const Functor
&functor
,
3161 int winid
= wxID_ANY
,
3162 int lastId
= wxID_ANY
,
3163 wxObject
*userData
= NULL
)
3165 return DoUnbind(winid
, lastId
, eventType
,
3166 wxMakeEventFunctor(eventType
, functor
),
3171 // Bind a method of a class (called on the specified handler which must
3172 // be convertible to this class) object to an event:
3174 template <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
3175 void Bind(const EventTag
&eventType
,
3176 void (Class::*method
)(EventArg
&),
3177 EventHandler
*handler
,
3178 int winid
= wxID_ANY
,
3179 int lastId
= wxID_ANY
,
3180 wxObject
*userData
= NULL
)
3182 DoBind(winid
, lastId
, eventType
,
3183 wxNewEventFunctor(eventType
, method
, handler
),
3187 template <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
3188 bool Unbind(const EventTag
&eventType
,
3189 void (Class::*method
)(EventArg
&),
3190 EventHandler
*handler
,
3191 int winid
= wxID_ANY
,
3192 int lastId
= wxID_ANY
,
3193 wxObject
*userData
= NULL
)
3195 return DoUnbind(winid
, lastId
, eventType
,
3196 wxMakeEventFunctor(eventType
, method
, handler
),
3199 #endif // wxHAS_EVENT_BIND
3201 wxList
* GetDynamicEventTable() const { return m_dynamicEvents
; }
3203 // User data can be associated with each wxEvtHandler
3204 void SetClientObject( wxClientData
*data
) { DoSetClientObject(data
); }
3205 wxClientData
*GetClientObject() const { return DoGetClientObject(); }
3207 void SetClientData( void *data
) { DoSetClientData(data
); }
3208 void *GetClientData() const { return DoGetClientData(); }
3211 // implementation from now on
3212 // --------------------------
3214 // check if the given event table entry matches this event by id (the check
3215 // for the event type should be done by caller) and call the handler if it
3218 // return true if the event was processed, false otherwise (no match or the
3219 // handler decided to skip the event)
3220 static bool ProcessEventIfMatchesId(const wxEventTableEntryBase
& tableEntry
,
3221 wxEvtHandler
*handler
,
3224 virtual bool SearchEventTable(wxEventTable
& table
, wxEvent
& event
);
3225 bool SearchDynamicEventTable( wxEvent
& event
);
3227 // Avoid problems at exit by cleaning up static hash table gracefully
3228 void ClearEventHashTable() { GetEventHashTable().Clear(); }
3229 void OnSinkDestroyed( wxEvtHandler
*sink
);
3233 void DoBind(int winid
,
3235 wxEventType eventType
,
3236 wxEventFunctor
*func
,
3237 wxObject
* userData
= NULL
);
3239 bool DoUnbind(int winid
,
3241 wxEventType eventType
,
3242 const wxEventFunctor
& func
,
3243 wxObject
*userData
= NULL
);
3245 static const wxEventTableEntry sm_eventTableEntries
[];
3248 // hooks for wxWindow used by ProcessEvent()
3249 // -----------------------------------------
3251 // this one is called before trying our own event table to allow plugging
3252 // in the event handlers overriding the default logic, this is used by e.g.
3254 virtual bool TryBefore(wxEvent
& event
);
3256 // This one is not a hook but just a helper which looks up the handler in
3257 // this object itself.
3259 // It is called from ProcessEventLocally() and normally shouldn't be called
3260 // directly as doing it would ignore any chained event handlers
3261 bool TryHereOnly(wxEvent
& event
);
3263 // Another helper which simply calls pre-processing hook and then tries to
3264 // handle the event at this handler level.
3265 bool TryBeforeAndHere(wxEvent
& event
)
3267 return TryBefore(event
) || TryHereOnly(event
);
3270 // this one is called after failing to find the event handle in our own
3271 // table to give a chance to the other windows to process it
3273 // base class implementation passes the event to wxTheApp
3274 virtual bool TryAfter(wxEvent
& event
);
3276 #ifdef WXWIN_COMPATIBILITY_2_8
3277 // deprecated method: override TryBefore() instead of this one
3278 wxDEPRECATED_BUT_USED_INTERNALLY_INLINE(
3279 virtual bool TryValidator(wxEvent
& WXUNUSED(event
)), return false; )
3281 wxDEPRECATED_BUT_USED_INTERNALLY_INLINE(
3282 virtual bool TryParent(wxEvent
& event
), return DoTryApp(event
); )
3283 #endif // WXWIN_COMPATIBILITY_2_8
3286 static const wxEventTable sm_eventTable
;
3287 virtual const wxEventTable
*GetEventTable() const;
3289 static wxEventHashTable sm_eventHashTable
;
3290 virtual wxEventHashTable
& GetEventHashTable() const;
3292 wxEvtHandler
* m_nextHandler
;
3293 wxEvtHandler
* m_previousHandler
;
3294 wxList
* m_dynamicEvents
;
3295 wxList
* m_pendingEvents
;
3298 // critical section protecting m_pendingEvents
3299 wxCriticalSection m_pendingEventsLock
;
3300 #endif // wxUSE_THREADS
3302 // Is event handler enabled?
3306 // The user data: either an object which will be deleted by the container
3307 // when it's deleted or some raw pointer which we do nothing with - only
3308 // one type of data can be used with the given window (i.e. you cannot set
3309 // the void data and then associate the container with wxClientData or vice
3313 wxClientData
*m_clientObject
;
3317 // what kind of data do we have?
3318 wxClientDataType m_clientDataType
;
3320 // client data accessors
3321 virtual void DoSetClientObject( wxClientData
*data
);
3322 virtual wxClientData
*DoGetClientObject() const;
3324 virtual void DoSetClientData( void *data
);
3325 virtual void *DoGetClientData() const;
3327 // Search tracker objects for event connection with this sink
3328 wxEventConnectionRef
*FindRefInTrackerList(wxEvtHandler
*handler
);
3331 // pass the event to wxTheApp instance, called from TryAfter()
3332 bool DoTryApp(wxEvent
& event
);
3334 // try to process events in all handlers chained to this one
3335 bool DoTryChain(wxEvent
& event
);
3337 DECLARE_DYNAMIC_CLASS_NO_COPY(wxEvtHandler
)
3340 WX_DEFINE_ARRAY_WITH_DECL_PTR(wxEvtHandler
*, wxEvtHandlerArray
, class WXDLLIMPEXP_BASE
);
3343 // Define an inline method of wxObjectEventFunctor which couldn't be defined
3344 // before wxEvtHandler declaration: at least Sun CC refuses to compile function
3345 // calls through pointer to member for forward-declared classes (see #12452).
3346 inline void wxObjectEventFunctor::operator()(wxEvtHandler
*handler
, wxEvent
& event
)
3348 wxEvtHandler
* const realHandler
= m_handler
? m_handler
: handler
;
3350 (realHandler
->*m_method
)(event
);
3353 // ----------------------------------------------------------------------------
3354 // wxEventConnectionRef represents all connections between two event handlers
3355 // and enables automatic disconnect when an event handler sink goes out of
3356 // scope. Each connection/disconnect increases/decreases ref count, and
3357 // when it reaches zero the node goes out of scope.
3358 // ----------------------------------------------------------------------------
3360 class wxEventConnectionRef
: public wxTrackerNode
3363 wxEventConnectionRef() : m_src(NULL
), m_sink(NULL
), m_refCount(0) { }
3364 wxEventConnectionRef(wxEvtHandler
*src
, wxEvtHandler
*sink
)
3365 : m_src(src
), m_sink(sink
), m_refCount(1)
3367 m_sink
->AddNode(this);
3370 // The sink is being destroyed
3371 virtual void OnObjectDestroy( )
3374 m_src
->OnSinkDestroyed( m_sink
);
3378 virtual wxEventConnectionRef
*ToEventConnection() { return this; }
3380 void IncRef() { m_refCount
++; }
3383 if ( !--m_refCount
)
3385 // The sink holds the only external pointer to this object
3387 m_sink
->RemoveNode(this);
3393 wxEvtHandler
*m_src
,
3397 friend class wxEvtHandler
;
3399 wxDECLARE_NO_ASSIGN_CLASS(wxEventConnectionRef
);
3402 // Post a message to the given event handler which will be processed during the
3403 // next event loop iteration.
3405 // Notice that this one is not thread-safe, use wxQueueEvent()
3406 inline void wxPostEvent(wxEvtHandler
*dest
, const wxEvent
& event
)
3408 wxCHECK_RET( dest
, "need an object to post event to" );
3410 dest
->AddPendingEvent(event
);
3413 // Wrapper around wxEvtHandler::QueueEvent(): adds an event for later
3414 // processing, unlike wxPostEvent it is safe to use from different thread even
3415 // for events with wxString members
3416 inline void wxQueueEvent(wxEvtHandler
*dest
, wxEvent
*event
)
3418 wxCHECK_RET( dest
, "need an object to queue event for" );
3420 dest
->QueueEvent(event
);
3423 typedef void (wxEvtHandler::*wxEventFunction
)(wxEvent
&);
3424 typedef void (wxEvtHandler::*wxIdleEventFunction
)(wxIdleEvent
&);
3426 #define wxEventHandler(func) \
3427 wxEVENT_HANDLER_CAST(wxEventFunction, func)
3428 #define wxIdleEventHandler(func) \
3429 wxEVENT_HANDLER_CAST(wxIdleEventFunction, func)
3433 // ----------------------------------------------------------------------------
3434 // wxEventBlocker: helper class to temporarily disable event handling for a window
3435 // ----------------------------------------------------------------------------
3437 class WXDLLIMPEXP_CORE wxEventBlocker
: public wxEvtHandler
3440 wxEventBlocker(wxWindow
*win
, wxEventType type
= wxEVT_ANY
);
3441 virtual ~wxEventBlocker();
3443 void Block(wxEventType type
)
3445 m_eventsToBlock
.push_back(type
);
3448 virtual bool ProcessEvent(wxEvent
& event
);
3451 wxArrayInt m_eventsToBlock
;
3454 wxDECLARE_NO_COPY_CLASS(wxEventBlocker
);
3457 typedef void (wxEvtHandler::*wxCommandEventFunction
)(wxCommandEvent
&);
3458 typedef void (wxEvtHandler::*wxThreadEventFunction
)(wxThreadEvent
&);
3459 typedef void (wxEvtHandler::*wxScrollEventFunction
)(wxScrollEvent
&);
3460 typedef void (wxEvtHandler::*wxScrollWinEventFunction
)(wxScrollWinEvent
&);
3461 typedef void (wxEvtHandler::*wxSizeEventFunction
)(wxSizeEvent
&);
3462 typedef void (wxEvtHandler::*wxMoveEventFunction
)(wxMoveEvent
&);
3463 typedef void (wxEvtHandler::*wxPaintEventFunction
)(wxPaintEvent
&);
3464 typedef void (wxEvtHandler::*wxNcPaintEventFunction
)(wxNcPaintEvent
&);
3465 typedef void (wxEvtHandler::*wxEraseEventFunction
)(wxEraseEvent
&);
3466 typedef void (wxEvtHandler::*wxMouseEventFunction
)(wxMouseEvent
&);
3467 typedef void (wxEvtHandler::*wxCharEventFunction
)(wxKeyEvent
&);
3468 typedef void (wxEvtHandler::*wxFocusEventFunction
)(wxFocusEvent
&);
3469 typedef void (wxEvtHandler::*wxChildFocusEventFunction
)(wxChildFocusEvent
&);
3470 typedef void (wxEvtHandler::*wxActivateEventFunction
)(wxActivateEvent
&);
3471 typedef void (wxEvtHandler::*wxMenuEventFunction
)(wxMenuEvent
&);
3472 typedef void (wxEvtHandler::*wxJoystickEventFunction
)(wxJoystickEvent
&);
3473 typedef void (wxEvtHandler::*wxDropFilesEventFunction
)(wxDropFilesEvent
&);
3474 typedef void (wxEvtHandler::*wxInitDialogEventFunction
)(wxInitDialogEvent
&);
3475 typedef void (wxEvtHandler::*wxSysColourChangedEventFunction
)(wxSysColourChangedEvent
&);
3476 typedef void (wxEvtHandler::*wxDisplayChangedEventFunction
)(wxDisplayChangedEvent
&);
3477 typedef void (wxEvtHandler::*wxUpdateUIEventFunction
)(wxUpdateUIEvent
&);
3478 typedef void (wxEvtHandler::*wxCloseEventFunction
)(wxCloseEvent
&);
3479 typedef void (wxEvtHandler::*wxShowEventFunction
)(wxShowEvent
&);
3480 typedef void (wxEvtHandler::*wxIconizeEventFunction
)(wxIconizeEvent
&);
3481 typedef void (wxEvtHandler::*wxMaximizeEventFunction
)(wxMaximizeEvent
&);
3482 typedef void (wxEvtHandler::*wxNavigationKeyEventFunction
)(wxNavigationKeyEvent
&);
3483 typedef void (wxEvtHandler::*wxPaletteChangedEventFunction
)(wxPaletteChangedEvent
&);
3484 typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction
)(wxQueryNewPaletteEvent
&);
3485 typedef void (wxEvtHandler::*wxWindowCreateEventFunction
)(wxWindowCreateEvent
&);
3486 typedef void (wxEvtHandler::*wxWindowDestroyEventFunction
)(wxWindowDestroyEvent
&);
3487 typedef void (wxEvtHandler::*wxSetCursorEventFunction
)(wxSetCursorEvent
&);
3488 typedef void (wxEvtHandler::*wxNotifyEventFunction
)(wxNotifyEvent
&);
3489 typedef void (wxEvtHandler::*wxHelpEventFunction
)(wxHelpEvent
&);
3490 typedef void (wxEvtHandler::*wxContextMenuEventFunction
)(wxContextMenuEvent
&);
3491 typedef void (wxEvtHandler::*wxMouseCaptureChangedEventFunction
)(wxMouseCaptureChangedEvent
&);
3492 typedef void (wxEvtHandler::*wxMouseCaptureLostEventFunction
)(wxMouseCaptureLostEvent
&);
3493 typedef void (wxEvtHandler::*wxClipboardTextEventFunction
)(wxClipboardTextEvent
&);
3496 #define wxCommandEventHandler(func) \
3497 wxEVENT_HANDLER_CAST(wxCommandEventFunction, func)
3498 #define wxThreadEventHandler(func) \
3499 wxEVENT_HANDLER_CAST(wxThreadEventFunction, func)
3500 #define wxScrollEventHandler(func) \
3501 wxEVENT_HANDLER_CAST(wxScrollEventFunction, func)
3502 #define wxScrollWinEventHandler(func) \
3503 wxEVENT_HANDLER_CAST(wxScrollWinEventFunction, func)
3504 #define wxSizeEventHandler(func) \
3505 wxEVENT_HANDLER_CAST(wxSizeEventFunction, func)
3506 #define wxMoveEventHandler(func) \
3507 wxEVENT_HANDLER_CAST(wxMoveEventFunction, func)
3508 #define wxPaintEventHandler(func) \
3509 wxEVENT_HANDLER_CAST(wxPaintEventFunction, func)
3510 #define wxNcPaintEventHandler(func) \
3511 wxEVENT_HANDLER_CAST(wxNcPaintEventFunction, func)
3512 #define wxEraseEventHandler(func) \
3513 wxEVENT_HANDLER_CAST(wxEraseEventFunction, func)
3514 #define wxMouseEventHandler(func) \
3515 wxEVENT_HANDLER_CAST(wxMouseEventFunction, func)
3516 #define wxCharEventHandler(func) \
3517 wxEVENT_HANDLER_CAST(wxCharEventFunction, func)
3518 #define wxKeyEventHandler(func) wxCharEventHandler(func)
3519 #define wxFocusEventHandler(func) \
3520 wxEVENT_HANDLER_CAST(wxFocusEventFunction, func)
3521 #define wxChildFocusEventHandler(func) \
3522 wxEVENT_HANDLER_CAST(wxChildFocusEventFunction, func)
3523 #define wxActivateEventHandler(func) \
3524 wxEVENT_HANDLER_CAST(wxActivateEventFunction, func)
3525 #define wxMenuEventHandler(func) \
3526 wxEVENT_HANDLER_CAST(wxMenuEventFunction, func)
3527 #define wxJoystickEventHandler(func) \
3528 wxEVENT_HANDLER_CAST(wxJoystickEventFunction, func)
3529 #define wxDropFilesEventHandler(func) \
3530 wxEVENT_HANDLER_CAST(wxDropFilesEventFunction, func)
3531 #define wxInitDialogEventHandler(func) \
3532 wxEVENT_HANDLER_CAST(wxInitDialogEventFunction, func)
3533 #define wxSysColourChangedEventHandler(func) \
3534 wxEVENT_HANDLER_CAST(wxSysColourChangedEventFunction, func)
3535 #define wxDisplayChangedEventHandler(func) \
3536 wxEVENT_HANDLER_CAST(wxDisplayChangedEventFunction, func)
3537 #define wxUpdateUIEventHandler(func) \
3538 wxEVENT_HANDLER_CAST(wxUpdateUIEventFunction, func)
3539 #define wxCloseEventHandler(func) \
3540 wxEVENT_HANDLER_CAST(wxCloseEventFunction, func)
3541 #define wxShowEventHandler(func) \
3542 wxEVENT_HANDLER_CAST(wxShowEventFunction, func)
3543 #define wxIconizeEventHandler(func) \
3544 wxEVENT_HANDLER_CAST(wxIconizeEventFunction, func)
3545 #define wxMaximizeEventHandler(func) \
3546 wxEVENT_HANDLER_CAST(wxMaximizeEventFunction, func)
3547 #define wxNavigationKeyEventHandler(func) \
3548 wxEVENT_HANDLER_CAST(wxNavigationKeyEventFunction, func)
3549 #define wxPaletteChangedEventHandler(func) \
3550 wxEVENT_HANDLER_CAST(wxPaletteChangedEventFunction, func)
3551 #define wxQueryNewPaletteEventHandler(func) \
3552 wxEVENT_HANDLER_CAST(wxQueryNewPaletteEventFunction, func)
3553 #define wxWindowCreateEventHandler(func) \
3554 wxEVENT_HANDLER_CAST(wxWindowCreateEventFunction, func)
3555 #define wxWindowDestroyEventHandler(func) \
3556 wxEVENT_HANDLER_CAST(wxWindowDestroyEventFunction, func)
3557 #define wxSetCursorEventHandler(func) \
3558 wxEVENT_HANDLER_CAST(wxSetCursorEventFunction, func)
3559 #define wxNotifyEventHandler(func) \
3560 wxEVENT_HANDLER_CAST(wxNotifyEventFunction, func)
3561 #define wxHelpEventHandler(func) \
3562 wxEVENT_HANDLER_CAST(wxHelpEventFunction, func)
3563 #define wxContextMenuEventHandler(func) \
3564 wxEVENT_HANDLER_CAST(wxContextMenuEventFunction, func)
3565 #define wxMouseCaptureChangedEventHandler(func) \
3566 wxEVENT_HANDLER_CAST(wxMouseCaptureChangedEventFunction, func)
3567 #define wxMouseCaptureLostEventHandler(func) \
3568 wxEVENT_HANDLER_CAST(wxMouseCaptureLostEventFunction, func)
3569 #define wxClipboardTextEventHandler(func) \
3570 wxEVENT_HANDLER_CAST(wxClipboardTextEventFunction, func)
3574 // N.B. In GNU-WIN32, you *have* to take the address of a member function
3575 // (use &) or the compiler crashes...
3577 #define wxDECLARE_EVENT_TABLE() \
3579 static const wxEventTableEntry sm_eventTableEntries[]; \
3581 static const wxEventTable sm_eventTable; \
3582 virtual const wxEventTable* GetEventTable() const; \
3583 static wxEventHashTable sm_eventHashTable; \
3584 virtual wxEventHashTable& GetEventHashTable() const
3586 // N.B.: when building DLL with Borland C++ 5.5 compiler, you must initialize
3587 // sm_eventTable before using it in GetEventTable() or the compiler gives
3588 // E2233 (see http://groups.google.com/groups?selm=397dcc8a%241_2%40dnews)
3590 #define wxBEGIN_EVENT_TABLE(theClass, baseClass) \
3591 const wxEventTable theClass::sm_eventTable = \
3592 { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] }; \
3593 const wxEventTable *theClass::GetEventTable() const \
3594 { return &theClass::sm_eventTable; } \
3595 wxEventHashTable theClass::sm_eventHashTable(theClass::sm_eventTable); \
3596 wxEventHashTable &theClass::GetEventHashTable() const \
3597 { return theClass::sm_eventHashTable; } \
3598 const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
3600 #define wxBEGIN_EVENT_TABLE_TEMPLATE1(theClass, baseClass, T1) \
3601 template<typename T1> \
3602 const wxEventTable theClass<T1>::sm_eventTable = \
3603 { &baseClass::sm_eventTable, &theClass<T1>::sm_eventTableEntries[0] }; \
3604 template<typename T1> \
3605 const wxEventTable *theClass<T1>::GetEventTable() const \
3606 { return &theClass<T1>::sm_eventTable; } \
3607 template<typename T1> \
3608 wxEventHashTable theClass<T1>::sm_eventHashTable(theClass<T1>::sm_eventTable); \
3609 template<typename T1> \
3610 wxEventHashTable &theClass<T1>::GetEventHashTable() const \
3611 { return theClass<T1>::sm_eventHashTable; } \
3612 template<typename T1> \
3613 const wxEventTableEntry theClass<T1>::sm_eventTableEntries[] = { \
3615 #define wxBEGIN_EVENT_TABLE_TEMPLATE2(theClass, baseClass, T1, T2) \
3616 template<typename T1, typename T2> \
3617 const wxEventTable theClass<T1, T2>::sm_eventTable = \
3618 { &baseClass::sm_eventTable, &theClass<T1, T2>::sm_eventTableEntries[0] }; \
3619 template<typename T1, typename T2> \
3620 const wxEventTable *theClass<T1, T2>::GetEventTable() const \
3621 { return &theClass<T1, T2>::sm_eventTable; } \
3622 template<typename T1, typename T2> \
3623 wxEventHashTable theClass<T1, T2>::sm_eventHashTable(theClass<T1, T2>::sm_eventTable); \
3624 template<typename T1, typename T2> \
3625 wxEventHashTable &theClass<T1, T2>::GetEventHashTable() const \
3626 { return theClass<T1, T2>::sm_eventHashTable; } \
3627 template<typename T1, typename T2> \
3628 const wxEventTableEntry theClass<T1, T2>::sm_eventTableEntries[] = { \
3630 #define wxBEGIN_EVENT_TABLE_TEMPLATE3(theClass, baseClass, T1, T2, T3) \
3631 template<typename T1, typename T2, typename T3> \
3632 const wxEventTable theClass<T1, T2, T3>::sm_eventTable = \
3633 { &baseClass::sm_eventTable, &theClass<T1, T2, T3>::sm_eventTableEntries[0] }; \
3634 template<typename T1, typename T2, typename T3> \
3635 const wxEventTable *theClass<T1, T2, T3>::GetEventTable() const \
3636 { return &theClass<T1, T2, T3>::sm_eventTable; } \
3637 template<typename T1, typename T2, typename T3> \
3638 wxEventHashTable theClass<T1, T2, T3>::sm_eventHashTable(theClass<T1, T2, T3>::sm_eventTable); \
3639 template<typename T1, typename T2, typename T3> \
3640 wxEventHashTable &theClass<T1, T2, T3>::GetEventHashTable() const \
3641 { return theClass<T1, T2, T3>::sm_eventHashTable; } \
3642 template<typename T1, typename T2, typename T3> \
3643 const wxEventTableEntry theClass<T1, T2, T3>::sm_eventTableEntries[] = { \
3645 #define wxBEGIN_EVENT_TABLE_TEMPLATE4(theClass, baseClass, T1, T2, T3, T4) \
3646 template<typename T1, typename T2, typename T3, typename T4> \
3647 const wxEventTable theClass<T1, T2, T3, T4>::sm_eventTable = \
3648 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4>::sm_eventTableEntries[0] }; \
3649 template<typename T1, typename T2, typename T3, typename T4> \
3650 const wxEventTable *theClass<T1, T2, T3, T4>::GetEventTable() const \
3651 { return &theClass<T1, T2, T3, T4>::sm_eventTable; } \
3652 template<typename T1, typename T2, typename T3, typename T4> \
3653 wxEventHashTable theClass<T1, T2, T3, T4>::sm_eventHashTable(theClass<T1, T2, T3, T4>::sm_eventTable); \
3654 template<typename T1, typename T2, typename T3, typename T4> \
3655 wxEventHashTable &theClass<T1, T2, T3, T4>::GetEventHashTable() const \
3656 { return theClass<T1, T2, T3, T4>::sm_eventHashTable; } \
3657 template<typename T1, typename T2, typename T3, typename T4> \
3658 const wxEventTableEntry theClass<T1, T2, T3, T4>::sm_eventTableEntries[] = { \
3660 #define wxBEGIN_EVENT_TABLE_TEMPLATE5(theClass, baseClass, T1, T2, T3, T4, T5) \
3661 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3662 const wxEventTable theClass<T1, T2, T3, T4, T5>::sm_eventTable = \
3663 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[0] }; \
3664 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3665 const wxEventTable *theClass<T1, T2, T3, T4, T5>::GetEventTable() const \
3666 { return &theClass<T1, T2, T3, T4, T5>::sm_eventTable; } \
3667 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3668 wxEventHashTable theClass<T1, T2, T3, T4, T5>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5>::sm_eventTable); \
3669 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3670 wxEventHashTable &theClass<T1, T2, T3, T4, T5>::GetEventHashTable() const \
3671 { return theClass<T1, T2, T3, T4, T5>::sm_eventHashTable; } \
3672 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3673 const wxEventTableEntry theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[] = { \
3675 #define wxBEGIN_EVENT_TABLE_TEMPLATE7(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7) \
3676 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3677 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable = \
3678 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[0] }; \
3679 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3680 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventTable() const \
3681 { return &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable; } \
3682 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3683 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable); \
3684 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3685 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventHashTable() const \
3686 { return theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable; } \
3687 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3688 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[] = { \
3690 #define wxBEGIN_EVENT_TABLE_TEMPLATE8(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7, T8) \
3691 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3692 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable = \
3693 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[0] }; \
3694 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3695 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventTable() const \
3696 { return &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable; } \
3697 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3698 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable); \
3699 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3700 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventHashTable() const \
3701 { return theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable; } \
3702 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3703 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[] = { \
3705 #define wxEND_EVENT_TABLE() \
3706 wxDECLARE_EVENT_TABLE_TERMINATOR() };
3709 * Event table macros
3712 // helpers for writing shorter code below: declare an event macro taking 2, 1
3713 // or none ids (the missing ids default to wxID_ANY)
3716 // - evt one of wxEVT_XXX constants
3717 // - id1, id2 ids of the first/last id
3718 // - fn the function (should be cast to the right type)
3719 #define wx__DECLARE_EVT2(evt, id1, id2, fn) \
3720 wxDECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
3721 #define wx__DECLARE_EVT1(evt, id, fn) \
3722 wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
3723 #define wx__DECLARE_EVT0(evt, fn) \
3724 wx__DECLARE_EVT1(evt, wxID_ANY, fn)
3728 #define EVT_CUSTOM(event, winid, func) \
3729 wx__DECLARE_EVT1(event, winid, wxEventHandler(func))
3730 #define EVT_CUSTOM_RANGE(event, id1, id2, func) \
3731 wx__DECLARE_EVT2(event, id1, id2, wxEventHandler(func))
3734 #define EVT_COMMAND(winid, event, func) \
3735 wx__DECLARE_EVT1(event, winid, wxCommandEventHandler(func))
3737 #define EVT_COMMAND_RANGE(id1, id2, event, func) \
3738 wx__DECLARE_EVT2(event, id1, id2, wxCommandEventHandler(func))
3740 #define EVT_NOTIFY(event, winid, func) \
3741 wx__DECLARE_EVT1(event, winid, wxNotifyEventHandler(func))
3743 #define EVT_NOTIFY_RANGE(event, id1, id2, func) \
3744 wx__DECLARE_EVT2(event, id1, id2, wxNotifyEventHandler(func))
3747 #define EVT_SIZE(func) wx__DECLARE_EVT0(wxEVT_SIZE, wxSizeEventHandler(func))
3748 #define EVT_SIZING(func) wx__DECLARE_EVT0(wxEVT_SIZING, wxSizeEventHandler(func))
3749 #define EVT_MOVE(func) wx__DECLARE_EVT0(wxEVT_MOVE, wxMoveEventHandler(func))
3750 #define EVT_MOVING(func) wx__DECLARE_EVT0(wxEVT_MOVING, wxMoveEventHandler(func))
3751 #define EVT_MOVE_START(func) wx__DECLARE_EVT0(wxEVT_MOVE_START, wxMoveEventHandler(func))
3752 #define EVT_MOVE_END(func) wx__DECLARE_EVT0(wxEVT_MOVE_END, wxMoveEventHandler(func))
3753 #define EVT_CLOSE(func) wx__DECLARE_EVT0(wxEVT_CLOSE_WINDOW, wxCloseEventHandler(func))
3754 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3755 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3756 #define EVT_PAINT(func) wx__DECLARE_EVT0(wxEVT_PAINT, wxPaintEventHandler(func))
3757 #define EVT_NC_PAINT(func) wx__DECLARE_EVT0(wxEVT_NC_PAINT, wxNcPaintEventHandler(func))
3758 #define EVT_ERASE_BACKGROUND(func) wx__DECLARE_EVT0(wxEVT_ERASE_BACKGROUND, wxEraseEventHandler(func))
3759 #define EVT_CHAR(func) wx__DECLARE_EVT0(wxEVT_CHAR, wxCharEventHandler(func))
3760 #define EVT_KEY_DOWN(func) wx__DECLARE_EVT0(wxEVT_KEY_DOWN, wxKeyEventHandler(func))
3761 #define EVT_KEY_UP(func) wx__DECLARE_EVT0(wxEVT_KEY_UP, wxKeyEventHandler(func))
3763 #define EVT_HOTKEY(winid, func) wx__DECLARE_EVT1(wxEVT_HOTKEY, winid, wxCharEventHandler(func))
3765 #define EVT_CHAR_HOOK(func) wx__DECLARE_EVT0(wxEVT_CHAR_HOOK, wxCharEventHandler(func))
3766 #define EVT_MENU_OPEN(func) wx__DECLARE_EVT0(wxEVT_MENU_OPEN, wxMenuEventHandler(func))
3767 #define EVT_MENU_CLOSE(func) wx__DECLARE_EVT0(wxEVT_MENU_CLOSE, wxMenuEventHandler(func))
3768 #define EVT_MENU_HIGHLIGHT(winid, func) wx__DECLARE_EVT1(wxEVT_MENU_HIGHLIGHT, winid, wxMenuEventHandler(func))
3769 #define EVT_MENU_HIGHLIGHT_ALL(func) wx__DECLARE_EVT0(wxEVT_MENU_HIGHLIGHT, wxMenuEventHandler(func))
3770 #define EVT_SET_FOCUS(func) wx__DECLARE_EVT0(wxEVT_SET_FOCUS, wxFocusEventHandler(func))
3771 #define EVT_KILL_FOCUS(func) wx__DECLARE_EVT0(wxEVT_KILL_FOCUS, wxFocusEventHandler(func))
3772 #define EVT_CHILD_FOCUS(func) wx__DECLARE_EVT0(wxEVT_CHILD_FOCUS, wxChildFocusEventHandler(func))
3773 #define EVT_ACTIVATE(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE, wxActivateEventHandler(func))
3774 #define EVT_ACTIVATE_APP(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE_APP, wxActivateEventHandler(func))
3775 #define EVT_HIBERNATE(func) wx__DECLARE_EVT0(wxEVT_HIBERNATE, wxActivateEventHandler(func))
3776 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3777 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3778 #define EVT_DROP_FILES(func) wx__DECLARE_EVT0(wxEVT_DROP_FILES, wxDropFilesEventHandler(func))
3779 #define EVT_INIT_DIALOG(func) wx__DECLARE_EVT0(wxEVT_INIT_DIALOG, wxInitDialogEventHandler(func))
3780 #define EVT_SYS_COLOUR_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEventHandler(func))
3781 #define EVT_DISPLAY_CHANGED(func) wx__DECLARE_EVT0(wxEVT_DISPLAY_CHANGED, wxDisplayChangedEventHandler(func))
3782 #define EVT_SHOW(func) wx__DECLARE_EVT0(wxEVT_SHOW, wxShowEventHandler(func))
3783 #define EVT_MAXIMIZE(func) wx__DECLARE_EVT0(wxEVT_MAXIMIZE, wxMaximizeEventHandler(func))
3784 #define EVT_ICONIZE(func) wx__DECLARE_EVT0(wxEVT_ICONIZE, wxIconizeEventHandler(func))
3785 #define EVT_NAVIGATION_KEY(func) wx__DECLARE_EVT0(wxEVT_NAVIGATION_KEY, wxNavigationKeyEventHandler(func))
3786 #define EVT_PALETTE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_PALETTE_CHANGED, wxPaletteChangedEventHandler(func))
3787 #define EVT_QUERY_NEW_PALETTE(func) wx__DECLARE_EVT0(wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEventHandler(func))
3788 #define EVT_WINDOW_CREATE(func) wx__DECLARE_EVT0(wxEVT_CREATE, wxWindowCreateEventHandler(func))
3789 #define EVT_WINDOW_DESTROY(func) wx__DECLARE_EVT0(wxEVT_DESTROY, wxWindowDestroyEventHandler(func))
3790 #define EVT_SET_CURSOR(func) wx__DECLARE_EVT0(wxEVT_SET_CURSOR, wxSetCursorEventHandler(func))
3791 #define EVT_MOUSE_CAPTURE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEventHandler(func))
3792 #define EVT_MOUSE_CAPTURE_LOST(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEventHandler(func))
3795 #define EVT_LEFT_DOWN(func) wx__DECLARE_EVT0(wxEVT_LEFT_DOWN, wxMouseEventHandler(func))
3796 #define EVT_LEFT_UP(func) wx__DECLARE_EVT0(wxEVT_LEFT_UP, wxMouseEventHandler(func))
3797 #define EVT_MIDDLE_DOWN(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DOWN, wxMouseEventHandler(func))
3798 #define EVT_MIDDLE_UP(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_UP, wxMouseEventHandler(func))
3799 #define EVT_RIGHT_DOWN(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DOWN, wxMouseEventHandler(func))
3800 #define EVT_RIGHT_UP(func) wx__DECLARE_EVT0(wxEVT_RIGHT_UP, wxMouseEventHandler(func))
3801 #define EVT_MOTION(func) wx__DECLARE_EVT0(wxEVT_MOTION, wxMouseEventHandler(func))
3802 #define EVT_LEFT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_LEFT_DCLICK, wxMouseEventHandler(func))
3803 #define EVT_MIDDLE_DCLICK(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DCLICK, wxMouseEventHandler(func))
3804 #define EVT_RIGHT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DCLICK, wxMouseEventHandler(func))
3805 #define EVT_LEAVE_WINDOW(func) wx__DECLARE_EVT0(wxEVT_LEAVE_WINDOW, wxMouseEventHandler(func))
3806 #define EVT_ENTER_WINDOW(func) wx__DECLARE_EVT0(wxEVT_ENTER_WINDOW, wxMouseEventHandler(func))
3807 #define EVT_MOUSEWHEEL(func) wx__DECLARE_EVT0(wxEVT_MOUSEWHEEL, wxMouseEventHandler(func))
3808 #define EVT_MOUSE_AUX1_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX1_DOWN, wxMouseEventHandler(func))
3809 #define EVT_MOUSE_AUX1_UP(func) wx__DECLARE_EVT0(wxEVT_AUX1_UP, wxMouseEventHandler(func))
3810 #define EVT_MOUSE_AUX1_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX1_DCLICK, wxMouseEventHandler(func))
3811 #define EVT_MOUSE_AUX2_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX2_DOWN, wxMouseEventHandler(func))
3812 #define EVT_MOUSE_AUX2_UP(func) wx__DECLARE_EVT0(wxEVT_AUX2_UP, wxMouseEventHandler(func))
3813 #define EVT_MOUSE_AUX2_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX2_DCLICK, wxMouseEventHandler(func))
3816 #define EVT_MOUSE_EVENTS(func) \
3817 EVT_LEFT_DOWN(func) \
3819 EVT_LEFT_DCLICK(func) \
3820 EVT_MIDDLE_DOWN(func) \
3821 EVT_MIDDLE_UP(func) \
3822 EVT_MIDDLE_DCLICK(func) \
3823 EVT_RIGHT_DOWN(func) \
3824 EVT_RIGHT_UP(func) \
3825 EVT_RIGHT_DCLICK(func) \
3826 EVT_MOUSE_AUX1_DOWN(func) \
3827 EVT_MOUSE_AUX1_UP(func) \
3828 EVT_MOUSE_AUX1_DCLICK(func) \
3829 EVT_MOUSE_AUX2_DOWN(func) \
3830 EVT_MOUSE_AUX2_UP(func) \
3831 EVT_MOUSE_AUX2_DCLICK(func) \
3833 EVT_LEAVE_WINDOW(func) \
3834 EVT_ENTER_WINDOW(func) \
3835 EVT_MOUSEWHEEL(func)
3837 // Scrolling from wxWindow (sent to wxScrolledWindow)
3838 #define EVT_SCROLLWIN_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_TOP, wxScrollWinEventHandler(func))
3839 #define EVT_SCROLLWIN_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEventHandler(func))
3840 #define EVT_SCROLLWIN_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEUP, wxScrollWinEventHandler(func))
3841 #define EVT_SCROLLWIN_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEventHandler(func))
3842 #define EVT_SCROLLWIN_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEventHandler(func))
3843 #define EVT_SCROLLWIN_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEventHandler(func))
3844 #define EVT_SCROLLWIN_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEventHandler(func))
3845 #define EVT_SCROLLWIN_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEventHandler(func))
3847 #define EVT_SCROLLWIN(func) \
3848 EVT_SCROLLWIN_TOP(func) \
3849 EVT_SCROLLWIN_BOTTOM(func) \
3850 EVT_SCROLLWIN_LINEUP(func) \
3851 EVT_SCROLLWIN_LINEDOWN(func) \
3852 EVT_SCROLLWIN_PAGEUP(func) \
3853 EVT_SCROLLWIN_PAGEDOWN(func) \
3854 EVT_SCROLLWIN_THUMBTRACK(func) \
3855 EVT_SCROLLWIN_THUMBRELEASE(func)
3857 // Scrolling from wxSlider and wxScrollBar
3858 #define EVT_SCROLL_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_TOP, wxScrollEventHandler(func))
3859 #define EVT_SCROLL_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLL_BOTTOM, wxScrollEventHandler(func))
3860 #define EVT_SCROLL_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEUP, wxScrollEventHandler(func))
3861 #define EVT_SCROLL_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEDOWN, wxScrollEventHandler(func))
3862 #define EVT_SCROLL_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEUP, wxScrollEventHandler(func))
3863 #define EVT_SCROLL_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler(func))
3864 #define EVT_SCROLL_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler(func))
3865 #define EVT_SCROLL_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBRELEASE, wxScrollEventHandler(func))
3866 #define EVT_SCROLL_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SCROLL_CHANGED, wxScrollEventHandler(func))
3868 #define EVT_SCROLL(func) \
3869 EVT_SCROLL_TOP(func) \
3870 EVT_SCROLL_BOTTOM(func) \
3871 EVT_SCROLL_LINEUP(func) \
3872 EVT_SCROLL_LINEDOWN(func) \
3873 EVT_SCROLL_PAGEUP(func) \
3874 EVT_SCROLL_PAGEDOWN(func) \
3875 EVT_SCROLL_THUMBTRACK(func) \
3876 EVT_SCROLL_THUMBRELEASE(func) \
3877 EVT_SCROLL_CHANGED(func)
3879 // Scrolling from wxSlider and wxScrollBar, with an id
3880 #define EVT_COMMAND_SCROLL_TOP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_TOP, winid, wxScrollEventHandler(func))
3881 #define EVT_COMMAND_SCROLL_BOTTOM(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_BOTTOM, winid, wxScrollEventHandler(func))
3882 #define EVT_COMMAND_SCROLL_LINEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEUP, winid, wxScrollEventHandler(func))
3883 #define EVT_COMMAND_SCROLL_LINEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEDOWN, winid, wxScrollEventHandler(func))
3884 #define EVT_COMMAND_SCROLL_PAGEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEUP, winid, wxScrollEventHandler(func))
3885 #define EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEDOWN, winid, wxScrollEventHandler(func))
3886 #define EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBTRACK, winid, wxScrollEventHandler(func))
3887 #define EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBRELEASE, winid, wxScrollEventHandler(func))
3888 #define EVT_COMMAND_SCROLL_CHANGED(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_CHANGED, winid, wxScrollEventHandler(func))
3890 #define EVT_COMMAND_SCROLL(winid, func) \
3891 EVT_COMMAND_SCROLL_TOP(winid, func) \
3892 EVT_COMMAND_SCROLL_BOTTOM(winid, func) \
3893 EVT_COMMAND_SCROLL_LINEUP(winid, func) \
3894 EVT_COMMAND_SCROLL_LINEDOWN(winid, func) \
3895 EVT_COMMAND_SCROLL_PAGEUP(winid, func) \
3896 EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) \
3897 EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) \
3898 EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) \
3899 EVT_COMMAND_SCROLL_CHANGED(winid, func)
3901 #if WXWIN_COMPATIBILITY_2_6
3902 // compatibility macros for the old name, deprecated in 2.8
3903 #define wxEVT_SCROLL_ENDSCROLL wxEVT_SCROLL_CHANGED
3904 #define EVT_COMMAND_SCROLL_ENDSCROLL EVT_COMMAND_SCROLL_CHANGED
3905 #define EVT_SCROLL_ENDSCROLL EVT_SCROLL_CHANGED
3906 #endif // WXWIN_COMPATIBILITY_2_6
3908 // Convenience macros for commonly-used commands
3909 #define EVT_CHECKBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKBOX_CLICKED, winid, wxCommandEventHandler(func))
3910 #define EVT_CHOICE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHOICE_SELECTED, winid, wxCommandEventHandler(func))
3911 #define EVT_LISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_SELECTED, winid, wxCommandEventHandler(func))
3912 #define EVT_LISTBOX_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, winid, wxCommandEventHandler(func))
3913 #define EVT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_MENU_SELECTED, winid, wxCommandEventHandler(func))
3914 #define EVT_MENU_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_MENU_SELECTED, id1, id2, wxCommandEventHandler(func))
3915 #if defined(__SMARTPHONE__)
3916 # define EVT_BUTTON(winid, func) EVT_MENU(winid, func)
3918 # define EVT_BUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_BUTTON_CLICKED, winid, wxCommandEventHandler(func))
3920 #define EVT_SLIDER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SLIDER_UPDATED, winid, wxCommandEventHandler(func))
3921 #define EVT_RADIOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBOX_SELECTED, winid, wxCommandEventHandler(func))
3922 #define EVT_RADIOBUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBUTTON_SELECTED, winid, wxCommandEventHandler(func))
3923 // EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events
3924 #define EVT_SCROLLBAR(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SCROLLBAR_UPDATED, winid, wxCommandEventHandler(func))
3925 #define EVT_VLBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_VLBOX_SELECTED, winid, wxCommandEventHandler(func))
3926 #define EVT_COMBOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_SELECTED, winid, wxCommandEventHandler(func))
3927 #define EVT_TOOL(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_CLICKED, winid, wxCommandEventHandler(func))
3928 #define EVT_TOOL_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, winid, wxCommandEventHandler(func))
3929 #define EVT_TOOL_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_CLICKED, id1, id2, wxCommandEventHandler(func))
3930 #define EVT_TOOL_RCLICKED(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_RCLICKED, winid, wxCommandEventHandler(func))
3931 #define EVT_TOOL_RCLICKED_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, wxCommandEventHandler(func))
3932 #define EVT_TOOL_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_ENTER, winid, wxCommandEventHandler(func))
3933 #define EVT_CHECKLISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, winid, wxCommandEventHandler(func))
3934 #define EVT_COMBOBOX_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_DROPDOWN, winid, wxCommandEventHandler(func))
3935 #define EVT_COMBOBOX_CLOSEUP(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_CLOSEUP, winid, wxCommandEventHandler(func))
3937 // Generic command events
3938 #define EVT_COMMAND_LEFT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_CLICK, winid, wxCommandEventHandler(func))
3939 #define EVT_COMMAND_LEFT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_DCLICK, winid, wxCommandEventHandler(func))
3940 #define EVT_COMMAND_RIGHT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_CLICK, winid, wxCommandEventHandler(func))
3941 #define EVT_COMMAND_RIGHT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_DCLICK, winid, wxCommandEventHandler(func))
3942 #define EVT_COMMAND_SET_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SET_FOCUS, winid, wxCommandEventHandler(func))
3943 #define EVT_COMMAND_KILL_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_KILL_FOCUS, winid, wxCommandEventHandler(func))
3944 #define EVT_COMMAND_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_ENTER, winid, wxCommandEventHandler(func))
3948 #define EVT_JOY_BUTTON_DOWN(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_DOWN, wxJoystickEventHandler(func))
3949 #define EVT_JOY_BUTTON_UP(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_UP, wxJoystickEventHandler(func))
3950 #define EVT_JOY_MOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_MOVE, wxJoystickEventHandler(func))
3951 #define EVT_JOY_ZMOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_ZMOVE, wxJoystickEventHandler(func))
3953 // All joystick events
3954 #define EVT_JOYSTICK_EVENTS(func) \
3955 EVT_JOY_BUTTON_DOWN(func) \
3956 EVT_JOY_BUTTON_UP(func) \
3957 EVT_JOY_MOVE(func) \
3961 #define EVT_IDLE(func) wx__DECLARE_EVT0(wxEVT_IDLE, wxIdleEventHandler(func))
3964 #define EVT_UPDATE_UI(winid, func) wx__DECLARE_EVT1(wxEVT_UPDATE_UI, winid, wxUpdateUIEventHandler(func))
3965 #define EVT_UPDATE_UI_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_UPDATE_UI, id1, id2, wxUpdateUIEventHandler(func))
3968 #define EVT_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_HELP, winid, wxHelpEventHandler(func))
3969 #define EVT_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_HELP, id1, id2, wxHelpEventHandler(func))
3970 #define EVT_DETAILED_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_DETAILED_HELP, winid, wxHelpEventHandler(func))
3971 #define EVT_DETAILED_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_DETAILED_HELP, id1, id2, wxHelpEventHandler(func))
3973 // Context Menu Events
3974 #define EVT_CONTEXT_MENU(func) wx__DECLARE_EVT0(wxEVT_CONTEXT_MENU, wxContextMenuEventHandler(func))
3975 #define EVT_COMMAND_CONTEXT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_CONTEXT_MENU, winid, wxContextMenuEventHandler(func))
3977 // Clipboard text Events
3978 #define EVT_TEXT_CUT(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_CUT, winid, wxClipboardTextEventHandler(func))
3979 #define EVT_TEXT_COPY(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_COPY, winid, wxClipboardTextEventHandler(func))
3980 #define EVT_TEXT_PASTE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_PASTE, winid, wxClipboardTextEventHandler(func))
3983 #define EVT_THREAD(id, func) wx__DECLARE_EVT1(wxEVT_COMMAND_THREAD, id, wxThreadEventHandler(func))
3985 // ----------------------------------------------------------------------------
3987 // ----------------------------------------------------------------------------
3989 // This is an ugly hack to allow the use of Bind() instead of Connect() inside
3990 // the library code if the library was built with support for it, here is how
3993 // class SomeEventHandlingClass : wxBIND_OR_CONNECT_HACK_BASE_CLASS
3994 // public SomeBaseClass
3997 // SomeEventHandlingClass(wxWindow *win)
3999 // // connect to the event for the given window
4000 // wxBIND_OR_CONNECT_HACK(win, wxEVT_SOMETHING, wxSomeEventHandler,
4001 // SomeEventHandlingClass::OnSomeEvent, this);
4005 // void OnSomeEvent(wxSomeEvent&) { ... }
4008 // This is *not* meant to be used by library users, it is only defined here
4009 // (and not in a private header) because the base class must be visible from
4010 // other public headers, please do NOT use this in your code, it will be
4011 // removed from future wx versions without warning.
4012 #ifdef wxHAS_EVENT_BIND
4013 #define wxBIND_OR_CONNECT_HACK_BASE_CLASS
4014 #define wxBIND_OR_CONNECT_HACK_ONLY_BASE_CLASS
4015 #define wxBIND_OR_CONNECT_HACK(win, evt, handler, func, obj) \
4016 win->Bind(evt, &func, obj)
4017 #else // wxHAS_EVENT_BIND
4018 #define wxBIND_OR_CONNECT_HACK_BASE_CLASS public wxEvtHandler,
4019 #define wxBIND_OR_CONNECT_HACK_ONLY_BASE_CLASS : public wxEvtHandler
4020 #define wxBIND_OR_CONNECT_HACK(win, evt, handler, func, obj) \
4021 win->Connect(evt, handler(func), NULL, obj)
4022 #endif // wxHAS_EVENT_BIND
4026 // Find a window with the focus, that is also a descendant of the given window.
4027 // This is used to determine the window to initially send commands to.
4028 WXDLLIMPEXP_CORE wxWindow
* wxFindFocusDescendant(wxWindow
* ancestor
);
4033 // ----------------------------------------------------------------------------
4034 // Compatibility macro aliases
4035 // ----------------------------------------------------------------------------
4037 // deprecated variants _not_ requiring a semicolon after them and without wx prefix
4038 // (note that also some wx-prefixed macro do _not_ require a semicolon because
4039 // it's not always possible to force the compire to require it)
4041 #define DECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj) \
4042 wxDECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj)
4043 #define DECLARE_EVENT_TABLE_TERMINATOR() wxDECLARE_EVENT_TABLE_TERMINATOR()
4044 #define DECLARE_EVENT_TABLE() wxDECLARE_EVENT_TABLE();
4045 #define BEGIN_EVENT_TABLE(a,b) wxBEGIN_EVENT_TABLE(a,b)
4046 #define BEGIN_EVENT_TABLE_TEMPLATE1(a,b,c) wxBEGIN_EVENT_TABLE_TEMPLATE1(a,b,c)
4047 #define BEGIN_EVENT_TABLE_TEMPLATE2(a,b,c,d) wxBEGIN_EVENT_TABLE_TEMPLATE1(a,b,c,d)
4048 #define BEGIN_EVENT_TABLE_TEMPLATE3(a,b,c,d,e) wxBEGIN_EVENT_TABLE_TEMPLATE1(a,b,c,d,e)
4049 #define BEGIN_EVENT_TABLE_TEMPLATE4(a,b,c,d,e,f) wxBEGIN_EVENT_TABLE_TEMPLATE1(a,b,c,d,e,f)
4050 #define BEGIN_EVENT_TABLE_TEMPLATE5(a,b,c,d,e,f,g) wxBEGIN_EVENT_TABLE_TEMPLATE1(a,b,c,d,e,f,g)
4051 #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)
4052 #define END_EVENT_TABLE() wxEND_EVENT_TABLE()
4054 // other obsolete event declaration/definition macros; we don't need them any longer
4055 // but we keep them for compatibility as it doesn't cost us anything anyhow
4056 #define BEGIN_DECLARE_EVENT_TYPES()
4057 #define END_DECLARE_EVENT_TYPES()
4058 #define DECLARE_EXPORTED_EVENT_TYPE(expdecl, name, value) \
4059 extern expdecl const wxEventType name;
4060 #define DECLARE_EVENT_TYPE(name, value) \
4061 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_CORE, name, value)
4062 #define DECLARE_LOCAL_EVENT_TYPE(name, value) \
4063 DECLARE_EXPORTED_EVENT_TYPE(wxEMPTY_PARAMETER_VALUE, name, value)
4064 #define DEFINE_EVENT_TYPE(name) const wxEventType name = wxNewEventType();
4065 #define DEFINE_LOCAL_EVENT_TYPE(name) DEFINE_EVENT_TYPE(name)
4067 #endif // _WX_EVENT_H_