1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Event classes
4 // Author: Julian Smart
8 // Copyright: (c) wxWidgets team
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
17 #include "wx/object.h"
18 #include "wx/clntdata.h"
21 #include "wx/gdicmn.h"
22 #include "wx/cursor.h"
23 #include "wx/mousestate.h"
26 #include "wx/dynarray.h"
27 #include "wx/thread.h"
28 #include "wx/tracker.h"
30 #if !wxEVENTS_COMPATIBILITY_2_8
31 #include "wx/meta/convertible.h"
34 // ----------------------------------------------------------------------------
35 // forward declarations
36 // ----------------------------------------------------------------------------
38 class WXDLLIMPEXP_FWD_BASE wxList
;
39 class WXDLLIMPEXP_FWD_BASE wxEvent
;
41 class WXDLLIMPEXP_FWD_CORE wxDC
;
42 class WXDLLIMPEXP_FWD_CORE wxMenu
;
43 class WXDLLIMPEXP_FWD_CORE wxWindow
;
44 class WXDLLIMPEXP_FWD_CORE wxWindowBase
;
47 // We operate with pointer to members of wxEvtHandler (such functions are used
48 // as event handlers in the event tables or as arguments to Connect()) but by
49 // default MSVC uses a restricted (but more efficient) representation of
50 // pointers to members which can't deal with multiple base classes. To avoid
51 // mysterious (as the compiler is not good enough to detect this and give a
52 // sensible error message) errors in the user code as soon as it defines
53 // classes inheriting from both wxEvtHandler (possibly indirectly, e.g. via
54 // wxWindow) and something else (including our own wxTrackable but not limited
55 // to it), we use the special MSVC keyword telling the compiler to use a more
56 // general pointer to member representation for the classes inheriting from
59 #define wxMSVC_FWD_MULTIPLE_BASES __multiple_inheritance
61 #define wxMSVC_FWD_MULTIPLE_BASES
64 class WXDLLIMPEXP_FWD_BASE wxMSVC_FWD_MULTIPLE_BASES wxEvtHandler
;
65 class wxEventConnectionRef
;
67 // ----------------------------------------------------------------------------
69 // ----------------------------------------------------------------------------
71 typedef int wxEventType
;
73 #define wxEVT_ANY ((wxEventType)-1)
75 // this is used to make the event table entry type safe, so that for an event
76 // handler only a function with proper parameter list can be given. See also
77 // the wxEVENT_HANDLER_CAST-macro.
78 #define wxStaticCastEvent(type, val) static_cast<type>(val)
80 #define DECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj) \
81 wxEventTableEntry(type, winid, idLast, wxNewEventFunctor(type, fn), obj)
83 #define DECLARE_EVENT_TABLE_TERMINATOR() \
84 wxEventTableEntry(wxEVT_NULL, 0, 0, 0, 0)
86 // obsolete event declaration/definition macros, we don't need them any longer
87 // but we keep them for compatibility as it doesn't cost us anything anyhow
88 #define BEGIN_DECLARE_EVENT_TYPES()
89 #define END_DECLARE_EVENT_TYPES()
90 #define DECLARE_EXPORTED_EVENT_TYPE(expdecl, name, value) \
91 extern expdecl const wxEventType name;
92 #define DECLARE_EVENT_TYPE(name, value) \
93 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_CORE, name, value)
94 #define DECLARE_LOCAL_EVENT_TYPE(name, value) \
95 DECLARE_EXPORTED_EVENT_TYPE(wxEMPTY_PARAMETER_VALUE, name, value)
96 #define DEFINE_EVENT_TYPE(name) const wxEventType name = wxNewEventType();
97 #define DEFINE_LOCAL_EVENT_TYPE(name) DEFINE_EVENT_TYPE(name)
99 // generate a new unique event type
100 extern WXDLLIMPEXP_BASE wxEventType
wxNewEventType();
102 // New macros to create templatized event types:
104 #if wxEVENTS_COMPATIBILITY_2_8
106 // Define/Declare a wxEventType-based event type:
108 #define wxDEFINE_EVENT( name, type ) \
109 const wxEventType name( wxNewEventType() )
111 #define wxDECLARE_EXPORTED_EVENT( expdecl, name, type ) \
112 extern const expdecl wxEventType name
114 // Define/Declare a wxEventType-based event type and initialize it with a
115 // predefined event type. (Only used for wxEVT_SPIN_XXX for backward
118 #define wxDEFINE_EVENT_ALIAS( name, type, value ) \
119 const wxEventType name = value
121 #define wxDECLARE_EXPORTED_EVENT_ALIAS( expdecl, name, type ) \
122 extern const expdecl wxEventType name
124 // Declare a local (not exported) wxEventType-based event type:
126 #define wxDECLARE_EVENT( name, type ) \
127 wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type );
129 // Try to cast the given event handler to the correct handler type:
131 #define wxEVENT_HANDLER_CAST( functype, func ) \
132 ( wxObjectEventFunction )( wxEventFunction )wxStaticCastEvent( functype, &func )
134 // Define/Declare a templatized event type with the corresponding event as
137 #define wxDEFINE_EVENT( name, type ) \
138 const wxEventTypeTag< type > name( wxNewEventType() )
140 #define wxDECLARE_EXPORTED_EVENT( expdecl, name, type ) \
141 extern const expdecl wxEventTypeTag< type > name
143 // Define/Declare a templatized event type and initialize it with a
144 // predefined event type. (Only used for wxEVT_SPIN_XXX for backward
147 #define wxDEFINE_EVENT_ALIAS( name, type, value ) \
148 const wxEventTypeTag< type > name( value )
150 #define wxDECLARE_EXPORTED_EVENT_ALIAS( expdecl, name, type ) \
151 extern const expdecl wxEventTypeTag< type > name
153 // Declare a local (not exported) templatized event type:
155 #define wxDECLARE_EVENT( name, type ) \
156 wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type );
158 // Don't cast the given event handler so that wxEvtHandler::Connect() sees
161 #define wxEVENT_HANDLER_CAST( functype, func ) \
165 // Template which associates the correct event object with the event type
167 #if !wxEVENTS_COMPATIBILITY_2_8
169 // The tag is a type associated to the event type (which is an integer itself,
170 // in spite of its name) value. It exists in order to be used as a template
171 // parameter and provide a mapping between the event type values and their
172 // corresponding wxEvent-derived classes.
173 template <typename T
>
177 // The class of wxEvent-derived class carried by the events of this type.
178 typedef T EventClass
;
180 wxEventTypeTag(wxEventType type
) { m_type
= type
; }
182 // Return a wxEventType reference for the initialization of the static
183 // event tables. See wxEventTableEntry::m_eventType for a more thorough
185 operator const wxEventType
&() const { return m_type
; }
191 #endif // !wxEVENTS_COMPATIBILITY_2_8
193 // These are needed for the functor definitions
194 typedef void (wxEvtHandler::*wxEventFunction
)(wxEvent
&);
196 // We had some trouble (specifically with eVC for ARM WinCE build) with using
197 // wxEventFunction in the past so we had introduced wxObjectEventFunction which
198 // used to be a typedef for a member of wxObject and not wxEvtHandler to work
199 // around this but as eVC is not really supported any longer we now only keep
200 // this for backwards compatibility and, despite its name, this is a typedef
201 // for wxEvtHandler member now -- but if we have the same problem with another
202 // compiler we can restore its old definition for it.
203 typedef wxEventFunction wxObjectEventFunction
;
206 // The event functor which is stored in the static and dynamic event tables:
207 class WXDLLIMPEXP_BASE wxEventFunctor
210 virtual ~wxEventFunctor();
212 // Invoke the actual event handler:
213 virtual void operator()(wxEvtHandler
*, wxEvent
&) = 0;
215 // this function tests whether this functor is matched, for the purpose of
216 // finding it in an event table in Disconnect(), by the given func
217 virtual bool Matches(const wxEventFunctor
& func
) const = 0;
219 // these functions are used for functors comparison in Matches()
220 virtual void *GetHandler() const { return GetEvtHandler(); }
221 virtual wxEventFunction
GetMethod() const { return NULL
; }
223 // this one is also used elsewhere in the code and should be overridden to
224 // return non-NULL if we are indeed associated with an wxEvtHandler
225 virtual wxEvtHandler
*GetEvtHandler() const { return NULL
; }
228 // A plain method functor: notice that it is used even with the new events as
229 // it is reused as a specialization of wxEventFunctorMethod for legacy untyped
231 class WXDLLIMPEXP_BASE wxObjectEventFunctor
: public wxEventFunctor
234 wxObjectEventFunctor(wxObjectEventFunction method
, wxEvtHandler
*handler
)
240 virtual void operator()(wxEvtHandler
*handler
, wxEvent
& event
);
242 virtual bool Matches(const wxEventFunctor
& func
) const
244 void * const handler
= func
.GetHandler();
245 if ( handler
&& GetHandler() != handler
)
248 const wxEventFunction method
= GetMethod();
250 // FIXME-VC6: amazing but true: replacing "method == NULL" here with
251 // "!method" makes VC6 crash with an ICE in DLL build (only!)
252 return method
== NULL
|| GetMethod() == method
;
255 virtual wxEvtHandler
*GetEvtHandler() const { return m_handler
; }
256 virtual wxEventFunction
GetMethod() const { return m_method
; }
259 wxEvtHandler
*m_handler
;
260 wxEventFunction m_method
;
263 #if wxEVENTS_COMPATIBILITY_2_8
265 // Create a functor for the legacy events: handler can be NULL and its default
266 // value is used by the event table macros
268 inline wxObjectEventFunctor
*
269 wxNewEventFunctor(const wxEventType
& WXUNUSED(evtType
),
270 wxObjectEventFunction method
,
271 wxEvtHandler
*handler
= NULL
)
273 return new wxObjectEventFunctor(method
, handler
);
276 inline wxObjectEventFunctor
277 wxMakeEventFunctor(const wxEventType
& WXUNUSED(evtType
),
278 wxObjectEventFunction method
,
279 wxEvtHandler
*handler
)
281 return wxObjectEventFunctor(method
, handler
);
284 #else // !wxEVENTS_COMPATIBILITY_2_8
286 // functor forwarding the event to anything callable (function, static method,
287 // generalized functor...)
288 template <typename EventTag
, typename Functor
>
289 class wxEventFunctorFunction
: public wxEventFunctor
292 typedef typename
EventTag::EventClass EventArg
;
294 wxEventFunctorFunction(Functor handler
)
299 virtual void operator()(wxEvtHandler
*WXUNUSED(handler
), wxEvent
& event
)
301 m_handler(static_cast<EventArg
&>(event
));
304 virtual bool Matches(const wxEventFunctor
& WXUNUSED(func
)) const
306 // we have no way to compare arbitrary functors so just consider them
307 // to be equal: this means that disconnecting a functor will always
308 // find the last functor connected which in turn implies that it's
309 // probably a bad idea to connect more than one functor if you plan to
310 // disconnect them but this limitation doesn't seem very important in
322 // helper template defining nested "type" typedef as the event class
323 // corresponding to the given event type
324 template <typename T
> struct EventClassOf
;
326 // the typed events provide the information about the class of the events they
328 template <typename T
>
329 struct EventClassOf
< wxEventTypeTag
<T
> >
331 typedef typename wxEventTypeTag
<T
>::EventClass type
;
334 // for the old untyped events we don't have information about the exact event
335 // class carried by them
337 struct EventClassOf
<wxEventType
>
339 typedef wxEvent type
;
343 // helper class defining operations different for method functors using an
344 // object of wxEvtHandler-derived class as handler and the others
345 template <typename T
, typename A
, bool> struct HandlerImpl
;
347 // specialization for handlers deriving from wxEvtHandler
348 template <typename T
, typename A
>
349 struct HandlerImpl
<T
, A
, true>
351 static bool IsEvtHandler()
353 static T
*ConvertFromEvtHandler(wxEvtHandler
*p
)
354 { return static_cast<T
*>(p
); }
355 static wxEvtHandler
*ConvertToEvtHandler(T
*p
)
357 static wxEventFunction
ConvertToEvtFunction(void (T::*f
)(A
&))
358 { return static_cast<wxEventFunction
>(
359 reinterpret_cast<void (T::*)(wxEvent
&)>(f
)); }
362 // specialization for handlers not deriving from wxEvtHandler
363 template <typename T
, typename A
>
364 struct HandlerImpl
<T
, A
, false>
366 static bool IsEvtHandler()
368 static T
*ConvertFromEvtHandler(wxEvtHandler
*)
370 static wxEvtHandler
*ConvertToEvtHandler(T
*)
372 static wxEventFunction
ConvertToEvtFunction(void (T::*)(A
&))
376 } // namespace wxPrivate
378 // functor forwarding the event to a method of the given object
380 // notice that the object class may be different from the class in which the
381 // method is defined but it must be convertible to this class
383 // also, the type of the handler parameter doesn't need to be exactly the same
384 // as EventTag::EventClass but it must be its base class -- this is explicitly
385 // allowed to handle different events in the same handler taking wxEvent&, for
388 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
389 class wxEventFunctorMethod
390 : public wxEventFunctor
,
391 private wxPrivate::HandlerImpl
395 wxConvertibleTo
<Class
, wxEvtHandler
>::value
!= 0
399 static void CheckHandlerArgument(EventArg
*) { }
402 // the event class associated with the given event tag
403 typedef typename
wxPrivate::EventClassOf
<EventTag
>::type EventClass
;
406 wxEventFunctorMethod(void (Class::*method
)(EventArg
&), ObjClass
*handler
)
408 wxASSERT_MSG( handler
|| this->IsEvtHandler(),
409 "handlers defined in non-wxEvtHandler-derived classes "
410 "must be connected with a valid sink object" );
412 // if you get an error here it means that the signature of the handler
413 // you're trying to use is not compatible with (i.e. is not the same as
414 // or a base class of) the real event class used for this event type
415 CheckHandlerArgument(static_cast<EventClass
*>(NULL
));
421 virtual void operator()(wxEvtHandler
*handler
, wxEvent
& event
)
423 Class
* realHandler
= m_handler
;
426 realHandler
= this->ConvertFromEvtHandler(handler
);
428 // this is not supposed to happen but check for it nevertheless
429 wxCHECK_RET( realHandler
, "invalid event handler" );
432 // the real (run-time) type of event is EventClass and we checked in
433 // the ctor that EventClass can be converted to EventArg, so this cast
435 (realHandler
->*m_method
)(static_cast<EventArg
&>(event
));
438 virtual bool Matches(const wxEventFunctor
& func
) const
440 void * const handler
= func
.GetHandler();
441 if ( handler
&& GetHandler() != handler
)
444 const wxEventFunction method
= GetMethod();
445 return !method
|| GetMethod() == method
;
448 virtual void *GetHandler() const
453 virtual wxEventFunction
GetMethod() const
455 return this->ConvertToEvtFunction(m_method
);
458 virtual wxEvtHandler
*GetEvtHandler() const
460 return this->ConvertToEvtHandler(m_handler
);
465 void (Class::*m_method
)(EventArg
&);
470 // Create functors for the templatized events, either allocated on the heap for
471 // wxNewXXX() variants (this is needed in wxEvtHandler::Connect() to store them
472 // in dynamic event table) or just by returning them as temporary objects (this
473 // is enough for Disconnect() and we allocate unnecessary heap allocation like
477 // Create functors wrapping other functors (including functions):
478 template <typename EventTag
, typename Functor
>
479 inline wxEventFunctorFunction
<EventTag
, Functor
> *
480 wxNewEventFunctor(const EventTag
&, Functor func
)
482 return new wxEventFunctorFunction
<EventTag
, Functor
>(func
);
485 template <typename EventTag
, typename Functor
>
486 inline wxEventFunctorFunction
<EventTag
, Functor
>
487 wxMakeEventFunctor(const EventTag
&, Functor func
)
489 return wxEventFunctorFunction
<EventTag
, Functor
>(func
);
493 // Create functors for methods:
495 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
496 inline wxEventFunctorMethod
<EventTag
, Class
, EventArg
, ObjClass
> *
497 wxNewEventFunctor(const EventTag
&,
498 void (Class::*method
)(EventArg
&),
501 return new wxEventFunctorMethod
<EventTag
, Class
, EventArg
, ObjClass
>(
506 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
507 inline wxEventFunctorMethod
<EventTag
, Class
, EventArg
, ObjClass
>
508 wxMakeEventFunctor(const EventTag
&,
509 void (Class::*method
)(EventArg
&),
512 return wxEventFunctorMethod
<EventTag
, Class
, EventArg
, ObjClass
>(
516 // Special case for the wxNewEventFunctor() calls used inside the event table
517 // macros: they don't specify the handler so ObjClass can't be deduced
518 template <typename EventTag
, typename Class
, typename EventArg
>
519 inline wxEventFunctorMethod
<EventTag
, Class
, EventArg
, Class
> *
520 wxNewEventFunctor(const EventTag
&, void (Class::*method
)(EventArg
&))
522 return new wxEventFunctorMethod
<EventTag
, Class
, EventArg
, Class
>(
527 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
528 inline wxEventFunctorMethod
<EventTag
, Class
, EventArg
, Class
>
529 wxMakeEventFunctor(const EventTag
&, void (Class::*method
)(EventArg
&))
531 return wxEventFunctorMethod
<EventTag
, Class
, EventArg
, Class
>(
535 #endif // !wxEVENTS_COMPATIBILITY_2_8
538 // many, but not all, standard event types
540 // some generic events
541 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_NULL
;
542 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_FIRST
;
543 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_USER_FIRST
;
545 // Need events declared to do this
546 class WXDLLIMPEXP_FWD_CORE wxCommandEvent
;
547 class WXDLLIMPEXP_FWD_CORE wxThreadEvent
;
548 class WXDLLIMPEXP_FWD_CORE wxMouseEvent
;
549 class WXDLLIMPEXP_FWD_CORE wxFocusEvent
;
550 class WXDLLIMPEXP_FWD_CORE wxChildFocusEvent
;
551 class WXDLLIMPEXP_FWD_CORE wxKeyEvent
;
552 class WXDLLIMPEXP_FWD_CORE wxNavigationKeyEvent
;
553 class WXDLLIMPEXP_FWD_CORE wxSetCursorEvent
;
554 class WXDLLIMPEXP_FWD_CORE wxScrollEvent
;
555 class WXDLLIMPEXP_FWD_CORE wxSpinEvent
;
556 class WXDLLIMPEXP_FWD_CORE wxScrollWinEvent
;
557 class WXDLLIMPEXP_FWD_CORE wxSizeEvent
;
558 class WXDLLIMPEXP_FWD_CORE wxMoveEvent
;
559 class WXDLLIMPEXP_FWD_CORE wxCloseEvent
;
560 class WXDLLIMPEXP_FWD_CORE wxActivateEvent
;
561 class WXDLLIMPEXP_FWD_CORE wxWindowCreateEvent
;
562 class WXDLLIMPEXP_FWD_CORE wxWindowDestroyEvent
;
563 class WXDLLIMPEXP_FWD_CORE wxShowEvent
;
564 class WXDLLIMPEXP_FWD_CORE wxIconizeEvent
;
565 class WXDLLIMPEXP_FWD_CORE wxMaximizeEvent
;
566 class WXDLLIMPEXP_FWD_CORE wxMouseCaptureChangedEvent
;
567 class WXDLLIMPEXP_FWD_CORE wxMouseCaptureLostEvent
;
568 class WXDLLIMPEXP_FWD_CORE wxPaintEvent
;
569 class WXDLLIMPEXP_FWD_CORE wxEraseEvent
;
570 class WXDLLIMPEXP_FWD_CORE wxNcPaintEvent
;
571 class WXDLLIMPEXP_FWD_CORE wxMenuEvent
;
572 class WXDLLIMPEXP_FWD_CORE wxContextMenuEvent
;
573 class WXDLLIMPEXP_FWD_CORE wxSysColourChangedEvent
;
574 class WXDLLIMPEXP_FWD_CORE wxDisplayChangedEvent
;
575 class WXDLLIMPEXP_FWD_CORE wxQueryNewPaletteEvent
;
576 class WXDLLIMPEXP_FWD_CORE wxPaletteChangedEvent
;
577 class WXDLLIMPEXP_FWD_CORE wxJoystickEvent
;
578 class WXDLLIMPEXP_FWD_CORE wxDropFilesEvent
;
579 class WXDLLIMPEXP_FWD_CORE wxInitDialogEvent
;
580 class WXDLLIMPEXP_FWD_CORE wxIdleEvent
;
581 class WXDLLIMPEXP_FWD_CORE wxUpdateUIEvent
;
582 class WXDLLIMPEXP_FWD_CORE wxClipboardTextEvent
;
583 class WXDLLIMPEXP_FWD_CORE wxHelpEvent
;
587 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_BUTTON_CLICKED
, wxCommandEvent
);
588 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHECKBOX_CLICKED
, wxCommandEvent
);
589 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHOICE_SELECTED
, wxCommandEvent
);
590 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LISTBOX_SELECTED
, wxCommandEvent
);
591 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
, wxCommandEvent
);
592 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
, wxCommandEvent
);
593 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_MENU_SELECTED
, wxCommandEvent
);
594 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SLIDER_UPDATED
, wxCommandEvent
);
595 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RADIOBOX_SELECTED
, wxCommandEvent
);
596 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RADIOBUTTON_SELECTED
, wxCommandEvent
);
598 // wxEVT_COMMAND_SCROLLBAR_UPDATED is deprecated, use wxEVT_SCROLL... events
599 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SCROLLBAR_UPDATED
, wxCommandEvent
);
600 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_VLBOX_SELECTED
, wxCommandEvent
);
601 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_COMBOBOX_SELECTED
, wxCommandEvent
);
602 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_RCLICKED
, wxCommandEvent
);
603 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED
, wxCommandEvent
);
604 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_ENTER
, wxCommandEvent
);
607 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_THREAD
, wxThreadEvent
);
610 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_DOWN
, wxMouseEvent
);
611 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_UP
, wxMouseEvent
);
612 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_DOWN
, wxMouseEvent
);
613 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_UP
, wxMouseEvent
);
614 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_DOWN
, wxMouseEvent
);
615 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_UP
, wxMouseEvent
);
616 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOTION
, wxMouseEvent
);
617 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ENTER_WINDOW
, wxMouseEvent
);
618 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEAVE_WINDOW
, wxMouseEvent
);
619 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_DCLICK
, wxMouseEvent
);
620 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_DCLICK
, wxMouseEvent
);
621 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_DCLICK
, wxMouseEvent
);
622 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SET_FOCUS
, wxFocusEvent
);
623 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KILL_FOCUS
, wxFocusEvent
);
624 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHILD_FOCUS
, wxChildFocusEvent
);
625 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSEWHEEL
, wxMouseEvent
);
626 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_DOWN
, wxMouseEvent
);
627 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_UP
, wxMouseEvent
);
628 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_DCLICK
, wxMouseEvent
);
629 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_DOWN
, wxMouseEvent
);
630 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_UP
, wxMouseEvent
);
631 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_DCLICK
, wxMouseEvent
);
633 // Character input event type
634 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHAR
, wxKeyEvent
);
635 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHAR_HOOK
, wxKeyEvent
);
636 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_NAVIGATION_KEY
, wxNavigationKeyEvent
);
637 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KEY_DOWN
, wxKeyEvent
);
638 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KEY_UP
, wxKeyEvent
);
640 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HOTKEY
, wxKeyEvent
);
643 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SET_CURSOR
, wxSetCursorEvent
);
645 // wxScrollBar and wxSlider event identifiers
646 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_TOP
, wxScrollEvent
);
647 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_BOTTOM
, wxScrollEvent
);
648 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_LINEUP
, wxScrollEvent
);
649 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_LINEDOWN
, wxScrollEvent
);
650 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_PAGEUP
, wxScrollEvent
);
651 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_PAGEDOWN
, wxScrollEvent
);
652 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_THUMBTRACK
, wxScrollEvent
);
653 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_THUMBRELEASE
, wxScrollEvent
);
654 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_CHANGED
, wxScrollEvent
);
656 // Due to a bug in older wx versions, wxSpinEvents were being sent with type of
657 // wxEVT_SCROLL_LINEUP, wxEVT_SCROLL_LINEDOWN and wxEVT_SCROLL_THUMBTRACK. But
658 // with the type-safe events in place, these event types are associated with
659 // wxScrollEvent. To allow handling of spin events, new event types have been
660 // defined in spinbutt.h/spinnbuttcmn.cpp. To maintain backward compatibility
661 // the spin event types are being initialized with the scroll event types.
665 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN_UP
, wxSpinEvent
);
666 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN_DOWN
, wxSpinEvent
);
667 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN
, wxSpinEvent
);
671 // Scroll events from wxWindow
672 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_TOP
, wxScrollWinEvent
);
673 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_BOTTOM
, wxScrollWinEvent
);
674 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_LINEUP
, wxScrollWinEvent
);
675 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_LINEDOWN
, wxScrollWinEvent
);
676 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_PAGEUP
, wxScrollWinEvent
);
677 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_PAGEDOWN
, wxScrollWinEvent
);
678 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_THUMBTRACK
, wxScrollWinEvent
);
679 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_THUMBRELEASE
, wxScrollWinEvent
);
682 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SIZE
, wxSizeEvent
);
683 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE
, wxMoveEvent
);
684 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CLOSE_WINDOW
, wxCloseEvent
);
685 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_END_SESSION
, wxCloseEvent
);
686 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_QUERY_END_SESSION
, wxCloseEvent
);
687 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ACTIVATE_APP
, wxActivateEvent
);
688 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ACTIVATE
, wxActivateEvent
);
689 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CREATE
, wxWindowCreateEvent
);
690 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DESTROY
, wxWindowDestroyEvent
);
691 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SHOW
, wxShowEvent
);
692 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ICONIZE
, wxIconizeEvent
);
693 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MAXIMIZE
, wxMaximizeEvent
);
694 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSE_CAPTURE_CHANGED
, wxMouseCaptureChangedEvent
);
695 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSE_CAPTURE_LOST
, wxMouseCaptureLostEvent
);
696 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_PAINT
, wxPaintEvent
);
697 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ERASE_BACKGROUND
, wxEraseEvent
);
698 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_NC_PAINT
, wxNcPaintEvent
);
699 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_OPEN
, wxMenuEvent
);
700 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_CLOSE
, wxMenuEvent
);
701 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_HIGHLIGHT
, wxMenuEvent
);
702 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CONTEXT_MENU
, wxContextMenuEvent
);
703 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SYS_COLOUR_CHANGED
, wxSysColourChangedEvent
);
704 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DISPLAY_CHANGED
, wxDisplayChangedEvent
);
705 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_QUERY_NEW_PALETTE
, wxQueryNewPaletteEvent
);
706 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_PALETTE_CHANGED
, wxPaletteChangedEvent
);
707 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_BUTTON_DOWN
, wxJoystickEvent
);
708 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_BUTTON_UP
, wxJoystickEvent
);
709 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_MOVE
, wxJoystickEvent
);
710 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_ZMOVE
, wxJoystickEvent
);
711 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DROP_FILES
, wxDropFilesEvent
);
712 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_INIT_DIALOG
, wxInitDialogEvent
);
713 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_BASE
, wxEVT_IDLE
, wxIdleEvent
);
714 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_UPDATE_UI
, wxUpdateUIEvent
);
715 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SIZING
, wxSizeEvent
);
716 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVING
, wxMoveEvent
);
717 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE_START
, wxMoveEvent
);
718 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE_END
, wxMoveEvent
);
719 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HIBERNATE
, wxActivateEvent
);
722 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_COPY
, wxClipboardTextEvent
);
723 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_CUT
, wxClipboardTextEvent
);
724 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_PASTE
, wxClipboardTextEvent
);
726 // Generic command events
727 // Note: a click is a higher-level event than button down/up
728 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LEFT_CLICK
, wxCommandEvent
);
729 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LEFT_DCLICK
, wxCommandEvent
);
730 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RIGHT_CLICK
, wxCommandEvent
);
731 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RIGHT_DCLICK
, wxCommandEvent
);
732 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SET_FOCUS
, wxCommandEvent
);
733 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_KILL_FOCUS
, wxCommandEvent
);
734 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_ENTER
, wxCommandEvent
);
737 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HELP
, wxHelpEvent
);
738 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DETAILED_HELP
, wxHelpEvent
);
740 // these 2 events are the same
741 #define wxEVT_COMMAND_TOOL_CLICKED wxEVT_COMMAND_MENU_SELECTED
743 // ----------------------------------------------------------------------------
745 // ----------------------------------------------------------------------------
747 // this event is also used by wxComboBox and wxSpinCtrl which don't include
748 // wx/textctrl.h in all ports [yet], so declare it here as well
750 // still, any new code using it should include wx/textctrl.h explicitly
751 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_UPDATED
, wxCommandEvent
);
754 // ----------------------------------------------------------------------------
755 // wxEvent(-derived) classes
756 // ----------------------------------------------------------------------------
758 // the predefined constants for the number of times we propagate event
759 // upwards window child-parent chain
760 enum wxEventPropagation
762 // don't propagate it at all
763 wxEVENT_PROPAGATE_NONE
= 0,
765 // propagate it until it is processed
766 wxEVENT_PROPAGATE_MAX
= INT_MAX
769 // The different categories for a wxEvent; see wxEvent::GetEventCategory.
770 // NOTE: they are used as OR-combinable flags by wxEventLoopBase::YieldFor
773 // this is the category for those events which are generated to update
774 // the appearance of the GUI but which (usually) do not comport data
775 // processing, i.e. which do not provide input or output data
776 // (e.g. size events, scroll events, etc).
777 // They are events NOT directly generated by the user's input devices.
778 wxEVT_CATEGORY_UI
= 1,
780 // this category groups those events which are generated directly from the
781 // user through input devices like mouse and keyboard and usually result in
782 // data to be processed from the application.
783 // (e.g. mouse clicks, key presses, etc)
784 wxEVT_CATEGORY_USER_INPUT
= 2,
786 // this category is for wxSocketEvent
787 wxEVT_CATEGORY_SOCKET
= 4,
789 // this category is for wxTimerEvent
790 wxEVT_CATEGORY_TIMER
= 8,
792 // this category is for any event used to send notifications from the
793 // secondary threads to the main one or in general for notifications among
794 // different threads (which may or may not be user-generated)
795 wxEVT_CATEGORY_THREAD
= 16,
798 // implementation only
800 // used in the implementations of wxEventLoopBase::YieldFor
801 wxEVT_CATEGORY_UNKNOWN
= 32,
803 // a special category used as an argument to wxEventLoopBase::YieldFor to indicate that
804 // Yield() should leave all wxEvents on the queue while emptying the native event queue
805 // (native events will be processed but the wxEvents they generate will be queued)
806 wxEVT_CATEGORY_CLIPBOARD
= 64,
811 // this category groups those events which are emitted in response to
812 // events of the native toolkit and which typically are not-"delayable".
813 wxEVT_CATEGORY_NATIVE_EVENTS
= wxEVT_CATEGORY_UI
|wxEVT_CATEGORY_USER_INPUT
,
815 // used in wxEventLoopBase::YieldFor to specify all event categories should be processed:
817 wxEVT_CATEGORY_UI
|wxEVT_CATEGORY_USER_INPUT
|wxEVT_CATEGORY_SOCKET
| \
818 wxEVT_CATEGORY_TIMER
|wxEVT_CATEGORY_THREAD
822 * wxWidgets events, covering all interesting things that might happen
823 * (button clicking, resizing, setting text in widgets, etc.).
825 * For each completely new event type, derive a new event class.
826 * An event CLASS represents a C++ class defining a range of similar event TYPES;
827 * examples are canvas events, panel item command events.
828 * An event TYPE is a unique identifier for a particular system event,
829 * such as a button press or a listbox deselection.
833 class WXDLLIMPEXP_BASE wxEvent
: public wxObject
836 wxEvent(int winid
= 0, wxEventType commandType
= wxEVT_NULL
);
838 void SetEventType(wxEventType typ
) { m_eventType
= typ
; }
839 wxEventType
GetEventType() const { return m_eventType
; }
841 wxObject
*GetEventObject() const { return m_eventObject
; }
842 void SetEventObject(wxObject
*obj
) { m_eventObject
= obj
; }
844 long GetTimestamp() const { return m_timeStamp
; }
845 void SetTimestamp(long ts
= 0) { m_timeStamp
= ts
; }
847 int GetId() const { return m_id
; }
848 void SetId(int Id
) { m_id
= Id
; }
850 // Can instruct event processor that we wish to ignore this event
851 // (treat as if the event table entry had not been found): this must be done
852 // to allow the event processing by the base classes (calling event.Skip()
853 // is the analog of calling the base class version of a virtual function)
854 void Skip(bool skip
= true) { m_skipped
= skip
; }
855 bool GetSkipped() const { return m_skipped
; }
857 // This function is used to create a copy of the event polymorphically and
858 // all derived classes must implement it because otherwise wxPostEvent()
859 // for them wouldn't work (it needs to do a copy of the event)
860 virtual wxEvent
*Clone() const = 0;
862 // this function is used to selectively process events in wxEventLoopBase::YieldFor
863 // NOTE: by default it returns wxEVT_CATEGORY_UI just because the major
864 // part of wxWidgets events belong to that category.
865 virtual wxEventCategory
GetEventCategory() const
866 { return wxEVT_CATEGORY_UI
; }
868 // Implementation only: this test is explicitly anti OO and this function
869 // exists only for optimization purposes.
870 bool IsCommandEvent() const { return m_isCommandEvent
; }
872 // Determine if this event should be propagating to the parent window.
873 bool ShouldPropagate() const
874 { return m_propagationLevel
!= wxEVENT_PROPAGATE_NONE
; }
876 // Stop an event from propagating to its parent window, returns the old
877 // propagation level value
878 int StopPropagation()
880 int propagationLevel
= m_propagationLevel
;
881 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
882 return propagationLevel
;
885 // Resume the event propagation by restoring the propagation level
886 // (returned by StopPropagation())
887 void ResumePropagation(int propagationLevel
)
889 m_propagationLevel
= propagationLevel
;
893 // This is for internal use only and is only called by
894 // wxEvtHandler::ProcessEvent() to check whether it's the first time this
895 // event is being processed
898 if ( m_wasProcessed
)
901 m_wasProcessed
= true;
907 wxObject
* m_eventObject
;
908 wxEventType m_eventType
;
913 // m_callbackUserData is for internal usage only
914 wxObject
* m_callbackUserData
;
917 // the propagation level: while it is positive, we propagate the event to
918 // the parent window (if any)
919 int m_propagationLevel
;
922 bool m_isCommandEvent
;
924 // initially false but becomes true as soon as WasProcessed() is called for
925 // the first time, as this is done only by ProcessEvent() it explains the
926 // variable name: it becomes true after ProcessEvent() was called at least
927 // once for this event
931 wxEvent(const wxEvent
&); // for implementing Clone()
932 wxEvent
& operator=(const wxEvent
&); // for derived classes operator=()
935 // it needs to access our m_propagationLevel
936 friend class WXDLLIMPEXP_FWD_BASE wxPropagateOnce
;
938 DECLARE_ABSTRACT_CLASS(wxEvent
)
942 * Helper class to temporarily change an event not to propagate.
944 class WXDLLIMPEXP_BASE wxPropagationDisabler
947 wxPropagationDisabler(wxEvent
& event
) : m_event(event
)
949 m_propagationLevelOld
= m_event
.StopPropagation();
952 ~wxPropagationDisabler()
954 m_event
.ResumePropagation(m_propagationLevelOld
);
959 int m_propagationLevelOld
;
961 wxDECLARE_NO_COPY_CLASS(wxPropagationDisabler
);
965 * Another one to temporarily lower propagation level.
967 class WXDLLIMPEXP_BASE wxPropagateOnce
970 wxPropagateOnce(wxEvent
& event
) : m_event(event
)
972 wxASSERT_MSG( m_event
.m_propagationLevel
> 0,
973 _T("shouldn't be used unless ShouldPropagate()!") );
975 m_event
.m_propagationLevel
--;
980 m_event
.m_propagationLevel
++;
986 wxDECLARE_NO_COPY_CLASS(wxPropagateOnce
);
993 // Item or menu event class
995 wxEVT_COMMAND_BUTTON_CLICKED
996 wxEVT_COMMAND_CHECKBOX_CLICKED
997 wxEVT_COMMAND_CHOICE_SELECTED
998 wxEVT_COMMAND_LISTBOX_SELECTED
999 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
1000 wxEVT_COMMAND_TEXT_UPDATED
1001 wxEVT_COMMAND_TEXT_ENTER
1002 wxEVT_COMMAND_MENU_SELECTED
1003 wxEVT_COMMAND_SLIDER_UPDATED
1004 wxEVT_COMMAND_RADIOBOX_SELECTED
1005 wxEVT_COMMAND_RADIOBUTTON_SELECTED
1006 wxEVT_COMMAND_SCROLLBAR_UPDATED
1007 wxEVT_COMMAND_VLBOX_SELECTED
1008 wxEVT_COMMAND_COMBOBOX_SELECTED
1009 wxEVT_COMMAND_TOGGLEBUTTON_CLICKED
1012 class WXDLLIMPEXP_CORE wxCommandEvent
: public wxEvent
1015 wxCommandEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0);
1017 wxCommandEvent(const wxCommandEvent
& event
)
1019 m_cmdString(event
.m_cmdString
),
1020 m_commandInt(event
.m_commandInt
),
1021 m_extraLong(event
.m_extraLong
),
1022 m_clientData(event
.m_clientData
),
1023 m_clientObject(event
.m_clientObject
)
1026 // Set/Get client data from controls
1027 void SetClientData(void* clientData
) { m_clientData
= clientData
; }
1028 void *GetClientData() const { return m_clientData
; }
1030 // Set/Get client object from controls
1031 void SetClientObject(wxClientData
* clientObject
) { m_clientObject
= clientObject
; }
1032 wxClientData
*GetClientObject() const { return m_clientObject
; }
1034 // Get listbox selection if single-choice
1035 int GetSelection() const { return m_commandInt
; }
1037 // Set/Get listbox/choice selection string
1038 void SetString(const wxString
& s
) { m_cmdString
= s
; }
1039 wxString
GetString() const;
1041 // Get checkbox value
1042 bool IsChecked() const { return m_commandInt
!= 0; }
1044 // true if the listbox event was a selection.
1045 bool IsSelection() const { return (m_extraLong
!= 0); }
1047 void SetExtraLong(long extraLong
) { m_extraLong
= extraLong
; }
1048 long GetExtraLong() const { return m_extraLong
; }
1050 void SetInt(int i
) { m_commandInt
= i
; }
1051 int GetInt() const { return m_commandInt
; }
1053 virtual wxEvent
*Clone() const { return new wxCommandEvent(*this); }
1054 virtual wxEventCategory
GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT
; }
1057 wxString m_cmdString
; // String event argument
1059 long m_extraLong
; // Additional information (e.g. select/deselect)
1060 void* m_clientData
; // Arbitrary client data
1061 wxClientData
* m_clientObject
; // Arbitrary client object
1064 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCommandEvent
)
1067 // this class adds a possibility to react (from the user) code to a control
1068 // notification: allow or veto the operation being reported.
1069 class WXDLLIMPEXP_CORE wxNotifyEvent
: public wxCommandEvent
1072 wxNotifyEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0)
1073 : wxCommandEvent(commandType
, winid
)
1074 { m_bAllow
= true; }
1076 wxNotifyEvent(const wxNotifyEvent
& event
)
1077 : wxCommandEvent(event
)
1078 { m_bAllow
= event
.m_bAllow
; }
1080 // veto the operation (usually it's allowed by default)
1081 void Veto() { m_bAllow
= false; }
1083 // allow the operation if it was disabled by default
1084 void Allow() { m_bAllow
= true; }
1086 // for implementation code only: is the operation allowed?
1087 bool IsAllowed() const { return m_bAllow
; }
1089 virtual wxEvent
*Clone() const { return new wxNotifyEvent(*this); }
1095 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNotifyEvent
)
1101 class WXDLLIMPEXP_CORE wxThreadEvent
: public wxCommandEvent
1104 wxThreadEvent(wxEventType eventType
= wxEVT_COMMAND_THREAD
, int id
= wxID_ANY
)
1105 : wxCommandEvent(eventType
, id
)
1108 wxThreadEvent(const wxThreadEvent
& event
)
1109 : wxCommandEvent(event
)
1111 // make sure our string member (which uses COW, aka refcounting) is not
1112 // shared by other wxString instances:
1113 SetString(GetString().c_str());
1116 virtual wxEvent
*Clone() const
1118 wxThreadEvent
* ev
= new wxThreadEvent(*this);
1120 // make sure our string member (which uses COW, aka refcounting) is not
1121 // shared by other wxString instances:
1122 ev
->SetString(GetString().c_str());
1126 // this is important to avoid that calling wxEventLoopBase::YieldFor thread events
1127 // gets processed when this is unwanted:
1128 virtual wxEventCategory
GetEventCategory() const
1129 { return wxEVT_CATEGORY_THREAD
; }
1132 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxThreadEvent
)
1137 // Scroll event class, derived form wxCommandEvent. wxScrollEvents are
1138 // sent by wxSlider and wxScrollBar.
1143 wxEVT_SCROLL_LINEDOWN
1145 wxEVT_SCROLL_PAGEDOWN
1146 wxEVT_SCROLL_THUMBTRACK
1147 wxEVT_SCROLL_THUMBRELEASE
1148 wxEVT_SCROLL_CHANGED
1151 class WXDLLIMPEXP_CORE wxScrollEvent
: public wxCommandEvent
1154 wxScrollEvent(wxEventType commandType
= wxEVT_NULL
,
1155 int winid
= 0, int pos
= 0, int orient
= 0);
1157 int GetOrientation() const { return (int) m_extraLong
; }
1158 int GetPosition() const { return m_commandInt
; }
1159 void SetOrientation(int orient
) { m_extraLong
= (long) orient
; }
1160 void SetPosition(int pos
) { m_commandInt
= pos
; }
1162 virtual wxEvent
*Clone() const { return new wxScrollEvent(*this); }
1165 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollEvent
)
1168 // ScrollWin event class, derived fom wxEvent. wxScrollWinEvents
1169 // are sent by wxWindow.
1172 wxEVT_SCROLLWIN_BOTTOM
1173 wxEVT_SCROLLWIN_LINEUP
1174 wxEVT_SCROLLWIN_LINEDOWN
1175 wxEVT_SCROLLWIN_PAGEUP
1176 wxEVT_SCROLLWIN_PAGEDOWN
1177 wxEVT_SCROLLWIN_THUMBTRACK
1178 wxEVT_SCROLLWIN_THUMBRELEASE
1181 class WXDLLIMPEXP_CORE wxScrollWinEvent
: public wxEvent
1184 wxScrollWinEvent(wxEventType commandType
= wxEVT_NULL
,
1185 int pos
= 0, int orient
= 0);
1186 wxScrollWinEvent(const wxScrollWinEvent
& event
) : wxEvent(event
)
1187 { m_commandInt
= event
.m_commandInt
;
1188 m_extraLong
= event
.m_extraLong
; }
1190 int GetOrientation() const { return (int) m_extraLong
; }
1191 int GetPosition() const { return m_commandInt
; }
1192 void SetOrientation(int orient
) { m_extraLong
= (long) orient
; }
1193 void SetPosition(int pos
) { m_commandInt
= pos
; }
1195 virtual wxEvent
*Clone() const { return new wxScrollWinEvent(*this); }
1202 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollWinEvent
)
1207 // Mouse event class
1224 wxEVT_NC_MIDDLE_DOWN,
1226 wxEVT_NC_RIGHT_DOWN,
1229 wxEVT_NC_ENTER_WINDOW,
1230 wxEVT_NC_LEAVE_WINDOW,
1231 wxEVT_NC_LEFT_DCLICK,
1232 wxEVT_NC_MIDDLE_DCLICK,
1233 wxEVT_NC_RIGHT_DCLICK,
1236 // the symbolic names for the mouse buttons
1239 wxMOUSE_BTN_ANY
= -1,
1240 wxMOUSE_BTN_NONE
= 0,
1241 wxMOUSE_BTN_LEFT
= 1,
1242 wxMOUSE_BTN_MIDDLE
= 2,
1243 wxMOUSE_BTN_RIGHT
= 3,
1244 wxMOUSE_BTN_AUX1
= 4,
1245 wxMOUSE_BTN_AUX2
= 5,
1249 class WXDLLIMPEXP_CORE wxMouseEvent
: public wxEvent
,
1253 wxMouseEvent(wxEventType mouseType
= wxEVT_NULL
);
1254 wxMouseEvent(const wxMouseEvent
& event
)
1261 // Was it a button event? (*doesn't* mean: is any button *down*?)
1262 bool IsButton() const { return Button(wxMOUSE_BTN_ANY
); }
1264 // Was it a down event from this (or any) button?
1265 bool ButtonDown(int but
= wxMOUSE_BTN_ANY
) const;
1267 // Was it a dclick event from this (or any) button?
1268 bool ButtonDClick(int but
= wxMOUSE_BTN_ANY
) const;
1270 // Was it a up event from this (or any) button?
1271 bool ButtonUp(int but
= wxMOUSE_BTN_ANY
) const;
1273 // Was the given button?
1274 bool Button(int but
) const;
1276 // Was the given button in Down state?
1277 bool ButtonIsDown(int but
) const;
1279 // Get the button which is changing state (wxMOUSE_BTN_NONE if none)
1280 int GetButton() const;
1282 // Find which event was just generated
1283 bool LeftDown() const { return (m_eventType
== wxEVT_LEFT_DOWN
); }
1284 bool MiddleDown() const { return (m_eventType
== wxEVT_MIDDLE_DOWN
); }
1285 bool RightDown() const { return (m_eventType
== wxEVT_RIGHT_DOWN
); }
1286 bool Aux1Down() const { return (m_eventType
== wxEVT_AUX1_DOWN
); }
1287 bool Aux2Down() const { return (m_eventType
== wxEVT_AUX2_DOWN
); }
1289 bool LeftUp() const { return (m_eventType
== wxEVT_LEFT_UP
); }
1290 bool MiddleUp() const { return (m_eventType
== wxEVT_MIDDLE_UP
); }
1291 bool RightUp() const { return (m_eventType
== wxEVT_RIGHT_UP
); }
1292 bool Aux1Up() const { return (m_eventType
== wxEVT_AUX1_UP
); }
1293 bool Aux2Up() const { return (m_eventType
== wxEVT_AUX2_UP
); }
1295 bool LeftDClick() const { return (m_eventType
== wxEVT_LEFT_DCLICK
); }
1296 bool MiddleDClick() const { return (m_eventType
== wxEVT_MIDDLE_DCLICK
); }
1297 bool RightDClick() const { return (m_eventType
== wxEVT_RIGHT_DCLICK
); }
1298 bool Aux1DClick() const { return (m_eventType
== wxEVT_AUX1_UP
); }
1299 bool Aux2DClick() const { return (m_eventType
== wxEVT_AUX2_UP
); }
1301 // Find the current state of the mouse buttons (regardless
1302 // of current event type)
1303 bool LeftIsDown() const { return m_leftDown
; }
1304 bool MiddleIsDown() const { return m_middleDown
; }
1305 bool RightIsDown() const { return m_rightDown
; }
1306 bool Aux1IsDown() const { return m_aux1Down
; }
1307 bool Aux2IsDown() const { return m_aux2Down
; }
1309 // True if a button is down and the mouse is moving
1310 bool Dragging() const
1312 return (m_eventType
== wxEVT_MOTION
) && ButtonIsDown(wxMOUSE_BTN_ANY
);
1315 // True if the mouse is moving, and no button is down
1318 return (m_eventType
== wxEVT_MOTION
) && !ButtonIsDown(wxMOUSE_BTN_ANY
);
1321 // True if the mouse is just entering the window
1322 bool Entering() const { return (m_eventType
== wxEVT_ENTER_WINDOW
); }
1324 // True if the mouse is just leaving the window
1325 bool Leaving() const { return (m_eventType
== wxEVT_LEAVE_WINDOW
); }
1327 // Returns the number of mouse clicks associated with this event.
1328 int GetClickCount() const { return m_clickCount
; }
1331 // Find the position of the event
1332 void GetPosition(wxCoord
*xpos
, wxCoord
*ypos
) const
1340 void GetPosition(long *xpos
, long *ypos
) const
1348 // Find the position of the event
1349 wxPoint
GetPosition() const { return wxPoint(m_x
, m_y
); }
1351 // Find the logical position of the event given the DC
1352 wxPoint
GetLogicalPosition(const wxDC
& dc
) const;
1355 wxCoord
GetX() const { return m_x
; }
1358 wxCoord
GetY() const { return m_y
; }
1360 // Get wheel rotation, positive or negative indicates direction of
1361 // rotation. Current devices all send an event when rotation is equal to
1362 // +/-WheelDelta, but this allows for finer resolution devices to be
1363 // created in the future. Because of this you shouldn't assume that one
1364 // event is equal to 1 line or whatever, but you should be able to either
1365 // do partial line scrolling or wait until +/-WheelDelta rotation values
1366 // have been accumulated before scrolling.
1367 int GetWheelRotation() const { return m_wheelRotation
; }
1369 // Get wheel delta, normally 120. This is the threshold for action to be
1370 // taken, and one such action (for example, scrolling one increment)
1371 // should occur for each delta.
1372 int GetWheelDelta() const { return m_wheelDelta
; }
1374 // Gets the axis the wheel operation concerns, 0 being the y axis as on
1375 // most mouse wheels, 1 is the x axis for things like MightyMouse scrolls
1376 // or horizontal trackpad scrolling
1377 int GetWheelAxis() const { return m_wheelAxis
; }
1379 // Returns the configured number of lines (or whatever) to be scrolled per
1380 // wheel action. Defaults to one.
1381 int GetLinesPerAction() const { return m_linesPerAction
; }
1383 // Is the system set to do page scrolling?
1384 bool IsPageScroll() const { return ((unsigned int)m_linesPerAction
== UINT_MAX
); }
1386 virtual wxEvent
*Clone() const { return new wxMouseEvent(*this); }
1387 virtual wxEventCategory
GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT
; }
1389 wxMouseEvent
& operator=(const wxMouseEvent
& event
)
1408 int m_wheelRotation
;
1410 int m_linesPerAction
;
1413 void Assign(const wxMouseEvent
& evt
);
1416 DECLARE_DYNAMIC_CLASS(wxMouseEvent
)
1425 class WXDLLIMPEXP_CORE wxSetCursorEvent
: public wxEvent
1428 wxSetCursorEvent(wxCoord x
= 0, wxCoord y
= 0)
1429 : wxEvent(0, wxEVT_SET_CURSOR
),
1430 m_x(x
), m_y(y
), m_cursor()
1433 wxSetCursorEvent(const wxSetCursorEvent
& event
)
1437 m_cursor(event
.m_cursor
)
1440 wxCoord
GetX() const { return m_x
; }
1441 wxCoord
GetY() const { return m_y
; }
1443 void SetCursor(const wxCursor
& cursor
) { m_cursor
= cursor
; }
1444 const wxCursor
& GetCursor() const { return m_cursor
; }
1445 bool HasCursor() const { return m_cursor
.Ok(); }
1447 virtual wxEvent
*Clone() const { return new wxSetCursorEvent(*this); }
1454 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSetCursorEvent
)
1457 // Keyboard input event class
1467 class WXDLLIMPEXP_CORE wxKeyEvent
: public wxEvent
,
1468 public wxKeyboardState
1471 wxKeyEvent(wxEventType keyType
= wxEVT_NULL
);
1472 wxKeyEvent(const wxKeyEvent
& evt
);
1474 // get the key code: an ASCII7 char or an element of wxKeyCode enum
1475 int GetKeyCode() const { return (int)m_keyCode
; }
1478 // get the Unicode character corresponding to this key
1479 wxChar
GetUnicodeKey() const { return m_uniChar
; }
1480 #endif // wxUSE_UNICODE
1482 // get the raw key code (platform-dependent)
1483 wxUint32
GetRawKeyCode() const { return m_rawCode
; }
1485 // get the raw key flags (platform-dependent)
1486 wxUint32
GetRawKeyFlags() const { return m_rawFlags
; }
1488 // Find the position of the event
1489 void GetPosition(wxCoord
*xpos
, wxCoord
*ypos
) const
1491 if (xpos
) *xpos
= m_x
;
1492 if (ypos
) *ypos
= m_y
;
1495 void GetPosition(long *xpos
, long *ypos
) const
1497 if (xpos
) *xpos
= (long)m_x
;
1498 if (ypos
) *ypos
= (long)m_y
;
1501 wxPoint
GetPosition() const
1502 { return wxPoint(m_x
, m_y
); }
1505 wxCoord
GetX() const { return m_x
; }
1508 wxCoord
GetY() const { return m_y
; }
1510 virtual wxEvent
*Clone() const { return new wxKeyEvent(*this); }
1511 virtual wxEventCategory
GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT
; }
1513 // we do need to copy wxKeyEvent sometimes (in wxTreeCtrl code, for
1515 wxKeyEvent
& operator=(const wxKeyEvent
& evt
)
1519 wxEvent::operator=(evt
);
1521 // Borland C++ 5.82 doesn't compile an explicit call to an
1522 // implicitly defined operator=() so need to do it this way:
1523 *static_cast<wxKeyboardState
*>(this) = evt
;
1528 m_keyCode
= evt
.m_keyCode
;
1530 m_rawCode
= evt
.m_rawCode
;
1531 m_rawFlags
= evt
.m_rawFlags
;
1533 m_uniChar
= evt
.m_uniChar
;
1545 // This contains the full Unicode character
1546 // in a character events in Unicode mode
1550 // these fields contain the platform-specific information about
1551 // key that was pressed
1553 wxUint32 m_rawFlags
;
1556 DECLARE_DYNAMIC_CLASS(wxKeyEvent
)
1564 class WXDLLIMPEXP_CORE wxSizeEvent
: public wxEvent
1567 wxSizeEvent() : wxEvent(0, wxEVT_SIZE
)
1569 wxSizeEvent(const wxSize
& sz
, int winid
= 0)
1570 : wxEvent(winid
, wxEVT_SIZE
),
1573 wxSizeEvent(const wxSizeEvent
& event
)
1575 m_size(event
.m_size
), m_rect(event
.m_rect
)
1577 wxSizeEvent(const wxRect
& rect
, int id
= 0)
1578 : m_size(rect
.GetSize()), m_rect(rect
)
1579 { m_eventType
= wxEVT_SIZING
; m_id
= id
; }
1581 wxSize
GetSize() const { return m_size
; }
1582 wxRect
GetRect() const { return m_rect
; }
1583 void SetRect(const wxRect
& rect
) { m_rect
= rect
; }
1585 virtual wxEvent
*Clone() const { return new wxSizeEvent(*this); }
1588 // For internal usage only. Will be converted to protected members.
1590 wxRect m_rect
; // Used for wxEVT_SIZING
1593 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSizeEvent
)
1602 class WXDLLIMPEXP_CORE wxMoveEvent
: public wxEvent
1606 : wxEvent(0, wxEVT_MOVE
)
1608 wxMoveEvent(const wxPoint
& pos
, int winid
= 0)
1609 : wxEvent(winid
, wxEVT_MOVE
),
1612 wxMoveEvent(const wxMoveEvent
& event
)
1616 wxMoveEvent(const wxRect
& rect
, int id
= 0)
1617 : m_pos(rect
.GetPosition()), m_rect(rect
)
1618 { m_eventType
= wxEVT_MOVING
; m_id
= id
; }
1620 wxPoint
GetPosition() const { return m_pos
; }
1621 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
1622 wxRect
GetRect() const { return m_rect
; }
1623 void SetRect(const wxRect
& rect
) { m_rect
= rect
; }
1625 virtual wxEvent
*Clone() const { return new wxMoveEvent(*this); }
1632 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMoveEvent
)
1635 // Paint event class
1642 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1643 // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined
1644 extern WXDLLIMPEXP_CORE
int g_isPainting
;
1647 class WXDLLIMPEXP_CORE wxPaintEvent
: public wxEvent
1650 wxPaintEvent(int Id
= 0)
1651 : wxEvent(Id
, wxEVT_PAINT
)
1653 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1654 // set the internal flag for the duration of processing of WM_PAINT
1659 // default copy ctor and dtor are normally fine, we only need them to keep
1660 // g_isPainting updated in debug build
1661 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1662 wxPaintEvent(const wxPaintEvent
& event
)
1668 virtual ~wxPaintEvent()
1674 virtual wxEvent
*Clone() const { return new wxPaintEvent(*this); }
1677 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaintEvent
)
1680 class WXDLLIMPEXP_CORE wxNcPaintEvent
: public wxEvent
1683 wxNcPaintEvent(int winid
= 0)
1684 : wxEvent(winid
, wxEVT_NC_PAINT
)
1687 virtual wxEvent
*Clone() const { return new wxNcPaintEvent(*this); }
1690 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNcPaintEvent
)
1693 // Erase background event class
1695 wxEVT_ERASE_BACKGROUND
1698 class WXDLLIMPEXP_CORE wxEraseEvent
: public wxEvent
1701 wxEraseEvent(int Id
= 0, wxDC
*dc
= NULL
)
1702 : wxEvent(Id
, wxEVT_ERASE_BACKGROUND
),
1706 wxEraseEvent(const wxEraseEvent
& event
)
1711 wxDC
*GetDC() const { return m_dc
; }
1713 virtual wxEvent
*Clone() const { return new wxEraseEvent(*this); }
1719 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxEraseEvent
)
1722 // Focus event class
1728 class WXDLLIMPEXP_CORE wxFocusEvent
: public wxEvent
1731 wxFocusEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0)
1732 : wxEvent(winid
, type
)
1735 wxFocusEvent(const wxFocusEvent
& event
)
1737 { m_win
= event
.m_win
; }
1739 // The window associated with this event is the window which had focus
1740 // before for SET event and the window which will have focus for the KILL
1741 // one. NB: it may be NULL in both cases!
1742 wxWindow
*GetWindow() const { return m_win
; }
1743 void SetWindow(wxWindow
*win
) { m_win
= win
; }
1745 virtual wxEvent
*Clone() const { return new wxFocusEvent(*this); }
1751 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFocusEvent
)
1754 // wxChildFocusEvent notifies the parent that a child has got the focus: unlike
1755 // wxFocusEvent it is propagated upwards the window chain
1756 class WXDLLIMPEXP_CORE wxChildFocusEvent
: public wxCommandEvent
1759 wxChildFocusEvent(wxWindow
*win
= NULL
);
1761 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
1763 virtual wxEvent
*Clone() const { return new wxChildFocusEvent(*this); }
1766 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxChildFocusEvent
)
1769 // Activate event class
1776 class WXDLLIMPEXP_CORE wxActivateEvent
: public wxEvent
1779 wxActivateEvent(wxEventType type
= wxEVT_NULL
, bool active
= true, int Id
= 0)
1781 { m_active
= active
; }
1782 wxActivateEvent(const wxActivateEvent
& event
)
1784 { m_active
= event
.m_active
; }
1786 bool GetActive() const { return m_active
; }
1788 virtual wxEvent
*Clone() const { return new wxActivateEvent(*this); }
1794 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxActivateEvent
)
1797 // InitDialog event class
1802 class WXDLLIMPEXP_CORE wxInitDialogEvent
: public wxEvent
1805 wxInitDialogEvent(int Id
= 0)
1806 : wxEvent(Id
, wxEVT_INIT_DIALOG
)
1809 virtual wxEvent
*Clone() const { return new wxInitDialogEvent(*this); }
1812 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxInitDialogEvent
)
1815 // Miscellaneous menu event class
1819 wxEVT_MENU_HIGHLIGHT,
1822 class WXDLLIMPEXP_CORE wxMenuEvent
: public wxEvent
1825 wxMenuEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0, wxMenu
* menu
= NULL
)
1826 : wxEvent(winid
, type
)
1827 { m_menuId
= winid
; m_menu
= menu
; }
1828 wxMenuEvent(const wxMenuEvent
& event
)
1830 { m_menuId
= event
.m_menuId
; m_menu
= event
.m_menu
; }
1832 // only for wxEVT_MENU_HIGHLIGHT
1833 int GetMenuId() const { return m_menuId
; }
1835 // only for wxEVT_MENU_OPEN/CLOSE
1836 bool IsPopup() const { return m_menuId
== wxID_ANY
; }
1838 // only for wxEVT_MENU_OPEN/CLOSE
1839 wxMenu
* GetMenu() const { return m_menu
; }
1841 virtual wxEvent
*Clone() const { return new wxMenuEvent(*this); }
1847 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMenuEvent
)
1850 // Window close or session close event class
1854 wxEVT_QUERY_END_SESSION
1857 class WXDLLIMPEXP_CORE wxCloseEvent
: public wxEvent
1860 wxCloseEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0)
1861 : wxEvent(winid
, type
),
1863 m_veto(false), // should be false by default
1866 wxCloseEvent(const wxCloseEvent
& event
)
1868 m_loggingOff(event
.m_loggingOff
),
1869 m_veto(event
.m_veto
),
1870 m_canVeto(event
.m_canVeto
) {}
1872 void SetLoggingOff(bool logOff
) { m_loggingOff
= logOff
; }
1873 bool GetLoggingOff() const
1875 // m_loggingOff flag is only used by wxEVT_[QUERY_]END_SESSION, it
1876 // doesn't make sense for wxEVT_CLOSE_WINDOW
1877 wxASSERT_MSG( m_eventType
!= wxEVT_CLOSE_WINDOW
,
1878 _T("this flag is for end session events only") );
1880 return m_loggingOff
;
1883 void Veto(bool veto
= true)
1885 // GetVeto() will return false anyhow...
1886 wxCHECK_RET( m_canVeto
,
1887 wxT("call to Veto() ignored (can't veto this event)") );
1891 void SetCanVeto(bool canVeto
) { m_canVeto
= canVeto
; }
1892 bool CanVeto() const { return m_canVeto
; }
1893 bool GetVeto() const { return m_canVeto
&& m_veto
; }
1895 virtual wxEvent
*Clone() const { return new wxCloseEvent(*this); }
1903 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCloseEvent
)
1910 class WXDLLIMPEXP_CORE wxShowEvent
: public wxEvent
1913 wxShowEvent(int winid
= 0, bool show
= false)
1914 : wxEvent(winid
, wxEVT_SHOW
)
1916 wxShowEvent(const wxShowEvent
& event
)
1918 { m_show
= event
.m_show
; }
1920 void SetShow(bool show
) { m_show
= show
; }
1922 // return true if the window was shown, false if hidden
1923 bool IsShown() const { return m_show
; }
1925 #if WXWIN_COMPATIBILITY_2_8
1926 wxDEPRECATED( bool GetShow() const { return IsShown(); } )
1929 virtual wxEvent
*Clone() const { return new wxShowEvent(*this); }
1935 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxShowEvent
)
1942 class WXDLLIMPEXP_CORE wxIconizeEvent
: public wxEvent
1945 wxIconizeEvent(int winid
= 0, bool iconized
= true)
1946 : wxEvent(winid
, wxEVT_ICONIZE
)
1947 { m_iconized
= iconized
; }
1948 wxIconizeEvent(const wxIconizeEvent
& event
)
1950 { m_iconized
= event
.m_iconized
; }
1952 #if WXWIN_COMPATIBILITY_2_8
1953 wxDEPRECATED( bool Iconized() const { return IsIconized(); } )
1955 // return true if the frame was iconized, false if restored
1956 bool IsIconized() const { return m_iconized
; }
1958 virtual wxEvent
*Clone() const { return new wxIconizeEvent(*this); }
1964 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIconizeEvent
)
1970 class WXDLLIMPEXP_CORE wxMaximizeEvent
: public wxEvent
1973 wxMaximizeEvent(int winid
= 0)
1974 : wxEvent(winid
, wxEVT_MAXIMIZE
)
1977 virtual wxEvent
*Clone() const { return new wxMaximizeEvent(*this); }
1980 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMaximizeEvent
)
1983 // Joystick event class
1985 wxEVT_JOY_BUTTON_DOWN,
1986 wxEVT_JOY_BUTTON_UP,
1991 // Which joystick? Same as Windows ids so no conversion necessary.
1998 // Which button is down?
2001 wxJOY_BUTTON_ANY
= -1,
2008 class WXDLLIMPEXP_CORE wxJoystickEvent
: public wxEvent
2013 int m_buttonChange
; // Which button changed?
2014 int m_buttonState
; // Which buttons are down?
2015 int m_joyStick
; // Which joystick?
2018 wxJoystickEvent(wxEventType type
= wxEVT_NULL
,
2020 int joystick
= wxJOYSTICK1
,
2025 m_buttonChange(change
),
2026 m_buttonState(state
),
2027 m_joyStick(joystick
)
2030 wxJoystickEvent(const wxJoystickEvent
& event
)
2033 m_zPosition(event
.m_zPosition
),
2034 m_buttonChange(event
.m_buttonChange
),
2035 m_buttonState(event
.m_buttonState
),
2036 m_joyStick(event
.m_joyStick
)
2039 wxPoint
GetPosition() const { return m_pos
; }
2040 int GetZPosition() const { return m_zPosition
; }
2041 int GetButtonState() const { return m_buttonState
; }
2042 int GetButtonChange() const { return m_buttonChange
; }
2043 int GetJoystick() const { return m_joyStick
; }
2045 void SetJoystick(int stick
) { m_joyStick
= stick
; }
2046 void SetButtonState(int state
) { m_buttonState
= state
; }
2047 void SetButtonChange(int change
) { m_buttonChange
= change
; }
2048 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2049 void SetZPosition(int zPos
) { m_zPosition
= zPos
; }
2051 // Was it a button event? (*doesn't* mean: is any button *down*?)
2052 bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN
) ||
2053 (GetEventType() == wxEVT_JOY_BUTTON_UP
)); }
2055 // Was it a move event?
2056 bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE
); }
2058 // Was it a zmove event?
2059 bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE
); }
2061 // Was it a down event from button 1, 2, 3, 4 or any?
2062 bool ButtonDown(int but
= wxJOY_BUTTON_ANY
) const
2063 { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN
) &&
2064 ((but
== wxJOY_BUTTON_ANY
) || (but
== m_buttonChange
))); }
2066 // Was it a up event from button 1, 2, 3 or any?
2067 bool ButtonUp(int but
= wxJOY_BUTTON_ANY
) const
2068 { return ((GetEventType() == wxEVT_JOY_BUTTON_UP
) &&
2069 ((but
== wxJOY_BUTTON_ANY
) || (but
== m_buttonChange
))); }
2071 // Was the given button 1,2,3,4 or any in Down state?
2072 bool ButtonIsDown(int but
= wxJOY_BUTTON_ANY
) const
2073 { return (((but
== wxJOY_BUTTON_ANY
) && (m_buttonState
!= 0)) ||
2074 ((m_buttonState
& but
) == but
)); }
2076 virtual wxEvent
*Clone() const { return new wxJoystickEvent(*this); }
2079 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxJoystickEvent
)
2082 // Drop files event class
2087 class WXDLLIMPEXP_CORE wxDropFilesEvent
: public wxEvent
2094 wxDropFilesEvent(wxEventType type
= wxEVT_NULL
,
2096 wxString
*files
= NULL
)
2103 // we need a copy ctor to avoid deleting m_files pointer twice
2104 wxDropFilesEvent(const wxDropFilesEvent
& other
)
2106 m_noFiles(other
.m_noFiles
),
2110 m_files
= new wxString
[m_noFiles
];
2111 for ( int n
= 0; n
< m_noFiles
; n
++ )
2113 m_files
[n
] = other
.m_files
[n
];
2117 virtual ~wxDropFilesEvent()
2122 wxPoint
GetPosition() const { return m_pos
; }
2123 int GetNumberOfFiles() const { return m_noFiles
; }
2124 wxString
*GetFiles() const { return m_files
; }
2126 virtual wxEvent
*Clone() const { return new wxDropFilesEvent(*this); }
2129 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDropFilesEvent
)
2137 // Whether to always send update events to windows, or
2138 // to only send update events to those with the
2139 // wxWS_EX_PROCESS_UI_UPDATES style.
2143 // Send UI update events to all windows
2144 wxUPDATE_UI_PROCESS_ALL
,
2146 // Send UI update events to windows that have
2147 // the wxWS_EX_PROCESS_UI_UPDATES flag specified
2148 wxUPDATE_UI_PROCESS_SPECIFIED
2151 class WXDLLIMPEXP_CORE wxUpdateUIEvent
: public wxCommandEvent
2154 wxUpdateUIEvent(wxWindowID commandId
= 0)
2155 : wxCommandEvent(wxEVT_UPDATE_UI
, commandId
)
2163 m_setChecked
= false;
2165 wxUpdateUIEvent(const wxUpdateUIEvent
& event
)
2166 : wxCommandEvent(event
),
2167 m_checked(event
.m_checked
),
2168 m_enabled(event
.m_enabled
),
2169 m_shown(event
.m_shown
),
2170 m_setEnabled(event
.m_setEnabled
),
2171 m_setShown(event
.m_setShown
),
2172 m_setText(event
.m_setText
),
2173 m_setChecked(event
.m_setChecked
),
2174 m_text(event
.m_text
)
2177 bool GetChecked() const { return m_checked
; }
2178 bool GetEnabled() const { return m_enabled
; }
2179 bool GetShown() const { return m_shown
; }
2180 wxString
GetText() const { return m_text
; }
2181 bool GetSetText() const { return m_setText
; }
2182 bool GetSetChecked() const { return m_setChecked
; }
2183 bool GetSetEnabled() const { return m_setEnabled
; }
2184 bool GetSetShown() const { return m_setShown
; }
2186 void Check(bool check
) { m_checked
= check
; m_setChecked
= true; }
2187 void Enable(bool enable
) { m_enabled
= enable
; m_setEnabled
= true; }
2188 void Show(bool show
) { m_shown
= show
; m_setShown
= true; }
2189 void SetText(const wxString
& text
) { m_text
= text
; m_setText
= true; }
2191 // Sets the interval between updates in milliseconds.
2192 // Set to -1 to disable updates, or to 0 to update as frequently as possible.
2193 static void SetUpdateInterval(long updateInterval
) { sm_updateInterval
= updateInterval
; }
2195 // Returns the current interval between updates in milliseconds
2196 static long GetUpdateInterval() { return sm_updateInterval
; }
2198 // Can we update this window?
2199 static bool CanUpdate(wxWindowBase
*win
);
2201 // Reset the update time to provide a delay until the next
2202 // time we should update
2203 static void ResetUpdateTime();
2205 // Specify how wxWidgets will send update events: to
2206 // all windows, or only to those which specify that they
2207 // will process the events.
2208 static void SetMode(wxUpdateUIMode mode
) { sm_updateMode
= mode
; }
2210 // Returns the UI update mode
2211 static wxUpdateUIMode
GetMode() { return sm_updateMode
; }
2213 virtual wxEvent
*Clone() const { return new wxUpdateUIEvent(*this); }
2225 static wxLongLong sm_lastUpdate
;
2227 static long sm_updateInterval
;
2228 static wxUpdateUIMode sm_updateMode
;
2231 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxUpdateUIEvent
)
2235 wxEVT_SYS_COLOUR_CHANGED
2238 // TODO: shouldn't all events record the window ID?
2239 class WXDLLIMPEXP_CORE wxSysColourChangedEvent
: public wxEvent
2242 wxSysColourChangedEvent()
2243 : wxEvent(0, wxEVT_SYS_COLOUR_CHANGED
)
2246 virtual wxEvent
*Clone() const { return new wxSysColourChangedEvent(*this); }
2249 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSysColourChangedEvent
)
2253 wxEVT_MOUSE_CAPTURE_CHANGED
2254 The window losing the capture receives this message
2255 (even if it released the capture itself).
2258 class WXDLLIMPEXP_CORE wxMouseCaptureChangedEvent
: public wxEvent
2261 wxMouseCaptureChangedEvent(wxWindowID winid
= 0, wxWindow
* gainedCapture
= NULL
)
2262 : wxEvent(winid
, wxEVT_MOUSE_CAPTURE_CHANGED
),
2263 m_gainedCapture(gainedCapture
)
2266 wxMouseCaptureChangedEvent(const wxMouseCaptureChangedEvent
& event
)
2268 m_gainedCapture(event
.m_gainedCapture
)
2271 virtual wxEvent
*Clone() const { return new wxMouseCaptureChangedEvent(*this); }
2273 wxWindow
* GetCapturedWindow() const { return m_gainedCapture
; }
2276 wxWindow
* m_gainedCapture
;
2278 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureChangedEvent
)
2282 wxEVT_MOUSE_CAPTURE_LOST
2283 The window losing the capture receives this message, unless it released it
2284 it itself or unless wxWindow::CaptureMouse was called on another window
2285 (and so capture will be restored when the new capturer releases it).
2288 class WXDLLIMPEXP_CORE wxMouseCaptureLostEvent
: public wxEvent
2291 wxMouseCaptureLostEvent(wxWindowID winid
= 0)
2292 : wxEvent(winid
, wxEVT_MOUSE_CAPTURE_LOST
)
2295 wxMouseCaptureLostEvent(const wxMouseCaptureLostEvent
& event
)
2299 virtual wxEvent
*Clone() const { return new wxMouseCaptureLostEvent(*this); }
2301 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureLostEvent
)
2305 wxEVT_DISPLAY_CHANGED
2307 class WXDLLIMPEXP_CORE wxDisplayChangedEvent
: public wxEvent
2310 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDisplayChangedEvent
)
2313 wxDisplayChangedEvent()
2314 : wxEvent(0, wxEVT_DISPLAY_CHANGED
)
2317 virtual wxEvent
*Clone() const { return new wxDisplayChangedEvent(*this); }
2321 wxEVT_PALETTE_CHANGED
2324 class WXDLLIMPEXP_CORE wxPaletteChangedEvent
: public wxEvent
2327 wxPaletteChangedEvent(wxWindowID winid
= 0)
2328 : wxEvent(winid
, wxEVT_PALETTE_CHANGED
),
2329 m_changedWindow(NULL
)
2332 wxPaletteChangedEvent(const wxPaletteChangedEvent
& event
)
2334 m_changedWindow(event
.m_changedWindow
)
2337 void SetChangedWindow(wxWindow
* win
) { m_changedWindow
= win
; }
2338 wxWindow
* GetChangedWindow() const { return m_changedWindow
; }
2340 virtual wxEvent
*Clone() const { return new wxPaletteChangedEvent(*this); }
2343 wxWindow
* m_changedWindow
;
2346 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaletteChangedEvent
)
2350 wxEVT_QUERY_NEW_PALETTE
2351 Indicates the window is getting keyboard focus and should re-do its palette.
2354 class WXDLLIMPEXP_CORE wxQueryNewPaletteEvent
: public wxEvent
2357 wxQueryNewPaletteEvent(wxWindowID winid
= 0)
2358 : wxEvent(winid
, wxEVT_QUERY_NEW_PALETTE
),
2359 m_paletteRealized(false)
2361 wxQueryNewPaletteEvent(const wxQueryNewPaletteEvent
& event
)
2363 m_paletteRealized(event
.m_paletteRealized
)
2366 // App sets this if it changes the palette.
2367 void SetPaletteRealized(bool realized
) { m_paletteRealized
= realized
; }
2368 bool GetPaletteRealized() const { return m_paletteRealized
; }
2370 virtual wxEvent
*Clone() const { return new wxQueryNewPaletteEvent(*this); }
2373 bool m_paletteRealized
;
2376 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxQueryNewPaletteEvent
)
2380 Event generated by dialog navigation keys
2381 wxEVT_NAVIGATION_KEY
2383 // NB: don't derive from command event to avoid being propagated to the parent
2384 class WXDLLIMPEXP_CORE wxNavigationKeyEvent
: public wxEvent
2387 wxNavigationKeyEvent()
2388 : wxEvent(0, wxEVT_NAVIGATION_KEY
),
2389 m_flags(IsForward
| FromTab
), // defaults are for TAB
2392 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
2395 wxNavigationKeyEvent(const wxNavigationKeyEvent
& event
)
2397 m_flags(event
.m_flags
),
2398 m_focus(event
.m_focus
)
2401 // direction: forward (true) or backward (false)
2402 bool GetDirection() const
2403 { return (m_flags
& IsForward
) != 0; }
2404 void SetDirection(bool bForward
)
2405 { if ( bForward
) m_flags
|= IsForward
; else m_flags
&= ~IsForward
; }
2407 // it may be a window change event (MDI, notebook pages...) or a control
2409 bool IsWindowChange() const
2410 { return (m_flags
& WinChange
) != 0; }
2411 void SetWindowChange(bool bIs
)
2412 { if ( bIs
) m_flags
|= WinChange
; else m_flags
&= ~WinChange
; }
2414 // Set to true under MSW if the event was generated using the tab key.
2415 // This is required for proper navogation over radio buttons
2416 bool IsFromTab() const
2417 { return (m_flags
& FromTab
) != 0; }
2418 void SetFromTab(bool bIs
)
2419 { if ( bIs
) m_flags
|= FromTab
; else m_flags
&= ~FromTab
; }
2421 // the child which has the focus currently (may be NULL - use
2422 // wxWindow::FindFocus then)
2423 wxWindow
* GetCurrentFocus() const { return m_focus
; }
2424 void SetCurrentFocus(wxWindow
*win
) { m_focus
= win
; }
2427 void SetFlags(long flags
) { m_flags
= flags
; }
2429 virtual wxEvent
*Clone() const { return new wxNavigationKeyEvent(*this); }
2431 enum wxNavigationKeyEventFlags
2433 IsBackward
= 0x0000,
2443 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNavigationKeyEvent
)
2446 // Window creation/destruction events: the first is sent as soon as window is
2447 // created (i.e. the underlying GUI object exists), but when the C++ object is
2448 // fully initialized (so virtual functions may be called). The second,
2449 // wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
2450 // still safe to call virtual functions at this moment
2456 class WXDLLIMPEXP_CORE wxWindowCreateEvent
: public wxCommandEvent
2459 wxWindowCreateEvent(wxWindow
*win
= NULL
);
2461 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
2463 virtual wxEvent
*Clone() const { return new wxWindowCreateEvent(*this); }
2466 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowCreateEvent
)
2469 class WXDLLIMPEXP_CORE wxWindowDestroyEvent
: public wxCommandEvent
2472 wxWindowDestroyEvent(wxWindow
*win
= NULL
);
2474 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
2476 virtual wxEvent
*Clone() const { return new wxWindowDestroyEvent(*this); }
2479 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowDestroyEvent
)
2482 // A help event is sent when the user clicks on a window in context-help mode.
2488 class WXDLLIMPEXP_CORE wxHelpEvent
: public wxCommandEvent
2491 // how was this help event generated?
2494 Origin_Unknown
, // unrecognized event source
2495 Origin_Keyboard
, // event generated from F1 key press
2496 Origin_HelpButton
// event from [?] button on the title bar (Windows)
2499 wxHelpEvent(wxEventType type
= wxEVT_NULL
,
2500 wxWindowID winid
= 0,
2501 const wxPoint
& pt
= wxDefaultPosition
,
2502 Origin origin
= Origin_Unknown
)
2503 : wxCommandEvent(type
, winid
),
2505 m_origin(GuessOrigin(origin
))
2507 wxHelpEvent(const wxHelpEvent
& event
)
2508 : wxCommandEvent(event
),
2510 m_target(event
.m_target
),
2511 m_link(event
.m_link
),
2512 m_origin(event
.m_origin
)
2515 // Position of event (in screen coordinates)
2516 const wxPoint
& GetPosition() const { return m_pos
; }
2517 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2519 // Optional link to further help
2520 const wxString
& GetLink() const { return m_link
; }
2521 void SetLink(const wxString
& link
) { m_link
= link
; }
2523 // Optional target to display help in. E.g. a window specification
2524 const wxString
& GetTarget() const { return m_target
; }
2525 void SetTarget(const wxString
& target
) { m_target
= target
; }
2527 virtual wxEvent
*Clone() const { return new wxHelpEvent(*this); }
2529 // optional indication of the event source
2530 Origin
GetOrigin() const { return m_origin
; }
2531 void SetOrigin(Origin origin
) { m_origin
= origin
; }
2539 // we can try to guess the event origin ourselves, even if none is
2540 // specified in the ctor
2541 static Origin
GuessOrigin(Origin origin
);
2544 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHelpEvent
)
2547 // A Clipboard Text event is sent when a window intercepts text copy/cut/paste
2548 // message, i.e. the user has cut/copied/pasted data from/into a text control
2549 // via ctrl-C/X/V, ctrl/shift-del/insert, a popup menu command, etc.
2550 // NOTE : under windows these events are *NOT* generated automatically
2551 // for a Rich Edit text control.
2553 wxEVT_COMMAND_TEXT_COPY
2554 wxEVT_COMMAND_TEXT_CUT
2555 wxEVT_COMMAND_TEXT_PASTE
2558 class WXDLLIMPEXP_CORE wxClipboardTextEvent
: public wxCommandEvent
2561 wxClipboardTextEvent(wxEventType type
= wxEVT_NULL
,
2562 wxWindowID winid
= 0)
2563 : wxCommandEvent(type
, winid
)
2565 wxClipboardTextEvent(const wxClipboardTextEvent
& event
)
2566 : wxCommandEvent(event
)
2569 virtual wxEvent
*Clone() const { return new wxClipboardTextEvent(*this); }
2572 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxClipboardTextEvent
)
2575 // A Context event is sent when the user right clicks on a window or
2576 // presses Shift-F10
2577 // NOTE : Under windows this is a repackaged WM_CONTETXMENU message
2578 // Under other systems it may have to be generated from a right click event
2583 class WXDLLIMPEXP_CORE wxContextMenuEvent
: public wxCommandEvent
2586 wxContextMenuEvent(wxEventType type
= wxEVT_NULL
,
2587 wxWindowID winid
= 0,
2588 const wxPoint
& pt
= wxDefaultPosition
)
2589 : wxCommandEvent(type
, winid
),
2592 wxContextMenuEvent(const wxContextMenuEvent
& event
)
2593 : wxCommandEvent(event
),
2597 // Position of event (in screen coordinates)
2598 const wxPoint
& GetPosition() const { return m_pos
; }
2599 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2601 virtual wxEvent
*Clone() const { return new wxContextMenuEvent(*this); }
2607 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxContextMenuEvent
)
2617 // Whether to always send idle events to windows, or
2618 // to only send update events to those with the
2619 // wxWS_EX_PROCESS_IDLE style.
2623 // Send idle events to all windows
2626 // Send idle events to windows that have
2627 // the wxWS_EX_PROCESS_IDLE flag specified
2628 wxIDLE_PROCESS_SPECIFIED
2631 class WXDLLIMPEXP_BASE wxIdleEvent
: public wxEvent
2635 : wxEvent(0, wxEVT_IDLE
),
2636 m_requestMore(false)
2638 wxIdleEvent(const wxIdleEvent
& event
)
2640 m_requestMore(event
.m_requestMore
)
2643 void RequestMore(bool needMore
= true) { m_requestMore
= needMore
; }
2644 bool MoreRequested() const { return m_requestMore
; }
2646 virtual wxEvent
*Clone() const { return new wxIdleEvent(*this); }
2648 // Specify how wxWidgets will send idle events: to
2649 // all windows, or only to those which specify that they
2650 // will process the events.
2651 static void SetMode(wxIdleMode mode
) { sm_idleMode
= mode
; }
2653 // Returns the idle event mode
2654 static wxIdleMode
GetMode() { return sm_idleMode
; }
2658 static wxIdleMode sm_idleMode
;
2661 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIdleEvent
)
2665 wxEVT_MOUSE_CAPTURE_CHANGED,
2666 wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
2667 // wxEVT_FONT_CHANGED, // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
2668 // wxEVT_FONT_CHANGED to all other windows (maybe).
2669 wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
2676 // ============================================================================
2677 // event handler and related classes
2678 // ============================================================================
2681 // struct containing the members common to static and dynamic event tables
2683 struct WXDLLIMPEXP_BASE wxEventTableEntryBase
2685 wxEventTableEntryBase(int winid
, int idLast
,
2686 wxEventFunctor
* fn
, wxObject
*data
)
2690 m_callbackUserData(data
)
2693 wxEventTableEntryBase( const wxEventTableEntryBase
&entry
)
2694 : m_id( entry
.m_id
),
2695 m_lastId( entry
.m_lastId
),
2697 m_callbackUserData( entry
.m_callbackUserData
)
2699 // This is a 'hack' to ensure that only one instance tries to delete
2700 // the functor pointer. It is safe as long as the only place where the
2701 // copy constructor is being called is when the static event tables are
2702 // being initialized (a temporary instance is created and then this
2703 // constructor is called).
2705 const_cast<wxEventTableEntryBase
&>( entry
).m_fn
= NULL
;
2708 ~wxEventTableEntryBase()
2713 // the range of ids for this entry: if m_lastId == wxID_ANY, the range
2714 // consists only of m_id, otherwise it is m_id..m_lastId inclusive
2718 // function/method/functor to call
2719 wxEventFunctor
* m_fn
;
2721 // arbitrary user data associated with the callback
2722 wxObject
* m_callbackUserData
;
2725 wxDECLARE_NO_ASSIGN_CLASS(wxEventTableEntryBase
);
2728 // an entry from a static event table
2729 struct WXDLLIMPEXP_BASE wxEventTableEntry
: public wxEventTableEntryBase
2731 wxEventTableEntry(const int& evType
, int winid
, int idLast
,
2732 wxEventFunctor
* fn
, wxObject
*data
)
2733 : wxEventTableEntryBase(winid
, idLast
, fn
, data
),
2737 // the reference to event type: this allows us to not care about the
2738 // (undefined) order in which the event table entries and the event types
2739 // are initialized: initially the value of this reference might be
2740 // invalid, but by the time it is used for the first time, all global
2741 // objects will have been initialized (including the event type constants)
2742 // and so it will have the correct value when it is needed
2743 const int& m_eventType
;
2746 wxDECLARE_NO_ASSIGN_CLASS(wxEventTableEntry
);
2749 // an entry used in dynamic event table managed by wxEvtHandler::Connect()
2750 struct WXDLLIMPEXP_BASE wxDynamicEventTableEntry
: public wxEventTableEntryBase
2752 wxDynamicEventTableEntry(int evType
, int winid
, int idLast
,
2753 wxEventFunctor
* fn
, wxObject
*data
)
2754 : wxEventTableEntryBase(winid
, idLast
, fn
, data
),
2758 // not a reference here as we can't keep a reference to a temporary int
2759 // created to wrap the constant value typically passed to Connect() - nor
2764 wxDECLARE_NO_ASSIGN_CLASS(wxDynamicEventTableEntry
);
2767 // ----------------------------------------------------------------------------
2768 // wxEventTable: an array of event entries terminated with {0, 0, 0, 0, 0}
2769 // ----------------------------------------------------------------------------
2771 struct WXDLLIMPEXP_BASE wxEventTable
2773 const wxEventTable
*baseTable
; // base event table (next in chain)
2774 const wxEventTableEntry
*entries
; // bottom of entry array
2777 // ----------------------------------------------------------------------------
2778 // wxEventHashTable: a helper of wxEvtHandler to speed up wxEventTable lookups.
2779 // ----------------------------------------------------------------------------
2781 WX_DEFINE_ARRAY_PTR(const wxEventTableEntry
*, wxEventTableEntryPointerArray
);
2783 class WXDLLIMPEXP_BASE wxEventHashTable
2786 // Internal data structs
2787 struct EventTypeTable
2789 wxEventType eventType
;
2790 wxEventTableEntryPointerArray eventEntryTable
;
2792 typedef EventTypeTable
* EventTypeTablePointer
;
2795 // Constructor, needs the event table it needs to hash later on.
2796 // Note: hashing of the event table is not done in the constructor as it
2797 // can be that the event table is not yet full initialize, the hash
2798 // will gets initialized when handling the first event look-up request.
2799 wxEventHashTable(const wxEventTable
&table
);
2801 ~wxEventHashTable();
2803 // Handle the given event, in other words search the event table hash
2804 // and call self->ProcessEvent() if a match was found.
2805 bool HandleEvent(wxEvent
& event
, wxEvtHandler
*self
);
2810 #if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
2812 static void ClearAll();
2813 #endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING
2816 // Init the hash table with the entries of the static event table.
2817 void InitHashTable();
2818 // Helper funtion of InitHashTable() to insert 1 entry into the hash table.
2819 void AddEntry(const wxEventTableEntry
&entry
);
2820 // Allocate and init with null pointers the base hash table.
2821 void AllocEventTypeTable(size_t size
);
2822 // Grow the hash table in size and transfer all items currently
2823 // in the table to the correct location in the new table.
2824 void GrowEventTypeTable();
2827 const wxEventTable
&m_table
;
2831 EventTypeTablePointer
*m_eventTypeTable
;
2833 static wxEventHashTable
* sm_first
;
2834 wxEventHashTable
* m_previous
;
2835 wxEventHashTable
* m_next
;
2837 wxDECLARE_NO_COPY_CLASS(wxEventHashTable
);
2840 // ----------------------------------------------------------------------------
2841 // wxEvtHandler: the base class for all objects handling wxWidgets events
2842 // ----------------------------------------------------------------------------
2844 class WXDLLIMPEXP_BASE wxEvtHandler
: public wxObject
2845 , public wxTrackable
2849 virtual ~wxEvtHandler();
2852 // Event handler chain
2853 // -------------------
2855 wxEvtHandler
*GetNextHandler() const { return m_nextHandler
; }
2856 wxEvtHandler
*GetPreviousHandler() const { return m_previousHandler
; }
2857 virtual void SetNextHandler(wxEvtHandler
*handler
) { m_nextHandler
= handler
; }
2858 virtual void SetPreviousHandler(wxEvtHandler
*handler
) { m_previousHandler
= handler
; }
2860 void SetEvtHandlerEnabled(bool enabled
) { m_enabled
= enabled
; }
2861 bool GetEvtHandlerEnabled() const { return m_enabled
; }
2864 bool IsUnlinked() const;
2868 // Event queuing and processing
2869 // ----------------------------
2872 // Process an event right now: this can only be called from the main
2873 // thread, use QueueEvent() for scheduling the events for
2874 // processing from other threads.
2875 virtual bool ProcessEvent(wxEvent
& event
);
2877 // Process an event by calling ProcessEvent and handling any exceptions
2878 // thrown by event handlers. It's mostly useful when processing wx events
2879 // when called from C code (e.g. in GTK+ callback) when the exception
2880 // wouldn't correctly propagate to wxEventLoop.
2881 bool SafelyProcessEvent(wxEvent
& event
);
2882 // NOTE: uses ProcessEvent()
2884 // Schedule the given event to be processed later. It takes ownership of
2885 // the event pointer, i.e. it will be deleted later. This is safe to call
2886 // from multiple threads although you still need to ensure that wxString
2887 // fields of the event object are deep copies and not use the same string
2888 // buffer as other wxString objects in this thread.
2889 virtual void QueueEvent(wxEvent
*event
);
2891 // Add an event to be processed later: notice that this function is not
2892 // safe to call from threads other than main, use QueueEvent()
2893 virtual void AddPendingEvent(const wxEvent
& event
)
2895 // notice that the thread-safety problem comes from the fact that
2896 // Clone() doesn't make deep copies of wxString fields of wxEvent
2897 // object and so the same wxString could be used from both threads when
2898 // the event object is destroyed in this one -- QueueEvent() avoids
2899 // this problem as the event pointer is not used any more in this
2900 // thread at all after it is called.
2901 QueueEvent(event
.Clone());
2904 void ProcessPendingEvents();
2905 // NOTE: uses ProcessEvent()
2908 bool ProcessThreadEvent(const wxEvent
& event
);
2909 // NOTE: uses AddPendingEvent()
2913 // Connecting and disconnecting
2914 // ----------------------------
2916 // These functions are used for old, untyped, event handlers and don't
2917 // check that the type of the function passed to them actually matches the
2918 // type of the event. They also only allow connecting events to methods of
2919 // wxEvtHandler-derived classes.
2921 // The template Connect() methods below are safer and allow connecting
2922 // events to arbitrary functions or functors -- but require compiler
2923 // support for templates.
2925 // Dynamic association of a member function handler with the event handler,
2926 // winid and event type
2927 void Connect(int winid
,
2929 wxEventType eventType
,
2930 wxObjectEventFunction func
,
2931 wxObject
*userData
= NULL
,
2932 wxEvtHandler
*eventSink
= NULL
)
2934 DoConnect(winid
, lastId
, eventType
,
2935 wxNewEventFunctor(eventType
, func
, eventSink
),
2939 // Convenience function: take just one id
2940 void Connect(int winid
,
2941 wxEventType eventType
,
2942 wxObjectEventFunction func
,
2943 wxObject
*userData
= NULL
,
2944 wxEvtHandler
*eventSink
= NULL
)
2945 { Connect(winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
2947 // Even more convenient: without id (same as using id of wxID_ANY)
2948 void Connect(wxEventType eventType
,
2949 wxObjectEventFunction func
,
2950 wxObject
*userData
= NULL
,
2951 wxEvtHandler
*eventSink
= NULL
)
2952 { Connect(wxID_ANY
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
2954 bool Disconnect(int winid
,
2956 wxEventType eventType
,
2957 wxObjectEventFunction func
= NULL
,
2958 wxObject
*userData
= NULL
,
2959 wxEvtHandler
*eventSink
= NULL
)
2961 return DoDisconnect(winid
, lastId
, eventType
,
2962 wxMakeEventFunctor(eventType
, func
, eventSink
),
2966 bool Disconnect(int winid
= wxID_ANY
,
2967 wxEventType eventType
= wxEVT_NULL
,
2968 wxObjectEventFunction func
= NULL
,
2969 wxObject
*userData
= NULL
,
2970 wxEvtHandler
*eventSink
= NULL
)
2971 { return Disconnect(winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
2973 bool Disconnect(wxEventType eventType
,
2974 wxObjectEventFunction func
,
2975 wxObject
*userData
= NULL
,
2976 wxEvtHandler
*eventSink
= NULL
)
2977 { return Disconnect(wxID_ANY
, eventType
, func
, userData
, eventSink
); }
2979 #if !wxEVENTS_COMPATIBILITY_2_8
2980 // Event handling in functions (including generalized functors):
2982 template <typename EventTag
, typename Functor
>
2983 void Connect(int winid
,
2985 const EventTag
& eventType
,
2988 DoConnect(winid
, lastId
, eventType
,
2989 wxNewEventFunctor(eventType
, func
));
2992 template <typename EventTag
, typename Functor
>
2993 void Connect(int winid
, const EventTag
& eventType
, Functor func
)
2994 { Connect(winid
, wxID_ANY
, eventType
, func
); }
2996 template <typename EventTag
, typename Functor
>
2997 void Connect(const EventTag
& eventType
, Functor func
)
2998 { Connect(wxID_ANY
, eventType
, func
); }
3001 template <typename EventTag
, typename Functor
>
3002 bool Disconnect(int winid
,
3004 const EventTag
& eventType
,
3007 return DoDisconnect(winid
, lastId
, eventType
,
3008 wxMakeEventFunctor(eventType
, func
));
3011 template <typename EventTag
, typename Functor
>
3012 bool Disconnect(int winid
, const EventTag
& eventType
, Functor func
)
3013 { return Disconnect(winid
, wxID_ANY
, eventType
, func
); }
3015 template <typename EventTag
, typename Functor
>
3016 bool Disconnect(const EventTag
& eventType
, Functor func
)
3017 { return Disconnect(wxID_ANY
, eventType
, func
); }
3021 // Event handling in class methods: the object handling the event (i.e.
3022 // this object itself by default or eventSink if specified) must be
3023 // convertible to this class.
3025 // Notice that we need to have separate overloads for the versions with and
3026 // without eventSink because in the latter case we must check that this
3027 // object itself derives from Class while in the former this is not
3030 // Methods connecting/disconnecting event to this object itself
3032 template <typename EventTag
, typename Class
, typename EventArg
>
3033 void Connect(int winid
,
3035 const EventTag
& eventType
,
3036 void (Class::*func
)(EventArg
&),
3037 wxObject
*userData
= NULL
)
3039 DoConnect(winid
, lastId
, eventType
,
3040 wxNewEventFunctor(eventType
, func
, static_cast<Class
*>(this)),
3044 template <typename EventTag
, typename Class
, typename EventArg
>
3045 void Connect(int winid
,
3046 const EventTag
& eventType
,
3047 void (Class::*func
)(EventArg
&),
3048 wxObject
*userData
= NULL
)
3049 { Connect(winid
, wxID_ANY
, eventType
, func
, userData
); }
3051 template <typename EventTag
, typename Class
, typename EventArg
>
3052 void Connect(const EventTag
& eventType
,
3053 void (Class::*func
)(EventArg
&),
3054 wxObject
*userData
= NULL
)
3055 { Connect(wxID_ANY
, eventType
, func
, userData
); }
3058 template <typename EventTag
, typename Class
, typename EventArg
>
3059 bool Disconnect(int winid
,
3061 const EventTag
& eventType
,
3062 void (Class::*func
)(EventArg
&),
3063 wxObject
*userData
= NULL
)
3065 return DoDisconnect(winid
, lastId
, eventType
,
3066 wxMakeEventFunctor(eventType
, func
,
3067 static_cast<Class
*>(this)),
3071 template <typename EventTag
, typename Class
, typename EventArg
>
3072 bool Disconnect(int winid
,
3073 const EventTag
& eventType
,
3074 void (Class::*func
)(EventArg
&),
3075 wxObject
*userData
= NULL
)
3076 { return Disconnect(winid
, wxID_ANY
, eventType
, func
, userData
); }
3078 template <typename EventTag
, typename Class
, typename EventArg
>
3079 bool Disconnect(const EventTag
& eventType
,
3080 void (Class::*func
)(EventArg
&),
3081 wxObject
*userData
= NULL
)
3082 { return Disconnect(wxID_ANY
, eventType
, func
, userData
); }
3085 // Methods connecting/disconnecting event to another object
3088 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
3089 void Connect(int winid
,
3091 const EventTag
& eventType
,
3092 void (Class::*func
)(EventArg
&),
3094 ObjClass
*eventSink
)
3096 DoConnect(winid
, lastId
, eventType
,
3097 wxNewEventFunctor(eventType
, func
, eventSink
),
3102 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
3103 void Connect(int winid
,
3104 const EventTag
& eventType
,
3105 void (Class::*func
)(EventArg
&),
3107 ObjClass
*eventSink
)
3108 { Connect(winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3111 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
3112 void Connect(const EventTag
& eventType
,
3113 void (Class::*func
)(EventArg
&),
3115 ObjClass
*eventSink
)
3116 { Connect(wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3120 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
3121 bool Disconnect(int winid
,
3123 const EventTag
& eventType
,
3124 void (Class::*func
)(EventArg
&),
3126 ObjClass
*eventSink
)
3128 return DoDisconnect(winid
, lastId
, eventType
,
3129 wxMakeEventFunctor(eventType
, func
, eventSink
),
3134 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
3135 bool Disconnect(int winid
,
3136 const EventTag
& eventType
,
3137 void (Class::*func
)(EventArg
&),
3139 ObjClass
*eventSink
)
3140 { return Disconnect(winid
, wxID_ANY
, eventType
, func
,
3141 userData
, eventSink
); }
3144 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
3145 bool Disconnect(const EventTag
& eventType
,
3146 void (Class::*func
)(EventArg
&),
3148 ObjClass
*eventSink
)
3149 { return Disconnect(wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3153 // Static version of Connect() which allows to specify the event source and
3154 // event handler in a more symmetric way
3155 template <typename ObjSource
, typename EventTag
,
3156 typename Class
, typename EventArg
, typename ObjClass
>
3157 static void Connect(ObjSource
*eventSrc
,
3160 const EventTag
& eventType
,
3161 void (Class::*func
)(EventArg
&),
3162 wxObject
*userData
= NULL
,
3163 ObjClass
*eventSink
= NULL
)
3165 eventSrc
->Connect(winid
, lastId
, eventType
, func
, userData
, eventSink
);
3168 template <typename ObjSource
, typename EventTag
,
3169 typename Class
, typename EventArg
, typename ObjClass
>
3170 static void Connect(ObjSource
*eventSrc
,
3172 const EventTag
& eventType
,
3173 void (Class::*func
)(EventArg
&),
3174 wxObject
*userData
= NULL
,
3175 ObjClass
*eventSink
= NULL
)
3177 Connect(eventSrc
, winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
);
3180 template <typename ObjSource
, typename EventTag
,
3181 typename Class
, typename EventArg
, typename ObjClass
>
3182 static void Connect(ObjSource
*eventSrc
,
3183 const EventTag
& eventType
,
3184 void (Class::*func
)(EventArg
&),
3185 wxObject
*userData
= NULL
,
3186 ObjClass
*eventSink
= NULL
)
3188 Connect(eventSrc
, wxID_ANY
, eventType
, func
, userData
, eventSink
);
3192 template <typename ObjSource
, typename EventTag
,
3193 typename Class
, typename EventArg
, typename ObjClass
>
3194 static bool Disconnect(ObjSource
*eventSrc
,
3197 const EventTag
& eventType
,
3198 void (Class::*func
)(EventArg
&),
3199 wxObject
*userData
= NULL
,
3200 ObjClass
*eventSink
= NULL
)
3202 return eventSrc
->Disconnect(winid
, lastId
, eventType
, func
,
3203 userData
, eventSink
);
3206 template <typename ObjSource
, typename EventTag
,
3207 typename Class
, typename EventArg
, typename ObjClass
>
3208 static bool Disconnect(ObjSource
*eventSrc
,
3210 const EventTag
& eventType
,
3211 void (Class::*func
)(EventArg
&),
3212 wxObject
*userData
= NULL
,
3213 ObjClass
*eventSink
= NULL
)
3215 return Disconnect(eventSrc
, winid
, wxID_ANY
, eventType
, func
,
3216 userData
, eventSink
);
3219 template <typename ObjSource
, typename EventTag
,
3220 typename Class
, typename EventArg
, typename ObjClass
>
3221 static bool Disconnect(ObjSource
*eventSrc
,
3222 const EventTag
& eventType
,
3223 void (Class::*func
)(EventArg
&),
3224 wxObject
*userData
= NULL
,
3225 ObjClass
*eventSink
= NULL
)
3227 return Disconnect(eventSrc
, wxID_ANY
, eventType
, func
,
3228 userData
, eventSink
);
3230 #endif // !wxEVENTS_COMPATIBILITY_2_8
3233 wxList
* GetDynamicEventTable() const { return m_dynamicEvents
; }
3235 // User data can be associated with each wxEvtHandler
3236 void SetClientObject( wxClientData
*data
) { DoSetClientObject(data
); }
3237 wxClientData
*GetClientObject() const { return DoGetClientObject(); }
3239 void SetClientData( void *data
) { DoSetClientData(data
); }
3240 void *GetClientData() const { return DoGetClientData(); }
3243 // implementation from now on
3244 // --------------------------
3246 // check if the given event table entry matches this event by id (the check
3247 // for the event type should be done by caller) and call the handler if it
3250 // return true if the event was processed, false otherwise (no match or the
3251 // handler decided to skip the event)
3252 static bool ProcessEventIfMatchesId(const wxEventTableEntryBase
& tableEntry
,
3253 wxEvtHandler
*handler
,
3256 virtual bool SearchEventTable(wxEventTable
& table
, wxEvent
& event
);
3257 bool SearchDynamicEventTable( wxEvent
& event
);
3259 // Avoid problems at exit by cleaning up static hash table gracefully
3260 void ClearEventHashTable() { GetEventHashTable().Clear(); }
3261 void OnSinkDestroyed( wxEvtHandler
*sink
);
3264 // The method tries to process the event in this event handler.
3266 // It is meant to be called from ProcessEvent() only and is not virtual,
3267 // additional event handlers can be hooked into the normal event processing
3268 // logic using TryValidator() hook.
3269 bool ProcessEventHere(wxEvent
& event
);
3273 void DoConnect(int winid
,
3275 wxEventType eventType
,
3276 wxEventFunctor
*func
,
3277 wxObject
* userData
= NULL
);
3279 bool DoDisconnect(int winid
,
3281 wxEventType eventType
,
3282 const wxEventFunctor
& func
,
3283 wxObject
*userData
= NULL
);
3285 static const wxEventTableEntry sm_eventTableEntries
[];
3288 // hooks for wxWindow used by ProcessEvent()
3289 // -----------------------------------------
3291 // This one is called before trying our own event table to allow plugging
3292 // in the validators.
3294 // NB: This method is intentionally *not* inside wxUSE_VALIDATORS!
3295 // It is part of wxBase which doesn't use validators and the code
3296 // is compiled out when building wxBase w/o GUI classes, which affects
3297 // binary compatibility and wxBase library can't be used by GUI
3299 virtual bool TryValidator(wxEvent
& WXUNUSED(event
)) { return false; }
3301 // this one is called after failing to find the event handle in our own
3302 // table to give a chance to the other windows to process it
3304 // base class implementation passes the event to wxTheApp
3305 virtual bool TryParent(wxEvent
& event
);
3308 static const wxEventTable sm_eventTable
;
3309 virtual const wxEventTable
*GetEventTable() const;
3311 static wxEventHashTable sm_eventHashTable
;
3312 virtual wxEventHashTable
& GetEventHashTable() const;
3314 wxEvtHandler
* m_nextHandler
;
3315 wxEvtHandler
* m_previousHandler
;
3316 wxList
* m_dynamicEvents
;
3317 wxList
* m_pendingEvents
;
3320 // critical section protecting m_pendingEvents
3321 wxCriticalSection m_pendingEventsLock
;
3322 #endif // wxUSE_THREADS
3324 // Is event handler enabled?
3328 // The user data: either an object which will be deleted by the container
3329 // when it's deleted or some raw pointer which we do nothing with - only
3330 // one type of data can be used with the given window (i.e. you cannot set
3331 // the void data and then associate the container with wxClientData or vice
3335 wxClientData
*m_clientObject
;
3339 // what kind of data do we have?
3340 wxClientDataType m_clientDataType
;
3342 // client data accessors
3343 virtual void DoSetClientObject( wxClientData
*data
);
3344 virtual wxClientData
*DoGetClientObject() const;
3346 virtual void DoSetClientData( void *data
);
3347 virtual void *DoGetClientData() const;
3349 // Search tracker objects for event connection with this sink
3350 wxEventConnectionRef
*FindRefInTrackerList(wxEvtHandler
*eventSink
);
3353 DECLARE_DYNAMIC_CLASS_NO_COPY(wxEvtHandler
)
3356 WX_DEFINE_EXPORTED_ARRAY_PTR(wxEvtHandler
*, wxEvtHandlerArray
);
3358 // ----------------------------------------------------------------------------
3359 // wxEventConnectionRef represents all connections between two event handlers
3360 // and enables automatic disconnect when an event handler sink goes out of
3361 // scope. Each connection/disconnect increases/decreases ref count, and
3362 // when it reaches zero the node goes out of scope.
3363 // ----------------------------------------------------------------------------
3365 class wxEventConnectionRef
: public wxTrackerNode
3368 wxEventConnectionRef() : m_src(NULL
), m_sink(NULL
), m_refCount(0) { }
3369 wxEventConnectionRef(wxEvtHandler
*src
, wxEvtHandler
*sink
)
3370 : m_src(src
), m_sink(sink
), m_refCount(1)
3372 m_sink
->AddNode(this);
3375 // The sink is being destroyed
3376 virtual void OnObjectDestroy( )
3379 m_src
->OnSinkDestroyed( m_sink
);
3383 virtual wxEventConnectionRef
*ToEventConnection() { return this; }
3385 void IncRef() { m_refCount
++; }
3388 if ( !--m_refCount
)
3390 // The sink holds the only external pointer to this object
3392 m_sink
->RemoveNode(this);
3398 wxEvtHandler
*m_src
,
3402 friend class wxEvtHandler
;
3404 wxDECLARE_NO_ASSIGN_CLASS(wxEventConnectionRef
);
3407 inline void wxObjectEventFunctor::operator()(wxEvtHandler
*handler
, wxEvent
& event
)
3409 wxEvtHandler
* const realHandler
= m_handler
? m_handler
: handler
;
3411 (realHandler
->*m_method
)(event
);
3414 // Post a message to the given event handler which will be processed during the
3415 // next event loop iteration.
3417 // Notice that this one is not thread-safe, use wxQueueEvent()
3418 inline void wxPostEvent(wxEvtHandler
*dest
, const wxEvent
& event
)
3420 wxCHECK_RET( dest
, "need an object to post event to" );
3422 dest
->AddPendingEvent(event
);
3425 // Wrapper around wxEvtHandler::QueueEvent(): adds an event for later
3426 // processing, unlike wxPostEvent it is safe to use from different thread even
3427 // for events with wxString members
3428 inline void wxQueueEvent(wxEvtHandler
*dest
, wxEvent
*event
)
3430 wxCHECK_RET( dest
, "need an object to queue event for" );
3432 dest
->QueueEvent(event
);
3435 typedef void (wxEvtHandler::*wxEventFunction
)(wxEvent
&);
3436 typedef void (wxEvtHandler::*wxIdleEventFunction
)(wxIdleEvent
&);
3438 #define wxEventHandler(func) \
3439 wxEVENT_HANDLER_CAST(wxEventFunction, func)
3440 #define wxIdleEventHandler(func) \
3441 wxEVENT_HANDLER_CAST(wxIdleEventFunction, func)
3445 // ----------------------------------------------------------------------------
3446 // wxEventBlocker: helper class to temporarily disable event handling for a window
3447 // ----------------------------------------------------------------------------
3449 class WXDLLIMPEXP_CORE wxEventBlocker
: public wxEvtHandler
3452 wxEventBlocker(wxWindow
*win
, wxEventType type
= wxEVT_ANY
);
3453 virtual ~wxEventBlocker();
3455 void Block(wxEventType type
)
3457 m_eventsToBlock
.push_back(type
);
3460 virtual bool ProcessEvent(wxEvent
& event
);
3463 wxArrayInt m_eventsToBlock
;
3466 wxDECLARE_NO_COPY_CLASS(wxEventBlocker
);
3469 typedef void (wxEvtHandler::*wxCommandEventFunction
)(wxCommandEvent
&);
3470 typedef void (wxEvtHandler::*wxThreadEventFunction
)(wxThreadEvent
&);
3471 typedef void (wxEvtHandler::*wxScrollEventFunction
)(wxScrollEvent
&);
3472 typedef void (wxEvtHandler::*wxScrollWinEventFunction
)(wxScrollWinEvent
&);
3473 typedef void (wxEvtHandler::*wxSizeEventFunction
)(wxSizeEvent
&);
3474 typedef void (wxEvtHandler::*wxMoveEventFunction
)(wxMoveEvent
&);
3475 typedef void (wxEvtHandler::*wxPaintEventFunction
)(wxPaintEvent
&);
3476 typedef void (wxEvtHandler::*wxNcPaintEventFunction
)(wxNcPaintEvent
&);
3477 typedef void (wxEvtHandler::*wxEraseEventFunction
)(wxEraseEvent
&);
3478 typedef void (wxEvtHandler::*wxMouseEventFunction
)(wxMouseEvent
&);
3479 typedef void (wxEvtHandler::*wxCharEventFunction
)(wxKeyEvent
&);
3480 typedef void (wxEvtHandler::*wxFocusEventFunction
)(wxFocusEvent
&);
3481 typedef void (wxEvtHandler::*wxChildFocusEventFunction
)(wxChildFocusEvent
&);
3482 typedef void (wxEvtHandler::*wxActivateEventFunction
)(wxActivateEvent
&);
3483 typedef void (wxEvtHandler::*wxMenuEventFunction
)(wxMenuEvent
&);
3484 typedef void (wxEvtHandler::*wxJoystickEventFunction
)(wxJoystickEvent
&);
3485 typedef void (wxEvtHandler::*wxDropFilesEventFunction
)(wxDropFilesEvent
&);
3486 typedef void (wxEvtHandler::*wxInitDialogEventFunction
)(wxInitDialogEvent
&);
3487 typedef void (wxEvtHandler::*wxSysColourChangedEventFunction
)(wxSysColourChangedEvent
&);
3488 typedef void (wxEvtHandler::*wxDisplayChangedEventFunction
)(wxDisplayChangedEvent
&);
3489 typedef void (wxEvtHandler::*wxUpdateUIEventFunction
)(wxUpdateUIEvent
&);
3490 typedef void (wxEvtHandler::*wxCloseEventFunction
)(wxCloseEvent
&);
3491 typedef void (wxEvtHandler::*wxShowEventFunction
)(wxShowEvent
&);
3492 typedef void (wxEvtHandler::*wxIconizeEventFunction
)(wxIconizeEvent
&);
3493 typedef void (wxEvtHandler::*wxMaximizeEventFunction
)(wxMaximizeEvent
&);
3494 typedef void (wxEvtHandler::*wxNavigationKeyEventFunction
)(wxNavigationKeyEvent
&);
3495 typedef void (wxEvtHandler::*wxPaletteChangedEventFunction
)(wxPaletteChangedEvent
&);
3496 typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction
)(wxQueryNewPaletteEvent
&);
3497 typedef void (wxEvtHandler::*wxWindowCreateEventFunction
)(wxWindowCreateEvent
&);
3498 typedef void (wxEvtHandler::*wxWindowDestroyEventFunction
)(wxWindowDestroyEvent
&);
3499 typedef void (wxEvtHandler::*wxSetCursorEventFunction
)(wxSetCursorEvent
&);
3500 typedef void (wxEvtHandler::*wxNotifyEventFunction
)(wxNotifyEvent
&);
3501 typedef void (wxEvtHandler::*wxHelpEventFunction
)(wxHelpEvent
&);
3502 typedef void (wxEvtHandler::*wxContextMenuEventFunction
)(wxContextMenuEvent
&);
3503 typedef void (wxEvtHandler::*wxMouseCaptureChangedEventFunction
)(wxMouseCaptureChangedEvent
&);
3504 typedef void (wxEvtHandler::*wxMouseCaptureLostEventFunction
)(wxMouseCaptureLostEvent
&);
3505 typedef void (wxEvtHandler::*wxClipboardTextEventFunction
)(wxClipboardTextEvent
&);
3508 #define wxCommandEventHandler(func) \
3509 wxEVENT_HANDLER_CAST(wxCommandEventFunction, func)
3510 #define wxThreadEventHandler(func) \
3511 wxEVENT_HANDLER_CAST(wxThreadEventFunction, func)
3512 #define wxScrollEventHandler(func) \
3513 wxEVENT_HANDLER_CAST(wxScrollEventFunction, func)
3514 #define wxScrollWinEventHandler(func) \
3515 wxEVENT_HANDLER_CAST(wxScrollWinEventFunction, func)
3516 #define wxSizeEventHandler(func) \
3517 wxEVENT_HANDLER_CAST(wxSizeEventFunction, func)
3518 #define wxMoveEventHandler(func) \
3519 wxEVENT_HANDLER_CAST(wxMoveEventFunction, func)
3520 #define wxPaintEventHandler(func) \
3521 wxEVENT_HANDLER_CAST(wxPaintEventFunction, func)
3522 #define wxNcPaintEventHandler(func) \
3523 wxEVENT_HANDLER_CAST(wxNcPaintEventFunction, func)
3524 #define wxEraseEventHandler(func) \
3525 wxEVENT_HANDLER_CAST(wxEraseEventFunction, func)
3526 #define wxMouseEventHandler(func) \
3527 wxEVENT_HANDLER_CAST(wxMouseEventFunction, func)
3528 #define wxCharEventHandler(func) \
3529 wxEVENT_HANDLER_CAST(wxCharEventFunction, func)
3530 #define wxKeyEventHandler(func) wxCharEventHandler(func)
3531 #define wxFocusEventHandler(func) \
3532 wxEVENT_HANDLER_CAST(wxFocusEventFunction, func)
3533 #define wxChildFocusEventHandler(func) \
3534 wxEVENT_HANDLER_CAST(wxChildFocusEventFunction, func)
3535 #define wxActivateEventHandler(func) \
3536 wxEVENT_HANDLER_CAST(wxActivateEventFunction, func)
3537 #define wxMenuEventHandler(func) \
3538 wxEVENT_HANDLER_CAST(wxMenuEventFunction, func)
3539 #define wxJoystickEventHandler(func) \
3540 wxEVENT_HANDLER_CAST(wxJoystickEventFunction, func)
3541 #define wxDropFilesEventHandler(func) \
3542 wxEVENT_HANDLER_CAST(wxDropFilesEventFunction, func)
3543 #define wxInitDialogEventHandler(func) \
3544 wxEVENT_HANDLER_CAST(wxInitDialogEventFunction, func)
3545 #define wxSysColourChangedEventHandler(func) \
3546 wxEVENT_HANDLER_CAST(wxSysColourChangedEventFunction, func)
3547 #define wxDisplayChangedEventHandler(func) \
3548 wxEVENT_HANDLER_CAST(wxDisplayChangedEventFunction, func)
3549 #define wxUpdateUIEventHandler(func) \
3550 wxEVENT_HANDLER_CAST(wxUpdateUIEventFunction, func)
3551 #define wxCloseEventHandler(func) \
3552 wxEVENT_HANDLER_CAST(wxCloseEventFunction, func)
3553 #define wxShowEventHandler(func) \
3554 wxEVENT_HANDLER_CAST(wxShowEventFunction, func)
3555 #define wxIconizeEventHandler(func) \
3556 wxEVENT_HANDLER_CAST(wxIconizeEventFunction, func)
3557 #define wxMaximizeEventHandler(func) \
3558 wxEVENT_HANDLER_CAST(wxMaximizeEventFunction, func)
3559 #define wxNavigationKeyEventHandler(func) \
3560 wxEVENT_HANDLER_CAST(wxNavigationKeyEventFunction, func)
3561 #define wxPaletteChangedEventHandler(func) \
3562 wxEVENT_HANDLER_CAST(wxPaletteChangedEventFunction, func)
3563 #define wxQueryNewPaletteEventHandler(func) \
3564 wxEVENT_HANDLER_CAST(wxQueryNewPaletteEventFunction, func)
3565 #define wxWindowCreateEventHandler(func) \
3566 wxEVENT_HANDLER_CAST(wxWindowCreateEventFunction, func)
3567 #define wxWindowDestroyEventHandler(func) \
3568 wxEVENT_HANDLER_CAST(wxWindowDestroyEventFunction, func)
3569 #define wxSetCursorEventHandler(func) \
3570 wxEVENT_HANDLER_CAST(wxSetCursorEventFunction, func)
3571 #define wxNotifyEventHandler(func) \
3572 wxEVENT_HANDLER_CAST(wxNotifyEventFunction, func)
3573 #define wxHelpEventHandler(func) \
3574 wxEVENT_HANDLER_CAST(wxHelpEventFunction, func)
3575 #define wxContextMenuEventHandler(func) \
3576 wxEVENT_HANDLER_CAST(wxContextMenuEventFunction, func)
3577 #define wxMouseCaptureChangedEventHandler(func) \
3578 wxEVENT_HANDLER_CAST(wxMouseCaptureChangedEventFunction, func)
3579 #define wxMouseCaptureLostEventHandler(func) \
3580 wxEVENT_HANDLER_CAST(wxMouseCaptureLostEventFunction, func)
3581 #define wxClipboardTextEventHandler(func) \
3582 wxEVENT_HANDLER_CAST(wxClipboardTextEventFunction, func)
3586 // N.B. In GNU-WIN32, you *have* to take the address of a member function
3587 // (use &) or the compiler crashes...
3589 #define DECLARE_EVENT_TABLE() \
3591 static const wxEventTableEntry sm_eventTableEntries[]; \
3593 static const wxEventTable sm_eventTable; \
3594 virtual const wxEventTable* GetEventTable() const; \
3595 static wxEventHashTable sm_eventHashTable; \
3596 virtual wxEventHashTable& GetEventHashTable() const;
3598 // N.B.: when building DLL with Borland C++ 5.5 compiler, you must initialize
3599 // sm_eventTable before using it in GetEventTable() or the compiler gives
3600 // E2233 (see http://groups.google.com/groups?selm=397dcc8a%241_2%40dnews)
3602 #define BEGIN_EVENT_TABLE(theClass, baseClass) \
3603 const wxEventTable theClass::sm_eventTable = \
3604 { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] }; \
3605 const wxEventTable *theClass::GetEventTable() const \
3606 { return &theClass::sm_eventTable; } \
3607 wxEventHashTable theClass::sm_eventHashTable(theClass::sm_eventTable); \
3608 wxEventHashTable &theClass::GetEventHashTable() const \
3609 { return theClass::sm_eventHashTable; } \
3610 const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
3612 #define BEGIN_EVENT_TABLE_TEMPLATE1(theClass, baseClass, T1) \
3613 template<typename T1> \
3614 const wxEventTable theClass<T1>::sm_eventTable = \
3615 { &baseClass::sm_eventTable, &theClass<T1>::sm_eventTableEntries[0] }; \
3616 template<typename T1> \
3617 const wxEventTable *theClass<T1>::GetEventTable() const \
3618 { return &theClass<T1>::sm_eventTable; } \
3619 template<typename T1> \
3620 wxEventHashTable theClass<T1>::sm_eventHashTable(theClass<T1>::sm_eventTable); \
3621 template<typename T1> \
3622 wxEventHashTable &theClass<T1>::GetEventHashTable() const \
3623 { return theClass<T1>::sm_eventHashTable; } \
3624 template<typename T1> \
3625 const wxEventTableEntry theClass<T1>::sm_eventTableEntries[] = { \
3627 #define BEGIN_EVENT_TABLE_TEMPLATE2(theClass, baseClass, T1, T2) \
3628 template<typename T1, typename T2> \
3629 const wxEventTable theClass<T1, T2>::sm_eventTable = \
3630 { &baseClass::sm_eventTable, &theClass<T1, T2>::sm_eventTableEntries[0] }; \
3631 template<typename T1, typename T2> \
3632 const wxEventTable *theClass<T1, T2>::GetEventTable() const \
3633 { return &theClass<T1, T2>::sm_eventTable; } \
3634 template<typename T1, typename T2> \
3635 wxEventHashTable theClass<T1, T2>::sm_eventHashTable(theClass<T1, T2>::sm_eventTable); \
3636 template<typename T1, typename T2> \
3637 wxEventHashTable &theClass<T1, T2>::GetEventHashTable() const \
3638 { return theClass<T1, T2>::sm_eventHashTable; } \
3639 template<typename T1, typename T2> \
3640 const wxEventTableEntry theClass<T1, T2>::sm_eventTableEntries[] = { \
3642 #define BEGIN_EVENT_TABLE_TEMPLATE3(theClass, baseClass, T1, T2, T3) \
3643 template<typename T1, typename T2, typename T3> \
3644 const wxEventTable theClass<T1, T2, T3>::sm_eventTable = \
3645 { &baseClass::sm_eventTable, &theClass<T1, T2, T3>::sm_eventTableEntries[0] }; \
3646 template<typename T1, typename T2, typename T3> \
3647 const wxEventTable *theClass<T1, T2, T3>::GetEventTable() const \
3648 { return &theClass<T1, T2, T3>::sm_eventTable; } \
3649 template<typename T1, typename T2, typename T3> \
3650 wxEventHashTable theClass<T1, T2, T3>::sm_eventHashTable(theClass<T1, T2, T3>::sm_eventTable); \
3651 template<typename T1, typename T2, typename T3> \
3652 wxEventHashTable &theClass<T1, T2, T3>::GetEventHashTable() const \
3653 { return theClass<T1, T2, T3>::sm_eventHashTable; } \
3654 template<typename T1, typename T2, typename T3> \
3655 const wxEventTableEntry theClass<T1, T2, T3>::sm_eventTableEntries[] = { \
3657 #define BEGIN_EVENT_TABLE_TEMPLATE4(theClass, baseClass, T1, T2, T3, T4) \
3658 template<typename T1, typename T2, typename T3, typename T4> \
3659 const wxEventTable theClass<T1, T2, T3, T4>::sm_eventTable = \
3660 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4>::sm_eventTableEntries[0] }; \
3661 template<typename T1, typename T2, typename T3, typename T4> \
3662 const wxEventTable *theClass<T1, T2, T3, T4>::GetEventTable() const \
3663 { return &theClass<T1, T2, T3, T4>::sm_eventTable; } \
3664 template<typename T1, typename T2, typename T3, typename T4> \
3665 wxEventHashTable theClass<T1, T2, T3, T4>::sm_eventHashTable(theClass<T1, T2, T3, T4>::sm_eventTable); \
3666 template<typename T1, typename T2, typename T3, typename T4> \
3667 wxEventHashTable &theClass<T1, T2, T3, T4>::GetEventHashTable() const \
3668 { return theClass<T1, T2, T3, T4>::sm_eventHashTable; } \
3669 template<typename T1, typename T2, typename T3, typename T4> \
3670 const wxEventTableEntry theClass<T1, T2, T3, T4>::sm_eventTableEntries[] = { \
3672 #define BEGIN_EVENT_TABLE_TEMPLATE5(theClass, baseClass, T1, T2, T3, T4, T5) \
3673 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3674 const wxEventTable theClass<T1, T2, T3, T4, T5>::sm_eventTable = \
3675 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[0] }; \
3676 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3677 const wxEventTable *theClass<T1, T2, T3, T4, T5>::GetEventTable() const \
3678 { return &theClass<T1, T2, T3, T4, T5>::sm_eventTable; } \
3679 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3680 wxEventHashTable theClass<T1, T2, T3, T4, T5>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5>::sm_eventTable); \
3681 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3682 wxEventHashTable &theClass<T1, T2, T3, T4, T5>::GetEventHashTable() const \
3683 { return theClass<T1, T2, T3, T4, T5>::sm_eventHashTable; } \
3684 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3685 const wxEventTableEntry theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[] = { \
3687 #define BEGIN_EVENT_TABLE_TEMPLATE7(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7) \
3688 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3689 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable = \
3690 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[0] }; \
3691 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3692 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventTable() const \
3693 { return &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable; } \
3694 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3695 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable); \
3696 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3697 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventHashTable() const \
3698 { return theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable; } \
3699 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3700 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[] = { \
3702 #define BEGIN_EVENT_TABLE_TEMPLATE8(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7, T8) \
3703 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3704 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable = \
3705 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[0] }; \
3706 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3707 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventTable() const \
3708 { return &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable; } \
3709 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3710 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable); \
3711 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3712 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventHashTable() const \
3713 { return theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable; } \
3714 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3715 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[] = { \
3717 #define END_EVENT_TABLE() DECLARE_EVENT_TABLE_TERMINATOR() };
3720 * Event table macros
3723 // helpers for writing shorter code below: declare an event macro taking 2, 1
3724 // or none ids (the missing ids default to wxID_ANY)
3727 // - evt one of wxEVT_XXX constants
3728 // - id1, id2 ids of the first/last id
3729 // - fn the function (should be cast to the right type)
3730 #define wx__DECLARE_EVT2(evt, id1, id2, fn) \
3731 DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
3732 #define wx__DECLARE_EVT1(evt, id, fn) \
3733 wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
3734 #define wx__DECLARE_EVT0(evt, fn) \
3735 wx__DECLARE_EVT1(evt, wxID_ANY, fn)
3739 #define EVT_CUSTOM(event, winid, func) \
3740 wx__DECLARE_EVT1(event, winid, wxEventHandler(func))
3741 #define EVT_CUSTOM_RANGE(event, id1, id2, func) \
3742 wx__DECLARE_EVT2(event, id1, id2, wxEventHandler(func))
3745 #define EVT_COMMAND(winid, event, func) \
3746 wx__DECLARE_EVT1(event, winid, wxCommandEventHandler(func))
3748 #define EVT_COMMAND_RANGE(id1, id2, event, func) \
3749 wx__DECLARE_EVT2(event, id1, id2, wxCommandEventHandler(func))
3751 #define EVT_NOTIFY(event, winid, func) \
3752 wx__DECLARE_EVT1(event, winid, wxNotifyEventHandler(func))
3754 #define EVT_NOTIFY_RANGE(event, id1, id2, func) \
3755 wx__DECLARE_EVT2(event, id1, id2, wxNotifyEventHandler(func))
3758 #define EVT_SIZE(func) wx__DECLARE_EVT0(wxEVT_SIZE, wxSizeEventHandler(func))
3759 #define EVT_SIZING(func) wx__DECLARE_EVT0(wxEVT_SIZING, wxSizeEventHandler(func))
3760 #define EVT_MOVE(func) wx__DECLARE_EVT0(wxEVT_MOVE, wxMoveEventHandler(func))
3761 #define EVT_MOVING(func) wx__DECLARE_EVT0(wxEVT_MOVING, wxMoveEventHandler(func))
3762 #define EVT_MOVE_START(func) wx__DECLARE_EVT0(wxEVT_MOVE_START, wxMoveEventHandler(func))
3763 #define EVT_MOVE_END(func) wx__DECLARE_EVT0(wxEVT_MOVE_END, wxMoveEventHandler(func))
3764 #define EVT_CLOSE(func) wx__DECLARE_EVT0(wxEVT_CLOSE_WINDOW, wxCloseEventHandler(func))
3765 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3766 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3767 #define EVT_PAINT(func) wx__DECLARE_EVT0(wxEVT_PAINT, wxPaintEventHandler(func))
3768 #define EVT_NC_PAINT(func) wx__DECLARE_EVT0(wxEVT_NC_PAINT, wxNcPaintEventHandler(func))
3769 #define EVT_ERASE_BACKGROUND(func) wx__DECLARE_EVT0(wxEVT_ERASE_BACKGROUND, wxEraseEventHandler(func))
3770 #define EVT_CHAR(func) wx__DECLARE_EVT0(wxEVT_CHAR, wxCharEventHandler(func))
3771 #define EVT_KEY_DOWN(func) wx__DECLARE_EVT0(wxEVT_KEY_DOWN, wxKeyEventHandler(func))
3772 #define EVT_KEY_UP(func) wx__DECLARE_EVT0(wxEVT_KEY_UP, wxKeyEventHandler(func))
3774 #define EVT_HOTKEY(winid, func) wx__DECLARE_EVT1(wxEVT_HOTKEY, winid, wxCharEventHandler(func))
3776 #define EVT_CHAR_HOOK(func) wx__DECLARE_EVT0(wxEVT_CHAR_HOOK, wxCharEventHandler(func))
3777 #define EVT_MENU_OPEN(func) wx__DECLARE_EVT0(wxEVT_MENU_OPEN, wxMenuEventHandler(func))
3778 #define EVT_MENU_CLOSE(func) wx__DECLARE_EVT0(wxEVT_MENU_CLOSE, wxMenuEventHandler(func))
3779 #define EVT_MENU_HIGHLIGHT(winid, func) wx__DECLARE_EVT1(wxEVT_MENU_HIGHLIGHT, winid, wxMenuEventHandler(func))
3780 #define EVT_MENU_HIGHLIGHT_ALL(func) wx__DECLARE_EVT0(wxEVT_MENU_HIGHLIGHT, wxMenuEventHandler(func))
3781 #define EVT_SET_FOCUS(func) wx__DECLARE_EVT0(wxEVT_SET_FOCUS, wxFocusEventHandler(func))
3782 #define EVT_KILL_FOCUS(func) wx__DECLARE_EVT0(wxEVT_KILL_FOCUS, wxFocusEventHandler(func))
3783 #define EVT_CHILD_FOCUS(func) wx__DECLARE_EVT0(wxEVT_CHILD_FOCUS, wxChildFocusEventHandler(func))
3784 #define EVT_ACTIVATE(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE, wxActivateEventHandler(func))
3785 #define EVT_ACTIVATE_APP(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE_APP, wxActivateEventHandler(func))
3786 #define EVT_HIBERNATE(func) wx__DECLARE_EVT0(wxEVT_HIBERNATE, wxActivateEventHandler(func))
3787 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3788 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3789 #define EVT_DROP_FILES(func) wx__DECLARE_EVT0(wxEVT_DROP_FILES, wxDropFilesEventHandler(func))
3790 #define EVT_INIT_DIALOG(func) wx__DECLARE_EVT0(wxEVT_INIT_DIALOG, wxInitDialogEventHandler(func))
3791 #define EVT_SYS_COLOUR_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEventHandler(func))
3792 #define EVT_DISPLAY_CHANGED(func) wx__DECLARE_EVT0(wxEVT_DISPLAY_CHANGED, wxDisplayChangedEventHandler(func))
3793 #define EVT_SHOW(func) wx__DECLARE_EVT0(wxEVT_SHOW, wxShowEventHandler(func))
3794 #define EVT_MAXIMIZE(func) wx__DECLARE_EVT0(wxEVT_MAXIMIZE, wxMaximizeEventHandler(func))
3795 #define EVT_ICONIZE(func) wx__DECLARE_EVT0(wxEVT_ICONIZE, wxIconizeEventHandler(func))
3796 #define EVT_NAVIGATION_KEY(func) wx__DECLARE_EVT0(wxEVT_NAVIGATION_KEY, wxNavigationKeyEventHandler(func))
3797 #define EVT_PALETTE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_PALETTE_CHANGED, wxPaletteChangedEventHandler(func))
3798 #define EVT_QUERY_NEW_PALETTE(func) wx__DECLARE_EVT0(wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEventHandler(func))
3799 #define EVT_WINDOW_CREATE(func) wx__DECLARE_EVT0(wxEVT_CREATE, wxWindowCreateEventHandler(func))
3800 #define EVT_WINDOW_DESTROY(func) wx__DECLARE_EVT0(wxEVT_DESTROY, wxWindowDestroyEventHandler(func))
3801 #define EVT_SET_CURSOR(func) wx__DECLARE_EVT0(wxEVT_SET_CURSOR, wxSetCursorEventHandler(func))
3802 #define EVT_MOUSE_CAPTURE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEventHandler(func))
3803 #define EVT_MOUSE_CAPTURE_LOST(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEventHandler(func))
3806 #define EVT_LEFT_DOWN(func) wx__DECLARE_EVT0(wxEVT_LEFT_DOWN, wxMouseEventHandler(func))
3807 #define EVT_LEFT_UP(func) wx__DECLARE_EVT0(wxEVT_LEFT_UP, wxMouseEventHandler(func))
3808 #define EVT_MIDDLE_DOWN(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DOWN, wxMouseEventHandler(func))
3809 #define EVT_MIDDLE_UP(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_UP, wxMouseEventHandler(func))
3810 #define EVT_RIGHT_DOWN(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DOWN, wxMouseEventHandler(func))
3811 #define EVT_RIGHT_UP(func) wx__DECLARE_EVT0(wxEVT_RIGHT_UP, wxMouseEventHandler(func))
3812 #define EVT_MOTION(func) wx__DECLARE_EVT0(wxEVT_MOTION, wxMouseEventHandler(func))
3813 #define EVT_LEFT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_LEFT_DCLICK, wxMouseEventHandler(func))
3814 #define EVT_MIDDLE_DCLICK(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DCLICK, wxMouseEventHandler(func))
3815 #define EVT_RIGHT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DCLICK, wxMouseEventHandler(func))
3816 #define EVT_LEAVE_WINDOW(func) wx__DECLARE_EVT0(wxEVT_LEAVE_WINDOW, wxMouseEventHandler(func))
3817 #define EVT_ENTER_WINDOW(func) wx__DECLARE_EVT0(wxEVT_ENTER_WINDOW, wxMouseEventHandler(func))
3818 #define EVT_MOUSEWHEEL(func) wx__DECLARE_EVT0(wxEVT_MOUSEWHEEL, wxMouseEventHandler(func))
3819 #define EVT_MOUSE_AUX1_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX1_DOWN, wxMouseEventHandler(func))
3820 #define EVT_MOUSE_AUX1_UP(func) wx__DECLARE_EVT0(wxEVT_AUX1_UP, wxMouseEventHandler(func))
3821 #define EVT_MOUSE_AUX1_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX1_DCLICK, wxMouseEventHandler(func))
3822 #define EVT_MOUSE_AUX2_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX2_DOWN, wxMouseEventHandler(func))
3823 #define EVT_MOUSE_AUX2_UP(func) wx__DECLARE_EVT0(wxEVT_AUX2_UP, wxMouseEventHandler(func))
3824 #define EVT_MOUSE_AUX2_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX2_DCLICK, wxMouseEventHandler(func))
3827 #define EVT_MOUSE_EVENTS(func) \
3828 EVT_LEFT_DOWN(func) \
3830 EVT_LEFT_DCLICK(func) \
3831 EVT_MIDDLE_DOWN(func) \
3832 EVT_MIDDLE_UP(func) \
3833 EVT_MIDDLE_DCLICK(func) \
3834 EVT_RIGHT_DOWN(func) \
3835 EVT_RIGHT_UP(func) \
3836 EVT_RIGHT_DCLICK(func) \
3837 EVT_MOUSE_AUX1_DOWN(func) \
3838 EVT_MOUSE_AUX1_UP(func) \
3839 EVT_MOUSE_AUX1_DCLICK(func) \
3840 EVT_MOUSE_AUX2_DOWN(func) \
3841 EVT_MOUSE_AUX2_UP(func) \
3842 EVT_MOUSE_AUX2_DCLICK(func) \
3844 EVT_LEAVE_WINDOW(func) \
3845 EVT_ENTER_WINDOW(func) \
3846 EVT_MOUSEWHEEL(func)
3848 // Scrolling from wxWindow (sent to wxScrolledWindow)
3849 #define EVT_SCROLLWIN_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_TOP, wxScrollWinEventHandler(func))
3850 #define EVT_SCROLLWIN_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEventHandler(func))
3851 #define EVT_SCROLLWIN_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEUP, wxScrollWinEventHandler(func))
3852 #define EVT_SCROLLWIN_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEventHandler(func))
3853 #define EVT_SCROLLWIN_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEventHandler(func))
3854 #define EVT_SCROLLWIN_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEventHandler(func))
3855 #define EVT_SCROLLWIN_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEventHandler(func))
3856 #define EVT_SCROLLWIN_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEventHandler(func))
3858 #define EVT_SCROLLWIN(func) \
3859 EVT_SCROLLWIN_TOP(func) \
3860 EVT_SCROLLWIN_BOTTOM(func) \
3861 EVT_SCROLLWIN_LINEUP(func) \
3862 EVT_SCROLLWIN_LINEDOWN(func) \
3863 EVT_SCROLLWIN_PAGEUP(func) \
3864 EVT_SCROLLWIN_PAGEDOWN(func) \
3865 EVT_SCROLLWIN_THUMBTRACK(func) \
3866 EVT_SCROLLWIN_THUMBRELEASE(func)
3868 // Scrolling from wxSlider and wxScrollBar
3869 #define EVT_SCROLL_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_TOP, wxScrollEventHandler(func))
3870 #define EVT_SCROLL_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLL_BOTTOM, wxScrollEventHandler(func))
3871 #define EVT_SCROLL_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEUP, wxScrollEventHandler(func))
3872 #define EVT_SCROLL_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEDOWN, wxScrollEventHandler(func))
3873 #define EVT_SCROLL_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEUP, wxScrollEventHandler(func))
3874 #define EVT_SCROLL_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler(func))
3875 #define EVT_SCROLL_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler(func))
3876 #define EVT_SCROLL_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBRELEASE, wxScrollEventHandler(func))
3877 #define EVT_SCROLL_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SCROLL_CHANGED, wxScrollEventHandler(func))
3879 #define EVT_SCROLL(func) \
3880 EVT_SCROLL_TOP(func) \
3881 EVT_SCROLL_BOTTOM(func) \
3882 EVT_SCROLL_LINEUP(func) \
3883 EVT_SCROLL_LINEDOWN(func) \
3884 EVT_SCROLL_PAGEUP(func) \
3885 EVT_SCROLL_PAGEDOWN(func) \
3886 EVT_SCROLL_THUMBTRACK(func) \
3887 EVT_SCROLL_THUMBRELEASE(func) \
3888 EVT_SCROLL_CHANGED(func)
3890 // Scrolling from wxSlider and wxScrollBar, with an id
3891 #define EVT_COMMAND_SCROLL_TOP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_TOP, winid, wxScrollEventHandler(func))
3892 #define EVT_COMMAND_SCROLL_BOTTOM(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_BOTTOM, winid, wxScrollEventHandler(func))
3893 #define EVT_COMMAND_SCROLL_LINEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEUP, winid, wxScrollEventHandler(func))
3894 #define EVT_COMMAND_SCROLL_LINEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEDOWN, winid, wxScrollEventHandler(func))
3895 #define EVT_COMMAND_SCROLL_PAGEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEUP, winid, wxScrollEventHandler(func))
3896 #define EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEDOWN, winid, wxScrollEventHandler(func))
3897 #define EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBTRACK, winid, wxScrollEventHandler(func))
3898 #define EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBRELEASE, winid, wxScrollEventHandler(func))
3899 #define EVT_COMMAND_SCROLL_CHANGED(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_CHANGED, winid, wxScrollEventHandler(func))
3901 #define EVT_COMMAND_SCROLL(winid, func) \
3902 EVT_COMMAND_SCROLL_TOP(winid, func) \
3903 EVT_COMMAND_SCROLL_BOTTOM(winid, func) \
3904 EVT_COMMAND_SCROLL_LINEUP(winid, func) \
3905 EVT_COMMAND_SCROLL_LINEDOWN(winid, func) \
3906 EVT_COMMAND_SCROLL_PAGEUP(winid, func) \
3907 EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) \
3908 EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) \
3909 EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) \
3910 EVT_COMMAND_SCROLL_CHANGED(winid, func)
3912 #if WXWIN_COMPATIBILITY_2_6
3913 // compatibility macros for the old name, deprecated in 2.8
3914 #define wxEVT_SCROLL_ENDSCROLL wxEVT_SCROLL_CHANGED
3915 #define EVT_COMMAND_SCROLL_ENDSCROLL EVT_COMMAND_SCROLL_CHANGED
3916 #define EVT_SCROLL_ENDSCROLL EVT_SCROLL_CHANGED
3917 #endif // WXWIN_COMPATIBILITY_2_6
3919 // Convenience macros for commonly-used commands
3920 #define EVT_CHECKBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKBOX_CLICKED, winid, wxCommandEventHandler(func))
3921 #define EVT_CHOICE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHOICE_SELECTED, winid, wxCommandEventHandler(func))
3922 #define EVT_LISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_SELECTED, winid, wxCommandEventHandler(func))
3923 #define EVT_LISTBOX_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, winid, wxCommandEventHandler(func))
3924 #define EVT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_MENU_SELECTED, winid, wxCommandEventHandler(func))
3925 #define EVT_MENU_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_MENU_SELECTED, id1, id2, wxCommandEventHandler(func))
3926 #if defined(__SMARTPHONE__)
3927 # define EVT_BUTTON(winid, func) EVT_MENU(winid, func)
3929 # define EVT_BUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_BUTTON_CLICKED, winid, wxCommandEventHandler(func))
3931 #define EVT_SLIDER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SLIDER_UPDATED, winid, wxCommandEventHandler(func))
3932 #define EVT_RADIOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBOX_SELECTED, winid, wxCommandEventHandler(func))
3933 #define EVT_RADIOBUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBUTTON_SELECTED, winid, wxCommandEventHandler(func))
3934 // EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events
3935 #define EVT_SCROLLBAR(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SCROLLBAR_UPDATED, winid, wxCommandEventHandler(func))
3936 #define EVT_VLBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_VLBOX_SELECTED, winid, wxCommandEventHandler(func))
3937 #define EVT_COMBOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_SELECTED, winid, wxCommandEventHandler(func))
3938 #define EVT_TOOL(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_CLICKED, winid, wxCommandEventHandler(func))
3939 #define EVT_TOOL_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, winid, wxCommandEventHandler(func))
3940 #define EVT_TOOL_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_CLICKED, id1, id2, wxCommandEventHandler(func))
3941 #define EVT_TOOL_RCLICKED(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_RCLICKED, winid, wxCommandEventHandler(func))
3942 #define EVT_TOOL_RCLICKED_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, wxCommandEventHandler(func))
3943 #define EVT_TOOL_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_ENTER, winid, wxCommandEventHandler(func))
3944 #define EVT_CHECKLISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, winid, wxCommandEventHandler(func))
3946 // Generic command events
3947 #define EVT_COMMAND_LEFT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_CLICK, winid, wxCommandEventHandler(func))
3948 #define EVT_COMMAND_LEFT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_DCLICK, winid, wxCommandEventHandler(func))
3949 #define EVT_COMMAND_RIGHT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_CLICK, winid, wxCommandEventHandler(func))
3950 #define EVT_COMMAND_RIGHT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_DCLICK, winid, wxCommandEventHandler(func))
3951 #define EVT_COMMAND_SET_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SET_FOCUS, winid, wxCommandEventHandler(func))
3952 #define EVT_COMMAND_KILL_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_KILL_FOCUS, winid, wxCommandEventHandler(func))
3953 #define EVT_COMMAND_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_ENTER, winid, wxCommandEventHandler(func))
3957 #define EVT_JOY_BUTTON_DOWN(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_DOWN, wxJoystickEventHandler(func))
3958 #define EVT_JOY_BUTTON_UP(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_UP, wxJoystickEventHandler(func))
3959 #define EVT_JOY_MOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_MOVE, wxJoystickEventHandler(func))
3960 #define EVT_JOY_ZMOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_ZMOVE, wxJoystickEventHandler(func))
3962 // All joystick events
3963 #define EVT_JOYSTICK_EVENTS(func) \
3964 EVT_JOY_BUTTON_DOWN(func) \
3965 EVT_JOY_BUTTON_UP(func) \
3966 EVT_JOY_MOVE(func) \
3970 #define EVT_IDLE(func) wx__DECLARE_EVT0(wxEVT_IDLE, wxIdleEventHandler(func))
3973 #define EVT_UPDATE_UI(winid, func) wx__DECLARE_EVT1(wxEVT_UPDATE_UI, winid, wxUpdateUIEventHandler(func))
3974 #define EVT_UPDATE_UI_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_UPDATE_UI, id1, id2, wxUpdateUIEventHandler(func))
3977 #define EVT_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_HELP, winid, wxHelpEventHandler(func))
3978 #define EVT_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_HELP, id1, id2, wxHelpEventHandler(func))
3979 #define EVT_DETAILED_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_DETAILED_HELP, winid, wxHelpEventHandler(func))
3980 #define EVT_DETAILED_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_DETAILED_HELP, id1, id2, wxHelpEventHandler(func))
3982 // Context Menu Events
3983 #define EVT_CONTEXT_MENU(func) wx__DECLARE_EVT0(wxEVT_CONTEXT_MENU, wxContextMenuEventHandler(func))
3984 #define EVT_COMMAND_CONTEXT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_CONTEXT_MENU, winid, wxContextMenuEventHandler(func))
3986 // Clipboard text Events
3987 #define EVT_TEXT_CUT(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_CUT, winid, wxClipboardTextEventHandler(func))
3988 #define EVT_TEXT_COPY(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_COPY, winid, wxClipboardTextEventHandler(func))
3989 #define EVT_TEXT_PASTE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_PASTE, winid, wxClipboardTextEventHandler(func))
3992 #define EVT_THREAD(id, func) wx__DECLARE_EVT1(wxEVT_COMMAND_THREAD, id, wxThreadEventHandler(func))
3994 // ----------------------------------------------------------------------------
3996 // ----------------------------------------------------------------------------
4000 // Find a window with the focus, that is also a descendant of the given window.
4001 // This is used to determine the window to initially send commands to.
4002 WXDLLIMPEXP_CORE wxWindow
* wxFindFocusDescendant(wxWindow
* ancestor
);
4006 #endif // _WX_EVENT_H_