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
);
717 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SET_CURSOR
, wxSetCursorEvent
);
719 // wxScrollBar and wxSlider event identifiers
720 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_TOP
, wxScrollEvent
);
721 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_BOTTOM
, wxScrollEvent
);
722 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_LINEUP
, wxScrollEvent
);
723 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_LINEDOWN
, wxScrollEvent
);
724 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_PAGEUP
, wxScrollEvent
);
725 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_PAGEDOWN
, wxScrollEvent
);
726 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_THUMBTRACK
, wxScrollEvent
);
727 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_THUMBRELEASE
, wxScrollEvent
);
728 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_CHANGED
, wxScrollEvent
);
730 // Due to a bug in older wx versions, wxSpinEvents were being sent with type of
731 // wxEVT_SCROLL_LINEUP, wxEVT_SCROLL_LINEDOWN and wxEVT_SCROLL_THUMBTRACK. But
732 // with the type-safe events in place, these event types are associated with
733 // wxScrollEvent. To allow handling of spin events, new event types have been
734 // defined in spinbutt.h/spinnbuttcmn.cpp. To maintain backward compatibility
735 // the spin event types are being initialized with the scroll event types.
739 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN_UP
, wxSpinEvent
);
740 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN_DOWN
, wxSpinEvent
);
741 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN
, wxSpinEvent
);
745 // Scroll events from wxWindow
746 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_TOP
, wxScrollWinEvent
);
747 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_BOTTOM
, wxScrollWinEvent
);
748 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_LINEUP
, wxScrollWinEvent
);
749 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_LINEDOWN
, wxScrollWinEvent
);
750 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_PAGEUP
, wxScrollWinEvent
);
751 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_PAGEDOWN
, wxScrollWinEvent
);
752 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_THUMBTRACK
, wxScrollWinEvent
);
753 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_THUMBRELEASE
, wxScrollWinEvent
);
756 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SIZE
, wxSizeEvent
);
757 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE
, wxMoveEvent
);
758 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CLOSE_WINDOW
, wxCloseEvent
);
759 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_END_SESSION
, wxCloseEvent
);
760 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_QUERY_END_SESSION
, wxCloseEvent
);
761 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ACTIVATE_APP
, wxActivateEvent
);
762 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ACTIVATE
, wxActivateEvent
);
763 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CREATE
, wxWindowCreateEvent
);
764 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DESTROY
, wxWindowDestroyEvent
);
765 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SHOW
, wxShowEvent
);
766 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ICONIZE
, wxIconizeEvent
);
767 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MAXIMIZE
, wxMaximizeEvent
);
768 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSE_CAPTURE_CHANGED
, wxMouseCaptureChangedEvent
);
769 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSE_CAPTURE_LOST
, wxMouseCaptureLostEvent
);
770 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_PAINT
, wxPaintEvent
);
771 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ERASE_BACKGROUND
, wxEraseEvent
);
772 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_NC_PAINT
, wxNcPaintEvent
);
773 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_OPEN
, wxMenuEvent
);
774 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_CLOSE
, wxMenuEvent
);
775 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_HIGHLIGHT
, wxMenuEvent
);
776 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CONTEXT_MENU
, wxContextMenuEvent
);
777 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SYS_COLOUR_CHANGED
, wxSysColourChangedEvent
);
778 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DISPLAY_CHANGED
, wxDisplayChangedEvent
);
779 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_QUERY_NEW_PALETTE
, wxQueryNewPaletteEvent
);
780 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_PALETTE_CHANGED
, wxPaletteChangedEvent
);
781 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_BUTTON_DOWN
, wxJoystickEvent
);
782 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_BUTTON_UP
, wxJoystickEvent
);
783 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_MOVE
, wxJoystickEvent
);
784 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_ZMOVE
, wxJoystickEvent
);
785 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DROP_FILES
, wxDropFilesEvent
);
786 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_INIT_DIALOG
, wxInitDialogEvent
);
787 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_BASE
, wxEVT_IDLE
, wxIdleEvent
);
788 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_UPDATE_UI
, wxUpdateUIEvent
);
789 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SIZING
, wxSizeEvent
);
790 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVING
, wxMoveEvent
);
791 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE_START
, wxMoveEvent
);
792 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE_END
, wxMoveEvent
);
793 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HIBERNATE
, wxActivateEvent
);
796 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_COPY
, wxClipboardTextEvent
);
797 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_CUT
, wxClipboardTextEvent
);
798 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_PASTE
, wxClipboardTextEvent
);
800 // Generic command events
801 // Note: a click is a higher-level event than button down/up
802 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LEFT_CLICK
, wxCommandEvent
);
803 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LEFT_DCLICK
, wxCommandEvent
);
804 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RIGHT_CLICK
, wxCommandEvent
);
805 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RIGHT_DCLICK
, wxCommandEvent
);
806 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SET_FOCUS
, wxCommandEvent
);
807 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_KILL_FOCUS
, wxCommandEvent
);
808 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_ENTER
, wxCommandEvent
);
811 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HELP
, wxHelpEvent
);
812 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DETAILED_HELP
, wxHelpEvent
);
814 // these 2 events are the same
815 #define wxEVT_COMMAND_TOOL_CLICKED wxEVT_COMMAND_MENU_SELECTED
817 // ----------------------------------------------------------------------------
819 // ----------------------------------------------------------------------------
821 // this event is also used by wxComboBox and wxSpinCtrl which don't include
822 // wx/textctrl.h in all ports [yet], so declare it here as well
824 // still, any new code using it should include wx/textctrl.h explicitly
825 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_UPDATED
, wxCommandEvent
);
828 // ----------------------------------------------------------------------------
829 // wxEvent(-derived) classes
830 // ----------------------------------------------------------------------------
832 // the predefined constants for the number of times we propagate event
833 // upwards window child-parent chain
834 enum wxEventPropagation
836 // don't propagate it at all
837 wxEVENT_PROPAGATE_NONE
= 0,
839 // propagate it until it is processed
840 wxEVENT_PROPAGATE_MAX
= INT_MAX
843 // The different categories for a wxEvent; see wxEvent::GetEventCategory.
844 // NOTE: they are used as OR-combinable flags by wxEventLoopBase::YieldFor
847 // this is the category for those events which are generated to update
848 // the appearance of the GUI but which (usually) do not comport data
849 // processing, i.e. which do not provide input or output data
850 // (e.g. size events, scroll events, etc).
851 // They are events NOT directly generated by the user's input devices.
852 wxEVT_CATEGORY_UI
= 1,
854 // this category groups those events which are generated directly from the
855 // user through input devices like mouse and keyboard and usually result in
856 // data to be processed from the application.
857 // (e.g. mouse clicks, key presses, etc)
858 wxEVT_CATEGORY_USER_INPUT
= 2,
860 // this category is for wxSocketEvent
861 wxEVT_CATEGORY_SOCKET
= 4,
863 // this category is for wxTimerEvent
864 wxEVT_CATEGORY_TIMER
= 8,
866 // this category is for any event used to send notifications from the
867 // secondary threads to the main one or in general for notifications among
868 // different threads (which may or may not be user-generated)
869 wxEVT_CATEGORY_THREAD
= 16,
872 // implementation only
874 // used in the implementations of wxEventLoopBase::YieldFor
875 wxEVT_CATEGORY_UNKNOWN
= 32,
877 // a special category used as an argument to wxEventLoopBase::YieldFor to indicate that
878 // Yield() should leave all wxEvents on the queue while emptying the native event queue
879 // (native events will be processed but the wxEvents they generate will be queued)
880 wxEVT_CATEGORY_CLIPBOARD
= 64,
885 // this category groups those events which are emitted in response to
886 // events of the native toolkit and which typically are not-"delayable".
887 wxEVT_CATEGORY_NATIVE_EVENTS
= wxEVT_CATEGORY_UI
|wxEVT_CATEGORY_USER_INPUT
,
889 // used in wxEventLoopBase::YieldFor to specify all event categories should be processed:
891 wxEVT_CATEGORY_UI
|wxEVT_CATEGORY_USER_INPUT
|wxEVT_CATEGORY_SOCKET
| \
892 wxEVT_CATEGORY_TIMER
|wxEVT_CATEGORY_THREAD
|wxEVT_CATEGORY_UNKNOWN
| \
893 wxEVT_CATEGORY_CLIPBOARD
897 * wxWidgets events, covering all interesting things that might happen
898 * (button clicking, resizing, setting text in widgets, etc.).
900 * For each completely new event type, derive a new event class.
901 * An event CLASS represents a C++ class defining a range of similar event TYPES;
902 * examples are canvas events, panel item command events.
903 * An event TYPE is a unique identifier for a particular system event,
904 * such as a button press or a listbox deselection.
908 class WXDLLIMPEXP_BASE wxEvent
: public wxObject
911 wxEvent(int winid
= 0, wxEventType commandType
= wxEVT_NULL
);
913 void SetEventType(wxEventType typ
) { m_eventType
= typ
; }
914 wxEventType
GetEventType() const { return m_eventType
; }
916 wxObject
*GetEventObject() const { return m_eventObject
; }
917 void SetEventObject(wxObject
*obj
) { m_eventObject
= obj
; }
919 long GetTimestamp() const { return m_timeStamp
; }
920 void SetTimestamp(long ts
= 0) { m_timeStamp
= ts
; }
922 int GetId() const { return m_id
; }
923 void SetId(int Id
) { m_id
= Id
; }
925 // Can instruct event processor that we wish to ignore this event
926 // (treat as if the event table entry had not been found): this must be done
927 // to allow the event processing by the base classes (calling event.Skip()
928 // is the analog of calling the base class version of a virtual function)
929 void Skip(bool skip
= true) { m_skipped
= skip
; }
930 bool GetSkipped() const { return m_skipped
; }
932 // This function is used to create a copy of the event polymorphically and
933 // all derived classes must implement it because otherwise wxPostEvent()
934 // for them wouldn't work (it needs to do a copy of the event)
935 virtual wxEvent
*Clone() const = 0;
937 // this function is used to selectively process events in wxEventLoopBase::YieldFor
938 // NOTE: by default it returns wxEVT_CATEGORY_UI just because the major
939 // part of wxWidgets events belong to that category.
940 virtual wxEventCategory
GetEventCategory() const
941 { return wxEVT_CATEGORY_UI
; }
943 // Implementation only: this test is explicitly anti OO and this function
944 // exists only for optimization purposes.
945 bool IsCommandEvent() const { return m_isCommandEvent
; }
947 // Determine if this event should be propagating to the parent window.
948 bool ShouldPropagate() const
949 { return m_propagationLevel
!= wxEVENT_PROPAGATE_NONE
; }
951 // Stop an event from propagating to its parent window, returns the old
952 // propagation level value
953 int StopPropagation()
955 int propagationLevel
= m_propagationLevel
;
956 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
957 return propagationLevel
;
960 // Resume the event propagation by restoring the propagation level
961 // (returned by StopPropagation())
962 void ResumePropagation(int propagationLevel
)
964 m_propagationLevel
= propagationLevel
;
968 // This is for internal use only and is only called by
969 // wxEvtHandler::ProcessEvent() to check whether it's the first time this
970 // event is being processed
973 if ( m_wasProcessed
)
976 m_wasProcessed
= true;
981 // This is also used only internally by ProcessEvent() to check if it
982 // should process the event normally or only restrict the search for the
983 // event handler to this object itself.
984 bool ShouldProcessOnlyIn(wxEvtHandler
*h
) const
986 return h
== m_handlerToProcessOnlyIn
;
989 // Called to indicate that the result of ShouldProcessOnlyIn() wasn't taken
990 // into account. The existence of this function may seem counterintuitive
991 // but unfortunately it's needed by wxScrollHelperEvtHandler, see comments
992 // there. Don't even think of using this in your own code, this is a gross
993 // hack and is only needed because of wx complicated history and should
994 // never be used anywhere else.
995 void DidntHonourProcessOnlyIn()
997 m_handlerToProcessOnlyIn
= NULL
;
1001 wxObject
* m_eventObject
;
1002 wxEventType m_eventType
;
1007 // m_callbackUserData is for internal usage only
1008 wxObject
* m_callbackUserData
;
1012 wxEvtHandler
*m_handlerToProcessOnlyIn
;
1015 // the propagation level: while it is positive, we propagate the event to
1016 // the parent window (if any)
1017 int m_propagationLevel
;
1020 bool m_isCommandEvent
;
1022 // initially false but becomes true as soon as WasProcessed() is called for
1023 // the first time, as this is done only by ProcessEvent() it explains the
1024 // variable name: it becomes true after ProcessEvent() was called at least
1025 // once for this event
1026 bool m_wasProcessed
;
1029 wxEvent(const wxEvent
&); // for implementing Clone()
1030 wxEvent
& operator=(const wxEvent
&); // for derived classes operator=()
1033 // it needs to access our m_propagationLevel
1034 friend class WXDLLIMPEXP_FWD_BASE wxPropagateOnce
;
1036 // and this one needs to access our m_handlerToProcessOnlyIn
1037 friend class WXDLLIMPEXP_FWD_BASE wxEventProcessInHandlerOnly
;
1040 DECLARE_ABSTRACT_CLASS(wxEvent
)
1044 * Helper class to temporarily change an event not to propagate.
1046 class WXDLLIMPEXP_BASE wxPropagationDisabler
1049 wxPropagationDisabler(wxEvent
& event
) : m_event(event
)
1051 m_propagationLevelOld
= m_event
.StopPropagation();
1054 ~wxPropagationDisabler()
1056 m_event
.ResumePropagation(m_propagationLevelOld
);
1061 int m_propagationLevelOld
;
1063 wxDECLARE_NO_COPY_CLASS(wxPropagationDisabler
);
1067 * Another one to temporarily lower propagation level.
1069 class WXDLLIMPEXP_BASE wxPropagateOnce
1072 wxPropagateOnce(wxEvent
& event
) : m_event(event
)
1074 wxASSERT_MSG( m_event
.m_propagationLevel
> 0,
1075 wxT("shouldn't be used unless ShouldPropagate()!") );
1077 m_event
.m_propagationLevel
--;
1082 m_event
.m_propagationLevel
++;
1088 wxDECLARE_NO_COPY_CLASS(wxPropagateOnce
);
1091 // A helper object used to temporarily make wxEvent::ShouldProcessOnlyIn()
1092 // return true for the handler passed to its ctor.
1093 class wxEventProcessInHandlerOnly
1096 wxEventProcessInHandlerOnly(wxEvent
& event
, wxEvtHandler
*handler
)
1098 m_handlerToProcessOnlyInOld(event
.m_handlerToProcessOnlyIn
)
1100 m_event
.m_handlerToProcessOnlyIn
= handler
;
1103 ~wxEventProcessInHandlerOnly()
1105 m_event
.m_handlerToProcessOnlyIn
= m_handlerToProcessOnlyInOld
;
1110 wxEvtHandler
* const m_handlerToProcessOnlyInOld
;
1112 wxDECLARE_NO_COPY_CLASS(wxEventProcessInHandlerOnly
);
1118 // Item or menu event class
1120 wxEVT_COMMAND_BUTTON_CLICKED
1121 wxEVT_COMMAND_CHECKBOX_CLICKED
1122 wxEVT_COMMAND_CHOICE_SELECTED
1123 wxEVT_COMMAND_LISTBOX_SELECTED
1124 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
1125 wxEVT_COMMAND_TEXT_UPDATED
1126 wxEVT_COMMAND_TEXT_ENTER
1127 wxEVT_COMMAND_MENU_SELECTED
1128 wxEVT_COMMAND_SLIDER_UPDATED
1129 wxEVT_COMMAND_RADIOBOX_SELECTED
1130 wxEVT_COMMAND_RADIOBUTTON_SELECTED
1131 wxEVT_COMMAND_SCROLLBAR_UPDATED
1132 wxEVT_COMMAND_VLBOX_SELECTED
1133 wxEVT_COMMAND_COMBOBOX_SELECTED
1134 wxEVT_COMMAND_TOGGLEBUTTON_CLICKED
1137 class WXDLLIMPEXP_CORE wxCommandEvent
: public wxEvent
1140 wxCommandEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0);
1142 wxCommandEvent(const wxCommandEvent
& event
)
1144 m_cmdString(event
.m_cmdString
),
1145 m_commandInt(event
.m_commandInt
),
1146 m_extraLong(event
.m_extraLong
),
1147 m_clientData(event
.m_clientData
),
1148 m_clientObject(event
.m_clientObject
)
1151 // Set/Get client data from controls
1152 void SetClientData(void* clientData
) { m_clientData
= clientData
; }
1153 void *GetClientData() const { return m_clientData
; }
1155 // Set/Get client object from controls
1156 void SetClientObject(wxClientData
* clientObject
) { m_clientObject
= clientObject
; }
1157 wxClientData
*GetClientObject() const { return m_clientObject
; }
1159 // Get listbox selection if single-choice
1160 int GetSelection() const { return m_commandInt
; }
1162 // Set/Get listbox/choice selection string
1163 void SetString(const wxString
& s
) { m_cmdString
= s
; }
1164 wxString
GetString() const;
1166 // Get checkbox value
1167 bool IsChecked() const { return m_commandInt
!= 0; }
1169 // true if the listbox event was a selection.
1170 bool IsSelection() const { return (m_extraLong
!= 0); }
1172 void SetExtraLong(long extraLong
) { m_extraLong
= extraLong
; }
1173 long GetExtraLong() const { return m_extraLong
; }
1175 void SetInt(int i
) { m_commandInt
= i
; }
1176 int GetInt() const { return m_commandInt
; }
1178 virtual wxEvent
*Clone() const { return new wxCommandEvent(*this); }
1179 virtual wxEventCategory
GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT
; }
1182 wxString m_cmdString
; // String event argument
1184 long m_extraLong
; // Additional information (e.g. select/deselect)
1185 void* m_clientData
; // Arbitrary client data
1186 wxClientData
* m_clientObject
; // Arbitrary client object
1189 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCommandEvent
)
1192 // this class adds a possibility to react (from the user) code to a control
1193 // notification: allow or veto the operation being reported.
1194 class WXDLLIMPEXP_CORE wxNotifyEvent
: public wxCommandEvent
1197 wxNotifyEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0)
1198 : wxCommandEvent(commandType
, winid
)
1199 { m_bAllow
= true; }
1201 wxNotifyEvent(const wxNotifyEvent
& event
)
1202 : wxCommandEvent(event
)
1203 { m_bAllow
= event
.m_bAllow
; }
1205 // veto the operation (usually it's allowed by default)
1206 void Veto() { m_bAllow
= false; }
1208 // allow the operation if it was disabled by default
1209 void Allow() { m_bAllow
= true; }
1211 // for implementation code only: is the operation allowed?
1212 bool IsAllowed() const { return m_bAllow
; }
1214 virtual wxEvent
*Clone() const { return new wxNotifyEvent(*this); }
1220 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNotifyEvent
)
1226 class WXDLLIMPEXP_CORE wxThreadEvent
: public wxCommandEvent
1229 wxThreadEvent(wxEventType eventType
= wxEVT_COMMAND_THREAD
, int id
= wxID_ANY
)
1230 : wxCommandEvent(eventType
, id
)
1233 wxThreadEvent(const wxThreadEvent
& event
)
1234 : wxCommandEvent(event
)
1236 // make sure our string member (which uses COW, aka refcounting) is not
1237 // shared by other wxString instances:
1238 SetString(GetString().c_str());
1240 #if wxUSE_ANY && (!defined(__VISUALC__) || wxCHECK_VISUALC_VERSION(7))
1241 m_payload
= event
.m_payload
;
1245 virtual wxEvent
*Clone() const
1247 return new wxThreadEvent(*this);
1250 // this is important to avoid that calling wxEventLoopBase::YieldFor thread events
1251 // gets processed when this is unwanted:
1252 virtual wxEventCategory
GetEventCategory() const
1253 { return wxEVT_CATEGORY_THREAD
; }
1255 #if wxUSE_ANY && (!defined(__VISUALC__) || wxCHECK_VISUALC_VERSION(7))
1256 template<typename T
>
1257 void SetPayload(const T
& payload
)
1259 m_payload
= payload
;
1262 template<typename T
>
1263 T
GetPayload() const
1265 return m_payload
.As
<T
>();
1270 #endif // wxUSE_ANY && (!defined(__VISUALC__) || wxCHECK_VISUALC_VERSION(7))
1273 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxThreadEvent
)
1278 // Scroll event class, derived form wxCommandEvent. wxScrollEvents are
1279 // sent by wxSlider and wxScrollBar.
1284 wxEVT_SCROLL_LINEDOWN
1286 wxEVT_SCROLL_PAGEDOWN
1287 wxEVT_SCROLL_THUMBTRACK
1288 wxEVT_SCROLL_THUMBRELEASE
1289 wxEVT_SCROLL_CHANGED
1292 class WXDLLIMPEXP_CORE wxScrollEvent
: public wxCommandEvent
1295 wxScrollEvent(wxEventType commandType
= wxEVT_NULL
,
1296 int winid
= 0, int pos
= 0, int orient
= 0);
1298 int GetOrientation() const { return (int) m_extraLong
; }
1299 int GetPosition() const { return m_commandInt
; }
1300 void SetOrientation(int orient
) { m_extraLong
= (long) orient
; }
1301 void SetPosition(int pos
) { m_commandInt
= pos
; }
1303 virtual wxEvent
*Clone() const { return new wxScrollEvent(*this); }
1306 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollEvent
)
1309 // ScrollWin event class, derived fom wxEvent. wxScrollWinEvents
1310 // are sent by wxWindow.
1313 wxEVT_SCROLLWIN_BOTTOM
1314 wxEVT_SCROLLWIN_LINEUP
1315 wxEVT_SCROLLWIN_LINEDOWN
1316 wxEVT_SCROLLWIN_PAGEUP
1317 wxEVT_SCROLLWIN_PAGEDOWN
1318 wxEVT_SCROLLWIN_THUMBTRACK
1319 wxEVT_SCROLLWIN_THUMBRELEASE
1322 class WXDLLIMPEXP_CORE wxScrollWinEvent
: public wxEvent
1325 wxScrollWinEvent(wxEventType commandType
= wxEVT_NULL
,
1326 int pos
= 0, int orient
= 0);
1327 wxScrollWinEvent(const wxScrollWinEvent
& event
) : wxEvent(event
)
1328 { m_commandInt
= event
.m_commandInt
;
1329 m_extraLong
= event
.m_extraLong
; }
1331 int GetOrientation() const { return (int) m_extraLong
; }
1332 int GetPosition() const { return m_commandInt
; }
1333 void SetOrientation(int orient
) { m_extraLong
= (long) orient
; }
1334 void SetPosition(int pos
) { m_commandInt
= pos
; }
1336 virtual wxEvent
*Clone() const { return new wxScrollWinEvent(*this); }
1343 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollWinEvent
)
1348 // Mouse event class
1365 wxEVT_NC_MIDDLE_DOWN,
1367 wxEVT_NC_RIGHT_DOWN,
1370 wxEVT_NC_ENTER_WINDOW,
1371 wxEVT_NC_LEAVE_WINDOW,
1372 wxEVT_NC_LEFT_DCLICK,
1373 wxEVT_NC_MIDDLE_DCLICK,
1374 wxEVT_NC_RIGHT_DCLICK,
1377 class WXDLLIMPEXP_CORE wxMouseEvent
: public wxEvent
,
1381 wxMouseEvent(wxEventType mouseType
= wxEVT_NULL
);
1382 wxMouseEvent(const wxMouseEvent
& event
)
1389 // Was it a button event? (*doesn't* mean: is any button *down*?)
1390 bool IsButton() const { return Button(wxMOUSE_BTN_ANY
); }
1392 // Was it a down event from this (or any) button?
1393 bool ButtonDown(int but
= wxMOUSE_BTN_ANY
) const;
1395 // Was it a dclick event from this (or any) button?
1396 bool ButtonDClick(int but
= wxMOUSE_BTN_ANY
) const;
1398 // Was it a up event from this (or any) button?
1399 bool ButtonUp(int but
= wxMOUSE_BTN_ANY
) const;
1401 // Was this event generated by the given button?
1402 bool Button(int but
) const;
1404 // Get the button which is changing state (wxMOUSE_BTN_NONE if none)
1405 int GetButton() const;
1407 // Find which event was just generated
1408 bool LeftDown() const { return (m_eventType
== wxEVT_LEFT_DOWN
); }
1409 bool MiddleDown() const { return (m_eventType
== wxEVT_MIDDLE_DOWN
); }
1410 bool RightDown() const { return (m_eventType
== wxEVT_RIGHT_DOWN
); }
1411 bool Aux1Down() const { return (m_eventType
== wxEVT_AUX1_DOWN
); }
1412 bool Aux2Down() const { return (m_eventType
== wxEVT_AUX2_DOWN
); }
1414 bool LeftUp() const { return (m_eventType
== wxEVT_LEFT_UP
); }
1415 bool MiddleUp() const { return (m_eventType
== wxEVT_MIDDLE_UP
); }
1416 bool RightUp() const { return (m_eventType
== wxEVT_RIGHT_UP
); }
1417 bool Aux1Up() const { return (m_eventType
== wxEVT_AUX1_UP
); }
1418 bool Aux2Up() const { return (m_eventType
== wxEVT_AUX2_UP
); }
1420 bool LeftDClick() const { return (m_eventType
== wxEVT_LEFT_DCLICK
); }
1421 bool MiddleDClick() const { return (m_eventType
== wxEVT_MIDDLE_DCLICK
); }
1422 bool RightDClick() const { return (m_eventType
== wxEVT_RIGHT_DCLICK
); }
1423 bool Aux1DClick() const { return (m_eventType
== wxEVT_AUX1_UP
); }
1424 bool Aux2DClick() const { return (m_eventType
== wxEVT_AUX2_UP
); }
1426 // True if a button is down and the mouse is moving
1427 bool Dragging() const
1429 return (m_eventType
== wxEVT_MOTION
) && ButtonIsDown(wxMOUSE_BTN_ANY
);
1432 // True if the mouse is moving, and no button is down
1435 return (m_eventType
== wxEVT_MOTION
) && !ButtonIsDown(wxMOUSE_BTN_ANY
);
1438 // True if the mouse is just entering the window
1439 bool Entering() const { return (m_eventType
== wxEVT_ENTER_WINDOW
); }
1441 // True if the mouse is just leaving the window
1442 bool Leaving() const { return (m_eventType
== wxEVT_LEAVE_WINDOW
); }
1444 // Returns the number of mouse clicks associated with this event.
1445 int GetClickCount() const { return m_clickCount
; }
1447 // Find the logical position of the event given the DC
1448 wxPoint
GetLogicalPosition(const wxDC
& dc
) const;
1450 // Get wheel rotation, positive or negative indicates direction of
1451 // rotation. Current devices all send an event when rotation is equal to
1452 // +/-WheelDelta, but this allows for finer resolution devices to be
1453 // created in the future. Because of this you shouldn't assume that one
1454 // event is equal to 1 line or whatever, but you should be able to either
1455 // do partial line scrolling or wait until +/-WheelDelta rotation values
1456 // have been accumulated before scrolling.
1457 int GetWheelRotation() const { return m_wheelRotation
; }
1459 // Get wheel delta, normally 120. This is the threshold for action to be
1460 // taken, and one such action (for example, scrolling one increment)
1461 // should occur for each delta.
1462 int GetWheelDelta() const { return m_wheelDelta
; }
1464 // Gets the axis the wheel operation concerns, 0 being the y axis as on
1465 // most mouse wheels, 1 is the x axis for things like MightyMouse scrolls
1466 // or horizontal trackpad scrolling
1467 int GetWheelAxis() const { return m_wheelAxis
; }
1469 // Returns the configured number of lines (or whatever) to be scrolled per
1470 // wheel action. Defaults to one.
1471 int GetLinesPerAction() const { return m_linesPerAction
; }
1473 // Is the system set to do page scrolling?
1474 bool IsPageScroll() const { return ((unsigned int)m_linesPerAction
== UINT_MAX
); }
1476 virtual wxEvent
*Clone() const { return new wxMouseEvent(*this); }
1477 virtual wxEventCategory
GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT
; }
1479 wxMouseEvent
& operator=(const wxMouseEvent
& event
)
1490 int m_wheelRotation
;
1492 int m_linesPerAction
;
1495 void Assign(const wxMouseEvent
& evt
);
1498 DECLARE_DYNAMIC_CLASS(wxMouseEvent
)
1507 class WXDLLIMPEXP_CORE wxSetCursorEvent
: public wxEvent
1510 wxSetCursorEvent(wxCoord x
= 0, wxCoord y
= 0)
1511 : wxEvent(0, wxEVT_SET_CURSOR
),
1512 m_x(x
), m_y(y
), m_cursor()
1515 wxSetCursorEvent(const wxSetCursorEvent
& event
)
1519 m_cursor(event
.m_cursor
)
1522 wxCoord
GetX() const { return m_x
; }
1523 wxCoord
GetY() const { return m_y
; }
1525 void SetCursor(const wxCursor
& cursor
) { m_cursor
= cursor
; }
1526 const wxCursor
& GetCursor() const { return m_cursor
; }
1527 bool HasCursor() const { return m_cursor
.Ok(); }
1529 virtual wxEvent
*Clone() const { return new wxSetCursorEvent(*this); }
1536 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSetCursorEvent
)
1539 // Keyboard input event class
1549 // key categories: the bit flags for IsKeyInCategory() function
1551 // the enum values used may change in future version of wx
1552 // use the named constants only, or bitwise combinations thereof
1553 enum wxKeyCategoryFlags
1555 // arrow keys, on and off numeric keypads
1556 WXK_CATEGORY_ARROW
= 1,
1558 // page up and page down keys, on and off numeric keypads
1559 WXK_CATEGORY_PAGING
= 2,
1561 // home and end keys, on and off numeric keypads
1562 WXK_CATEGORY_JUMP
= 4,
1564 // tab key, on and off numeric keypads
1565 WXK_CATEGORY_TAB
= 8,
1567 // backspace and delete keys, on and off numeric keypads
1568 WXK_CATEGORY_CUT
= 16,
1570 // all keys usually used for navigation
1571 WXK_CATEGORY_NAVIGATION
= WXK_CATEGORY_ARROW
|
1572 WXK_CATEGORY_PAGING
|
1576 class WXDLLIMPEXP_CORE wxKeyEvent
: public wxEvent
,
1577 public wxKeyboardState
1580 wxKeyEvent(wxEventType keyType
= wxEVT_NULL
);
1581 wxKeyEvent(const wxKeyEvent
& evt
);
1583 // get the key code: an ASCII7 char or an element of wxKeyCode enum
1584 int GetKeyCode() const { return (int)m_keyCode
; }
1586 // returns true iff this event's key code is of a certain type
1587 bool IsKeyInCategory(int category
) const;
1590 // get the Unicode character corresponding to this key
1591 wxChar
GetUnicodeKey() const { return m_uniChar
; }
1592 #endif // wxUSE_UNICODE
1594 // get the raw key code (platform-dependent)
1595 wxUint32
GetRawKeyCode() const { return m_rawCode
; }
1597 // get the raw key flags (platform-dependent)
1598 wxUint32
GetRawKeyFlags() const { return m_rawFlags
; }
1600 // Find the position of the event
1601 void GetPosition(wxCoord
*xpos
, wxCoord
*ypos
) const
1603 if (xpos
) *xpos
= m_x
;
1604 if (ypos
) *ypos
= m_y
;
1607 void GetPosition(long *xpos
, long *ypos
) const
1609 if (xpos
) *xpos
= (long)m_x
;
1610 if (ypos
) *ypos
= (long)m_y
;
1613 wxPoint
GetPosition() const
1614 { return wxPoint(m_x
, m_y
); }
1617 wxCoord
GetX() const { return m_x
; }
1620 wxCoord
GetY() const { return m_y
; }
1622 virtual wxEvent
*Clone() const { return new wxKeyEvent(*this); }
1623 virtual wxEventCategory
GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT
; }
1625 // we do need to copy wxKeyEvent sometimes (in wxTreeCtrl code, for
1627 wxKeyEvent
& operator=(const wxKeyEvent
& evt
)
1631 wxEvent::operator=(evt
);
1633 // Borland C++ 5.82 doesn't compile an explicit call to an
1634 // implicitly defined operator=() so need to do it this way:
1635 *static_cast<wxKeyboardState
*>(this) = evt
;
1640 m_keyCode
= evt
.m_keyCode
;
1642 m_rawCode
= evt
.m_rawCode
;
1643 m_rawFlags
= evt
.m_rawFlags
;
1645 m_uniChar
= evt
.m_uniChar
;
1657 // This contains the full Unicode character
1658 // in a character events in Unicode mode
1662 // these fields contain the platform-specific information about
1663 // key that was pressed
1665 wxUint32 m_rawFlags
;
1668 DECLARE_DYNAMIC_CLASS(wxKeyEvent
)
1676 class WXDLLIMPEXP_CORE wxSizeEvent
: public wxEvent
1679 wxSizeEvent() : wxEvent(0, wxEVT_SIZE
)
1681 wxSizeEvent(const wxSize
& sz
, int winid
= 0)
1682 : wxEvent(winid
, wxEVT_SIZE
),
1685 wxSizeEvent(const wxSizeEvent
& event
)
1687 m_size(event
.m_size
), m_rect(event
.m_rect
)
1689 wxSizeEvent(const wxRect
& rect
, int id
= 0)
1690 : m_size(rect
.GetSize()), m_rect(rect
)
1691 { m_eventType
= wxEVT_SIZING
; m_id
= id
; }
1693 wxSize
GetSize() const { return m_size
; }
1694 wxRect
GetRect() const { return m_rect
; }
1695 void SetRect(const wxRect
& rect
) { m_rect
= rect
; }
1697 virtual wxEvent
*Clone() const { return new wxSizeEvent(*this); }
1700 // For internal usage only. Will be converted to protected members.
1702 wxRect m_rect
; // Used for wxEVT_SIZING
1705 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSizeEvent
)
1714 class WXDLLIMPEXP_CORE wxMoveEvent
: public wxEvent
1718 : wxEvent(0, wxEVT_MOVE
)
1720 wxMoveEvent(const wxPoint
& pos
, int winid
= 0)
1721 : wxEvent(winid
, wxEVT_MOVE
),
1724 wxMoveEvent(const wxMoveEvent
& event
)
1728 wxMoveEvent(const wxRect
& rect
, int id
= 0)
1729 : m_pos(rect
.GetPosition()), m_rect(rect
)
1730 { m_eventType
= wxEVT_MOVING
; m_id
= id
; }
1732 wxPoint
GetPosition() const { return m_pos
; }
1733 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
1734 wxRect
GetRect() const { return m_rect
; }
1735 void SetRect(const wxRect
& rect
) { m_rect
= rect
; }
1737 virtual wxEvent
*Clone() const { return new wxMoveEvent(*this); }
1744 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMoveEvent
)
1747 // Paint event class
1754 #if wxDEBUG_LEVEL && (defined(__WXMSW__) || defined(__WXPM__))
1755 #define wxHAS_PAINT_DEBUG
1757 // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined
1758 extern WXDLLIMPEXP_CORE
int g_isPainting
;
1761 class WXDLLIMPEXP_CORE wxPaintEvent
: public wxEvent
1764 wxPaintEvent(int Id
= 0)
1765 : wxEvent(Id
, wxEVT_PAINT
)
1767 #ifdef wxHAS_PAINT_DEBUG
1768 // set the internal flag for the duration of redrawing
1773 // default copy ctor and dtor are normally fine, we only need them to keep
1774 // g_isPainting updated in debug build
1775 #ifdef wxHAS_PAINT_DEBUG
1776 wxPaintEvent(const wxPaintEvent
& event
)
1782 virtual ~wxPaintEvent()
1788 virtual wxEvent
*Clone() const { return new wxPaintEvent(*this); }
1791 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaintEvent
)
1794 class WXDLLIMPEXP_CORE wxNcPaintEvent
: public wxEvent
1797 wxNcPaintEvent(int winid
= 0)
1798 : wxEvent(winid
, wxEVT_NC_PAINT
)
1801 virtual wxEvent
*Clone() const { return new wxNcPaintEvent(*this); }
1804 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNcPaintEvent
)
1807 // Erase background event class
1809 wxEVT_ERASE_BACKGROUND
1812 class WXDLLIMPEXP_CORE wxEraseEvent
: public wxEvent
1815 wxEraseEvent(int Id
= 0, wxDC
*dc
= NULL
)
1816 : wxEvent(Id
, wxEVT_ERASE_BACKGROUND
),
1820 wxEraseEvent(const wxEraseEvent
& event
)
1825 wxDC
*GetDC() const { return m_dc
; }
1827 virtual wxEvent
*Clone() const { return new wxEraseEvent(*this); }
1833 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxEraseEvent
)
1836 // Focus event class
1842 class WXDLLIMPEXP_CORE wxFocusEvent
: public wxEvent
1845 wxFocusEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0)
1846 : wxEvent(winid
, type
)
1849 wxFocusEvent(const wxFocusEvent
& event
)
1851 { m_win
= event
.m_win
; }
1853 // The window associated with this event is the window which had focus
1854 // before for SET event and the window which will have focus for the KILL
1855 // one. NB: it may be NULL in both cases!
1856 wxWindow
*GetWindow() const { return m_win
; }
1857 void SetWindow(wxWindow
*win
) { m_win
= win
; }
1859 virtual wxEvent
*Clone() const { return new wxFocusEvent(*this); }
1865 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFocusEvent
)
1868 // wxChildFocusEvent notifies the parent that a child has got the focus: unlike
1869 // wxFocusEvent it is propagated upwards the window chain
1870 class WXDLLIMPEXP_CORE wxChildFocusEvent
: public wxCommandEvent
1873 wxChildFocusEvent(wxWindow
*win
= NULL
);
1875 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
1877 virtual wxEvent
*Clone() const { return new wxChildFocusEvent(*this); }
1880 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxChildFocusEvent
)
1883 // Activate event class
1890 class WXDLLIMPEXP_CORE wxActivateEvent
: public wxEvent
1893 wxActivateEvent(wxEventType type
= wxEVT_NULL
, bool active
= true, int Id
= 0)
1895 { m_active
= active
; }
1896 wxActivateEvent(const wxActivateEvent
& event
)
1898 { m_active
= event
.m_active
; }
1900 bool GetActive() const { return m_active
; }
1902 virtual wxEvent
*Clone() const { return new wxActivateEvent(*this); }
1908 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxActivateEvent
)
1911 // InitDialog event class
1916 class WXDLLIMPEXP_CORE wxInitDialogEvent
: public wxEvent
1919 wxInitDialogEvent(int Id
= 0)
1920 : wxEvent(Id
, wxEVT_INIT_DIALOG
)
1923 virtual wxEvent
*Clone() const { return new wxInitDialogEvent(*this); }
1926 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxInitDialogEvent
)
1929 // Miscellaneous menu event class
1933 wxEVT_MENU_HIGHLIGHT,
1936 class WXDLLIMPEXP_CORE wxMenuEvent
: public wxEvent
1939 wxMenuEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0, wxMenu
* menu
= NULL
)
1940 : wxEvent(winid
, type
)
1941 { m_menuId
= winid
; m_menu
= menu
; }
1942 wxMenuEvent(const wxMenuEvent
& event
)
1944 { m_menuId
= event
.m_menuId
; m_menu
= event
.m_menu
; }
1946 // only for wxEVT_MENU_HIGHLIGHT
1947 int GetMenuId() const { return m_menuId
; }
1949 // only for wxEVT_MENU_OPEN/CLOSE
1950 bool IsPopup() const { return m_menuId
== wxID_ANY
; }
1952 // only for wxEVT_MENU_OPEN/CLOSE
1953 wxMenu
* GetMenu() const { return m_menu
; }
1955 virtual wxEvent
*Clone() const { return new wxMenuEvent(*this); }
1961 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMenuEvent
)
1964 // Window close or session close event class
1968 wxEVT_QUERY_END_SESSION
1971 class WXDLLIMPEXP_CORE wxCloseEvent
: public wxEvent
1974 wxCloseEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0)
1975 : wxEvent(winid
, type
),
1977 m_veto(false), // should be false by default
1980 wxCloseEvent(const wxCloseEvent
& event
)
1982 m_loggingOff(event
.m_loggingOff
),
1983 m_veto(event
.m_veto
),
1984 m_canVeto(event
.m_canVeto
) {}
1986 void SetLoggingOff(bool logOff
) { m_loggingOff
= logOff
; }
1987 bool GetLoggingOff() const
1989 // m_loggingOff flag is only used by wxEVT_[QUERY_]END_SESSION, it
1990 // doesn't make sense for wxEVT_CLOSE_WINDOW
1991 wxASSERT_MSG( m_eventType
!= wxEVT_CLOSE_WINDOW
,
1992 wxT("this flag is for end session events only") );
1994 return m_loggingOff
;
1997 void Veto(bool veto
= true)
1999 // GetVeto() will return false anyhow...
2000 wxCHECK_RET( m_canVeto
,
2001 wxT("call to Veto() ignored (can't veto this event)") );
2005 void SetCanVeto(bool canVeto
) { m_canVeto
= canVeto
; }
2006 bool CanVeto() const { return m_canVeto
; }
2007 bool GetVeto() const { return m_canVeto
&& m_veto
; }
2009 virtual wxEvent
*Clone() const { return new wxCloseEvent(*this); }
2017 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCloseEvent
)
2024 class WXDLLIMPEXP_CORE wxShowEvent
: public wxEvent
2027 wxShowEvent(int winid
= 0, bool show
= false)
2028 : wxEvent(winid
, wxEVT_SHOW
)
2030 wxShowEvent(const wxShowEvent
& event
)
2032 { m_show
= event
.m_show
; }
2034 void SetShow(bool show
) { m_show
= show
; }
2036 // return true if the window was shown, false if hidden
2037 bool IsShown() const { return m_show
; }
2039 #if WXWIN_COMPATIBILITY_2_8
2040 wxDEPRECATED( bool GetShow() const { return IsShown(); } )
2043 virtual wxEvent
*Clone() const { return new wxShowEvent(*this); }
2049 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxShowEvent
)
2056 class WXDLLIMPEXP_CORE wxIconizeEvent
: public wxEvent
2059 wxIconizeEvent(int winid
= 0, bool iconized
= true)
2060 : wxEvent(winid
, wxEVT_ICONIZE
)
2061 { m_iconized
= iconized
; }
2062 wxIconizeEvent(const wxIconizeEvent
& event
)
2064 { m_iconized
= event
.m_iconized
; }
2066 #if WXWIN_COMPATIBILITY_2_8
2067 wxDEPRECATED( bool Iconized() const { return IsIconized(); } )
2069 // return true if the frame was iconized, false if restored
2070 bool IsIconized() const { return m_iconized
; }
2072 virtual wxEvent
*Clone() const { return new wxIconizeEvent(*this); }
2078 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIconizeEvent
)
2084 class WXDLLIMPEXP_CORE wxMaximizeEvent
: public wxEvent
2087 wxMaximizeEvent(int winid
= 0)
2088 : wxEvent(winid
, wxEVT_MAXIMIZE
)
2091 virtual wxEvent
*Clone() const { return new wxMaximizeEvent(*this); }
2094 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMaximizeEvent
)
2097 // Joystick event class
2099 wxEVT_JOY_BUTTON_DOWN,
2100 wxEVT_JOY_BUTTON_UP,
2105 // Which joystick? Same as Windows ids so no conversion necessary.
2112 // Which button is down?
2115 wxJOY_BUTTON_ANY
= -1,
2122 class WXDLLIMPEXP_CORE wxJoystickEvent
: public wxEvent
2127 int m_buttonChange
; // Which button changed?
2128 int m_buttonState
; // Which buttons are down?
2129 int m_joyStick
; // Which joystick?
2132 wxJoystickEvent(wxEventType type
= wxEVT_NULL
,
2134 int joystick
= wxJOYSTICK1
,
2139 m_buttonChange(change
),
2140 m_buttonState(state
),
2141 m_joyStick(joystick
)
2144 wxJoystickEvent(const wxJoystickEvent
& event
)
2147 m_zPosition(event
.m_zPosition
),
2148 m_buttonChange(event
.m_buttonChange
),
2149 m_buttonState(event
.m_buttonState
),
2150 m_joyStick(event
.m_joyStick
)
2153 wxPoint
GetPosition() const { return m_pos
; }
2154 int GetZPosition() const { return m_zPosition
; }
2155 int GetButtonState() const { return m_buttonState
; }
2156 int GetButtonChange() const { return m_buttonChange
; }
2157 int GetJoystick() const { return m_joyStick
; }
2159 void SetJoystick(int stick
) { m_joyStick
= stick
; }
2160 void SetButtonState(int state
) { m_buttonState
= state
; }
2161 void SetButtonChange(int change
) { m_buttonChange
= change
; }
2162 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2163 void SetZPosition(int zPos
) { m_zPosition
= zPos
; }
2165 // Was it a button event? (*doesn't* mean: is any button *down*?)
2166 bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN
) ||
2167 (GetEventType() == wxEVT_JOY_BUTTON_UP
)); }
2169 // Was it a move event?
2170 bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE
); }
2172 // Was it a zmove event?
2173 bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE
); }
2175 // Was it a down event from button 1, 2, 3, 4 or any?
2176 bool ButtonDown(int but
= wxJOY_BUTTON_ANY
) const
2177 { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN
) &&
2178 ((but
== wxJOY_BUTTON_ANY
) || (but
== m_buttonChange
))); }
2180 // Was it a up event from button 1, 2, 3 or any?
2181 bool ButtonUp(int but
= wxJOY_BUTTON_ANY
) const
2182 { return ((GetEventType() == wxEVT_JOY_BUTTON_UP
) &&
2183 ((but
== wxJOY_BUTTON_ANY
) || (but
== m_buttonChange
))); }
2185 // Was the given button 1,2,3,4 or any in Down state?
2186 bool ButtonIsDown(int but
= wxJOY_BUTTON_ANY
) const
2187 { return (((but
== wxJOY_BUTTON_ANY
) && (m_buttonState
!= 0)) ||
2188 ((m_buttonState
& but
) == but
)); }
2190 virtual wxEvent
*Clone() const { return new wxJoystickEvent(*this); }
2193 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxJoystickEvent
)
2196 // Drop files event class
2201 class WXDLLIMPEXP_CORE wxDropFilesEvent
: public wxEvent
2208 wxDropFilesEvent(wxEventType type
= wxEVT_NULL
,
2210 wxString
*files
= NULL
)
2217 // we need a copy ctor to avoid deleting m_files pointer twice
2218 wxDropFilesEvent(const wxDropFilesEvent
& other
)
2220 m_noFiles(other
.m_noFiles
),
2224 m_files
= new wxString
[m_noFiles
];
2225 for ( int n
= 0; n
< m_noFiles
; n
++ )
2227 m_files
[n
] = other
.m_files
[n
];
2231 virtual ~wxDropFilesEvent()
2236 wxPoint
GetPosition() const { return m_pos
; }
2237 int GetNumberOfFiles() const { return m_noFiles
; }
2238 wxString
*GetFiles() const { return m_files
; }
2240 virtual wxEvent
*Clone() const { return new wxDropFilesEvent(*this); }
2243 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDropFilesEvent
)
2251 // Whether to always send update events to windows, or
2252 // to only send update events to those with the
2253 // wxWS_EX_PROCESS_UI_UPDATES style.
2257 // Send UI update events to all windows
2258 wxUPDATE_UI_PROCESS_ALL
,
2260 // Send UI update events to windows that have
2261 // the wxWS_EX_PROCESS_UI_UPDATES flag specified
2262 wxUPDATE_UI_PROCESS_SPECIFIED
2265 class WXDLLIMPEXP_CORE wxUpdateUIEvent
: public wxCommandEvent
2268 wxUpdateUIEvent(wxWindowID commandId
= 0)
2269 : wxCommandEvent(wxEVT_UPDATE_UI
, commandId
)
2277 m_setChecked
= false;
2279 wxUpdateUIEvent(const wxUpdateUIEvent
& event
)
2280 : wxCommandEvent(event
),
2281 m_checked(event
.m_checked
),
2282 m_enabled(event
.m_enabled
),
2283 m_shown(event
.m_shown
),
2284 m_setEnabled(event
.m_setEnabled
),
2285 m_setShown(event
.m_setShown
),
2286 m_setText(event
.m_setText
),
2287 m_setChecked(event
.m_setChecked
),
2288 m_text(event
.m_text
)
2291 bool GetChecked() const { return m_checked
; }
2292 bool GetEnabled() const { return m_enabled
; }
2293 bool GetShown() const { return m_shown
; }
2294 wxString
GetText() const { return m_text
; }
2295 bool GetSetText() const { return m_setText
; }
2296 bool GetSetChecked() const { return m_setChecked
; }
2297 bool GetSetEnabled() const { return m_setEnabled
; }
2298 bool GetSetShown() const { return m_setShown
; }
2300 void Check(bool check
) { m_checked
= check
; m_setChecked
= true; }
2301 void Enable(bool enable
) { m_enabled
= enable
; m_setEnabled
= true; }
2302 void Show(bool show
) { m_shown
= show
; m_setShown
= true; }
2303 void SetText(const wxString
& text
) { m_text
= text
; m_setText
= true; }
2305 // Sets the interval between updates in milliseconds.
2306 // Set to -1 to disable updates, or to 0 to update as frequently as possible.
2307 static void SetUpdateInterval(long updateInterval
) { sm_updateInterval
= updateInterval
; }
2309 // Returns the current interval between updates in milliseconds
2310 static long GetUpdateInterval() { return sm_updateInterval
; }
2312 // Can we update this window?
2313 static bool CanUpdate(wxWindowBase
*win
);
2315 // Reset the update time to provide a delay until the next
2316 // time we should update
2317 static void ResetUpdateTime();
2319 // Specify how wxWidgets will send update events: to
2320 // all windows, or only to those which specify that they
2321 // will process the events.
2322 static void SetMode(wxUpdateUIMode mode
) { sm_updateMode
= mode
; }
2324 // Returns the UI update mode
2325 static wxUpdateUIMode
GetMode() { return sm_updateMode
; }
2327 virtual wxEvent
*Clone() const { return new wxUpdateUIEvent(*this); }
2339 static wxLongLong sm_lastUpdate
;
2341 static long sm_updateInterval
;
2342 static wxUpdateUIMode sm_updateMode
;
2345 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxUpdateUIEvent
)
2349 wxEVT_SYS_COLOUR_CHANGED
2352 // TODO: shouldn't all events record the window ID?
2353 class WXDLLIMPEXP_CORE wxSysColourChangedEvent
: public wxEvent
2356 wxSysColourChangedEvent()
2357 : wxEvent(0, wxEVT_SYS_COLOUR_CHANGED
)
2360 virtual wxEvent
*Clone() const { return new wxSysColourChangedEvent(*this); }
2363 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSysColourChangedEvent
)
2367 wxEVT_MOUSE_CAPTURE_CHANGED
2368 The window losing the capture receives this message
2369 (even if it released the capture itself).
2372 class WXDLLIMPEXP_CORE wxMouseCaptureChangedEvent
: public wxEvent
2375 wxMouseCaptureChangedEvent(wxWindowID winid
= 0, wxWindow
* gainedCapture
= NULL
)
2376 : wxEvent(winid
, wxEVT_MOUSE_CAPTURE_CHANGED
),
2377 m_gainedCapture(gainedCapture
)
2380 wxMouseCaptureChangedEvent(const wxMouseCaptureChangedEvent
& event
)
2382 m_gainedCapture(event
.m_gainedCapture
)
2385 virtual wxEvent
*Clone() const { return new wxMouseCaptureChangedEvent(*this); }
2387 wxWindow
* GetCapturedWindow() const { return m_gainedCapture
; }
2390 wxWindow
* m_gainedCapture
;
2392 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureChangedEvent
)
2396 wxEVT_MOUSE_CAPTURE_LOST
2397 The window losing the capture receives this message, unless it released it
2398 it itself or unless wxWindow::CaptureMouse was called on another window
2399 (and so capture will be restored when the new capturer releases it).
2402 class WXDLLIMPEXP_CORE wxMouseCaptureLostEvent
: public wxEvent
2405 wxMouseCaptureLostEvent(wxWindowID winid
= 0)
2406 : wxEvent(winid
, wxEVT_MOUSE_CAPTURE_LOST
)
2409 wxMouseCaptureLostEvent(const wxMouseCaptureLostEvent
& event
)
2413 virtual wxEvent
*Clone() const { return new wxMouseCaptureLostEvent(*this); }
2415 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureLostEvent
)
2419 wxEVT_DISPLAY_CHANGED
2421 class WXDLLIMPEXP_CORE wxDisplayChangedEvent
: public wxEvent
2424 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDisplayChangedEvent
)
2427 wxDisplayChangedEvent()
2428 : wxEvent(0, wxEVT_DISPLAY_CHANGED
)
2431 virtual wxEvent
*Clone() const { return new wxDisplayChangedEvent(*this); }
2435 wxEVT_PALETTE_CHANGED
2438 class WXDLLIMPEXP_CORE wxPaletteChangedEvent
: public wxEvent
2441 wxPaletteChangedEvent(wxWindowID winid
= 0)
2442 : wxEvent(winid
, wxEVT_PALETTE_CHANGED
),
2443 m_changedWindow(NULL
)
2446 wxPaletteChangedEvent(const wxPaletteChangedEvent
& event
)
2448 m_changedWindow(event
.m_changedWindow
)
2451 void SetChangedWindow(wxWindow
* win
) { m_changedWindow
= win
; }
2452 wxWindow
* GetChangedWindow() const { return m_changedWindow
; }
2454 virtual wxEvent
*Clone() const { return new wxPaletteChangedEvent(*this); }
2457 wxWindow
* m_changedWindow
;
2460 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaletteChangedEvent
)
2464 wxEVT_QUERY_NEW_PALETTE
2465 Indicates the window is getting keyboard focus and should re-do its palette.
2468 class WXDLLIMPEXP_CORE wxQueryNewPaletteEvent
: public wxEvent
2471 wxQueryNewPaletteEvent(wxWindowID winid
= 0)
2472 : wxEvent(winid
, wxEVT_QUERY_NEW_PALETTE
),
2473 m_paletteRealized(false)
2475 wxQueryNewPaletteEvent(const wxQueryNewPaletteEvent
& event
)
2477 m_paletteRealized(event
.m_paletteRealized
)
2480 // App sets this if it changes the palette.
2481 void SetPaletteRealized(bool realized
) { m_paletteRealized
= realized
; }
2482 bool GetPaletteRealized() const { return m_paletteRealized
; }
2484 virtual wxEvent
*Clone() const { return new wxQueryNewPaletteEvent(*this); }
2487 bool m_paletteRealized
;
2490 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxQueryNewPaletteEvent
)
2494 Event generated by dialog navigation keys
2495 wxEVT_NAVIGATION_KEY
2497 // NB: don't derive from command event to avoid being propagated to the parent
2498 class WXDLLIMPEXP_CORE wxNavigationKeyEvent
: public wxEvent
2501 wxNavigationKeyEvent()
2502 : wxEvent(0, wxEVT_NAVIGATION_KEY
),
2503 m_flags(IsForward
| FromTab
), // defaults are for TAB
2506 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
2509 wxNavigationKeyEvent(const wxNavigationKeyEvent
& event
)
2511 m_flags(event
.m_flags
),
2512 m_focus(event
.m_focus
)
2515 // direction: forward (true) or backward (false)
2516 bool GetDirection() const
2517 { return (m_flags
& IsForward
) != 0; }
2518 void SetDirection(bool bForward
)
2519 { if ( bForward
) m_flags
|= IsForward
; else m_flags
&= ~IsForward
; }
2521 // it may be a window change event (MDI, notebook pages...) or a control
2523 bool IsWindowChange() const
2524 { return (m_flags
& WinChange
) != 0; }
2525 void SetWindowChange(bool bIs
)
2526 { if ( bIs
) m_flags
|= WinChange
; else m_flags
&= ~WinChange
; }
2528 // Set to true under MSW if the event was generated using the tab key.
2529 // This is required for proper navogation over radio buttons
2530 bool IsFromTab() const
2531 { return (m_flags
& FromTab
) != 0; }
2532 void SetFromTab(bool bIs
)
2533 { if ( bIs
) m_flags
|= FromTab
; else m_flags
&= ~FromTab
; }
2535 // the child which has the focus currently (may be NULL - use
2536 // wxWindow::FindFocus then)
2537 wxWindow
* GetCurrentFocus() const { return m_focus
; }
2538 void SetCurrentFocus(wxWindow
*win
) { m_focus
= win
; }
2541 void SetFlags(long flags
) { m_flags
= flags
; }
2543 virtual wxEvent
*Clone() const { return new wxNavigationKeyEvent(*this); }
2545 enum wxNavigationKeyEventFlags
2547 IsBackward
= 0x0000,
2557 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNavigationKeyEvent
)
2560 // Window creation/destruction events: the first is sent as soon as window is
2561 // created (i.e. the underlying GUI object exists), but when the C++ object is
2562 // fully initialized (so virtual functions may be called). The second,
2563 // wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
2564 // still safe to call virtual functions at this moment
2570 class WXDLLIMPEXP_CORE wxWindowCreateEvent
: public wxCommandEvent
2573 wxWindowCreateEvent(wxWindow
*win
= NULL
);
2575 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
2577 virtual wxEvent
*Clone() const { return new wxWindowCreateEvent(*this); }
2580 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowCreateEvent
)
2583 class WXDLLIMPEXP_CORE wxWindowDestroyEvent
: public wxCommandEvent
2586 wxWindowDestroyEvent(wxWindow
*win
= NULL
);
2588 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
2590 virtual wxEvent
*Clone() const { return new wxWindowDestroyEvent(*this); }
2593 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowDestroyEvent
)
2596 // A help event is sent when the user clicks on a window in context-help mode.
2602 class WXDLLIMPEXP_CORE wxHelpEvent
: public wxCommandEvent
2605 // how was this help event generated?
2608 Origin_Unknown
, // unrecognized event source
2609 Origin_Keyboard
, // event generated from F1 key press
2610 Origin_HelpButton
// event from [?] button on the title bar (Windows)
2613 wxHelpEvent(wxEventType type
= wxEVT_NULL
,
2614 wxWindowID winid
= 0,
2615 const wxPoint
& pt
= wxDefaultPosition
,
2616 Origin origin
= Origin_Unknown
)
2617 : wxCommandEvent(type
, winid
),
2619 m_origin(GuessOrigin(origin
))
2621 wxHelpEvent(const wxHelpEvent
& event
)
2622 : wxCommandEvent(event
),
2624 m_target(event
.m_target
),
2625 m_link(event
.m_link
),
2626 m_origin(event
.m_origin
)
2629 // Position of event (in screen coordinates)
2630 const wxPoint
& GetPosition() const { return m_pos
; }
2631 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2633 // Optional link to further help
2634 const wxString
& GetLink() const { return m_link
; }
2635 void SetLink(const wxString
& link
) { m_link
= link
; }
2637 // Optional target to display help in. E.g. a window specification
2638 const wxString
& GetTarget() const { return m_target
; }
2639 void SetTarget(const wxString
& target
) { m_target
= target
; }
2641 virtual wxEvent
*Clone() const { return new wxHelpEvent(*this); }
2643 // optional indication of the event source
2644 Origin
GetOrigin() const { return m_origin
; }
2645 void SetOrigin(Origin origin
) { m_origin
= origin
; }
2653 // we can try to guess the event origin ourselves, even if none is
2654 // specified in the ctor
2655 static Origin
GuessOrigin(Origin origin
);
2658 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHelpEvent
)
2661 // A Clipboard Text event is sent when a window intercepts text copy/cut/paste
2662 // message, i.e. the user has cut/copied/pasted data from/into a text control
2663 // via ctrl-C/X/V, ctrl/shift-del/insert, a popup menu command, etc.
2664 // NOTE : under windows these events are *NOT* generated automatically
2665 // for a Rich Edit text control.
2667 wxEVT_COMMAND_TEXT_COPY
2668 wxEVT_COMMAND_TEXT_CUT
2669 wxEVT_COMMAND_TEXT_PASTE
2672 class WXDLLIMPEXP_CORE wxClipboardTextEvent
: public wxCommandEvent
2675 wxClipboardTextEvent(wxEventType type
= wxEVT_NULL
,
2676 wxWindowID winid
= 0)
2677 : wxCommandEvent(type
, winid
)
2679 wxClipboardTextEvent(const wxClipboardTextEvent
& event
)
2680 : wxCommandEvent(event
)
2683 virtual wxEvent
*Clone() const { return new wxClipboardTextEvent(*this); }
2686 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxClipboardTextEvent
)
2689 // A Context event is sent when the user right clicks on a window or
2690 // presses Shift-F10
2691 // NOTE : Under windows this is a repackaged WM_CONTETXMENU message
2692 // Under other systems it may have to be generated from a right click event
2697 class WXDLLIMPEXP_CORE wxContextMenuEvent
: public wxCommandEvent
2700 wxContextMenuEvent(wxEventType type
= wxEVT_NULL
,
2701 wxWindowID winid
= 0,
2702 const wxPoint
& pt
= wxDefaultPosition
)
2703 : wxCommandEvent(type
, winid
),
2706 wxContextMenuEvent(const wxContextMenuEvent
& event
)
2707 : wxCommandEvent(event
),
2711 // Position of event (in screen coordinates)
2712 const wxPoint
& GetPosition() const { return m_pos
; }
2713 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2715 virtual wxEvent
*Clone() const { return new wxContextMenuEvent(*this); }
2721 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxContextMenuEvent
)
2731 // Whether to always send idle events to windows, or
2732 // to only send update events to those with the
2733 // wxWS_EX_PROCESS_IDLE style.
2737 // Send idle events to all windows
2740 // Send idle events to windows that have
2741 // the wxWS_EX_PROCESS_IDLE flag specified
2742 wxIDLE_PROCESS_SPECIFIED
2745 class WXDLLIMPEXP_BASE wxIdleEvent
: public wxEvent
2749 : wxEvent(0, wxEVT_IDLE
),
2750 m_requestMore(false)
2752 wxIdleEvent(const wxIdleEvent
& event
)
2754 m_requestMore(event
.m_requestMore
)
2757 void RequestMore(bool needMore
= true) { m_requestMore
= needMore
; }
2758 bool MoreRequested() const { return m_requestMore
; }
2760 virtual wxEvent
*Clone() const { return new wxIdleEvent(*this); }
2762 // Specify how wxWidgets will send idle events: to
2763 // all windows, or only to those which specify that they
2764 // will process the events.
2765 static void SetMode(wxIdleMode mode
) { sm_idleMode
= mode
; }
2767 // Returns the idle event mode
2768 static wxIdleMode
GetMode() { return sm_idleMode
; }
2772 static wxIdleMode sm_idleMode
;
2775 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIdleEvent
)
2779 wxEVT_MOUSE_CAPTURE_CHANGED,
2780 wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
2781 // wxEVT_FONT_CHANGED, // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
2782 // wxEVT_FONT_CHANGED to all other windows (maybe).
2783 wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
2790 // ============================================================================
2791 // event handler and related classes
2792 // ============================================================================
2795 // struct containing the members common to static and dynamic event tables
2797 struct WXDLLIMPEXP_BASE wxEventTableEntryBase
2799 wxEventTableEntryBase(int winid
, int idLast
,
2800 wxEventFunctor
* fn
, wxObject
*data
)
2804 m_callbackUserData(data
)
2806 wxASSERT_MSG( idLast
== wxID_ANY
|| winid
<= idLast
,
2807 "invalid IDs range: lower bound > upper bound" );
2810 wxEventTableEntryBase( const wxEventTableEntryBase
&entry
)
2811 : m_id( entry
.m_id
),
2812 m_lastId( entry
.m_lastId
),
2814 m_callbackUserData( entry
.m_callbackUserData
)
2816 // This is a 'hack' to ensure that only one instance tries to delete
2817 // the functor pointer. It is safe as long as the only place where the
2818 // copy constructor is being called is when the static event tables are
2819 // being initialized (a temporary instance is created and then this
2820 // constructor is called).
2822 const_cast<wxEventTableEntryBase
&>( entry
).m_fn
= NULL
;
2825 ~wxEventTableEntryBase()
2830 // the range of ids for this entry: if m_lastId == wxID_ANY, the range
2831 // consists only of m_id, otherwise it is m_id..m_lastId inclusive
2835 // function/method/functor to call
2836 wxEventFunctor
* m_fn
;
2838 // arbitrary user data associated with the callback
2839 wxObject
* m_callbackUserData
;
2842 wxDECLARE_NO_ASSIGN_CLASS(wxEventTableEntryBase
);
2845 // an entry from a static event table
2846 struct WXDLLIMPEXP_BASE wxEventTableEntry
: public wxEventTableEntryBase
2848 wxEventTableEntry(const int& evType
, int winid
, int idLast
,
2849 wxEventFunctor
* fn
, wxObject
*data
)
2850 : wxEventTableEntryBase(winid
, idLast
, fn
, data
),
2854 // the reference to event type: this allows us to not care about the
2855 // (undefined) order in which the event table entries and the event types
2856 // are initialized: initially the value of this reference might be
2857 // invalid, but by the time it is used for the first time, all global
2858 // objects will have been initialized (including the event type constants)
2859 // and so it will have the correct value when it is needed
2860 const int& m_eventType
;
2863 wxDECLARE_NO_ASSIGN_CLASS(wxEventTableEntry
);
2866 // an entry used in dynamic event table managed by wxEvtHandler::Connect()
2867 struct WXDLLIMPEXP_BASE wxDynamicEventTableEntry
: public wxEventTableEntryBase
2869 wxDynamicEventTableEntry(int evType
, int winid
, int idLast
,
2870 wxEventFunctor
* fn
, wxObject
*data
)
2871 : wxEventTableEntryBase(winid
, idLast
, fn
, data
),
2875 // not a reference here as we can't keep a reference to a temporary int
2876 // created to wrap the constant value typically passed to Connect() - nor
2881 wxDECLARE_NO_ASSIGN_CLASS(wxDynamicEventTableEntry
);
2884 // ----------------------------------------------------------------------------
2885 // wxEventTable: an array of event entries terminated with {0, 0, 0, 0, 0}
2886 // ----------------------------------------------------------------------------
2888 struct WXDLLIMPEXP_BASE wxEventTable
2890 const wxEventTable
*baseTable
; // base event table (next in chain)
2891 const wxEventTableEntry
*entries
; // bottom of entry array
2894 // ----------------------------------------------------------------------------
2895 // wxEventHashTable: a helper of wxEvtHandler to speed up wxEventTable lookups.
2896 // ----------------------------------------------------------------------------
2898 WX_DEFINE_ARRAY_PTR(const wxEventTableEntry
*, wxEventTableEntryPointerArray
);
2900 class WXDLLIMPEXP_BASE wxEventHashTable
2903 // Internal data structs
2904 struct EventTypeTable
2906 wxEventType eventType
;
2907 wxEventTableEntryPointerArray eventEntryTable
;
2909 typedef EventTypeTable
* EventTypeTablePointer
;
2912 // Constructor, needs the event table it needs to hash later on.
2913 // Note: hashing of the event table is not done in the constructor as it
2914 // can be that the event table is not yet full initialize, the hash
2915 // will gets initialized when handling the first event look-up request.
2916 wxEventHashTable(const wxEventTable
&table
);
2918 ~wxEventHashTable();
2920 // Handle the given event, in other words search the event table hash
2921 // and call self->ProcessEvent() if a match was found.
2922 bool HandleEvent(wxEvent
& event
, wxEvtHandler
*self
);
2927 #if wxUSE_MEMORY_TRACING
2928 // Clear all tables: only used to work around problems in memory tracing
2930 static void ClearAll();
2931 #endif // wxUSE_MEMORY_TRACING
2934 // Init the hash table with the entries of the static event table.
2935 void InitHashTable();
2936 // Helper funtion of InitHashTable() to insert 1 entry into the hash table.
2937 void AddEntry(const wxEventTableEntry
&entry
);
2938 // Allocate and init with null pointers the base hash table.
2939 void AllocEventTypeTable(size_t size
);
2940 // Grow the hash table in size and transfer all items currently
2941 // in the table to the correct location in the new table.
2942 void GrowEventTypeTable();
2945 const wxEventTable
&m_table
;
2949 EventTypeTablePointer
*m_eventTypeTable
;
2951 static wxEventHashTable
* sm_first
;
2952 wxEventHashTable
* m_previous
;
2953 wxEventHashTable
* m_next
;
2955 wxDECLARE_NO_COPY_CLASS(wxEventHashTable
);
2958 // ----------------------------------------------------------------------------
2959 // wxEvtHandler: the base class for all objects handling wxWidgets events
2960 // ----------------------------------------------------------------------------
2962 class WXDLLIMPEXP_BASE wxEvtHandler
: public wxObject
2963 , public wxTrackable
2967 virtual ~wxEvtHandler();
2970 // Event handler chain
2971 // -------------------
2973 wxEvtHandler
*GetNextHandler() const { return m_nextHandler
; }
2974 wxEvtHandler
*GetPreviousHandler() const { return m_previousHandler
; }
2975 virtual void SetNextHandler(wxEvtHandler
*handler
) { m_nextHandler
= handler
; }
2976 virtual void SetPreviousHandler(wxEvtHandler
*handler
) { m_previousHandler
= handler
; }
2978 void SetEvtHandlerEnabled(bool enabled
) { m_enabled
= enabled
; }
2979 bool GetEvtHandlerEnabled() const { return m_enabled
; }
2982 bool IsUnlinked() const;
2986 // Event queuing and processing
2987 // ----------------------------
2989 // Process an event right now: this can only be called from the main
2990 // thread, use QueueEvent() for scheduling the events for
2991 // processing from other threads.
2992 virtual bool ProcessEvent(wxEvent
& event
);
2994 // Process an event by calling ProcessEvent and handling any exceptions
2995 // thrown by event handlers. It's mostly useful when processing wx events
2996 // when called from C code (e.g. in GTK+ callback) when the exception
2997 // wouldn't correctly propagate to wxEventLoop.
2998 bool SafelyProcessEvent(wxEvent
& event
);
2999 // NOTE: uses ProcessEvent()
3001 // This method tries to process the event in this event handler, including
3002 // any preprocessing done by TryBefore() and all the handlers chained to
3003 // it, but excluding the post-processing done in TryAfter().
3005 // It is meant to be called from ProcessEvent() only and is not virtual,
3006 // additional event handlers can be hooked into the normal event processing
3007 // logic using TryBefore() and TryAfter() hooks.
3009 // You can also call it yourself to forward an event to another handler but
3010 // without propagating it upwards if it's unhandled (this is usually
3011 // unwanted when forwarding as the original handler would already do it if
3012 // needed normally).
3013 bool ProcessEventLocally(wxEvent
& event
);
3015 // Schedule the given event to be processed later. It takes ownership of
3016 // the event pointer, i.e. it will be deleted later. This is safe to call
3017 // from multiple threads although you still need to ensure that wxString
3018 // fields of the event object are deep copies and not use the same string
3019 // buffer as other wxString objects in this thread.
3020 virtual void QueueEvent(wxEvent
*event
);
3022 // Add an event to be processed later: notice that this function is not
3023 // safe to call from threads other than main, use QueueEvent()
3024 virtual void AddPendingEvent(const wxEvent
& event
)
3026 // notice that the thread-safety problem comes from the fact that
3027 // Clone() doesn't make deep copies of wxString fields of wxEvent
3028 // object and so the same wxString could be used from both threads when
3029 // the event object is destroyed in this one -- QueueEvent() avoids
3030 // this problem as the event pointer is not used any more in this
3031 // thread at all after it is called.
3032 QueueEvent(event
.Clone());
3035 void ProcessPendingEvents();
3036 // NOTE: uses ProcessEvent()
3038 void DeletePendingEvents();
3041 bool ProcessThreadEvent(const wxEvent
& event
);
3042 // NOTE: uses AddPendingEvent(); call only from secondary threads
3046 // Connecting and disconnecting
3047 // ----------------------------
3049 // These functions are used for old, untyped, event handlers and don't
3050 // check that the type of the function passed to them actually matches the
3051 // type of the event. They also only allow connecting events to methods of
3052 // wxEvtHandler-derived classes.
3054 // The template Connect() methods below are safer and allow connecting
3055 // events to arbitrary functions or functors -- but require compiler
3056 // support for templates.
3058 // Dynamic association of a member function handler with the event handler,
3059 // winid and event type
3060 void Connect(int winid
,
3062 wxEventType eventType
,
3063 wxObjectEventFunction func
,
3064 wxObject
*userData
= NULL
,
3065 wxEvtHandler
*eventSink
= NULL
)
3067 DoBind(winid
, lastId
, eventType
,
3068 wxNewEventFunctor(eventType
, func
, eventSink
),
3072 // Convenience function: take just one id
3073 void Connect(int winid
,
3074 wxEventType eventType
,
3075 wxObjectEventFunction func
,
3076 wxObject
*userData
= NULL
,
3077 wxEvtHandler
*eventSink
= NULL
)
3078 { Connect(winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3080 // Even more convenient: without id (same as using id of wxID_ANY)
3081 void Connect(wxEventType eventType
,
3082 wxObjectEventFunction func
,
3083 wxObject
*userData
= NULL
,
3084 wxEvtHandler
*eventSink
= NULL
)
3085 { Connect(wxID_ANY
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3087 bool Disconnect(int winid
,
3089 wxEventType eventType
,
3090 wxObjectEventFunction func
= NULL
,
3091 wxObject
*userData
= NULL
,
3092 wxEvtHandler
*eventSink
= NULL
)
3094 return DoUnbind(winid
, lastId
, eventType
,
3095 wxMakeEventFunctor(eventType
, func
, eventSink
),
3099 bool Disconnect(int winid
= wxID_ANY
,
3100 wxEventType eventType
= wxEVT_NULL
,
3101 wxObjectEventFunction func
= NULL
,
3102 wxObject
*userData
= NULL
,
3103 wxEvtHandler
*eventSink
= NULL
)
3104 { return Disconnect(winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3106 bool Disconnect(wxEventType eventType
,
3107 wxObjectEventFunction func
,
3108 wxObject
*userData
= NULL
,
3109 wxEvtHandler
*eventSink
= NULL
)
3110 { return Disconnect(wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3112 #ifdef wxHAS_EVENT_BIND
3113 // Bind functions to an event:
3114 template <typename EventTag
, typename EventArg
>
3115 void Bind(const EventTag
& eventType
,
3116 void (*function
)(EventArg
&),
3117 int winid
= wxID_ANY
,
3118 int lastId
= wxID_ANY
,
3119 wxObject
*userData
= NULL
)
3121 DoBind(winid
, lastId
, eventType
,
3122 wxNewEventFunctor(eventType
, function
),
3127 template <typename EventTag
, typename EventArg
>
3128 bool Unbind(const EventTag
& eventType
,
3129 void (*function
)(EventArg
&),
3130 int winid
= wxID_ANY
,
3131 int lastId
= wxID_ANY
,
3132 wxObject
*userData
= NULL
)
3134 return DoUnbind(winid
, lastId
, eventType
,
3135 wxMakeEventFunctor(eventType
, function
),
3139 // Bind functors to an event:
3140 template <typename EventTag
, typename Functor
>
3141 void Bind(const EventTag
& eventType
,
3142 const Functor
&functor
,
3143 int winid
= wxID_ANY
,
3144 int lastId
= wxID_ANY
,
3145 wxObject
*userData
= NULL
)
3147 DoBind(winid
, lastId
, eventType
,
3148 wxNewEventFunctor(eventType
, functor
),
3153 template <typename EventTag
, typename Functor
>
3154 bool Unbind(const EventTag
& eventType
,
3155 const Functor
&functor
,
3156 int winid
= wxID_ANY
,
3157 int lastId
= wxID_ANY
,
3158 wxObject
*userData
= NULL
)
3160 return DoUnbind(winid
, lastId
, eventType
,
3161 wxMakeEventFunctor(eventType
, functor
),
3166 // Bind a method of a class (called on the specified handler which must
3167 // be convertible to this class) object to an event:
3169 template <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
3170 void Bind(const EventTag
&eventType
,
3171 void (Class::*method
)(EventArg
&),
3172 EventHandler
*handler
,
3173 int winid
= wxID_ANY
,
3174 int lastId
= wxID_ANY
,
3175 wxObject
*userData
= NULL
)
3177 DoBind(winid
, lastId
, eventType
,
3178 wxNewEventFunctor(eventType
, method
, handler
),
3182 template <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
3183 bool Unbind(const EventTag
&eventType
,
3184 void (Class::*method
)(EventArg
&),
3185 EventHandler
*handler
,
3186 int winid
= wxID_ANY
,
3187 int lastId
= wxID_ANY
,
3188 wxObject
*userData
= NULL
)
3190 return DoUnbind(winid
, lastId
, eventType
,
3191 wxMakeEventFunctor(eventType
, method
, handler
),
3194 #endif // wxHAS_EVENT_BIND
3196 wxList
* GetDynamicEventTable() const { return m_dynamicEvents
; }
3198 // User data can be associated with each wxEvtHandler
3199 void SetClientObject( wxClientData
*data
) { DoSetClientObject(data
); }
3200 wxClientData
*GetClientObject() const { return DoGetClientObject(); }
3202 void SetClientData( void *data
) { DoSetClientData(data
); }
3203 void *GetClientData() const { return DoGetClientData(); }
3206 // implementation from now on
3207 // --------------------------
3209 // check if the given event table entry matches this event by id (the check
3210 // for the event type should be done by caller) and call the handler if it
3213 // return true if the event was processed, false otherwise (no match or the
3214 // handler decided to skip the event)
3215 static bool ProcessEventIfMatchesId(const wxEventTableEntryBase
& tableEntry
,
3216 wxEvtHandler
*handler
,
3219 virtual bool SearchEventTable(wxEventTable
& table
, wxEvent
& event
);
3220 bool SearchDynamicEventTable( wxEvent
& event
);
3222 // Avoid problems at exit by cleaning up static hash table gracefully
3223 void ClearEventHashTable() { GetEventHashTable().Clear(); }
3224 void OnSinkDestroyed( wxEvtHandler
*sink
);
3228 void DoBind(int winid
,
3230 wxEventType eventType
,
3231 wxEventFunctor
*func
,
3232 wxObject
* userData
= NULL
);
3234 bool DoUnbind(int winid
,
3236 wxEventType eventType
,
3237 const wxEventFunctor
& func
,
3238 wxObject
*userData
= NULL
);
3240 static const wxEventTableEntry sm_eventTableEntries
[];
3243 // hooks for wxWindow used by ProcessEvent()
3244 // -----------------------------------------
3246 // this one is called before trying our own event table to allow plugging
3247 // in the event handlers overriding the default logic, this is used by e.g.
3249 virtual bool TryBefore(wxEvent
& event
);
3251 // This one is not a hook but just a helper which looks up the handler in
3252 // this object itself.
3254 // It is called from ProcessEventLocally() and normally shouldn't be called
3255 // directly as doing it would ignore any chained event handlers
3256 bool TryHereOnly(wxEvent
& event
);
3258 // Another helper which simply calls pre-processing hook and then tries to
3259 // handle the event at this handler level.
3260 bool TryBeforeAndHere(wxEvent
& event
)
3262 return TryBefore(event
) || TryHereOnly(event
);
3265 // this one is called after failing to find the event handle in our own
3266 // table to give a chance to the other windows to process it
3268 // base class implementation passes the event to wxTheApp
3269 virtual bool TryAfter(wxEvent
& event
);
3271 #ifdef WXWIN_COMPATIBILITY_2_8
3272 // deprecated method: override TryBefore() instead of this one
3273 wxDEPRECATED_BUT_USED_INTERNALLY_INLINE(
3274 virtual bool TryValidator(wxEvent
& WXUNUSED(event
)), return false; )
3276 wxDEPRECATED_BUT_USED_INTERNALLY_INLINE(
3277 virtual bool TryParent(wxEvent
& event
), return DoTryApp(event
); )
3278 #endif // WXWIN_COMPATIBILITY_2_8
3281 static const wxEventTable sm_eventTable
;
3282 virtual const wxEventTable
*GetEventTable() const;
3284 static wxEventHashTable sm_eventHashTable
;
3285 virtual wxEventHashTable
& GetEventHashTable() const;
3287 wxEvtHandler
* m_nextHandler
;
3288 wxEvtHandler
* m_previousHandler
;
3289 wxList
* m_dynamicEvents
;
3290 wxList
* m_pendingEvents
;
3293 // critical section protecting m_pendingEvents
3294 wxCriticalSection m_pendingEventsLock
;
3295 #endif // wxUSE_THREADS
3297 // Is event handler enabled?
3301 // The user data: either an object which will be deleted by the container
3302 // when it's deleted or some raw pointer which we do nothing with - only
3303 // one type of data can be used with the given window (i.e. you cannot set
3304 // the void data and then associate the container with wxClientData or vice
3308 wxClientData
*m_clientObject
;
3312 // what kind of data do we have?
3313 wxClientDataType m_clientDataType
;
3315 // client data accessors
3316 virtual void DoSetClientObject( wxClientData
*data
);
3317 virtual wxClientData
*DoGetClientObject() const;
3319 virtual void DoSetClientData( void *data
);
3320 virtual void *DoGetClientData() const;
3322 // Search tracker objects for event connection with this sink
3323 wxEventConnectionRef
*FindRefInTrackerList(wxEvtHandler
*handler
);
3326 // pass the event to wxTheApp instance, called from TryAfter()
3327 bool DoTryApp(wxEvent
& event
);
3329 // try to process events in all handlers chained to this one
3330 bool DoTryChain(wxEvent
& event
);
3332 DECLARE_DYNAMIC_CLASS_NO_COPY(wxEvtHandler
)
3335 WX_DEFINE_ARRAY_WITH_DECL_PTR(wxEvtHandler
*, wxEvtHandlerArray
, class WXDLLIMPEXP_BASE
);
3338 // Define an inline method of wxObjectEventFunctor which couldn't be defined
3339 // before wxEvtHandler declaration: at least Sun CC refuses to compile function
3340 // calls through pointer to member for forward-declared classes (see #12452).
3341 inline void wxObjectEventFunctor::operator()(wxEvtHandler
*handler
, wxEvent
& event
)
3343 wxEvtHandler
* const realHandler
= m_handler
? m_handler
: handler
;
3345 (realHandler
->*m_method
)(event
);
3348 // ----------------------------------------------------------------------------
3349 // wxEventConnectionRef represents all connections between two event handlers
3350 // and enables automatic disconnect when an event handler sink goes out of
3351 // scope. Each connection/disconnect increases/decreases ref count, and
3352 // when it reaches zero the node goes out of scope.
3353 // ----------------------------------------------------------------------------
3355 class wxEventConnectionRef
: public wxTrackerNode
3358 wxEventConnectionRef() : m_src(NULL
), m_sink(NULL
), m_refCount(0) { }
3359 wxEventConnectionRef(wxEvtHandler
*src
, wxEvtHandler
*sink
)
3360 : m_src(src
), m_sink(sink
), m_refCount(1)
3362 m_sink
->AddNode(this);
3365 // The sink is being destroyed
3366 virtual void OnObjectDestroy( )
3369 m_src
->OnSinkDestroyed( m_sink
);
3373 virtual wxEventConnectionRef
*ToEventConnection() { return this; }
3375 void IncRef() { m_refCount
++; }
3378 if ( !--m_refCount
)
3380 // The sink holds the only external pointer to this object
3382 m_sink
->RemoveNode(this);
3388 wxEvtHandler
*m_src
,
3392 friend class wxEvtHandler
;
3394 wxDECLARE_NO_ASSIGN_CLASS(wxEventConnectionRef
);
3397 // Post a message to the given event handler which will be processed during the
3398 // next event loop iteration.
3400 // Notice that this one is not thread-safe, use wxQueueEvent()
3401 inline void wxPostEvent(wxEvtHandler
*dest
, const wxEvent
& event
)
3403 wxCHECK_RET( dest
, "need an object to post event to" );
3405 dest
->AddPendingEvent(event
);
3408 // Wrapper around wxEvtHandler::QueueEvent(): adds an event for later
3409 // processing, unlike wxPostEvent it is safe to use from different thread even
3410 // for events with wxString members
3411 inline void wxQueueEvent(wxEvtHandler
*dest
, wxEvent
*event
)
3413 wxCHECK_RET( dest
, "need an object to queue event for" );
3415 dest
->QueueEvent(event
);
3418 typedef void (wxEvtHandler::*wxEventFunction
)(wxEvent
&);
3419 typedef void (wxEvtHandler::*wxIdleEventFunction
)(wxIdleEvent
&);
3421 #define wxEventHandler(func) \
3422 wxEVENT_HANDLER_CAST(wxEventFunction, func)
3423 #define wxIdleEventHandler(func) \
3424 wxEVENT_HANDLER_CAST(wxIdleEventFunction, func)
3428 // ----------------------------------------------------------------------------
3429 // wxEventBlocker: helper class to temporarily disable event handling for a window
3430 // ----------------------------------------------------------------------------
3432 class WXDLLIMPEXP_CORE wxEventBlocker
: public wxEvtHandler
3435 wxEventBlocker(wxWindow
*win
, wxEventType type
= wxEVT_ANY
);
3436 virtual ~wxEventBlocker();
3438 void Block(wxEventType type
)
3440 m_eventsToBlock
.push_back(type
);
3443 virtual bool ProcessEvent(wxEvent
& event
);
3446 wxArrayInt m_eventsToBlock
;
3449 wxDECLARE_NO_COPY_CLASS(wxEventBlocker
);
3452 typedef void (wxEvtHandler::*wxCommandEventFunction
)(wxCommandEvent
&);
3453 typedef void (wxEvtHandler::*wxThreadEventFunction
)(wxThreadEvent
&);
3454 typedef void (wxEvtHandler::*wxScrollEventFunction
)(wxScrollEvent
&);
3455 typedef void (wxEvtHandler::*wxScrollWinEventFunction
)(wxScrollWinEvent
&);
3456 typedef void (wxEvtHandler::*wxSizeEventFunction
)(wxSizeEvent
&);
3457 typedef void (wxEvtHandler::*wxMoveEventFunction
)(wxMoveEvent
&);
3458 typedef void (wxEvtHandler::*wxPaintEventFunction
)(wxPaintEvent
&);
3459 typedef void (wxEvtHandler::*wxNcPaintEventFunction
)(wxNcPaintEvent
&);
3460 typedef void (wxEvtHandler::*wxEraseEventFunction
)(wxEraseEvent
&);
3461 typedef void (wxEvtHandler::*wxMouseEventFunction
)(wxMouseEvent
&);
3462 typedef void (wxEvtHandler::*wxCharEventFunction
)(wxKeyEvent
&);
3463 typedef void (wxEvtHandler::*wxFocusEventFunction
)(wxFocusEvent
&);
3464 typedef void (wxEvtHandler::*wxChildFocusEventFunction
)(wxChildFocusEvent
&);
3465 typedef void (wxEvtHandler::*wxActivateEventFunction
)(wxActivateEvent
&);
3466 typedef void (wxEvtHandler::*wxMenuEventFunction
)(wxMenuEvent
&);
3467 typedef void (wxEvtHandler::*wxJoystickEventFunction
)(wxJoystickEvent
&);
3468 typedef void (wxEvtHandler::*wxDropFilesEventFunction
)(wxDropFilesEvent
&);
3469 typedef void (wxEvtHandler::*wxInitDialogEventFunction
)(wxInitDialogEvent
&);
3470 typedef void (wxEvtHandler::*wxSysColourChangedEventFunction
)(wxSysColourChangedEvent
&);
3471 typedef void (wxEvtHandler::*wxDisplayChangedEventFunction
)(wxDisplayChangedEvent
&);
3472 typedef void (wxEvtHandler::*wxUpdateUIEventFunction
)(wxUpdateUIEvent
&);
3473 typedef void (wxEvtHandler::*wxCloseEventFunction
)(wxCloseEvent
&);
3474 typedef void (wxEvtHandler::*wxShowEventFunction
)(wxShowEvent
&);
3475 typedef void (wxEvtHandler::*wxIconizeEventFunction
)(wxIconizeEvent
&);
3476 typedef void (wxEvtHandler::*wxMaximizeEventFunction
)(wxMaximizeEvent
&);
3477 typedef void (wxEvtHandler::*wxNavigationKeyEventFunction
)(wxNavigationKeyEvent
&);
3478 typedef void (wxEvtHandler::*wxPaletteChangedEventFunction
)(wxPaletteChangedEvent
&);
3479 typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction
)(wxQueryNewPaletteEvent
&);
3480 typedef void (wxEvtHandler::*wxWindowCreateEventFunction
)(wxWindowCreateEvent
&);
3481 typedef void (wxEvtHandler::*wxWindowDestroyEventFunction
)(wxWindowDestroyEvent
&);
3482 typedef void (wxEvtHandler::*wxSetCursorEventFunction
)(wxSetCursorEvent
&);
3483 typedef void (wxEvtHandler::*wxNotifyEventFunction
)(wxNotifyEvent
&);
3484 typedef void (wxEvtHandler::*wxHelpEventFunction
)(wxHelpEvent
&);
3485 typedef void (wxEvtHandler::*wxContextMenuEventFunction
)(wxContextMenuEvent
&);
3486 typedef void (wxEvtHandler::*wxMouseCaptureChangedEventFunction
)(wxMouseCaptureChangedEvent
&);
3487 typedef void (wxEvtHandler::*wxMouseCaptureLostEventFunction
)(wxMouseCaptureLostEvent
&);
3488 typedef void (wxEvtHandler::*wxClipboardTextEventFunction
)(wxClipboardTextEvent
&);
3491 #define wxCommandEventHandler(func) \
3492 wxEVENT_HANDLER_CAST(wxCommandEventFunction, func)
3493 #define wxThreadEventHandler(func) \
3494 wxEVENT_HANDLER_CAST(wxThreadEventFunction, func)
3495 #define wxScrollEventHandler(func) \
3496 wxEVENT_HANDLER_CAST(wxScrollEventFunction, func)
3497 #define wxScrollWinEventHandler(func) \
3498 wxEVENT_HANDLER_CAST(wxScrollWinEventFunction, func)
3499 #define wxSizeEventHandler(func) \
3500 wxEVENT_HANDLER_CAST(wxSizeEventFunction, func)
3501 #define wxMoveEventHandler(func) \
3502 wxEVENT_HANDLER_CAST(wxMoveEventFunction, func)
3503 #define wxPaintEventHandler(func) \
3504 wxEVENT_HANDLER_CAST(wxPaintEventFunction, func)
3505 #define wxNcPaintEventHandler(func) \
3506 wxEVENT_HANDLER_CAST(wxNcPaintEventFunction, func)
3507 #define wxEraseEventHandler(func) \
3508 wxEVENT_HANDLER_CAST(wxEraseEventFunction, func)
3509 #define wxMouseEventHandler(func) \
3510 wxEVENT_HANDLER_CAST(wxMouseEventFunction, func)
3511 #define wxCharEventHandler(func) \
3512 wxEVENT_HANDLER_CAST(wxCharEventFunction, func)
3513 #define wxKeyEventHandler(func) wxCharEventHandler(func)
3514 #define wxFocusEventHandler(func) \
3515 wxEVENT_HANDLER_CAST(wxFocusEventFunction, func)
3516 #define wxChildFocusEventHandler(func) \
3517 wxEVENT_HANDLER_CAST(wxChildFocusEventFunction, func)
3518 #define wxActivateEventHandler(func) \
3519 wxEVENT_HANDLER_CAST(wxActivateEventFunction, func)
3520 #define wxMenuEventHandler(func) \
3521 wxEVENT_HANDLER_CAST(wxMenuEventFunction, func)
3522 #define wxJoystickEventHandler(func) \
3523 wxEVENT_HANDLER_CAST(wxJoystickEventFunction, func)
3524 #define wxDropFilesEventHandler(func) \
3525 wxEVENT_HANDLER_CAST(wxDropFilesEventFunction, func)
3526 #define wxInitDialogEventHandler(func) \
3527 wxEVENT_HANDLER_CAST(wxInitDialogEventFunction, func)
3528 #define wxSysColourChangedEventHandler(func) \
3529 wxEVENT_HANDLER_CAST(wxSysColourChangedEventFunction, func)
3530 #define wxDisplayChangedEventHandler(func) \
3531 wxEVENT_HANDLER_CAST(wxDisplayChangedEventFunction, func)
3532 #define wxUpdateUIEventHandler(func) \
3533 wxEVENT_HANDLER_CAST(wxUpdateUIEventFunction, func)
3534 #define wxCloseEventHandler(func) \
3535 wxEVENT_HANDLER_CAST(wxCloseEventFunction, func)
3536 #define wxShowEventHandler(func) \
3537 wxEVENT_HANDLER_CAST(wxShowEventFunction, func)
3538 #define wxIconizeEventHandler(func) \
3539 wxEVENT_HANDLER_CAST(wxIconizeEventFunction, func)
3540 #define wxMaximizeEventHandler(func) \
3541 wxEVENT_HANDLER_CAST(wxMaximizeEventFunction, func)
3542 #define wxNavigationKeyEventHandler(func) \
3543 wxEVENT_HANDLER_CAST(wxNavigationKeyEventFunction, func)
3544 #define wxPaletteChangedEventHandler(func) \
3545 wxEVENT_HANDLER_CAST(wxPaletteChangedEventFunction, func)
3546 #define wxQueryNewPaletteEventHandler(func) \
3547 wxEVENT_HANDLER_CAST(wxQueryNewPaletteEventFunction, func)
3548 #define wxWindowCreateEventHandler(func) \
3549 wxEVENT_HANDLER_CAST(wxWindowCreateEventFunction, func)
3550 #define wxWindowDestroyEventHandler(func) \
3551 wxEVENT_HANDLER_CAST(wxWindowDestroyEventFunction, func)
3552 #define wxSetCursorEventHandler(func) \
3553 wxEVENT_HANDLER_CAST(wxSetCursorEventFunction, func)
3554 #define wxNotifyEventHandler(func) \
3555 wxEVENT_HANDLER_CAST(wxNotifyEventFunction, func)
3556 #define wxHelpEventHandler(func) \
3557 wxEVENT_HANDLER_CAST(wxHelpEventFunction, func)
3558 #define wxContextMenuEventHandler(func) \
3559 wxEVENT_HANDLER_CAST(wxContextMenuEventFunction, func)
3560 #define wxMouseCaptureChangedEventHandler(func) \
3561 wxEVENT_HANDLER_CAST(wxMouseCaptureChangedEventFunction, func)
3562 #define wxMouseCaptureLostEventHandler(func) \
3563 wxEVENT_HANDLER_CAST(wxMouseCaptureLostEventFunction, func)
3564 #define wxClipboardTextEventHandler(func) \
3565 wxEVENT_HANDLER_CAST(wxClipboardTextEventFunction, func)
3569 // N.B. In GNU-WIN32, you *have* to take the address of a member function
3570 // (use &) or the compiler crashes...
3572 #define wxDECLARE_EVENT_TABLE() \
3574 static const wxEventTableEntry sm_eventTableEntries[]; \
3576 static const wxEventTable sm_eventTable; \
3577 virtual const wxEventTable* GetEventTable() const; \
3578 static wxEventHashTable sm_eventHashTable; \
3579 virtual wxEventHashTable& GetEventHashTable() const
3581 // N.B.: when building DLL with Borland C++ 5.5 compiler, you must initialize
3582 // sm_eventTable before using it in GetEventTable() or the compiler gives
3583 // E2233 (see http://groups.google.com/groups?selm=397dcc8a%241_2%40dnews)
3585 #define wxBEGIN_EVENT_TABLE(theClass, baseClass) \
3586 const wxEventTable theClass::sm_eventTable = \
3587 { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] }; \
3588 const wxEventTable *theClass::GetEventTable() const \
3589 { return &theClass::sm_eventTable; } \
3590 wxEventHashTable theClass::sm_eventHashTable(theClass::sm_eventTable); \
3591 wxEventHashTable &theClass::GetEventHashTable() const \
3592 { return theClass::sm_eventHashTable; } \
3593 const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
3595 #define wxBEGIN_EVENT_TABLE_TEMPLATE1(theClass, baseClass, T1) \
3596 template<typename T1> \
3597 const wxEventTable theClass<T1>::sm_eventTable = \
3598 { &baseClass::sm_eventTable, &theClass<T1>::sm_eventTableEntries[0] }; \
3599 template<typename T1> \
3600 const wxEventTable *theClass<T1>::GetEventTable() const \
3601 { return &theClass<T1>::sm_eventTable; } \
3602 template<typename T1> \
3603 wxEventHashTable theClass<T1>::sm_eventHashTable(theClass<T1>::sm_eventTable); \
3604 template<typename T1> \
3605 wxEventHashTable &theClass<T1>::GetEventHashTable() const \
3606 { return theClass<T1>::sm_eventHashTable; } \
3607 template<typename T1> \
3608 const wxEventTableEntry theClass<T1>::sm_eventTableEntries[] = { \
3610 #define wxBEGIN_EVENT_TABLE_TEMPLATE2(theClass, baseClass, T1, T2) \
3611 template<typename T1, typename T2> \
3612 const wxEventTable theClass<T1, T2>::sm_eventTable = \
3613 { &baseClass::sm_eventTable, &theClass<T1, T2>::sm_eventTableEntries[0] }; \
3614 template<typename T1, typename T2> \
3615 const wxEventTable *theClass<T1, T2>::GetEventTable() const \
3616 { return &theClass<T1, T2>::sm_eventTable; } \
3617 template<typename T1, typename T2> \
3618 wxEventHashTable theClass<T1, T2>::sm_eventHashTable(theClass<T1, T2>::sm_eventTable); \
3619 template<typename T1, typename T2> \
3620 wxEventHashTable &theClass<T1, T2>::GetEventHashTable() const \
3621 { return theClass<T1, T2>::sm_eventHashTable; } \
3622 template<typename T1, typename T2> \
3623 const wxEventTableEntry theClass<T1, T2>::sm_eventTableEntries[] = { \
3625 #define wxBEGIN_EVENT_TABLE_TEMPLATE3(theClass, baseClass, T1, T2, T3) \
3626 template<typename T1, typename T2, typename T3> \
3627 const wxEventTable theClass<T1, T2, T3>::sm_eventTable = \
3628 { &baseClass::sm_eventTable, &theClass<T1, T2, T3>::sm_eventTableEntries[0] }; \
3629 template<typename T1, typename T2, typename T3> \
3630 const wxEventTable *theClass<T1, T2, T3>::GetEventTable() const \
3631 { return &theClass<T1, T2, T3>::sm_eventTable; } \
3632 template<typename T1, typename T2, typename T3> \
3633 wxEventHashTable theClass<T1, T2, T3>::sm_eventHashTable(theClass<T1, T2, T3>::sm_eventTable); \
3634 template<typename T1, typename T2, typename T3> \
3635 wxEventHashTable &theClass<T1, T2, T3>::GetEventHashTable() const \
3636 { return theClass<T1, T2, T3>::sm_eventHashTable; } \
3637 template<typename T1, typename T2, typename T3> \
3638 const wxEventTableEntry theClass<T1, T2, T3>::sm_eventTableEntries[] = { \
3640 #define wxBEGIN_EVENT_TABLE_TEMPLATE4(theClass, baseClass, T1, T2, T3, T4) \
3641 template<typename T1, typename T2, typename T3, typename T4> \
3642 const wxEventTable theClass<T1, T2, T3, T4>::sm_eventTable = \
3643 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4>::sm_eventTableEntries[0] }; \
3644 template<typename T1, typename T2, typename T3, typename T4> \
3645 const wxEventTable *theClass<T1, T2, T3, T4>::GetEventTable() const \
3646 { return &theClass<T1, T2, T3, T4>::sm_eventTable; } \
3647 template<typename T1, typename T2, typename T3, typename T4> \
3648 wxEventHashTable theClass<T1, T2, T3, T4>::sm_eventHashTable(theClass<T1, T2, T3, T4>::sm_eventTable); \
3649 template<typename T1, typename T2, typename T3, typename T4> \
3650 wxEventHashTable &theClass<T1, T2, T3, T4>::GetEventHashTable() const \
3651 { return theClass<T1, T2, T3, T4>::sm_eventHashTable; } \
3652 template<typename T1, typename T2, typename T3, typename T4> \
3653 const wxEventTableEntry theClass<T1, T2, T3, T4>::sm_eventTableEntries[] = { \
3655 #define wxBEGIN_EVENT_TABLE_TEMPLATE5(theClass, baseClass, T1, T2, T3, T4, T5) \
3656 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3657 const wxEventTable theClass<T1, T2, T3, T4, T5>::sm_eventTable = \
3658 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[0] }; \
3659 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3660 const wxEventTable *theClass<T1, T2, T3, T4, T5>::GetEventTable() const \
3661 { return &theClass<T1, T2, T3, T4, T5>::sm_eventTable; } \
3662 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3663 wxEventHashTable theClass<T1, T2, T3, T4, T5>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5>::sm_eventTable); \
3664 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3665 wxEventHashTable &theClass<T1, T2, T3, T4, T5>::GetEventHashTable() const \
3666 { return theClass<T1, T2, T3, T4, T5>::sm_eventHashTable; } \
3667 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3668 const wxEventTableEntry theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[] = { \
3670 #define wxBEGIN_EVENT_TABLE_TEMPLATE7(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7) \
3671 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3672 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable = \
3673 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[0] }; \
3674 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3675 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventTable() const \
3676 { return &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable; } \
3677 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3678 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable); \
3679 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3680 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventHashTable() const \
3681 { return theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable; } \
3682 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3683 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[] = { \
3685 #define wxBEGIN_EVENT_TABLE_TEMPLATE8(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7, T8) \
3686 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3687 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable = \
3688 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[0] }; \
3689 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3690 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventTable() const \
3691 { return &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable; } \
3692 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3693 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable); \
3694 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3695 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventHashTable() const \
3696 { return theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable; } \
3697 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3698 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[] = { \
3700 #define wxEND_EVENT_TABLE() \
3701 wxDECLARE_EVENT_TABLE_TERMINATOR() };
3704 * Event table macros
3707 // helpers for writing shorter code below: declare an event macro taking 2, 1
3708 // or none ids (the missing ids default to wxID_ANY)
3711 // - evt one of wxEVT_XXX constants
3712 // - id1, id2 ids of the first/last id
3713 // - fn the function (should be cast to the right type)
3714 #define wx__DECLARE_EVT2(evt, id1, id2, fn) \
3715 wxDECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
3716 #define wx__DECLARE_EVT1(evt, id, fn) \
3717 wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
3718 #define wx__DECLARE_EVT0(evt, fn) \
3719 wx__DECLARE_EVT1(evt, wxID_ANY, fn)
3723 #define EVT_CUSTOM(event, winid, func) \
3724 wx__DECLARE_EVT1(event, winid, wxEventHandler(func))
3725 #define EVT_CUSTOM_RANGE(event, id1, id2, func) \
3726 wx__DECLARE_EVT2(event, id1, id2, wxEventHandler(func))
3729 #define EVT_COMMAND(winid, event, func) \
3730 wx__DECLARE_EVT1(event, winid, wxCommandEventHandler(func))
3732 #define EVT_COMMAND_RANGE(id1, id2, event, func) \
3733 wx__DECLARE_EVT2(event, id1, id2, wxCommandEventHandler(func))
3735 #define EVT_NOTIFY(event, winid, func) \
3736 wx__DECLARE_EVT1(event, winid, wxNotifyEventHandler(func))
3738 #define EVT_NOTIFY_RANGE(event, id1, id2, func) \
3739 wx__DECLARE_EVT2(event, id1, id2, wxNotifyEventHandler(func))
3742 #define EVT_SIZE(func) wx__DECLARE_EVT0(wxEVT_SIZE, wxSizeEventHandler(func))
3743 #define EVT_SIZING(func) wx__DECLARE_EVT0(wxEVT_SIZING, wxSizeEventHandler(func))
3744 #define EVT_MOVE(func) wx__DECLARE_EVT0(wxEVT_MOVE, wxMoveEventHandler(func))
3745 #define EVT_MOVING(func) wx__DECLARE_EVT0(wxEVT_MOVING, wxMoveEventHandler(func))
3746 #define EVT_MOVE_START(func) wx__DECLARE_EVT0(wxEVT_MOVE_START, wxMoveEventHandler(func))
3747 #define EVT_MOVE_END(func) wx__DECLARE_EVT0(wxEVT_MOVE_END, wxMoveEventHandler(func))
3748 #define EVT_CLOSE(func) wx__DECLARE_EVT0(wxEVT_CLOSE_WINDOW, wxCloseEventHandler(func))
3749 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3750 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3751 #define EVT_PAINT(func) wx__DECLARE_EVT0(wxEVT_PAINT, wxPaintEventHandler(func))
3752 #define EVT_NC_PAINT(func) wx__DECLARE_EVT0(wxEVT_NC_PAINT, wxNcPaintEventHandler(func))
3753 #define EVT_ERASE_BACKGROUND(func) wx__DECLARE_EVT0(wxEVT_ERASE_BACKGROUND, wxEraseEventHandler(func))
3754 #define EVT_CHAR(func) wx__DECLARE_EVT0(wxEVT_CHAR, wxCharEventHandler(func))
3755 #define EVT_KEY_DOWN(func) wx__DECLARE_EVT0(wxEVT_KEY_DOWN, wxKeyEventHandler(func))
3756 #define EVT_KEY_UP(func) wx__DECLARE_EVT0(wxEVT_KEY_UP, wxKeyEventHandler(func))
3758 #define EVT_HOTKEY(winid, func) wx__DECLARE_EVT1(wxEVT_HOTKEY, winid, wxCharEventHandler(func))
3760 #define EVT_CHAR_HOOK(func) wx__DECLARE_EVT0(wxEVT_CHAR_HOOK, wxCharEventHandler(func))
3761 #define EVT_MENU_OPEN(func) wx__DECLARE_EVT0(wxEVT_MENU_OPEN, wxMenuEventHandler(func))
3762 #define EVT_MENU_CLOSE(func) wx__DECLARE_EVT0(wxEVT_MENU_CLOSE, wxMenuEventHandler(func))
3763 #define EVT_MENU_HIGHLIGHT(winid, func) wx__DECLARE_EVT1(wxEVT_MENU_HIGHLIGHT, winid, wxMenuEventHandler(func))
3764 #define EVT_MENU_HIGHLIGHT_ALL(func) wx__DECLARE_EVT0(wxEVT_MENU_HIGHLIGHT, wxMenuEventHandler(func))
3765 #define EVT_SET_FOCUS(func) wx__DECLARE_EVT0(wxEVT_SET_FOCUS, wxFocusEventHandler(func))
3766 #define EVT_KILL_FOCUS(func) wx__DECLARE_EVT0(wxEVT_KILL_FOCUS, wxFocusEventHandler(func))
3767 #define EVT_CHILD_FOCUS(func) wx__DECLARE_EVT0(wxEVT_CHILD_FOCUS, wxChildFocusEventHandler(func))
3768 #define EVT_ACTIVATE(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE, wxActivateEventHandler(func))
3769 #define EVT_ACTIVATE_APP(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE_APP, wxActivateEventHandler(func))
3770 #define EVT_HIBERNATE(func) wx__DECLARE_EVT0(wxEVT_HIBERNATE, wxActivateEventHandler(func))
3771 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3772 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3773 #define EVT_DROP_FILES(func) wx__DECLARE_EVT0(wxEVT_DROP_FILES, wxDropFilesEventHandler(func))
3774 #define EVT_INIT_DIALOG(func) wx__DECLARE_EVT0(wxEVT_INIT_DIALOG, wxInitDialogEventHandler(func))
3775 #define EVT_SYS_COLOUR_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEventHandler(func))
3776 #define EVT_DISPLAY_CHANGED(func) wx__DECLARE_EVT0(wxEVT_DISPLAY_CHANGED, wxDisplayChangedEventHandler(func))
3777 #define EVT_SHOW(func) wx__DECLARE_EVT0(wxEVT_SHOW, wxShowEventHandler(func))
3778 #define EVT_MAXIMIZE(func) wx__DECLARE_EVT0(wxEVT_MAXIMIZE, wxMaximizeEventHandler(func))
3779 #define EVT_ICONIZE(func) wx__DECLARE_EVT0(wxEVT_ICONIZE, wxIconizeEventHandler(func))
3780 #define EVT_NAVIGATION_KEY(func) wx__DECLARE_EVT0(wxEVT_NAVIGATION_KEY, wxNavigationKeyEventHandler(func))
3781 #define EVT_PALETTE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_PALETTE_CHANGED, wxPaletteChangedEventHandler(func))
3782 #define EVT_QUERY_NEW_PALETTE(func) wx__DECLARE_EVT0(wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEventHandler(func))
3783 #define EVT_WINDOW_CREATE(func) wx__DECLARE_EVT0(wxEVT_CREATE, wxWindowCreateEventHandler(func))
3784 #define EVT_WINDOW_DESTROY(func) wx__DECLARE_EVT0(wxEVT_DESTROY, wxWindowDestroyEventHandler(func))
3785 #define EVT_SET_CURSOR(func) wx__DECLARE_EVT0(wxEVT_SET_CURSOR, wxSetCursorEventHandler(func))
3786 #define EVT_MOUSE_CAPTURE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEventHandler(func))
3787 #define EVT_MOUSE_CAPTURE_LOST(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEventHandler(func))
3790 #define EVT_LEFT_DOWN(func) wx__DECLARE_EVT0(wxEVT_LEFT_DOWN, wxMouseEventHandler(func))
3791 #define EVT_LEFT_UP(func) wx__DECLARE_EVT0(wxEVT_LEFT_UP, wxMouseEventHandler(func))
3792 #define EVT_MIDDLE_DOWN(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DOWN, wxMouseEventHandler(func))
3793 #define EVT_MIDDLE_UP(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_UP, wxMouseEventHandler(func))
3794 #define EVT_RIGHT_DOWN(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DOWN, wxMouseEventHandler(func))
3795 #define EVT_RIGHT_UP(func) wx__DECLARE_EVT0(wxEVT_RIGHT_UP, wxMouseEventHandler(func))
3796 #define EVT_MOTION(func) wx__DECLARE_EVT0(wxEVT_MOTION, wxMouseEventHandler(func))
3797 #define EVT_LEFT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_LEFT_DCLICK, wxMouseEventHandler(func))
3798 #define EVT_MIDDLE_DCLICK(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DCLICK, wxMouseEventHandler(func))
3799 #define EVT_RIGHT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DCLICK, wxMouseEventHandler(func))
3800 #define EVT_LEAVE_WINDOW(func) wx__DECLARE_EVT0(wxEVT_LEAVE_WINDOW, wxMouseEventHandler(func))
3801 #define EVT_ENTER_WINDOW(func) wx__DECLARE_EVT0(wxEVT_ENTER_WINDOW, wxMouseEventHandler(func))
3802 #define EVT_MOUSEWHEEL(func) wx__DECLARE_EVT0(wxEVT_MOUSEWHEEL, wxMouseEventHandler(func))
3803 #define EVT_MOUSE_AUX1_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX1_DOWN, wxMouseEventHandler(func))
3804 #define EVT_MOUSE_AUX1_UP(func) wx__DECLARE_EVT0(wxEVT_AUX1_UP, wxMouseEventHandler(func))
3805 #define EVT_MOUSE_AUX1_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX1_DCLICK, wxMouseEventHandler(func))
3806 #define EVT_MOUSE_AUX2_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX2_DOWN, wxMouseEventHandler(func))
3807 #define EVT_MOUSE_AUX2_UP(func) wx__DECLARE_EVT0(wxEVT_AUX2_UP, wxMouseEventHandler(func))
3808 #define EVT_MOUSE_AUX2_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX2_DCLICK, wxMouseEventHandler(func))
3811 #define EVT_MOUSE_EVENTS(func) \
3812 EVT_LEFT_DOWN(func) \
3814 EVT_LEFT_DCLICK(func) \
3815 EVT_MIDDLE_DOWN(func) \
3816 EVT_MIDDLE_UP(func) \
3817 EVT_MIDDLE_DCLICK(func) \
3818 EVT_RIGHT_DOWN(func) \
3819 EVT_RIGHT_UP(func) \
3820 EVT_RIGHT_DCLICK(func) \
3821 EVT_MOUSE_AUX1_DOWN(func) \
3822 EVT_MOUSE_AUX1_UP(func) \
3823 EVT_MOUSE_AUX1_DCLICK(func) \
3824 EVT_MOUSE_AUX2_DOWN(func) \
3825 EVT_MOUSE_AUX2_UP(func) \
3826 EVT_MOUSE_AUX2_DCLICK(func) \
3828 EVT_LEAVE_WINDOW(func) \
3829 EVT_ENTER_WINDOW(func) \
3830 EVT_MOUSEWHEEL(func)
3832 // Scrolling from wxWindow (sent to wxScrolledWindow)
3833 #define EVT_SCROLLWIN_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_TOP, wxScrollWinEventHandler(func))
3834 #define EVT_SCROLLWIN_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEventHandler(func))
3835 #define EVT_SCROLLWIN_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEUP, wxScrollWinEventHandler(func))
3836 #define EVT_SCROLLWIN_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEventHandler(func))
3837 #define EVT_SCROLLWIN_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEventHandler(func))
3838 #define EVT_SCROLLWIN_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEventHandler(func))
3839 #define EVT_SCROLLWIN_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEventHandler(func))
3840 #define EVT_SCROLLWIN_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEventHandler(func))
3842 #define EVT_SCROLLWIN(func) \
3843 EVT_SCROLLWIN_TOP(func) \
3844 EVT_SCROLLWIN_BOTTOM(func) \
3845 EVT_SCROLLWIN_LINEUP(func) \
3846 EVT_SCROLLWIN_LINEDOWN(func) \
3847 EVT_SCROLLWIN_PAGEUP(func) \
3848 EVT_SCROLLWIN_PAGEDOWN(func) \
3849 EVT_SCROLLWIN_THUMBTRACK(func) \
3850 EVT_SCROLLWIN_THUMBRELEASE(func)
3852 // Scrolling from wxSlider and wxScrollBar
3853 #define EVT_SCROLL_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_TOP, wxScrollEventHandler(func))
3854 #define EVT_SCROLL_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLL_BOTTOM, wxScrollEventHandler(func))
3855 #define EVT_SCROLL_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEUP, wxScrollEventHandler(func))
3856 #define EVT_SCROLL_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEDOWN, wxScrollEventHandler(func))
3857 #define EVT_SCROLL_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEUP, wxScrollEventHandler(func))
3858 #define EVT_SCROLL_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler(func))
3859 #define EVT_SCROLL_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler(func))
3860 #define EVT_SCROLL_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBRELEASE, wxScrollEventHandler(func))
3861 #define EVT_SCROLL_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SCROLL_CHANGED, wxScrollEventHandler(func))
3863 #define EVT_SCROLL(func) \
3864 EVT_SCROLL_TOP(func) \
3865 EVT_SCROLL_BOTTOM(func) \
3866 EVT_SCROLL_LINEUP(func) \
3867 EVT_SCROLL_LINEDOWN(func) \
3868 EVT_SCROLL_PAGEUP(func) \
3869 EVT_SCROLL_PAGEDOWN(func) \
3870 EVT_SCROLL_THUMBTRACK(func) \
3871 EVT_SCROLL_THUMBRELEASE(func) \
3872 EVT_SCROLL_CHANGED(func)
3874 // Scrolling from wxSlider and wxScrollBar, with an id
3875 #define EVT_COMMAND_SCROLL_TOP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_TOP, winid, wxScrollEventHandler(func))
3876 #define EVT_COMMAND_SCROLL_BOTTOM(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_BOTTOM, winid, wxScrollEventHandler(func))
3877 #define EVT_COMMAND_SCROLL_LINEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEUP, winid, wxScrollEventHandler(func))
3878 #define EVT_COMMAND_SCROLL_LINEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEDOWN, winid, wxScrollEventHandler(func))
3879 #define EVT_COMMAND_SCROLL_PAGEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEUP, winid, wxScrollEventHandler(func))
3880 #define EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEDOWN, winid, wxScrollEventHandler(func))
3881 #define EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBTRACK, winid, wxScrollEventHandler(func))
3882 #define EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBRELEASE, winid, wxScrollEventHandler(func))
3883 #define EVT_COMMAND_SCROLL_CHANGED(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_CHANGED, winid, wxScrollEventHandler(func))
3885 #define EVT_COMMAND_SCROLL(winid, func) \
3886 EVT_COMMAND_SCROLL_TOP(winid, func) \
3887 EVT_COMMAND_SCROLL_BOTTOM(winid, func) \
3888 EVT_COMMAND_SCROLL_LINEUP(winid, func) \
3889 EVT_COMMAND_SCROLL_LINEDOWN(winid, func) \
3890 EVT_COMMAND_SCROLL_PAGEUP(winid, func) \
3891 EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) \
3892 EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) \
3893 EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) \
3894 EVT_COMMAND_SCROLL_CHANGED(winid, func)
3896 #if WXWIN_COMPATIBILITY_2_6
3897 // compatibility macros for the old name, deprecated in 2.8
3898 #define wxEVT_SCROLL_ENDSCROLL wxEVT_SCROLL_CHANGED
3899 #define EVT_COMMAND_SCROLL_ENDSCROLL EVT_COMMAND_SCROLL_CHANGED
3900 #define EVT_SCROLL_ENDSCROLL EVT_SCROLL_CHANGED
3901 #endif // WXWIN_COMPATIBILITY_2_6
3903 // Convenience macros for commonly-used commands
3904 #define EVT_CHECKBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKBOX_CLICKED, winid, wxCommandEventHandler(func))
3905 #define EVT_CHOICE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHOICE_SELECTED, winid, wxCommandEventHandler(func))
3906 #define EVT_LISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_SELECTED, winid, wxCommandEventHandler(func))
3907 #define EVT_LISTBOX_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, winid, wxCommandEventHandler(func))
3908 #define EVT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_MENU_SELECTED, winid, wxCommandEventHandler(func))
3909 #define EVT_MENU_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_MENU_SELECTED, id1, id2, wxCommandEventHandler(func))
3910 #if defined(__SMARTPHONE__)
3911 # define EVT_BUTTON(winid, func) EVT_MENU(winid, func)
3913 # define EVT_BUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_BUTTON_CLICKED, winid, wxCommandEventHandler(func))
3915 #define EVT_SLIDER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SLIDER_UPDATED, winid, wxCommandEventHandler(func))
3916 #define EVT_RADIOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBOX_SELECTED, winid, wxCommandEventHandler(func))
3917 #define EVT_RADIOBUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBUTTON_SELECTED, winid, wxCommandEventHandler(func))
3918 // EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events
3919 #define EVT_SCROLLBAR(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SCROLLBAR_UPDATED, winid, wxCommandEventHandler(func))
3920 #define EVT_VLBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_VLBOX_SELECTED, winid, wxCommandEventHandler(func))
3921 #define EVT_COMBOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_SELECTED, winid, wxCommandEventHandler(func))
3922 #define EVT_TOOL(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_CLICKED, winid, wxCommandEventHandler(func))
3923 #define EVT_TOOL_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, winid, wxCommandEventHandler(func))
3924 #define EVT_TOOL_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_CLICKED, id1, id2, wxCommandEventHandler(func))
3925 #define EVT_TOOL_RCLICKED(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_RCLICKED, winid, wxCommandEventHandler(func))
3926 #define EVT_TOOL_RCLICKED_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, wxCommandEventHandler(func))
3927 #define EVT_TOOL_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_ENTER, winid, wxCommandEventHandler(func))
3928 #define EVT_CHECKLISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, winid, wxCommandEventHandler(func))
3929 #define EVT_COMBOBOX_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_DROPDOWN, winid, wxCommandEventHandler(func))
3930 #define EVT_COMBOBOX_CLOSEUP(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_CLOSEUP, winid, wxCommandEventHandler(func))
3932 // Generic command events
3933 #define EVT_COMMAND_LEFT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_CLICK, winid, wxCommandEventHandler(func))
3934 #define EVT_COMMAND_LEFT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_DCLICK, winid, wxCommandEventHandler(func))
3935 #define EVT_COMMAND_RIGHT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_CLICK, winid, wxCommandEventHandler(func))
3936 #define EVT_COMMAND_RIGHT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_DCLICK, winid, wxCommandEventHandler(func))
3937 #define EVT_COMMAND_SET_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SET_FOCUS, winid, wxCommandEventHandler(func))
3938 #define EVT_COMMAND_KILL_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_KILL_FOCUS, winid, wxCommandEventHandler(func))
3939 #define EVT_COMMAND_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_ENTER, winid, wxCommandEventHandler(func))
3943 #define EVT_JOY_BUTTON_DOWN(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_DOWN, wxJoystickEventHandler(func))
3944 #define EVT_JOY_BUTTON_UP(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_UP, wxJoystickEventHandler(func))
3945 #define EVT_JOY_MOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_MOVE, wxJoystickEventHandler(func))
3946 #define EVT_JOY_ZMOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_ZMOVE, wxJoystickEventHandler(func))
3948 // All joystick events
3949 #define EVT_JOYSTICK_EVENTS(func) \
3950 EVT_JOY_BUTTON_DOWN(func) \
3951 EVT_JOY_BUTTON_UP(func) \
3952 EVT_JOY_MOVE(func) \
3956 #define EVT_IDLE(func) wx__DECLARE_EVT0(wxEVT_IDLE, wxIdleEventHandler(func))
3959 #define EVT_UPDATE_UI(winid, func) wx__DECLARE_EVT1(wxEVT_UPDATE_UI, winid, wxUpdateUIEventHandler(func))
3960 #define EVT_UPDATE_UI_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_UPDATE_UI, id1, id2, wxUpdateUIEventHandler(func))
3963 #define EVT_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_HELP, winid, wxHelpEventHandler(func))
3964 #define EVT_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_HELP, id1, id2, wxHelpEventHandler(func))
3965 #define EVT_DETAILED_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_DETAILED_HELP, winid, wxHelpEventHandler(func))
3966 #define EVT_DETAILED_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_DETAILED_HELP, id1, id2, wxHelpEventHandler(func))
3968 // Context Menu Events
3969 #define EVT_CONTEXT_MENU(func) wx__DECLARE_EVT0(wxEVT_CONTEXT_MENU, wxContextMenuEventHandler(func))
3970 #define EVT_COMMAND_CONTEXT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_CONTEXT_MENU, winid, wxContextMenuEventHandler(func))
3972 // Clipboard text Events
3973 #define EVT_TEXT_CUT(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_CUT, winid, wxClipboardTextEventHandler(func))
3974 #define EVT_TEXT_COPY(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_COPY, winid, wxClipboardTextEventHandler(func))
3975 #define EVT_TEXT_PASTE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_PASTE, winid, wxClipboardTextEventHandler(func))
3978 #define EVT_THREAD(id, func) wx__DECLARE_EVT1(wxEVT_COMMAND_THREAD, id, wxThreadEventHandler(func))
3980 // ----------------------------------------------------------------------------
3982 // ----------------------------------------------------------------------------
3984 // This is an ugly hack to allow the use of Bind() instead of Connect() inside
3985 // the library code if the library was built with support for it, here is how
3988 // class SomeEventHandlingClass : wxBIND_OR_CONNECT_HACK_BASE_CLASS
3989 // public SomeBaseClass
3992 // SomeEventHandlingClass(wxWindow *win)
3994 // // connect to the event for the given window
3995 // wxBIND_OR_CONNECT_HACK(win, wxEVT_SOMETHING, wxSomeEventHandler,
3996 // SomeEventHandlingClass::OnSomeEvent, this);
4000 // void OnSomeEvent(wxSomeEvent&) { ... }
4003 // This is *not* meant to be used by library users, it is only defined here
4004 // (and not in a private header) because the base class must be visible from
4005 // other public headers, please do NOT use this in your code, it will be
4006 // removed from future wx versions without warning.
4007 #ifdef wxHAS_EVENT_BIND
4008 #define wxBIND_OR_CONNECT_HACK_BASE_CLASS
4009 #define wxBIND_OR_CONNECT_HACK_ONLY_BASE_CLASS
4010 #define wxBIND_OR_CONNECT_HACK(win, evt, handler, func, obj) \
4011 win->Bind(evt, &func, obj)
4012 #else // wxHAS_EVENT_BIND
4013 #define wxBIND_OR_CONNECT_HACK_BASE_CLASS public wxEvtHandler,
4014 #define wxBIND_OR_CONNECT_HACK_ONLY_BASE_CLASS : public wxEvtHandler
4015 #define wxBIND_OR_CONNECT_HACK(win, evt, handler, func, obj) \
4016 win->Connect(evt, handler(func), NULL, obj)
4017 #endif // wxHAS_EVENT_BIND
4021 // Find a window with the focus, that is also a descendant of the given window.
4022 // This is used to determine the window to initially send commands to.
4023 WXDLLIMPEXP_CORE wxWindow
* wxFindFocusDescendant(wxWindow
* ancestor
);
4028 // ----------------------------------------------------------------------------
4029 // Compatibility macro aliases
4030 // ----------------------------------------------------------------------------
4032 // deprecated variants _not_ requiring a semicolon after them and without wx prefix
4033 // (note that also some wx-prefixed macro do _not_ require a semicolon because
4034 // it's not always possible to force the compire to require it)
4036 #define DECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj) \
4037 wxDECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj)
4038 #define DECLARE_EVENT_TABLE_TERMINATOR() wxDECLARE_EVENT_TABLE_TERMINATOR()
4039 #define DECLARE_EVENT_TABLE() wxDECLARE_EVENT_TABLE();
4040 #define BEGIN_EVENT_TABLE(a,b) wxBEGIN_EVENT_TABLE(a,b)
4041 #define BEGIN_EVENT_TABLE_TEMPLATE1(a,b,c) wxBEGIN_EVENT_TABLE_TEMPLATE1(a,b,c)
4042 #define BEGIN_EVENT_TABLE_TEMPLATE2(a,b,c,d) wxBEGIN_EVENT_TABLE_TEMPLATE1(a,b,c,d)
4043 #define BEGIN_EVENT_TABLE_TEMPLATE3(a,b,c,d,e) wxBEGIN_EVENT_TABLE_TEMPLATE1(a,b,c,d,e)
4044 #define BEGIN_EVENT_TABLE_TEMPLATE4(a,b,c,d,e,f) wxBEGIN_EVENT_TABLE_TEMPLATE1(a,b,c,d,e,f)
4045 #define BEGIN_EVENT_TABLE_TEMPLATE5(a,b,c,d,e,f,g) wxBEGIN_EVENT_TABLE_TEMPLATE1(a,b,c,d,e,f,g)
4046 #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)
4047 #define END_EVENT_TABLE() wxEND_EVENT_TABLE()
4049 // other obsolete event declaration/definition macros; we don't need them any longer
4050 // but we keep them for compatibility as it doesn't cost us anything anyhow
4051 #define BEGIN_DECLARE_EVENT_TYPES()
4052 #define END_DECLARE_EVENT_TYPES()
4053 #define DECLARE_EXPORTED_EVENT_TYPE(expdecl, name, value) \
4054 extern expdecl const wxEventType name;
4055 #define DECLARE_EVENT_TYPE(name, value) \
4056 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_CORE, name, value)
4057 #define DECLARE_LOCAL_EVENT_TYPE(name, value) \
4058 DECLARE_EXPORTED_EVENT_TYPE(wxEMPTY_PARAMETER_VALUE, name, value)
4059 #define DEFINE_EVENT_TYPE(name) const wxEventType name = wxNewEventType();
4060 #define DEFINE_LOCAL_EVENT_TYPE(name) DEFINE_EVENT_TYPE(name)
4062 #endif // _WX_EVENT_H_