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_LOCAL_EVENT( name, type ) \
127 wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type )
129 // Try to cast the given event handler to the correct handler type:
131 #define wxEVENT_HANDLER_CAST( functype, func ) \
132 ( wxObjectEventFunction )( wxEventFunction )wxStaticCastEvent( functype, &func )
134 // Define/Declare a templatized event type with the corresponding event as
137 #define wxDEFINE_EVENT( name, type ) \
138 const wxEventTypeTag< type > name( wxNewEventType() );
140 #define wxDECLARE_EXPORTED_EVENT( expdecl, name, type ) \
141 extern const expdecl wxEventTypeTag< type > name;
143 // Define/Declare a templatized event type and initialize it with a
144 // predefined event type. (Only used for wxEVT_SPIN_XXX for backward
147 #define wxDEFINE_EVENT_ALIAS( name, type, value ) \
148 const wxEventTypeTag< type > name( value );
150 #define wxDECLARE_EXPORTED_EVENT_ALIAS( expdecl, name, type ) \
151 extern const expdecl wxEventTypeTag< type > name;
153 // Declare a local (not exported) templatized event type:
155 #define wxDECLARE_LOCAL_EVENT( name, type ) \
156 wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type )
158 // Don't cast the given event handler so that wxEvtHandler::Connect() sees
161 #define wxEVENT_HANDLER_CAST( functype, func ) \
165 // Template which associates the correct event object with the event type
167 #if !wxEVENTS_COMPATIBILITY_2_8
169 // The tag is a type associated to the event type (which is an integer itself,
170 // in spite of its name) value. It exists in order to be used as a template
171 // parameter and provide a mapping between the event type values and their
172 // corresponding wxEvent-derived classes.
173 template <typename T
>
177 // The class of wxEvent-derived class carried by the events of this type.
178 typedef T EventClass
;
180 wxEventTypeTag(wxEventType type
) { m_type
= type
; }
182 // Return a wxEventType reference for the initialization of the static
183 // event tables. See wxEventTableEntry::m_eventType for a more thorough
185 operator const wxEventType
&() const { return m_type
; }
191 #endif // !wxEVENTS_COMPATIBILITY_2_8
193 // These are needed for the functor definitions
194 typedef void (wxEvtHandler
::*wxEventFunction
)(wxEvent
&);
196 // We had some trouble (specifically with eVC for ARM WinCE build) with using
197 // wxEventFunction in the past so we had introduced wxObjectEventFunction which
198 // used to be a typedef for a member of wxObject and not wxEvtHandler to work
199 // around this but as eVC is not really supported any longer we now only keep
200 // this for backwards compatibility and, despite its name, this is a typedef
201 // for wxEvtHandler member now -- but if we have the same problem with another
202 // compiler we can restore its old definition for it.
203 typedef wxEventFunction wxObjectEventFunction
;
206 // The event functor which is stored in the static and dynamic event tables:
207 class WXDLLIMPEXP_BASE wxEventFunctor
210 virtual ~wxEventFunctor();
212 // Invoke the actual event handler:
213 virtual void operator()(wxEvtHandler
*, wxEvent
&) = 0;
215 // this function tests whether this functor is matched, for the purpose of
216 // finding it in an event table in Disconnect(), by the given func
217 virtual bool Matches(const wxEventFunctor
& func
) const = 0;
219 // these functions are used for functors comparison in Matches()
220 virtual void *GetHandler() const { return GetEvtHandler(); }
221 virtual wxEventFunction
GetMethod() const { return NULL
; }
223 // this one is also used elsewhere in the code and should be overridden to
224 // return non-NULL if we are indeed associated with an wxEvtHandler
225 virtual wxEvtHandler
*GetEvtHandler() const { return NULL
; }
228 // A plain method functor: notice that it is used even with the new events as
229 // it is reused as a specialization of wxEventFunctorMethod for legacy untyped
231 class WXDLLIMPEXP_BASE wxObjectEventFunctor
: public wxEventFunctor
234 wxObjectEventFunctor(wxObjectEventFunction method
, wxEvtHandler
*handler
)
240 virtual void operator()(wxEvtHandler
*handler
, wxEvent
& event
)
242 wxEvtHandler
* const realHandler
= m_handler ? m_handler
: handler
;
244 (realHandler
->*m_method
)(event
);
247 virtual bool Matches(const wxEventFunctor
& func
) const
249 void * const handler
= func
.GetHandler();
250 if ( handler
&& GetHandler() != handler
)
253 const wxEventFunction method
= GetMethod();
254 return !method
|| GetMethod() == method
;
257 virtual wxEvtHandler
*GetEvtHandler() const { return m_handler
; }
258 virtual wxEventFunction
GetMethod() const { return m_method
; }
261 wxEvtHandler
*m_handler
;
262 wxObjectEventFunction m_method
;
265 #if wxEVENTS_COMPATIBILITY_2_8
267 // Create a functor for the legacy events: handler can be NULL and its default
268 // value is used by the event table macros
270 inline wxObjectEventFunctor
*
271 wxNewEventFunctor(const wxEventType
& WXUNUSED(evtType
),
272 wxObjectEventFunction method
,
273 wxEvtHandler
*handler
= NULL
)
275 return new wxObjectEventFunctor(method
, handler
);
278 inline wxObjectEventFunctor
279 wxMakeEventFunctor(const wxEventType
& WXUNUSED(evtType
),
280 wxObjectEventFunction method
,
281 wxEvtHandler
*handler
)
283 return wxObjectEventFunctor(method
, handler
);
286 #else // !wxEVENTS_COMPATIBILITY_2_8
288 // functor forwarding the event to anything callable (function, static method,
289 // generalized functor...)
290 template <typename EventTag
, typename Functor
>
291 class wxEventFunctorFunction
: public wxEventFunctor
294 typedef typename EventTag
::EventClass EventArg
;
296 wxEventFunctorFunction(Functor handler
)
301 virtual void operator()(wxEvtHandler
*WXUNUSED(handler
), wxEvent
& event
)
303 m_handler(static_cast<EventArg
&>(event
));
306 virtual bool Matches(const wxEventFunctor
& WXUNUSED(func
)) const
308 // we have no way to compare arbitrary functors so just consider them
309 // to be equal: this means that disconnecting a functor will always
310 // find the last functor connected which in turn implies that it's
311 // probably a bad idea to connect more than one functor if you plan to
312 // disconnect them but this limitation doesn't seem very important in
321 // helper class defining operations different for method functors using an
322 // object of wxEvtHandler-derived class as handler and the others
326 template <typename T
, typename A
, bool> struct HandlerImpl
;
328 // specialization for handlers deriving from wxEvtHandler
329 template <typename T
, typename A
>
330 struct HandlerImpl
<T
, A
, true>
332 static bool IsEvtHandler()
334 static T
*ConvertFromEvtHandler(wxEvtHandler
*p
)
335 { return static_cast<T
*>(p
); }
336 static wxEvtHandler
*ConvertToEvtHandler(T
*p
)
338 static wxEventFunction
ConvertToEvtFunction(void (T
::*f
)(A
&))
339 { return reinterpret_cast<wxEventFunction
>(f
); }
342 // specialization for handlers not deriving from wxEvtHandler
343 template <typename T
, typename A
>
344 struct HandlerImpl
<T
, A
, false>
346 static bool IsEvtHandler()
348 static T
*ConvertFromEvtHandler(wxEvtHandler
*)
350 static wxEvtHandler
*ConvertToEvtHandler(T
*)
352 static wxEventFunction
ConvertToEvtFunction(void (T
::*)(A
&))
356 } // namespace wxPrivate
358 // functor forwarding the event to a method of the given object
360 // notice that the object class may be different from the class in which the
361 // method is defined but it must be convertible to this class
362 template <typename EventTag
, typename Class
, typename ObjClass
>
363 class wxEventFunctorMethod
364 : public wxEventFunctor
,
365 private wxPrivate
::HandlerImpl
368 typename EventTag
::EventClass
,
369 wxConvertibleTo
<Class
, wxEvtHandler
>::value
373 typedef typename EventTag
::EventClass EventArg
;
375 wxEventFunctorMethod(void (Class
::*method
)(EventArg
&), ObjClass
*handler
)
377 wxASSERT_MSG( handler
|| IsEvtHandler(),
378 "handlers defined in non-wxEvtHandler-derived classes "
379 "must be connected with a valid sink object" );
385 virtual void operator()(wxEvtHandler
*handler
, wxEvent
& event
)
387 Class
* realHandler
= m_handler
;
390 realHandler
= ConvertFromEvtHandler(handler
);
392 // this is not supposed to happen but check for it nevertheless
393 wxCHECK_RET( realHandler
, "invalid event handler" );
396 (realHandler
->*m_method
)(static_cast<EventArg
&>(event
));
399 virtual bool Matches(const wxEventFunctor
& func
) const
401 void * const handler
= func
.GetHandler();
402 if ( handler
&& GetHandler() != handler
)
405 const wxEventFunction method
= GetMethod();
406 return !method
|| GetMethod() == method
;
409 virtual void *GetHandler() const
414 virtual wxEventFunction
GetMethod() const
416 return ConvertToEvtFunction(m_method
);
419 virtual wxEvtHandler
*GetEvtHandler() const
421 return ConvertToEvtHandler(m_handler
);
426 void (Class
::*m_method
)(EventArg
&);
429 // partial specialization for legacy event types
430 template <typename ObjClass
>
431 class wxEventFunctorMethod
<wxEventType
, wxEvtHandler
, ObjClass
>
432 : public wxObjectEventFunctor
435 wxEventFunctorMethod(wxObjectEventFunction method
, ObjClass
*handler
)
436 : wxObjectEventFunctor(method
, handler
)
443 // Create functors for the templatized events, either allocated on the heap for
444 // wxNewXXX() variants (this is needed in wxEvtHandler::Connect() to store them
445 // in dynamic event table) or just by returning them as temporary objects (this
446 // is enough for Disconnect() and we allocate unnecessary heap allocation like
450 // Create functors wrapping other functors (including functions):
451 template <typename EventTag
, typename Functor
>
452 inline wxEventFunctorFunction
<EventTag
, Functor
> *
453 wxNewEventFunctor(const EventTag
&, Functor func
)
455 return new wxEventFunctorFunction
<EventTag
, Functor
>(func
);
458 template <typename EventTag
, typename Functor
>
459 inline wxEventFunctorFunction
<EventTag
, Functor
>
460 wxMakeEventFunctor(const EventTag
&, Functor func
)
462 return wxEventFunctorFunction
<EventTag
, Functor
>(func
);
466 // Create functors for methods:
468 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
469 inline wxEventFunctorMethod
<EventTag
, Class
, ObjClass
> *
470 wxNewEventFunctor(const EventTag
&,
471 void (Class
::*method
)(EventArg
&),
474 return new wxEventFunctorMethod
<EventTag
, Class
, ObjClass
>(method
, handler
);
478 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
479 inline wxEventFunctorMethod
<EventTag
, Class
, ObjClass
>
480 wxMakeEventFunctor(const EventTag
&,
481 void (Class
::*method
)(EventArg
&),
484 return wxEventFunctorMethod
<EventTag
, Class
, ObjClass
>(method
, handler
);
487 // Special case for the wxNewEventFunctor() calls used inside the event table
488 // macros: they don't specify the handler so ObjClass can't be deduced
489 template <typename EventTag
, typename Class
, typename EventArg
>
490 inline wxEventFunctorMethod
<EventTag
, Class
, Class
> *
491 wxNewEventFunctor(const EventTag
&, void (Class
::*method
)(EventArg
&))
493 return new wxEventFunctorMethod
<EventTag
, Class
, Class
>(method
, NULL
);
497 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
498 inline wxEventFunctorMethod
<EventTag
, Class
, Class
>
499 wxMakeEventFunctor(const EventTag
&, void (Class
::*method
)(EventArg
&))
501 return wxEventFunctorMethod
<EventTag
, Class
, Class
>(method
, NULL
);
504 #endif // !wxEVENTS_COMPATIBILITY_2_8
507 // many, but not all, standard event types
509 // some generic events
510 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_NULL
;
511 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_FIRST
;
512 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_USER_FIRST
;
514 // Need events declared to do this
515 class WXDLLIMPEXP_FWD_CORE wxCommandEvent
;
516 class WXDLLIMPEXP_FWD_CORE wxMouseEvent
;
517 class WXDLLIMPEXP_FWD_CORE wxFocusEvent
;
518 class WXDLLIMPEXP_FWD_CORE wxChildFocusEvent
;
519 class WXDLLIMPEXP_FWD_CORE wxKeyEvent
;
520 class WXDLLIMPEXP_FWD_CORE wxNavigationKeyEvent
;
521 class WXDLLIMPEXP_FWD_CORE wxSetCursorEvent
;
522 class WXDLLIMPEXP_FWD_CORE wxScrollEvent
;
523 class WXDLLIMPEXP_FWD_CORE wxSpinEvent
;
524 class WXDLLIMPEXP_FWD_CORE wxScrollWinEvent
;
525 class WXDLLIMPEXP_FWD_CORE wxSizeEvent
;
526 class WXDLLIMPEXP_FWD_CORE wxMoveEvent
;
527 class WXDLLIMPEXP_FWD_CORE wxCloseEvent
;
528 class WXDLLIMPEXP_FWD_CORE wxActivateEvent
;
529 class WXDLLIMPEXP_FWD_CORE wxWindowCreateEvent
;
530 class WXDLLIMPEXP_FWD_CORE wxWindowDestroyEvent
;
531 class WXDLLIMPEXP_FWD_CORE wxShowEvent
;
532 class WXDLLIMPEXP_FWD_CORE wxIconizeEvent
;
533 class WXDLLIMPEXP_FWD_CORE wxMaximizeEvent
;
534 class WXDLLIMPEXP_FWD_CORE wxMouseCaptureChangedEvent
;
535 class WXDLLIMPEXP_FWD_CORE wxMouseCaptureLostEvent
;
536 class WXDLLIMPEXP_FWD_CORE wxPaintEvent
;
537 class WXDLLIMPEXP_FWD_CORE wxEraseEvent
;
538 class WXDLLIMPEXP_FWD_CORE wxNcPaintEvent
;
539 class WXDLLIMPEXP_FWD_CORE wxMenuEvent
;
540 class WXDLLIMPEXP_FWD_CORE wxContextMenuEvent
;
541 class WXDLLIMPEXP_FWD_CORE wxSysColourChangedEvent
;
542 class WXDLLIMPEXP_FWD_CORE wxDisplayChangedEvent
;
543 class WXDLLIMPEXP_FWD_CORE wxQueryNewPaletteEvent
;
544 class WXDLLIMPEXP_FWD_CORE wxPaletteChangedEvent
;
545 class WXDLLIMPEXP_FWD_CORE wxJoystickEvent
;
546 class WXDLLIMPEXP_FWD_CORE wxDropFilesEvent
;
547 class WXDLLIMPEXP_FWD_CORE wxInitDialogEvent
;
548 class WXDLLIMPEXP_FWD_CORE wxIdleEvent
;
549 class WXDLLIMPEXP_FWD_CORE wxUpdateUIEvent
;
550 class WXDLLIMPEXP_FWD_CORE wxClipboardTextEvent
;
551 class WXDLLIMPEXP_FWD_CORE wxHelpEvent
;
555 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_BUTTON_CLICKED
, wxCommandEvent
)
556 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHECKBOX_CLICKED
, wxCommandEvent
)
557 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHOICE_SELECTED
, wxCommandEvent
)
558 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LISTBOX_SELECTED
, wxCommandEvent
)
559 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
, wxCommandEvent
)
560 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
, wxCommandEvent
)
561 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_MENU_SELECTED
, wxCommandEvent
)
562 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SLIDER_UPDATED
, wxCommandEvent
)
563 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RADIOBOX_SELECTED
, wxCommandEvent
)
564 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RADIOBUTTON_SELECTED
, wxCommandEvent
)
566 // wxEVT_COMMAND_SCROLLBAR_UPDATED is deprecated, use wxEVT_SCROLL... events
567 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SCROLLBAR_UPDATED
, wxCommandEvent
)
568 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_VLBOX_SELECTED
, wxCommandEvent
)
569 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_COMBOBOX_SELECTED
, wxCommandEvent
)
570 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_RCLICKED
, wxCommandEvent
)
571 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED
, wxCommandEvent
)
572 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_ENTER
, wxCommandEvent
)
575 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_DOWN
, wxMouseEvent
)
576 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_UP
, wxMouseEvent
)
577 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_DOWN
, wxMouseEvent
)
578 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_UP
, wxMouseEvent
)
579 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_DOWN
, wxMouseEvent
)
580 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_UP
, wxMouseEvent
)
581 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOTION
, wxMouseEvent
)
582 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ENTER_WINDOW
, wxMouseEvent
)
583 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEAVE_WINDOW
, wxMouseEvent
)
584 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_DCLICK
, wxMouseEvent
)
585 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_DCLICK
, wxMouseEvent
)
586 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_DCLICK
, wxMouseEvent
)
587 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SET_FOCUS
, wxFocusEvent
)
588 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KILL_FOCUS
, wxFocusEvent
)
589 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHILD_FOCUS
, wxChildFocusEvent
)
590 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSEWHEEL
, wxMouseEvent
)
591 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_DOWN
, wxMouseEvent
)
592 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_UP
, wxMouseEvent
)
593 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_DCLICK
, wxMouseEvent
)
594 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_DOWN
, wxMouseEvent
)
595 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_UP
, wxMouseEvent
)
596 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_DCLICK
, wxMouseEvent
)
598 // Character input event type
599 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHAR
, wxKeyEvent
)
600 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHAR_HOOK
, wxKeyEvent
)
601 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_NAVIGATION_KEY
, wxNavigationKeyEvent
)
602 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KEY_DOWN
, wxKeyEvent
)
603 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KEY_UP
, wxKeyEvent
)
605 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HOTKEY
, wxKeyEvent
)
608 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SET_CURSOR
, wxSetCursorEvent
)
610 // wxScrollBar and wxSlider event identifiers
611 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_TOP
, wxScrollEvent
)
612 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_BOTTOM
, wxScrollEvent
)
613 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_LINEUP
, wxScrollEvent
)
614 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_LINEDOWN
, wxScrollEvent
)
615 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_PAGEUP
, wxScrollEvent
)
616 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_PAGEDOWN
, wxScrollEvent
)
617 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_THUMBTRACK
, wxScrollEvent
)
618 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_THUMBRELEASE
, wxScrollEvent
)
619 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_CHANGED
, wxScrollEvent
)
621 // Due to a bug in older wx versions, wxSpinEvents were being sent with type of
622 // wxEVT_SCROLL_LINEUP, wxEVT_SCROLL_LINEDOWN and wxEVT_SCROLL_THUMBTRACK. But
623 // with the type-safe events in place, these event types are associated with
624 // wxScrollEvent. To allow handling of spin events, new event types have been
625 // defined in spinbutt.h/spinnbuttcmn.cpp. To maintain backward compatibility
626 // the spin event types are being initialized with the scroll event types.
630 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN_UP
, wxSpinEvent
)
631 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN_DOWN
, wxSpinEvent
)
632 wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE
, wxEVT_SPIN
, wxSpinEvent
)
636 // Scroll events from wxWindow
637 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_TOP
, wxScrollWinEvent
)
638 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_BOTTOM
, wxScrollWinEvent
)
639 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_LINEUP
, wxScrollWinEvent
)
640 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_LINEDOWN
, wxScrollWinEvent
)
641 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_PAGEUP
, wxScrollWinEvent
)
642 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_PAGEDOWN
, wxScrollWinEvent
)
643 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_THUMBTRACK
, wxScrollWinEvent
)
644 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_THUMBRELEASE
, wxScrollWinEvent
)
647 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SIZE
, wxSizeEvent
)
648 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE
, wxMoveEvent
)
649 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CLOSE_WINDOW
, wxCloseEvent
)
650 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_END_SESSION
, wxCloseEvent
)
651 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_QUERY_END_SESSION
, wxCloseEvent
)
652 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ACTIVATE_APP
, wxActivateEvent
)
653 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ACTIVATE
, wxActivateEvent
)
654 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CREATE
, wxWindowCreateEvent
)
655 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DESTROY
, wxWindowDestroyEvent
)
656 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SHOW
, wxShowEvent
)
657 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ICONIZE
, wxIconizeEvent
)
658 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MAXIMIZE
, wxMaximizeEvent
)
659 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSE_CAPTURE_CHANGED
, wxMouseCaptureChangedEvent
)
660 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSE_CAPTURE_LOST
, wxMouseCaptureLostEvent
)
661 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_PAINT
, wxPaintEvent
)
662 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ERASE_BACKGROUND
, wxEraseEvent
)
663 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_NC_PAINT
, wxNcPaintEvent
)
664 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_OPEN
, wxMenuEvent
)
665 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_CLOSE
, wxMenuEvent
)
666 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_HIGHLIGHT
, wxMenuEvent
)
667 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CONTEXT_MENU
, wxContextMenuEvent
)
668 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SYS_COLOUR_CHANGED
, wxSysColourChangedEvent
)
669 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DISPLAY_CHANGED
, wxDisplayChangedEvent
)
670 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_QUERY_NEW_PALETTE
, wxQueryNewPaletteEvent
)
671 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_PALETTE_CHANGED
, wxPaletteChangedEvent
)
672 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_BUTTON_DOWN
, wxJoystickEvent
)
673 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_BUTTON_UP
, wxJoystickEvent
)
674 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_MOVE
, wxJoystickEvent
)
675 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_ZMOVE
, wxJoystickEvent
)
676 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DROP_FILES
, wxDropFilesEvent
)
677 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_INIT_DIALOG
, wxInitDialogEvent
)
678 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_BASE
, wxEVT_IDLE
, wxIdleEvent
)
679 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_UPDATE_UI
, wxUpdateUIEvent
)
680 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SIZING
, wxSizeEvent
)
681 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVING
, wxMoveEvent
)
682 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE_START
, wxMoveEvent
)
683 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE_END
, wxMoveEvent
)
684 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HIBERNATE
, wxActivateEvent
)
687 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_COPY
, wxClipboardTextEvent
)
688 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_CUT
, wxClipboardTextEvent
)
689 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_PASTE
, wxClipboardTextEvent
)
691 // Generic command events
692 // Note: a click is a higher-level event than button down/up
693 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LEFT_CLICK
, wxCommandEvent
)
694 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LEFT_DCLICK
, wxCommandEvent
)
695 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RIGHT_CLICK
, wxCommandEvent
)
696 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RIGHT_DCLICK
, wxCommandEvent
)
697 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SET_FOCUS
, wxCommandEvent
)
698 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_KILL_FOCUS
, wxCommandEvent
)
699 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_ENTER
, wxCommandEvent
)
702 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HELP
, wxHelpEvent
)
703 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DETAILED_HELP
, wxHelpEvent
)
705 // these 2 events are the same
706 #define wxEVT_COMMAND_TOOL_CLICKED wxEVT_COMMAND_MENU_SELECTED
708 // ----------------------------------------------------------------------------
710 // ----------------------------------------------------------------------------
712 // this event is also used by wxComboBox and wxSpinCtrl which don't include
713 // wx/textctrl.h in all ports [yet], so declare it here as well
715 // still, any new code using it should include wx/textctrl.h explicitly
716 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_UPDATED
, wxCommandEvent
)
718 // the predefined constants for the number of times we propagate event
719 // upwards window child-parent chain
720 enum Propagation_state
722 // don't propagate it at all
723 wxEVENT_PROPAGATE_NONE
= 0,
725 // propagate it until it is processed
726 wxEVENT_PROPAGATE_MAX
= INT_MAX
730 * wxWidgets events, covering all interesting things that might happen
731 * (button clicking, resizing, setting text in widgets, etc.).
733 * For each completely new event type, derive a new event class.
734 * An event CLASS represents a C++ class defining a range of similar event TYPES;
735 * examples are canvas events, panel item command events.
736 * An event TYPE is a unique identifier for a particular system event,
737 * such as a button press or a listbox deselection.
741 class WXDLLIMPEXP_BASE wxEvent
: public wxObject
744 wxEvent(int winid
= 0, wxEventType commandType
= wxEVT_NULL
);
746 void SetEventType(wxEventType typ
) { m_eventType
= typ
; }
747 wxEventType
GetEventType() const { return m_eventType
; }
748 wxObject
*GetEventObject() const { return m_eventObject
; }
749 void SetEventObject(wxObject
*obj
) { m_eventObject
= obj
; }
750 long GetTimestamp() const { return m_timeStamp
; }
751 void SetTimestamp(long ts
= 0) { m_timeStamp
= ts
; }
752 int GetId() const { return m_id
; }
753 void SetId(int Id
) { m_id
= Id
; }
755 // Can instruct event processor that we wish to ignore this event
756 // (treat as if the event table entry had not been found): this must be done
757 // to allow the event processing by the base classes (calling event.Skip()
758 // is the analog of calling the base class version of a virtual function)
759 void Skip(bool skip
= true) { m_skipped
= skip
; }
760 bool GetSkipped() const { return m_skipped
; }
762 // This function is used to create a copy of the event polymorphically and
763 // all derived classes must implement it because otherwise wxPostEvent()
764 // for them wouldn't work (it needs to do a copy of the event)
765 virtual wxEvent
*Clone() const = 0;
767 // Implementation only: this test is explicitly anti OO and this function
768 // exists only for optimization purposes.
769 bool IsCommandEvent() const { return m_isCommandEvent
; }
771 // Determine if this event should be propagating to the parent window.
772 bool ShouldPropagate() const
773 { return m_propagationLevel
!= wxEVENT_PROPAGATE_NONE
; }
775 // Stop an event from propagating to its parent window, returns the old
776 // propagation level value
777 int StopPropagation()
779 int propagationLevel
= m_propagationLevel
;
780 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
781 return propagationLevel
;
784 // Resume the event propagation by restoring the propagation level
785 // (returned by StopPropagation())
786 void ResumePropagation(int propagationLevel
)
788 m_propagationLevel
= propagationLevel
;
792 // This is for internal use only and is only called by
793 // wxEvtHandler::ProcessEvent() to check whether it's the first time this
794 // event is being processed
797 if ( m_wasProcessed
)
800 m_wasProcessed
= true;
806 wxObject
* m_eventObject
;
807 wxEventType m_eventType
;
812 // m_callbackUserData is for internal usage only
813 wxObject
* m_callbackUserData
;
816 // the propagation level: while it is positive, we propagate the event to
817 // the parent window (if any)
819 // this one doesn't have to be public, we don't have to worry about
820 // backwards compatibility as it is new
821 int m_propagationLevel
;
824 bool m_isCommandEvent
;
826 // initially false but becomes true as soon as WasProcessed() is called for
827 // the first time, as this is done only by ProcessEvent() it explains the
828 // variable name: it becomes true after ProcessEvent() was called at least
829 // once for this event
833 wxEvent(const wxEvent
&); // for implementing Clone()
834 wxEvent
& operator=(const wxEvent
&); // for derived classes operator=()
837 // it needs to access our m_propagationLevel
838 friend class WXDLLIMPEXP_FWD_BASE wxPropagateOnce
;
840 DECLARE_ABSTRACT_CLASS(wxEvent
)
844 * Helper class to temporarily change an event not to propagate.
846 class WXDLLIMPEXP_BASE wxPropagationDisabler
849 wxPropagationDisabler(wxEvent
& event
) : m_event(event
)
851 m_propagationLevelOld
= m_event
.StopPropagation();
854 ~wxPropagationDisabler()
856 m_event
.ResumePropagation(m_propagationLevelOld
);
861 int m_propagationLevelOld
;
863 DECLARE_NO_COPY_CLASS(wxPropagationDisabler
)
867 * Another one to temporarily lower propagation level.
869 class WXDLLIMPEXP_BASE wxPropagateOnce
872 wxPropagateOnce(wxEvent
& event
) : m_event(event
)
874 wxASSERT_MSG( m_event
.m_propagationLevel
> 0,
875 _T("shouldn't be used unless ShouldPropagate()!") );
877 m_event
.m_propagationLevel
--;
882 m_event
.m_propagationLevel
++;
888 DECLARE_NO_COPY_CLASS(wxPropagateOnce
)
895 // Item or menu event class
897 wxEVT_COMMAND_BUTTON_CLICKED
898 wxEVT_COMMAND_CHECKBOX_CLICKED
899 wxEVT_COMMAND_CHOICE_SELECTED
900 wxEVT_COMMAND_LISTBOX_SELECTED
901 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
902 wxEVT_COMMAND_TEXT_UPDATED
903 wxEVT_COMMAND_TEXT_ENTER
904 wxEVT_COMMAND_MENU_SELECTED
905 wxEVT_COMMAND_SLIDER_UPDATED
906 wxEVT_COMMAND_RADIOBOX_SELECTED
907 wxEVT_COMMAND_RADIOBUTTON_SELECTED
908 wxEVT_COMMAND_SCROLLBAR_UPDATED
909 wxEVT_COMMAND_VLBOX_SELECTED
910 wxEVT_COMMAND_COMBOBOX_SELECTED
911 wxEVT_COMMAND_TOGGLEBUTTON_CLICKED
914 class WXDLLIMPEXP_CORE wxCommandEvent
: public wxEvent
917 wxCommandEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0);
919 wxCommandEvent(const wxCommandEvent
& event
)
921 m_cmdString(event
.m_cmdString
),
922 m_commandInt(event
.m_commandInt
),
923 m_extraLong(event
.m_extraLong
),
924 m_clientData(event
.m_clientData
),
925 m_clientObject(event
.m_clientObject
)
928 // Set/Get client data from controls
929 void SetClientData(void* clientData
) { m_clientData
= clientData
; }
930 void *GetClientData() const { return m_clientData
; }
932 // Set/Get client object from controls
933 void SetClientObject(wxClientData
* clientObject
) { m_clientObject
= clientObject
; }
934 wxClientData
*GetClientObject() const { return m_clientObject
; }
936 // Get listbox selection if single-choice
937 int GetSelection() const { return m_commandInt
; }
939 // Set/Get listbox/choice selection string
940 void SetString(const wxString
& s
) { m_cmdString
= s
; }
941 wxString
GetString() const;
943 // Get checkbox value
944 bool IsChecked() const { return m_commandInt
!= 0; }
946 // true if the listbox event was a selection.
947 bool IsSelection() const { return (m_extraLong
!= 0); }
949 void SetExtraLong(long extraLong
) { m_extraLong
= extraLong
; }
950 long GetExtraLong() const { return m_extraLong
; }
952 void SetInt(int i
) { m_commandInt
= i
; }
953 int GetInt() const { return m_commandInt
; }
955 virtual wxEvent
*Clone() const { return new wxCommandEvent(*this); }
958 wxString m_cmdString
; // String event argument
960 long m_extraLong
; // Additional information (e.g. select/deselect)
961 void* m_clientData
; // Arbitrary client data
962 wxClientData
* m_clientObject
; // Arbitrary client object
965 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCommandEvent
)
968 // this class adds a possibility to react (from the user) code to a control
969 // notification: allow or veto the operation being reported.
970 class WXDLLIMPEXP_CORE wxNotifyEvent
: public wxCommandEvent
973 wxNotifyEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0)
974 : wxCommandEvent(commandType
, winid
)
977 wxNotifyEvent(const wxNotifyEvent
& event
)
978 : wxCommandEvent(event
)
979 { m_bAllow
= event
.m_bAllow
; }
981 // veto the operation (usually it's allowed by default)
982 void Veto() { m_bAllow
= false; }
984 // allow the operation if it was disabled by default
985 void Allow() { m_bAllow
= true; }
987 // for implementation code only: is the operation allowed?
988 bool IsAllowed() const { return m_bAllow
; }
990 virtual wxEvent
*Clone() const { return new wxNotifyEvent(*this); }
996 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNotifyEvent
)
999 // Scroll event class, derived form wxCommandEvent. wxScrollEvents are
1000 // sent by wxSlider and wxScrollBar.
1005 wxEVT_SCROLL_LINEDOWN
1007 wxEVT_SCROLL_PAGEDOWN
1008 wxEVT_SCROLL_THUMBTRACK
1009 wxEVT_SCROLL_THUMBRELEASE
1010 wxEVT_SCROLL_CHANGED
1013 class WXDLLIMPEXP_CORE wxScrollEvent
: public wxCommandEvent
1016 wxScrollEvent(wxEventType commandType
= wxEVT_NULL
,
1017 int winid
= 0, int pos
= 0, int orient
= 0);
1019 int GetOrientation() const { return (int) m_extraLong
; }
1020 int GetPosition() const { return m_commandInt
; }
1021 void SetOrientation(int orient
) { m_extraLong
= (long) orient
; }
1022 void SetPosition(int pos
) { m_commandInt
= pos
; }
1024 virtual wxEvent
*Clone() const { return new wxScrollEvent(*this); }
1027 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollEvent
)
1030 // ScrollWin event class, derived fom wxEvent. wxScrollWinEvents
1031 // are sent by wxWindow.
1034 wxEVT_SCROLLWIN_BOTTOM
1035 wxEVT_SCROLLWIN_LINEUP
1036 wxEVT_SCROLLWIN_LINEDOWN
1037 wxEVT_SCROLLWIN_PAGEUP
1038 wxEVT_SCROLLWIN_PAGEDOWN
1039 wxEVT_SCROLLWIN_THUMBTRACK
1040 wxEVT_SCROLLWIN_THUMBRELEASE
1043 class WXDLLIMPEXP_CORE wxScrollWinEvent
: public wxEvent
1046 wxScrollWinEvent(wxEventType commandType
= wxEVT_NULL
,
1047 int pos
= 0, int orient
= 0);
1048 wxScrollWinEvent(const wxScrollWinEvent
& event
) : wxEvent(event
)
1049 { m_commandInt
= event
.m_commandInt
;
1050 m_extraLong
= event
.m_extraLong
; }
1052 int GetOrientation() const { return (int) m_extraLong
; }
1053 int GetPosition() const { return m_commandInt
; }
1054 void SetOrientation(int orient
) { m_extraLong
= (long) orient
; }
1055 void SetPosition(int pos
) { m_commandInt
= pos
; }
1057 virtual wxEvent
*Clone() const { return new wxScrollWinEvent(*this); }
1064 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollWinEvent
)
1067 // Mouse event class
1084 wxEVT_NC_MIDDLE_DOWN,
1086 wxEVT_NC_RIGHT_DOWN,
1089 wxEVT_NC_ENTER_WINDOW,
1090 wxEVT_NC_LEAVE_WINDOW,
1091 wxEVT_NC_LEFT_DCLICK,
1092 wxEVT_NC_MIDDLE_DCLICK,
1093 wxEVT_NC_RIGHT_DCLICK,
1096 // the symbolic names for the mouse buttons
1099 wxMOUSE_BTN_ANY
= -1,
1100 wxMOUSE_BTN_NONE
= 0,
1101 wxMOUSE_BTN_LEFT
= 1,
1102 wxMOUSE_BTN_MIDDLE
= 2,
1103 wxMOUSE_BTN_RIGHT
= 3,
1104 wxMOUSE_BTN_AUX1
= 4,
1105 wxMOUSE_BTN_AUX2
= 5,
1109 class WXDLLIMPEXP_CORE wxMouseEvent
: public wxEvent
,
1113 wxMouseEvent(wxEventType mouseType
= wxEVT_NULL
);
1114 wxMouseEvent(const wxMouseEvent
& event
)
1121 // Was it a button event? (*doesn't* mean: is any button *down*?)
1122 bool IsButton() const { return Button(wxMOUSE_BTN_ANY
); }
1124 // Was it a down event from this (or any) button?
1125 bool ButtonDown(int but
= wxMOUSE_BTN_ANY
) const;
1127 // Was it a dclick event from this (or any) button?
1128 bool ButtonDClick(int but
= wxMOUSE_BTN_ANY
) const;
1130 // Was it a up event from this (or any) button?
1131 bool ButtonUp(int but
= wxMOUSE_BTN_ANY
) const;
1133 // Was the given button?
1134 bool Button(int but
) const;
1136 // Was the given button in Down state?
1137 bool ButtonIsDown(int but
) const;
1139 // Get the button which is changing state (wxMOUSE_BTN_NONE if none)
1140 int GetButton() const;
1142 // Find which event was just generated
1143 bool LeftDown() const { return (m_eventType
== wxEVT_LEFT_DOWN
); }
1144 bool MiddleDown() const { return (m_eventType
== wxEVT_MIDDLE_DOWN
); }
1145 bool RightDown() const { return (m_eventType
== wxEVT_RIGHT_DOWN
); }
1146 bool Aux1Down() const { return (m_eventType
== wxEVT_AUX1_DOWN
); }
1147 bool Aux2Down() const { return (m_eventType
== wxEVT_AUX2_DOWN
); }
1149 bool LeftUp() const { return (m_eventType
== wxEVT_LEFT_UP
); }
1150 bool MiddleUp() const { return (m_eventType
== wxEVT_MIDDLE_UP
); }
1151 bool RightUp() const { return (m_eventType
== wxEVT_RIGHT_UP
); }
1152 bool Aux1Up() const { return (m_eventType
== wxEVT_AUX1_UP
); }
1153 bool Aux2Up() const { return (m_eventType
== wxEVT_AUX2_UP
); }
1155 bool LeftDClick() const { return (m_eventType
== wxEVT_LEFT_DCLICK
); }
1156 bool MiddleDClick() const { return (m_eventType
== wxEVT_MIDDLE_DCLICK
); }
1157 bool RightDClick() const { return (m_eventType
== wxEVT_RIGHT_DCLICK
); }
1158 bool Aux1DClick() const { return (m_eventType
== wxEVT_AUX1_UP
); }
1159 bool Aux2DClick() const { return (m_eventType
== wxEVT_AUX2_UP
); }
1161 // Find the current state of the mouse buttons (regardless
1162 // of current event type)
1163 bool LeftIsDown() const { return m_leftDown
; }
1164 bool MiddleIsDown() const { return m_middleDown
; }
1165 bool RightIsDown() const { return m_rightDown
; }
1166 bool Aux1IsDown() const { return m_aux1Down
; }
1167 bool Aux2IsDown() const { return m_aux2Down
; }
1169 // True if a button is down and the mouse is moving
1170 bool Dragging() const
1172 return (m_eventType
== wxEVT_MOTION
) && ButtonIsDown(wxMOUSE_BTN_ANY
);
1175 // True if the mouse is moving, and no button is down
1178 return (m_eventType
== wxEVT_MOTION
) && !ButtonIsDown(wxMOUSE_BTN_ANY
);
1181 // True if the mouse is just entering the window
1182 bool Entering() const { return (m_eventType
== wxEVT_ENTER_WINDOW
); }
1184 // True if the mouse is just leaving the window
1185 bool Leaving() const { return (m_eventType
== wxEVT_LEAVE_WINDOW
); }
1187 // Returns the number of mouse clicks associated with this event.
1188 int GetClickCount() const { return m_clickCount
; }
1191 // Find the position of the event
1192 void GetPosition(wxCoord
*xpos
, wxCoord
*ypos
) const
1200 void GetPosition(long *xpos
, long *ypos
) const
1208 // Find the position of the event
1209 wxPoint
GetPosition() const { return wxPoint(m_x
, m_y
); }
1211 // Find the logical position of the event given the DC
1212 wxPoint
GetLogicalPosition(const wxDC
& dc
) const;
1215 wxCoord
GetX() const { return m_x
; }
1218 wxCoord
GetY() const { return m_y
; }
1220 // Get wheel rotation, positive or negative indicates direction of
1221 // rotation. Current devices all send an event when rotation is equal to
1222 // +/-WheelDelta, but this allows for finer resolution devices to be
1223 // created in the future. Because of this you shouldn't assume that one
1224 // event is equal to 1 line or whatever, but you should be able to either
1225 // do partial line scrolling or wait until +/-WheelDelta rotation values
1226 // have been accumulated before scrolling.
1227 int GetWheelRotation() const { return m_wheelRotation
; }
1229 // Get wheel delta, normally 120. This is the threshold for action to be
1230 // taken, and one such action (for example, scrolling one increment)
1231 // should occur for each delta.
1232 int GetWheelDelta() const { return m_wheelDelta
; }
1234 // Gets the axis the wheel operation concerns, 0 being the y axis as on
1235 // most mouse wheels, 1 is the x axis for things like MightyMouse scrolls
1236 // or horizontal trackpad scrolling
1237 int GetWheelAxis() const { return m_wheelAxis
; }
1239 // Returns the configured number of lines (or whatever) to be scrolled per
1240 // wheel action. Defaults to one.
1241 int GetLinesPerAction() const { return m_linesPerAction
; }
1243 // Is the system set to do page scrolling?
1244 bool IsPageScroll() const { return ((unsigned int)m_linesPerAction
== UINT_MAX
); }
1246 virtual wxEvent
*Clone() const { return new wxMouseEvent(*this); }
1248 wxMouseEvent
& operator=(const wxMouseEvent
& event
)
1267 int m_wheelRotation
;
1269 int m_linesPerAction
;
1272 void Assign(const wxMouseEvent
& evt
);
1275 DECLARE_DYNAMIC_CLASS(wxMouseEvent
)
1284 class WXDLLIMPEXP_CORE wxSetCursorEvent
: public wxEvent
1287 wxSetCursorEvent(wxCoord x
= 0, wxCoord y
= 0)
1288 : wxEvent(0, wxEVT_SET_CURSOR
),
1289 m_x(x
), m_y(y
), m_cursor()
1292 wxSetCursorEvent(const wxSetCursorEvent
& event
)
1296 m_cursor(event
.m_cursor
)
1299 wxCoord
GetX() const { return m_x
; }
1300 wxCoord
GetY() const { return m_y
; }
1302 void SetCursor(const wxCursor
& cursor
) { m_cursor
= cursor
; }
1303 const wxCursor
& GetCursor() const { return m_cursor
; }
1304 bool HasCursor() const { return m_cursor
.Ok(); }
1306 virtual wxEvent
*Clone() const { return new wxSetCursorEvent(*this); }
1313 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSetCursorEvent
)
1316 // Keyboard input event class
1326 class WXDLLIMPEXP_CORE wxKeyEvent
: public wxEvent
,
1327 public wxKeyboardState
1330 wxKeyEvent(wxEventType keyType
= wxEVT_NULL
);
1331 wxKeyEvent(const wxKeyEvent
& evt
);
1333 // get the key code: an ASCII7 char or an element of wxKeyCode enum
1334 int GetKeyCode() const { return (int)m_keyCode
; }
1337 // get the Unicode character corresponding to this key
1338 wxChar
GetUnicodeKey() const { return m_uniChar
; }
1339 #endif // wxUSE_UNICODE
1341 // get the raw key code (platform-dependent)
1342 wxUint32
GetRawKeyCode() const { return m_rawCode
; }
1344 // get the raw key flags (platform-dependent)
1345 wxUint32
GetRawKeyFlags() const { return m_rawFlags
; }
1347 // Find the position of the event
1348 void GetPosition(wxCoord
*xpos
, wxCoord
*ypos
) const
1350 if (xpos
) *xpos
= m_x
;
1351 if (ypos
) *ypos
= m_y
;
1354 void GetPosition(long *xpos
, long *ypos
) const
1356 if (xpos
) *xpos
= (long)m_x
;
1357 if (ypos
) *ypos
= (long)m_y
;
1360 wxPoint
GetPosition() const
1361 { return wxPoint(m_x
, m_y
); }
1364 wxCoord
GetX() const { return m_x
; }
1367 wxCoord
GetY() const { return m_y
; }
1369 virtual wxEvent
*Clone() const { return new wxKeyEvent(*this); }
1371 // we do need to copy wxKeyEvent sometimes (in wxTreeCtrl code, for
1373 wxKeyEvent
& operator=(const wxKeyEvent
& evt
)
1377 wxEvent
::operator=(evt
);
1379 // Borland C++ 5.82 doesn't compile an explicit call to an
1380 // implicitly defined operator=() so need to do it this way:
1381 *static_cast<wxKeyboardState
*>(this) = evt
;
1386 m_keyCode
= evt
.m_keyCode
;
1388 m_scanCode
= evt
.m_scanCode
;
1389 m_rawCode
= evt
.m_rawCode
;
1390 m_rawFlags
= evt
.m_rawFlags
;
1392 m_uniChar
= evt
.m_uniChar
;
1403 // FIXME: what is this for? relation to m_rawXXX?
1407 // This contains the full Unicode character
1408 // in a character events in Unicode mode
1412 // these fields contain the platform-specific information about
1413 // key that was pressed
1415 wxUint32 m_rawFlags
;
1418 DECLARE_DYNAMIC_CLASS(wxKeyEvent
)
1426 class WXDLLIMPEXP_CORE wxSizeEvent
: public wxEvent
1429 wxSizeEvent() : wxEvent(0, wxEVT_SIZE
)
1431 wxSizeEvent(const wxSize
& sz
, int winid
= 0)
1432 : wxEvent(winid
, wxEVT_SIZE
),
1435 wxSizeEvent(const wxSizeEvent
& event
)
1437 m_size(event
.m_size
), m_rect(event
.m_rect
)
1439 wxSizeEvent(const wxRect
& rect
, int id
= 0)
1440 : m_size(rect
.GetSize()), m_rect(rect
)
1441 { m_eventType
= wxEVT_SIZING
; m_id
= id
; }
1443 wxSize
GetSize() const { return m_size
; }
1444 wxRect
GetRect() const { return m_rect
; }
1445 void SetRect(const wxRect
& rect
) { m_rect
= rect
; }
1447 virtual wxEvent
*Clone() const { return new wxSizeEvent(*this); }
1450 // For internal usage only. Will be converted to protected members.
1452 wxRect m_rect
; // Used for wxEVT_SIZING
1455 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSizeEvent
)
1464 class WXDLLIMPEXP_CORE wxMoveEvent
: public wxEvent
1468 : wxEvent(0, wxEVT_MOVE
)
1470 wxMoveEvent(const wxPoint
& pos
, int winid
= 0)
1471 : wxEvent(winid
, wxEVT_MOVE
),
1474 wxMoveEvent(const wxMoveEvent
& event
)
1478 wxMoveEvent(const wxRect
& rect
, int id
= 0)
1479 : m_pos(rect
.GetPosition()), m_rect(rect
)
1480 { m_eventType
= wxEVT_MOVING
; m_id
= id
; }
1482 wxPoint
GetPosition() const { return m_pos
; }
1483 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
1484 wxRect
GetRect() const { return m_rect
; }
1485 void SetRect(const wxRect
& rect
) { m_rect
= rect
; }
1487 virtual wxEvent
*Clone() const { return new wxMoveEvent(*this); }
1494 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMoveEvent
)
1497 // Paint event class
1504 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1505 // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined
1506 extern WXDLLIMPEXP_CORE
int g_isPainting
;
1509 class WXDLLIMPEXP_CORE wxPaintEvent
: public wxEvent
1512 wxPaintEvent(int Id
= 0)
1513 : wxEvent(Id
, wxEVT_PAINT
)
1515 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1516 // set the internal flag for the duration of processing of WM_PAINT
1521 // default copy ctor and dtor are normally fine, we only need them to keep
1522 // g_isPainting updated in debug build
1523 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1524 wxPaintEvent(const wxPaintEvent
& event
)
1530 virtual ~wxPaintEvent()
1536 virtual wxEvent
*Clone() const { return new wxPaintEvent(*this); }
1539 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaintEvent
)
1542 class WXDLLIMPEXP_CORE wxNcPaintEvent
: public wxEvent
1545 wxNcPaintEvent(int winid
= 0)
1546 : wxEvent(winid
, wxEVT_NC_PAINT
)
1549 virtual wxEvent
*Clone() const { return new wxNcPaintEvent(*this); }
1552 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNcPaintEvent
)
1555 // Erase background event class
1557 wxEVT_ERASE_BACKGROUND
1560 class WXDLLIMPEXP_CORE wxEraseEvent
: public wxEvent
1563 wxEraseEvent(int Id
= 0, wxDC
*dc
= NULL
)
1564 : wxEvent(Id
, wxEVT_ERASE_BACKGROUND
),
1568 wxEraseEvent(const wxEraseEvent
& event
)
1573 wxDC
*GetDC() const { return m_dc
; }
1575 virtual wxEvent
*Clone() const { return new wxEraseEvent(*this); }
1581 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxEraseEvent
)
1584 // Focus event class
1590 class WXDLLIMPEXP_CORE wxFocusEvent
: public wxEvent
1593 wxFocusEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0)
1594 : wxEvent(winid
, type
)
1597 wxFocusEvent(const wxFocusEvent
& event
)
1599 { m_win
= event
.m_win
; }
1601 // The window associated with this event is the window which had focus
1602 // before for SET event and the window which will have focus for the KILL
1603 // one. NB: it may be NULL in both cases!
1604 wxWindow
*GetWindow() const { return m_win
; }
1605 void SetWindow(wxWindow
*win
) { m_win
= win
; }
1607 virtual wxEvent
*Clone() const { return new wxFocusEvent(*this); }
1613 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFocusEvent
)
1616 // wxChildFocusEvent notifies the parent that a child has got the focus: unlike
1617 // wxFocusEvent it is propagated upwards the window chain
1618 class WXDLLIMPEXP_CORE wxChildFocusEvent
: public wxCommandEvent
1621 wxChildFocusEvent(wxWindow
*win
= NULL
);
1623 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
1625 virtual wxEvent
*Clone() const { return new wxChildFocusEvent(*this); }
1628 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxChildFocusEvent
)
1631 // Activate event class
1638 class WXDLLIMPEXP_CORE wxActivateEvent
: public wxEvent
1641 wxActivateEvent(wxEventType type
= wxEVT_NULL
, bool active
= true, int Id
= 0)
1643 { m_active
= active
; }
1644 wxActivateEvent(const wxActivateEvent
& event
)
1646 { m_active
= event
.m_active
; }
1648 bool GetActive() const { return m_active
; }
1650 virtual wxEvent
*Clone() const { return new wxActivateEvent(*this); }
1656 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxActivateEvent
)
1659 // InitDialog event class
1664 class WXDLLIMPEXP_CORE wxInitDialogEvent
: public wxEvent
1667 wxInitDialogEvent(int Id
= 0)
1668 : wxEvent(Id
, wxEVT_INIT_DIALOG
)
1671 virtual wxEvent
*Clone() const { return new wxInitDialogEvent(*this); }
1674 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxInitDialogEvent
)
1677 // Miscellaneous menu event class
1681 wxEVT_MENU_HIGHLIGHT,
1684 class WXDLLIMPEXP_CORE wxMenuEvent
: public wxEvent
1687 wxMenuEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0, wxMenu
* menu
= NULL
)
1688 : wxEvent(winid
, type
)
1689 { m_menuId
= winid
; m_menu
= menu
; }
1690 wxMenuEvent(const wxMenuEvent
& event
)
1692 { m_menuId
= event
.m_menuId
; m_menu
= event
.m_menu
; }
1694 // only for wxEVT_MENU_HIGHLIGHT
1695 int GetMenuId() const { return m_menuId
; }
1697 // only for wxEVT_MENU_OPEN/CLOSE
1698 bool IsPopup() const { return m_menuId
== wxID_ANY
; }
1700 // only for wxEVT_MENU_OPEN/CLOSE
1701 wxMenu
* GetMenu() const { return m_menu
; }
1703 virtual wxEvent
*Clone() const { return new wxMenuEvent(*this); }
1709 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMenuEvent
)
1712 // Window close or session close event class
1716 wxEVT_QUERY_END_SESSION
1719 class WXDLLIMPEXP_CORE wxCloseEvent
: public wxEvent
1722 wxCloseEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0)
1723 : wxEvent(winid
, type
),
1725 m_veto(false), // should be false by default
1728 wxCloseEvent(const wxCloseEvent
& event
)
1730 m_loggingOff(event
.m_loggingOff
),
1731 m_veto(event
.m_veto
),
1732 m_canVeto(event
.m_canVeto
) {}
1734 void SetLoggingOff(bool logOff
) { m_loggingOff
= logOff
; }
1735 bool GetLoggingOff() const
1737 // m_loggingOff flag is only used by wxEVT_[QUERY_]END_SESSION, it
1738 // doesn't make sense for wxEVT_CLOSE_WINDOW
1739 wxASSERT_MSG( m_eventType
!= wxEVT_CLOSE_WINDOW
,
1740 _T("this flag is for end session events only") );
1742 return m_loggingOff
;
1745 void Veto(bool veto
= true)
1747 // GetVeto() will return false anyhow...
1748 wxCHECK_RET( m_canVeto
,
1749 wxT("call to Veto() ignored (can't veto this event)") );
1753 void SetCanVeto(bool canVeto
) { m_canVeto
= canVeto
; }
1754 bool CanVeto() const { return m_canVeto
; }
1755 bool GetVeto() const { return m_canVeto
&& m_veto
; }
1757 virtual wxEvent
*Clone() const { return new wxCloseEvent(*this); }
1765 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCloseEvent
)
1772 class WXDLLIMPEXP_CORE wxShowEvent
: public wxEvent
1775 wxShowEvent(int winid
= 0, bool show
= false)
1776 : wxEvent(winid
, wxEVT_SHOW
)
1778 wxShowEvent(const wxShowEvent
& event
)
1780 { m_show
= event
.m_show
; }
1782 void SetShow(bool show
) { m_show
= show
; }
1784 // return true if the window was shown, false if hidden
1785 bool IsShown() const { return m_show
; }
1787 #if WXWIN_COMPATIBILITY_2_8
1788 wxDEPRECATED( bool GetShow() const { return IsShown(); } )
1791 virtual wxEvent
*Clone() const { return new wxShowEvent(*this); }
1797 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxShowEvent
)
1804 class WXDLLIMPEXP_CORE wxIconizeEvent
: public wxEvent
1807 wxIconizeEvent(int winid
= 0, bool iconized
= true)
1808 : wxEvent(winid
, wxEVT_ICONIZE
)
1809 { m_iconized
= iconized
; }
1810 wxIconizeEvent(const wxIconizeEvent
& event
)
1812 { m_iconized
= event
.m_iconized
; }
1814 #if WXWIN_COMPATIBILITY_2_8
1815 wxDEPRECATED( bool Iconized() const { return IsIconized(); } )
1817 // return true if the frame was iconized, false if restored
1818 bool IsIconized() const { return m_iconized
; }
1820 virtual wxEvent
*Clone() const { return new wxIconizeEvent(*this); }
1826 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIconizeEvent
)
1832 class WXDLLIMPEXP_CORE wxMaximizeEvent
: public wxEvent
1835 wxMaximizeEvent(int winid
= 0)
1836 : wxEvent(winid
, wxEVT_MAXIMIZE
)
1839 virtual wxEvent
*Clone() const { return new wxMaximizeEvent(*this); }
1842 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMaximizeEvent
)
1845 // Joystick event class
1847 wxEVT_JOY_BUTTON_DOWN,
1848 wxEVT_JOY_BUTTON_UP,
1853 // Which joystick? Same as Windows ids so no conversion necessary.
1860 // Which button is down?
1863 wxJOY_BUTTON_ANY
= -1,
1870 class WXDLLIMPEXP_CORE wxJoystickEvent
: public wxEvent
1875 int m_buttonChange
; // Which button changed?
1876 int m_buttonState
; // Which buttons are down?
1877 int m_joyStick
; // Which joystick?
1880 wxJoystickEvent(wxEventType type
= wxEVT_NULL
,
1882 int joystick
= wxJOYSTICK1
,
1887 m_buttonChange(change
),
1888 m_buttonState(state
),
1889 m_joyStick(joystick
)
1892 wxJoystickEvent(const wxJoystickEvent
& event
)
1895 m_zPosition(event
.m_zPosition
),
1896 m_buttonChange(event
.m_buttonChange
),
1897 m_buttonState(event
.m_buttonState
),
1898 m_joyStick(event
.m_joyStick
)
1901 wxPoint
GetPosition() const { return m_pos
; }
1902 int GetZPosition() const { return m_zPosition
; }
1903 int GetButtonState() const { return m_buttonState
; }
1904 int GetButtonChange() const { return m_buttonChange
; }
1905 int GetJoystick() const { return m_joyStick
; }
1907 void SetJoystick(int stick
) { m_joyStick
= stick
; }
1908 void SetButtonState(int state
) { m_buttonState
= state
; }
1909 void SetButtonChange(int change
) { m_buttonChange
= change
; }
1910 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
1911 void SetZPosition(int zPos
) { m_zPosition
= zPos
; }
1913 // Was it a button event? (*doesn't* mean: is any button *down*?)
1914 bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN
) ||
1915 (GetEventType() == wxEVT_JOY_BUTTON_UP
)); }
1917 // Was it a move event?
1918 bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE
); }
1920 // Was it a zmove event?
1921 bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE
); }
1923 // Was it a down event from button 1, 2, 3, 4 or any?
1924 bool ButtonDown(int but
= wxJOY_BUTTON_ANY
) const
1925 { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN
) &&
1926 ((but
== wxJOY_BUTTON_ANY
) || (but
== m_buttonChange
))); }
1928 // Was it a up event from button 1, 2, 3 or any?
1929 bool ButtonUp(int but
= wxJOY_BUTTON_ANY
) const
1930 { return ((GetEventType() == wxEVT_JOY_BUTTON_UP
) &&
1931 ((but
== wxJOY_BUTTON_ANY
) || (but
== m_buttonChange
))); }
1933 // Was the given button 1,2,3,4 or any in Down state?
1934 bool ButtonIsDown(int but
= wxJOY_BUTTON_ANY
) const
1935 { return (((but
== wxJOY_BUTTON_ANY
) && (m_buttonState
!= 0)) ||
1936 ((m_buttonState
& but
) == but
)); }
1938 virtual wxEvent
*Clone() const { return new wxJoystickEvent(*this); }
1941 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxJoystickEvent
)
1944 // Drop files event class
1949 class WXDLLIMPEXP_CORE wxDropFilesEvent
: public wxEvent
1956 wxDropFilesEvent(wxEventType type
= wxEVT_NULL
,
1958 wxString
*files
= NULL
)
1965 // we need a copy ctor to avoid deleting m_files pointer twice
1966 wxDropFilesEvent(const wxDropFilesEvent
& other
)
1968 m_noFiles(other
.m_noFiles
),
1972 m_files
= new wxString
[m_noFiles
];
1973 for ( int n
= 0; n
< m_noFiles
; n
++ )
1975 m_files
[n
] = other
.m_files
[n
];
1979 virtual ~wxDropFilesEvent()
1984 wxPoint
GetPosition() const { return m_pos
; }
1985 int GetNumberOfFiles() const { return m_noFiles
; }
1986 wxString
*GetFiles() const { return m_files
; }
1988 virtual wxEvent
*Clone() const { return new wxDropFilesEvent(*this); }
1991 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDropFilesEvent
)
1999 // Whether to always send update events to windows, or
2000 // to only send update events to those with the
2001 // wxWS_EX_PROCESS_UI_UPDATES style.
2005 // Send UI update events to all windows
2006 wxUPDATE_UI_PROCESS_ALL
,
2008 // Send UI update events to windows that have
2009 // the wxWS_EX_PROCESS_UI_UPDATES flag specified
2010 wxUPDATE_UI_PROCESS_SPECIFIED
2013 class WXDLLIMPEXP_CORE wxUpdateUIEvent
: public wxCommandEvent
2016 wxUpdateUIEvent(wxWindowID commandId
= 0)
2017 : wxCommandEvent(wxEVT_UPDATE_UI
, commandId
)
2025 m_setChecked
= false;
2027 wxUpdateUIEvent(const wxUpdateUIEvent
& event
)
2028 : wxCommandEvent(event
),
2029 m_checked(event
.m_checked
),
2030 m_enabled(event
.m_enabled
),
2031 m_shown(event
.m_shown
),
2032 m_setEnabled(event
.m_setEnabled
),
2033 m_setShown(event
.m_setShown
),
2034 m_setText(event
.m_setText
),
2035 m_setChecked(event
.m_setChecked
),
2036 m_text(event
.m_text
)
2039 bool GetChecked() const { return m_checked
; }
2040 bool GetEnabled() const { return m_enabled
; }
2041 bool GetShown() const { return m_shown
; }
2042 wxString
GetText() const { return m_text
; }
2043 bool GetSetText() const { return m_setText
; }
2044 bool GetSetChecked() const { return m_setChecked
; }
2045 bool GetSetEnabled() const { return m_setEnabled
; }
2046 bool GetSetShown() const { return m_setShown
; }
2048 void Check(bool check
) { m_checked
= check
; m_setChecked
= true; }
2049 void Enable(bool enable
) { m_enabled
= enable
; m_setEnabled
= true; }
2050 void Show(bool show
) { m_shown
= show
; m_setShown
= true; }
2051 void SetText(const wxString
& text
) { m_text
= text
; m_setText
= true; }
2053 // Sets the interval between updates in milliseconds.
2054 // Set to -1 to disable updates, or to 0 to update as frequently as possible.
2055 static void SetUpdateInterval(long updateInterval
) { sm_updateInterval
= updateInterval
; }
2057 // Returns the current interval between updates in milliseconds
2058 static long GetUpdateInterval() { return sm_updateInterval
; }
2060 // Can we update this window?
2061 static bool CanUpdate(wxWindowBase
*win
);
2063 // Reset the update time to provide a delay until the next
2064 // time we should update
2065 static void ResetUpdateTime();
2067 // Specify how wxWidgets will send update events: to
2068 // all windows, or only to those which specify that they
2069 // will process the events.
2070 static void SetMode(wxUpdateUIMode mode
) { sm_updateMode
= mode
; }
2072 // Returns the UI update mode
2073 static wxUpdateUIMode
GetMode() { return sm_updateMode
; }
2075 virtual wxEvent
*Clone() const { return new wxUpdateUIEvent(*this); }
2087 static wxLongLong sm_lastUpdate
;
2089 static long sm_updateInterval
;
2090 static wxUpdateUIMode sm_updateMode
;
2093 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxUpdateUIEvent
)
2097 wxEVT_SYS_COLOUR_CHANGED
2100 // TODO: shouldn't all events record the window ID?
2101 class WXDLLIMPEXP_CORE wxSysColourChangedEvent
: public wxEvent
2104 wxSysColourChangedEvent()
2105 : wxEvent(0, wxEVT_SYS_COLOUR_CHANGED
)
2108 virtual wxEvent
*Clone() const { return new wxSysColourChangedEvent(*this); }
2111 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSysColourChangedEvent
)
2115 wxEVT_MOUSE_CAPTURE_CHANGED
2116 The window losing the capture receives this message
2117 (even if it released the capture itself).
2120 class WXDLLIMPEXP_CORE wxMouseCaptureChangedEvent
: public wxEvent
2123 wxMouseCaptureChangedEvent(wxWindowID winid
= 0, wxWindow
* gainedCapture
= NULL
)
2124 : wxEvent(winid
, wxEVT_MOUSE_CAPTURE_CHANGED
),
2125 m_gainedCapture(gainedCapture
)
2128 wxMouseCaptureChangedEvent(const wxMouseCaptureChangedEvent
& event
)
2130 m_gainedCapture(event
.m_gainedCapture
)
2133 virtual wxEvent
*Clone() const { return new wxMouseCaptureChangedEvent(*this); }
2135 wxWindow
* GetCapturedWindow() const { return m_gainedCapture
; }
2138 wxWindow
* m_gainedCapture
;
2140 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureChangedEvent
)
2144 wxEVT_MOUSE_CAPTURE_LOST
2145 The window losing the capture receives this message, unless it released it
2146 it itself or unless wxWindow::CaptureMouse was called on another window
2147 (and so capture will be restored when the new capturer releases it).
2150 class WXDLLIMPEXP_CORE wxMouseCaptureLostEvent
: public wxEvent
2153 wxMouseCaptureLostEvent(wxWindowID winid
= 0)
2154 : wxEvent(winid
, wxEVT_MOUSE_CAPTURE_LOST
)
2157 wxMouseCaptureLostEvent(const wxMouseCaptureLostEvent
& event
)
2161 virtual wxEvent
*Clone() const { return new wxMouseCaptureLostEvent(*this); }
2163 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureLostEvent
)
2167 wxEVT_DISPLAY_CHANGED
2169 class WXDLLIMPEXP_CORE wxDisplayChangedEvent
: public wxEvent
2172 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDisplayChangedEvent
)
2175 wxDisplayChangedEvent()
2176 : wxEvent(0, wxEVT_DISPLAY_CHANGED
)
2179 virtual wxEvent
*Clone() const { return new wxDisplayChangedEvent(*this); }
2183 wxEVT_PALETTE_CHANGED
2186 class WXDLLIMPEXP_CORE wxPaletteChangedEvent
: public wxEvent
2189 wxPaletteChangedEvent(wxWindowID winid
= 0)
2190 : wxEvent(winid
, wxEVT_PALETTE_CHANGED
),
2191 m_changedWindow(NULL
)
2194 wxPaletteChangedEvent(const wxPaletteChangedEvent
& event
)
2196 m_changedWindow(event
.m_changedWindow
)
2199 void SetChangedWindow(wxWindow
* win
) { m_changedWindow
= win
; }
2200 wxWindow
* GetChangedWindow() const { return m_changedWindow
; }
2202 virtual wxEvent
*Clone() const { return new wxPaletteChangedEvent(*this); }
2205 wxWindow
* m_changedWindow
;
2208 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaletteChangedEvent
)
2212 wxEVT_QUERY_NEW_PALETTE
2213 Indicates the window is getting keyboard focus and should re-do its palette.
2216 class WXDLLIMPEXP_CORE wxQueryNewPaletteEvent
: public wxEvent
2219 wxQueryNewPaletteEvent(wxWindowID winid
= 0)
2220 : wxEvent(winid
, wxEVT_QUERY_NEW_PALETTE
),
2221 m_paletteRealized(false)
2223 wxQueryNewPaletteEvent(const wxQueryNewPaletteEvent
& event
)
2225 m_paletteRealized(event
.m_paletteRealized
)
2228 // App sets this if it changes the palette.
2229 void SetPaletteRealized(bool realized
) { m_paletteRealized
= realized
; }
2230 bool GetPaletteRealized() const { return m_paletteRealized
; }
2232 virtual wxEvent
*Clone() const { return new wxQueryNewPaletteEvent(*this); }
2235 bool m_paletteRealized
;
2238 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxQueryNewPaletteEvent
)
2242 Event generated by dialog navigation keys
2243 wxEVT_NAVIGATION_KEY
2245 // NB: don't derive from command event to avoid being propagated to the parent
2246 class WXDLLIMPEXP_CORE wxNavigationKeyEvent
: public wxEvent
2249 wxNavigationKeyEvent()
2250 : wxEvent(0, wxEVT_NAVIGATION_KEY
),
2251 m_flags(IsForward
| FromTab
), // defaults are for TAB
2254 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
2257 wxNavigationKeyEvent(const wxNavigationKeyEvent
& event
)
2259 m_flags(event
.m_flags
),
2260 m_focus(event
.m_focus
)
2263 // direction: forward (true) or backward (false)
2264 bool GetDirection() const
2265 { return (m_flags
& IsForward
) != 0; }
2266 void SetDirection(bool bForward
)
2267 { if ( bForward
) m_flags
|= IsForward
; else m_flags
&= ~IsForward
; }
2269 // it may be a window change event (MDI, notebook pages...) or a control
2271 bool IsWindowChange() const
2272 { return (m_flags
& WinChange
) != 0; }
2273 void SetWindowChange(bool bIs
)
2274 { if ( bIs
) m_flags
|= WinChange
; else m_flags
&= ~WinChange
; }
2276 // Set to true under MSW if the event was generated using the tab key.
2277 // This is required for proper navogation over radio buttons
2278 bool IsFromTab() const
2279 { return (m_flags
& FromTab
) != 0; }
2280 void SetFromTab(bool bIs
)
2281 { if ( bIs
) m_flags
|= FromTab
; else m_flags
&= ~FromTab
; }
2283 // the child which has the focus currently (may be NULL - use
2284 // wxWindow::FindFocus then)
2285 wxWindow
* GetCurrentFocus() const { return m_focus
; }
2286 void SetCurrentFocus(wxWindow
*win
) { m_focus
= win
; }
2289 void SetFlags(long flags
) { m_flags
= flags
; }
2291 virtual wxEvent
*Clone() const { return new wxNavigationKeyEvent(*this); }
2295 IsBackward
= 0x0000,
2305 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNavigationKeyEvent
)
2308 // Window creation/destruction events: the first is sent as soon as window is
2309 // created (i.e. the underlying GUI object exists), but when the C++ object is
2310 // fully initialized (so virtual functions may be called). The second,
2311 // wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
2312 // still safe to call virtual functions at this moment
2318 class WXDLLIMPEXP_CORE wxWindowCreateEvent
: public wxCommandEvent
2321 wxWindowCreateEvent(wxWindow
*win
= NULL
);
2323 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
2325 virtual wxEvent
*Clone() const { return new wxWindowCreateEvent(*this); }
2328 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowCreateEvent
)
2331 class WXDLLIMPEXP_CORE wxWindowDestroyEvent
: public wxCommandEvent
2334 wxWindowDestroyEvent(wxWindow
*win
= NULL
);
2336 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
2338 virtual wxEvent
*Clone() const { return new wxWindowDestroyEvent(*this); }
2341 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowDestroyEvent
)
2344 // A help event is sent when the user clicks on a window in context-help mode.
2350 class WXDLLIMPEXP_CORE wxHelpEvent
: public wxCommandEvent
2353 // how was this help event generated?
2356 Origin_Unknown
, // unrecognized event source
2357 Origin_Keyboard
, // event generated from F1 key press
2358 Origin_HelpButton
// event from [?] button on the title bar (Windows)
2361 wxHelpEvent(wxEventType type
= wxEVT_NULL
,
2362 wxWindowID winid
= 0,
2363 const wxPoint
& pt
= wxDefaultPosition
,
2364 Origin origin
= Origin_Unknown
)
2365 : wxCommandEvent(type
, winid
),
2367 m_origin(GuessOrigin(origin
))
2369 wxHelpEvent(const wxHelpEvent
& event
)
2370 : wxCommandEvent(event
),
2372 m_target(event
.m_target
),
2373 m_link(event
.m_link
),
2374 m_origin(event
.m_origin
)
2377 // Position of event (in screen coordinates)
2378 const wxPoint
& GetPosition() const { return m_pos
; }
2379 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2381 // Optional link to further help
2382 const wxString
& GetLink() const { return m_link
; }
2383 void SetLink(const wxString
& link
) { m_link
= link
; }
2385 // Optional target to display help in. E.g. a window specification
2386 const wxString
& GetTarget() const { return m_target
; }
2387 void SetTarget(const wxString
& target
) { m_target
= target
; }
2389 virtual wxEvent
*Clone() const { return new wxHelpEvent(*this); }
2391 // optional indication of the event source
2392 Origin
GetOrigin() const { return m_origin
; }
2393 void SetOrigin(Origin origin
) { m_origin
= origin
; }
2401 // we can try to guess the event origin ourselves, even if none is
2402 // specified in the ctor
2403 static Origin
GuessOrigin(Origin origin
);
2406 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHelpEvent
)
2409 // A Clipboard Text event is sent when a window intercepts text copy/cut/paste
2410 // message, i.e. the user has cut/copied/pasted data from/into a text control
2411 // via ctrl-C/X/V, ctrl/shift-del/insert, a popup menu command, etc.
2412 // NOTE : under windows these events are *NOT* generated automatically
2413 // for a Rich Edit text control.
2415 wxEVT_COMMAND_TEXT_COPY
2416 wxEVT_COMMAND_TEXT_CUT
2417 wxEVT_COMMAND_TEXT_PASTE
2420 class WXDLLIMPEXP_CORE wxClipboardTextEvent
: public wxCommandEvent
2423 wxClipboardTextEvent(wxEventType type
= wxEVT_NULL
,
2424 wxWindowID winid
= 0)
2425 : wxCommandEvent(type
, winid
)
2427 wxClipboardTextEvent(const wxClipboardTextEvent
& event
)
2428 : wxCommandEvent(event
)
2431 virtual wxEvent
*Clone() const { return new wxClipboardTextEvent(*this); }
2434 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxClipboardTextEvent
)
2437 // A Context event is sent when the user right clicks on a window or
2438 // presses Shift-F10
2439 // NOTE : Under windows this is a repackaged WM_CONTETXMENU message
2440 // Under other systems it may have to be generated from a right click event
2445 class WXDLLIMPEXP_CORE wxContextMenuEvent
: public wxCommandEvent
2448 wxContextMenuEvent(wxEventType type
= wxEVT_NULL
,
2449 wxWindowID winid
= 0,
2450 const wxPoint
& pt
= wxDefaultPosition
)
2451 : wxCommandEvent(type
, winid
),
2454 wxContextMenuEvent(const wxContextMenuEvent
& event
)
2455 : wxCommandEvent(event
),
2459 // Position of event (in screen coordinates)
2460 const wxPoint
& GetPosition() const { return m_pos
; }
2461 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2463 virtual wxEvent
*Clone() const { return new wxContextMenuEvent(*this); }
2469 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxContextMenuEvent
)
2479 // Whether to always send idle events to windows, or
2480 // to only send update events to those with the
2481 // wxWS_EX_PROCESS_IDLE style.
2485 // Send idle events to all windows
2488 // Send idle events to windows that have
2489 // the wxWS_EX_PROCESS_IDLE flag specified
2490 wxIDLE_PROCESS_SPECIFIED
2493 class WXDLLIMPEXP_BASE wxIdleEvent
: public wxEvent
2497 : wxEvent(0, wxEVT_IDLE
),
2498 m_requestMore(false)
2500 wxIdleEvent(const wxIdleEvent
& event
)
2502 m_requestMore(event
.m_requestMore
)
2505 void RequestMore(bool needMore
= true) { m_requestMore
= needMore
; }
2506 bool MoreRequested() const { return m_requestMore
; }
2508 virtual wxEvent
*Clone() const { return new wxIdleEvent(*this); }
2510 // Specify how wxWidgets will send idle events: to
2511 // all windows, or only to those which specify that they
2512 // will process the events.
2513 static void SetMode(wxIdleMode mode
) { sm_idleMode
= mode
; }
2515 // Returns the idle event mode
2516 static wxIdleMode
GetMode() { return sm_idleMode
; }
2520 static wxIdleMode sm_idleMode
;
2523 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIdleEvent
)
2527 wxEVT_MOUSE_CAPTURE_CHANGED,
2528 wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
2529 // wxEVT_FONT_CHANGED, // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
2530 // wxEVT_FONT_CHANGED to all other windows (maybe).
2531 wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
2537 // ============================================================================
2538 // event handler and related classes
2539 // ============================================================================
2542 // struct containing the members common to static and dynamic event tables
2544 struct WXDLLIMPEXP_BASE wxEventTableEntryBase
2546 wxEventTableEntryBase(int winid
, int idLast
,
2547 wxEventFunctor
* fn
, wxObject
*data
)
2551 m_callbackUserData(data
)
2554 wxEventTableEntryBase( const wxEventTableEntryBase
&entry
)
2555 : m_id( entry
.m_id
),
2556 m_lastId( entry
.m_lastId
),
2558 m_callbackUserData( entry
.m_callbackUserData
)
2560 // This is a 'hack' to ensure that only one instance tries to delete
2561 // the functor pointer. It is safe as long as the only place where the
2562 // copy constructor is being called is when the static event tables are
2563 // being initialized (a temporary instance is created and then this
2564 // constructor is called).
2566 const_cast<wxEventTableEntryBase
&>( entry
).m_fn
= NULL
;
2569 ~wxEventTableEntryBase()
2574 // the range of ids for this entry: if m_lastId == wxID_ANY, the range
2575 // consists only of m_id, otherwise it is m_id..m_lastId inclusive
2579 // function/method/functor to call
2580 wxEventFunctor
* m_fn
;
2582 // arbitrary user data associated with the callback
2583 wxObject
* m_callbackUserData
;
2586 DECLARE_NO_ASSIGN_CLASS(wxEventTableEntryBase
)
2589 // an entry from a static event table
2590 struct WXDLLIMPEXP_BASE wxEventTableEntry
: public wxEventTableEntryBase
2592 wxEventTableEntry(const int& evType
, int winid
, int idLast
,
2593 wxEventFunctor
* fn
, wxObject
*data
)
2594 : wxEventTableEntryBase(winid
, idLast
, fn
, data
),
2598 // the reference to event type: this allows us to not care about the
2599 // (undefined) order in which the event table entries and the event types
2600 // are initialized: initially the value of this reference might be
2601 // invalid, but by the time it is used for the first time, all global
2602 // objects will have been initialized (including the event type constants)
2603 // and so it will have the correct value when it is needed
2604 const int& m_eventType
;
2607 DECLARE_NO_ASSIGN_CLASS(wxEventTableEntry
)
2610 // an entry used in dynamic event table managed by wxEvtHandler::Connect()
2611 struct WXDLLIMPEXP_BASE wxDynamicEventTableEntry
: public wxEventTableEntryBase
2613 wxDynamicEventTableEntry(int evType
, int winid
, int idLast
,
2614 wxEventFunctor
* fn
, wxObject
*data
)
2615 : wxEventTableEntryBase(winid
, idLast
, fn
, data
),
2619 // not a reference here as we can't keep a reference to a temporary int
2620 // created to wrap the constant value typically passed to Connect() - nor
2625 DECLARE_NO_ASSIGN_CLASS(wxDynamicEventTableEntry
)
2628 // ----------------------------------------------------------------------------
2629 // wxEventTable: an array of event entries terminated with {0, 0, 0, 0, 0}
2630 // ----------------------------------------------------------------------------
2632 struct WXDLLIMPEXP_BASE wxEventTable
2634 const wxEventTable
*baseTable
; // base event table (next in chain)
2635 const wxEventTableEntry
*entries
; // bottom of entry array
2638 // ----------------------------------------------------------------------------
2639 // wxEventHashTable: a helper of wxEvtHandler to speed up wxEventTable lookups.
2640 // ----------------------------------------------------------------------------
2642 WX_DEFINE_ARRAY_PTR(const wxEventTableEntry
*, wxEventTableEntryPointerArray
);
2644 class WXDLLIMPEXP_BASE wxEventHashTable
2647 // Internal data structs
2648 struct EventTypeTable
2650 wxEventType eventType
;
2651 wxEventTableEntryPointerArray eventEntryTable
;
2653 typedef EventTypeTable
* EventTypeTablePointer
;
2656 // Constructor, needs the event table it needs to hash later on.
2657 // Note: hashing of the event table is not done in the constructor as it
2658 // can be that the event table is not yet full initialize, the hash
2659 // will gets initialized when handling the first event look-up request.
2660 wxEventHashTable(const wxEventTable
&table
);
2662 ~wxEventHashTable();
2664 // Handle the given event, in other words search the event table hash
2665 // and call self->ProcessEvent() if a match was found.
2666 bool HandleEvent(wxEvent
& event
, wxEvtHandler
*self
);
2671 #if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
2673 static void ClearAll();
2674 #endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING
2677 // Init the hash table with the entries of the static event table.
2678 void InitHashTable();
2679 // Helper funtion of InitHashTable() to insert 1 entry into the hash table.
2680 void AddEntry(const wxEventTableEntry
&entry
);
2681 // Allocate and init with null pointers the base hash table.
2682 void AllocEventTypeTable(size_t size
);
2683 // Grow the hash table in size and transfer all items currently
2684 // in the table to the correct location in the new table.
2685 void GrowEventTypeTable();
2688 const wxEventTable
&m_table
;
2692 EventTypeTablePointer
*m_eventTypeTable
;
2694 static wxEventHashTable
* sm_first
;
2695 wxEventHashTable
* m_previous
;
2696 wxEventHashTable
* m_next
;
2698 DECLARE_NO_COPY_CLASS(wxEventHashTable
)
2701 // ----------------------------------------------------------------------------
2702 // wxEvtHandler: the base class for all objects handling wxWidgets events
2703 // ----------------------------------------------------------------------------
2705 class WXDLLIMPEXP_BASE wxEvtHandler
: public wxObject
2706 , public wxTrackable
2710 virtual ~wxEvtHandler();
2713 // Event handler chain
2714 // -------------------
2716 wxEvtHandler
*GetNextHandler() const { return m_nextHandler
; }
2717 wxEvtHandler
*GetPreviousHandler() const { return m_previousHandler
; }
2718 virtual void SetNextHandler(wxEvtHandler
*handler
) { m_nextHandler
= handler
; }
2719 virtual void SetPreviousHandler(wxEvtHandler
*handler
) { m_previousHandler
= handler
; }
2721 void SetEvtHandlerEnabled(bool enabled
) { m_enabled
= enabled
; }
2722 bool GetEvtHandlerEnabled() const { return m_enabled
; }
2725 bool IsUnlinked() const;
2729 // Event queuing and processing
2730 // ----------------------------
2733 // Process an event right now: this can only be called from the main
2734 // thread, use QueueEvent() for scheduling the events for
2735 // processing from other threads.
2736 virtual bool ProcessEvent(wxEvent
& event
);
2738 // Process an event by calling ProcessEvent and handling any exceptions
2739 // thrown by event handlers. It's mostly useful when processing wx events
2740 // when called from C code (e.g. in GTK+ callback) when the exception
2741 // wouldn't correctly propagate to wxEventLoop.
2742 bool SafelyProcessEvent(wxEvent
& event
);
2743 // NOTE: uses ProcessEvent()
2745 // Schedule the given event to be processed later. It takes ownership of
2746 // the event pointer, i.e. it will be deleted later. This is safe to call
2747 // from multiple threads although you still need to ensure that wxString
2748 // fields of the event object are deep copies and not use the same string
2749 // buffer as other wxString objects in this thread.
2750 virtual void QueueEvent(wxEvent
*event
);
2752 // Add an event to be processed later: notice that this function is not
2753 // safe to call from threads other than main, use QueueEvent()
2754 virtual void AddPendingEvent(const wxEvent
& event
)
2756 // notice that the thread-safety problem comes from the fact that
2757 // Clone() doesn't make deep copies of wxString fields of wxEvent
2758 // object and so the same wxString could be used from both threads when
2759 // the event object is destroyed in this one -- QueueEvent() avoids
2760 // this problem as the event pointer is not used any more in this
2761 // thread at all after it is called.
2762 QueueEvent(event
.Clone());
2765 void ProcessPendingEvents();
2766 // NOTE: uses ProcessEvent()
2769 bool ProcessThreadEvent(const wxEvent
& event
);
2770 // NOTE: uses AddPendingEvent()
2774 // Connecting and disconnecting
2775 // ----------------------------
2777 // These functions are used for old, untyped, event handlers and don't
2778 // check that the type of the function passed to them actually matches the
2779 // type of the event. They also only allow connecting events to methods of
2780 // wxEvtHandler-derived classes.
2782 // The template Connect() methods below are safer and allow connecting
2783 // events to arbitrary functions or functors -- but require compiler
2784 // support for templates.
2786 // Dynamic association of a member function handler with the event handler,
2787 // winid and event type
2788 void Connect(int winid
,
2790 wxEventType eventType
,
2791 wxObjectEventFunction func
,
2792 wxObject
*userData
= NULL
,
2793 wxEvtHandler
*eventSink
= NULL
)
2795 DoConnect(winid
, lastId
, eventType
,
2796 wxNewEventFunctor(eventType
, func
, eventSink
),
2800 // Convenience function: take just one id
2801 void Connect(int winid
,
2802 wxEventType eventType
,
2803 wxObjectEventFunction func
,
2804 wxObject
*userData
= NULL
,
2805 wxEvtHandler
*eventSink
= NULL
)
2806 { Connect(winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
2808 // Even more convenient: without id (same as using id of wxID_ANY)
2809 void Connect(wxEventType eventType
,
2810 wxObjectEventFunction func
,
2811 wxObject
*userData
= NULL
,
2812 wxEvtHandler
*eventSink
= NULL
)
2813 { Connect(wxID_ANY
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
2815 bool Disconnect(int winid
,
2817 wxEventType eventType
,
2818 wxObjectEventFunction func
= NULL
,
2819 wxObject
*userData
= NULL
,
2820 wxEvtHandler
*eventSink
= NULL
)
2822 return DoDisconnect(winid
, lastId
, eventType
,
2823 wxMakeEventFunctor(eventType
, func
, eventSink
),
2827 bool Disconnect(int winid
= wxID_ANY
,
2828 wxEventType eventType
= wxEVT_NULL
,
2829 wxObjectEventFunction func
= NULL
,
2830 wxObject
*userData
= NULL
,
2831 wxEvtHandler
*eventSink
= NULL
)
2832 { return Disconnect(winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
2834 bool Disconnect(wxEventType eventType
,
2835 wxObjectEventFunction func
,
2836 wxObject
*userData
= NULL
,
2837 wxEvtHandler
*eventSink
= NULL
)
2838 { return Disconnect(wxID_ANY
, eventType
, func
, userData
, eventSink
); }
2840 #if !wxEVENTS_COMPATIBILITY_2_8
2841 // Event handling in functions (including generalized functors):
2843 template <typename EventTag
, typename Functor
>
2844 void Connect(int winid
,
2846 const EventTag
& eventType
,
2849 DoConnect(winid
, lastId
, eventType
,
2850 wxNewEventFunctor(eventType
, func
));
2853 template <typename EventTag
, typename Functor
>
2854 void Connect(int winid
, const EventTag
& eventType
, Functor func
)
2855 { Connect(winid
, wxID_ANY
, eventType
, func
); }
2857 template <typename EventTag
, typename Functor
>
2858 void Connect(const EventTag
& eventType
, Functor func
)
2859 { Connect(wxID_ANY
, eventType
, func
); }
2862 template <typename EventTag
, typename Functor
>
2863 bool Disconnect(int winid
,
2865 const EventTag
& eventType
,
2868 return DoDisconnect(winid
, lastId
, eventType
,
2869 wxMakeEventFunctor(eventType
, func
));
2872 template <typename EventTag
, typename Functor
>
2873 bool Disconnect(int winid
, const EventTag
& eventType
, Functor func
)
2874 { return Disconnect(winid
, wxID_ANY
, eventType
, func
); }
2876 template <typename EventTag
, typename Functor
>
2877 bool Disconnect(const EventTag
& eventType
, Functor func
)
2878 { return Disconnect(wxID_ANY
, eventType
, func
); }
2882 // Event handling in class methods: the object handling the event (i.e.
2883 // this object itself by default or eventSink if specified) must be
2884 // convertible to this class.
2886 // Notice that we need to have separate overloads for the versions with and
2887 // without eventSink because in the latter case we must check that this
2888 // object itself derives from Class while in the former this is not
2891 // Methods connecting/disconnecting event to this object itself
2893 template <typename EventTag
, typename Class
, typename EventArg
>
2894 void Connect(int winid
,
2896 const EventTag
& eventType
,
2897 void (Class
::*func
)(EventArg
&),
2898 wxObject
*userData
= NULL
)
2900 DoConnect(winid
, lastId
, eventType
,
2901 wxNewEventFunctor(eventType
, func
, static_cast<Class
*>(this)),
2905 template <typename EventTag
, typename Class
, typename EventArg
>
2906 void Connect(int winid
,
2907 const EventTag
& eventType
,
2908 void (Class
::*func
)(EventArg
&),
2909 wxObject
*userData
= NULL
)
2910 { Connect(winid
, wxID_ANY
, eventType
, func
, userData
); }
2912 template <typename EventTag
, typename Class
, typename EventArg
>
2913 void Connect(const EventTag
& eventType
,
2914 void (Class
::*func
)(EventArg
&),
2915 wxObject
*userData
= NULL
)
2916 { Connect(wxID_ANY
, eventType
, func
, userData
); }
2919 template <typename EventTag
, typename Class
, typename EventArg
>
2920 bool Disconnect(int winid
,
2922 const EventTag
& eventType
,
2923 void (Class
::*func
)(EventArg
&),
2924 wxObject
*userData
= NULL
)
2926 return DoDisconnect(winid
, lastId
, eventType
,
2927 wxMakeEventFunctor(eventType
, func
,
2928 static_cast<Class
*>(this)),
2932 template <typename EventTag
, typename Class
, typename EventArg
>
2933 bool Disconnect(int winid
,
2934 const EventTag
& eventType
,
2935 void (Class
::*func
)(EventArg
&),
2936 wxObject
*userData
= NULL
)
2937 { return Disconnect(winid
, wxID_ANY
, eventType
, func
, userData
); }
2939 template <typename EventTag
, typename Class
, typename EventArg
>
2940 bool Disconnect(const EventTag
& eventType
,
2941 void (Class
::*func
)(EventArg
&),
2942 wxObject
*userData
= NULL
)
2943 { return Disconnect(wxID_ANY
, eventType
, func
, userData
); }
2946 // Methods connecting/disconnecting event to another object
2949 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
2950 void Connect(int winid
,
2952 const EventTag
& eventType
,
2953 void (Class
::*func
)(EventArg
&),
2955 ObjClass
*eventSink
)
2957 DoConnect(winid
, lastId
, eventType
,
2958 wxNewEventFunctor(eventType
, func
, eventSink
),
2963 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
2964 void Connect(int winid
,
2965 const EventTag
& eventType
,
2966 void (Class
::*func
)(EventArg
&),
2968 ObjClass
*eventSink
)
2969 { Connect(winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
2972 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
2973 void Connect(const EventTag
& eventType
,
2974 void (Class
::*func
)(EventArg
&),
2976 ObjClass
*eventSink
)
2977 { Connect(wxID_ANY
, eventType
, func
, userData
, eventSink
); }
2981 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
2982 bool Disconnect(int winid
,
2984 const EventTag
& eventType
,
2985 void (Class
::*func
)(EventArg
&),
2987 ObjClass
*eventSink
)
2989 return DoDisconnect(winid
, lastId
, eventType
,
2990 wxMakeEventFunctor(eventType
, func
, eventSink
),
2995 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
2996 bool Disconnect(int winid
,
2997 const EventTag
& eventType
,
2998 void (Class
::*func
)(EventArg
&),
3000 ObjClass
*eventSink
)
3001 { return Disconnect(winid
, wxID_ANY
, eventType
, func
,
3002 userData
, eventSink
); }
3005 <typename EventTag
, typename Class
, typename EventArg
, typename ObjClass
>
3006 bool Disconnect(const EventTag
& eventType
,
3007 void (Class
::*func
)(EventArg
&),
3009 ObjClass
*eventSink
)
3010 { return Disconnect(wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3014 // Static version of Connect() which allows to specify the event source and
3015 // event handler in a more symmetric way
3016 template <typename ObjSource
, typename EventTag
,
3017 typename Class
, typename EventArg
, typename ObjClass
>
3018 static void Connect(ObjSource
*eventSrc
,
3021 const EventTag
& eventType
,
3022 void (Class
::*func
)(EventArg
&),
3023 wxObject
*userData
= NULL
,
3024 ObjClass
*eventSink
= NULL
)
3026 eventSrc
->Connect(winid
, lastId
, eventType
, func
, userData
, eventSink
);
3029 template <typename ObjSource
, typename EventTag
,
3030 typename Class
, typename EventArg
, typename ObjClass
>
3031 static void Connect(ObjSource
*eventSrc
,
3033 const EventTag
& eventType
,
3034 void (Class
::*func
)(EventArg
&),
3035 wxObject
*userData
= NULL
,
3036 ObjClass
*eventSink
= NULL
)
3038 Connect(eventSrc
, winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
);
3041 template <typename ObjSource
, typename EventTag
,
3042 typename Class
, typename EventArg
, typename ObjClass
>
3043 static void Connect(ObjSource
*eventSrc
,
3044 const EventTag
& eventType
,
3045 void (Class
::*func
)(EventArg
&),
3046 wxObject
*userData
= NULL
,
3047 ObjClass
*eventSink
= NULL
)
3049 Connect(eventSrc
, wxID_ANY
, eventType
, func
, userData
, eventSink
);
3053 template <typename ObjSource
, typename EventTag
,
3054 typename Class
, typename EventArg
, typename ObjClass
>
3055 static bool Disconnect(ObjSource
*eventSrc
,
3058 const EventTag
& eventType
,
3059 void (Class
::*func
)(EventArg
&),
3060 wxObject
*userData
= NULL
,
3061 ObjClass
*eventSink
= NULL
)
3063 return eventSrc
->Disconnect(winid
, lastId
, eventType
, func
,
3064 userData
, eventSink
);
3067 template <typename ObjSource
, typename EventTag
,
3068 typename Class
, typename EventArg
, typename ObjClass
>
3069 static bool Disconnect(ObjSource
*eventSrc
,
3071 const EventTag
& eventType
,
3072 void (Class
::*func
)(EventArg
&),
3073 wxObject
*userData
= NULL
,
3074 ObjClass
*eventSink
= NULL
)
3076 return Disconnect(eventSrc
, winid
, wxID_ANY
, eventType
, func
,
3077 userData
, eventSink
);
3080 template <typename ObjSource
, typename EventTag
,
3081 typename Class
, typename EventArg
, typename ObjClass
>
3082 static bool Disconnect(ObjSource
*eventSrc
,
3083 const EventTag
& eventType
,
3084 void (Class
::*func
)(EventArg
&),
3085 wxObject
*userData
= NULL
,
3086 ObjClass
*eventSink
= NULL
)
3088 return Disconnect(eventSrc
, wxID_ANY
, eventType
, func
,
3089 userData
, eventSink
);
3091 #endif // !wxEVENTS_COMPATIBILITY_2_8
3094 wxList
* GetDynamicEventTable() const { return m_dynamicEvents
; }
3096 // User data can be associated with each wxEvtHandler
3097 void SetClientObject( wxClientData
*data
) { DoSetClientObject(data
); }
3098 wxClientData
*GetClientObject() const { return DoGetClientObject(); }
3100 void SetClientData( void *data
) { DoSetClientData(data
); }
3101 void *GetClientData() const { return DoGetClientData(); }
3104 // implementation from now on
3105 // --------------------------
3107 // check if the given event table entry matches this event by id (the check
3108 // for the event type should be done by caller) and call the handler if it
3111 // return true if the event was processed, false otherwise (no match or the
3112 // handler decided to skip the event)
3113 static bool ProcessEventIfMatchesId(const wxEventTableEntryBase
& tableEntry
,
3114 wxEvtHandler
*handler
,
3117 virtual bool SearchEventTable(wxEventTable
& table
, wxEvent
& event
);
3118 bool SearchDynamicEventTable( wxEvent
& event
);
3120 // Avoid problems at exit by cleaning up static hash table gracefully
3121 void ClearEventHashTable() { GetEventHashTable().Clear(); }
3122 void OnSinkDestroyed( wxEvtHandler
*sink
);
3125 // The method tries to process the event in this event handler.
3127 // It is meant to be called from ProcessEvent() only and is not virtual,
3128 // additional event handlers can be hooked into the normal event processing
3129 // logic using TryValidator() hook.
3130 bool ProcessEventHere(wxEvent
& event
);
3134 void DoConnect(int winid
,
3136 wxEventType eventType
,
3137 wxEventFunctor
*func
,
3138 wxObject
* userData
= NULL
);
3140 bool DoDisconnect(int winid
,
3142 wxEventType eventType
,
3143 const wxEventFunctor
& func
,
3144 wxObject
*userData
= NULL
);
3146 static const wxEventTableEntry sm_eventTableEntries
[];
3149 // hooks for wxWindow used by ProcessEvent()
3150 // -----------------------------------------
3152 // This one is called before trying our own event table to allow plugging
3153 // in the validators.
3155 // NB: This method is intentionally *not* inside wxUSE_VALIDATORS!
3156 // It is part of wxBase which doesn't use validators and the code
3157 // is compiled out when building wxBase w/o GUI classes, which affects
3158 // binary compatibility and wxBase library can't be used by GUI
3160 virtual bool TryValidator(wxEvent
& WXUNUSED(event
)) { return false; }
3162 // this one is called after failing to find the event handle in our own
3163 // table to give a chance to the other windows to process it
3165 // base class implementation passes the event to wxTheApp
3166 virtual bool TryParent(wxEvent
& event
);
3169 static const wxEventTable sm_eventTable
;
3170 virtual const wxEventTable
*GetEventTable() const;
3172 static wxEventHashTable sm_eventHashTable
;
3173 virtual wxEventHashTable
& GetEventHashTable() const;
3175 wxEvtHandler
* m_nextHandler
;
3176 wxEvtHandler
* m_previousHandler
;
3177 wxList
* m_dynamicEvents
;
3178 wxList
* m_pendingEvents
;
3181 // critical section protecting m_pendingEvents
3182 wxCriticalSection m_pendingEventsLock
;
3183 #endif // wxUSE_THREADS
3185 // Is event handler enabled?
3189 // The user data: either an object which will be deleted by the container
3190 // when it's deleted or some raw pointer which we do nothing with - only
3191 // one type of data can be used with the given window (i.e. you cannot set
3192 // the void data and then associate the container with wxClientData or vice
3196 wxClientData
*m_clientObject
;
3200 // what kind of data do we have?
3201 wxClientDataType m_clientDataType
;
3203 // client data accessors
3204 virtual void DoSetClientObject( wxClientData
*data
);
3205 virtual wxClientData
*DoGetClientObject() const;
3207 virtual void DoSetClientData( void *data
);
3208 virtual void *DoGetClientData() const;
3210 // Search tracker objects for event connection with this sink
3211 wxEventConnectionRef
*FindRefInTrackerList(wxEvtHandler
*eventSink
);
3214 DECLARE_DYNAMIC_CLASS_NO_COPY(wxEvtHandler
)
3217 // ----------------------------------------------------------------------------
3218 // wxEventConnectionRef represents all connections between two event handlers
3219 // and enables automatic disconnect when an event handler sink goes out of
3220 // scope. Each connection/disconnect increases/decreases ref count, and
3221 // when it reaches zero the node goes out of scope.
3222 // ----------------------------------------------------------------------------
3224 class wxEventConnectionRef
: public wxTrackerNode
3227 wxEventConnectionRef() : m_src(NULL
), m_sink(NULL
), m_refCount(0) { }
3228 wxEventConnectionRef(wxEvtHandler
*src
, wxEvtHandler
*sink
)
3229 : m_src(src
), m_sink(sink
), m_refCount(1)
3231 m_sink
->AddNode(this);
3234 // The sink is being destroyed
3235 virtual void OnObjectDestroy( )
3238 m_src
->OnSinkDestroyed( m_sink
);
3242 virtual wxEventConnectionRef
*ToEventConnection() { return this; }
3244 void IncRef() { m_refCount
++; }
3247 if ( !--m_refCount
)
3249 // The sink holds the only external pointer to this object
3251 m_sink
->RemoveNode(this);
3257 wxEvtHandler
*m_src
,
3261 friend class wxEvtHandler
;
3263 DECLARE_NO_ASSIGN_CLASS(wxEventConnectionRef
)
3266 // Post a message to the given event handler which will be processed during the
3267 // next event loop iteration.
3269 // Notice that this one is not thread-safe, use wxQueueEvent()
3270 inline void wxPostEvent(wxEvtHandler
*dest
, const wxEvent
& event
)
3272 wxCHECK_RET( dest
, "need an object to post event to" );
3274 dest
->AddPendingEvent(event
);
3277 // Wrapper around wxEvtHandler::QueueEvent(): adds an event for later
3278 // processing, unlike wxPostEvent it is safe to use from different thread even
3279 // for events with wxString members
3280 inline void wxQueueEvent(wxEvtHandler
*dest
, wxEvent
*event
)
3282 wxCHECK_RET( dest
, "need an object to queue event for" );
3284 dest
->QueueEvent(event
);
3287 typedef void (wxEvtHandler
::*wxEventFunction
)(wxEvent
&);
3288 typedef void (wxEvtHandler
::*wxIdleEventFunction
)(wxIdleEvent
&);
3290 #define wxEventHandler(func) \
3291 wxEVENT_HANDLER_CAST(wxEventFunction, func)
3292 #define wxIdleEventHandler(func) \
3293 wxEVENT_HANDLER_CAST(wxIdleEventFunction, func)
3297 // ----------------------------------------------------------------------------
3298 // wxEventBlocker: helper class to temporarily disable event handling for a window
3299 // ----------------------------------------------------------------------------
3301 class WXDLLIMPEXP_CORE wxEventBlocker
: public wxEvtHandler
3304 wxEventBlocker(wxWindow
*win
, wxEventType type
= wxEVT_ANY
);
3305 virtual ~wxEventBlocker();
3307 void Block(wxEventType type
)
3309 m_eventsToBlock
.push_back(type
);
3312 virtual bool ProcessEvent(wxEvent
& event
);
3315 wxArrayInt m_eventsToBlock
;
3318 DECLARE_NO_COPY_CLASS(wxEventBlocker
)
3321 typedef void (wxEvtHandler
::*wxCommandEventFunction
)(wxCommandEvent
&);
3322 typedef void (wxEvtHandler
::*wxScrollEventFunction
)(wxScrollEvent
&);
3323 typedef void (wxEvtHandler
::*wxScrollWinEventFunction
)(wxScrollWinEvent
&);
3324 typedef void (wxEvtHandler
::*wxSizeEventFunction
)(wxSizeEvent
&);
3325 typedef void (wxEvtHandler
::*wxMoveEventFunction
)(wxMoveEvent
&);
3326 typedef void (wxEvtHandler
::*wxPaintEventFunction
)(wxPaintEvent
&);
3327 typedef void (wxEvtHandler
::*wxNcPaintEventFunction
)(wxNcPaintEvent
&);
3328 typedef void (wxEvtHandler
::*wxEraseEventFunction
)(wxEraseEvent
&);
3329 typedef void (wxEvtHandler
::*wxMouseEventFunction
)(wxMouseEvent
&);
3330 typedef void (wxEvtHandler
::*wxCharEventFunction
)(wxKeyEvent
&);
3331 typedef void (wxEvtHandler
::*wxFocusEventFunction
)(wxFocusEvent
&);
3332 typedef void (wxEvtHandler
::*wxChildFocusEventFunction
)(wxChildFocusEvent
&);
3333 typedef void (wxEvtHandler
::*wxActivateEventFunction
)(wxActivateEvent
&);
3334 typedef void (wxEvtHandler
::*wxMenuEventFunction
)(wxMenuEvent
&);
3335 typedef void (wxEvtHandler
::*wxJoystickEventFunction
)(wxJoystickEvent
&);
3336 typedef void (wxEvtHandler
::*wxDropFilesEventFunction
)(wxDropFilesEvent
&);
3337 typedef void (wxEvtHandler
::*wxInitDialogEventFunction
)(wxInitDialogEvent
&);
3338 typedef void (wxEvtHandler
::*wxSysColourChangedEventFunction
)(wxSysColourChangedEvent
&);
3339 typedef void (wxEvtHandler
::*wxDisplayChangedEventFunction
)(wxDisplayChangedEvent
&);
3340 typedef void (wxEvtHandler
::*wxUpdateUIEventFunction
)(wxUpdateUIEvent
&);
3341 typedef void (wxEvtHandler
::*wxCloseEventFunction
)(wxCloseEvent
&);
3342 typedef void (wxEvtHandler
::*wxShowEventFunction
)(wxShowEvent
&);
3343 typedef void (wxEvtHandler
::*wxIconizeEventFunction
)(wxIconizeEvent
&);
3344 typedef void (wxEvtHandler
::*wxMaximizeEventFunction
)(wxMaximizeEvent
&);
3345 typedef void (wxEvtHandler
::*wxNavigationKeyEventFunction
)(wxNavigationKeyEvent
&);
3346 typedef void (wxEvtHandler
::*wxPaletteChangedEventFunction
)(wxPaletteChangedEvent
&);
3347 typedef void (wxEvtHandler
::*wxQueryNewPaletteEventFunction
)(wxQueryNewPaletteEvent
&);
3348 typedef void (wxEvtHandler
::*wxWindowCreateEventFunction
)(wxWindowCreateEvent
&);
3349 typedef void (wxEvtHandler
::*wxWindowDestroyEventFunction
)(wxWindowDestroyEvent
&);
3350 typedef void (wxEvtHandler
::*wxSetCursorEventFunction
)(wxSetCursorEvent
&);
3351 typedef void (wxEvtHandler
::*wxNotifyEventFunction
)(wxNotifyEvent
&);
3352 typedef void (wxEvtHandler
::*wxHelpEventFunction
)(wxHelpEvent
&);
3353 typedef void (wxEvtHandler
::*wxContextMenuEventFunction
)(wxContextMenuEvent
&);
3354 typedef void (wxEvtHandler
::*wxMouseCaptureChangedEventFunction
)(wxMouseCaptureChangedEvent
&);
3355 typedef void (wxEvtHandler
::*wxMouseCaptureLostEventFunction
)(wxMouseCaptureLostEvent
&);
3356 typedef void (wxEvtHandler
::*wxClipboardTextEventFunction
)(wxClipboardTextEvent
&);
3359 #define wxCommandEventHandler(func) \
3360 wxEVENT_HANDLER_CAST(wxCommandEventFunction, func)
3361 #define wxScrollEventHandler(func) \
3362 wxEVENT_HANDLER_CAST(wxScrollEventFunction, func)
3363 #define wxScrollWinEventHandler(func) \
3364 wxEVENT_HANDLER_CAST(wxScrollWinEventFunction, func)
3365 #define wxSizeEventHandler(func) \
3366 wxEVENT_HANDLER_CAST(wxSizeEventFunction, func)
3367 #define wxMoveEventHandler(func) \
3368 wxEVENT_HANDLER_CAST(wxMoveEventFunction, func)
3369 #define wxPaintEventHandler(func) \
3370 wxEVENT_HANDLER_CAST(wxPaintEventFunction, func)
3371 #define wxNcPaintEventHandler(func) \
3372 wxEVENT_HANDLER_CAST(wxNcPaintEventFunction, func)
3373 #define wxEraseEventHandler(func) \
3374 wxEVENT_HANDLER_CAST(wxEraseEventFunction, func)
3375 #define wxMouseEventHandler(func) \
3376 wxEVENT_HANDLER_CAST(wxMouseEventFunction, func)
3377 #define wxCharEventHandler(func) \
3378 wxEVENT_HANDLER_CAST(wxCharEventFunction, func)
3379 #define wxKeyEventHandler(func) wxCharEventHandler(func)
3380 #define wxFocusEventHandler(func) \
3381 wxEVENT_HANDLER_CAST(wxFocusEventFunction, func)
3382 #define wxChildFocusEventHandler(func) \
3383 wxEVENT_HANDLER_CAST(wxChildFocusEventFunction, func)
3384 #define wxActivateEventHandler(func) \
3385 wxEVENT_HANDLER_CAST(wxActivateEventFunction, func)
3386 #define wxMenuEventHandler(func) \
3387 wxEVENT_HANDLER_CAST(wxMenuEventFunction, func)
3388 #define wxJoystickEventHandler(func) \
3389 wxEVENT_HANDLER_CAST(wxJoystickEventFunction, func)
3390 #define wxDropFilesEventHandler(func) \
3391 wxEVENT_HANDLER_CAST(wxDropFilesEventFunction, func)
3392 #define wxInitDialogEventHandler(func) \
3393 wxEVENT_HANDLER_CAST(wxInitDialogEventFunction, func)
3394 #define wxSysColourChangedEventHandler(func) \
3395 wxEVENT_HANDLER_CAST(wxSysColourChangedEventFunction, func)
3396 #define wxDisplayChangedEventHandler(func) \
3397 wxEVENT_HANDLER_CAST(wxDisplayChangedEventFunction, func)
3398 #define wxUpdateUIEventHandler(func) \
3399 wxEVENT_HANDLER_CAST(wxUpdateUIEventFunction, func)
3400 #define wxCloseEventHandler(func) \
3401 wxEVENT_HANDLER_CAST(wxCloseEventFunction, func)
3402 #define wxShowEventHandler(func) \
3403 wxEVENT_HANDLER_CAST(wxShowEventFunction, func)
3404 #define wxIconizeEventHandler(func) \
3405 wxEVENT_HANDLER_CAST(wxIconizeEventFunction, func)
3406 #define wxMaximizeEventHandler(func) \
3407 wxEVENT_HANDLER_CAST(wxMaximizeEventFunction, func)
3408 #define wxNavigationKeyEventHandler(func) \
3409 wxEVENT_HANDLER_CAST(wxNavigationKeyEventFunction, func)
3410 #define wxPaletteChangedEventHandler(func) \
3411 wxEVENT_HANDLER_CAST(wxPaletteChangedEventFunction, func)
3412 #define wxQueryNewPaletteEventHandler(func) \
3413 wxEVENT_HANDLER_CAST(wxQueryNewPaletteEventFunction, func)
3414 #define wxWindowCreateEventHandler(func) \
3415 wxEVENT_HANDLER_CAST(wxWindowCreateEventFunction, func)
3416 #define wxWindowDestroyEventHandler(func) \
3417 wxEVENT_HANDLER_CAST(wxWindowDestroyEventFunction, func)
3418 #define wxSetCursorEventHandler(func) \
3419 wxEVENT_HANDLER_CAST(wxSetCursorEventFunction, func)
3420 #define wxNotifyEventHandler(func) \
3421 wxEVENT_HANDLER_CAST(wxNotifyEventFunction, func)
3422 #define wxHelpEventHandler(func) \
3423 wxEVENT_HANDLER_CAST(wxHelpEventFunction, func)
3424 #define wxContextMenuEventHandler(func) \
3425 wxEVENT_HANDLER_CAST(wxContextMenuEventFunction, func)
3426 #define wxMouseCaptureChangedEventHandler(func) \
3427 wxEVENT_HANDLER_CAST(wxMouseCaptureChangedEventFunction, func)
3428 #define wxMouseCaptureLostEventHandler(func) \
3429 wxEVENT_HANDLER_CAST(wxMouseCaptureLostEventFunction, func)
3430 #define wxClipboardTextEventHandler(func) \
3431 wxEVENT_HANDLER_CAST(wxClipboardTextEventFunction, func)
3435 // N.B. In GNU-WIN32, you *have* to take the address of a member function
3436 // (use &) or the compiler crashes...
3438 #define DECLARE_EVENT_TABLE() \
3440 static const wxEventTableEntry sm_eventTableEntries[]; \
3442 static const wxEventTable sm_eventTable; \
3443 virtual const wxEventTable* GetEventTable() const; \
3444 static wxEventHashTable sm_eventHashTable; \
3445 virtual wxEventHashTable& GetEventHashTable() const;
3447 // N.B.: when building DLL with Borland C++ 5.5 compiler, you must initialize
3448 // sm_eventTable before using it in GetEventTable() or the compiler gives
3449 // E2233 (see http://groups.google.com/groups?selm=397dcc8a%241_2%40dnews)
3451 #define BEGIN_EVENT_TABLE(theClass, baseClass) \
3452 const wxEventTable theClass::sm_eventTable = \
3453 { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] }; \
3454 const wxEventTable *theClass::GetEventTable() const \
3455 { return &theClass::sm_eventTable; } \
3456 wxEventHashTable theClass::sm_eventHashTable(theClass::sm_eventTable); \
3457 wxEventHashTable &theClass::GetEventHashTable() const \
3458 { return theClass::sm_eventHashTable; } \
3459 const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
3461 #define BEGIN_EVENT_TABLE_TEMPLATE1(theClass, baseClass, T1) \
3462 template<typename T1> \
3463 const wxEventTable theClass<T1>::sm_eventTable = \
3464 { &baseClass::sm_eventTable, &theClass<T1>::sm_eventTableEntries[0] }; \
3465 template<typename T1> \
3466 const wxEventTable *theClass<T1>::GetEventTable() const \
3467 { return &theClass<T1>::sm_eventTable; } \
3468 template<typename T1> \
3469 wxEventHashTable theClass<T1>::sm_eventHashTable(theClass<T1>::sm_eventTable); \
3470 template<typename T1> \
3471 wxEventHashTable &theClass<T1>::GetEventHashTable() const \
3472 { return theClass<T1>::sm_eventHashTable; } \
3473 template<typename T1> \
3474 const wxEventTableEntry theClass<T1>::sm_eventTableEntries[] = { \
3476 #define BEGIN_EVENT_TABLE_TEMPLATE2(theClass, baseClass, T1, T2) \
3477 template<typename T1, typename T2> \
3478 const wxEventTable theClass<T1, T2>::sm_eventTable = \
3479 { &baseClass::sm_eventTable, &theClass<T1, T2>::sm_eventTableEntries[0] }; \
3480 template<typename T1, typename T2> \
3481 const wxEventTable *theClass<T1, T2>::GetEventTable() const \
3482 { return &theClass<T1, T2>::sm_eventTable; } \
3483 template<typename T1, typename T2> \
3484 wxEventHashTable theClass<T1, T2>::sm_eventHashTable(theClass<T1, T2>::sm_eventTable); \
3485 template<typename T1, typename T2> \
3486 wxEventHashTable &theClass<T1, T2>::GetEventHashTable() const \
3487 { return theClass<T1, T2>::sm_eventHashTable; } \
3488 template<typename T1, typename T2> \
3489 const wxEventTableEntry theClass<T1, T2>::sm_eventTableEntries[] = { \
3491 #define BEGIN_EVENT_TABLE_TEMPLATE3(theClass, baseClass, T1, T2, T3) \
3492 template<typename T1, typename T2, typename T3> \
3493 const wxEventTable theClass<T1, T2, T3>::sm_eventTable = \
3494 { &baseClass::sm_eventTable, &theClass<T1, T2, T3>::sm_eventTableEntries[0] }; \
3495 template<typename T1, typename T2, typename T3> \
3496 const wxEventTable *theClass<T1, T2, T3>::GetEventTable() const \
3497 { return &theClass<T1, T2, T3>::sm_eventTable; } \
3498 template<typename T1, typename T2, typename T3> \
3499 wxEventHashTable theClass<T1, T2, T3>::sm_eventHashTable(theClass<T1, T2, T3>::sm_eventTable); \
3500 template<typename T1, typename T2, typename T3> \
3501 wxEventHashTable &theClass<T1, T2, T3>::GetEventHashTable() const \
3502 { return theClass<T1, T2, T3>::sm_eventHashTable; } \
3503 template<typename T1, typename T2, typename T3> \
3504 const wxEventTableEntry theClass<T1, T2, T3>::sm_eventTableEntries[] = { \
3506 #define BEGIN_EVENT_TABLE_TEMPLATE4(theClass, baseClass, T1, T2, T3, T4) \
3507 template<typename T1, typename T2, typename T3, typename T4> \
3508 const wxEventTable theClass<T1, T2, T3, T4>::sm_eventTable = \
3509 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4>::sm_eventTableEntries[0] }; \
3510 template<typename T1, typename T2, typename T3, typename T4> \
3511 const wxEventTable *theClass<T1, T2, T3, T4>::GetEventTable() const \
3512 { return &theClass<T1, T2, T3, T4>::sm_eventTable; } \
3513 template<typename T1, typename T2, typename T3, typename T4> \
3514 wxEventHashTable theClass<T1, T2, T3, T4>::sm_eventHashTable(theClass<T1, T2, T3, T4>::sm_eventTable); \
3515 template<typename T1, typename T2, typename T3, typename T4> \
3516 wxEventHashTable &theClass<T1, T2, T3, T4>::GetEventHashTable() const \
3517 { return theClass<T1, T2, T3, T4>::sm_eventHashTable; } \
3518 template<typename T1, typename T2, typename T3, typename T4> \
3519 const wxEventTableEntry theClass<T1, T2, T3, T4>::sm_eventTableEntries[] = { \
3521 #define BEGIN_EVENT_TABLE_TEMPLATE5(theClass, baseClass, T1, T2, T3, T4, T5) \
3522 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3523 const wxEventTable theClass<T1, T2, T3, T4, T5>::sm_eventTable = \
3524 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[0] }; \
3525 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3526 const wxEventTable *theClass<T1, T2, T3, T4, T5>::GetEventTable() const \
3527 { return &theClass<T1, T2, T3, T4, T5>::sm_eventTable; } \
3528 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3529 wxEventHashTable theClass<T1, T2, T3, T4, T5>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5>::sm_eventTable); \
3530 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3531 wxEventHashTable &theClass<T1, T2, T3, T4, T5>::GetEventHashTable() const \
3532 { return theClass<T1, T2, T3, T4, T5>::sm_eventHashTable; } \
3533 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3534 const wxEventTableEntry theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[] = { \
3536 #define BEGIN_EVENT_TABLE_TEMPLATE7(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7) \
3537 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3538 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable = \
3539 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[0] }; \
3540 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3541 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventTable() const \
3542 { return &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable; } \
3543 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3544 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable); \
3545 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3546 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventHashTable() const \
3547 { return theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable; } \
3548 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3549 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[] = { \
3551 #define BEGIN_EVENT_TABLE_TEMPLATE8(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7, T8) \
3552 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3553 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable = \
3554 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[0] }; \
3555 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3556 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventTable() const \
3557 { return &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable; } \
3558 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3559 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable); \
3560 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3561 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventHashTable() const \
3562 { return theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable; } \
3563 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3564 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[] = { \
3566 #define END_EVENT_TABLE() DECLARE_EVENT_TABLE_TERMINATOR() };
3569 * Event table macros
3572 // helpers for writing shorter code below: declare an event macro taking 2, 1
3573 // or none ids (the missing ids default to wxID_ANY)
3576 // - evt one of wxEVT_XXX constants
3577 // - id1, id2 ids of the first/last id
3578 // - fn the function (should be cast to the right type)
3579 #define wx__DECLARE_EVT2(evt, id1, id2, fn) \
3580 DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
3581 #define wx__DECLARE_EVT1(evt, id, fn) \
3582 wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
3583 #define wx__DECLARE_EVT0(evt, fn) \
3584 wx__DECLARE_EVT1(evt, wxID_ANY, fn)
3588 #define EVT_CUSTOM(event, winid, func) \
3589 wx__DECLARE_EVT1(event, winid, wxEventHandler(func))
3590 #define EVT_CUSTOM_RANGE(event, id1, id2, func) \
3591 wx__DECLARE_EVT2(event, id1, id2, wxEventHandler(func))
3594 #define EVT_COMMAND(winid, event, func) \
3595 wx__DECLARE_EVT1(event, winid, wxCommandEventHandler(func))
3597 #define EVT_COMMAND_RANGE(id1, id2, event, func) \
3598 wx__DECLARE_EVT2(event, id1, id2, wxCommandEventHandler(func))
3600 #define EVT_NOTIFY(event, winid, func) \
3601 wx__DECLARE_EVT1(event, winid, wxNotifyEventHandler(func))
3603 #define EVT_NOTIFY_RANGE(event, id1, id2, func) \
3604 wx__DECLARE_EVT2(event, id1, id2, wxNotifyEventHandler(func))
3607 #define EVT_SIZE(func) wx__DECLARE_EVT0(wxEVT_SIZE, wxSizeEventHandler(func))
3608 #define EVT_SIZING(func) wx__DECLARE_EVT0(wxEVT_SIZING, wxSizeEventHandler(func))
3609 #define EVT_MOVE(func) wx__DECLARE_EVT0(wxEVT_MOVE, wxMoveEventHandler(func))
3610 #define EVT_MOVING(func) wx__DECLARE_EVT0(wxEVT_MOVING, wxMoveEventHandler(func))
3611 #define EVT_MOVE_START(func) wx__DECLARE_EVT0(wxEVT_MOVE_START, wxMoveEventHandler(func))
3612 #define EVT_MOVE_END(func) wx__DECLARE_EVT0(wxEVT_MOVE_END, wxMoveEventHandler(func))
3613 #define EVT_CLOSE(func) wx__DECLARE_EVT0(wxEVT_CLOSE_WINDOW, wxCloseEventHandler(func))
3614 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3615 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3616 #define EVT_PAINT(func) wx__DECLARE_EVT0(wxEVT_PAINT, wxPaintEventHandler(func))
3617 #define EVT_NC_PAINT(func) wx__DECLARE_EVT0(wxEVT_NC_PAINT, wxNcPaintEventHandler(func))
3618 #define EVT_ERASE_BACKGROUND(func) wx__DECLARE_EVT0(wxEVT_ERASE_BACKGROUND, wxEraseEventHandler(func))
3619 #define EVT_CHAR(func) wx__DECLARE_EVT0(wxEVT_CHAR, wxCharEventHandler(func))
3620 #define EVT_KEY_DOWN(func) wx__DECLARE_EVT0(wxEVT_KEY_DOWN, wxKeyEventHandler(func))
3621 #define EVT_KEY_UP(func) wx__DECLARE_EVT0(wxEVT_KEY_UP, wxKeyEventHandler(func))
3623 #define EVT_HOTKEY(winid, func) wx__DECLARE_EVT1(wxEVT_HOTKEY, winid, wxCharEventHandler(func))
3625 #define EVT_CHAR_HOOK(func) wx__DECLARE_EVT0(wxEVT_CHAR_HOOK, wxCharEventHandler(func))
3626 #define EVT_MENU_OPEN(func) wx__DECLARE_EVT0(wxEVT_MENU_OPEN, wxMenuEventHandler(func))
3627 #define EVT_MENU_CLOSE(func) wx__DECLARE_EVT0(wxEVT_MENU_CLOSE, wxMenuEventHandler(func))
3628 #define EVT_MENU_HIGHLIGHT(winid, func) wx__DECLARE_EVT1(wxEVT_MENU_HIGHLIGHT, winid, wxMenuEventHandler(func))
3629 #define EVT_MENU_HIGHLIGHT_ALL(func) wx__DECLARE_EVT0(wxEVT_MENU_HIGHLIGHT, wxMenuEventHandler(func))
3630 #define EVT_SET_FOCUS(func) wx__DECLARE_EVT0(wxEVT_SET_FOCUS, wxFocusEventHandler(func))
3631 #define EVT_KILL_FOCUS(func) wx__DECLARE_EVT0(wxEVT_KILL_FOCUS, wxFocusEventHandler(func))
3632 #define EVT_CHILD_FOCUS(func) wx__DECLARE_EVT0(wxEVT_CHILD_FOCUS, wxChildFocusEventHandler(func))
3633 #define EVT_ACTIVATE(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE, wxActivateEventHandler(func))
3634 #define EVT_ACTIVATE_APP(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE_APP, wxActivateEventHandler(func))
3635 #define EVT_HIBERNATE(func) wx__DECLARE_EVT0(wxEVT_HIBERNATE, wxActivateEventHandler(func))
3636 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3637 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3638 #define EVT_DROP_FILES(func) wx__DECLARE_EVT0(wxEVT_DROP_FILES, wxDropFilesEventHandler(func))
3639 #define EVT_INIT_DIALOG(func) wx__DECLARE_EVT0(wxEVT_INIT_DIALOG, wxInitDialogEventHandler(func))
3640 #define EVT_SYS_COLOUR_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEventHandler(func))
3641 #define EVT_DISPLAY_CHANGED(func) wx__DECLARE_EVT0(wxEVT_DISPLAY_CHANGED, wxDisplayChangedEventHandler(func))
3642 #define EVT_SHOW(func) wx__DECLARE_EVT0(wxEVT_SHOW, wxShowEventHandler(func))
3643 #define EVT_MAXIMIZE(func) wx__DECLARE_EVT0(wxEVT_MAXIMIZE, wxMaximizeEventHandler(func))
3644 #define EVT_ICONIZE(func) wx__DECLARE_EVT0(wxEVT_ICONIZE, wxIconizeEventHandler(func))
3645 #define EVT_NAVIGATION_KEY(func) wx__DECLARE_EVT0(wxEVT_NAVIGATION_KEY, wxNavigationKeyEventHandler(func))
3646 #define EVT_PALETTE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_PALETTE_CHANGED, wxPaletteChangedEventHandler(func))
3647 #define EVT_QUERY_NEW_PALETTE(func) wx__DECLARE_EVT0(wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEventHandler(func))
3648 #define EVT_WINDOW_CREATE(func) wx__DECLARE_EVT0(wxEVT_CREATE, wxWindowCreateEventHandler(func))
3649 #define EVT_WINDOW_DESTROY(func) wx__DECLARE_EVT0(wxEVT_DESTROY, wxWindowDestroyEventHandler(func))
3650 #define EVT_SET_CURSOR(func) wx__DECLARE_EVT0(wxEVT_SET_CURSOR, wxSetCursorEventHandler(func))
3651 #define EVT_MOUSE_CAPTURE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEventHandler(func))
3652 #define EVT_MOUSE_CAPTURE_LOST(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEventHandler(func))
3655 #define EVT_LEFT_DOWN(func) wx__DECLARE_EVT0(wxEVT_LEFT_DOWN, wxMouseEventHandler(func))
3656 #define EVT_LEFT_UP(func) wx__DECLARE_EVT0(wxEVT_LEFT_UP, wxMouseEventHandler(func))
3657 #define EVT_MIDDLE_DOWN(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DOWN, wxMouseEventHandler(func))
3658 #define EVT_MIDDLE_UP(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_UP, wxMouseEventHandler(func))
3659 #define EVT_RIGHT_DOWN(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DOWN, wxMouseEventHandler(func))
3660 #define EVT_RIGHT_UP(func) wx__DECLARE_EVT0(wxEVT_RIGHT_UP, wxMouseEventHandler(func))
3661 #define EVT_MOTION(func) wx__DECLARE_EVT0(wxEVT_MOTION, wxMouseEventHandler(func))
3662 #define EVT_LEFT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_LEFT_DCLICK, wxMouseEventHandler(func))
3663 #define EVT_MIDDLE_DCLICK(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DCLICK, wxMouseEventHandler(func))
3664 #define EVT_RIGHT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DCLICK, wxMouseEventHandler(func))
3665 #define EVT_LEAVE_WINDOW(func) wx__DECLARE_EVT0(wxEVT_LEAVE_WINDOW, wxMouseEventHandler(func))
3666 #define EVT_ENTER_WINDOW(func) wx__DECLARE_EVT0(wxEVT_ENTER_WINDOW, wxMouseEventHandler(func))
3667 #define EVT_MOUSEWHEEL(func) wx__DECLARE_EVT0(wxEVT_MOUSEWHEEL, wxMouseEventHandler(func))
3668 #define EVT_MOUSE_AUX1_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX1_DOWN, wxMouseEventHandler(func))
3669 #define EVT_MOUSE_AUX1_UP(func) wx__DECLARE_EVT0(wxEVT_AUX1_UP, wxMouseEventHandler(func))
3670 #define EVT_MOUSE_AUX1_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX1_DCLICK, wxMouseEventHandler(func))
3671 #define EVT_MOUSE_AUX2_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX2_DOWN, wxMouseEventHandler(func))
3672 #define EVT_MOUSE_AUX2_UP(func) wx__DECLARE_EVT0(wxEVT_AUX2_UP, wxMouseEventHandler(func))
3673 #define EVT_MOUSE_AUX2_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX2_DCLICK, wxMouseEventHandler(func))
3676 #define EVT_MOUSE_EVENTS(func) \
3677 EVT_LEFT_DOWN(func) \
3679 EVT_LEFT_DCLICK(func) \
3680 EVT_MIDDLE_DOWN(func) \
3681 EVT_MIDDLE_UP(func) \
3682 EVT_MIDDLE_DCLICK(func) \
3683 EVT_RIGHT_DOWN(func) \
3684 EVT_RIGHT_UP(func) \
3685 EVT_RIGHT_DCLICK(func) \
3686 EVT_MOUSE_AUX1_DOWN(func) \
3687 EVT_MOUSE_AUX1_UP(func) \
3688 EVT_MOUSE_AUX1_DCLICK(func) \
3689 EVT_MOUSE_AUX2_DOWN(func) \
3690 EVT_MOUSE_AUX2_UP(func) \
3691 EVT_MOUSE_AUX2_DCLICK(func) \
3693 EVT_LEAVE_WINDOW(func) \
3694 EVT_ENTER_WINDOW(func) \
3695 EVT_MOUSEWHEEL(func)
3697 // Scrolling from wxWindow (sent to wxScrolledWindow)
3698 #define EVT_SCROLLWIN_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_TOP, wxScrollWinEventHandler(func))
3699 #define EVT_SCROLLWIN_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEventHandler(func))
3700 #define EVT_SCROLLWIN_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEUP, wxScrollWinEventHandler(func))
3701 #define EVT_SCROLLWIN_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEventHandler(func))
3702 #define EVT_SCROLLWIN_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEventHandler(func))
3703 #define EVT_SCROLLWIN_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEventHandler(func))
3704 #define EVT_SCROLLWIN_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEventHandler(func))
3705 #define EVT_SCROLLWIN_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEventHandler(func))
3707 #define EVT_SCROLLWIN(func) \
3708 EVT_SCROLLWIN_TOP(func) \
3709 EVT_SCROLLWIN_BOTTOM(func) \
3710 EVT_SCROLLWIN_LINEUP(func) \
3711 EVT_SCROLLWIN_LINEDOWN(func) \
3712 EVT_SCROLLWIN_PAGEUP(func) \
3713 EVT_SCROLLWIN_PAGEDOWN(func) \
3714 EVT_SCROLLWIN_THUMBTRACK(func) \
3715 EVT_SCROLLWIN_THUMBRELEASE(func)
3717 // Scrolling from wxSlider and wxScrollBar
3718 #define EVT_SCROLL_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_TOP, wxScrollEventHandler(func))
3719 #define EVT_SCROLL_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLL_BOTTOM, wxScrollEventHandler(func))
3720 #define EVT_SCROLL_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEUP, wxScrollEventHandler(func))
3721 #define EVT_SCROLL_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEDOWN, wxScrollEventHandler(func))
3722 #define EVT_SCROLL_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEUP, wxScrollEventHandler(func))
3723 #define EVT_SCROLL_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler(func))
3724 #define EVT_SCROLL_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler(func))
3725 #define EVT_SCROLL_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBRELEASE, wxScrollEventHandler(func))
3726 #define EVT_SCROLL_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SCROLL_CHANGED, wxScrollEventHandler(func))
3728 #define EVT_SCROLL(func) \
3729 EVT_SCROLL_TOP(func) \
3730 EVT_SCROLL_BOTTOM(func) \
3731 EVT_SCROLL_LINEUP(func) \
3732 EVT_SCROLL_LINEDOWN(func) \
3733 EVT_SCROLL_PAGEUP(func) \
3734 EVT_SCROLL_PAGEDOWN(func) \
3735 EVT_SCROLL_THUMBTRACK(func) \
3736 EVT_SCROLL_THUMBRELEASE(func) \
3737 EVT_SCROLL_CHANGED(func)
3739 // Scrolling from wxSlider and wxScrollBar, with an id
3740 #define EVT_COMMAND_SCROLL_TOP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_TOP, winid, wxScrollEventHandler(func))
3741 #define EVT_COMMAND_SCROLL_BOTTOM(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_BOTTOM, winid, wxScrollEventHandler(func))
3742 #define EVT_COMMAND_SCROLL_LINEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEUP, winid, wxScrollEventHandler(func))
3743 #define EVT_COMMAND_SCROLL_LINEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEDOWN, winid, wxScrollEventHandler(func))
3744 #define EVT_COMMAND_SCROLL_PAGEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEUP, winid, wxScrollEventHandler(func))
3745 #define EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEDOWN, winid, wxScrollEventHandler(func))
3746 #define EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBTRACK, winid, wxScrollEventHandler(func))
3747 #define EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBRELEASE, winid, wxScrollEventHandler(func))
3748 #define EVT_COMMAND_SCROLL_CHANGED(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_CHANGED, winid, wxScrollEventHandler(func))
3750 #define EVT_COMMAND_SCROLL(winid, func) \
3751 EVT_COMMAND_SCROLL_TOP(winid, func) \
3752 EVT_COMMAND_SCROLL_BOTTOM(winid, func) \
3753 EVT_COMMAND_SCROLL_LINEUP(winid, func) \
3754 EVT_COMMAND_SCROLL_LINEDOWN(winid, func) \
3755 EVT_COMMAND_SCROLL_PAGEUP(winid, func) \
3756 EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) \
3757 EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) \
3758 EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) \
3759 EVT_COMMAND_SCROLL_CHANGED(winid, func)
3761 #if WXWIN_COMPATIBILITY_2_6
3762 // compatibility macros for the old name, deprecated in 2.8
3763 #define wxEVT_SCROLL_ENDSCROLL wxEVT_SCROLL_CHANGED
3764 #define EVT_COMMAND_SCROLL_ENDSCROLL EVT_COMMAND_SCROLL_CHANGED
3765 #define EVT_SCROLL_ENDSCROLL EVT_SCROLL_CHANGED
3766 #endif // WXWIN_COMPATIBILITY_2_6
3768 // Convenience macros for commonly-used commands
3769 #define EVT_CHECKBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKBOX_CLICKED, winid, wxCommandEventHandler(func))
3770 #define EVT_CHOICE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHOICE_SELECTED, winid, wxCommandEventHandler(func))
3771 #define EVT_LISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_SELECTED, winid, wxCommandEventHandler(func))
3772 #define EVT_LISTBOX_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, winid, wxCommandEventHandler(func))
3773 #define EVT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_MENU_SELECTED, winid, wxCommandEventHandler(func))
3774 #define EVT_MENU_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_MENU_SELECTED, id1, id2, wxCommandEventHandler(func))
3775 #if defined(__SMARTPHONE__)
3776 # define EVT_BUTTON(winid, func) EVT_MENU(winid, func)
3778 # define EVT_BUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_BUTTON_CLICKED, winid, wxCommandEventHandler(func))
3780 #define EVT_SLIDER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SLIDER_UPDATED, winid, wxCommandEventHandler(func))
3781 #define EVT_RADIOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBOX_SELECTED, winid, wxCommandEventHandler(func))
3782 #define EVT_RADIOBUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBUTTON_SELECTED, winid, wxCommandEventHandler(func))
3783 // EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events
3784 #define EVT_SCROLLBAR(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SCROLLBAR_UPDATED, winid, wxCommandEventHandler(func))
3785 #define EVT_VLBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_VLBOX_SELECTED, winid, wxCommandEventHandler(func))
3786 #define EVT_COMBOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_SELECTED, winid, wxCommandEventHandler(func))
3787 #define EVT_TOOL(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_CLICKED, winid, wxCommandEventHandler(func))
3788 #define EVT_TOOL_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, winid, wxCommandEventHandler(func))
3789 #define EVT_TOOL_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_CLICKED, id1, id2, wxCommandEventHandler(func))
3790 #define EVT_TOOL_RCLICKED(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_RCLICKED, winid, wxCommandEventHandler(func))
3791 #define EVT_TOOL_RCLICKED_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, wxCommandEventHandler(func))
3792 #define EVT_TOOL_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_ENTER, winid, wxCommandEventHandler(func))
3793 #define EVT_CHECKLISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, winid, wxCommandEventHandler(func))
3795 // Generic command events
3796 #define EVT_COMMAND_LEFT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_CLICK, winid, wxCommandEventHandler(func))
3797 #define EVT_COMMAND_LEFT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_DCLICK, winid, wxCommandEventHandler(func))
3798 #define EVT_COMMAND_RIGHT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_CLICK, winid, wxCommandEventHandler(func))
3799 #define EVT_COMMAND_RIGHT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_DCLICK, winid, wxCommandEventHandler(func))
3800 #define EVT_COMMAND_SET_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SET_FOCUS, winid, wxCommandEventHandler(func))
3801 #define EVT_COMMAND_KILL_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_KILL_FOCUS, winid, wxCommandEventHandler(func))
3802 #define EVT_COMMAND_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_ENTER, winid, wxCommandEventHandler(func))
3806 #define EVT_JOY_BUTTON_DOWN(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_DOWN, wxJoystickEventHandler(func))
3807 #define EVT_JOY_BUTTON_UP(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_UP, wxJoystickEventHandler(func))
3808 #define EVT_JOY_MOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_MOVE, wxJoystickEventHandler(func))
3809 #define EVT_JOY_ZMOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_ZMOVE, wxJoystickEventHandler(func))
3811 // All joystick events
3812 #define EVT_JOYSTICK_EVENTS(func) \
3813 EVT_JOY_BUTTON_DOWN(func) \
3814 EVT_JOY_BUTTON_UP(func) \
3815 EVT_JOY_MOVE(func) \
3819 #define EVT_IDLE(func) wx__DECLARE_EVT0(wxEVT_IDLE, wxIdleEventHandler(func))
3822 #define EVT_UPDATE_UI(winid, func) wx__DECLARE_EVT1(wxEVT_UPDATE_UI, winid, wxUpdateUIEventHandler(func))
3823 #define EVT_UPDATE_UI_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_UPDATE_UI, id1, id2, wxUpdateUIEventHandler(func))
3826 #define EVT_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_HELP, winid, wxHelpEventHandler(func))
3827 #define EVT_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_HELP, id1, id2, wxHelpEventHandler(func))
3828 #define EVT_DETAILED_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_DETAILED_HELP, winid, wxHelpEventHandler(func))
3829 #define EVT_DETAILED_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_DETAILED_HELP, id1, id2, wxHelpEventHandler(func))
3831 // Context Menu Events
3832 #define EVT_CONTEXT_MENU(func) wx__DECLARE_EVT0(wxEVT_CONTEXT_MENU, wxContextMenuEventHandler(func))
3833 #define EVT_COMMAND_CONTEXT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_CONTEXT_MENU, winid, wxContextMenuEventHandler(func))
3835 // Clipboard text Events
3836 #define EVT_TEXT_CUT(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_CUT, winid, wxClipboardTextEventHandler(func))
3837 #define EVT_TEXT_COPY(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_COPY, winid, wxClipboardTextEventHandler(func))
3838 #define EVT_TEXT_PASTE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_PASTE, winid, wxClipboardTextEventHandler(func))
3840 // ----------------------------------------------------------------------------
3842 // ----------------------------------------------------------------------------
3844 // list containing event handlers with pending events for them
3846 // notice that each event handler should occur at most once in this list
3847 extern WXDLLIMPEXP_BASE wxList
*wxHandlersWithPendingEvents
;
3849 extern WXDLLIMPEXP_BASE wxCriticalSection
*wxHandlersWithPendingEventsLocker
;
3852 // ----------------------------------------------------------------------------
3854 // ----------------------------------------------------------------------------
3858 // Find a window with the focus, that is also a descendant of the given window.
3859 // This is used to determine the window to initially send commands to.
3860 WXDLLIMPEXP_CORE wxWindow
* wxFindFocusDescendant(wxWindow
* ancestor
);
3864 #endif // _WX_EVENT_H_