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 );
130 // Define/Declare a templatized event type with the corresponding event as
133 #define wxDEFINE_EVENT( name, type ) \
134 const wxEventTypeTag< type > name( wxNewEventType() )
136 #define wxDECLARE_EXPORTED_EVENT( expdecl, name, type ) \
137 extern const expdecl wxEventTypeTag< type > name
139 // Define/Declare a templatized event type and initialize it with a
140 // predefined event type. (Only used for wxEVT_SPIN_XXX for backward
143 #define wxDEFINE_EVENT_ALIAS( name, type, value ) \
144 const wxEventTypeTag< type > name( value )
146 #define wxDECLARE_EXPORTED_EVENT_ALIAS( expdecl, name, type ) \
147 extern const expdecl wxEventTypeTag< type > name
149 // Declare a local (not exported) templatized event type:
151 #define wxDECLARE_EVENT( name, type ) \
152 wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type );
156 // Try to cast the given event handler to the correct handler type:
158 #define wxEVENT_HANDLER_CAST( functype, func ) \
159 ( wxObjectEventFunction )( wxEventFunction )wxStaticCastEvent( functype, &func )
161 // Template which associates the correct event object with the event type
163 #if !wxEVENTS_COMPATIBILITY_2_8
165 // The tag is a type associated to the event type (which is an integer itself,
166 // in spite of its name) value. It exists in order to be used as a template
167 // parameter and provide a mapping between the event type values and their
168 // corresponding wxEvent-derived classes.
169 template <typename T
>
173 // The class of wxEvent-derived class carried by the events of this type.
174 typedef T EventClass
;
176 wxEventTypeTag(wxEventType type
) { m_type
= type
; }
178 // Return a wxEventType reference for the initialization of the static
179 // event tables. See wxEventTableEntry::m_eventType for a more thorough
181 operator const wxEventType
&() const { return m_type
; }
187 #endif // !wxEVENTS_COMPATIBILITY_2_8
189 // These are needed for the functor definitions
190 typedef void (wxEvtHandler
::*wxEventFunction
)(wxEvent
&);
192 // We had some trouble (specifically with eVC for ARM WinCE build) with using
193 // wxEventFunction in the past so we had introduced wxObjectEventFunction which
194 // used to be a typedef for a member of wxObject and not wxEvtHandler to work
195 // around this but as eVC is not really supported any longer we now only keep
196 // this for backwards compatibility and, despite its name, this is a typedef
197 // for wxEvtHandler member now -- but if we have the same problem with another
198 // compiler we can restore its old definition for it.
199 typedef wxEventFunction wxObjectEventFunction
;
202 // The event functor which is stored in the static and dynamic event tables:
203 class WXDLLIMPEXP_BASE wxEventFunctor
206 virtual ~wxEventFunctor();
208 // Invoke the actual event handler:
209 virtual void operator()(wxEvtHandler
*, wxEvent
&) = 0;
211 // this function tests whether this functor is matched, for the purpose of
212 // finding it in an event table in Disconnect(), by the given func
213 virtual bool Matches(const wxEventFunctor
& func
) const = 0;
215 // these functions are used for functors comparison in Matches()
216 virtual void *GetHandler() const { return GetEvtHandler(); }
217 virtual wxEventFunction
GetMethod() const { return NULL
; }
219 // this one is also used elsewhere in the code and should be overridden to
220 // return non-NULL if we are indeed associated with an wxEvtHandler
221 virtual wxEvtHandler
*GetEvtHandler() const { return NULL
; }
224 // A plain method functor: notice that it is used even with the new events as
225 // it is reused as a specialization of wxEventFunctorMethod for legacy untyped
227 class WXDLLIMPEXP_BASE wxObjectEventFunctor
: public wxEventFunctor
230 wxObjectEventFunctor(wxObjectEventFunction method
, wxEvtHandler
*handler
)
236 virtual void operator()(wxEvtHandler
*handler
, wxEvent
& event
);
238 virtual bool Matches(const wxEventFunctor
& func
) const
240 void * const handler
= func
.GetHandler();
241 if ( handler
&& GetHandler() != handler
)
244 const wxEventFunction method
= GetMethod();
246 // FIXME-VC6: amazing but true: replacing "method == NULL" here with
247 // "!method" makes VC6 crash with an ICE in DLL build (only!)
248 return method
== NULL
|| GetMethod() == method
;
251 virtual wxEvtHandler
*GetEvtHandler() const { return m_handler
; }
252 virtual wxEventFunction
GetMethod() const { return m_method
; }
255 wxEvtHandler
*m_handler
;
256 wxEventFunction m_method
;
259 #if wxEVENTS_COMPATIBILITY_2_8
261 // Create a functor for the legacy events: handler can be NULL and its default
262 // value is used by the event table macros
264 inline wxObjectEventFunctor
*
265 wxNewEventFunctor(const wxEventType
& WXUNUSED(evtType
),
266 wxObjectEventFunction method
,
267 wxEvtHandler
*handler
= NULL
)
269 return new wxObjectEventFunctor(method
, handler
);
272 inline wxObjectEventFunctor
273 wxMakeEventFunctor(const wxEventType
& WXUNUSED(evtType
),
274 wxObjectEventFunction method
,
275 wxEvtHandler
*handler
)
277 return wxObjectEventFunctor(method
, handler
);
280 #else // !wxEVENTS_COMPATIBILITY_2_8
282 // functor forwarding the event to anything callable (function, static method,
283 // generalized functor...)
284 template <typename EventTag
, typename Functor
>
285 class wxEventFunctorFunction
: public wxEventFunctor
288 typedef typename EventTag
::EventClass EventArg
;
290 wxEventFunctorFunction(Functor handler
)
295 virtual void operator()(wxEvtHandler
*WXUNUSED(handler
), wxEvent
& event
)
297 m_handler(static_cast<EventArg
&>(event
));
300 virtual bool Matches(const wxEventFunctor
& WXUNUSED(func
)) const
302 // we have no way to compare arbitrary functors so just consider them
303 // to be equal: this means that disconnecting a functor will always
304 // find the last functor connected which in turn implies that it's
305 // probably a bad idea to connect more than one functor if you plan to
306 // disconnect them but this limitation doesn't seem very important in
318 // helper template defining nested "type" typedef as the event class
319 // corresponding to the given event type
320 template <typename T
> struct EventClassOf
;
322 // the typed events provide the information about the class of the events they
324 template <typename T
>
325 struct EventClassOf
< wxEventTypeTag
<T
> >
327 typedef typename wxEventTypeTag
<T
>::EventClass type
;
330 // for the old untyped events we don't have information about the exact event
331 // class carried by them
333 struct EventClassOf
<wxEventType
>
335 typedef wxEvent type
;
339 // helper class defining operations different for method functors using an
340 // object of wxEvtHandler-derived class as handler and the others
341 template <typename T
, typename A
, bool> struct HandlerImpl
;
343 // specialization for handlers deriving from wxEvtHandler
344 template <typename T
, typename A
>
345 struct HandlerImpl
<T
, A
, true>
347 static bool IsEvtHandler()
349 static T
*ConvertFromEvtHandler(wxEvtHandler
*p
)
350 { return static_cast<T
*>(p
); }
351 static wxEvtHandler
*ConvertToEvtHandler(T
*p
)
353 static wxEventFunction
ConvertToEvtFunction(void (T
::*f
)(A
&))
354 { return static_cast<wxEventFunction
>(
355 reinterpret_cast<void (T
::*)(wxEvent
&)>(f
)); }
358 // specialization for handlers not deriving from wxEvtHandler
359 template <typename T
, typename A
>
360 struct HandlerImpl
<T
, A
, false>
362 static bool IsEvtHandler()
364 static T
*ConvertFromEvtHandler(wxEvtHandler
*)
366 static wxEvtHandler
*ConvertToEvtHandler(T
*)
368 static wxEventFunction
ConvertToEvtFunction(void (T
::*)(A
&))
372 } // namespace wxPrivate
374 // functor forwarding the event to a method of the given object
376 // notice that the object class may be different from the class in which the
377 // method is defined but it must be convertible to this class
379 // also, the type of the handler parameter doesn't need to be exactly the same
380 // as EventTag::EventClass but it must be its base class -- this is explicitly
381 // allowed to handle different events in the same handler taking wxEvent&, for
384 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
385 class wxEventFunctorMethod
386 : public wxEventFunctor
,
387 private wxPrivate
::HandlerImpl
391 wxConvertibleTo
<Class
, wxEvtHandler
>::value
!= 0
395 static void CheckHandlerArgument(EventArg
*) { }
398 // the event class associated with the given event tag
399 typedef typename wxPrivate
::EventClassOf
<EventTag
>::type EventClass
;
402 wxEventFunctorMethod(void (Class
::*method
)(EventArg
&), ObjClass
*handler
)
404 wxASSERT_MSG( handler
|| this->IsEvtHandler(),
405 "handlers defined in non-wxEvtHandler-derived classes "
406 "must be connected with a valid sink object" );
408 // if you get an error here it means that the signature of the handler
409 // you're trying to use is not compatible with (i.e. is not the same as
410 // or a base class of) the real event class used for this event type
411 CheckHandlerArgument(static_cast<EventClass
*>(NULL
));
417 virtual void operator()(wxEvtHandler
*handler
, wxEvent
& event
)
419 Class
* realHandler
= m_handler
;
422 realHandler
= this->ConvertFromEvtHandler(handler
);
424 // this is not supposed to happen but check for it nevertheless
425 wxCHECK_RET( realHandler
, "invalid event handler" );
428 // the real (run-time) type of event is EventClass and we checked in
429 // the ctor that EventClass can be converted to EventArg, so this cast
431 (realHandler
->*m_method
)(static_cast<EventArg
&>(event
));
434 virtual bool Matches(const wxEventFunctor
& func
) const
436 void * const handler
= func
.GetHandler();
437 if ( handler
&& GetHandler() != handler
)
440 const wxEventFunction method
= GetMethod();
441 return !method
|| GetMethod() == method
;
444 virtual void *GetHandler() const
449 virtual wxEventFunction
GetMethod() const
451 return this->ConvertToEvtFunction(m_method
);
454 virtual wxEvtHandler
*GetEvtHandler() const
456 return this->ConvertToEvtHandler(m_handler
);
461 void (Class
::*m_method
)(EventArg
&);
465 // Create functors for the templatized events, either allocated on the heap for
466 // wxNewXXX() variants (this is needed in wxEvtHandler::Bind<>() to store them
467 // in dynamic event table) or just by returning them as temporary objects (this
468 // is enough for Unbind<>() and we avoid unnecessary heap allocation like this).
471 // Create functors wrapping other functors (including functions):
472 template <typename EventTag
, typename Functor
>
473 inline wxEventFunctorFunction
<EventTag
, Functor
> *
474 wxNewEventFunctor(const EventTag
&, Functor func
)
476 return new wxEventFunctorFunction
<EventTag
, Functor
>(func
);
479 template <typename EventTag
, typename Functor
>
480 inline wxEventFunctorFunction
<EventTag
, Functor
>
481 wxMakeEventFunctor(const EventTag
&, Functor func
)
483 return wxEventFunctorFunction
<EventTag
, Functor
>(func
);
487 // Create functors for methods:
489 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
490 inline wxEventFunctorMethod
<EventTag
, Class
, EventArg
, ObjClass
> *
491 wxNewEventFunctor(const EventTag
&,
492 void (Class
::*method
)(EventArg
&),
495 return new wxEventFunctorMethod
<EventTag
, Class
, EventArg
, ObjClass
>(
500 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
501 inline wxEventFunctorMethod
<EventTag
, Class
, EventArg
, ObjClass
>
502 wxMakeEventFunctor(const EventTag
&,
503 void (Class
::*method
)(EventArg
&),
506 return wxEventFunctorMethod
<EventTag
, Class
, EventArg
, ObjClass
>(
510 // Special case for the wxNewEventFunctor() calls used inside the event table
511 // macros: they don't specify the handler so ObjClass can't be deduced
512 template <typename EventTag
, typename Class
, typename EventArg
>
513 inline wxEventFunctorMethod
<EventTag
, Class
, EventArg
, Class
> *
514 wxNewEventFunctor(const EventTag
&, void (Class
::*method
)(EventArg
&))
516 return new wxEventFunctorMethod
<EventTag
, Class
, EventArg
, Class
>(
521 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
522 inline wxEventFunctorMethod
<EventTag
, Class
, EventArg
, Class
>
523 wxMakeEventFunctor(const EventTag
&, void (Class
::*method
)(EventArg
&))
525 return wxEventFunctorMethod
<EventTag
, Class
, EventArg
, Class
>(
529 #endif // !wxEVENTS_COMPATIBILITY_2_8
532 // many, but not all, standard event types
534 // some generic events
535 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_NULL
;
536 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_FIRST
;
537 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_USER_FIRST
;
539 // Need events declared to do this
540 class WXDLLIMPEXP_FWD_CORE wxCommandEvent
;
541 class WXDLLIMPEXP_FWD_CORE wxThreadEvent
;
542 class WXDLLIMPEXP_FWD_CORE wxMouseEvent
;
543 class WXDLLIMPEXP_FWD_CORE wxFocusEvent
;
544 class WXDLLIMPEXP_FWD_CORE wxChildFocusEvent
;
545 class WXDLLIMPEXP_FWD_CORE wxKeyEvent
;
546 class WXDLLIMPEXP_FWD_CORE wxNavigationKeyEvent
;
547 class WXDLLIMPEXP_FWD_CORE wxSetCursorEvent
;
548 class WXDLLIMPEXP_FWD_CORE wxScrollEvent
;
549 class WXDLLIMPEXP_FWD_CORE wxSpinEvent
;
550 class WXDLLIMPEXP_FWD_CORE wxScrollWinEvent
;
551 class WXDLLIMPEXP_FWD_CORE wxSizeEvent
;
552 class WXDLLIMPEXP_FWD_CORE wxMoveEvent
;
553 class WXDLLIMPEXP_FWD_CORE wxCloseEvent
;
554 class WXDLLIMPEXP_FWD_CORE wxActivateEvent
;
555 class WXDLLIMPEXP_FWD_CORE wxWindowCreateEvent
;
556 class WXDLLIMPEXP_FWD_CORE wxWindowDestroyEvent
;
557 class WXDLLIMPEXP_FWD_CORE wxShowEvent
;
558 class WXDLLIMPEXP_FWD_CORE wxIconizeEvent
;
559 class WXDLLIMPEXP_FWD_CORE wxMaximizeEvent
;
560 class WXDLLIMPEXP_FWD_CORE wxMouseCaptureChangedEvent
;
561 class WXDLLIMPEXP_FWD_CORE wxMouseCaptureLostEvent
;
562 class WXDLLIMPEXP_FWD_CORE wxPaintEvent
;
563 class WXDLLIMPEXP_FWD_CORE wxEraseEvent
;
564 class WXDLLIMPEXP_FWD_CORE wxNcPaintEvent
;
565 class WXDLLIMPEXP_FWD_CORE wxMenuEvent
;
566 class WXDLLIMPEXP_FWD_CORE wxContextMenuEvent
;
567 class WXDLLIMPEXP_FWD_CORE wxSysColourChangedEvent
;
568 class WXDLLIMPEXP_FWD_CORE wxDisplayChangedEvent
;
569 class WXDLLIMPEXP_FWD_CORE wxQueryNewPaletteEvent
;
570 class WXDLLIMPEXP_FWD_CORE wxPaletteChangedEvent
;
571 class WXDLLIMPEXP_FWD_CORE wxJoystickEvent
;
572 class WXDLLIMPEXP_FWD_CORE wxDropFilesEvent
;
573 class WXDLLIMPEXP_FWD_CORE wxInitDialogEvent
;
574 class WXDLLIMPEXP_FWD_CORE wxIdleEvent
;
575 class WXDLLIMPEXP_FWD_CORE wxUpdateUIEvent
;
576 class WXDLLIMPEXP_FWD_CORE wxClipboardTextEvent
;
577 class WXDLLIMPEXP_FWD_CORE wxHelpEvent
;
581 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_BUTTON_CLICKED
, wxCommandEvent
);
582 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHECKBOX_CLICKED
, wxCommandEvent
);
583 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHOICE_SELECTED
, wxCommandEvent
);
584 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LISTBOX_SELECTED
, wxCommandEvent
);
585 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
, wxCommandEvent
);
586 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
, wxCommandEvent
);
587 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_MENU_SELECTED
, wxCommandEvent
);
588 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SLIDER_UPDATED
, wxCommandEvent
);
589 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RADIOBOX_SELECTED
, wxCommandEvent
);
590 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RADIOBUTTON_SELECTED
, wxCommandEvent
);
592 // wxEVT_COMMAND_SCROLLBAR_UPDATED is deprecated, use wxEVT_SCROLL... events
593 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SCROLLBAR_UPDATED
, wxCommandEvent
);
594 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_VLBOX_SELECTED
, wxCommandEvent
);
595 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_COMBOBOX_SELECTED
, wxCommandEvent
);
596 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_RCLICKED
, wxCommandEvent
);
597 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED
, wxCommandEvent
);
598 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_ENTER
, wxCommandEvent
);
601 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_THREAD
, wxThreadEvent
);
604 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_DOWN
, wxMouseEvent
);
605 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_UP
, wxMouseEvent
);
606 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_DOWN
, wxMouseEvent
);
607 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_UP
, wxMouseEvent
);
608 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_DOWN
, wxMouseEvent
);
609 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_UP
, wxMouseEvent
);
610 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOTION
, wxMouseEvent
);
611 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ENTER_WINDOW
, wxMouseEvent
);
612 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEAVE_WINDOW
, wxMouseEvent
);
613 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_DCLICK
, wxMouseEvent
);
614 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_DCLICK
, wxMouseEvent
);
615 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_DCLICK
, wxMouseEvent
);
616 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SET_FOCUS
, wxFocusEvent
);
617 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KILL_FOCUS
, wxFocusEvent
);
618 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHILD_FOCUS
, wxChildFocusEvent
);
619 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSEWHEEL
, wxMouseEvent
);
620 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_DOWN
, wxMouseEvent
);
621 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_UP
, wxMouseEvent
);
622 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_DCLICK
, wxMouseEvent
);
623 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_DOWN
, wxMouseEvent
);
624 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_UP
, wxMouseEvent
);
625 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_DCLICK
, wxMouseEvent
);
627 // Character input event type
628 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHAR
, wxKeyEvent
);
629 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHAR_HOOK
, wxKeyEvent
);
630 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_NAVIGATION_KEY
, wxNavigationKeyEvent
);
631 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KEY_DOWN
, wxKeyEvent
);
632 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KEY_UP
, wxKeyEvent
);
634 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HOTKEY
, wxKeyEvent
);
637 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SET_CURSOR
, wxSetCursorEvent
);
639 // wxScrollBar and wxSlider event identifiers
640 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_TOP
, wxScrollEvent
);
641 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_BOTTOM
, wxScrollEvent
);
642 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_LINEUP
, wxScrollEvent
);
643 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_LINEDOWN
, wxScrollEvent
);
644 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_PAGEUP
, wxScrollEvent
);
645 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_PAGEDOWN
, wxScrollEvent
);
646 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_THUMBTRACK
, wxScrollEvent
);
647 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_THUMBRELEASE
, wxScrollEvent
);
648 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_CHANGED
, wxScrollEvent
);
650 // Due to a bug in older wx versions, wxSpinEvents were being sent with type of
651 // wxEVT_SCROLL_LINEUP, wxEVT_SCROLL_LINEDOWN and wxEVT_SCROLL_THUMBTRACK. But
652 // with the type-safe events in place, these event types are associated with
653 // wxScrollEvent. To allow handling of spin events, new event types have been
654 // defined in spinbutt.h/spinnbuttcmn.cpp. To maintain backward compatibility
655 // the spin event types are being initialized with the scroll event types.
659 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN_UP
, wxSpinEvent
);
660 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN_DOWN
, wxSpinEvent
);
661 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN
, wxSpinEvent
);
665 // Scroll events from wxWindow
666 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_TOP
, wxScrollWinEvent
);
667 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_BOTTOM
, wxScrollWinEvent
);
668 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_LINEUP
, wxScrollWinEvent
);
669 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_LINEDOWN
, wxScrollWinEvent
);
670 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_PAGEUP
, wxScrollWinEvent
);
671 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_PAGEDOWN
, wxScrollWinEvent
);
672 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_THUMBTRACK
, wxScrollWinEvent
);
673 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_THUMBRELEASE
, wxScrollWinEvent
);
676 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SIZE
, wxSizeEvent
);
677 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE
, wxMoveEvent
);
678 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CLOSE_WINDOW
, wxCloseEvent
);
679 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_END_SESSION
, wxCloseEvent
);
680 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_QUERY_END_SESSION
, wxCloseEvent
);
681 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ACTIVATE_APP
, wxActivateEvent
);
682 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ACTIVATE
, wxActivateEvent
);
683 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CREATE
, wxWindowCreateEvent
);
684 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DESTROY
, wxWindowDestroyEvent
);
685 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SHOW
, wxShowEvent
);
686 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ICONIZE
, wxIconizeEvent
);
687 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MAXIMIZE
, wxMaximizeEvent
);
688 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSE_CAPTURE_CHANGED
, wxMouseCaptureChangedEvent
);
689 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSE_CAPTURE_LOST
, wxMouseCaptureLostEvent
);
690 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_PAINT
, wxPaintEvent
);
691 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ERASE_BACKGROUND
, wxEraseEvent
);
692 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_NC_PAINT
, wxNcPaintEvent
);
693 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_OPEN
, wxMenuEvent
);
694 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_CLOSE
, wxMenuEvent
);
695 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_HIGHLIGHT
, wxMenuEvent
);
696 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CONTEXT_MENU
, wxContextMenuEvent
);
697 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SYS_COLOUR_CHANGED
, wxSysColourChangedEvent
);
698 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DISPLAY_CHANGED
, wxDisplayChangedEvent
);
699 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_QUERY_NEW_PALETTE
, wxQueryNewPaletteEvent
);
700 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_PALETTE_CHANGED
, wxPaletteChangedEvent
);
701 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_BUTTON_DOWN
, wxJoystickEvent
);
702 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_BUTTON_UP
, wxJoystickEvent
);
703 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_MOVE
, wxJoystickEvent
);
704 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_ZMOVE
, wxJoystickEvent
);
705 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DROP_FILES
, wxDropFilesEvent
);
706 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_INIT_DIALOG
, wxInitDialogEvent
);
707 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_BASE
, wxEVT_IDLE
, wxIdleEvent
);
708 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_UPDATE_UI
, wxUpdateUIEvent
);
709 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SIZING
, wxSizeEvent
);
710 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVING
, wxMoveEvent
);
711 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE_START
, wxMoveEvent
);
712 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE_END
, wxMoveEvent
);
713 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HIBERNATE
, wxActivateEvent
);
716 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_COPY
, wxClipboardTextEvent
);
717 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_CUT
, wxClipboardTextEvent
);
718 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_PASTE
, wxClipboardTextEvent
);
720 // Generic command events
721 // Note: a click is a higher-level event than button down/up
722 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LEFT_CLICK
, wxCommandEvent
);
723 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LEFT_DCLICK
, wxCommandEvent
);
724 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RIGHT_CLICK
, wxCommandEvent
);
725 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RIGHT_DCLICK
, wxCommandEvent
);
726 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SET_FOCUS
, wxCommandEvent
);
727 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_KILL_FOCUS
, wxCommandEvent
);
728 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_ENTER
, wxCommandEvent
);
731 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HELP
, wxHelpEvent
);
732 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DETAILED_HELP
, wxHelpEvent
);
734 // these 2 events are the same
735 #define wxEVT_COMMAND_TOOL_CLICKED wxEVT_COMMAND_MENU_SELECTED
737 // ----------------------------------------------------------------------------
739 // ----------------------------------------------------------------------------
741 // this event is also used by wxComboBox and wxSpinCtrl which don't include
742 // wx/textctrl.h in all ports [yet], so declare it here as well
744 // still, any new code using it should include wx/textctrl.h explicitly
745 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_UPDATED
, wxCommandEvent
);
748 // ----------------------------------------------------------------------------
749 // wxEvent(-derived) classes
750 // ----------------------------------------------------------------------------
752 // the predefined constants for the number of times we propagate event
753 // upwards window child-parent chain
754 enum wxEventPropagation
756 // don't propagate it at all
757 wxEVENT_PROPAGATE_NONE
= 0,
759 // propagate it until it is processed
760 wxEVENT_PROPAGATE_MAX
= INT_MAX
763 // The different categories for a wxEvent; see wxEvent::GetEventCategory.
764 // NOTE: they are used as OR-combinable flags by wxEventLoopBase::YieldFor
767 // this is the category for those events which are generated to update
768 // the appearance of the GUI but which (usually) do not comport data
769 // processing, i.e. which do not provide input or output data
770 // (e.g. size events, scroll events, etc).
771 // They are events NOT directly generated by the user's input devices.
772 wxEVT_CATEGORY_UI
= 1,
774 // this category groups those events which are generated directly from the
775 // user through input devices like mouse and keyboard and usually result in
776 // data to be processed from the application.
777 // (e.g. mouse clicks, key presses, etc)
778 wxEVT_CATEGORY_USER_INPUT
= 2,
780 // this category is for wxSocketEvent
781 wxEVT_CATEGORY_SOCKET
= 4,
783 // this category is for wxTimerEvent
784 wxEVT_CATEGORY_TIMER
= 8,
786 // this category is for any event used to send notifications from the
787 // secondary threads to the main one or in general for notifications among
788 // different threads (which may or may not be user-generated)
789 wxEVT_CATEGORY_THREAD
= 16,
792 // implementation only
794 // used in the implementations of wxEventLoopBase::YieldFor
795 wxEVT_CATEGORY_UNKNOWN
= 32,
797 // a special category used as an argument to wxEventLoopBase::YieldFor to indicate that
798 // Yield() should leave all wxEvents on the queue while emptying the native event queue
799 // (native events will be processed but the wxEvents they generate will be queued)
800 wxEVT_CATEGORY_CLIPBOARD
= 64,
805 // this category groups those events which are emitted in response to
806 // events of the native toolkit and which typically are not-"delayable".
807 wxEVT_CATEGORY_NATIVE_EVENTS
= wxEVT_CATEGORY_UI
|wxEVT_CATEGORY_USER_INPUT
,
809 // used in wxEventLoopBase::YieldFor to specify all event categories should be processed:
811 wxEVT_CATEGORY_UI
|wxEVT_CATEGORY_USER_INPUT
|wxEVT_CATEGORY_SOCKET
| \
812 wxEVT_CATEGORY_TIMER
|wxEVT_CATEGORY_THREAD
|wxEVT_CATEGORY_UNKNOWN
| \
813 wxEVT_CATEGORY_CLIPBOARD
817 * wxWidgets events, covering all interesting things that might happen
818 * (button clicking, resizing, setting text in widgets, etc.).
820 * For each completely new event type, derive a new event class.
821 * An event CLASS represents a C++ class defining a range of similar event TYPES;
822 * examples are canvas events, panel item command events.
823 * An event TYPE is a unique identifier for a particular system event,
824 * such as a button press or a listbox deselection.
828 class WXDLLIMPEXP_BASE wxEvent
: public wxObject
831 wxEvent(int winid
= 0, wxEventType commandType
= wxEVT_NULL
);
833 void SetEventType(wxEventType typ
) { m_eventType
= typ
; }
834 wxEventType
GetEventType() const { return m_eventType
; }
836 wxObject
*GetEventObject() const { return m_eventObject
; }
837 void SetEventObject(wxObject
*obj
) { m_eventObject
= obj
; }
839 long GetTimestamp() const { return m_timeStamp
; }
840 void SetTimestamp(long ts
= 0) { m_timeStamp
= ts
; }
842 int GetId() const { return m_id
; }
843 void SetId(int Id
) { m_id
= Id
; }
845 // Can instruct event processor that we wish to ignore this event
846 // (treat as if the event table entry had not been found): this must be done
847 // to allow the event processing by the base classes (calling event.Skip()
848 // is the analog of calling the base class version of a virtual function)
849 void Skip(bool skip
= true) { m_skipped
= skip
; }
850 bool GetSkipped() const { return m_skipped
; }
852 // This function is used to create a copy of the event polymorphically and
853 // all derived classes must implement it because otherwise wxPostEvent()
854 // for them wouldn't work (it needs to do a copy of the event)
855 virtual wxEvent
*Clone() const = 0;
857 // this function is used to selectively process events in wxEventLoopBase::YieldFor
858 // NOTE: by default it returns wxEVT_CATEGORY_UI just because the major
859 // part of wxWidgets events belong to that category.
860 virtual wxEventCategory
GetEventCategory() const
861 { return wxEVT_CATEGORY_UI
; }
863 // Implementation only: this test is explicitly anti OO and this function
864 // exists only for optimization purposes.
865 bool IsCommandEvent() const { return m_isCommandEvent
; }
867 // Determine if this event should be propagating to the parent window.
868 bool ShouldPropagate() const
869 { return m_propagationLevel
!= wxEVENT_PROPAGATE_NONE
; }
871 // Stop an event from propagating to its parent window, returns the old
872 // propagation level value
873 int StopPropagation()
875 int propagationLevel
= m_propagationLevel
;
876 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
877 return propagationLevel
;
880 // Resume the event propagation by restoring the propagation level
881 // (returned by StopPropagation())
882 void ResumePropagation(int propagationLevel
)
884 m_propagationLevel
= propagationLevel
;
888 // This is for internal use only and is only called by
889 // wxEvtHandler::ProcessEvent() to check whether it's the first time this
890 // event is being processed
893 if ( m_wasProcessed
)
896 m_wasProcessed
= true;
902 wxObject
* m_eventObject
;
903 wxEventType m_eventType
;
908 // m_callbackUserData is for internal usage only
909 wxObject
* m_callbackUserData
;
912 // the propagation level: while it is positive, we propagate the event to
913 // the parent window (if any)
914 int m_propagationLevel
;
917 bool m_isCommandEvent
;
919 // initially false but becomes true as soon as WasProcessed() is called for
920 // the first time, as this is done only by ProcessEvent() it explains the
921 // variable name: it becomes true after ProcessEvent() was called at least
922 // once for this event
926 wxEvent(const wxEvent
&); // for implementing Clone()
927 wxEvent
& operator=(const wxEvent
&); // for derived classes operator=()
930 // it needs to access our m_propagationLevel
931 friend class WXDLLIMPEXP_FWD_BASE wxPropagateOnce
;
933 DECLARE_ABSTRACT_CLASS(wxEvent
)
937 * Helper class to temporarily change an event not to propagate.
939 class WXDLLIMPEXP_BASE wxPropagationDisabler
942 wxPropagationDisabler(wxEvent
& event
) : m_event(event
)
944 m_propagationLevelOld
= m_event
.StopPropagation();
947 ~wxPropagationDisabler()
949 m_event
.ResumePropagation(m_propagationLevelOld
);
954 int m_propagationLevelOld
;
956 wxDECLARE_NO_COPY_CLASS(wxPropagationDisabler
);
960 * Another one to temporarily lower propagation level.
962 class WXDLLIMPEXP_BASE wxPropagateOnce
965 wxPropagateOnce(wxEvent
& event
) : m_event(event
)
967 wxASSERT_MSG( m_event
.m_propagationLevel
> 0,
968 _T("shouldn't be used unless ShouldPropagate()!") );
970 m_event
.m_propagationLevel
--;
975 m_event
.m_propagationLevel
++;
981 wxDECLARE_NO_COPY_CLASS(wxPropagateOnce
);
988 // Item or menu event class
990 wxEVT_COMMAND_BUTTON_CLICKED
991 wxEVT_COMMAND_CHECKBOX_CLICKED
992 wxEVT_COMMAND_CHOICE_SELECTED
993 wxEVT_COMMAND_LISTBOX_SELECTED
994 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
995 wxEVT_COMMAND_TEXT_UPDATED
996 wxEVT_COMMAND_TEXT_ENTER
997 wxEVT_COMMAND_MENU_SELECTED
998 wxEVT_COMMAND_SLIDER_UPDATED
999 wxEVT_COMMAND_RADIOBOX_SELECTED
1000 wxEVT_COMMAND_RADIOBUTTON_SELECTED
1001 wxEVT_COMMAND_SCROLLBAR_UPDATED
1002 wxEVT_COMMAND_VLBOX_SELECTED
1003 wxEVT_COMMAND_COMBOBOX_SELECTED
1004 wxEVT_COMMAND_TOGGLEBUTTON_CLICKED
1007 class WXDLLIMPEXP_CORE wxCommandEvent
: public wxEvent
1010 wxCommandEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0);
1012 wxCommandEvent(const wxCommandEvent
& event
)
1014 m_cmdString(event
.m_cmdString
),
1015 m_commandInt(event
.m_commandInt
),
1016 m_extraLong(event
.m_extraLong
),
1017 m_clientData(event
.m_clientData
),
1018 m_clientObject(event
.m_clientObject
)
1021 // Set/Get client data from controls
1022 void SetClientData(void* clientData
) { m_clientData
= clientData
; }
1023 void *GetClientData() const { return m_clientData
; }
1025 // Set/Get client object from controls
1026 void SetClientObject(wxClientData
* clientObject
) { m_clientObject
= clientObject
; }
1027 wxClientData
*GetClientObject() const { return m_clientObject
; }
1029 // Get listbox selection if single-choice
1030 int GetSelection() const { return m_commandInt
; }
1032 // Set/Get listbox/choice selection string
1033 void SetString(const wxString
& s
) { m_cmdString
= s
; }
1034 wxString
GetString() const;
1036 // Get checkbox value
1037 bool IsChecked() const { return m_commandInt
!= 0; }
1039 // true if the listbox event was a selection.
1040 bool IsSelection() const { return (m_extraLong
!= 0); }
1042 void SetExtraLong(long extraLong
) { m_extraLong
= extraLong
; }
1043 long GetExtraLong() const { return m_extraLong
; }
1045 void SetInt(int i
) { m_commandInt
= i
; }
1046 int GetInt() const { return m_commandInt
; }
1048 virtual wxEvent
*Clone() const { return new wxCommandEvent(*this); }
1049 virtual wxEventCategory
GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT
; }
1052 wxString m_cmdString
; // String event argument
1054 long m_extraLong
; // Additional information (e.g. select/deselect)
1055 void* m_clientData
; // Arbitrary client data
1056 wxClientData
* m_clientObject
; // Arbitrary client object
1059 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCommandEvent
)
1062 // this class adds a possibility to react (from the user) code to a control
1063 // notification: allow or veto the operation being reported.
1064 class WXDLLIMPEXP_CORE wxNotifyEvent
: public wxCommandEvent
1067 wxNotifyEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0)
1068 : wxCommandEvent(commandType
, winid
)
1069 { m_bAllow
= true; }
1071 wxNotifyEvent(const wxNotifyEvent
& event
)
1072 : wxCommandEvent(event
)
1073 { m_bAllow
= event
.m_bAllow
; }
1075 // veto the operation (usually it's allowed by default)
1076 void Veto() { m_bAllow
= false; }
1078 // allow the operation if it was disabled by default
1079 void Allow() { m_bAllow
= true; }
1081 // for implementation code only: is the operation allowed?
1082 bool IsAllowed() const { return m_bAllow
; }
1084 virtual wxEvent
*Clone() const { return new wxNotifyEvent(*this); }
1090 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNotifyEvent
)
1096 class WXDLLIMPEXP_CORE wxThreadEvent
: public wxCommandEvent
1099 wxThreadEvent(wxEventType eventType
= wxEVT_COMMAND_THREAD
, int id
= wxID_ANY
)
1100 : wxCommandEvent(eventType
, id
)
1103 wxThreadEvent(const wxThreadEvent
& event
)
1104 : wxCommandEvent(event
)
1106 // make sure our string member (which uses COW, aka refcounting) is not
1107 // shared by other wxString instances:
1108 SetString(GetString().c_str());
1111 virtual wxEvent
*Clone() const
1113 wxThreadEvent
* ev
= new wxThreadEvent(*this);
1115 // make sure our string member (which uses COW, aka refcounting) is not
1116 // shared by other wxString instances:
1117 ev
->SetString(GetString().c_str());
1121 // this is important to avoid that calling wxEventLoopBase::YieldFor thread events
1122 // gets processed when this is unwanted:
1123 virtual wxEventCategory
GetEventCategory() const
1124 { return wxEVT_CATEGORY_THREAD
; }
1127 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxThreadEvent
)
1132 // Scroll event class, derived form wxCommandEvent. wxScrollEvents are
1133 // sent by wxSlider and wxScrollBar.
1138 wxEVT_SCROLL_LINEDOWN
1140 wxEVT_SCROLL_PAGEDOWN
1141 wxEVT_SCROLL_THUMBTRACK
1142 wxEVT_SCROLL_THUMBRELEASE
1143 wxEVT_SCROLL_CHANGED
1146 class WXDLLIMPEXP_CORE wxScrollEvent
: public wxCommandEvent
1149 wxScrollEvent(wxEventType commandType
= wxEVT_NULL
,
1150 int winid
= 0, int pos
= 0, int orient
= 0);
1152 int GetOrientation() const { return (int) m_extraLong
; }
1153 int GetPosition() const { return m_commandInt
; }
1154 void SetOrientation(int orient
) { m_extraLong
= (long) orient
; }
1155 void SetPosition(int pos
) { m_commandInt
= pos
; }
1157 virtual wxEvent
*Clone() const { return new wxScrollEvent(*this); }
1160 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollEvent
)
1163 // ScrollWin event class, derived fom wxEvent. wxScrollWinEvents
1164 // are sent by wxWindow.
1167 wxEVT_SCROLLWIN_BOTTOM
1168 wxEVT_SCROLLWIN_LINEUP
1169 wxEVT_SCROLLWIN_LINEDOWN
1170 wxEVT_SCROLLWIN_PAGEUP
1171 wxEVT_SCROLLWIN_PAGEDOWN
1172 wxEVT_SCROLLWIN_THUMBTRACK
1173 wxEVT_SCROLLWIN_THUMBRELEASE
1176 class WXDLLIMPEXP_CORE wxScrollWinEvent
: public wxEvent
1179 wxScrollWinEvent(wxEventType commandType
= wxEVT_NULL
,
1180 int pos
= 0, int orient
= 0);
1181 wxScrollWinEvent(const wxScrollWinEvent
& event
) : wxEvent(event
)
1182 { m_commandInt
= event
.m_commandInt
;
1183 m_extraLong
= event
.m_extraLong
; }
1185 int GetOrientation() const { return (int) m_extraLong
; }
1186 int GetPosition() const { return m_commandInt
; }
1187 void SetOrientation(int orient
) { m_extraLong
= (long) orient
; }
1188 void SetPosition(int pos
) { m_commandInt
= pos
; }
1190 virtual wxEvent
*Clone() const { return new wxScrollWinEvent(*this); }
1197 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollWinEvent
)
1202 // Mouse event class
1219 wxEVT_NC_MIDDLE_DOWN,
1221 wxEVT_NC_RIGHT_DOWN,
1224 wxEVT_NC_ENTER_WINDOW,
1225 wxEVT_NC_LEAVE_WINDOW,
1226 wxEVT_NC_LEFT_DCLICK,
1227 wxEVT_NC_MIDDLE_DCLICK,
1228 wxEVT_NC_RIGHT_DCLICK,
1231 // the symbolic names for the mouse buttons
1234 wxMOUSE_BTN_ANY
= -1,
1235 wxMOUSE_BTN_NONE
= 0,
1236 wxMOUSE_BTN_LEFT
= 1,
1237 wxMOUSE_BTN_MIDDLE
= 2,
1238 wxMOUSE_BTN_RIGHT
= 3,
1239 wxMOUSE_BTN_AUX1
= 4,
1240 wxMOUSE_BTN_AUX2
= 5,
1244 class WXDLLIMPEXP_CORE wxMouseEvent
: public wxEvent
,
1248 wxMouseEvent(wxEventType mouseType
= wxEVT_NULL
);
1249 wxMouseEvent(const wxMouseEvent
& event
)
1256 // Was it a button event? (*doesn't* mean: is any button *down*?)
1257 bool IsButton() const { return Button(wxMOUSE_BTN_ANY
); }
1259 // Was it a down event from this (or any) button?
1260 bool ButtonDown(int but
= wxMOUSE_BTN_ANY
) const;
1262 // Was it a dclick event from this (or any) button?
1263 bool ButtonDClick(int but
= wxMOUSE_BTN_ANY
) const;
1265 // Was it a up event from this (or any) button?
1266 bool ButtonUp(int but
= wxMOUSE_BTN_ANY
) const;
1268 // Was the given button?
1269 bool Button(int but
) const;
1271 // Was the given button in Down state?
1272 bool ButtonIsDown(int but
) const;
1274 // Get the button which is changing state (wxMOUSE_BTN_NONE if none)
1275 int GetButton() const;
1277 // Find which event was just generated
1278 bool LeftDown() const { return (m_eventType
== wxEVT_LEFT_DOWN
); }
1279 bool MiddleDown() const { return (m_eventType
== wxEVT_MIDDLE_DOWN
); }
1280 bool RightDown() const { return (m_eventType
== wxEVT_RIGHT_DOWN
); }
1281 bool Aux1Down() const { return (m_eventType
== wxEVT_AUX1_DOWN
); }
1282 bool Aux2Down() const { return (m_eventType
== wxEVT_AUX2_DOWN
); }
1284 bool LeftUp() const { return (m_eventType
== wxEVT_LEFT_UP
); }
1285 bool MiddleUp() const { return (m_eventType
== wxEVT_MIDDLE_UP
); }
1286 bool RightUp() const { return (m_eventType
== wxEVT_RIGHT_UP
); }
1287 bool Aux1Up() const { return (m_eventType
== wxEVT_AUX1_UP
); }
1288 bool Aux2Up() const { return (m_eventType
== wxEVT_AUX2_UP
); }
1290 bool LeftDClick() const { return (m_eventType
== wxEVT_LEFT_DCLICK
); }
1291 bool MiddleDClick() const { return (m_eventType
== wxEVT_MIDDLE_DCLICK
); }
1292 bool RightDClick() const { return (m_eventType
== wxEVT_RIGHT_DCLICK
); }
1293 bool Aux1DClick() const { return (m_eventType
== wxEVT_AUX1_UP
); }
1294 bool Aux2DClick() const { return (m_eventType
== wxEVT_AUX2_UP
); }
1296 // Find the current state of the mouse buttons (regardless
1297 // of current event type)
1298 bool LeftIsDown() const { return m_leftDown
; }
1299 bool MiddleIsDown() const { return m_middleDown
; }
1300 bool RightIsDown() const { return m_rightDown
; }
1301 bool Aux1IsDown() const { return m_aux1Down
; }
1302 bool Aux2IsDown() const { return m_aux2Down
; }
1304 // True if a button is down and the mouse is moving
1305 bool Dragging() const
1307 return (m_eventType
== wxEVT_MOTION
) && ButtonIsDown(wxMOUSE_BTN_ANY
);
1310 // True if the mouse is moving, and no button is down
1313 return (m_eventType
== wxEVT_MOTION
) && !ButtonIsDown(wxMOUSE_BTN_ANY
);
1316 // True if the mouse is just entering the window
1317 bool Entering() const { return (m_eventType
== wxEVT_ENTER_WINDOW
); }
1319 // True if the mouse is just leaving the window
1320 bool Leaving() const { return (m_eventType
== wxEVT_LEAVE_WINDOW
); }
1322 // Returns the number of mouse clicks associated with this event.
1323 int GetClickCount() const { return m_clickCount
; }
1326 // Find the position of the event
1327 void GetPosition(wxCoord
*xpos
, wxCoord
*ypos
) const
1335 void GetPosition(long *xpos
, long *ypos
) const
1343 // Find the position of the event
1344 wxPoint
GetPosition() const { return wxPoint(m_x
, m_y
); }
1346 // Find the logical position of the event given the DC
1347 wxPoint
GetLogicalPosition(const wxDC
& dc
) const;
1350 wxCoord
GetX() const { return m_x
; }
1353 wxCoord
GetY() const { return m_y
; }
1355 // Get wheel rotation, positive or negative indicates direction of
1356 // rotation. Current devices all send an event when rotation is equal to
1357 // +/-WheelDelta, but this allows for finer resolution devices to be
1358 // created in the future. Because of this you shouldn't assume that one
1359 // event is equal to 1 line or whatever, but you should be able to either
1360 // do partial line scrolling or wait until +/-WheelDelta rotation values
1361 // have been accumulated before scrolling.
1362 int GetWheelRotation() const { return m_wheelRotation
; }
1364 // Get wheel delta, normally 120. This is the threshold for action to be
1365 // taken, and one such action (for example, scrolling one increment)
1366 // should occur for each delta.
1367 int GetWheelDelta() const { return m_wheelDelta
; }
1369 // Gets the axis the wheel operation concerns, 0 being the y axis as on
1370 // most mouse wheels, 1 is the x axis for things like MightyMouse scrolls
1371 // or horizontal trackpad scrolling
1372 int GetWheelAxis() const { return m_wheelAxis
; }
1374 // Returns the configured number of lines (or whatever) to be scrolled per
1375 // wheel action. Defaults to one.
1376 int GetLinesPerAction() const { return m_linesPerAction
; }
1378 // Is the system set to do page scrolling?
1379 bool IsPageScroll() const { return ((unsigned int)m_linesPerAction
== UINT_MAX
); }
1381 virtual wxEvent
*Clone() const { return new wxMouseEvent(*this); }
1382 virtual wxEventCategory
GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT
; }
1384 wxMouseEvent
& operator=(const wxMouseEvent
& event
)
1403 int m_wheelRotation
;
1405 int m_linesPerAction
;
1408 void Assign(const wxMouseEvent
& evt
);
1411 DECLARE_DYNAMIC_CLASS(wxMouseEvent
)
1420 class WXDLLIMPEXP_CORE wxSetCursorEvent
: public wxEvent
1423 wxSetCursorEvent(wxCoord x
= 0, wxCoord y
= 0)
1424 : wxEvent(0, wxEVT_SET_CURSOR
),
1425 m_x(x
), m_y(y
), m_cursor()
1428 wxSetCursorEvent(const wxSetCursorEvent
& event
)
1432 m_cursor(event
.m_cursor
)
1435 wxCoord
GetX() const { return m_x
; }
1436 wxCoord
GetY() const { return m_y
; }
1438 void SetCursor(const wxCursor
& cursor
) { m_cursor
= cursor
; }
1439 const wxCursor
& GetCursor() const { return m_cursor
; }
1440 bool HasCursor() const { return m_cursor
.Ok(); }
1442 virtual wxEvent
*Clone() const { return new wxSetCursorEvent(*this); }
1449 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSetCursorEvent
)
1452 // Keyboard input event class
1462 class WXDLLIMPEXP_CORE wxKeyEvent
: public wxEvent
,
1463 public wxKeyboardState
1466 wxKeyEvent(wxEventType keyType
= wxEVT_NULL
);
1467 wxKeyEvent(const wxKeyEvent
& evt
);
1469 // get the key code: an ASCII7 char or an element of wxKeyCode enum
1470 int GetKeyCode() const { return (int)m_keyCode
; }
1473 // get the Unicode character corresponding to this key
1474 wxChar
GetUnicodeKey() const { return m_uniChar
; }
1475 #endif // wxUSE_UNICODE
1477 // get the raw key code (platform-dependent)
1478 wxUint32
GetRawKeyCode() const { return m_rawCode
; }
1480 // get the raw key flags (platform-dependent)
1481 wxUint32
GetRawKeyFlags() const { return m_rawFlags
; }
1483 // Find the position of the event
1484 void GetPosition(wxCoord
*xpos
, wxCoord
*ypos
) const
1486 if (xpos
) *xpos
= m_x
;
1487 if (ypos
) *ypos
= m_y
;
1490 void GetPosition(long *xpos
, long *ypos
) const
1492 if (xpos
) *xpos
= (long)m_x
;
1493 if (ypos
) *ypos
= (long)m_y
;
1496 wxPoint
GetPosition() const
1497 { return wxPoint(m_x
, m_y
); }
1500 wxCoord
GetX() const { return m_x
; }
1503 wxCoord
GetY() const { return m_y
; }
1505 virtual wxEvent
*Clone() const { return new wxKeyEvent(*this); }
1506 virtual wxEventCategory
GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT
; }
1508 // we do need to copy wxKeyEvent sometimes (in wxTreeCtrl code, for
1510 wxKeyEvent
& operator=(const wxKeyEvent
& evt
)
1514 wxEvent
::operator=(evt
);
1516 // Borland C++ 5.82 doesn't compile an explicit call to an
1517 // implicitly defined operator=() so need to do it this way:
1518 *static_cast<wxKeyboardState
*>(this) = evt
;
1523 m_keyCode
= evt
.m_keyCode
;
1525 m_rawCode
= evt
.m_rawCode
;
1526 m_rawFlags
= evt
.m_rawFlags
;
1528 m_uniChar
= evt
.m_uniChar
;
1540 // This contains the full Unicode character
1541 // in a character events in Unicode mode
1545 // these fields contain the platform-specific information about
1546 // key that was pressed
1548 wxUint32 m_rawFlags
;
1551 DECLARE_DYNAMIC_CLASS(wxKeyEvent
)
1559 class WXDLLIMPEXP_CORE wxSizeEvent
: public wxEvent
1562 wxSizeEvent() : wxEvent(0, wxEVT_SIZE
)
1564 wxSizeEvent(const wxSize
& sz
, int winid
= 0)
1565 : wxEvent(winid
, wxEVT_SIZE
),
1568 wxSizeEvent(const wxSizeEvent
& event
)
1570 m_size(event
.m_size
), m_rect(event
.m_rect
)
1572 wxSizeEvent(const wxRect
& rect
, int id
= 0)
1573 : m_size(rect
.GetSize()), m_rect(rect
)
1574 { m_eventType
= wxEVT_SIZING
; m_id
= id
; }
1576 wxSize
GetSize() const { return m_size
; }
1577 wxRect
GetRect() const { return m_rect
; }
1578 void SetRect(const wxRect
& rect
) { m_rect
= rect
; }
1580 virtual wxEvent
*Clone() const { return new wxSizeEvent(*this); }
1583 // For internal usage only. Will be converted to protected members.
1585 wxRect m_rect
; // Used for wxEVT_SIZING
1588 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSizeEvent
)
1597 class WXDLLIMPEXP_CORE wxMoveEvent
: public wxEvent
1601 : wxEvent(0, wxEVT_MOVE
)
1603 wxMoveEvent(const wxPoint
& pos
, int winid
= 0)
1604 : wxEvent(winid
, wxEVT_MOVE
),
1607 wxMoveEvent(const wxMoveEvent
& event
)
1611 wxMoveEvent(const wxRect
& rect
, int id
= 0)
1612 : m_pos(rect
.GetPosition()), m_rect(rect
)
1613 { m_eventType
= wxEVT_MOVING
; m_id
= id
; }
1615 wxPoint
GetPosition() const { return m_pos
; }
1616 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
1617 wxRect
GetRect() const { return m_rect
; }
1618 void SetRect(const wxRect
& rect
) { m_rect
= rect
; }
1620 virtual wxEvent
*Clone() const { return new wxMoveEvent(*this); }
1627 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMoveEvent
)
1630 // Paint event class
1637 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1638 // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined
1639 extern WXDLLIMPEXP_CORE
int g_isPainting
;
1642 class WXDLLIMPEXP_CORE wxPaintEvent
: public wxEvent
1645 wxPaintEvent(int Id
= 0)
1646 : wxEvent(Id
, wxEVT_PAINT
)
1648 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1649 // set the internal flag for the duration of processing of WM_PAINT
1654 // default copy ctor and dtor are normally fine, we only need them to keep
1655 // g_isPainting updated in debug build
1656 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1657 wxPaintEvent(const wxPaintEvent
& event
)
1663 virtual ~wxPaintEvent()
1669 virtual wxEvent
*Clone() const { return new wxPaintEvent(*this); }
1672 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaintEvent
)
1675 class WXDLLIMPEXP_CORE wxNcPaintEvent
: public wxEvent
1678 wxNcPaintEvent(int winid
= 0)
1679 : wxEvent(winid
, wxEVT_NC_PAINT
)
1682 virtual wxEvent
*Clone() const { return new wxNcPaintEvent(*this); }
1685 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNcPaintEvent
)
1688 // Erase background event class
1690 wxEVT_ERASE_BACKGROUND
1693 class WXDLLIMPEXP_CORE wxEraseEvent
: public wxEvent
1696 wxEraseEvent(int Id
= 0, wxDC
*dc
= NULL
)
1697 : wxEvent(Id
, wxEVT_ERASE_BACKGROUND
),
1701 wxEraseEvent(const wxEraseEvent
& event
)
1706 wxDC
*GetDC() const { return m_dc
; }
1708 virtual wxEvent
*Clone() const { return new wxEraseEvent(*this); }
1714 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxEraseEvent
)
1717 // Focus event class
1723 class WXDLLIMPEXP_CORE wxFocusEvent
: public wxEvent
1726 wxFocusEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0)
1727 : wxEvent(winid
, type
)
1730 wxFocusEvent(const wxFocusEvent
& event
)
1732 { m_win
= event
.m_win
; }
1734 // The window associated with this event is the window which had focus
1735 // before for SET event and the window which will have focus for the KILL
1736 // one. NB: it may be NULL in both cases!
1737 wxWindow
*GetWindow() const { return m_win
; }
1738 void SetWindow(wxWindow
*win
) { m_win
= win
; }
1740 virtual wxEvent
*Clone() const { return new wxFocusEvent(*this); }
1746 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFocusEvent
)
1749 // wxChildFocusEvent notifies the parent that a child has got the focus: unlike
1750 // wxFocusEvent it is propagated upwards the window chain
1751 class WXDLLIMPEXP_CORE wxChildFocusEvent
: public wxCommandEvent
1754 wxChildFocusEvent(wxWindow
*win
= NULL
);
1756 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
1758 virtual wxEvent
*Clone() const { return new wxChildFocusEvent(*this); }
1761 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxChildFocusEvent
)
1764 // Activate event class
1771 class WXDLLIMPEXP_CORE wxActivateEvent
: public wxEvent
1774 wxActivateEvent(wxEventType type
= wxEVT_NULL
, bool active
= true, int Id
= 0)
1776 { m_active
= active
; }
1777 wxActivateEvent(const wxActivateEvent
& event
)
1779 { m_active
= event
.m_active
; }
1781 bool GetActive() const { return m_active
; }
1783 virtual wxEvent
*Clone() const { return new wxActivateEvent(*this); }
1789 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxActivateEvent
)
1792 // InitDialog event class
1797 class WXDLLIMPEXP_CORE wxInitDialogEvent
: public wxEvent
1800 wxInitDialogEvent(int Id
= 0)
1801 : wxEvent(Id
, wxEVT_INIT_DIALOG
)
1804 virtual wxEvent
*Clone() const { return new wxInitDialogEvent(*this); }
1807 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxInitDialogEvent
)
1810 // Miscellaneous menu event class
1814 wxEVT_MENU_HIGHLIGHT,
1817 class WXDLLIMPEXP_CORE wxMenuEvent
: public wxEvent
1820 wxMenuEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0, wxMenu
* menu
= NULL
)
1821 : wxEvent(winid
, type
)
1822 { m_menuId
= winid
; m_menu
= menu
; }
1823 wxMenuEvent(const wxMenuEvent
& event
)
1825 { m_menuId
= event
.m_menuId
; m_menu
= event
.m_menu
; }
1827 // only for wxEVT_MENU_HIGHLIGHT
1828 int GetMenuId() const { return m_menuId
; }
1830 // only for wxEVT_MENU_OPEN/CLOSE
1831 bool IsPopup() const { return m_menuId
== wxID_ANY
; }
1833 // only for wxEVT_MENU_OPEN/CLOSE
1834 wxMenu
* GetMenu() const { return m_menu
; }
1836 virtual wxEvent
*Clone() const { return new wxMenuEvent(*this); }
1842 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMenuEvent
)
1845 // Window close or session close event class
1849 wxEVT_QUERY_END_SESSION
1852 class WXDLLIMPEXP_CORE wxCloseEvent
: public wxEvent
1855 wxCloseEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0)
1856 : wxEvent(winid
, type
),
1858 m_veto(false), // should be false by default
1861 wxCloseEvent(const wxCloseEvent
& event
)
1863 m_loggingOff(event
.m_loggingOff
),
1864 m_veto(event
.m_veto
),
1865 m_canVeto(event
.m_canVeto
) {}
1867 void SetLoggingOff(bool logOff
) { m_loggingOff
= logOff
; }
1868 bool GetLoggingOff() const
1870 // m_loggingOff flag is only used by wxEVT_[QUERY_]END_SESSION, it
1871 // doesn't make sense for wxEVT_CLOSE_WINDOW
1872 wxASSERT_MSG( m_eventType
!= wxEVT_CLOSE_WINDOW
,
1873 _T("this flag is for end session events only") );
1875 return m_loggingOff
;
1878 void Veto(bool veto
= true)
1880 // GetVeto() will return false anyhow...
1881 wxCHECK_RET( m_canVeto
,
1882 wxT("call to Veto() ignored (can't veto this event)") );
1886 void SetCanVeto(bool canVeto
) { m_canVeto
= canVeto
; }
1887 bool CanVeto() const { return m_canVeto
; }
1888 bool GetVeto() const { return m_canVeto
&& m_veto
; }
1890 virtual wxEvent
*Clone() const { return new wxCloseEvent(*this); }
1898 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCloseEvent
)
1905 class WXDLLIMPEXP_CORE wxShowEvent
: public wxEvent
1908 wxShowEvent(int winid
= 0, bool show
= false)
1909 : wxEvent(winid
, wxEVT_SHOW
)
1911 wxShowEvent(const wxShowEvent
& event
)
1913 { m_show
= event
.m_show
; }
1915 void SetShow(bool show
) { m_show
= show
; }
1917 // return true if the window was shown, false if hidden
1918 bool IsShown() const { return m_show
; }
1920 #if WXWIN_COMPATIBILITY_2_8
1921 wxDEPRECATED( bool GetShow() const { return IsShown(); } )
1924 virtual wxEvent
*Clone() const { return new wxShowEvent(*this); }
1930 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxShowEvent
)
1937 class WXDLLIMPEXP_CORE wxIconizeEvent
: public wxEvent
1940 wxIconizeEvent(int winid
= 0, bool iconized
= true)
1941 : wxEvent(winid
, wxEVT_ICONIZE
)
1942 { m_iconized
= iconized
; }
1943 wxIconizeEvent(const wxIconizeEvent
& event
)
1945 { m_iconized
= event
.m_iconized
; }
1947 #if WXWIN_COMPATIBILITY_2_8
1948 wxDEPRECATED( bool Iconized() const { return IsIconized(); } )
1950 // return true if the frame was iconized, false if restored
1951 bool IsIconized() const { return m_iconized
; }
1953 virtual wxEvent
*Clone() const { return new wxIconizeEvent(*this); }
1959 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIconizeEvent
)
1965 class WXDLLIMPEXP_CORE wxMaximizeEvent
: public wxEvent
1968 wxMaximizeEvent(int winid
= 0)
1969 : wxEvent(winid
, wxEVT_MAXIMIZE
)
1972 virtual wxEvent
*Clone() const { return new wxMaximizeEvent(*this); }
1975 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMaximizeEvent
)
1978 // Joystick event class
1980 wxEVT_JOY_BUTTON_DOWN,
1981 wxEVT_JOY_BUTTON_UP,
1986 // Which joystick? Same as Windows ids so no conversion necessary.
1993 // Which button is down?
1996 wxJOY_BUTTON_ANY
= -1,
2003 class WXDLLIMPEXP_CORE wxJoystickEvent
: public wxEvent
2008 int m_buttonChange
; // Which button changed?
2009 int m_buttonState
; // Which buttons are down?
2010 int m_joyStick
; // Which joystick?
2013 wxJoystickEvent(wxEventType type
= wxEVT_NULL
,
2015 int joystick
= wxJOYSTICK1
,
2020 m_buttonChange(change
),
2021 m_buttonState(state
),
2022 m_joyStick(joystick
)
2025 wxJoystickEvent(const wxJoystickEvent
& event
)
2028 m_zPosition(event
.m_zPosition
),
2029 m_buttonChange(event
.m_buttonChange
),
2030 m_buttonState(event
.m_buttonState
),
2031 m_joyStick(event
.m_joyStick
)
2034 wxPoint
GetPosition() const { return m_pos
; }
2035 int GetZPosition() const { return m_zPosition
; }
2036 int GetButtonState() const { return m_buttonState
; }
2037 int GetButtonChange() const { return m_buttonChange
; }
2038 int GetJoystick() const { return m_joyStick
; }
2040 void SetJoystick(int stick
) { m_joyStick
= stick
; }
2041 void SetButtonState(int state
) { m_buttonState
= state
; }
2042 void SetButtonChange(int change
) { m_buttonChange
= change
; }
2043 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2044 void SetZPosition(int zPos
) { m_zPosition
= zPos
; }
2046 // Was it a button event? (*doesn't* mean: is any button *down*?)
2047 bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN
) ||
2048 (GetEventType() == wxEVT_JOY_BUTTON_UP
)); }
2050 // Was it a move event?
2051 bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE
); }
2053 // Was it a zmove event?
2054 bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE
); }
2056 // Was it a down event from button 1, 2, 3, 4 or any?
2057 bool ButtonDown(int but
= wxJOY_BUTTON_ANY
) const
2058 { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN
) &&
2059 ((but
== wxJOY_BUTTON_ANY
) || (but
== m_buttonChange
))); }
2061 // Was it a up event from button 1, 2, 3 or any?
2062 bool ButtonUp(int but
= wxJOY_BUTTON_ANY
) const
2063 { return ((GetEventType() == wxEVT_JOY_BUTTON_UP
) &&
2064 ((but
== wxJOY_BUTTON_ANY
) || (but
== m_buttonChange
))); }
2066 // Was the given button 1,2,3,4 or any in Down state?
2067 bool ButtonIsDown(int but
= wxJOY_BUTTON_ANY
) const
2068 { return (((but
== wxJOY_BUTTON_ANY
) && (m_buttonState
!= 0)) ||
2069 ((m_buttonState
& but
) == but
)); }
2071 virtual wxEvent
*Clone() const { return new wxJoystickEvent(*this); }
2074 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxJoystickEvent
)
2077 // Drop files event class
2082 class WXDLLIMPEXP_CORE wxDropFilesEvent
: public wxEvent
2089 wxDropFilesEvent(wxEventType type
= wxEVT_NULL
,
2091 wxString
*files
= NULL
)
2098 // we need a copy ctor to avoid deleting m_files pointer twice
2099 wxDropFilesEvent(const wxDropFilesEvent
& other
)
2101 m_noFiles(other
.m_noFiles
),
2105 m_files
= new wxString
[m_noFiles
];
2106 for ( int n
= 0; n
< m_noFiles
; n
++ )
2108 m_files
[n
] = other
.m_files
[n
];
2112 virtual ~wxDropFilesEvent()
2117 wxPoint
GetPosition() const { return m_pos
; }
2118 int GetNumberOfFiles() const { return m_noFiles
; }
2119 wxString
*GetFiles() const { return m_files
; }
2121 virtual wxEvent
*Clone() const { return new wxDropFilesEvent(*this); }
2124 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDropFilesEvent
)
2132 // Whether to always send update events to windows, or
2133 // to only send update events to those with the
2134 // wxWS_EX_PROCESS_UI_UPDATES style.
2138 // Send UI update events to all windows
2139 wxUPDATE_UI_PROCESS_ALL
,
2141 // Send UI update events to windows that have
2142 // the wxWS_EX_PROCESS_UI_UPDATES flag specified
2143 wxUPDATE_UI_PROCESS_SPECIFIED
2146 class WXDLLIMPEXP_CORE wxUpdateUIEvent
: public wxCommandEvent
2149 wxUpdateUIEvent(wxWindowID commandId
= 0)
2150 : wxCommandEvent(wxEVT_UPDATE_UI
, commandId
)
2158 m_setChecked
= false;
2160 wxUpdateUIEvent(const wxUpdateUIEvent
& event
)
2161 : wxCommandEvent(event
),
2162 m_checked(event
.m_checked
),
2163 m_enabled(event
.m_enabled
),
2164 m_shown(event
.m_shown
),
2165 m_setEnabled(event
.m_setEnabled
),
2166 m_setShown(event
.m_setShown
),
2167 m_setText(event
.m_setText
),
2168 m_setChecked(event
.m_setChecked
),
2169 m_text(event
.m_text
)
2172 bool GetChecked() const { return m_checked
; }
2173 bool GetEnabled() const { return m_enabled
; }
2174 bool GetShown() const { return m_shown
; }
2175 wxString
GetText() const { return m_text
; }
2176 bool GetSetText() const { return m_setText
; }
2177 bool GetSetChecked() const { return m_setChecked
; }
2178 bool GetSetEnabled() const { return m_setEnabled
; }
2179 bool GetSetShown() const { return m_setShown
; }
2181 void Check(bool check
) { m_checked
= check
; m_setChecked
= true; }
2182 void Enable(bool enable
) { m_enabled
= enable
; m_setEnabled
= true; }
2183 void Show(bool show
) { m_shown
= show
; m_setShown
= true; }
2184 void SetText(const wxString
& text
) { m_text
= text
; m_setText
= true; }
2186 // Sets the interval between updates in milliseconds.
2187 // Set to -1 to disable updates, or to 0 to update as frequently as possible.
2188 static void SetUpdateInterval(long updateInterval
) { sm_updateInterval
= updateInterval
; }
2190 // Returns the current interval between updates in milliseconds
2191 static long GetUpdateInterval() { return sm_updateInterval
; }
2193 // Can we update this window?
2194 static bool CanUpdate(wxWindowBase
*win
);
2196 // Reset the update time to provide a delay until the next
2197 // time we should update
2198 static void ResetUpdateTime();
2200 // Specify how wxWidgets will send update events: to
2201 // all windows, or only to those which specify that they
2202 // will process the events.
2203 static void SetMode(wxUpdateUIMode mode
) { sm_updateMode
= mode
; }
2205 // Returns the UI update mode
2206 static wxUpdateUIMode
GetMode() { return sm_updateMode
; }
2208 virtual wxEvent
*Clone() const { return new wxUpdateUIEvent(*this); }
2220 static wxLongLong sm_lastUpdate
;
2222 static long sm_updateInterval
;
2223 static wxUpdateUIMode sm_updateMode
;
2226 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxUpdateUIEvent
)
2230 wxEVT_SYS_COLOUR_CHANGED
2233 // TODO: shouldn't all events record the window ID?
2234 class WXDLLIMPEXP_CORE wxSysColourChangedEvent
: public wxEvent
2237 wxSysColourChangedEvent()
2238 : wxEvent(0, wxEVT_SYS_COLOUR_CHANGED
)
2241 virtual wxEvent
*Clone() const { return new wxSysColourChangedEvent(*this); }
2244 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSysColourChangedEvent
)
2248 wxEVT_MOUSE_CAPTURE_CHANGED
2249 The window losing the capture receives this message
2250 (even if it released the capture itself).
2253 class WXDLLIMPEXP_CORE wxMouseCaptureChangedEvent
: public wxEvent
2256 wxMouseCaptureChangedEvent(wxWindowID winid
= 0, wxWindow
* gainedCapture
= NULL
)
2257 : wxEvent(winid
, wxEVT_MOUSE_CAPTURE_CHANGED
),
2258 m_gainedCapture(gainedCapture
)
2261 wxMouseCaptureChangedEvent(const wxMouseCaptureChangedEvent
& event
)
2263 m_gainedCapture(event
.m_gainedCapture
)
2266 virtual wxEvent
*Clone() const { return new wxMouseCaptureChangedEvent(*this); }
2268 wxWindow
* GetCapturedWindow() const { return m_gainedCapture
; }
2271 wxWindow
* m_gainedCapture
;
2273 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureChangedEvent
)
2277 wxEVT_MOUSE_CAPTURE_LOST
2278 The window losing the capture receives this message, unless it released it
2279 it itself or unless wxWindow::CaptureMouse was called on another window
2280 (and so capture will be restored when the new capturer releases it).
2283 class WXDLLIMPEXP_CORE wxMouseCaptureLostEvent
: public wxEvent
2286 wxMouseCaptureLostEvent(wxWindowID winid
= 0)
2287 : wxEvent(winid
, wxEVT_MOUSE_CAPTURE_LOST
)
2290 wxMouseCaptureLostEvent(const wxMouseCaptureLostEvent
& event
)
2294 virtual wxEvent
*Clone() const { return new wxMouseCaptureLostEvent(*this); }
2296 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureLostEvent
)
2300 wxEVT_DISPLAY_CHANGED
2302 class WXDLLIMPEXP_CORE wxDisplayChangedEvent
: public wxEvent
2305 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDisplayChangedEvent
)
2308 wxDisplayChangedEvent()
2309 : wxEvent(0, wxEVT_DISPLAY_CHANGED
)
2312 virtual wxEvent
*Clone() const { return new wxDisplayChangedEvent(*this); }
2316 wxEVT_PALETTE_CHANGED
2319 class WXDLLIMPEXP_CORE wxPaletteChangedEvent
: public wxEvent
2322 wxPaletteChangedEvent(wxWindowID winid
= 0)
2323 : wxEvent(winid
, wxEVT_PALETTE_CHANGED
),
2324 m_changedWindow(NULL
)
2327 wxPaletteChangedEvent(const wxPaletteChangedEvent
& event
)
2329 m_changedWindow(event
.m_changedWindow
)
2332 void SetChangedWindow(wxWindow
* win
) { m_changedWindow
= win
; }
2333 wxWindow
* GetChangedWindow() const { return m_changedWindow
; }
2335 virtual wxEvent
*Clone() const { return new wxPaletteChangedEvent(*this); }
2338 wxWindow
* m_changedWindow
;
2341 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaletteChangedEvent
)
2345 wxEVT_QUERY_NEW_PALETTE
2346 Indicates the window is getting keyboard focus and should re-do its palette.
2349 class WXDLLIMPEXP_CORE wxQueryNewPaletteEvent
: public wxEvent
2352 wxQueryNewPaletteEvent(wxWindowID winid
= 0)
2353 : wxEvent(winid
, wxEVT_QUERY_NEW_PALETTE
),
2354 m_paletteRealized(false)
2356 wxQueryNewPaletteEvent(const wxQueryNewPaletteEvent
& event
)
2358 m_paletteRealized(event
.m_paletteRealized
)
2361 // App sets this if it changes the palette.
2362 void SetPaletteRealized(bool realized
) { m_paletteRealized
= realized
; }
2363 bool GetPaletteRealized() const { return m_paletteRealized
; }
2365 virtual wxEvent
*Clone() const { return new wxQueryNewPaletteEvent(*this); }
2368 bool m_paletteRealized
;
2371 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxQueryNewPaletteEvent
)
2375 Event generated by dialog navigation keys
2376 wxEVT_NAVIGATION_KEY
2378 // NB: don't derive from command event to avoid being propagated to the parent
2379 class WXDLLIMPEXP_CORE wxNavigationKeyEvent
: public wxEvent
2382 wxNavigationKeyEvent()
2383 : wxEvent(0, wxEVT_NAVIGATION_KEY
),
2384 m_flags(IsForward
| FromTab
), // defaults are for TAB
2387 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
2390 wxNavigationKeyEvent(const wxNavigationKeyEvent
& event
)
2392 m_flags(event
.m_flags
),
2393 m_focus(event
.m_focus
)
2396 // direction: forward (true) or backward (false)
2397 bool GetDirection() const
2398 { return (m_flags
& IsForward
) != 0; }
2399 void SetDirection(bool bForward
)
2400 { if ( bForward
) m_flags
|= IsForward
; else m_flags
&= ~IsForward
; }
2402 // it may be a window change event (MDI, notebook pages...) or a control
2404 bool IsWindowChange() const
2405 { return (m_flags
& WinChange
) != 0; }
2406 void SetWindowChange(bool bIs
)
2407 { if ( bIs
) m_flags
|= WinChange
; else m_flags
&= ~WinChange
; }
2409 // Set to true under MSW if the event was generated using the tab key.
2410 // This is required for proper navogation over radio buttons
2411 bool IsFromTab() const
2412 { return (m_flags
& FromTab
) != 0; }
2413 void SetFromTab(bool bIs
)
2414 { if ( bIs
) m_flags
|= FromTab
; else m_flags
&= ~FromTab
; }
2416 // the child which has the focus currently (may be NULL - use
2417 // wxWindow::FindFocus then)
2418 wxWindow
* GetCurrentFocus() const { return m_focus
; }
2419 void SetCurrentFocus(wxWindow
*win
) { m_focus
= win
; }
2422 void SetFlags(long flags
) { m_flags
= flags
; }
2424 virtual wxEvent
*Clone() const { return new wxNavigationKeyEvent(*this); }
2426 enum wxNavigationKeyEventFlags
2428 IsBackward
= 0x0000,
2438 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNavigationKeyEvent
)
2441 // Window creation/destruction events: the first is sent as soon as window is
2442 // created (i.e. the underlying GUI object exists), but when the C++ object is
2443 // fully initialized (so virtual functions may be called). The second,
2444 // wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
2445 // still safe to call virtual functions at this moment
2451 class WXDLLIMPEXP_CORE wxWindowCreateEvent
: public wxCommandEvent
2454 wxWindowCreateEvent(wxWindow
*win
= NULL
);
2456 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
2458 virtual wxEvent
*Clone() const { return new wxWindowCreateEvent(*this); }
2461 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowCreateEvent
)
2464 class WXDLLIMPEXP_CORE wxWindowDestroyEvent
: public wxCommandEvent
2467 wxWindowDestroyEvent(wxWindow
*win
= NULL
);
2469 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
2471 virtual wxEvent
*Clone() const { return new wxWindowDestroyEvent(*this); }
2474 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowDestroyEvent
)
2477 // A help event is sent when the user clicks on a window in context-help mode.
2483 class WXDLLIMPEXP_CORE wxHelpEvent
: public wxCommandEvent
2486 // how was this help event generated?
2489 Origin_Unknown
, // unrecognized event source
2490 Origin_Keyboard
, // event generated from F1 key press
2491 Origin_HelpButton
// event from [?] button on the title bar (Windows)
2494 wxHelpEvent(wxEventType type
= wxEVT_NULL
,
2495 wxWindowID winid
= 0,
2496 const wxPoint
& pt
= wxDefaultPosition
,
2497 Origin origin
= Origin_Unknown
)
2498 : wxCommandEvent(type
, winid
),
2500 m_origin(GuessOrigin(origin
))
2502 wxHelpEvent(const wxHelpEvent
& event
)
2503 : wxCommandEvent(event
),
2505 m_target(event
.m_target
),
2506 m_link(event
.m_link
),
2507 m_origin(event
.m_origin
)
2510 // Position of event (in screen coordinates)
2511 const wxPoint
& GetPosition() const { return m_pos
; }
2512 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2514 // Optional link to further help
2515 const wxString
& GetLink() const { return m_link
; }
2516 void SetLink(const wxString
& link
) { m_link
= link
; }
2518 // Optional target to display help in. E.g. a window specification
2519 const wxString
& GetTarget() const { return m_target
; }
2520 void SetTarget(const wxString
& target
) { m_target
= target
; }
2522 virtual wxEvent
*Clone() const { return new wxHelpEvent(*this); }
2524 // optional indication of the event source
2525 Origin
GetOrigin() const { return m_origin
; }
2526 void SetOrigin(Origin origin
) { m_origin
= origin
; }
2534 // we can try to guess the event origin ourselves, even if none is
2535 // specified in the ctor
2536 static Origin
GuessOrigin(Origin origin
);
2539 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHelpEvent
)
2542 // A Clipboard Text event is sent when a window intercepts text copy/cut/paste
2543 // message, i.e. the user has cut/copied/pasted data from/into a text control
2544 // via ctrl-C/X/V, ctrl/shift-del/insert, a popup menu command, etc.
2545 // NOTE : under windows these events are *NOT* generated automatically
2546 // for a Rich Edit text control.
2548 wxEVT_COMMAND_TEXT_COPY
2549 wxEVT_COMMAND_TEXT_CUT
2550 wxEVT_COMMAND_TEXT_PASTE
2553 class WXDLLIMPEXP_CORE wxClipboardTextEvent
: public wxCommandEvent
2556 wxClipboardTextEvent(wxEventType type
= wxEVT_NULL
,
2557 wxWindowID winid
= 0)
2558 : wxCommandEvent(type
, winid
)
2560 wxClipboardTextEvent(const wxClipboardTextEvent
& event
)
2561 : wxCommandEvent(event
)
2564 virtual wxEvent
*Clone() const { return new wxClipboardTextEvent(*this); }
2567 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxClipboardTextEvent
)
2570 // A Context event is sent when the user right clicks on a window or
2571 // presses Shift-F10
2572 // NOTE : Under windows this is a repackaged WM_CONTETXMENU message
2573 // Under other systems it may have to be generated from a right click event
2578 class WXDLLIMPEXP_CORE wxContextMenuEvent
: public wxCommandEvent
2581 wxContextMenuEvent(wxEventType type
= wxEVT_NULL
,
2582 wxWindowID winid
= 0,
2583 const wxPoint
& pt
= wxDefaultPosition
)
2584 : wxCommandEvent(type
, winid
),
2587 wxContextMenuEvent(const wxContextMenuEvent
& event
)
2588 : wxCommandEvent(event
),
2592 // Position of event (in screen coordinates)
2593 const wxPoint
& GetPosition() const { return m_pos
; }
2594 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2596 virtual wxEvent
*Clone() const { return new wxContextMenuEvent(*this); }
2602 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxContextMenuEvent
)
2612 // Whether to always send idle events to windows, or
2613 // to only send update events to those with the
2614 // wxWS_EX_PROCESS_IDLE style.
2618 // Send idle events to all windows
2621 // Send idle events to windows that have
2622 // the wxWS_EX_PROCESS_IDLE flag specified
2623 wxIDLE_PROCESS_SPECIFIED
2626 class WXDLLIMPEXP_BASE wxIdleEvent
: public wxEvent
2630 : wxEvent(0, wxEVT_IDLE
),
2631 m_requestMore(false)
2633 wxIdleEvent(const wxIdleEvent
& event
)
2635 m_requestMore(event
.m_requestMore
)
2638 void RequestMore(bool needMore
= true) { m_requestMore
= needMore
; }
2639 bool MoreRequested() const { return m_requestMore
; }
2641 virtual wxEvent
*Clone() const { return new wxIdleEvent(*this); }
2643 // Specify how wxWidgets will send idle events: to
2644 // all windows, or only to those which specify that they
2645 // will process the events.
2646 static void SetMode(wxIdleMode mode
) { sm_idleMode
= mode
; }
2648 // Returns the idle event mode
2649 static wxIdleMode
GetMode() { return sm_idleMode
; }
2653 static wxIdleMode sm_idleMode
;
2656 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIdleEvent
)
2660 wxEVT_MOUSE_CAPTURE_CHANGED,
2661 wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
2662 // wxEVT_FONT_CHANGED, // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
2663 // wxEVT_FONT_CHANGED to all other windows (maybe).
2664 wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
2671 // ============================================================================
2672 // event handler and related classes
2673 // ============================================================================
2676 // struct containing the members common to static and dynamic event tables
2678 struct WXDLLIMPEXP_BASE wxEventTableEntryBase
2680 wxEventTableEntryBase(int winid
, int idLast
,
2681 wxEventFunctor
* fn
, wxObject
*data
)
2685 m_callbackUserData(data
)
2688 wxEventTableEntryBase( const wxEventTableEntryBase
&entry
)
2689 : m_id( entry
.m_id
),
2690 m_lastId( entry
.m_lastId
),
2692 m_callbackUserData( entry
.m_callbackUserData
)
2694 // This is a 'hack' to ensure that only one instance tries to delete
2695 // the functor pointer. It is safe as long as the only place where the
2696 // copy constructor is being called is when the static event tables are
2697 // being initialized (a temporary instance is created and then this
2698 // constructor is called).
2700 const_cast<wxEventTableEntryBase
&>( entry
).m_fn
= NULL
;
2703 ~wxEventTableEntryBase()
2708 // the range of ids for this entry: if m_lastId == wxID_ANY, the range
2709 // consists only of m_id, otherwise it is m_id..m_lastId inclusive
2713 // function/method/functor to call
2714 wxEventFunctor
* m_fn
;
2716 // arbitrary user data associated with the callback
2717 wxObject
* m_callbackUserData
;
2720 wxDECLARE_NO_ASSIGN_CLASS(wxEventTableEntryBase
);
2723 // an entry from a static event table
2724 struct WXDLLIMPEXP_BASE wxEventTableEntry
: public wxEventTableEntryBase
2726 wxEventTableEntry(const int& evType
, int winid
, int idLast
,
2727 wxEventFunctor
* fn
, wxObject
*data
)
2728 : wxEventTableEntryBase(winid
, idLast
, fn
, data
),
2732 // the reference to event type: this allows us to not care about the
2733 // (undefined) order in which the event table entries and the event types
2734 // are initialized: initially the value of this reference might be
2735 // invalid, but by the time it is used for the first time, all global
2736 // objects will have been initialized (including the event type constants)
2737 // and so it will have the correct value when it is needed
2738 const int& m_eventType
;
2741 wxDECLARE_NO_ASSIGN_CLASS(wxEventTableEntry
);
2744 // an entry used in dynamic event table managed by wxEvtHandler::Connect()
2745 struct WXDLLIMPEXP_BASE wxDynamicEventTableEntry
: public wxEventTableEntryBase
2747 wxDynamicEventTableEntry(int evType
, int winid
, int idLast
,
2748 wxEventFunctor
* fn
, wxObject
*data
)
2749 : wxEventTableEntryBase(winid
, idLast
, fn
, data
),
2753 // not a reference here as we can't keep a reference to a temporary int
2754 // created to wrap the constant value typically passed to Connect() - nor
2759 wxDECLARE_NO_ASSIGN_CLASS(wxDynamicEventTableEntry
);
2762 // ----------------------------------------------------------------------------
2763 // wxEventTable: an array of event entries terminated with {0, 0, 0, 0, 0}
2764 // ----------------------------------------------------------------------------
2766 struct WXDLLIMPEXP_BASE wxEventTable
2768 const wxEventTable
*baseTable
; // base event table (next in chain)
2769 const wxEventTableEntry
*entries
; // bottom of entry array
2772 // ----------------------------------------------------------------------------
2773 // wxEventHashTable: a helper of wxEvtHandler to speed up wxEventTable lookups.
2774 // ----------------------------------------------------------------------------
2776 WX_DEFINE_ARRAY_PTR(const wxEventTableEntry
*, wxEventTableEntryPointerArray
);
2778 class WXDLLIMPEXP_BASE wxEventHashTable
2781 // Internal data structs
2782 struct EventTypeTable
2784 wxEventType eventType
;
2785 wxEventTableEntryPointerArray eventEntryTable
;
2787 typedef EventTypeTable
* EventTypeTablePointer
;
2790 // Constructor, needs the event table it needs to hash later on.
2791 // Note: hashing of the event table is not done in the constructor as it
2792 // can be that the event table is not yet full initialize, the hash
2793 // will gets initialized when handling the first event look-up request.
2794 wxEventHashTable(const wxEventTable
&table
);
2796 ~wxEventHashTable();
2798 // Handle the given event, in other words search the event table hash
2799 // and call self->ProcessEvent() if a match was found.
2800 bool HandleEvent(wxEvent
& event
, wxEvtHandler
*self
);
2805 #if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
2807 static void ClearAll();
2808 #endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING
2811 // Init the hash table with the entries of the static event table.
2812 void InitHashTable();
2813 // Helper funtion of InitHashTable() to insert 1 entry into the hash table.
2814 void AddEntry(const wxEventTableEntry
&entry
);
2815 // Allocate and init with null pointers the base hash table.
2816 void AllocEventTypeTable(size_t size
);
2817 // Grow the hash table in size and transfer all items currently
2818 // in the table to the correct location in the new table.
2819 void GrowEventTypeTable();
2822 const wxEventTable
&m_table
;
2826 EventTypeTablePointer
*m_eventTypeTable
;
2828 static wxEventHashTable
* sm_first
;
2829 wxEventHashTable
* m_previous
;
2830 wxEventHashTable
* m_next
;
2832 wxDECLARE_NO_COPY_CLASS(wxEventHashTable
);
2835 // ----------------------------------------------------------------------------
2836 // wxEvtHandler: the base class for all objects handling wxWidgets events
2837 // ----------------------------------------------------------------------------
2839 class WXDLLIMPEXP_BASE wxEvtHandler
: public wxObject
2840 , public wxTrackable
2844 virtual ~wxEvtHandler();
2847 // Event handler chain
2848 // -------------------
2850 wxEvtHandler
*GetNextHandler() const { return m_nextHandler
; }
2851 wxEvtHandler
*GetPreviousHandler() const { return m_previousHandler
; }
2852 virtual void SetNextHandler(wxEvtHandler
*handler
) { m_nextHandler
= handler
; }
2853 virtual void SetPreviousHandler(wxEvtHandler
*handler
) { m_previousHandler
= handler
; }
2855 void SetEvtHandlerEnabled(bool enabled
) { m_enabled
= enabled
; }
2856 bool GetEvtHandlerEnabled() const { return m_enabled
; }
2859 bool IsUnlinked() const;
2863 // Event queuing and processing
2864 // ----------------------------
2866 // Process an event right now: this can only be called from the main
2867 // thread, use QueueEvent() for scheduling the events for
2868 // processing from other threads.
2869 virtual bool ProcessEvent(wxEvent
& event
);
2871 // Process an event by calling ProcessEvent and handling any exceptions
2872 // thrown by event handlers. It's mostly useful when processing wx events
2873 // when called from C code (e.g. in GTK+ callback) when the exception
2874 // wouldn't correctly propagate to wxEventLoop.
2875 bool SafelyProcessEvent(wxEvent
& event
);
2876 // NOTE: uses ProcessEvent()
2878 // Schedule the given event to be processed later. It takes ownership of
2879 // the event pointer, i.e. it will be deleted later. This is safe to call
2880 // from multiple threads although you still need to ensure that wxString
2881 // fields of the event object are deep copies and not use the same string
2882 // buffer as other wxString objects in this thread.
2883 virtual void QueueEvent(wxEvent
*event
);
2885 // Add an event to be processed later: notice that this function is not
2886 // safe to call from threads other than main, use QueueEvent()
2887 virtual void AddPendingEvent(const wxEvent
& event
)
2889 // notice that the thread-safety problem comes from the fact that
2890 // Clone() doesn't make deep copies of wxString fields of wxEvent
2891 // object and so the same wxString could be used from both threads when
2892 // the event object is destroyed in this one -- QueueEvent() avoids
2893 // this problem as the event pointer is not used any more in this
2894 // thread at all after it is called.
2895 QueueEvent(event
.Clone());
2898 void ProcessPendingEvents();
2899 // NOTE: uses ProcessEvent()
2901 void DeletePendingEvents();
2904 bool ProcessThreadEvent(const wxEvent
& event
);
2905 // NOTE: uses AddPendingEvent(); call only from secondary threads
2909 // Connecting and disconnecting
2910 // ----------------------------
2912 // These functions are used for old, untyped, event handlers and don't
2913 // check that the type of the function passed to them actually matches the
2914 // type of the event. They also only allow connecting events to methods of
2915 // wxEvtHandler-derived classes.
2917 // The template Connect() methods below are safer and allow connecting
2918 // events to arbitrary functions or functors -- but require compiler
2919 // support for templates.
2921 // Dynamic association of a member function handler with the event handler,
2922 // winid and event type
2923 void Connect(int winid
,
2925 wxEventType eventType
,
2926 wxObjectEventFunction func
,
2927 wxObject
*userData
= NULL
,
2928 wxEvtHandler
*eventSink
= NULL
)
2930 DoConnect(winid
, lastId
, eventType
,
2931 wxNewEventFunctor(eventType
, func
, eventSink
),
2935 // Convenience function: take just one id
2936 void Connect(int winid
,
2937 wxEventType eventType
,
2938 wxObjectEventFunction func
,
2939 wxObject
*userData
= NULL
,
2940 wxEvtHandler
*eventSink
= NULL
)
2941 { Connect(winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
2943 // Even more convenient: without id (same as using id of wxID_ANY)
2944 void Connect(wxEventType eventType
,
2945 wxObjectEventFunction func
,
2946 wxObject
*userData
= NULL
,
2947 wxEvtHandler
*eventSink
= NULL
)
2948 { Connect(wxID_ANY
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
2950 bool Disconnect(int winid
,
2952 wxEventType eventType
,
2953 wxObjectEventFunction func
= NULL
,
2954 wxObject
*userData
= NULL
,
2955 wxEvtHandler
*eventSink
= NULL
)
2957 return DoDisconnect(winid
, lastId
, eventType
,
2958 wxMakeEventFunctor(eventType
, func
, eventSink
),
2962 bool Disconnect(int winid
= wxID_ANY
,
2963 wxEventType eventType
= wxEVT_NULL
,
2964 wxObjectEventFunction func
= NULL
,
2965 wxObject
*userData
= NULL
,
2966 wxEvtHandler
*eventSink
= NULL
)
2967 { return Disconnect(winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
2969 bool Disconnect(wxEventType eventType
,
2970 wxObjectEventFunction func
,
2971 wxObject
*userData
= NULL
,
2972 wxEvtHandler
*eventSink
= NULL
)
2973 { return Disconnect(wxID_ANY
, eventType
, func
, userData
, eventSink
); }
2975 #if !wxEVENTS_COMPATIBILITY_2_8
2976 // Bind arbitrary functor (including just a function) to an event:
2977 template <typename EventTag
, typename Functor
>
2978 void Bind(const EventTag
& eventType
,
2980 int winid
= wxID_ANY
,
2981 int lastId
= wxID_ANY
,
2982 wxObject
*userData
= NULL
)
2984 DoConnect(winid
, lastId
, eventType
,
2985 wxNewEventFunctor(eventType
, functor
),
2990 template <typename EventTag
, typename Functor
>
2991 bool Unbind(const EventTag
& eventType
,
2993 int winid
= wxID_ANY
,
2994 int lastId
= wxID_ANY
,
2995 wxObject
*userData
= NULL
)
2997 return DoDisconnect(winid
, lastId
, eventType
,
2998 wxMakeEventFunctor(eventType
, functor
),
3003 // Bind a method of a class (called on the specified eventSink which must
3004 // be convertible to this class) object to an event:
3006 template <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
3007 void Bind(const EventTag
&eventType
,
3008 void (Class
::*method
)(EventArg
&),
3009 ObjClass
*eventSink
,
3010 int winid
= wxID_ANY
,
3011 int lastId
= wxID_ANY
,
3012 wxObject
*userData
= NULL
)
3014 DoConnect(winid
, lastId
, eventType
,
3015 wxNewEventFunctor(eventType
, method
, eventSink
),
3019 template <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
3020 bool Unbind(const EventTag
&eventType
,
3021 void (Class
::*method
)(EventArg
&),
3022 ObjClass
*eventSink
,
3023 int winid
= wxID_ANY
,
3024 int lastId
= wxID_ANY
,
3025 wxObject
*userData
= NULL
)
3027 return DoDisconnect(winid
, lastId
, eventType
,
3028 wxMakeEventFunctor(eventType
, method
, eventSink
),
3031 #endif // !wxEVENTS_COMPATIBILITY_2_8
3033 wxList
* GetDynamicEventTable() const { return m_dynamicEvents
; }
3035 // User data can be associated with each wxEvtHandler
3036 void SetClientObject( wxClientData
*data
) { DoSetClientObject(data
); }
3037 wxClientData
*GetClientObject() const { return DoGetClientObject(); }
3039 void SetClientData( void *data
) { DoSetClientData(data
); }
3040 void *GetClientData() const { return DoGetClientData(); }
3043 // implementation from now on
3044 // --------------------------
3046 // check if the given event table entry matches this event by id (the check
3047 // for the event type should be done by caller) and call the handler if it
3050 // return true if the event was processed, false otherwise (no match or the
3051 // handler decided to skip the event)
3052 static bool ProcessEventIfMatchesId(const wxEventTableEntryBase
& tableEntry
,
3053 wxEvtHandler
*handler
,
3056 virtual bool SearchEventTable(wxEventTable
& table
, wxEvent
& event
);
3057 bool SearchDynamicEventTable( wxEvent
& event
);
3059 // Avoid problems at exit by cleaning up static hash table gracefully
3060 void ClearEventHashTable() { GetEventHashTable().Clear(); }
3061 void OnSinkDestroyed( wxEvtHandler
*sink
);
3064 // The method tries to process the event in this event handler.
3066 // It is meant to be called from ProcessEvent() only and is not virtual,
3067 // additional event handlers can be hooked into the normal event processing
3068 // logic using TryBefore() and TryAfter() hooks.
3069 bool ProcessEventHere(wxEvent
& event
);
3073 void DoConnect(int winid
,
3075 wxEventType eventType
,
3076 wxEventFunctor
*func
,
3077 wxObject
* userData
= NULL
);
3079 bool DoDisconnect(int winid
,
3081 wxEventType eventType
,
3082 const wxEventFunctor
& func
,
3083 wxObject
*userData
= NULL
);
3085 static const wxEventTableEntry sm_eventTableEntries
[];
3088 // hooks for wxWindow used by ProcessEvent()
3089 // -----------------------------------------
3091 // this one is called before trying our own event table to allow plugging
3092 // in the event handlers overriding the default logic, this is used by e.g.
3094 virtual bool TryBefore(wxEvent
& event
);
3096 // this one is called after failing to find the event handle in our own
3097 // table to give a chance to the other windows to process it
3099 // base class implementation passes the event to wxTheApp
3100 virtual bool TryAfter(wxEvent
& event
);
3102 #ifdef WXWIN_COMPATIBILITY_2_8
3103 // deprecated method: override TryBefore() instead of this one
3104 wxDEPRECATED_BUT_USED_INTERNALLY_INLINE(
3105 virtual bool TryValidator(wxEvent
& WXUNUSED(event
)), return false; )
3107 wxDEPRECATED_BUT_USED_INTERNALLY_INLINE(
3108 virtual bool TryParent(wxEvent
& event
), return DoTryApp(event
); )
3109 #endif // WXWIN_COMPATIBILITY_2_8
3112 static const wxEventTable sm_eventTable
;
3113 virtual const wxEventTable
*GetEventTable() const;
3115 static wxEventHashTable sm_eventHashTable
;
3116 virtual wxEventHashTable
& GetEventHashTable() const;
3118 wxEvtHandler
* m_nextHandler
;
3119 wxEvtHandler
* m_previousHandler
;
3120 wxList
* m_dynamicEvents
;
3121 wxList
* m_pendingEvents
;
3124 // critical section protecting m_pendingEvents
3125 wxCriticalSection m_pendingEventsLock
;
3126 #endif // wxUSE_THREADS
3128 // Is event handler enabled?
3132 // The user data: either an object which will be deleted by the container
3133 // when it's deleted or some raw pointer which we do nothing with - only
3134 // one type of data can be used with the given window (i.e. you cannot set
3135 // the void data and then associate the container with wxClientData or vice
3139 wxClientData
*m_clientObject
;
3143 // what kind of data do we have?
3144 wxClientDataType m_clientDataType
;
3146 // client data accessors
3147 virtual void DoSetClientObject( wxClientData
*data
);
3148 virtual wxClientData
*DoGetClientObject() const;
3150 virtual void DoSetClientData( void *data
);
3151 virtual void *DoGetClientData() const;
3153 // Search tracker objects for event connection with this sink
3154 wxEventConnectionRef
*FindRefInTrackerList(wxEvtHandler
*eventSink
);
3157 // pass the event to wxTheApp instance, called from TryAfter()
3158 bool DoTryApp(wxEvent
& event
);
3160 DECLARE_DYNAMIC_CLASS_NO_COPY(wxEvtHandler
)
3163 WX_DEFINE_ARRAY_WITH_DECL_PTR(wxEvtHandler
*, wxEvtHandlerArray
, class WXDLLIMPEXP_BASE
);
3165 // ----------------------------------------------------------------------------
3166 // wxEventConnectionRef represents all connections between two event handlers
3167 // and enables automatic disconnect when an event handler sink goes out of
3168 // scope. Each connection/disconnect increases/decreases ref count, and
3169 // when it reaches zero the node goes out of scope.
3170 // ----------------------------------------------------------------------------
3172 class wxEventConnectionRef
: public wxTrackerNode
3175 wxEventConnectionRef() : m_src(NULL
), m_sink(NULL
), m_refCount(0) { }
3176 wxEventConnectionRef(wxEvtHandler
*src
, wxEvtHandler
*sink
)
3177 : m_src(src
), m_sink(sink
), m_refCount(1)
3179 m_sink
->AddNode(this);
3182 // The sink is being destroyed
3183 virtual void OnObjectDestroy( )
3186 m_src
->OnSinkDestroyed( m_sink
);
3190 virtual wxEventConnectionRef
*ToEventConnection() { return this; }
3192 void IncRef() { m_refCount
++; }
3195 if ( !--m_refCount
)
3197 // The sink holds the only external pointer to this object
3199 m_sink
->RemoveNode(this);
3205 wxEvtHandler
*m_src
,
3209 friend class wxEvtHandler
;
3211 wxDECLARE_NO_ASSIGN_CLASS(wxEventConnectionRef
);
3214 inline void wxObjectEventFunctor
::operator()(wxEvtHandler
*handler
, wxEvent
& event
)
3216 wxEvtHandler
* const realHandler
= m_handler ? m_handler
: handler
;
3218 (realHandler
->*m_method
)(event
);
3221 // Post a message to the given event handler which will be processed during the
3222 // next event loop iteration.
3224 // Notice that this one is not thread-safe, use wxQueueEvent()
3225 inline void wxPostEvent(wxEvtHandler
*dest
, const wxEvent
& event
)
3227 wxCHECK_RET( dest
, "need an object to post event to" );
3229 dest
->AddPendingEvent(event
);
3232 // Wrapper around wxEvtHandler::QueueEvent(): adds an event for later
3233 // processing, unlike wxPostEvent it is safe to use from different thread even
3234 // for events with wxString members
3235 inline void wxQueueEvent(wxEvtHandler
*dest
, wxEvent
*event
)
3237 wxCHECK_RET( dest
, "need an object to queue event for" );
3239 dest
->QueueEvent(event
);
3242 typedef void (wxEvtHandler
::*wxEventFunction
)(wxEvent
&);
3243 typedef void (wxEvtHandler
::*wxIdleEventFunction
)(wxIdleEvent
&);
3245 #define wxEventHandler(func) \
3246 wxEVENT_HANDLER_CAST(wxEventFunction, func)
3247 #define wxIdleEventHandler(func) \
3248 wxEVENT_HANDLER_CAST(wxIdleEventFunction, func)
3252 // ----------------------------------------------------------------------------
3253 // wxEventBlocker: helper class to temporarily disable event handling for a window
3254 // ----------------------------------------------------------------------------
3256 class WXDLLIMPEXP_CORE wxEventBlocker
: public wxEvtHandler
3259 wxEventBlocker(wxWindow
*win
, wxEventType type
= wxEVT_ANY
);
3260 virtual ~wxEventBlocker();
3262 void Block(wxEventType type
)
3264 m_eventsToBlock
.push_back(type
);
3267 virtual bool ProcessEvent(wxEvent
& event
);
3270 wxArrayInt m_eventsToBlock
;
3273 wxDECLARE_NO_COPY_CLASS(wxEventBlocker
);
3276 typedef void (wxEvtHandler
::*wxCommandEventFunction
)(wxCommandEvent
&);
3277 typedef void (wxEvtHandler
::*wxThreadEventFunction
)(wxThreadEvent
&);
3278 typedef void (wxEvtHandler
::*wxScrollEventFunction
)(wxScrollEvent
&);
3279 typedef void (wxEvtHandler
::*wxScrollWinEventFunction
)(wxScrollWinEvent
&);
3280 typedef void (wxEvtHandler
::*wxSizeEventFunction
)(wxSizeEvent
&);
3281 typedef void (wxEvtHandler
::*wxMoveEventFunction
)(wxMoveEvent
&);
3282 typedef void (wxEvtHandler
::*wxPaintEventFunction
)(wxPaintEvent
&);
3283 typedef void (wxEvtHandler
::*wxNcPaintEventFunction
)(wxNcPaintEvent
&);
3284 typedef void (wxEvtHandler
::*wxEraseEventFunction
)(wxEraseEvent
&);
3285 typedef void (wxEvtHandler
::*wxMouseEventFunction
)(wxMouseEvent
&);
3286 typedef void (wxEvtHandler
::*wxCharEventFunction
)(wxKeyEvent
&);
3287 typedef void (wxEvtHandler
::*wxFocusEventFunction
)(wxFocusEvent
&);
3288 typedef void (wxEvtHandler
::*wxChildFocusEventFunction
)(wxChildFocusEvent
&);
3289 typedef void (wxEvtHandler
::*wxActivateEventFunction
)(wxActivateEvent
&);
3290 typedef void (wxEvtHandler
::*wxMenuEventFunction
)(wxMenuEvent
&);
3291 typedef void (wxEvtHandler
::*wxJoystickEventFunction
)(wxJoystickEvent
&);
3292 typedef void (wxEvtHandler
::*wxDropFilesEventFunction
)(wxDropFilesEvent
&);
3293 typedef void (wxEvtHandler
::*wxInitDialogEventFunction
)(wxInitDialogEvent
&);
3294 typedef void (wxEvtHandler
::*wxSysColourChangedEventFunction
)(wxSysColourChangedEvent
&);
3295 typedef void (wxEvtHandler
::*wxDisplayChangedEventFunction
)(wxDisplayChangedEvent
&);
3296 typedef void (wxEvtHandler
::*wxUpdateUIEventFunction
)(wxUpdateUIEvent
&);
3297 typedef void (wxEvtHandler
::*wxCloseEventFunction
)(wxCloseEvent
&);
3298 typedef void (wxEvtHandler
::*wxShowEventFunction
)(wxShowEvent
&);
3299 typedef void (wxEvtHandler
::*wxIconizeEventFunction
)(wxIconizeEvent
&);
3300 typedef void (wxEvtHandler
::*wxMaximizeEventFunction
)(wxMaximizeEvent
&);
3301 typedef void (wxEvtHandler
::*wxNavigationKeyEventFunction
)(wxNavigationKeyEvent
&);
3302 typedef void (wxEvtHandler
::*wxPaletteChangedEventFunction
)(wxPaletteChangedEvent
&);
3303 typedef void (wxEvtHandler
::*wxQueryNewPaletteEventFunction
)(wxQueryNewPaletteEvent
&);
3304 typedef void (wxEvtHandler
::*wxWindowCreateEventFunction
)(wxWindowCreateEvent
&);
3305 typedef void (wxEvtHandler
::*wxWindowDestroyEventFunction
)(wxWindowDestroyEvent
&);
3306 typedef void (wxEvtHandler
::*wxSetCursorEventFunction
)(wxSetCursorEvent
&);
3307 typedef void (wxEvtHandler
::*wxNotifyEventFunction
)(wxNotifyEvent
&);
3308 typedef void (wxEvtHandler
::*wxHelpEventFunction
)(wxHelpEvent
&);
3309 typedef void (wxEvtHandler
::*wxContextMenuEventFunction
)(wxContextMenuEvent
&);
3310 typedef void (wxEvtHandler
::*wxMouseCaptureChangedEventFunction
)(wxMouseCaptureChangedEvent
&);
3311 typedef void (wxEvtHandler
::*wxMouseCaptureLostEventFunction
)(wxMouseCaptureLostEvent
&);
3312 typedef void (wxEvtHandler
::*wxClipboardTextEventFunction
)(wxClipboardTextEvent
&);
3315 #define wxCommandEventHandler(func) \
3316 wxEVENT_HANDLER_CAST(wxCommandEventFunction, func)
3317 #define wxThreadEventHandler(func) \
3318 wxEVENT_HANDLER_CAST(wxThreadEventFunction, func)
3319 #define wxScrollEventHandler(func) \
3320 wxEVENT_HANDLER_CAST(wxScrollEventFunction, func)
3321 #define wxScrollWinEventHandler(func) \
3322 wxEVENT_HANDLER_CAST(wxScrollWinEventFunction, func)
3323 #define wxSizeEventHandler(func) \
3324 wxEVENT_HANDLER_CAST(wxSizeEventFunction, func)
3325 #define wxMoveEventHandler(func) \
3326 wxEVENT_HANDLER_CAST(wxMoveEventFunction, func)
3327 #define wxPaintEventHandler(func) \
3328 wxEVENT_HANDLER_CAST(wxPaintEventFunction, func)
3329 #define wxNcPaintEventHandler(func) \
3330 wxEVENT_HANDLER_CAST(wxNcPaintEventFunction, func)
3331 #define wxEraseEventHandler(func) \
3332 wxEVENT_HANDLER_CAST(wxEraseEventFunction, func)
3333 #define wxMouseEventHandler(func) \
3334 wxEVENT_HANDLER_CAST(wxMouseEventFunction, func)
3335 #define wxCharEventHandler(func) \
3336 wxEVENT_HANDLER_CAST(wxCharEventFunction, func)
3337 #define wxKeyEventHandler(func) wxCharEventHandler(func)
3338 #define wxFocusEventHandler(func) \
3339 wxEVENT_HANDLER_CAST(wxFocusEventFunction, func)
3340 #define wxChildFocusEventHandler(func) \
3341 wxEVENT_HANDLER_CAST(wxChildFocusEventFunction, func)
3342 #define wxActivateEventHandler(func) \
3343 wxEVENT_HANDLER_CAST(wxActivateEventFunction, func)
3344 #define wxMenuEventHandler(func) \
3345 wxEVENT_HANDLER_CAST(wxMenuEventFunction, func)
3346 #define wxJoystickEventHandler(func) \
3347 wxEVENT_HANDLER_CAST(wxJoystickEventFunction, func)
3348 #define wxDropFilesEventHandler(func) \
3349 wxEVENT_HANDLER_CAST(wxDropFilesEventFunction, func)
3350 #define wxInitDialogEventHandler(func) \
3351 wxEVENT_HANDLER_CAST(wxInitDialogEventFunction, func)
3352 #define wxSysColourChangedEventHandler(func) \
3353 wxEVENT_HANDLER_CAST(wxSysColourChangedEventFunction, func)
3354 #define wxDisplayChangedEventHandler(func) \
3355 wxEVENT_HANDLER_CAST(wxDisplayChangedEventFunction, func)
3356 #define wxUpdateUIEventHandler(func) \
3357 wxEVENT_HANDLER_CAST(wxUpdateUIEventFunction, func)
3358 #define wxCloseEventHandler(func) \
3359 wxEVENT_HANDLER_CAST(wxCloseEventFunction, func)
3360 #define wxShowEventHandler(func) \
3361 wxEVENT_HANDLER_CAST(wxShowEventFunction, func)
3362 #define wxIconizeEventHandler(func) \
3363 wxEVENT_HANDLER_CAST(wxIconizeEventFunction, func)
3364 #define wxMaximizeEventHandler(func) \
3365 wxEVENT_HANDLER_CAST(wxMaximizeEventFunction, func)
3366 #define wxNavigationKeyEventHandler(func) \
3367 wxEVENT_HANDLER_CAST(wxNavigationKeyEventFunction, func)
3368 #define wxPaletteChangedEventHandler(func) \
3369 wxEVENT_HANDLER_CAST(wxPaletteChangedEventFunction, func)
3370 #define wxQueryNewPaletteEventHandler(func) \
3371 wxEVENT_HANDLER_CAST(wxQueryNewPaletteEventFunction, func)
3372 #define wxWindowCreateEventHandler(func) \
3373 wxEVENT_HANDLER_CAST(wxWindowCreateEventFunction, func)
3374 #define wxWindowDestroyEventHandler(func) \
3375 wxEVENT_HANDLER_CAST(wxWindowDestroyEventFunction, func)
3376 #define wxSetCursorEventHandler(func) \
3377 wxEVENT_HANDLER_CAST(wxSetCursorEventFunction, func)
3378 #define wxNotifyEventHandler(func) \
3379 wxEVENT_HANDLER_CAST(wxNotifyEventFunction, func)
3380 #define wxHelpEventHandler(func) \
3381 wxEVENT_HANDLER_CAST(wxHelpEventFunction, func)
3382 #define wxContextMenuEventHandler(func) \
3383 wxEVENT_HANDLER_CAST(wxContextMenuEventFunction, func)
3384 #define wxMouseCaptureChangedEventHandler(func) \
3385 wxEVENT_HANDLER_CAST(wxMouseCaptureChangedEventFunction, func)
3386 #define wxMouseCaptureLostEventHandler(func) \
3387 wxEVENT_HANDLER_CAST(wxMouseCaptureLostEventFunction, func)
3388 #define wxClipboardTextEventHandler(func) \
3389 wxEVENT_HANDLER_CAST(wxClipboardTextEventFunction, func)
3393 // N.B. In GNU-WIN32, you *have* to take the address of a member function
3394 // (use &) or the compiler crashes...
3396 #define DECLARE_EVENT_TABLE() \
3398 static const wxEventTableEntry sm_eventTableEntries[]; \
3400 static const wxEventTable sm_eventTable; \
3401 virtual const wxEventTable* GetEventTable() const; \
3402 static wxEventHashTable sm_eventHashTable; \
3403 virtual wxEventHashTable& GetEventHashTable() const;
3405 // N.B.: when building DLL with Borland C++ 5.5 compiler, you must initialize
3406 // sm_eventTable before using it in GetEventTable() or the compiler gives
3407 // E2233 (see http://groups.google.com/groups?selm=397dcc8a%241_2%40dnews)
3409 #define BEGIN_EVENT_TABLE(theClass, baseClass) \
3410 const wxEventTable theClass::sm_eventTable = \
3411 { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] }; \
3412 const wxEventTable *theClass::GetEventTable() const \
3413 { return &theClass::sm_eventTable; } \
3414 wxEventHashTable theClass::sm_eventHashTable(theClass::sm_eventTable); \
3415 wxEventHashTable &theClass::GetEventHashTable() const \
3416 { return theClass::sm_eventHashTable; } \
3417 const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
3419 #define BEGIN_EVENT_TABLE_TEMPLATE1(theClass, baseClass, T1) \
3420 template<typename T1> \
3421 const wxEventTable theClass<T1>::sm_eventTable = \
3422 { &baseClass::sm_eventTable, &theClass<T1>::sm_eventTableEntries[0] }; \
3423 template<typename T1> \
3424 const wxEventTable *theClass<T1>::GetEventTable() const \
3425 { return &theClass<T1>::sm_eventTable; } \
3426 template<typename T1> \
3427 wxEventHashTable theClass<T1>::sm_eventHashTable(theClass<T1>::sm_eventTable); \
3428 template<typename T1> \
3429 wxEventHashTable &theClass<T1>::GetEventHashTable() const \
3430 { return theClass<T1>::sm_eventHashTable; } \
3431 template<typename T1> \
3432 const wxEventTableEntry theClass<T1>::sm_eventTableEntries[] = { \
3434 #define BEGIN_EVENT_TABLE_TEMPLATE2(theClass, baseClass, T1, T2) \
3435 template<typename T1, typename T2> \
3436 const wxEventTable theClass<T1, T2>::sm_eventTable = \
3437 { &baseClass::sm_eventTable, &theClass<T1, T2>::sm_eventTableEntries[0] }; \
3438 template<typename T1, typename T2> \
3439 const wxEventTable *theClass<T1, T2>::GetEventTable() const \
3440 { return &theClass<T1, T2>::sm_eventTable; } \
3441 template<typename T1, typename T2> \
3442 wxEventHashTable theClass<T1, T2>::sm_eventHashTable(theClass<T1, T2>::sm_eventTable); \
3443 template<typename T1, typename T2> \
3444 wxEventHashTable &theClass<T1, T2>::GetEventHashTable() const \
3445 { return theClass<T1, T2>::sm_eventHashTable; } \
3446 template<typename T1, typename T2> \
3447 const wxEventTableEntry theClass<T1, T2>::sm_eventTableEntries[] = { \
3449 #define BEGIN_EVENT_TABLE_TEMPLATE3(theClass, baseClass, T1, T2, T3) \
3450 template<typename T1, typename T2, typename T3> \
3451 const wxEventTable theClass<T1, T2, T3>::sm_eventTable = \
3452 { &baseClass::sm_eventTable, &theClass<T1, T2, T3>::sm_eventTableEntries[0] }; \
3453 template<typename T1, typename T2, typename T3> \
3454 const wxEventTable *theClass<T1, T2, T3>::GetEventTable() const \
3455 { return &theClass<T1, T2, T3>::sm_eventTable; } \
3456 template<typename T1, typename T2, typename T3> \
3457 wxEventHashTable theClass<T1, T2, T3>::sm_eventHashTable(theClass<T1, T2, T3>::sm_eventTable); \
3458 template<typename T1, typename T2, typename T3> \
3459 wxEventHashTable &theClass<T1, T2, T3>::GetEventHashTable() const \
3460 { return theClass<T1, T2, T3>::sm_eventHashTable; } \
3461 template<typename T1, typename T2, typename T3> \
3462 const wxEventTableEntry theClass<T1, T2, T3>::sm_eventTableEntries[] = { \
3464 #define BEGIN_EVENT_TABLE_TEMPLATE4(theClass, baseClass, T1, T2, T3, T4) \
3465 template<typename T1, typename T2, typename T3, typename T4> \
3466 const wxEventTable theClass<T1, T2, T3, T4>::sm_eventTable = \
3467 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4>::sm_eventTableEntries[0] }; \
3468 template<typename T1, typename T2, typename T3, typename T4> \
3469 const wxEventTable *theClass<T1, T2, T3, T4>::GetEventTable() const \
3470 { return &theClass<T1, T2, T3, T4>::sm_eventTable; } \
3471 template<typename T1, typename T2, typename T3, typename T4> \
3472 wxEventHashTable theClass<T1, T2, T3, T4>::sm_eventHashTable(theClass<T1, T2, T3, T4>::sm_eventTable); \
3473 template<typename T1, typename T2, typename T3, typename T4> \
3474 wxEventHashTable &theClass<T1, T2, T3, T4>::GetEventHashTable() const \
3475 { return theClass<T1, T2, T3, T4>::sm_eventHashTable; } \
3476 template<typename T1, typename T2, typename T3, typename T4> \
3477 const wxEventTableEntry theClass<T1, T2, T3, T4>::sm_eventTableEntries[] = { \
3479 #define BEGIN_EVENT_TABLE_TEMPLATE5(theClass, baseClass, T1, T2, T3, T4, T5) \
3480 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3481 const wxEventTable theClass<T1, T2, T3, T4, T5>::sm_eventTable = \
3482 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[0] }; \
3483 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3484 const wxEventTable *theClass<T1, T2, T3, T4, T5>::GetEventTable() const \
3485 { return &theClass<T1, T2, T3, T4, T5>::sm_eventTable; } \
3486 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3487 wxEventHashTable theClass<T1, T2, T3, T4, T5>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5>::sm_eventTable); \
3488 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3489 wxEventHashTable &theClass<T1, T2, T3, T4, T5>::GetEventHashTable() const \
3490 { return theClass<T1, T2, T3, T4, T5>::sm_eventHashTable; } \
3491 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3492 const wxEventTableEntry theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[] = { \
3494 #define BEGIN_EVENT_TABLE_TEMPLATE7(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7) \
3495 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3496 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable = \
3497 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[0] }; \
3498 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3499 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventTable() const \
3500 { return &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable; } \
3501 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3502 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable); \
3503 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3504 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventHashTable() const \
3505 { return theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable; } \
3506 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3507 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[] = { \
3509 #define BEGIN_EVENT_TABLE_TEMPLATE8(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7, T8) \
3510 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3511 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable = \
3512 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[0] }; \
3513 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3514 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventTable() const \
3515 { return &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable; } \
3516 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3517 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable); \
3518 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3519 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventHashTable() const \
3520 { return theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable; } \
3521 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3522 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[] = { \
3524 #define END_EVENT_TABLE() DECLARE_EVENT_TABLE_TERMINATOR() };
3527 * Event table macros
3530 // helpers for writing shorter code below: declare an event macro taking 2, 1
3531 // or none ids (the missing ids default to wxID_ANY)
3534 // - evt one of wxEVT_XXX constants
3535 // - id1, id2 ids of the first/last id
3536 // - fn the function (should be cast to the right type)
3537 #define wx__DECLARE_EVT2(evt, id1, id2, fn) \
3538 DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
3539 #define wx__DECLARE_EVT1(evt, id, fn) \
3540 wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
3541 #define wx__DECLARE_EVT0(evt, fn) \
3542 wx__DECLARE_EVT1(evt, wxID_ANY, fn)
3546 #define EVT_CUSTOM(event, winid, func) \
3547 wx__DECLARE_EVT1(event, winid, wxEventHandler(func))
3548 #define EVT_CUSTOM_RANGE(event, id1, id2, func) \
3549 wx__DECLARE_EVT2(event, id1, id2, wxEventHandler(func))
3552 #define EVT_COMMAND(winid, event, func) \
3553 wx__DECLARE_EVT1(event, winid, wxCommandEventHandler(func))
3555 #define EVT_COMMAND_RANGE(id1, id2, event, func) \
3556 wx__DECLARE_EVT2(event, id1, id2, wxCommandEventHandler(func))
3558 #define EVT_NOTIFY(event, winid, func) \
3559 wx__DECLARE_EVT1(event, winid, wxNotifyEventHandler(func))
3561 #define EVT_NOTIFY_RANGE(event, id1, id2, func) \
3562 wx__DECLARE_EVT2(event, id1, id2, wxNotifyEventHandler(func))
3565 #define EVT_SIZE(func) wx__DECLARE_EVT0(wxEVT_SIZE, wxSizeEventHandler(func))
3566 #define EVT_SIZING(func) wx__DECLARE_EVT0(wxEVT_SIZING, wxSizeEventHandler(func))
3567 #define EVT_MOVE(func) wx__DECLARE_EVT0(wxEVT_MOVE, wxMoveEventHandler(func))
3568 #define EVT_MOVING(func) wx__DECLARE_EVT0(wxEVT_MOVING, wxMoveEventHandler(func))
3569 #define EVT_MOVE_START(func) wx__DECLARE_EVT0(wxEVT_MOVE_START, wxMoveEventHandler(func))
3570 #define EVT_MOVE_END(func) wx__DECLARE_EVT0(wxEVT_MOVE_END, wxMoveEventHandler(func))
3571 #define EVT_CLOSE(func) wx__DECLARE_EVT0(wxEVT_CLOSE_WINDOW, wxCloseEventHandler(func))
3572 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3573 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3574 #define EVT_PAINT(func) wx__DECLARE_EVT0(wxEVT_PAINT, wxPaintEventHandler(func))
3575 #define EVT_NC_PAINT(func) wx__DECLARE_EVT0(wxEVT_NC_PAINT, wxNcPaintEventHandler(func))
3576 #define EVT_ERASE_BACKGROUND(func) wx__DECLARE_EVT0(wxEVT_ERASE_BACKGROUND, wxEraseEventHandler(func))
3577 #define EVT_CHAR(func) wx__DECLARE_EVT0(wxEVT_CHAR, wxCharEventHandler(func))
3578 #define EVT_KEY_DOWN(func) wx__DECLARE_EVT0(wxEVT_KEY_DOWN, wxKeyEventHandler(func))
3579 #define EVT_KEY_UP(func) wx__DECLARE_EVT0(wxEVT_KEY_UP, wxKeyEventHandler(func))
3581 #define EVT_HOTKEY(winid, func) wx__DECLARE_EVT1(wxEVT_HOTKEY, winid, wxCharEventHandler(func))
3583 #define EVT_CHAR_HOOK(func) wx__DECLARE_EVT0(wxEVT_CHAR_HOOK, wxCharEventHandler(func))
3584 #define EVT_MENU_OPEN(func) wx__DECLARE_EVT0(wxEVT_MENU_OPEN, wxMenuEventHandler(func))
3585 #define EVT_MENU_CLOSE(func) wx__DECLARE_EVT0(wxEVT_MENU_CLOSE, wxMenuEventHandler(func))
3586 #define EVT_MENU_HIGHLIGHT(winid, func) wx__DECLARE_EVT1(wxEVT_MENU_HIGHLIGHT, winid, wxMenuEventHandler(func))
3587 #define EVT_MENU_HIGHLIGHT_ALL(func) wx__DECLARE_EVT0(wxEVT_MENU_HIGHLIGHT, wxMenuEventHandler(func))
3588 #define EVT_SET_FOCUS(func) wx__DECLARE_EVT0(wxEVT_SET_FOCUS, wxFocusEventHandler(func))
3589 #define EVT_KILL_FOCUS(func) wx__DECLARE_EVT0(wxEVT_KILL_FOCUS, wxFocusEventHandler(func))
3590 #define EVT_CHILD_FOCUS(func) wx__DECLARE_EVT0(wxEVT_CHILD_FOCUS, wxChildFocusEventHandler(func))
3591 #define EVT_ACTIVATE(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE, wxActivateEventHandler(func))
3592 #define EVT_ACTIVATE_APP(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE_APP, wxActivateEventHandler(func))
3593 #define EVT_HIBERNATE(func) wx__DECLARE_EVT0(wxEVT_HIBERNATE, wxActivateEventHandler(func))
3594 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3595 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3596 #define EVT_DROP_FILES(func) wx__DECLARE_EVT0(wxEVT_DROP_FILES, wxDropFilesEventHandler(func))
3597 #define EVT_INIT_DIALOG(func) wx__DECLARE_EVT0(wxEVT_INIT_DIALOG, wxInitDialogEventHandler(func))
3598 #define EVT_SYS_COLOUR_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEventHandler(func))
3599 #define EVT_DISPLAY_CHANGED(func) wx__DECLARE_EVT0(wxEVT_DISPLAY_CHANGED, wxDisplayChangedEventHandler(func))
3600 #define EVT_SHOW(func) wx__DECLARE_EVT0(wxEVT_SHOW, wxShowEventHandler(func))
3601 #define EVT_MAXIMIZE(func) wx__DECLARE_EVT0(wxEVT_MAXIMIZE, wxMaximizeEventHandler(func))
3602 #define EVT_ICONIZE(func) wx__DECLARE_EVT0(wxEVT_ICONIZE, wxIconizeEventHandler(func))
3603 #define EVT_NAVIGATION_KEY(func) wx__DECLARE_EVT0(wxEVT_NAVIGATION_KEY, wxNavigationKeyEventHandler(func))
3604 #define EVT_PALETTE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_PALETTE_CHANGED, wxPaletteChangedEventHandler(func))
3605 #define EVT_QUERY_NEW_PALETTE(func) wx__DECLARE_EVT0(wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEventHandler(func))
3606 #define EVT_WINDOW_CREATE(func) wx__DECLARE_EVT0(wxEVT_CREATE, wxWindowCreateEventHandler(func))
3607 #define EVT_WINDOW_DESTROY(func) wx__DECLARE_EVT0(wxEVT_DESTROY, wxWindowDestroyEventHandler(func))
3608 #define EVT_SET_CURSOR(func) wx__DECLARE_EVT0(wxEVT_SET_CURSOR, wxSetCursorEventHandler(func))
3609 #define EVT_MOUSE_CAPTURE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEventHandler(func))
3610 #define EVT_MOUSE_CAPTURE_LOST(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEventHandler(func))
3613 #define EVT_LEFT_DOWN(func) wx__DECLARE_EVT0(wxEVT_LEFT_DOWN, wxMouseEventHandler(func))
3614 #define EVT_LEFT_UP(func) wx__DECLARE_EVT0(wxEVT_LEFT_UP, wxMouseEventHandler(func))
3615 #define EVT_MIDDLE_DOWN(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DOWN, wxMouseEventHandler(func))
3616 #define EVT_MIDDLE_UP(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_UP, wxMouseEventHandler(func))
3617 #define EVT_RIGHT_DOWN(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DOWN, wxMouseEventHandler(func))
3618 #define EVT_RIGHT_UP(func) wx__DECLARE_EVT0(wxEVT_RIGHT_UP, wxMouseEventHandler(func))
3619 #define EVT_MOTION(func) wx__DECLARE_EVT0(wxEVT_MOTION, wxMouseEventHandler(func))
3620 #define EVT_LEFT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_LEFT_DCLICK, wxMouseEventHandler(func))
3621 #define EVT_MIDDLE_DCLICK(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DCLICK, wxMouseEventHandler(func))
3622 #define EVT_RIGHT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DCLICK, wxMouseEventHandler(func))
3623 #define EVT_LEAVE_WINDOW(func) wx__DECLARE_EVT0(wxEVT_LEAVE_WINDOW, wxMouseEventHandler(func))
3624 #define EVT_ENTER_WINDOW(func) wx__DECLARE_EVT0(wxEVT_ENTER_WINDOW, wxMouseEventHandler(func))
3625 #define EVT_MOUSEWHEEL(func) wx__DECLARE_EVT0(wxEVT_MOUSEWHEEL, wxMouseEventHandler(func))
3626 #define EVT_MOUSE_AUX1_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX1_DOWN, wxMouseEventHandler(func))
3627 #define EVT_MOUSE_AUX1_UP(func) wx__DECLARE_EVT0(wxEVT_AUX1_UP, wxMouseEventHandler(func))
3628 #define EVT_MOUSE_AUX1_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX1_DCLICK, wxMouseEventHandler(func))
3629 #define EVT_MOUSE_AUX2_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX2_DOWN, wxMouseEventHandler(func))
3630 #define EVT_MOUSE_AUX2_UP(func) wx__DECLARE_EVT0(wxEVT_AUX2_UP, wxMouseEventHandler(func))
3631 #define EVT_MOUSE_AUX2_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX2_DCLICK, wxMouseEventHandler(func))
3634 #define EVT_MOUSE_EVENTS(func) \
3635 EVT_LEFT_DOWN(func) \
3637 EVT_LEFT_DCLICK(func) \
3638 EVT_MIDDLE_DOWN(func) \
3639 EVT_MIDDLE_UP(func) \
3640 EVT_MIDDLE_DCLICK(func) \
3641 EVT_RIGHT_DOWN(func) \
3642 EVT_RIGHT_UP(func) \
3643 EVT_RIGHT_DCLICK(func) \
3644 EVT_MOUSE_AUX1_DOWN(func) \
3645 EVT_MOUSE_AUX1_UP(func) \
3646 EVT_MOUSE_AUX1_DCLICK(func) \
3647 EVT_MOUSE_AUX2_DOWN(func) \
3648 EVT_MOUSE_AUX2_UP(func) \
3649 EVT_MOUSE_AUX2_DCLICK(func) \
3651 EVT_LEAVE_WINDOW(func) \
3652 EVT_ENTER_WINDOW(func) \
3653 EVT_MOUSEWHEEL(func)
3655 // Scrolling from wxWindow (sent to wxScrolledWindow)
3656 #define EVT_SCROLLWIN_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_TOP, wxScrollWinEventHandler(func))
3657 #define EVT_SCROLLWIN_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEventHandler(func))
3658 #define EVT_SCROLLWIN_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEUP, wxScrollWinEventHandler(func))
3659 #define EVT_SCROLLWIN_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEventHandler(func))
3660 #define EVT_SCROLLWIN_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEventHandler(func))
3661 #define EVT_SCROLLWIN_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEventHandler(func))
3662 #define EVT_SCROLLWIN_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEventHandler(func))
3663 #define EVT_SCROLLWIN_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEventHandler(func))
3665 #define EVT_SCROLLWIN(func) \
3666 EVT_SCROLLWIN_TOP(func) \
3667 EVT_SCROLLWIN_BOTTOM(func) \
3668 EVT_SCROLLWIN_LINEUP(func) \
3669 EVT_SCROLLWIN_LINEDOWN(func) \
3670 EVT_SCROLLWIN_PAGEUP(func) \
3671 EVT_SCROLLWIN_PAGEDOWN(func) \
3672 EVT_SCROLLWIN_THUMBTRACK(func) \
3673 EVT_SCROLLWIN_THUMBRELEASE(func)
3675 // Scrolling from wxSlider and wxScrollBar
3676 #define EVT_SCROLL_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_TOP, wxScrollEventHandler(func))
3677 #define EVT_SCROLL_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLL_BOTTOM, wxScrollEventHandler(func))
3678 #define EVT_SCROLL_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEUP, wxScrollEventHandler(func))
3679 #define EVT_SCROLL_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEDOWN, wxScrollEventHandler(func))
3680 #define EVT_SCROLL_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEUP, wxScrollEventHandler(func))
3681 #define EVT_SCROLL_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler(func))
3682 #define EVT_SCROLL_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler(func))
3683 #define EVT_SCROLL_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBRELEASE, wxScrollEventHandler(func))
3684 #define EVT_SCROLL_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SCROLL_CHANGED, wxScrollEventHandler(func))
3686 #define EVT_SCROLL(func) \
3687 EVT_SCROLL_TOP(func) \
3688 EVT_SCROLL_BOTTOM(func) \
3689 EVT_SCROLL_LINEUP(func) \
3690 EVT_SCROLL_LINEDOWN(func) \
3691 EVT_SCROLL_PAGEUP(func) \
3692 EVT_SCROLL_PAGEDOWN(func) \
3693 EVT_SCROLL_THUMBTRACK(func) \
3694 EVT_SCROLL_THUMBRELEASE(func) \
3695 EVT_SCROLL_CHANGED(func)
3697 // Scrolling from wxSlider and wxScrollBar, with an id
3698 #define EVT_COMMAND_SCROLL_TOP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_TOP, winid, wxScrollEventHandler(func))
3699 #define EVT_COMMAND_SCROLL_BOTTOM(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_BOTTOM, winid, wxScrollEventHandler(func))
3700 #define EVT_COMMAND_SCROLL_LINEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEUP, winid, wxScrollEventHandler(func))
3701 #define EVT_COMMAND_SCROLL_LINEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEDOWN, winid, wxScrollEventHandler(func))
3702 #define EVT_COMMAND_SCROLL_PAGEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEUP, winid, wxScrollEventHandler(func))
3703 #define EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEDOWN, winid, wxScrollEventHandler(func))
3704 #define EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBTRACK, winid, wxScrollEventHandler(func))
3705 #define EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBRELEASE, winid, wxScrollEventHandler(func))
3706 #define EVT_COMMAND_SCROLL_CHANGED(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_CHANGED, winid, wxScrollEventHandler(func))
3708 #define EVT_COMMAND_SCROLL(winid, func) \
3709 EVT_COMMAND_SCROLL_TOP(winid, func) \
3710 EVT_COMMAND_SCROLL_BOTTOM(winid, func) \
3711 EVT_COMMAND_SCROLL_LINEUP(winid, func) \
3712 EVT_COMMAND_SCROLL_LINEDOWN(winid, func) \
3713 EVT_COMMAND_SCROLL_PAGEUP(winid, func) \
3714 EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) \
3715 EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) \
3716 EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) \
3717 EVT_COMMAND_SCROLL_CHANGED(winid, func)
3719 #if WXWIN_COMPATIBILITY_2_6
3720 // compatibility macros for the old name, deprecated in 2.8
3721 #define wxEVT_SCROLL_ENDSCROLL wxEVT_SCROLL_CHANGED
3722 #define EVT_COMMAND_SCROLL_ENDSCROLL EVT_COMMAND_SCROLL_CHANGED
3723 #define EVT_SCROLL_ENDSCROLL EVT_SCROLL_CHANGED
3724 #endif // WXWIN_COMPATIBILITY_2_6
3726 // Convenience macros for commonly-used commands
3727 #define EVT_CHECKBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKBOX_CLICKED, winid, wxCommandEventHandler(func))
3728 #define EVT_CHOICE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHOICE_SELECTED, winid, wxCommandEventHandler(func))
3729 #define EVT_LISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_SELECTED, winid, wxCommandEventHandler(func))
3730 #define EVT_LISTBOX_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, winid, wxCommandEventHandler(func))
3731 #define EVT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_MENU_SELECTED, winid, wxCommandEventHandler(func))
3732 #define EVT_MENU_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_MENU_SELECTED, id1, id2, wxCommandEventHandler(func))
3733 #if defined(__SMARTPHONE__)
3734 # define EVT_BUTTON(winid, func) EVT_MENU(winid, func)
3736 # define EVT_BUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_BUTTON_CLICKED, winid, wxCommandEventHandler(func))
3738 #define EVT_SLIDER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SLIDER_UPDATED, winid, wxCommandEventHandler(func))
3739 #define EVT_RADIOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBOX_SELECTED, winid, wxCommandEventHandler(func))
3740 #define EVT_RADIOBUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBUTTON_SELECTED, winid, wxCommandEventHandler(func))
3741 // EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events
3742 #define EVT_SCROLLBAR(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SCROLLBAR_UPDATED, winid, wxCommandEventHandler(func))
3743 #define EVT_VLBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_VLBOX_SELECTED, winid, wxCommandEventHandler(func))
3744 #define EVT_COMBOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_SELECTED, winid, wxCommandEventHandler(func))
3745 #define EVT_TOOL(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_CLICKED, winid, wxCommandEventHandler(func))
3746 #define EVT_TOOL_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, winid, wxCommandEventHandler(func))
3747 #define EVT_TOOL_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_CLICKED, id1, id2, wxCommandEventHandler(func))
3748 #define EVT_TOOL_RCLICKED(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_RCLICKED, winid, wxCommandEventHandler(func))
3749 #define EVT_TOOL_RCLICKED_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, wxCommandEventHandler(func))
3750 #define EVT_TOOL_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_ENTER, winid, wxCommandEventHandler(func))
3751 #define EVT_CHECKLISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, winid, wxCommandEventHandler(func))
3753 // Generic command events
3754 #define EVT_COMMAND_LEFT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_CLICK, winid, wxCommandEventHandler(func))
3755 #define EVT_COMMAND_LEFT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_DCLICK, winid, wxCommandEventHandler(func))
3756 #define EVT_COMMAND_RIGHT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_CLICK, winid, wxCommandEventHandler(func))
3757 #define EVT_COMMAND_RIGHT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_DCLICK, winid, wxCommandEventHandler(func))
3758 #define EVT_COMMAND_SET_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SET_FOCUS, winid, wxCommandEventHandler(func))
3759 #define EVT_COMMAND_KILL_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_KILL_FOCUS, winid, wxCommandEventHandler(func))
3760 #define EVT_COMMAND_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_ENTER, winid, wxCommandEventHandler(func))
3764 #define EVT_JOY_BUTTON_DOWN(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_DOWN, wxJoystickEventHandler(func))
3765 #define EVT_JOY_BUTTON_UP(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_UP, wxJoystickEventHandler(func))
3766 #define EVT_JOY_MOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_MOVE, wxJoystickEventHandler(func))
3767 #define EVT_JOY_ZMOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_ZMOVE, wxJoystickEventHandler(func))
3769 // All joystick events
3770 #define EVT_JOYSTICK_EVENTS(func) \
3771 EVT_JOY_BUTTON_DOWN(func) \
3772 EVT_JOY_BUTTON_UP(func) \
3773 EVT_JOY_MOVE(func) \
3777 #define EVT_IDLE(func) wx__DECLARE_EVT0(wxEVT_IDLE, wxIdleEventHandler(func))
3780 #define EVT_UPDATE_UI(winid, func) wx__DECLARE_EVT1(wxEVT_UPDATE_UI, winid, wxUpdateUIEventHandler(func))
3781 #define EVT_UPDATE_UI_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_UPDATE_UI, id1, id2, wxUpdateUIEventHandler(func))
3784 #define EVT_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_HELP, winid, wxHelpEventHandler(func))
3785 #define EVT_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_HELP, id1, id2, wxHelpEventHandler(func))
3786 #define EVT_DETAILED_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_DETAILED_HELP, winid, wxHelpEventHandler(func))
3787 #define EVT_DETAILED_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_DETAILED_HELP, id1, id2, wxHelpEventHandler(func))
3789 // Context Menu Events
3790 #define EVT_CONTEXT_MENU(func) wx__DECLARE_EVT0(wxEVT_CONTEXT_MENU, wxContextMenuEventHandler(func))
3791 #define EVT_COMMAND_CONTEXT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_CONTEXT_MENU, winid, wxContextMenuEventHandler(func))
3793 // Clipboard text Events
3794 #define EVT_TEXT_CUT(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_CUT, winid, wxClipboardTextEventHandler(func))
3795 #define EVT_TEXT_COPY(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_COPY, winid, wxClipboardTextEventHandler(func))
3796 #define EVT_TEXT_PASTE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_PASTE, winid, wxClipboardTextEventHandler(func))
3799 #define EVT_THREAD(id, func) wx__DECLARE_EVT1(wxEVT_COMMAND_THREAD, id, wxThreadEventHandler(func))
3801 // ----------------------------------------------------------------------------
3803 // ----------------------------------------------------------------------------
3805 // This is an ugly hack to allow the use of Bind() instead of Connect() inside
3806 // the library code if the library was built with support for it, here is how
3809 // class SomeEventHandlingClass : wxBIND_OR_CONNECT_HACK_BASE_CLASS
3810 // public SomeBaseClass
3813 // SomeEventHandlingClass(wxWindow *win)
3815 // // connect to the event for the given window
3816 // wxBIND_OR_CONNECT_HACK(win, wxEVT_SOMETHING, wxSomeEventHandler,
3817 // SomeEventHandlingClass::OnSomeEvent, this);
3821 // void OnSomeEvent(wxSomeEvent&) { ... }
3824 // This is *not* meant to be used by library users, it is only defined here
3825 // (and not in a private header) because the base class must be visible from
3826 // other public headers, please do NOT use this in your code, it will be
3827 // removed from future wx versions without warning.
3828 #if wxEVENTS_COMPATIBILITY_2_8
3829 #define wxBIND_OR_CONNECT_HACK_BASE_CLASS public wxEvtHandler,
3830 #define wxBIND_OR_CONNECT_HACK_ONLY_BASE_CLASS : public wxEvtHandler
3831 #define wxBIND_OR_CONNECT_HACK(w, evt, handler, func, obj) \
3832 win->Connect(evt, handler(func), NULL, obj)
3833 #else // wxEVENTS_COMPATIBILITY_2_8
3834 #define wxBIND_OR_CONNECT_HACK_BASE_CLASS
3835 #define wxBIND_OR_CONNECT_HACK_ONLY_BASE_CLASS
3836 #define wxBIND_OR_CONNECT_HACK(w, evt, handler, func, obj) \
3837 win->Bind(evt, &func, obj)
3838 #endif // wxEVENTS_COMPATIBILITY_2_8/!wxEVENTS_COMPATIBILITY_2_8
3842 // Find a window with the focus, that is also a descendant of the given window.
3843 // This is used to determine the window to initially send commands to.
3844 WXDLLIMPEXP_CORE wxWindow
* wxFindFocusDescendant(wxWindow
* ancestor
);
3848 #endif // _WX_EVENT_H_