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 // ----------------------------------------------------------------------------
31 // forward declarations
32 // ----------------------------------------------------------------------------
34 class WXDLLIMPEXP_FWD_BASE wxList
;
35 class WXDLLIMPEXP_FWD_BASE wxEvent
;
37 class WXDLLIMPEXP_FWD_CORE wxDC
;
38 class WXDLLIMPEXP_FWD_CORE wxMenu
;
39 class WXDLLIMPEXP_FWD_CORE wxWindow
;
40 class WXDLLIMPEXP_FWD_CORE wxWindowBase
;
43 // We operate with pointer to members of wxEvtHandler (such functions are used
44 // as event handlers in the event tables or as arguments to Connect()) but by
45 // default MSVC uses a restricted (but more efficient) representation of
46 // pointers to members which can't deal with multiple base classes. To avoid
47 // mysterious (as the compiler is not good enough to detect this and give a
48 // sensible error message) errors in the user code as soon as it defines
49 // classes inheriting from both wxEvtHandler (possibly indirectly, e.g. via
50 // wxWindow) and something else (including our own wxTrackable but not limited
51 // to it), we use the special MSVC keyword telling the compiler to use a more
52 // general pointer to member representation for the classes inheriting from
55 #define wxMSVC_FWD_MULTIPLE_BASES __multiple_inheritance
57 #define wxMSVC_FWD_MULTIPLE_BASES
60 class WXDLLIMPEXP_FWD_BASE wxMSVC_FWD_MULTIPLE_BASES wxEvtHandler
;
61 class wxEventConnectionRef
;
63 // ----------------------------------------------------------------------------
65 // ----------------------------------------------------------------------------
67 typedef int wxEventType
;
69 #define wxEVT_ANY ((wxEventType)-1)
71 // this is used to make the event table entry type safe, so that for an event
72 // handler only a function with proper parameter list can be given.
73 #define wxStaticCastEvent(type, val) static_cast<type>(val)
75 #define DECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj) \
76 wxEventTableEntry(type, winid, idLast, wxNewEventFunctor(type, fn), obj)
78 #define DECLARE_EVENT_TABLE_TERMINATOR() \
79 wxEventTableEntry(wxEVT_NULL, 0, 0, 0, 0)
81 // obsolete event declaration/definition macros, we don't need them any longer
82 // but we keep them for compatibility as it doesn't cost us anything anyhow
83 #define BEGIN_DECLARE_EVENT_TYPES()
84 #define END_DECLARE_EVENT_TYPES()
85 #define DECLARE_EXPORTED_EVENT_TYPE(expdecl, name, value) \
86 extern expdecl const wxEventType name;
87 #define DECLARE_EVENT_TYPE(name, value) \
88 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_CORE, name, value)
89 #define DECLARE_LOCAL_EVENT_TYPE(name, value) \
90 DECLARE_EXPORTED_EVENT_TYPE(wxEMPTY_PARAMETER_VALUE, name, value)
91 #define DEFINE_EVENT_TYPE(name) const wxEventType name = wxNewEventType();
92 #define DEFINE_LOCAL_EVENT_TYPE(name) DEFINE_EVENT_TYPE(name)
94 // generate a new unique event type
95 extern WXDLLIMPEXP_BASE wxEventType
wxNewEventType();
97 // macros to create an event type depending on whether type safe events are
100 #if wxEVENTS_COMPATIBILITY_2_8
101 #define wxDEFINE_EVENT( name, type ) \
102 const wxEventType name( wxNewEventType() );
104 #define wxDECLARE_EXPORTED_EVENT( expdecl, name, type ) \
105 extern const expdecl wxEventType name;
107 #define wxDEFINE_EVENT_REFERENCE( name, type, value ) \
108 const wxEventType &name( value );
110 #define wxDECLARE_EXPORTED_EVENT_REFERENCE( expdecl, name, type ) \
111 extern const expdecl wxEventType &name;
113 #define wxDECLARE_LOCAL_EVENT( name, type ) \
114 wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type )
116 #define wxEVENT_HANDLER_CAST( functype, func ) \
117 ( wxObjectEventFunction )( wxEventFunction )wxStaticCastEvent( functype, &func )
119 #define wxDEFINE_EVENT( name, type ) \
120 const wxTypedEventType< type > name( wxNewEventType() );
122 #define wxDECLARE_EXPORTED_EVENT( expdecl, name, type ) \
123 extern const expdecl wxTypedEventType< type > name;
125 #define wxDEFINE_EVENT_REFERENCE( name, type, value ) \
126 const wxTypedEventTypeReference< type > name( value );
128 #define wxDECLARE_EXPORTED_EVENT_REFERENCE( expdecl, name, type ) \
129 extern const expdecl wxTypedEventTypeReference< type > name;
131 #define wxDECLARE_LOCAL_EVENT( name, type ) \
132 wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type )
134 #define wxEVENT_HANDLER_CAST( functype, func ) \
138 // template which associates the correct event object with the event type
140 #if !wxEVENTS_COMPATIBILITY_2_8
142 template <typename Event
>
143 class WXDLLIMPEXP_BASE wxTypedEventType
146 typedef Event CorrespondingEvent
;
148 wxTypedEventType(wxEventType type
) { m_type
= type
; }
150 // used for static event tables
151 operator const wxEventType
&() const { return m_type
; }
157 // Due to a bug in older wx versions wxSpinEvents were being sent with type of
158 // wxEVT_SCROLL_LINEUP, wxEVT_SCROLL_LINEDOWN and wxEVT_SCROLL_THUMBTRACK. But
159 // with the type-safe events in place, these event types are associated with
160 // wxScrollEvent. To allow handling of spin events, new event types have been
161 // defined in spinbutt.h/spinnbuttcmn.cpp. To maintain backward compatibility
162 // the spin event types are being initialized with the scroll event types. But
163 // this presents as with the same static initialization order problem we also
164 // have for the static event tables. So we use the same solution and the
165 // template definition below holds a reference to a wxEventType.
166 template <typename Event
>
167 class WXDLLIMPEXP_BASE wxTypedEventTypeReference
170 typedef Event CorrespondingEvent
;
172 wxTypedEventTypeReference(const wxEventType
& type
) : m_type(type
) { }
174 // used for static event tables
175 operator const wxEventType
&() const { return m_type
; }
178 const wxEventType
&m_type
;
181 #endif // !wxEVENTS_COMPATIBILITY_2_8
183 // These are needed for the functor definitions
184 typedef void (wxEvtHandler
::*wxEventFunction
)(wxEvent
&);
186 // We had some trouble (specifically with eVC for ARM WinCE build) with using
187 // wxEventFunction in the past so we had introduced wxObjectEventFunction which
188 // used to be a typedef for a member of wxObject and not wxEvtHandler to work
189 // around this but as eVC is not really supported any longer we now only keep
190 // this for backwards compatibility and, despite its name, this is a typedef
191 // for wxEvtHandler member now -- but if we have the same problem with another
192 // compiler we can restore its old definition for it.
193 typedef wxEventFunction wxObjectEventFunction
;
196 // the functors which will be stored in the static/dynamic tables
197 class WXDLLIMPEXP_BASE wxEventFunctor
200 virtual ~wxEventFunctor();
202 // this operator is used to actually invoke the event handler
203 virtual void operator()(wxEvtHandler
*, wxEvent
&) = 0;
205 // this function tests whether this functor is matched, for the purpose of
206 // finding it in an event table in Disconnect(), by the given func
207 virtual bool Matches(const wxEventFunctor
& func
) const = 0;
209 virtual wxEvtHandler
*GetHandler() const { return NULL
; }
211 virtual wxObjectEventFunction
GetMethod() const { return NULL
; }
214 // A plain method functor
215 class WXDLLIMPEXP_BASE wxObjectEventFunctor
: public wxEventFunctor
218 wxObjectEventFunctor(wxObjectEventFunction method
, wxEvtHandler
*handler
)
224 virtual void operator()(wxEvtHandler
*handler
, wxEvent
& event
)
226 wxEvtHandler
* const realHandler
= m_handler ? m_handler
: handler
;
228 (realHandler
->*m_method
)(event
);
231 virtual bool Matches(const wxEventFunctor
& other
) const
233 wxEvtHandler
* const handler
= other
.GetHandler();
235 return (m_handler
== handler
|| !handler
) &&
236 (m_method
== other
.GetMethod());
239 virtual wxEvtHandler
*GetHandler() const { return m_handler
; }
240 virtual wxObjectEventFunction
GetMethod() const { return m_method
; }
243 wxEvtHandler
*m_handler
;
244 wxObjectEventFunction m_method
;
247 // Create a functor for the legacy events: handler can be NULL
249 inline wxObjectEventFunctor
*
250 wxNewEventFunctor(wxEventType
WXUNUSED(evtType
),
251 wxObjectEventFunction method
,
252 wxEvtHandler
*handler
)
254 return new wxObjectEventFunctor(method
, handler
);
257 inline wxObjectEventFunctor
258 wxConstructEventFunctor(wxEventType
WXUNUSED(evtType
),
259 wxObjectEventFunction method
,
260 wxEvtHandler
*handler
)
262 return wxObjectEventFunctor(method
, handler
);
265 #if !wxEVENTS_COMPATIBILITY_2_8
267 template <typename EventType
>
268 class WXDLLIMPEXP_BASE wxEventFunctorFunction
: public wxEventFunctor
271 wxEventFunctorFunction(void (*handler
)(typename EventType
::CorrespondingEvent
&))
276 virtual void operator()(wxEvtHandler
*WXUNUSED(handler
), wxEvent
& event
)
278 // Protect against wrong event i.e. wxMouseEvent evt(wxEVT_PAINT):
279 wxASSERT( dynamic_cast< typename EventType
::CorrespondingEvent
* >( &event
) != NULL
);
281 // Will throw a std::bad_cast exception in release build:
282 ( *m_handler
)( dynamic_cast< typename EventType
::CorrespondingEvent
& >( event
));
285 virtual bool Matches( const wxEventFunctor
&right
) const
287 wxEventFunctorFunction
const &other
= dynamic_cast< wxEventFunctorFunction
const & >( right
);
289 return m_handler
== other
.m_handler
|| other
.m_handler
== NULL
;
293 void ( *m_handler
)( typename EventType
::CorrespondingEvent
& );
297 template <typename EventType
, typename Class
, typename Derived
>
298 class WXDLLIMPEXP_BASE wxEventFunctorMethod
: public wxEventFunctor
301 wxEventFunctorMethod( void ( Class
::*method
)( typename EventType
::CorrespondingEvent
& ),
308 virtual void operator () ( wxEvtHandler
*handler
, wxEvent
&event
)
310 // Compile-time type check 1: This requires Derived to derive from or
311 // be of the same type as Class
312 Class
*realHandler
= m_handler
;
314 if( m_handler
== NULL
)
316 // Verify that the handler does indeed derive from the class
317 // containing the handler method
318 wxASSERT( dynamic_cast< Class
* >( handler
) != NULL
);
320 realHandler
= dynamic_cast< Class
* >( handler
);
323 // Protect against wrong event i.e. wxMouseEvent evt(wxEVT_PAINT):
324 wxASSERT( dynamic_cast< typename EventType
::CorrespondingEvent
* >( &event
) != NULL
);
326 // Will throw a std::bad_cast exception in release build:
327 ( realHandler
->*m_method
)( dynamic_cast< typename EventType
::CorrespondingEvent
& >( event
));
330 virtual bool Matches( const wxEventFunctor
&right
) const
332 wxEventFunctorMethod
const &other
= dynamic_cast< wxEventFunctorMethod
const & >( right
);
334 return (( m_handler
== other
.m_handler
|| other
.m_handler
== NULL
) &&
335 ( m_method
== other
.m_method
|| other
.m_method
== NULL
));
338 virtual wxEvtHandler
*GetHandler() const
340 // This makes sure Derived derives from wxEvtHandler (it is still
341 // possible and even ok if Class does not derive from wxEvtHandler. In
342 // this case Derived would end up using multiple inheritance: class
343 // Derived : public wxEvtHandler, public Class { } where Class contains
344 // the method to call, but wxEvtHandler contains the wxTrackable and
345 // code for weak ref support
349 virtual wxObjectEventFunction
GetMethod() const
351 return reinterpret_cast<wxObjectEventFunction
>(m_method
);
356 void (Class
::*m_method
)(typename EventType
::CorrespondingEvent
&);
360 template <typename EventType
, typename Functor
>
361 class WXDLLIMPEXP_BASE wxEventFunctorAdapter
: public wxEventFunctor
364 wxEventFunctorAdapter( Functor
&functor
)
369 virtual void operator () ( wxEvtHandler
*WXUNUSED( handler
), wxEvent
&event
)
371 // Protect against wrong event i.e. wxMouseEvent evt(wxEVT_PAINT):
372 wxASSERT( dynamic_cast< typename EventType
::CorrespondingEvent
* >( &event
) != NULL
);
374 // Will throw a std::bad_cast exception in release build:
375 m_functor( dynamic_cast< typename EventType
::CorrespondingEvent
& >( event
));
378 virtual bool Matches( const wxEventFunctor
&right
) const
380 wxEventFunctorAdapter
const &other
= dynamic_cast< wxEventFunctorAdapter
const & >( right
);
382 return m_functor
== other
.m_functor
;
390 // Create functors for the templatized events (needed in wxEvtHandler::Connect):
393 // Create a functor for functions:
395 template <typename EventType
>
396 inline wxEventFunctorFunction
<EventType
> *
397 wxNewEventFunctor(const EventType
&,
398 void (*function
)(typename EventType
::CorrespondingEvent
&))
400 return new wxEventFunctorFunction
<EventType
>(function
);
403 // Create a functor for methods:
405 template <typename EventType
, typename Class
>
406 inline wxEventFunctorMethod
<EventType
, Class
, Class
> *
407 wxNewEventFunctor(const EventType
&,
408 void (Class
::*method
)(typename EventType
::CorrespondingEvent
&))
410 return new wxEventFunctorMethod
<EventType
, Class
, Class
>(method
, NULL
);
413 template <typename EventType
, typename Class
, typename Derived
>
414 inline wxEventFunctorMethod
<EventType
, Class
, Derived
> *
415 wxNewEventFunctor(const EventType
&,
416 void (Class
::*method
)(typename EventType
::CorrespondingEvent
&),
419 return new wxEventFunctorMethod
<EventType
, Class
, Derived
>(method
, handler
);
422 // Create a functor for arbitrary functors (like boost::function):
423 template <typename EventType
, typename Functor
>
424 inline wxEventFunctorAdapter
<EventType
, Functor
> *
425 wxNewEventFunctor(const EventType
&,
428 return new wxEventFunctorAdapter
<EventType
, Functor
>(functor
);
432 // Construct functors for the templatized events (needed in wxEvtHandler::Disconnect):
435 // Construct a functor for functions:
437 template <typename EventType
>
438 inline wxEventFunctorFunction
<EventType
>
439 wxConstructEventFunctor(const EventType
&,
440 void (*function
)(typename EventType
::CorrespondingEvent
&))
442 return wxEventFunctorFunction
<EventType
>(function
);
445 // Construct a functor for methods:
447 template <typename EventType
, typename Class
>
448 inline wxEventFunctorMethod
<EventType
, Class
, Class
>
449 wxConstructEventFunctor(const EventType
&,
450 void (Class
::*method
)(typename EventType
::CorrespondingEvent
&))
452 return wxEventFunctorMethod
<EventType
, Class
, Class
>(method
, NULL
);
455 template <typename EventType
, typename Class
, typename Derived
>
456 inline wxEventFunctorMethod
<EventType
, Class
, Derived
>
457 wxConstructEventFunctor(const EventType
&,
458 void (Class
::*method
)(typename EventType
::CorrespondingEvent
&),
461 return wxEventFunctorMethod
<EventType
, Class
, Derived
>(method
, handler
);
464 // Construct a functor for arbitrary functors (like boost:function):
466 template <typename EventType
, typename Functor
>
467 inline wxEventFunctorAdapter
<EventType
, Functor
>
468 wxConstructEventFunctor(const EventType
&,
471 return wxEventFunctorAdapter
<EventType
, Functor
>(functor
);
474 #endif // !wxEVENTS_COMPATIBILITY_2_8
476 // many, but not all, standard event types
478 // some generic events
479 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_NULL
;
480 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_FIRST
;
481 extern WXDLLIMPEXP_BASE
const wxEventType wxEVT_USER_FIRST
;
483 // Need events declared to do this
484 class WXDLLIMPEXP_FWD_CORE wxCommandEvent
;
485 class WXDLLIMPEXP_FWD_CORE wxMouseEvent
;
486 class WXDLLIMPEXP_FWD_CORE wxFocusEvent
;
487 class WXDLLIMPEXP_FWD_CORE wxChildFocusEvent
;
488 class WXDLLIMPEXP_FWD_CORE wxKeyEvent
;
489 class WXDLLIMPEXP_FWD_CORE wxNavigationKeyEvent
;
490 class WXDLLIMPEXP_FWD_CORE wxSetCursorEvent
;
491 class WXDLLIMPEXP_FWD_CORE wxScrollEvent
;
492 class WXDLLIMPEXP_FWD_CORE wxScrollWinEvent
;
493 class WXDLLIMPEXP_FWD_CORE wxSizeEvent
;
494 class WXDLLIMPEXP_FWD_CORE wxMoveEvent
;
495 class WXDLLIMPEXP_FWD_CORE wxCloseEvent
;
496 class WXDLLIMPEXP_FWD_CORE wxActivateEvent
;
497 class WXDLLIMPEXP_FWD_CORE wxWindowCreateEvent
;
498 class WXDLLIMPEXP_FWD_CORE wxWindowDestroyEvent
;
499 class WXDLLIMPEXP_FWD_CORE wxShowEvent
;
500 class WXDLLIMPEXP_FWD_CORE wxIconizeEvent
;
501 class WXDLLIMPEXP_FWD_CORE wxMaximizeEvent
;
502 class WXDLLIMPEXP_FWD_CORE wxMouseCaptureChangedEvent
;
503 class WXDLLIMPEXP_FWD_CORE wxMouseCaptureLostEvent
;
504 class WXDLLIMPEXP_FWD_CORE wxPaintEvent
;
505 class WXDLLIMPEXP_FWD_CORE wxEraseEvent
;
506 class WXDLLIMPEXP_FWD_CORE wxNcPaintEvent
;
507 class WXDLLIMPEXP_FWD_CORE wxMenuEvent
;
508 class WXDLLIMPEXP_FWD_CORE wxContextMenuEvent
;
509 class WXDLLIMPEXP_FWD_CORE wxSysColourChangedEvent
;
510 class WXDLLIMPEXP_FWD_CORE wxDisplayChangedEvent
;
511 class WXDLLIMPEXP_FWD_CORE wxQueryNewPaletteEvent
;
512 class WXDLLIMPEXP_FWD_CORE wxPaletteChangedEvent
;
513 class WXDLLIMPEXP_FWD_CORE wxJoystickEvent
;
514 class WXDLLIMPEXP_FWD_CORE wxDropFilesEvent
;
515 class WXDLLIMPEXP_FWD_CORE wxInitDialogEvent
;
516 class WXDLLIMPEXP_FWD_CORE wxIdleEvent
;
517 class WXDLLIMPEXP_FWD_CORE wxUpdateUIEvent
;
518 class WXDLLIMPEXP_FWD_CORE wxClipboardTextEvent
;
519 class WXDLLIMPEXP_FWD_CORE wxHelpEvent
;
523 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_BUTTON_CLICKED
, wxCommandEvent
)
524 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHECKBOX_CLICKED
, wxCommandEvent
)
525 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHOICE_SELECTED
, wxCommandEvent
)
526 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LISTBOX_SELECTED
, wxCommandEvent
)
527 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
, wxCommandEvent
)
528 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
, wxCommandEvent
)
529 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_MENU_SELECTED
, wxCommandEvent
)
530 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SLIDER_UPDATED
, wxCommandEvent
)
531 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RADIOBOX_SELECTED
, wxCommandEvent
)
532 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RADIOBUTTON_SELECTED
, wxCommandEvent
)
534 // wxEVT_COMMAND_SCROLLBAR_UPDATED is deprecated, use wxEVT_SCROLL... events
535 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SCROLLBAR_UPDATED
, wxCommandEvent
)
536 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_VLBOX_SELECTED
, wxCommandEvent
)
537 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_COMBOBOX_SELECTED
, wxCommandEvent
)
538 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_RCLICKED
, wxCommandEvent
)
539 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED
, wxCommandEvent
)
540 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TOOL_ENTER
, wxCommandEvent
)
543 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_DOWN
, wxMouseEvent
)
544 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_UP
, wxMouseEvent
)
545 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_DOWN
, wxMouseEvent
)
546 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_UP
, wxMouseEvent
)
547 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_DOWN
, wxMouseEvent
)
548 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_UP
, wxMouseEvent
)
549 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOTION
, wxMouseEvent
)
550 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ENTER_WINDOW
, wxMouseEvent
)
551 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEAVE_WINDOW
, wxMouseEvent
)
552 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_LEFT_DCLICK
, wxMouseEvent
)
553 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MIDDLE_DCLICK
, wxMouseEvent
)
554 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_RIGHT_DCLICK
, wxMouseEvent
)
555 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SET_FOCUS
, wxFocusEvent
)
556 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KILL_FOCUS
, wxFocusEvent
)
557 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHILD_FOCUS
, wxChildFocusEvent
)
558 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSEWHEEL
, wxMouseEvent
)
559 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_DOWN
, wxMouseEvent
)
560 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_UP
, wxMouseEvent
)
561 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX1_DCLICK
, wxMouseEvent
)
562 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_DOWN
, wxMouseEvent
)
563 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_UP
, wxMouseEvent
)
564 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_AUX2_DCLICK
, wxMouseEvent
)
566 // Character input event type
567 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHAR
, wxKeyEvent
)
568 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CHAR_HOOK
, wxKeyEvent
)
569 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_NAVIGATION_KEY
, wxNavigationKeyEvent
)
570 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KEY_DOWN
, wxKeyEvent
)
571 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_KEY_UP
, wxKeyEvent
)
573 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HOTKEY
, wxKeyEvent
)
576 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SET_CURSOR
, wxSetCursorEvent
)
578 // wxScrollBar and wxSlider event identifiers
579 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_TOP
, wxScrollEvent
)
580 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_BOTTOM
, wxScrollEvent
)
581 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_LINEUP
, wxScrollEvent
)
582 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_LINEDOWN
, wxScrollEvent
)
583 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_PAGEUP
, wxScrollEvent
)
584 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_PAGEDOWN
, wxScrollEvent
)
585 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_THUMBTRACK
, wxScrollEvent
)
586 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_THUMBRELEASE
, wxScrollEvent
)
587 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLL_CHANGED
, wxScrollEvent
)
589 // Scroll events from wxWindow
590 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_TOP
, wxScrollWinEvent
)
591 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_BOTTOM
, wxScrollWinEvent
)
592 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_LINEUP
, wxScrollWinEvent
)
593 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_LINEDOWN
, wxScrollWinEvent
)
594 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_PAGEUP
, wxScrollWinEvent
)
595 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_PAGEDOWN
, wxScrollWinEvent
)
596 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_THUMBTRACK
, wxScrollWinEvent
)
597 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SCROLLWIN_THUMBRELEASE
, wxScrollWinEvent
)
600 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SIZE
, wxSizeEvent
)
601 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE
, wxMoveEvent
)
602 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CLOSE_WINDOW
, wxCloseEvent
)
603 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_END_SESSION
, wxCloseEvent
)
604 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_QUERY_END_SESSION
, wxCloseEvent
)
605 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ACTIVATE_APP
, wxActivateEvent
)
606 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ACTIVATE
, wxActivateEvent
)
607 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CREATE
, wxWindowCreateEvent
)
608 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DESTROY
, wxWindowDestroyEvent
)
609 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SHOW
, wxShowEvent
)
610 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ICONIZE
, wxIconizeEvent
)
611 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MAXIMIZE
, wxMaximizeEvent
)
612 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSE_CAPTURE_CHANGED
, wxMouseCaptureChangedEvent
)
613 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOUSE_CAPTURE_LOST
, wxMouseCaptureLostEvent
)
614 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_PAINT
, wxPaintEvent
)
615 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_ERASE_BACKGROUND
, wxEraseEvent
)
616 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_NC_PAINT
, wxNcPaintEvent
)
617 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_OPEN
, wxMenuEvent
)
618 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_CLOSE
, wxMenuEvent
)
619 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MENU_HIGHLIGHT
, wxMenuEvent
)
620 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_CONTEXT_MENU
, wxContextMenuEvent
)
621 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SYS_COLOUR_CHANGED
, wxSysColourChangedEvent
)
622 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DISPLAY_CHANGED
, wxDisplayChangedEvent
)
623 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_QUERY_NEW_PALETTE
, wxQueryNewPaletteEvent
)
624 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_PALETTE_CHANGED
, wxPaletteChangedEvent
)
625 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_BUTTON_DOWN
, wxJoystickEvent
)
626 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_BUTTON_UP
, wxJoystickEvent
)
627 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_MOVE
, wxJoystickEvent
)
628 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_JOY_ZMOVE
, wxJoystickEvent
)
629 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DROP_FILES
, wxDropFilesEvent
)
630 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_INIT_DIALOG
, wxInitDialogEvent
)
631 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_BASE
, wxEVT_IDLE
, wxIdleEvent
)
632 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_UPDATE_UI
, wxUpdateUIEvent
)
633 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_SIZING
, wxSizeEvent
)
634 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVING
, wxMoveEvent
)
635 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE_START
, wxMoveEvent
)
636 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_MOVE_END
, wxMoveEvent
)
637 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HIBERNATE
, wxActivateEvent
)
640 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_COPY
, wxClipboardTextEvent
)
641 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_CUT
, wxClipboardTextEvent
)
642 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_PASTE
, wxClipboardTextEvent
)
644 // Generic command events
645 // Note: a click is a higher-level event than button down/up
646 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LEFT_CLICK
, wxCommandEvent
)
647 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_LEFT_DCLICK
, wxCommandEvent
)
648 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RIGHT_CLICK
, wxCommandEvent
)
649 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_RIGHT_DCLICK
, wxCommandEvent
)
650 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_SET_FOCUS
, wxCommandEvent
)
651 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_KILL_FOCUS
, wxCommandEvent
)
652 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_ENTER
, wxCommandEvent
)
655 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_HELP
, wxHelpEvent
)
656 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_DETAILED_HELP
, wxHelpEvent
)
658 // these 2 events are the same
659 #define wxEVT_COMMAND_TOOL_CLICKED wxEVT_COMMAND_MENU_SELECTED
661 // ----------------------------------------------------------------------------
663 // ----------------------------------------------------------------------------
665 // this event is also used by wxComboBox and wxSpinCtrl which don't include
666 // wx/textctrl.h in all ports [yet], so declare it here as well
668 // still, any new code using it should include wx/textctrl.h explicitly
669 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TEXT_UPDATED
, wxCommandEvent
)
671 // the predefined constants for the number of times we propagate event
672 // upwards window child-parent chain
673 enum Propagation_state
675 // don't propagate it at all
676 wxEVENT_PROPAGATE_NONE
= 0,
678 // propagate it until it is processed
679 wxEVENT_PROPAGATE_MAX
= INT_MAX
683 * wxWidgets events, covering all interesting things that might happen
684 * (button clicking, resizing, setting text in widgets, etc.).
686 * For each completely new event type, derive a new event class.
687 * An event CLASS represents a C++ class defining a range of similar event TYPES;
688 * examples are canvas events, panel item command events.
689 * An event TYPE is a unique identifier for a particular system event,
690 * such as a button press or a listbox deselection.
694 class WXDLLIMPEXP_BASE wxEvent
: public wxObject
697 wxEvent(int winid
= 0, wxEventType commandType
= wxEVT_NULL
);
699 void SetEventType(wxEventType typ
) { m_eventType
= typ
; }
700 wxEventType
GetEventType() const { return m_eventType
; }
701 wxObject
*GetEventObject() const { return m_eventObject
; }
702 void SetEventObject(wxObject
*obj
) { m_eventObject
= obj
; }
703 long GetTimestamp() const { return m_timeStamp
; }
704 void SetTimestamp(long ts
= 0) { m_timeStamp
= ts
; }
705 int GetId() const { return m_id
; }
706 void SetId(int Id
) { m_id
= Id
; }
708 // Can instruct event processor that we wish to ignore this event
709 // (treat as if the event table entry had not been found): this must be done
710 // to allow the event processing by the base classes (calling event.Skip()
711 // is the analog of calling the base class version of a virtual function)
712 void Skip(bool skip
= true) { m_skipped
= skip
; }
713 bool GetSkipped() const { return m_skipped
; }
715 // this function is used to create a copy of the event polymorphically and
716 // all derived classes must implement it because otherwise wxPostEvent()
717 // for them wouldn't work (it needs to do a copy of the event)
718 virtual wxEvent
*Clone() const = 0;
720 // Implementation only: this test is explicitly anti OO and this function
721 // exists only for optimization purposes.
722 bool IsCommandEvent() const { return m_isCommandEvent
; }
724 // Determine if this event should be propagating to the parent window.
725 bool ShouldPropagate() const
726 { return m_propagationLevel
!= wxEVENT_PROPAGATE_NONE
; }
728 // Stop an event from propagating to its parent window, returns the old
729 // propagation level value
730 int StopPropagation()
732 int propagationLevel
= m_propagationLevel
;
733 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
734 return propagationLevel
;
737 // Resume the event propagation by restoring the propagation level
738 // (returned by StopPropagation())
739 void ResumePropagation(int propagationLevel
)
741 m_propagationLevel
= propagationLevel
;
745 wxObject
* m_eventObject
;
746 wxEventType m_eventType
;
751 // m_callbackUserData is for internal usage only
752 wxObject
* m_callbackUserData
;
755 // the propagation level: while it is positive, we propagate the event to
756 // the parent window (if any)
758 // this one doesn't have to be public, we don't have to worry about
759 // backwards compatibility as it is new
760 int m_propagationLevel
;
763 bool m_isCommandEvent
;
766 wxEvent(const wxEvent
&); // for implementing Clone()
767 wxEvent
& operator=(const wxEvent
&); // for derived classes operator=()
770 // it needs to access our m_propagationLevel
771 friend class WXDLLIMPEXP_FWD_BASE wxPropagateOnce
;
773 DECLARE_ABSTRACT_CLASS(wxEvent
)
777 * Helper class to temporarily change an event not to propagate.
779 class WXDLLIMPEXP_BASE wxPropagationDisabler
782 wxPropagationDisabler(wxEvent
& event
) : m_event(event
)
784 m_propagationLevelOld
= m_event
.StopPropagation();
787 ~wxPropagationDisabler()
789 m_event
.ResumePropagation(m_propagationLevelOld
);
794 int m_propagationLevelOld
;
796 DECLARE_NO_COPY_CLASS(wxPropagationDisabler
)
800 * Another one to temporarily lower propagation level.
802 class WXDLLIMPEXP_BASE wxPropagateOnce
805 wxPropagateOnce(wxEvent
& event
) : m_event(event
)
807 wxASSERT_MSG( m_event
.m_propagationLevel
> 0,
808 _T("shouldn't be used unless ShouldPropagate()!") );
810 m_event
.m_propagationLevel
--;
815 m_event
.m_propagationLevel
++;
821 DECLARE_NO_COPY_CLASS(wxPropagateOnce
)
828 // Item or menu event class
830 wxEVT_COMMAND_BUTTON_CLICKED
831 wxEVT_COMMAND_CHECKBOX_CLICKED
832 wxEVT_COMMAND_CHOICE_SELECTED
833 wxEVT_COMMAND_LISTBOX_SELECTED
834 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
835 wxEVT_COMMAND_TEXT_UPDATED
836 wxEVT_COMMAND_TEXT_ENTER
837 wxEVT_COMMAND_MENU_SELECTED
838 wxEVT_COMMAND_SLIDER_UPDATED
839 wxEVT_COMMAND_RADIOBOX_SELECTED
840 wxEVT_COMMAND_RADIOBUTTON_SELECTED
841 wxEVT_COMMAND_SCROLLBAR_UPDATED
842 wxEVT_COMMAND_VLBOX_SELECTED
843 wxEVT_COMMAND_COMBOBOX_SELECTED
844 wxEVT_COMMAND_TOGGLEBUTTON_CLICKED
847 class WXDLLIMPEXP_CORE wxCommandEvent
: public wxEvent
850 wxCommandEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0);
852 wxCommandEvent(const wxCommandEvent
& event
)
854 m_cmdString(event
.m_cmdString
),
855 m_commandInt(event
.m_commandInt
),
856 m_extraLong(event
.m_extraLong
),
857 m_clientData(event
.m_clientData
),
858 m_clientObject(event
.m_clientObject
)
861 // Set/Get client data from controls
862 void SetClientData(void* clientData
) { m_clientData
= clientData
; }
863 void *GetClientData() const { return m_clientData
; }
865 // Set/Get client object from controls
866 void SetClientObject(wxClientData
* clientObject
) { m_clientObject
= clientObject
; }
867 wxClientData
*GetClientObject() const { return m_clientObject
; }
869 // Get listbox selection if single-choice
870 int GetSelection() const { return m_commandInt
; }
872 // Set/Get listbox/choice selection string
873 void SetString(const wxString
& s
) { m_cmdString
= s
; }
874 wxString
GetString() const;
876 // Get checkbox value
877 bool IsChecked() const { return m_commandInt
!= 0; }
879 // true if the listbox event was a selection.
880 bool IsSelection() const { return (m_extraLong
!= 0); }
882 void SetExtraLong(long extraLong
) { m_extraLong
= extraLong
; }
883 long GetExtraLong() const { return m_extraLong
; }
885 void SetInt(int i
) { m_commandInt
= i
; }
886 int GetInt() const { return m_commandInt
; }
888 virtual wxEvent
*Clone() const { return new wxCommandEvent(*this); }
891 wxString m_cmdString
; // String event argument
893 long m_extraLong
; // Additional information (e.g. select/deselect)
894 void* m_clientData
; // Arbitrary client data
895 wxClientData
* m_clientObject
; // Arbitrary client object
898 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCommandEvent
)
901 // this class adds a possibility to react (from the user) code to a control
902 // notification: allow or veto the operation being reported.
903 class WXDLLIMPEXP_CORE wxNotifyEvent
: public wxCommandEvent
906 wxNotifyEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0)
907 : wxCommandEvent(commandType
, winid
)
910 wxNotifyEvent(const wxNotifyEvent
& event
)
911 : wxCommandEvent(event
)
912 { m_bAllow
= event
.m_bAllow
; }
914 // veto the operation (usually it's allowed by default)
915 void Veto() { m_bAllow
= false; }
917 // allow the operation if it was disabled by default
918 void Allow() { m_bAllow
= true; }
920 // for implementation code only: is the operation allowed?
921 bool IsAllowed() const { return m_bAllow
; }
923 virtual wxEvent
*Clone() const { return new wxNotifyEvent(*this); }
929 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNotifyEvent
)
932 // Scroll event class, derived form wxCommandEvent. wxScrollEvents are
933 // sent by wxSlider and wxScrollBar.
938 wxEVT_SCROLL_LINEDOWN
940 wxEVT_SCROLL_PAGEDOWN
941 wxEVT_SCROLL_THUMBTRACK
942 wxEVT_SCROLL_THUMBRELEASE
946 class WXDLLIMPEXP_CORE wxScrollEvent
: public wxCommandEvent
949 wxScrollEvent(wxEventType commandType
= wxEVT_NULL
,
950 int winid
= 0, int pos
= 0, int orient
= 0);
952 int GetOrientation() const { return (int) m_extraLong
; }
953 int GetPosition() const { return m_commandInt
; }
954 void SetOrientation(int orient
) { m_extraLong
= (long) orient
; }
955 void SetPosition(int pos
) { m_commandInt
= pos
; }
957 virtual wxEvent
*Clone() const { return new wxScrollEvent(*this); }
960 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollEvent
)
963 // ScrollWin event class, derived fom wxEvent. wxScrollWinEvents
964 // are sent by wxWindow.
967 wxEVT_SCROLLWIN_BOTTOM
968 wxEVT_SCROLLWIN_LINEUP
969 wxEVT_SCROLLWIN_LINEDOWN
970 wxEVT_SCROLLWIN_PAGEUP
971 wxEVT_SCROLLWIN_PAGEDOWN
972 wxEVT_SCROLLWIN_THUMBTRACK
973 wxEVT_SCROLLWIN_THUMBRELEASE
976 class WXDLLIMPEXP_CORE wxScrollWinEvent
: public wxEvent
979 wxScrollWinEvent(wxEventType commandType
= wxEVT_NULL
,
980 int pos
= 0, int orient
= 0);
981 wxScrollWinEvent(const wxScrollWinEvent
& event
) : wxEvent(event
)
982 { m_commandInt
= event
.m_commandInt
;
983 m_extraLong
= event
.m_extraLong
; }
985 int GetOrientation() const { return (int) m_extraLong
; }
986 int GetPosition() const { return m_commandInt
; }
987 void SetOrientation(int orient
) { m_extraLong
= (long) orient
; }
988 void SetPosition(int pos
) { m_commandInt
= pos
; }
990 virtual wxEvent
*Clone() const { return new wxScrollWinEvent(*this); }
997 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollWinEvent
)
1000 // Mouse event class
1017 wxEVT_NC_MIDDLE_DOWN,
1019 wxEVT_NC_RIGHT_DOWN,
1022 wxEVT_NC_ENTER_WINDOW,
1023 wxEVT_NC_LEAVE_WINDOW,
1024 wxEVT_NC_LEFT_DCLICK,
1025 wxEVT_NC_MIDDLE_DCLICK,
1026 wxEVT_NC_RIGHT_DCLICK,
1029 // the symbolic names for the mouse buttons
1032 wxMOUSE_BTN_ANY
= -1,
1033 wxMOUSE_BTN_NONE
= 0,
1034 wxMOUSE_BTN_LEFT
= 1,
1035 wxMOUSE_BTN_MIDDLE
= 2,
1036 wxMOUSE_BTN_RIGHT
= 3,
1037 wxMOUSE_BTN_AUX1
= 4,
1038 wxMOUSE_BTN_AUX2
= 5,
1042 class WXDLLIMPEXP_CORE wxMouseEvent
: public wxEvent
,
1046 wxMouseEvent(wxEventType mouseType
= wxEVT_NULL
);
1047 wxMouseEvent(const wxMouseEvent
& event
)
1054 // Was it a button event? (*doesn't* mean: is any button *down*?)
1055 bool IsButton() const { return Button(wxMOUSE_BTN_ANY
); }
1057 // Was it a down event from this (or any) button?
1058 bool ButtonDown(int but
= wxMOUSE_BTN_ANY
) const;
1060 // Was it a dclick event from this (or any) button?
1061 bool ButtonDClick(int but
= wxMOUSE_BTN_ANY
) const;
1063 // Was it a up event from this (or any) button?
1064 bool ButtonUp(int but
= wxMOUSE_BTN_ANY
) const;
1066 // Was the given button?
1067 bool Button(int but
) const;
1069 // Was the given button in Down state?
1070 bool ButtonIsDown(int but
) const;
1072 // Get the button which is changing state (wxMOUSE_BTN_NONE if none)
1073 int GetButton() const;
1075 // Find which event was just generated
1076 bool LeftDown() const { return (m_eventType
== wxEVT_LEFT_DOWN
); }
1077 bool MiddleDown() const { return (m_eventType
== wxEVT_MIDDLE_DOWN
); }
1078 bool RightDown() const { return (m_eventType
== wxEVT_RIGHT_DOWN
); }
1079 bool Aux1Down() const { return (m_eventType
== wxEVT_AUX1_DOWN
); }
1080 bool Aux2Down() const { return (m_eventType
== wxEVT_AUX2_DOWN
); }
1082 bool LeftUp() const { return (m_eventType
== wxEVT_LEFT_UP
); }
1083 bool MiddleUp() const { return (m_eventType
== wxEVT_MIDDLE_UP
); }
1084 bool RightUp() const { return (m_eventType
== wxEVT_RIGHT_UP
); }
1085 bool Aux1Up() const { return (m_eventType
== wxEVT_AUX1_UP
); }
1086 bool Aux2Up() const { return (m_eventType
== wxEVT_AUX2_UP
); }
1088 bool LeftDClick() const { return (m_eventType
== wxEVT_LEFT_DCLICK
); }
1089 bool MiddleDClick() const { return (m_eventType
== wxEVT_MIDDLE_DCLICK
); }
1090 bool RightDClick() const { return (m_eventType
== wxEVT_RIGHT_DCLICK
); }
1091 bool Aux1DClick() const { return (m_eventType
== wxEVT_AUX1_UP
); }
1092 bool Aux2DClick() const { return (m_eventType
== wxEVT_AUX2_UP
); }
1094 // Find the current state of the mouse buttons (regardless
1095 // of current event type)
1096 bool LeftIsDown() const { return m_leftDown
; }
1097 bool MiddleIsDown() const { return m_middleDown
; }
1098 bool RightIsDown() const { return m_rightDown
; }
1099 bool Aux1IsDown() const { return m_aux1Down
; }
1100 bool Aux2IsDown() const { return m_aux2Down
; }
1102 // True if a button is down and the mouse is moving
1103 bool Dragging() const
1105 return (m_eventType
== wxEVT_MOTION
) && ButtonIsDown(wxMOUSE_BTN_ANY
);
1108 // True if the mouse is moving, and no button is down
1111 return (m_eventType
== wxEVT_MOTION
) && !ButtonIsDown(wxMOUSE_BTN_ANY
);
1114 // True if the mouse is just entering the window
1115 bool Entering() const { return (m_eventType
== wxEVT_ENTER_WINDOW
); }
1117 // True if the mouse is just leaving the window
1118 bool Leaving() const { return (m_eventType
== wxEVT_LEAVE_WINDOW
); }
1120 // Returns the number of mouse clicks associated with this event.
1121 int GetClickCount() const { return m_clickCount
; }
1124 // Find the position of the event
1125 void GetPosition(wxCoord
*xpos
, wxCoord
*ypos
) const
1133 void GetPosition(long *xpos
, long *ypos
) const
1141 // Find the position of the event
1142 wxPoint
GetPosition() const { return wxPoint(m_x
, m_y
); }
1144 // Find the logical position of the event given the DC
1145 wxPoint
GetLogicalPosition(const wxDC
& dc
) const;
1148 wxCoord
GetX() const { return m_x
; }
1151 wxCoord
GetY() const { return m_y
; }
1153 // Get wheel rotation, positive or negative indicates direction of
1154 // rotation. Current devices all send an event when rotation is equal to
1155 // +/-WheelDelta, but this allows for finer resolution devices to be
1156 // created in the future. Because of this you shouldn't assume that one
1157 // event is equal to 1 line or whatever, but you should be able to either
1158 // do partial line scrolling or wait until +/-WheelDelta rotation values
1159 // have been accumulated before scrolling.
1160 int GetWheelRotation() const { return m_wheelRotation
; }
1162 // Get wheel delta, normally 120. This is the threshold for action to be
1163 // taken, and one such action (for example, scrolling one increment)
1164 // should occur for each delta.
1165 int GetWheelDelta() const { return m_wheelDelta
; }
1167 // Gets the axis the wheel operation concerns, 0 being the y axis as on
1168 // most mouse wheels, 1 is the x axis for things like MightyMouse scrolls
1169 // or horizontal trackpad scrolling
1170 int GetWheelAxis() const { return m_wheelAxis
; }
1172 // Returns the configured number of lines (or whatever) to be scrolled per
1173 // wheel action. Defaults to one.
1174 int GetLinesPerAction() const { return m_linesPerAction
; }
1176 // Is the system set to do page scrolling?
1177 bool IsPageScroll() const { return ((unsigned int)m_linesPerAction
== UINT_MAX
); }
1179 virtual wxEvent
*Clone() const { return new wxMouseEvent(*this); }
1181 wxMouseEvent
& operator=(const wxMouseEvent
& event
)
1200 int m_wheelRotation
;
1202 int m_linesPerAction
;
1205 void Assign(const wxMouseEvent
& evt
);
1208 DECLARE_DYNAMIC_CLASS(wxMouseEvent
)
1217 class WXDLLIMPEXP_CORE wxSetCursorEvent
: public wxEvent
1220 wxSetCursorEvent(wxCoord x
= 0, wxCoord y
= 0)
1221 : wxEvent(0, wxEVT_SET_CURSOR
),
1222 m_x(x
), m_y(y
), m_cursor()
1225 wxSetCursorEvent(const wxSetCursorEvent
& event
)
1229 m_cursor(event
.m_cursor
)
1232 wxCoord
GetX() const { return m_x
; }
1233 wxCoord
GetY() const { return m_y
; }
1235 void SetCursor(const wxCursor
& cursor
) { m_cursor
= cursor
; }
1236 const wxCursor
& GetCursor() const { return m_cursor
; }
1237 bool HasCursor() const { return m_cursor
.Ok(); }
1239 virtual wxEvent
*Clone() const { return new wxSetCursorEvent(*this); }
1246 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSetCursorEvent
)
1249 // Keyboard input event class
1259 class WXDLLIMPEXP_CORE wxKeyEvent
: public wxEvent
,
1260 public wxKeyboardState
1263 wxKeyEvent(wxEventType keyType
= wxEVT_NULL
);
1264 wxKeyEvent(const wxKeyEvent
& evt
);
1266 // get the key code: an ASCII7 char or an element of wxKeyCode enum
1267 int GetKeyCode() const { return (int)m_keyCode
; }
1270 // get the Unicode character corresponding to this key
1271 wxChar
GetUnicodeKey() const { return m_uniChar
; }
1272 #endif // wxUSE_UNICODE
1274 // get the raw key code (platform-dependent)
1275 wxUint32
GetRawKeyCode() const { return m_rawCode
; }
1277 // get the raw key flags (platform-dependent)
1278 wxUint32
GetRawKeyFlags() const { return m_rawFlags
; }
1280 // Find the position of the event
1281 void GetPosition(wxCoord
*xpos
, wxCoord
*ypos
) const
1283 if (xpos
) *xpos
= m_x
;
1284 if (ypos
) *ypos
= m_y
;
1287 void GetPosition(long *xpos
, long *ypos
) const
1289 if (xpos
) *xpos
= (long)m_x
;
1290 if (ypos
) *ypos
= (long)m_y
;
1293 wxPoint
GetPosition() const
1294 { return wxPoint(m_x
, m_y
); }
1297 wxCoord
GetX() const { return m_x
; }
1300 wxCoord
GetY() const { return m_y
; }
1302 virtual wxEvent
*Clone() const { return new wxKeyEvent(*this); }
1304 // we do need to copy wxKeyEvent sometimes (in wxTreeCtrl code, for
1306 wxKeyEvent
& operator=(const wxKeyEvent
& evt
)
1310 wxEvent
::operator=(evt
);
1312 // Borland C++ 5.82 doesn't compile an explicit call to an
1313 // implicitly defined operator=() so need to do it this way:
1314 *static_cast<wxKeyboardState
*>(this) = evt
;
1319 m_keyCode
= evt
.m_keyCode
;
1321 m_scanCode
= evt
.m_scanCode
;
1322 m_rawCode
= evt
.m_rawCode
;
1323 m_rawFlags
= evt
.m_rawFlags
;
1325 m_uniChar
= evt
.m_uniChar
;
1336 // FIXME: what is this for? relation to m_rawXXX?
1340 // This contains the full Unicode character
1341 // in a character events in Unicode mode
1345 // these fields contain the platform-specific information about
1346 // key that was pressed
1348 wxUint32 m_rawFlags
;
1351 DECLARE_DYNAMIC_CLASS(wxKeyEvent
)
1359 class WXDLLIMPEXP_CORE wxSizeEvent
: public wxEvent
1362 wxSizeEvent() : wxEvent(0, wxEVT_SIZE
)
1364 wxSizeEvent(const wxSize
& sz
, int winid
= 0)
1365 : wxEvent(winid
, wxEVT_SIZE
),
1368 wxSizeEvent(const wxSizeEvent
& event
)
1370 m_size(event
.m_size
), m_rect(event
.m_rect
)
1372 wxSizeEvent(const wxRect
& rect
, int id
= 0)
1373 : m_size(rect
.GetSize()), m_rect(rect
)
1374 { m_eventType
= wxEVT_SIZING
; m_id
= id
; }
1376 wxSize
GetSize() const { return m_size
; }
1377 wxRect
GetRect() const { return m_rect
; }
1378 void SetRect(const wxRect
& rect
) { m_rect
= rect
; }
1380 virtual wxEvent
*Clone() const { return new wxSizeEvent(*this); }
1383 // For internal usage only. Will be converted to protected members.
1385 wxRect m_rect
; // Used for wxEVT_SIZING
1388 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSizeEvent
)
1397 class WXDLLIMPEXP_CORE wxMoveEvent
: public wxEvent
1401 : wxEvent(0, wxEVT_MOVE
)
1403 wxMoveEvent(const wxPoint
& pos
, int winid
= 0)
1404 : wxEvent(winid
, wxEVT_MOVE
),
1407 wxMoveEvent(const wxMoveEvent
& event
)
1411 wxMoveEvent(const wxRect
& rect
, int id
= 0)
1412 : m_pos(rect
.GetPosition()), m_rect(rect
)
1413 { m_eventType
= wxEVT_MOVING
; m_id
= id
; }
1415 wxPoint
GetPosition() const { return m_pos
; }
1416 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
1417 wxRect
GetRect() const { return m_rect
; }
1418 void SetRect(const wxRect
& rect
) { m_rect
= rect
; }
1420 virtual wxEvent
*Clone() const { return new wxMoveEvent(*this); }
1427 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMoveEvent
)
1430 // Paint event class
1437 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1438 // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined
1439 extern WXDLLIMPEXP_CORE
int g_isPainting
;
1442 class WXDLLIMPEXP_CORE wxPaintEvent
: public wxEvent
1445 wxPaintEvent(int Id
= 0)
1446 : wxEvent(Id
, wxEVT_PAINT
)
1448 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1449 // set the internal flag for the duration of processing of WM_PAINT
1454 // default copy ctor and dtor are normally fine, we only need them to keep
1455 // g_isPainting updated in debug build
1456 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1457 wxPaintEvent(const wxPaintEvent
& event
)
1463 virtual ~wxPaintEvent()
1469 virtual wxEvent
*Clone() const { return new wxPaintEvent(*this); }
1472 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaintEvent
)
1475 class WXDLLIMPEXP_CORE wxNcPaintEvent
: public wxEvent
1478 wxNcPaintEvent(int winid
= 0)
1479 : wxEvent(winid
, wxEVT_NC_PAINT
)
1482 virtual wxEvent
*Clone() const { return new wxNcPaintEvent(*this); }
1485 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNcPaintEvent
)
1488 // Erase background event class
1490 wxEVT_ERASE_BACKGROUND
1493 class WXDLLIMPEXP_CORE wxEraseEvent
: public wxEvent
1496 wxEraseEvent(int Id
= 0, wxDC
*dc
= NULL
)
1497 : wxEvent(Id
, wxEVT_ERASE_BACKGROUND
),
1501 wxEraseEvent(const wxEraseEvent
& event
)
1506 wxDC
*GetDC() const { return m_dc
; }
1508 virtual wxEvent
*Clone() const { return new wxEraseEvent(*this); }
1514 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxEraseEvent
)
1517 // Focus event class
1523 class WXDLLIMPEXP_CORE wxFocusEvent
: public wxEvent
1526 wxFocusEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0)
1527 : wxEvent(winid
, type
)
1530 wxFocusEvent(const wxFocusEvent
& event
)
1532 { m_win
= event
.m_win
; }
1534 // The window associated with this event is the window which had focus
1535 // before for SET event and the window which will have focus for the KILL
1536 // one. NB: it may be NULL in both cases!
1537 wxWindow
*GetWindow() const { return m_win
; }
1538 void SetWindow(wxWindow
*win
) { m_win
= win
; }
1540 virtual wxEvent
*Clone() const { return new wxFocusEvent(*this); }
1546 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFocusEvent
)
1549 // wxChildFocusEvent notifies the parent that a child has got the focus: unlike
1550 // wxFocusEvent it is propagated upwards the window chain
1551 class WXDLLIMPEXP_CORE wxChildFocusEvent
: public wxCommandEvent
1554 wxChildFocusEvent(wxWindow
*win
= NULL
);
1556 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
1558 virtual wxEvent
*Clone() const { return new wxChildFocusEvent(*this); }
1561 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxChildFocusEvent
)
1564 // Activate event class
1571 class WXDLLIMPEXP_CORE wxActivateEvent
: public wxEvent
1574 wxActivateEvent(wxEventType type
= wxEVT_NULL
, bool active
= true, int Id
= 0)
1576 { m_active
= active
; }
1577 wxActivateEvent(const wxActivateEvent
& event
)
1579 { m_active
= event
.m_active
; }
1581 bool GetActive() const { return m_active
; }
1583 virtual wxEvent
*Clone() const { return new wxActivateEvent(*this); }
1589 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxActivateEvent
)
1592 // InitDialog event class
1597 class WXDLLIMPEXP_CORE wxInitDialogEvent
: public wxEvent
1600 wxInitDialogEvent(int Id
= 0)
1601 : wxEvent(Id
, wxEVT_INIT_DIALOG
)
1604 virtual wxEvent
*Clone() const { return new wxInitDialogEvent(*this); }
1607 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxInitDialogEvent
)
1610 // Miscellaneous menu event class
1614 wxEVT_MENU_HIGHLIGHT,
1617 class WXDLLIMPEXP_CORE wxMenuEvent
: public wxEvent
1620 wxMenuEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0, wxMenu
* menu
= NULL
)
1621 : wxEvent(winid
, type
)
1622 { m_menuId
= winid
; m_menu
= menu
; }
1623 wxMenuEvent(const wxMenuEvent
& event
)
1625 { m_menuId
= event
.m_menuId
; m_menu
= event
.m_menu
; }
1627 // only for wxEVT_MENU_HIGHLIGHT
1628 int GetMenuId() const { return m_menuId
; }
1630 // only for wxEVT_MENU_OPEN/CLOSE
1631 bool IsPopup() const { return m_menuId
== wxID_ANY
; }
1633 // only for wxEVT_MENU_OPEN/CLOSE
1634 wxMenu
* GetMenu() const { return m_menu
; }
1636 virtual wxEvent
*Clone() const { return new wxMenuEvent(*this); }
1642 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMenuEvent
)
1645 // Window close or session close event class
1649 wxEVT_QUERY_END_SESSION
1652 class WXDLLIMPEXP_CORE wxCloseEvent
: public wxEvent
1655 wxCloseEvent(wxEventType type
= wxEVT_NULL
, int winid
= 0)
1656 : wxEvent(winid
, type
),
1658 m_veto(false), // should be false by default
1661 wxCloseEvent(const wxCloseEvent
& event
)
1663 m_loggingOff(event
.m_loggingOff
),
1664 m_veto(event
.m_veto
),
1665 m_canVeto(event
.m_canVeto
) {}
1667 void SetLoggingOff(bool logOff
) { m_loggingOff
= logOff
; }
1668 bool GetLoggingOff() const
1670 // m_loggingOff flag is only used by wxEVT_[QUERY_]END_SESSION, it
1671 // doesn't make sense for wxEVT_CLOSE_WINDOW
1672 wxASSERT_MSG( m_eventType
!= wxEVT_CLOSE_WINDOW
,
1673 _T("this flag is for end session events only") );
1675 return m_loggingOff
;
1678 void Veto(bool veto
= true)
1680 // GetVeto() will return false anyhow...
1681 wxCHECK_RET( m_canVeto
,
1682 wxT("call to Veto() ignored (can't veto this event)") );
1686 void SetCanVeto(bool canVeto
) { m_canVeto
= canVeto
; }
1687 bool CanVeto() const { return m_canVeto
; }
1688 bool GetVeto() const { return m_canVeto
&& m_veto
; }
1690 virtual wxEvent
*Clone() const { return new wxCloseEvent(*this); }
1698 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCloseEvent
)
1705 class WXDLLIMPEXP_CORE wxShowEvent
: public wxEvent
1708 wxShowEvent(int winid
= 0, bool show
= false)
1709 : wxEvent(winid
, wxEVT_SHOW
)
1711 wxShowEvent(const wxShowEvent
& event
)
1713 { m_show
= event
.m_show
; }
1715 void SetShow(bool show
) { m_show
= show
; }
1717 // return true if the window was shown, false if hidden
1718 bool IsShown() const { return m_show
; }
1720 #if WXWIN_COMPATIBILITY_2_8
1721 wxDEPRECATED( bool GetShow() const { return IsShown(); } )
1724 virtual wxEvent
*Clone() const { return new wxShowEvent(*this); }
1730 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxShowEvent
)
1737 class WXDLLIMPEXP_CORE wxIconizeEvent
: public wxEvent
1740 wxIconizeEvent(int winid
= 0, bool iconized
= true)
1741 : wxEvent(winid
, wxEVT_ICONIZE
)
1742 { m_iconized
= iconized
; }
1743 wxIconizeEvent(const wxIconizeEvent
& event
)
1745 { m_iconized
= event
.m_iconized
; }
1747 #if WXWIN_COMPATIBILITY_2_8
1748 wxDEPRECATED( bool Iconized() const { return IsIconized(); } )
1750 // return true if the frame was iconized, false if restored
1751 bool IsIconized() const { return m_iconized
; }
1753 virtual wxEvent
*Clone() const { return new wxIconizeEvent(*this); }
1759 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIconizeEvent
)
1765 class WXDLLIMPEXP_CORE wxMaximizeEvent
: public wxEvent
1768 wxMaximizeEvent(int winid
= 0)
1769 : wxEvent(winid
, wxEVT_MAXIMIZE
)
1772 virtual wxEvent
*Clone() const { return new wxMaximizeEvent(*this); }
1775 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMaximizeEvent
)
1778 // Joystick event class
1780 wxEVT_JOY_BUTTON_DOWN,
1781 wxEVT_JOY_BUTTON_UP,
1786 // Which joystick? Same as Windows ids so no conversion necessary.
1793 // Which button is down?
1796 wxJOY_BUTTON_ANY
= -1,
1803 class WXDLLIMPEXP_CORE wxJoystickEvent
: public wxEvent
1808 int m_buttonChange
; // Which button changed?
1809 int m_buttonState
; // Which buttons are down?
1810 int m_joyStick
; // Which joystick?
1813 wxJoystickEvent(wxEventType type
= wxEVT_NULL
,
1815 int joystick
= wxJOYSTICK1
,
1820 m_buttonChange(change
),
1821 m_buttonState(state
),
1822 m_joyStick(joystick
)
1825 wxJoystickEvent(const wxJoystickEvent
& event
)
1828 m_zPosition(event
.m_zPosition
),
1829 m_buttonChange(event
.m_buttonChange
),
1830 m_buttonState(event
.m_buttonState
),
1831 m_joyStick(event
.m_joyStick
)
1834 wxPoint
GetPosition() const { return m_pos
; }
1835 int GetZPosition() const { return m_zPosition
; }
1836 int GetButtonState() const { return m_buttonState
; }
1837 int GetButtonChange() const { return m_buttonChange
; }
1838 int GetJoystick() const { return m_joyStick
; }
1840 void SetJoystick(int stick
) { m_joyStick
= stick
; }
1841 void SetButtonState(int state
) { m_buttonState
= state
; }
1842 void SetButtonChange(int change
) { m_buttonChange
= change
; }
1843 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
1844 void SetZPosition(int zPos
) { m_zPosition
= zPos
; }
1846 // Was it a button event? (*doesn't* mean: is any button *down*?)
1847 bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN
) ||
1848 (GetEventType() == wxEVT_JOY_BUTTON_UP
)); }
1850 // Was it a move event?
1851 bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE
); }
1853 // Was it a zmove event?
1854 bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE
); }
1856 // Was it a down event from button 1, 2, 3, 4 or any?
1857 bool ButtonDown(int but
= wxJOY_BUTTON_ANY
) const
1858 { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN
) &&
1859 ((but
== wxJOY_BUTTON_ANY
) || (but
== m_buttonChange
))); }
1861 // Was it a up event from button 1, 2, 3 or any?
1862 bool ButtonUp(int but
= wxJOY_BUTTON_ANY
) const
1863 { return ((GetEventType() == wxEVT_JOY_BUTTON_UP
) &&
1864 ((but
== wxJOY_BUTTON_ANY
) || (but
== m_buttonChange
))); }
1866 // Was the given button 1,2,3,4 or any in Down state?
1867 bool ButtonIsDown(int but
= wxJOY_BUTTON_ANY
) const
1868 { return (((but
== wxJOY_BUTTON_ANY
) && (m_buttonState
!= 0)) ||
1869 ((m_buttonState
& but
) == but
)); }
1871 virtual wxEvent
*Clone() const { return new wxJoystickEvent(*this); }
1874 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxJoystickEvent
)
1877 // Drop files event class
1882 class WXDLLIMPEXP_CORE wxDropFilesEvent
: public wxEvent
1889 wxDropFilesEvent(wxEventType type
= wxEVT_NULL
,
1891 wxString
*files
= NULL
)
1898 // we need a copy ctor to avoid deleting m_files pointer twice
1899 wxDropFilesEvent(const wxDropFilesEvent
& other
)
1901 m_noFiles(other
.m_noFiles
),
1905 m_files
= new wxString
[m_noFiles
];
1906 for ( int n
= 0; n
< m_noFiles
; n
++ )
1908 m_files
[n
] = other
.m_files
[n
];
1912 virtual ~wxDropFilesEvent()
1917 wxPoint
GetPosition() const { return m_pos
; }
1918 int GetNumberOfFiles() const { return m_noFiles
; }
1919 wxString
*GetFiles() const { return m_files
; }
1921 virtual wxEvent
*Clone() const { return new wxDropFilesEvent(*this); }
1924 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDropFilesEvent
)
1932 // Whether to always send update events to windows, or
1933 // to only send update events to those with the
1934 // wxWS_EX_PROCESS_UI_UPDATES style.
1938 // Send UI update events to all windows
1939 wxUPDATE_UI_PROCESS_ALL
,
1941 // Send UI update events to windows that have
1942 // the wxWS_EX_PROCESS_UI_UPDATES flag specified
1943 wxUPDATE_UI_PROCESS_SPECIFIED
1946 class WXDLLIMPEXP_CORE wxUpdateUIEvent
: public wxCommandEvent
1949 wxUpdateUIEvent(wxWindowID commandId
= 0)
1950 : wxCommandEvent(wxEVT_UPDATE_UI
, commandId
)
1958 m_setChecked
= false;
1960 wxUpdateUIEvent(const wxUpdateUIEvent
& event
)
1961 : wxCommandEvent(event
),
1962 m_checked(event
.m_checked
),
1963 m_enabled(event
.m_enabled
),
1964 m_shown(event
.m_shown
),
1965 m_setEnabled(event
.m_setEnabled
),
1966 m_setShown(event
.m_setShown
),
1967 m_setText(event
.m_setText
),
1968 m_setChecked(event
.m_setChecked
),
1969 m_text(event
.m_text
)
1972 bool GetChecked() const { return m_checked
; }
1973 bool GetEnabled() const { return m_enabled
; }
1974 bool GetShown() const { return m_shown
; }
1975 wxString
GetText() const { return m_text
; }
1976 bool GetSetText() const { return m_setText
; }
1977 bool GetSetChecked() const { return m_setChecked
; }
1978 bool GetSetEnabled() const { return m_setEnabled
; }
1979 bool GetSetShown() const { return m_setShown
; }
1981 void Check(bool check
) { m_checked
= check
; m_setChecked
= true; }
1982 void Enable(bool enable
) { m_enabled
= enable
; m_setEnabled
= true; }
1983 void Show(bool show
) { m_shown
= show
; m_setShown
= true; }
1984 void SetText(const wxString
& text
) { m_text
= text
; m_setText
= true; }
1986 // Sets the interval between updates in milliseconds.
1987 // Set to -1 to disable updates, or to 0 to update as frequently as possible.
1988 static void SetUpdateInterval(long updateInterval
) { sm_updateInterval
= updateInterval
; }
1990 // Returns the current interval between updates in milliseconds
1991 static long GetUpdateInterval() { return sm_updateInterval
; }
1993 // Can we update this window?
1994 static bool CanUpdate(wxWindowBase
*win
);
1996 // Reset the update time to provide a delay until the next
1997 // time we should update
1998 static void ResetUpdateTime();
2000 // Specify how wxWidgets will send update events: to
2001 // all windows, or only to those which specify that they
2002 // will process the events.
2003 static void SetMode(wxUpdateUIMode mode
) { sm_updateMode
= mode
; }
2005 // Returns the UI update mode
2006 static wxUpdateUIMode
GetMode() { return sm_updateMode
; }
2008 virtual wxEvent
*Clone() const { return new wxUpdateUIEvent(*this); }
2020 static wxLongLong sm_lastUpdate
;
2022 static long sm_updateInterval
;
2023 static wxUpdateUIMode sm_updateMode
;
2026 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxUpdateUIEvent
)
2030 wxEVT_SYS_COLOUR_CHANGED
2033 // TODO: shouldn't all events record the window ID?
2034 class WXDLLIMPEXP_CORE wxSysColourChangedEvent
: public wxEvent
2037 wxSysColourChangedEvent()
2038 : wxEvent(0, wxEVT_SYS_COLOUR_CHANGED
)
2041 virtual wxEvent
*Clone() const { return new wxSysColourChangedEvent(*this); }
2044 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSysColourChangedEvent
)
2048 wxEVT_MOUSE_CAPTURE_CHANGED
2049 The window losing the capture receives this message
2050 (even if it released the capture itself).
2053 class WXDLLIMPEXP_CORE wxMouseCaptureChangedEvent
: public wxEvent
2056 wxMouseCaptureChangedEvent(wxWindowID winid
= 0, wxWindow
* gainedCapture
= NULL
)
2057 : wxEvent(winid
, wxEVT_MOUSE_CAPTURE_CHANGED
),
2058 m_gainedCapture(gainedCapture
)
2061 wxMouseCaptureChangedEvent(const wxMouseCaptureChangedEvent
& event
)
2063 m_gainedCapture(event
.m_gainedCapture
)
2066 virtual wxEvent
*Clone() const { return new wxMouseCaptureChangedEvent(*this); }
2068 wxWindow
* GetCapturedWindow() const { return m_gainedCapture
; }
2071 wxWindow
* m_gainedCapture
;
2073 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureChangedEvent
)
2077 wxEVT_MOUSE_CAPTURE_LOST
2078 The window losing the capture receives this message, unless it released it
2079 it itself or unless wxWindow::CaptureMouse was called on another window
2080 (and so capture will be restored when the new capturer releases it).
2083 class WXDLLIMPEXP_CORE wxMouseCaptureLostEvent
: public wxEvent
2086 wxMouseCaptureLostEvent(wxWindowID winid
= 0)
2087 : wxEvent(winid
, wxEVT_MOUSE_CAPTURE_LOST
)
2090 wxMouseCaptureLostEvent(const wxMouseCaptureLostEvent
& event
)
2094 virtual wxEvent
*Clone() const { return new wxMouseCaptureLostEvent(*this); }
2096 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureLostEvent
)
2100 wxEVT_DISPLAY_CHANGED
2102 class WXDLLIMPEXP_CORE wxDisplayChangedEvent
: public wxEvent
2105 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDisplayChangedEvent
)
2108 wxDisplayChangedEvent()
2109 : wxEvent(0, wxEVT_DISPLAY_CHANGED
)
2112 virtual wxEvent
*Clone() const { return new wxDisplayChangedEvent(*this); }
2116 wxEVT_PALETTE_CHANGED
2119 class WXDLLIMPEXP_CORE wxPaletteChangedEvent
: public wxEvent
2122 wxPaletteChangedEvent(wxWindowID winid
= 0)
2123 : wxEvent(winid
, wxEVT_PALETTE_CHANGED
),
2124 m_changedWindow(NULL
)
2127 wxPaletteChangedEvent(const wxPaletteChangedEvent
& event
)
2129 m_changedWindow(event
.m_changedWindow
)
2132 void SetChangedWindow(wxWindow
* win
) { m_changedWindow
= win
; }
2133 wxWindow
* GetChangedWindow() const { return m_changedWindow
; }
2135 virtual wxEvent
*Clone() const { return new wxPaletteChangedEvent(*this); }
2138 wxWindow
* m_changedWindow
;
2141 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaletteChangedEvent
)
2145 wxEVT_QUERY_NEW_PALETTE
2146 Indicates the window is getting keyboard focus and should re-do its palette.
2149 class WXDLLIMPEXP_CORE wxQueryNewPaletteEvent
: public wxEvent
2152 wxQueryNewPaletteEvent(wxWindowID winid
= 0)
2153 : wxEvent(winid
, wxEVT_QUERY_NEW_PALETTE
),
2154 m_paletteRealized(false)
2156 wxQueryNewPaletteEvent(const wxQueryNewPaletteEvent
& event
)
2158 m_paletteRealized(event
.m_paletteRealized
)
2161 // App sets this if it changes the palette.
2162 void SetPaletteRealized(bool realized
) { m_paletteRealized
= realized
; }
2163 bool GetPaletteRealized() const { return m_paletteRealized
; }
2165 virtual wxEvent
*Clone() const { return new wxQueryNewPaletteEvent(*this); }
2168 bool m_paletteRealized
;
2171 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxQueryNewPaletteEvent
)
2175 Event generated by dialog navigation keys
2176 wxEVT_NAVIGATION_KEY
2178 // NB: don't derive from command event to avoid being propagated to the parent
2179 class WXDLLIMPEXP_CORE wxNavigationKeyEvent
: public wxEvent
2182 wxNavigationKeyEvent()
2183 : wxEvent(0, wxEVT_NAVIGATION_KEY
),
2184 m_flags(IsForward
| FromTab
), // defaults are for TAB
2187 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
2190 wxNavigationKeyEvent(const wxNavigationKeyEvent
& event
)
2192 m_flags(event
.m_flags
),
2193 m_focus(event
.m_focus
)
2196 // direction: forward (true) or backward (false)
2197 bool GetDirection() const
2198 { return (m_flags
& IsForward
) != 0; }
2199 void SetDirection(bool bForward
)
2200 { if ( bForward
) m_flags
|= IsForward
; else m_flags
&= ~IsForward
; }
2202 // it may be a window change event (MDI, notebook pages...) or a control
2204 bool IsWindowChange() const
2205 { return (m_flags
& WinChange
) != 0; }
2206 void SetWindowChange(bool bIs
)
2207 { if ( bIs
) m_flags
|= WinChange
; else m_flags
&= ~WinChange
; }
2209 // Set to true under MSW if the event was generated using the tab key.
2210 // This is required for proper navogation over radio buttons
2211 bool IsFromTab() const
2212 { return (m_flags
& FromTab
) != 0; }
2213 void SetFromTab(bool bIs
)
2214 { if ( bIs
) m_flags
|= FromTab
; else m_flags
&= ~FromTab
; }
2216 // the child which has the focus currently (may be NULL - use
2217 // wxWindow::FindFocus then)
2218 wxWindow
* GetCurrentFocus() const { return m_focus
; }
2219 void SetCurrentFocus(wxWindow
*win
) { m_focus
= win
; }
2222 void SetFlags(long flags
) { m_flags
= flags
; }
2224 virtual wxEvent
*Clone() const { return new wxNavigationKeyEvent(*this); }
2228 IsBackward
= 0x0000,
2238 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNavigationKeyEvent
)
2241 // Window creation/destruction events: the first is sent as soon as window is
2242 // created (i.e. the underlying GUI object exists), but when the C++ object is
2243 // fully initialized (so virtual functions may be called). The second,
2244 // wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
2245 // still safe to call virtual functions at this moment
2251 class WXDLLIMPEXP_CORE wxWindowCreateEvent
: public wxCommandEvent
2254 wxWindowCreateEvent(wxWindow
*win
= NULL
);
2256 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
2258 virtual wxEvent
*Clone() const { return new wxWindowCreateEvent(*this); }
2261 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowCreateEvent
)
2264 class WXDLLIMPEXP_CORE wxWindowDestroyEvent
: public wxCommandEvent
2267 wxWindowDestroyEvent(wxWindow
*win
= NULL
);
2269 wxWindow
*GetWindow() const { return (wxWindow
*)GetEventObject(); }
2271 virtual wxEvent
*Clone() const { return new wxWindowDestroyEvent(*this); }
2274 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowDestroyEvent
)
2277 // A help event is sent when the user clicks on a window in context-help mode.
2283 class WXDLLIMPEXP_CORE wxHelpEvent
: public wxCommandEvent
2286 // how was this help event generated?
2289 Origin_Unknown
, // unrecognized event source
2290 Origin_Keyboard
, // event generated from F1 key press
2291 Origin_HelpButton
// event from [?] button on the title bar (Windows)
2294 wxHelpEvent(wxEventType type
= wxEVT_NULL
,
2295 wxWindowID winid
= 0,
2296 const wxPoint
& pt
= wxDefaultPosition
,
2297 Origin origin
= Origin_Unknown
)
2298 : wxCommandEvent(type
, winid
),
2300 m_origin(GuessOrigin(origin
))
2302 wxHelpEvent(const wxHelpEvent
& event
)
2303 : wxCommandEvent(event
),
2305 m_target(event
.m_target
),
2306 m_link(event
.m_link
),
2307 m_origin(event
.m_origin
)
2310 // Position of event (in screen coordinates)
2311 const wxPoint
& GetPosition() const { return m_pos
; }
2312 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2314 // Optional link to further help
2315 const wxString
& GetLink() const { return m_link
; }
2316 void SetLink(const wxString
& link
) { m_link
= link
; }
2318 // Optional target to display help in. E.g. a window specification
2319 const wxString
& GetTarget() const { return m_target
; }
2320 void SetTarget(const wxString
& target
) { m_target
= target
; }
2322 virtual wxEvent
*Clone() const { return new wxHelpEvent(*this); }
2324 // optional indication of the event source
2325 Origin
GetOrigin() const { return m_origin
; }
2326 void SetOrigin(Origin origin
) { m_origin
= origin
; }
2334 // we can try to guess the event origin ourselves, even if none is
2335 // specified in the ctor
2336 static Origin
GuessOrigin(Origin origin
);
2339 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHelpEvent
)
2342 // A Clipboard Text event is sent when a window intercepts text copy/cut/paste
2343 // message, i.e. the user has cut/copied/pasted data from/into a text control
2344 // via ctrl-C/X/V, ctrl/shift-del/insert, a popup menu command, etc.
2345 // NOTE : under windows these events are *NOT* generated automatically
2346 // for a Rich Edit text control.
2348 wxEVT_COMMAND_TEXT_COPY
2349 wxEVT_COMMAND_TEXT_CUT
2350 wxEVT_COMMAND_TEXT_PASTE
2353 class WXDLLIMPEXP_CORE wxClipboardTextEvent
: public wxCommandEvent
2356 wxClipboardTextEvent(wxEventType type
= wxEVT_NULL
,
2357 wxWindowID winid
= 0)
2358 : wxCommandEvent(type
, winid
)
2360 wxClipboardTextEvent(const wxClipboardTextEvent
& event
)
2361 : wxCommandEvent(event
)
2364 virtual wxEvent
*Clone() const { return new wxClipboardTextEvent(*this); }
2367 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxClipboardTextEvent
)
2370 // A Context event is sent when the user right clicks on a window or
2371 // presses Shift-F10
2372 // NOTE : Under windows this is a repackaged WM_CONTETXMENU message
2373 // Under other systems it may have to be generated from a right click event
2378 class WXDLLIMPEXP_CORE wxContextMenuEvent
: public wxCommandEvent
2381 wxContextMenuEvent(wxEventType type
= wxEVT_NULL
,
2382 wxWindowID winid
= 0,
2383 const wxPoint
& pt
= wxDefaultPosition
)
2384 : wxCommandEvent(type
, winid
),
2387 wxContextMenuEvent(const wxContextMenuEvent
& event
)
2388 : wxCommandEvent(event
),
2392 // Position of event (in screen coordinates)
2393 const wxPoint
& GetPosition() const { return m_pos
; }
2394 void SetPosition(const wxPoint
& pos
) { m_pos
= pos
; }
2396 virtual wxEvent
*Clone() const { return new wxContextMenuEvent(*this); }
2402 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxContextMenuEvent
)
2412 // Whether to always send idle events to windows, or
2413 // to only send update events to those with the
2414 // wxWS_EX_PROCESS_IDLE style.
2418 // Send idle events to all windows
2421 // Send idle events to windows that have
2422 // the wxWS_EX_PROCESS_IDLE flag specified
2423 wxIDLE_PROCESS_SPECIFIED
2426 class WXDLLIMPEXP_BASE wxIdleEvent
: public wxEvent
2430 : wxEvent(0, wxEVT_IDLE
),
2431 m_requestMore(false)
2433 wxIdleEvent(const wxIdleEvent
& event
)
2435 m_requestMore(event
.m_requestMore
)
2438 void RequestMore(bool needMore
= true) { m_requestMore
= needMore
; }
2439 bool MoreRequested() const { return m_requestMore
; }
2441 virtual wxEvent
*Clone() const { return new wxIdleEvent(*this); }
2443 // Specify how wxWidgets will send idle events: to
2444 // all windows, or only to those which specify that they
2445 // will process the events.
2446 static void SetMode(wxIdleMode mode
) { sm_idleMode
= mode
; }
2448 // Returns the idle event mode
2449 static wxIdleMode
GetMode() { return sm_idleMode
; }
2453 static wxIdleMode sm_idleMode
;
2456 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIdleEvent
)
2460 wxEVT_MOUSE_CAPTURE_CHANGED,
2461 wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
2462 // wxEVT_FONT_CHANGED, // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
2463 // wxEVT_FONT_CHANGED to all other windows (maybe).
2464 wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
2470 // ============================================================================
2471 // event handler and related classes
2472 // ============================================================================
2475 // struct containing the members common to static and dynamic event tables
2477 struct WXDLLIMPEXP_BASE wxEventTableEntryBase
2479 wxEventTableEntryBase(int winid
, int idLast
,
2480 wxEventFunctor
* fn
, wxObject
*data
)
2484 m_callbackUserData(data
)
2487 wxEventTableEntryBase( const wxEventTableEntryBase
&entry
)
2488 : m_id( entry
.m_id
),
2489 m_lastId( entry
.m_lastId
),
2491 m_callbackUserData( entry
.m_callbackUserData
)
2493 // This is a 'hack' to ensure that only one instance tries to delete
2494 // the functor pointer. It is safe as long as the only place where the
2495 // copy constructor is being called is when the static event tables are
2496 // being initialized (a temporary instance is created and then this
2497 // constructor is called).
2499 const_cast< wxEventTableEntryBase
& >( entry
).m_fn
= NULL
;
2502 ~wxEventTableEntryBase()
2507 // the range of ids for this entry: if m_lastId == wxID_ANY, the range
2508 // consists only of m_id, otherwise it is m_id..m_lastId inclusive
2512 // function/method/functor to call
2513 wxEventFunctor
* m_fn
;
2515 // arbitrary user data associated with the callback
2516 wxObject
* m_callbackUserData
;
2519 wxEventTableEntryBase
&operator = ( const wxEventTableEntryBase
& );
2522 // an entry from a static event table
2523 struct WXDLLIMPEXP_BASE wxEventTableEntry
: public wxEventTableEntryBase
2525 wxEventTableEntry(const int& evType
, int winid
, int idLast
,
2526 wxEventFunctor
* fn
, wxObject
*data
)
2527 : wxEventTableEntryBase(winid
, idLast
, fn
, data
),
2531 // the reference to event type: this allows us to not care about the
2532 // (undefined) order in which the event table entries and the event types
2533 // are initialized: initially the value of this reference might be
2534 // invalid, but by the time it is used for the first time, all global
2535 // objects will have been initialized (including the event type constants)
2536 // and so it will have the correct value when it is needed
2537 const int& m_eventType
;
2540 wxEventTableEntry
&operator = ( const wxEventTableEntry
& );
2543 // an entry used in dynamic event table managed by wxEvtHandler::Connect()
2544 struct WXDLLIMPEXP_BASE wxDynamicEventTableEntry
: public wxEventTableEntryBase
2546 wxDynamicEventTableEntry(int evType
, int winid
, int idLast
,
2547 wxEventFunctor
* fn
, wxObject
*data
)
2548 : wxEventTableEntryBase(winid
, idLast
, fn
, data
),
2552 // not a reference here as we can't keep a reference to a temporary int
2553 // created to wrap the constant value typically passed to Connect() - nor
2558 wxDynamicEventTableEntry
&operator = ( const wxDynamicEventTableEntry
& );
2561 // ----------------------------------------------------------------------------
2562 // wxEventTable: an array of event entries terminated with {0, 0, 0, 0, 0}
2563 // ----------------------------------------------------------------------------
2565 struct WXDLLIMPEXP_BASE wxEventTable
2567 const wxEventTable
*baseTable
; // base event table (next in chain)
2568 const wxEventTableEntry
*entries
; // bottom of entry array
2571 // ----------------------------------------------------------------------------
2572 // wxEventHashTable: a helper of wxEvtHandler to speed up wxEventTable lookups.
2573 // ----------------------------------------------------------------------------
2575 WX_DEFINE_ARRAY_PTR(const wxEventTableEntry
*, wxEventTableEntryPointerArray
);
2577 class WXDLLIMPEXP_BASE wxEventHashTable
2580 // Internal data structs
2581 struct EventTypeTable
2583 wxEventType eventType
;
2584 wxEventTableEntryPointerArray eventEntryTable
;
2586 typedef EventTypeTable
* EventTypeTablePointer
;
2589 // Constructor, needs the event table it needs to hash later on.
2590 // Note: hashing of the event table is not done in the constructor as it
2591 // can be that the event table is not yet full initialize, the hash
2592 // will gets initialized when handling the first event look-up request.
2593 wxEventHashTable(const wxEventTable
&table
);
2595 ~wxEventHashTable();
2597 // Handle the given event, in other words search the event table hash
2598 // and call self->ProcessEvent() if a match was found.
2599 bool HandleEvent(wxEvent
&event
, wxEvtHandler
*self
);
2604 #if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
2606 static void ClearAll();
2607 #endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING
2610 // Init the hash table with the entries of the static event table.
2611 void InitHashTable();
2612 // Helper funtion of InitHashTable() to insert 1 entry into the hash table.
2613 void AddEntry(const wxEventTableEntry
&entry
);
2614 // Allocate and init with null pointers the base hash table.
2615 void AllocEventTypeTable(size_t size
);
2616 // Grow the hash table in size and transfer all items currently
2617 // in the table to the correct location in the new table.
2618 void GrowEventTypeTable();
2621 const wxEventTable
&m_table
;
2625 EventTypeTablePointer
*m_eventTypeTable
;
2627 static wxEventHashTable
* sm_first
;
2628 wxEventHashTable
* m_previous
;
2629 wxEventHashTable
* m_next
;
2631 DECLARE_NO_COPY_CLASS(wxEventHashTable
)
2634 // ----------------------------------------------------------------------------
2635 // wxEvtHandler: the base class for all objects handling wxWidgets events
2636 // ----------------------------------------------------------------------------
2638 class WXDLLIMPEXP_BASE wxEvtHandler
: public wxObject
2639 , public wxTrackable
2643 virtual ~wxEvtHandler();
2645 wxEvtHandler
*GetNextHandler() const { return m_nextHandler
; }
2646 wxEvtHandler
*GetPreviousHandler() const { return m_previousHandler
; }
2647 void SetNextHandler(wxEvtHandler
*handler
) { m_nextHandler
= handler
; }
2648 void SetPreviousHandler(wxEvtHandler
*handler
) { m_previousHandler
= handler
; }
2650 void SetEvtHandlerEnabled(bool enabled
) { m_enabled
= enabled
; }
2651 bool GetEvtHandlerEnabled() const { return m_enabled
; }
2653 // Process an event right now: this can only be called from the main
2654 // thread, use QueueEvent() for scheduling the events for
2655 // processing from other threads.
2656 virtual bool ProcessEvent(wxEvent
& event
);
2658 // Process an event by calling ProcessEvent and handling any exceptions
2659 // thrown by event handlers. It's mostly useful when processing wx events
2660 // when called from C code (e.g. in GTK+ callback) when the exception
2661 // wouldn't correctly propagate to wxEventLoop.
2662 bool SafelyProcessEvent(wxEvent
& event
);
2664 // Schedule the given event to be processed later. It takes ownership of
2665 // the event pointer, i.e. it will be deleted later. This is safe to call
2666 // from multiple threads although you still need to ensure that wxString
2667 // fields of the event object are deep copies and not use the same string
2668 // buffer as other wxString objects in this thread.
2669 virtual void QueueEvent(wxEvent
*event
);
2671 // Add an event to be processed later: notice that this function is not
2672 // safe to call from threads other than main, use QueueEvent()
2673 virtual void AddPendingEvent(const wxEvent
& event
)
2675 // notice that the thread-safety problem comes from the fact that
2676 // Clone() doesn't make deep copies of wxString fields of wxEvent
2677 // object and so the same wxString could be used from both threads when
2678 // the event object is destroyed in this one -- QueueEvent() avoids
2679 // this problem as the event pointer is not used any more in this
2680 // thread at all after it is called.
2681 QueueEvent(event
.Clone());
2684 void ProcessPendingEvents();
2687 bool ProcessThreadEvent(const wxEvent
& event
);
2690 // Dynamic association of a member function handler with the event handler,
2691 // winid and event type
2692 void Connect(int winid
,
2694 wxEventType eventType
,
2695 wxObjectEventFunction func
,
2696 wxObject
*userData
= NULL
,
2697 wxEvtHandler
*eventSink
= NULL
)
2699 wxObjectEventFunctor
*functor
= wxNewEventFunctor( eventType
, func
, eventSink
);
2701 Subscribe( winid
, lastId
, eventType
, functor
, userData
);
2704 // Convenience function: take just one id
2705 void Connect(int winid
,
2706 wxEventType eventType
,
2707 wxObjectEventFunction func
,
2708 wxObject
*userData
= NULL
,
2709 wxEvtHandler
*eventSink
= NULL
)
2710 { Connect(winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
2712 // Even more convenient: without id (same as using id of wxID_ANY)
2713 void Connect(wxEventType eventType
,
2714 wxObjectEventFunction func
,
2715 wxObject
*userData
= NULL
,
2716 wxEvtHandler
*eventSink
= NULL
)
2717 { Connect(wxID_ANY
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
2719 bool Disconnect(int winid
,
2721 wxEventType eventType
,
2722 wxObjectEventFunction func
= NULL
,
2723 wxObject
*userData
= NULL
,
2724 wxEvtHandler
*eventSink
= NULL
)
2726 wxObjectEventFunctor functor
= wxConstructEventFunctor( eventType
, func
, eventSink
);
2728 return Unsubscribe( winid
, lastId
, eventType
, functor
, userData
);
2731 bool Disconnect(int winid
= wxID_ANY
,
2732 wxEventType eventType
= wxEVT_NULL
,
2733 wxObjectEventFunction func
= NULL
,
2734 wxObject
*userData
= NULL
,
2735 wxEvtHandler
*eventSink
= NULL
)
2736 { return Disconnect(winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
2738 bool Disconnect(wxEventType eventType
,
2739 wxObjectEventFunction func
,
2740 wxObject
*userData
= NULL
,
2741 wxEvtHandler
*eventSink
= NULL
)
2742 { return Disconnect(wxID_ANY
, eventType
, func
, userData
, eventSink
); }
2745 #if !wxEVENTS_COMPATIBILITY_2_8
2747 // Connect a function to an event:
2749 template <typename EventType
>
2750 void Connect(int winid
,
2752 const EventType
&eventType
,
2753 void (*func
)(typename EventType
::CorrespondingEvent
&),
2754 wxObject
* userData
= NULL
)
2756 wxEventFunctorFunction
< EventType
> *functor
= wxNewEventFunctor( eventType
, func
);
2758 Subscribe( winid
, lastId
, eventType
, functor
, userData
);
2761 template <typename EventType
>
2762 void Connect( int winid
,
2763 const EventType
&eventType
,
2764 void ( *func
)( typename EventType
::CorrespondingEvent
& ),
2765 wxObject
* userData
= NULL
)
2766 { Connect( winid
, wxID_ANY
, eventType
, func
, userData
); }
2768 template <typename EventType
>
2769 void Connect( const EventType
&eventType
,
2770 void ( *func
)( typename EventType
::CorrespondingEvent
& ),
2771 wxObject
* userData
= NULL
)
2772 { Connect( wxID_ANY
, wxID_ANY
, eventType
, func
, userData
); }
2775 // Connect a method to an event:
2778 template <typename EventType
, typename Class
>
2779 void Connect( int winid
,
2781 const EventType
&eventType
,
2782 void ( Class
::*func
)( typename EventType
::CorrespondingEvent
& ),
2783 wxObject
*userData
= NULL
)
2785 wxEventFunctorMethod
< EventType
, Class
, Class
> *functor
=
2786 wxNewEventFunctor( eventType
, func
, static_cast< Class
* const >( this ));
2788 Subscribe( winid
, lastId
, eventType
, functor
, userData
);
2791 template <typename EventType
, typename Class
>
2792 void Connect( int winid
,
2793 const EventType
&eventType
,
2794 void ( Class
::*func
)( typename EventType
::CorrespondingEvent
& ),
2795 wxObject
*userData
= NULL
)
2796 { Connect( winid
, wxID_ANY
, eventType
, func
, userData
); }
2798 template <typename EventType
, typename Class
>
2799 void Connect( const EventType
&eventType
,
2800 void ( Class
::*func
)( typename EventType
::CorrespondingEvent
& ),
2801 wxObject
*userData
= NULL
)
2802 { Connect( wxID_ANY
, wxID_ANY
, eventType
, func
, userData
); }
2804 template <typename EventType
, typename Class
, typename Derived
>
2805 void Connect( int winid
,
2807 const EventType
&eventType
,
2808 void ( Class
::*func
)( typename EventType
::CorrespondingEvent
& ),
2809 wxObject
*userData
= NULL
,
2810 Derived
*eventSink
= NULL
)
2812 wxEventFunctorMethod
< EventType
, Class
, Derived
> *functor
=
2813 wxNewEventFunctor( eventType
, func
, eventSink
);
2815 Subscribe( winid
, lastId
, eventType
, functor
, userData
);
2818 template <typename EventType
, typename Class
, typename Derived
>
2819 void Connect( int winid
,
2820 const EventType
&eventType
,
2821 void ( Class
::*func
)( typename EventType
::CorrespondingEvent
& ),
2822 wxObject
*userData
= NULL
,
2823 Derived
*eventSink
= NULL
)
2824 { Connect( winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
2826 template <typename EventType
, typename Class
, typename Derived
>
2827 void Connect( const EventType
&eventType
,
2828 void ( Class
::*func
)( typename EventType
::CorrespondingEvent
& ),
2829 wxObject
*userData
= NULL
,
2830 Derived
*eventSink
= NULL
)
2831 { Connect( wxID_ANY
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
2833 template <typename Sender
, typename EventType
, typename Class
, typename Derived
>
2834 static void Connect( Sender
*sender
,
2837 const EventType
&eventType
,
2838 void ( Class
::*func
)( typename EventType
::CorrespondingEvent
& ),
2839 wxObject
*userData
= NULL
,
2840 Derived
*eventSink
= NULL
)
2842 wxEventFunctorMethod
< EventType
, Class
, Derived
> *functor
=
2843 wxNewEventFunctor( eventType
, func
, eventSink
);
2845 sender
->Subscribe( winid
, lastId
, eventType
, functor
, userData
);
2848 template <typename Sender
, typename EventType
, typename Class
, typename Derived
>
2849 static void Connect( Sender
*sender
,
2851 const EventType
&eventType
,
2852 void ( Class
::*func
)( typename EventType
::CorrespondingEvent
& ),
2853 wxObject
*userData
= NULL
,
2854 Derived
*eventSink
= NULL
)
2855 { Connect( sender
, winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
2857 template <typename Sender
, typename EventType
, typename Class
, typename Derived
>
2858 static void Connect( Sender
*sender
,
2859 const EventType
&eventType
,
2860 void ( Class
::*func
)( typename EventType
::CorrespondingEvent
& ),
2861 wxObject
*userData
= NULL
,
2862 Derived
*eventSink
= NULL
)
2863 { Connect( sender
, wxID_ANY
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
2866 // Connect an arbitrary functor to an event:
2869 template <typename EventType
, typename Functor
>
2870 void Connect( int winid
,
2872 const EventType
&eventType
,
2874 wxObject
* userData
= NULL
)
2876 wxEventFunctorAdapter
< EventType
, Functor
> *adapter
=
2877 wxNewEventFunctor( eventType
, functor
);
2879 Subscribe( winid
, lastId
, eventType
, adapter
, userData
);
2881 template <typename EventType
, typename Functor
>
2882 void Connect( int winid
,
2883 const EventType
&eventType
,
2885 wxObject
* userData
= NULL
)
2886 { Connect( winid
, wxID_ANY
, eventType
, functor
, userData
); }
2888 template <typename EventType
, typename Functor
>
2889 void Connect( const EventType
&eventType
,
2891 wxObject
* userData
= NULL
)
2892 { Connect( wxID_ANY
, wxID_ANY
, eventType
, functor
, userData
); }
2895 // Disconnect a function from an event:
2898 template <typename EventType
>
2899 bool Disconnect( int winid
,
2901 const EventType
&eventType
,
2902 void ( *func
)( typename EventType
::CorrespondingEvent
& ),
2903 wxObject
* userData
= NULL
)
2905 wxEventFunctorFunction
< EventType
> functor
= wxConstructEventFunctor( eventType
, func
);
2907 return Unsubscribe( winid
, lastId
, eventType
, functor
, userData
);
2910 template <typename EventType
>
2911 bool Disconnect( int winid
,
2912 const EventType
&eventType
,
2913 void ( *func
)( typename EventType
::CorrespondingEvent
& ),
2914 wxObject
* userData
= NULL
)
2915 { return Disconnect( winid
, wxID_ANY
, eventType
, func
, userData
); }
2917 template <typename EventType
>
2918 bool Disconnect( const EventType
&eventType
,
2919 void ( *func
)( typename EventType
::CorrespondingEvent
& ),
2920 wxObject
* userData
= NULL
)
2921 { return Disconnect( wxID_ANY
, wxID_ANY
, eventType
, func
, userData
); }
2924 // Disconnect a method from an event:
2927 template <typename EventType
, typename Class
>
2928 bool Disconnect( int winid
,
2930 const EventType
&eventType
,
2931 void ( Class
::*func
)( typename EventType
::CorrespondingEvent
& ),
2932 wxObject
*userData
= NULL
)
2934 wxEventFunctorMethod
< EventType
, Class
, Class
> functor
=
2935 wxConstructEventFunctor( eventType
, func
, static_cast< Class
* const >( this ));
2937 return Unsubscribe( winid
, lastId
, eventType
, functor
, userData
);
2940 template <typename EventType
, typename Class
>
2941 bool Disconnect( int winid
,
2942 const EventType
&eventType
,
2943 void ( Class
::*func
)( typename EventType
::CorrespondingEvent
& ),
2944 wxObject
*userData
= NULL
)
2945 { return Disconnect( winid
, wxID_ANY
, eventType
, func
, userData
); }
2947 template <typename EventType
, typename Class
>
2948 bool Disconnect( const EventType
&eventType
,
2949 void ( Class
::*func
)( typename EventType
::CorrespondingEvent
& ),
2950 wxObject
*userData
= NULL
)
2951 { return Disconnect( wxID_ANY
, wxID_ANY
, eventType
, func
, userData
); }
2953 template <typename EventType
, typename Class
, typename Derived
>
2954 bool Disconnect( int winid
,
2956 const EventType
&eventType
,
2957 void ( Class
::*func
)( typename EventType
::CorrespondingEvent
& ),
2958 wxObject
*userData
= NULL
,
2959 Derived
*eventSink
= NULL
)
2961 wxEventFunctorMethod
< EventType
, Class
, Derived
> functor
=
2962 wxConstructEventFunctor( eventType
, func
, eventSink
);
2964 return Unsubscribe( winid
, lastId
, eventType
, functor
, userData
);
2967 template <typename EventType
, typename Class
, typename Derived
>
2968 bool Disconnect( int winid
,
2969 const EventType
&eventType
,
2970 void ( Class
::*func
)( typename EventType
::CorrespondingEvent
& ),
2971 wxObject
*userData
= NULL
,
2972 Derived
*eventSink
= NULL
)
2973 { return Disconnect( winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
2975 template <typename EventType
, typename Class
, typename Derived
>
2976 bool Disconnect( const EventType
&eventType
,
2977 void ( Class
::*func
)( typename EventType
::CorrespondingEvent
& ),
2978 wxObject
*userData
= NULL
,
2979 Derived
*eventSink
= NULL
)
2980 { return Disconnect( wxID_ANY
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
2982 template <typename Sender
, typename EventType
, typename Class
, typename Derived
>
2983 static bool Disconnect( Sender
*sender
,
2986 const EventType
&eventType
,
2987 void ( Class
::*func
)( typename EventType
::CorrespondingEvent
& ),
2988 wxObject
*userData
= NULL
,
2989 Derived
*eventSink
= NULL
)
2991 wxEventFunctorMethod
< EventType
, Class
, Derived
> functor
=
2992 wxConstructEventFunctor( eventType
, func
, eventSink
);
2994 return sender
->Unsubscribe( winid
, lastId
, eventType
, functor
, userData
);
2997 template <typename Sender
, typename EventType
, typename Class
, typename Derived
>
2998 static bool Disconnect( Sender
*sender
,
3000 const EventType
&eventType
,
3001 void ( Class
::*func
)( typename EventType
::CorrespondingEvent
& ),
3002 wxObject
*userData
= NULL
,
3003 Derived
*eventSink
= NULL
)
3004 { return Disconnect( sender
, winid
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3006 template <typename Sender
, typename EventType
, typename Class
, typename Derived
>
3007 static bool Disconnect( Sender
*sender
,
3008 const EventType
&eventType
,
3009 void ( Class
::*func
)( typename EventType
::CorrespondingEvent
& ),
3010 wxObject
*userData
= NULL
,
3011 Derived
*eventSink
= NULL
)
3012 { return Disconnect( sender
, wxID_ANY
, wxID_ANY
, eventType
, func
, userData
, eventSink
); }
3015 // Disconnect an arbitrary functor from an event:
3018 template <typename EventType
, typename Functor
>
3019 bool Disconnect( int winid
,
3021 const EventType
&eventType
,
3023 wxObject
* userData
= NULL
)
3025 wxEventFunctorAdapter
< EventType
, Functor
> adapter
=
3026 wxConstructEventFunctor( eventType
, functor
);
3028 return Unsubscribe( winid
, lastId
, eventType
, adapter
, userData
);
3031 template <typename EventType
, typename Functor
>
3032 bool Disconnect( int winid
,
3033 const EventType
&eventType
,
3035 wxObject
* userData
= NULL
)
3036 { return Disconnect( winid
, wxID_ANY
, eventType
, functor
, userData
); }
3038 template <typename EventType
, typename Functor
>
3039 bool Disconnect( const EventType
&eventType
,
3041 wxObject
* userData
= NULL
)
3042 { return Disconnect( wxID_ANY
, wxID_ANY
, eventType
, functor
, userData
); }
3044 #endif // !wxEVENTS_COMPATIBILITY_2_8
3047 wxList
* GetDynamicEventTable() const { return m_dynamicEvents
; }
3049 // User data can be associated with each wxEvtHandler
3050 void SetClientObject( wxClientData
*data
) { DoSetClientObject(data
); }
3051 wxClientData
*GetClientObject() const { return DoGetClientObject(); }
3053 void SetClientData( void *data
) { DoSetClientData(data
); }
3054 void *GetClientData() const { return DoGetClientData(); }
3057 // implementation from now on
3058 // --------------------------
3060 // check if the given event table entry matches this event by id (the check
3061 // for the event type should be done by caller) and call the handler if it
3064 // return true if the event was processed, false otherwise (no match or the
3065 // handler decided to skip the event)
3066 static bool ProcessEventIfMatchesId(const wxEventTableEntryBase
& tableEntry
,
3067 wxEvtHandler
*handler
,
3070 virtual bool SearchEventTable(wxEventTable
& table
, wxEvent
& event
);
3071 bool SearchDynamicEventTable( wxEvent
& event
);
3073 // Avoid problems at exit by cleaning up static hash table gracefully
3074 void ClearEventHashTable() { GetEventHashTable().Clear(); }
3075 void OnSinkDestroyed( wxEvtHandler
*sink
);
3078 // The method processing the event in this event handler (or rather in this
3079 // event handler chain as it also tries the next handler and so on), i.e.
3080 // it returns true if we processed this event or false if we didn't but
3081 // does not call TryParent() in the latter case. It also doesn't call
3082 // wxApp::FilterEvent() before processing it, this is supposed to be done
3083 // by the public ProcessEvent() only once for every event we handle.
3085 // It is meant to be called from ProcessEvent() only and is not virtual,
3086 // additional event handlers can be hooked into the normal event processing
3087 // logic using TryValidator() hook.
3088 bool ProcessEventHere(wxEvent
& event
);
3092 void Subscribe(int winid
,
3094 wxEventType eventType
,
3095 wxEventFunctor
*func
,
3096 wxObject
* userData
);
3098 bool Unsubscribe(int winid
,
3100 wxEventType eventType
,
3101 const wxEventFunctor
&func
,
3102 wxObject
*userData
);
3104 static const wxEventTableEntry sm_eventTableEntries
[];
3107 // hooks for wxWindow used by ProcessEvent()
3108 // -----------------------------------------
3110 // This one is called before trying our own event table to allow plugging
3111 // in the validators.
3113 // NB: This method is intentionally *not* inside wxUSE_VALIDATORS!
3114 // It is part of wxBase which doesn't use validators and the code
3115 // is compiled out when building wxBase w/o GUI classes, which affects
3116 // binary compatibility and wxBase library can't be used by GUI
3118 virtual bool TryValidator(wxEvent
& WXUNUSED(event
)) { return false; }
3120 // this one is called after failing to find the event handle in our own
3121 // table to give a chance to the other windows to process it
3123 // base class implementation passes the event to wxTheApp
3124 virtual bool TryParent(wxEvent
& event
);
3127 static const wxEventTable sm_eventTable
;
3128 virtual const wxEventTable
*GetEventTable() const;
3130 static wxEventHashTable sm_eventHashTable
;
3131 virtual wxEventHashTable
& GetEventHashTable() const;
3133 wxEvtHandler
* m_nextHandler
;
3134 wxEvtHandler
* m_previousHandler
;
3135 wxList
* m_dynamicEvents
;
3136 wxList
* m_pendingEvents
;
3139 // critical section protecting m_pendingEvents
3140 wxCriticalSection m_pendingEventsLock
;
3141 #endif // wxUSE_THREADS
3143 // Is event handler enabled?
3147 // The user data: either an object which will be deleted by the container
3148 // when it's deleted or some raw pointer which we do nothing with - only
3149 // one type of data can be used with the given window (i.e. you cannot set
3150 // the void data and then associate the container with wxClientData or vice
3154 wxClientData
*m_clientObject
;
3158 // what kind of data do we have?
3159 wxClientDataType m_clientDataType
;
3161 // client data accessors
3162 virtual void DoSetClientObject( wxClientData
*data
);
3163 virtual wxClientData
*DoGetClientObject() const;
3165 virtual void DoSetClientData( void *data
);
3166 virtual void *DoGetClientData() const;
3168 // Search tracker objects for event connection with this sink
3169 wxEventConnectionRef
*FindRefInTrackerList(wxEvtHandler
*eventSink
);
3172 DECLARE_DYNAMIC_CLASS_NO_COPY(wxEvtHandler
)
3175 // ----------------------------------------------------------------------------
3176 // wxEventConnectionRef represents all connections between two event handlers
3177 // and enables automatic disconnect when an event handler sink goes out of
3178 // scope. Each connection/disconnect increases/decreases ref count, and
3179 // when it reaches zero the node goes out of scope.
3180 // ----------------------------------------------------------------------------
3182 class wxEventConnectionRef
: public wxTrackerNode
3185 wxEventConnectionRef() : m_src(NULL
), m_sink(NULL
), m_refCount(0) { }
3186 wxEventConnectionRef(wxEvtHandler
*src
, wxEvtHandler
*sink
)
3187 : m_src(src
), m_sink(sink
), m_refCount(1)
3189 m_sink
->AddNode(this);
3192 // The sink is being destroyed
3193 virtual void OnObjectDestroy( )
3196 m_src
->OnSinkDestroyed( m_sink
);
3200 virtual wxEventConnectionRef
*ToEventConnection() { return this; }
3202 void IncRef() { m_refCount
++; }
3205 if ( !--m_refCount
)
3207 // The sink holds the only external pointer to this object
3209 m_sink
->RemoveNode(this);
3215 wxEvtHandler
*m_src
,
3219 friend class wxEvtHandler
;
3221 DECLARE_NO_ASSIGN_CLASS(wxEventConnectionRef
)
3224 // Post a message to the given event handler which will be processed during the
3225 // next event loop iteration.
3227 // Notice that this one is not thread-safe, use wxQueueEvent()
3228 inline void wxPostEvent(wxEvtHandler
*dest
, const wxEvent
& event
)
3230 wxCHECK_RET( dest
, "need an object to post event to" );
3232 dest
->AddPendingEvent(event
);
3235 // Wrapper around wxEvtHandler::QueueEvent(): adds an event for later
3236 // processing, unlike wxPostEvent it is safe to use from different thread even
3237 // for events with wxString members
3238 inline void wxQueueEvent(wxEvtHandler
*dest
, wxEvent
*event
)
3240 wxCHECK_RET( dest
, "need an object to queue event for" );
3242 dest
->QueueEvent(event
);
3245 typedef void (wxEvtHandler
::*wxEventFunction
)(wxEvent
&);
3246 typedef void (wxEvtHandler
::*wxIdleEventFunction
)(wxIdleEvent
&);
3248 #define wxEventHandler(func) \
3249 wxEVENT_HANDLER_CAST(wxEventFunction, func)
3250 #define wxIdleEventHandler(func) \
3251 wxEVENT_HANDLER_CAST(wxIdleEventFunction, func)
3255 // ----------------------------------------------------------------------------
3256 // wxEventBlocker: helper class to temporarily disable event handling for a window
3257 // ----------------------------------------------------------------------------
3259 class WXDLLIMPEXP_CORE wxEventBlocker
: public wxEvtHandler
3262 wxEventBlocker(wxWindow
*win
, wxEventType type
= wxEVT_ANY
);
3263 virtual ~wxEventBlocker();
3265 void Block(wxEventType type
)
3267 m_eventsToBlock
.push_back(type
);
3270 virtual bool ProcessEvent(wxEvent
& event
);
3273 wxArrayInt m_eventsToBlock
;
3276 DECLARE_NO_COPY_CLASS(wxEventBlocker
)
3279 typedef void (wxEvtHandler
::*wxCommandEventFunction
)(wxCommandEvent
&);
3280 typedef void (wxEvtHandler
::*wxScrollEventFunction
)(wxScrollEvent
&);
3281 typedef void (wxEvtHandler
::*wxScrollWinEventFunction
)(wxScrollWinEvent
&);
3282 typedef void (wxEvtHandler
::*wxSizeEventFunction
)(wxSizeEvent
&);
3283 typedef void (wxEvtHandler
::*wxMoveEventFunction
)(wxMoveEvent
&);
3284 typedef void (wxEvtHandler
::*wxPaintEventFunction
)(wxPaintEvent
&);
3285 typedef void (wxEvtHandler
::*wxNcPaintEventFunction
)(wxNcPaintEvent
&);
3286 typedef void (wxEvtHandler
::*wxEraseEventFunction
)(wxEraseEvent
&);
3287 typedef void (wxEvtHandler
::*wxMouseEventFunction
)(wxMouseEvent
&);
3288 typedef void (wxEvtHandler
::*wxCharEventFunction
)(wxKeyEvent
&);
3289 typedef void (wxEvtHandler
::*wxFocusEventFunction
)(wxFocusEvent
&);
3290 typedef void (wxEvtHandler
::*wxChildFocusEventFunction
)(wxChildFocusEvent
&);
3291 typedef void (wxEvtHandler
::*wxActivateEventFunction
)(wxActivateEvent
&);
3292 typedef void (wxEvtHandler
::*wxMenuEventFunction
)(wxMenuEvent
&);
3293 typedef void (wxEvtHandler
::*wxJoystickEventFunction
)(wxJoystickEvent
&);
3294 typedef void (wxEvtHandler
::*wxDropFilesEventFunction
)(wxDropFilesEvent
&);
3295 typedef void (wxEvtHandler
::*wxInitDialogEventFunction
)(wxInitDialogEvent
&);
3296 typedef void (wxEvtHandler
::*wxSysColourChangedEventFunction
)(wxSysColourChangedEvent
&);
3297 typedef void (wxEvtHandler
::*wxDisplayChangedEventFunction
)(wxDisplayChangedEvent
&);
3298 typedef void (wxEvtHandler
::*wxUpdateUIEventFunction
)(wxUpdateUIEvent
&);
3299 typedef void (wxEvtHandler
::*wxCloseEventFunction
)(wxCloseEvent
&);
3300 typedef void (wxEvtHandler
::*wxShowEventFunction
)(wxShowEvent
&);
3301 typedef void (wxEvtHandler
::*wxIconizeEventFunction
)(wxIconizeEvent
&);
3302 typedef void (wxEvtHandler
::*wxMaximizeEventFunction
)(wxMaximizeEvent
&);
3303 typedef void (wxEvtHandler
::*wxNavigationKeyEventFunction
)(wxNavigationKeyEvent
&);
3304 typedef void (wxEvtHandler
::*wxPaletteChangedEventFunction
)(wxPaletteChangedEvent
&);
3305 typedef void (wxEvtHandler
::*wxQueryNewPaletteEventFunction
)(wxQueryNewPaletteEvent
&);
3306 typedef void (wxEvtHandler
::*wxWindowCreateEventFunction
)(wxWindowCreateEvent
&);
3307 typedef void (wxEvtHandler
::*wxWindowDestroyEventFunction
)(wxWindowDestroyEvent
&);
3308 typedef void (wxEvtHandler
::*wxSetCursorEventFunction
)(wxSetCursorEvent
&);
3309 typedef void (wxEvtHandler
::*wxNotifyEventFunction
)(wxNotifyEvent
&);
3310 typedef void (wxEvtHandler
::*wxHelpEventFunction
)(wxHelpEvent
&);
3311 typedef void (wxEvtHandler
::*wxContextMenuEventFunction
)(wxContextMenuEvent
&);
3312 typedef void (wxEvtHandler
::*wxMouseCaptureChangedEventFunction
)(wxMouseCaptureChangedEvent
&);
3313 typedef void (wxEvtHandler
::*wxMouseCaptureLostEventFunction
)(wxMouseCaptureLostEvent
&);
3314 typedef void (wxEvtHandler
::*wxClipboardTextEventFunction
)(wxClipboardTextEvent
&);
3317 #define wxCommandEventHandler(func) \
3318 wxEVENT_HANDLER_CAST(wxCommandEventFunction, func)
3319 #define wxScrollEventHandler(func) \
3320 wxEVENT_HANDLER_CAST(wxScrollEventFunction, func)
3321 #define wxScrollWinEventHandler(func) \
3322 wxEVENT_HANDLER_CAST(wxScrollWinEventFunction, func)
3323 #define wxSizeEventHandler(func) \
3324 wxEVENT_HANDLER_CAST(wxSizeEventFunction, func)
3325 #define wxMoveEventHandler(func) \
3326 wxEVENT_HANDLER_CAST(wxMoveEventFunction, func)
3327 #define wxPaintEventHandler(func) \
3328 wxEVENT_HANDLER_CAST(wxPaintEventFunction, func)
3329 #define wxNcPaintEventHandler(func) \
3330 wxEVENT_HANDLER_CAST(wxNcPaintEventFunction, func)
3331 #define wxEraseEventHandler(func) \
3332 wxEVENT_HANDLER_CAST(wxEraseEventFunction, func)
3333 #define wxMouseEventHandler(func) \
3334 wxEVENT_HANDLER_CAST(wxMouseEventFunction, func)
3335 #define wxCharEventHandler(func) \
3336 wxEVENT_HANDLER_CAST(wxCharEventFunction, func)
3337 #define wxKeyEventHandler(func) wxCharEventHandler(func)
3338 #define wxFocusEventHandler(func) \
3339 wxEVENT_HANDLER_CAST(wxFocusEventFunction, func)
3340 #define wxChildFocusEventHandler(func) \
3341 wxEVENT_HANDLER_CAST(wxChildFocusEventFunction, func)
3342 #define wxActivateEventHandler(func) \
3343 wxEVENT_HANDLER_CAST(wxActivateEventFunction, func)
3344 #define wxMenuEventHandler(func) \
3345 wxEVENT_HANDLER_CAST(wxMenuEventFunction, func)
3346 #define wxJoystickEventHandler(func) \
3347 wxEVENT_HANDLER_CAST(wxJoystickEventFunction, func)
3348 #define wxDropFilesEventHandler(func) \
3349 wxEVENT_HANDLER_CAST(wxDropFilesEventFunction, func)
3350 #define wxInitDialogEventHandler(func) \
3351 wxEVENT_HANDLER_CAST(wxInitDialogEventFunction, func)
3352 #define wxSysColourChangedEventHandler(func) \
3353 wxEVENT_HANDLER_CAST(wxSysColourChangedEventFunction, func)
3354 #define wxDisplayChangedEventHandler(func) \
3355 wxEVENT_HANDLER_CAST(wxDisplayChangedEventFunction, func)
3356 #define wxUpdateUIEventHandler(func) \
3357 wxEVENT_HANDLER_CAST(wxUpdateUIEventFunction, func)
3358 #define wxCloseEventHandler(func) \
3359 wxEVENT_HANDLER_CAST(wxCloseEventFunction, func)
3360 #define wxShowEventHandler(func) \
3361 wxEVENT_HANDLER_CAST(wxShowEventFunction, func)
3362 #define wxIconizeEventHandler(func) \
3363 wxEVENT_HANDLER_CAST(wxIconizeEventFunction, func)
3364 #define wxMaximizeEventHandler(func) \
3365 wxEVENT_HANDLER_CAST(wxMaximizeEventFunction, func)
3366 #define wxNavigationKeyEventHandler(func) \
3367 wxEVENT_HANDLER_CAST(wxNavigationKeyEventFunction, func)
3368 #define wxPaletteChangedEventHandler(func) \
3369 wxEVENT_HANDLER_CAST(wxPaletteChangedEventFunction, func)
3370 #define wxQueryNewPaletteEventHandler(func) \
3371 wxEVENT_HANDLER_CAST(wxQueryNewPaletteEventFunction, func)
3372 #define wxWindowCreateEventHandler(func) \
3373 wxEVENT_HANDLER_CAST(wxWindowCreateEventFunction, func)
3374 #define wxWindowDestroyEventHandler(func) \
3375 wxEVENT_HANDLER_CAST(wxWindowDestroyEventFunction, func)
3376 #define wxSetCursorEventHandler(func) \
3377 wxEVENT_HANDLER_CAST(wxSetCursorEventFunction, func)
3378 #define wxNotifyEventHandler(func) \
3379 wxEVENT_HANDLER_CAST(wxNotifyEventFunction, func)
3380 #define wxHelpEventHandler(func) \
3381 wxEVENT_HANDLER_CAST(wxHelpEventFunction, func)
3382 #define wxContextMenuEventHandler(func) \
3383 wxEVENT_HANDLER_CAST(wxContextMenuEventFunction, func)
3384 #define wxMouseCaptureChangedEventHandler(func) \
3385 wxEVENT_HANDLER_CAST(wxMouseCaptureChangedEventFunction, func)
3386 #define wxMouseCaptureLostEventHandler(func) \
3387 wxEVENT_HANDLER_CAST(wxMouseCaptureLostEventFunction, func)
3388 #define wxClipboardTextEventHandler(func) \
3389 wxEVENT_HANDLER_CAST(wxClipboardTextEventFunction, func)
3393 // N.B. In GNU-WIN32, you *have* to take the address of a member function
3394 // (use &) or the compiler crashes...
3396 #define DECLARE_EVENT_TABLE() \
3398 static const wxEventTableEntry sm_eventTableEntries[]; \
3400 static const wxEventTable sm_eventTable; \
3401 virtual const wxEventTable* GetEventTable() const; \
3402 static wxEventHashTable sm_eventHashTable; \
3403 virtual wxEventHashTable& GetEventHashTable() const;
3405 // N.B.: when building DLL with Borland C++ 5.5 compiler, you must initialize
3406 // sm_eventTable before using it in GetEventTable() or the compiler gives
3407 // E2233 (see http://groups.google.com/groups?selm=397dcc8a%241_2%40dnews)
3409 #define BEGIN_EVENT_TABLE(theClass, baseClass) \
3410 const wxEventTable theClass::sm_eventTable = \
3411 { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] }; \
3412 const wxEventTable *theClass::GetEventTable() const \
3413 { return &theClass::sm_eventTable; } \
3414 wxEventHashTable theClass::sm_eventHashTable(theClass::sm_eventTable); \
3415 wxEventHashTable &theClass::GetEventHashTable() const \
3416 { return theClass::sm_eventHashTable; } \
3417 const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
3419 #define BEGIN_EVENT_TABLE_TEMPLATE1(theClass, baseClass, T1) \
3420 template<typename T1> \
3421 const wxEventTable theClass<T1>::sm_eventTable = \
3422 { &baseClass::sm_eventTable, &theClass<T1>::sm_eventTableEntries[0] }; \
3423 template<typename T1> \
3424 const wxEventTable *theClass<T1>::GetEventTable() const \
3425 { return &theClass<T1>::sm_eventTable; } \
3426 template<typename T1> \
3427 wxEventHashTable theClass<T1>::sm_eventHashTable(theClass<T1>::sm_eventTable); \
3428 template<typename T1> \
3429 wxEventHashTable &theClass<T1>::GetEventHashTable() const \
3430 { return theClass<T1>::sm_eventHashTable; } \
3431 template<typename T1> \
3432 const wxEventTableEntry theClass<T1>::sm_eventTableEntries[] = { \
3434 #define BEGIN_EVENT_TABLE_TEMPLATE2(theClass, baseClass, T1, T2) \
3435 template<typename T1, typename T2> \
3436 const wxEventTable theClass<T1, T2>::sm_eventTable = \
3437 { &baseClass::sm_eventTable, &theClass<T1, T2>::sm_eventTableEntries[0] }; \
3438 template<typename T1, typename T2> \
3439 const wxEventTable *theClass<T1, T2>::GetEventTable() const \
3440 { return &theClass<T1, T2>::sm_eventTable; } \
3441 template<typename T1, typename T2> \
3442 wxEventHashTable theClass<T1, T2>::sm_eventHashTable(theClass<T1, T2>::sm_eventTable); \
3443 template<typename T1, typename T2> \
3444 wxEventHashTable &theClass<T1, T2>::GetEventHashTable() const \
3445 { return theClass<T1, T2>::sm_eventHashTable; } \
3446 template<typename T1, typename T2> \
3447 const wxEventTableEntry theClass<T1, T2>::sm_eventTableEntries[] = { \
3449 #define BEGIN_EVENT_TABLE_TEMPLATE3(theClass, baseClass, T1, T2, T3) \
3450 template<typename T1, typename T2, typename T3> \
3451 const wxEventTable theClass<T1, T2, T3>::sm_eventTable = \
3452 { &baseClass::sm_eventTable, &theClass<T1, T2, T3>::sm_eventTableEntries[0] }; \
3453 template<typename T1, typename T2, typename T3> \
3454 const wxEventTable *theClass<T1, T2, T3>::GetEventTable() const \
3455 { return &theClass<T1, T2, T3>::sm_eventTable; } \
3456 template<typename T1, typename T2, typename T3> \
3457 wxEventHashTable theClass<T1, T2, T3>::sm_eventHashTable(theClass<T1, T2, T3>::sm_eventTable); \
3458 template<typename T1, typename T2, typename T3> \
3459 wxEventHashTable &theClass<T1, T2, T3>::GetEventHashTable() const \
3460 { return theClass<T1, T2, T3>::sm_eventHashTable; } \
3461 template<typename T1, typename T2, typename T3> \
3462 const wxEventTableEntry theClass<T1, T2, T3>::sm_eventTableEntries[] = { \
3464 #define BEGIN_EVENT_TABLE_TEMPLATE4(theClass, baseClass, T1, T2, T3, T4) \
3465 template<typename T1, typename T2, typename T3, typename T4> \
3466 const wxEventTable theClass<T1, T2, T3, T4>::sm_eventTable = \
3467 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4>::sm_eventTableEntries[0] }; \
3468 template<typename T1, typename T2, typename T3, typename T4> \
3469 const wxEventTable *theClass<T1, T2, T3, T4>::GetEventTable() const \
3470 { return &theClass<T1, T2, T3, T4>::sm_eventTable; } \
3471 template<typename T1, typename T2, typename T3, typename T4> \
3472 wxEventHashTable theClass<T1, T2, T3, T4>::sm_eventHashTable(theClass<T1, T2, T3, T4>::sm_eventTable); \
3473 template<typename T1, typename T2, typename T3, typename T4> \
3474 wxEventHashTable &theClass<T1, T2, T3, T4>::GetEventHashTable() const \
3475 { return theClass<T1, T2, T3, T4>::sm_eventHashTable; } \
3476 template<typename T1, typename T2, typename T3, typename T4> \
3477 const wxEventTableEntry theClass<T1, T2, T3, T4>::sm_eventTableEntries[] = { \
3479 #define BEGIN_EVENT_TABLE_TEMPLATE5(theClass, baseClass, T1, T2, T3, T4, T5) \
3480 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3481 const wxEventTable theClass<T1, T2, T3, T4, T5>::sm_eventTable = \
3482 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[0] }; \
3483 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3484 const wxEventTable *theClass<T1, T2, T3, T4, T5>::GetEventTable() const \
3485 { return &theClass<T1, T2, T3, T4, T5>::sm_eventTable; } \
3486 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3487 wxEventHashTable theClass<T1, T2, T3, T4, T5>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5>::sm_eventTable); \
3488 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3489 wxEventHashTable &theClass<T1, T2, T3, T4, T5>::GetEventHashTable() const \
3490 { return theClass<T1, T2, T3, T4, T5>::sm_eventHashTable; } \
3491 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3492 const wxEventTableEntry theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[] = { \
3494 #define BEGIN_EVENT_TABLE_TEMPLATE7(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7) \
3495 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3496 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable = \
3497 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[0] }; \
3498 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3499 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventTable() const \
3500 { return &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable; } \
3501 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3502 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable); \
3503 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3504 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventHashTable() const \
3505 { return theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable; } \
3506 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3507 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[] = { \
3509 #define BEGIN_EVENT_TABLE_TEMPLATE8(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7, T8) \
3510 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3511 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable = \
3512 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[0] }; \
3513 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3514 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventTable() const \
3515 { return &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable; } \
3516 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3517 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable); \
3518 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3519 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventHashTable() const \
3520 { return theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable; } \
3521 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3522 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[] = { \
3524 #define END_EVENT_TABLE() DECLARE_EVENT_TABLE_TERMINATOR() };
3527 * Event table macros
3530 // helpers for writing shorter code below: declare an event macro taking 2, 1
3531 // or none ids (the missing ids default to wxID_ANY)
3534 // - evt one of wxEVT_XXX constants
3535 // - id1, id2 ids of the first/last id
3536 // - fn the function (should be cast to the right type)
3537 #define wx__DECLARE_EVT2(evt, id1, id2, fn) \
3538 DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
3539 #define wx__DECLARE_EVT1(evt, id, fn) \
3540 wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
3541 #define wx__DECLARE_EVT0(evt, fn) \
3542 wx__DECLARE_EVT1(evt, wxID_ANY, fn)
3546 #define EVT_CUSTOM(event, winid, func) \
3547 wx__DECLARE_EVT1(event, winid, wxEventHandler(func))
3548 #define EVT_CUSTOM_RANGE(event, id1, id2, func) \
3549 wx__DECLARE_EVT2(event, id1, id2, wxEventHandler(func))
3552 #define EVT_COMMAND(winid, event, func) \
3553 wx__DECLARE_EVT1(event, winid, wxCommandEventHandler(func))
3555 #define EVT_COMMAND_RANGE(id1, id2, event, func) \
3556 wx__DECLARE_EVT2(event, id1, id2, wxCommandEventHandler(func))
3558 #define EVT_NOTIFY(event, winid, func) \
3559 wx__DECLARE_EVT1(event, winid, wxNotifyEventHandler(func))
3561 #define EVT_NOTIFY_RANGE(event, id1, id2, func) \
3562 wx__DECLARE_EVT2(event, id1, id2, wxNotifyEventHandler(func))
3565 #define EVT_SIZE(func) wx__DECLARE_EVT0(wxEVT_SIZE, wxSizeEventHandler(func))
3566 #define EVT_SIZING(func) wx__DECLARE_EVT0(wxEVT_SIZING, wxSizeEventHandler(func))
3567 #define EVT_MOVE(func) wx__DECLARE_EVT0(wxEVT_MOVE, wxMoveEventHandler(func))
3568 #define EVT_MOVING(func) wx__DECLARE_EVT0(wxEVT_MOVING, wxMoveEventHandler(func))
3569 #define EVT_MOVE_START(func) wx__DECLARE_EVT0(wxEVT_MOVE_START, wxMoveEventHandler(func))
3570 #define EVT_MOVE_END(func) wx__DECLARE_EVT0(wxEVT_MOVE_END, wxMoveEventHandler(func))
3571 #define EVT_CLOSE(func) wx__DECLARE_EVT0(wxEVT_CLOSE_WINDOW, wxCloseEventHandler(func))
3572 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3573 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3574 #define EVT_PAINT(func) wx__DECLARE_EVT0(wxEVT_PAINT, wxPaintEventHandler(func))
3575 #define EVT_NC_PAINT(func) wx__DECLARE_EVT0(wxEVT_NC_PAINT, wxNcPaintEventHandler(func))
3576 #define EVT_ERASE_BACKGROUND(func) wx__DECLARE_EVT0(wxEVT_ERASE_BACKGROUND, wxEraseEventHandler(func))
3577 #define EVT_CHAR(func) wx__DECLARE_EVT0(wxEVT_CHAR, wxCharEventHandler(func))
3578 #define EVT_KEY_DOWN(func) wx__DECLARE_EVT0(wxEVT_KEY_DOWN, wxKeyEventHandler(func))
3579 #define EVT_KEY_UP(func) wx__DECLARE_EVT0(wxEVT_KEY_UP, wxKeyEventHandler(func))
3581 #define EVT_HOTKEY(winid, func) wx__DECLARE_EVT1(wxEVT_HOTKEY, winid, wxCharEventHandler(func))
3583 #define EVT_CHAR_HOOK(func) wx__DECLARE_EVT0(wxEVT_CHAR_HOOK, wxCharEventHandler(func))
3584 #define EVT_MENU_OPEN(func) wx__DECLARE_EVT0(wxEVT_MENU_OPEN, wxMenuEventHandler(func))
3585 #define EVT_MENU_CLOSE(func) wx__DECLARE_EVT0(wxEVT_MENU_CLOSE, wxMenuEventHandler(func))
3586 #define EVT_MENU_HIGHLIGHT(winid, func) wx__DECLARE_EVT1(wxEVT_MENU_HIGHLIGHT, winid, wxMenuEventHandler(func))
3587 #define EVT_MENU_HIGHLIGHT_ALL(func) wx__DECLARE_EVT0(wxEVT_MENU_HIGHLIGHT, wxMenuEventHandler(func))
3588 #define EVT_SET_FOCUS(func) wx__DECLARE_EVT0(wxEVT_SET_FOCUS, wxFocusEventHandler(func))
3589 #define EVT_KILL_FOCUS(func) wx__DECLARE_EVT0(wxEVT_KILL_FOCUS, wxFocusEventHandler(func))
3590 #define EVT_CHILD_FOCUS(func) wx__DECLARE_EVT0(wxEVT_CHILD_FOCUS, wxChildFocusEventHandler(func))
3591 #define EVT_ACTIVATE(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE, wxActivateEventHandler(func))
3592 #define EVT_ACTIVATE_APP(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE_APP, wxActivateEventHandler(func))
3593 #define EVT_HIBERNATE(func) wx__DECLARE_EVT0(wxEVT_HIBERNATE, wxActivateEventHandler(func))
3594 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3595 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3596 #define EVT_DROP_FILES(func) wx__DECLARE_EVT0(wxEVT_DROP_FILES, wxDropFilesEventHandler(func))
3597 #define EVT_INIT_DIALOG(func) wx__DECLARE_EVT0(wxEVT_INIT_DIALOG, wxInitDialogEventHandler(func))
3598 #define EVT_SYS_COLOUR_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEventHandler(func))
3599 #define EVT_DISPLAY_CHANGED(func) wx__DECLARE_EVT0(wxEVT_DISPLAY_CHANGED, wxDisplayChangedEventHandler(func))
3600 #define EVT_SHOW(func) wx__DECLARE_EVT0(wxEVT_SHOW, wxShowEventHandler(func))
3601 #define EVT_MAXIMIZE(func) wx__DECLARE_EVT0(wxEVT_MAXIMIZE, wxMaximizeEventHandler(func))
3602 #define EVT_ICONIZE(func) wx__DECLARE_EVT0(wxEVT_ICONIZE, wxIconizeEventHandler(func))
3603 #define EVT_NAVIGATION_KEY(func) wx__DECLARE_EVT0(wxEVT_NAVIGATION_KEY, wxNavigationKeyEventHandler(func))
3604 #define EVT_PALETTE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_PALETTE_CHANGED, wxPaletteChangedEventHandler(func))
3605 #define EVT_QUERY_NEW_PALETTE(func) wx__DECLARE_EVT0(wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEventHandler(func))
3606 #define EVT_WINDOW_CREATE(func) wx__DECLARE_EVT0(wxEVT_CREATE, wxWindowCreateEventHandler(func))
3607 #define EVT_WINDOW_DESTROY(func) wx__DECLARE_EVT0(wxEVT_DESTROY, wxWindowDestroyEventHandler(func))
3608 #define EVT_SET_CURSOR(func) wx__DECLARE_EVT0(wxEVT_SET_CURSOR, wxSetCursorEventHandler(func))
3609 #define EVT_MOUSE_CAPTURE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEventHandler(func))
3610 #define EVT_MOUSE_CAPTURE_LOST(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEventHandler(func))
3613 #define EVT_LEFT_DOWN(func) wx__DECLARE_EVT0(wxEVT_LEFT_DOWN, wxMouseEventHandler(func))
3614 #define EVT_LEFT_UP(func) wx__DECLARE_EVT0(wxEVT_LEFT_UP, wxMouseEventHandler(func))
3615 #define EVT_MIDDLE_DOWN(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DOWN, wxMouseEventHandler(func))
3616 #define EVT_MIDDLE_UP(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_UP, wxMouseEventHandler(func))
3617 #define EVT_RIGHT_DOWN(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DOWN, wxMouseEventHandler(func))
3618 #define EVT_RIGHT_UP(func) wx__DECLARE_EVT0(wxEVT_RIGHT_UP, wxMouseEventHandler(func))
3619 #define EVT_MOTION(func) wx__DECLARE_EVT0(wxEVT_MOTION, wxMouseEventHandler(func))
3620 #define EVT_LEFT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_LEFT_DCLICK, wxMouseEventHandler(func))
3621 #define EVT_MIDDLE_DCLICK(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DCLICK, wxMouseEventHandler(func))
3622 #define EVT_RIGHT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DCLICK, wxMouseEventHandler(func))
3623 #define EVT_LEAVE_WINDOW(func) wx__DECLARE_EVT0(wxEVT_LEAVE_WINDOW, wxMouseEventHandler(func))
3624 #define EVT_ENTER_WINDOW(func) wx__DECLARE_EVT0(wxEVT_ENTER_WINDOW, wxMouseEventHandler(func))
3625 #define EVT_MOUSEWHEEL(func) wx__DECLARE_EVT0(wxEVT_MOUSEWHEEL, wxMouseEventHandler(func))
3626 #define EVT_MOUSE_AUX1_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX1_DOWN, wxMouseEventHandler(func))
3627 #define EVT_MOUSE_AUX1_UP(func) wx__DECLARE_EVT0(wxEVT_AUX1_UP, wxMouseEventHandler(func))
3628 #define EVT_MOUSE_AUX1_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX1_DCLICK, wxMouseEventHandler(func))
3629 #define EVT_MOUSE_AUX2_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX2_DOWN, wxMouseEventHandler(func))
3630 #define EVT_MOUSE_AUX2_UP(func) wx__DECLARE_EVT0(wxEVT_AUX2_UP, wxMouseEventHandler(func))
3631 #define EVT_MOUSE_AUX2_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX2_DCLICK, wxMouseEventHandler(func))
3634 #define EVT_MOUSE_EVENTS(func) \
3635 EVT_LEFT_DOWN(func) \
3637 EVT_LEFT_DCLICK(func) \
3638 EVT_MIDDLE_DOWN(func) \
3639 EVT_MIDDLE_UP(func) \
3640 EVT_MIDDLE_DCLICK(func) \
3641 EVT_RIGHT_DOWN(func) \
3642 EVT_RIGHT_UP(func) \
3643 EVT_RIGHT_DCLICK(func) \
3644 EVT_MOUSE_AUX1_DOWN(func) \
3645 EVT_MOUSE_AUX1_UP(func) \
3646 EVT_MOUSE_AUX1_DCLICK(func) \
3647 EVT_MOUSE_AUX2_DOWN(func) \
3648 EVT_MOUSE_AUX2_UP(func) \
3649 EVT_MOUSE_AUX2_DCLICK(func) \
3651 EVT_LEAVE_WINDOW(func) \
3652 EVT_ENTER_WINDOW(func) \
3653 EVT_MOUSEWHEEL(func)
3655 // Scrolling from wxWindow (sent to wxScrolledWindow)
3656 #define EVT_SCROLLWIN_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_TOP, wxScrollWinEventHandler(func))
3657 #define EVT_SCROLLWIN_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEventHandler(func))
3658 #define EVT_SCROLLWIN_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEUP, wxScrollWinEventHandler(func))
3659 #define EVT_SCROLLWIN_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEventHandler(func))
3660 #define EVT_SCROLLWIN_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEventHandler(func))
3661 #define EVT_SCROLLWIN_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEventHandler(func))
3662 #define EVT_SCROLLWIN_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEventHandler(func))
3663 #define EVT_SCROLLWIN_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEventHandler(func))
3665 #define EVT_SCROLLWIN(func) \
3666 EVT_SCROLLWIN_TOP(func) \
3667 EVT_SCROLLWIN_BOTTOM(func) \
3668 EVT_SCROLLWIN_LINEUP(func) \
3669 EVT_SCROLLWIN_LINEDOWN(func) \
3670 EVT_SCROLLWIN_PAGEUP(func) \
3671 EVT_SCROLLWIN_PAGEDOWN(func) \
3672 EVT_SCROLLWIN_THUMBTRACK(func) \
3673 EVT_SCROLLWIN_THUMBRELEASE(func)
3675 // Scrolling from wxSlider and wxScrollBar
3676 #define EVT_SCROLL_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_TOP, wxScrollEventHandler(func))
3677 #define EVT_SCROLL_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLL_BOTTOM, wxScrollEventHandler(func))
3678 #define EVT_SCROLL_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEUP, wxScrollEventHandler(func))
3679 #define EVT_SCROLL_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEDOWN, wxScrollEventHandler(func))
3680 #define EVT_SCROLL_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEUP, wxScrollEventHandler(func))
3681 #define EVT_SCROLL_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler(func))
3682 #define EVT_SCROLL_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler(func))
3683 #define EVT_SCROLL_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBRELEASE, wxScrollEventHandler(func))
3684 #define EVT_SCROLL_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SCROLL_CHANGED, wxScrollEventHandler(func))
3686 #define EVT_SCROLL(func) \
3687 EVT_SCROLL_TOP(func) \
3688 EVT_SCROLL_BOTTOM(func) \
3689 EVT_SCROLL_LINEUP(func) \
3690 EVT_SCROLL_LINEDOWN(func) \
3691 EVT_SCROLL_PAGEUP(func) \
3692 EVT_SCROLL_PAGEDOWN(func) \
3693 EVT_SCROLL_THUMBTRACK(func) \
3694 EVT_SCROLL_THUMBRELEASE(func) \
3695 EVT_SCROLL_CHANGED(func)
3697 // Scrolling from wxSlider and wxScrollBar, with an id
3698 #define EVT_COMMAND_SCROLL_TOP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_TOP, winid, wxScrollEventHandler(func))
3699 #define EVT_COMMAND_SCROLL_BOTTOM(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_BOTTOM, winid, wxScrollEventHandler(func))
3700 #define EVT_COMMAND_SCROLL_LINEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEUP, winid, wxScrollEventHandler(func))
3701 #define EVT_COMMAND_SCROLL_LINEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEDOWN, winid, wxScrollEventHandler(func))
3702 #define EVT_COMMAND_SCROLL_PAGEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEUP, winid, wxScrollEventHandler(func))
3703 #define EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEDOWN, winid, wxScrollEventHandler(func))
3704 #define EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBTRACK, winid, wxScrollEventHandler(func))
3705 #define EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBRELEASE, winid, wxScrollEventHandler(func))
3706 #define EVT_COMMAND_SCROLL_CHANGED(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_CHANGED, winid, wxScrollEventHandler(func))
3708 #define EVT_COMMAND_SCROLL(winid, func) \
3709 EVT_COMMAND_SCROLL_TOP(winid, func) \
3710 EVT_COMMAND_SCROLL_BOTTOM(winid, func) \
3711 EVT_COMMAND_SCROLL_LINEUP(winid, func) \
3712 EVT_COMMAND_SCROLL_LINEDOWN(winid, func) \
3713 EVT_COMMAND_SCROLL_PAGEUP(winid, func) \
3714 EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) \
3715 EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) \
3716 EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) \
3717 EVT_COMMAND_SCROLL_CHANGED(winid, func)
3719 #if WXWIN_COMPATIBILITY_2_6
3720 // compatibility macros for the old name, deprecated in 2.8
3721 #define wxEVT_SCROLL_ENDSCROLL wxEVT_SCROLL_CHANGED
3722 #define EVT_COMMAND_SCROLL_ENDSCROLL EVT_COMMAND_SCROLL_CHANGED
3723 #define EVT_SCROLL_ENDSCROLL EVT_SCROLL_CHANGED
3724 #endif // WXWIN_COMPATIBILITY_2_6
3726 // Convenience macros for commonly-used commands
3727 #define EVT_CHECKBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKBOX_CLICKED, winid, wxCommandEventHandler(func))
3728 #define EVT_CHOICE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHOICE_SELECTED, winid, wxCommandEventHandler(func))
3729 #define EVT_LISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_SELECTED, winid, wxCommandEventHandler(func))
3730 #define EVT_LISTBOX_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, winid, wxCommandEventHandler(func))
3731 #define EVT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_MENU_SELECTED, winid, wxCommandEventHandler(func))
3732 #define EVT_MENU_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_MENU_SELECTED, id1, id2, wxCommandEventHandler(func))
3733 #if defined(__SMARTPHONE__)
3734 # define EVT_BUTTON(winid, func) EVT_MENU(winid, func)
3736 # define EVT_BUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_BUTTON_CLICKED, winid, wxCommandEventHandler(func))
3738 #define EVT_SLIDER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SLIDER_UPDATED, winid, wxCommandEventHandler(func))
3739 #define EVT_RADIOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBOX_SELECTED, winid, wxCommandEventHandler(func))
3740 #define EVT_RADIOBUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBUTTON_SELECTED, winid, wxCommandEventHandler(func))
3741 // EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events
3742 #define EVT_SCROLLBAR(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SCROLLBAR_UPDATED, winid, wxCommandEventHandler(func))
3743 #define EVT_VLBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_VLBOX_SELECTED, winid, wxCommandEventHandler(func))
3744 #define EVT_COMBOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_SELECTED, winid, wxCommandEventHandler(func))
3745 #define EVT_TOOL(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_CLICKED, winid, wxCommandEventHandler(func))
3746 #define EVT_TOOL_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, winid, wxCommandEventHandler(func))
3747 #define EVT_TOOL_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_CLICKED, id1, id2, wxCommandEventHandler(func))
3748 #define EVT_TOOL_RCLICKED(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_RCLICKED, winid, wxCommandEventHandler(func))
3749 #define EVT_TOOL_RCLICKED_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, wxCommandEventHandler(func))
3750 #define EVT_TOOL_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_ENTER, winid, wxCommandEventHandler(func))
3751 #define EVT_CHECKLISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, winid, wxCommandEventHandler(func))
3753 // Generic command events
3754 #define EVT_COMMAND_LEFT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_CLICK, winid, wxCommandEventHandler(func))
3755 #define EVT_COMMAND_LEFT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_DCLICK, winid, wxCommandEventHandler(func))
3756 #define EVT_COMMAND_RIGHT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_CLICK, winid, wxCommandEventHandler(func))
3757 #define EVT_COMMAND_RIGHT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_DCLICK, winid, wxCommandEventHandler(func))
3758 #define EVT_COMMAND_SET_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SET_FOCUS, winid, wxCommandEventHandler(func))
3759 #define EVT_COMMAND_KILL_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_KILL_FOCUS, winid, wxCommandEventHandler(func))
3760 #define EVT_COMMAND_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_ENTER, winid, wxCommandEventHandler(func))
3764 #define EVT_JOY_BUTTON_DOWN(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_DOWN, wxJoystickEventHandler(func))
3765 #define EVT_JOY_BUTTON_UP(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_UP, wxJoystickEventHandler(func))
3766 #define EVT_JOY_MOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_MOVE, wxJoystickEventHandler(func))
3767 #define EVT_JOY_ZMOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_ZMOVE, wxJoystickEventHandler(func))
3769 // All joystick events
3770 #define EVT_JOYSTICK_EVENTS(func) \
3771 EVT_JOY_BUTTON_DOWN(func) \
3772 EVT_JOY_BUTTON_UP(func) \
3773 EVT_JOY_MOVE(func) \
3777 #define EVT_IDLE(func) wx__DECLARE_EVT0(wxEVT_IDLE, wxIdleEventHandler(func))
3780 #define EVT_UPDATE_UI(winid, func) wx__DECLARE_EVT1(wxEVT_UPDATE_UI, winid, wxUpdateUIEventHandler(func))
3781 #define EVT_UPDATE_UI_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_UPDATE_UI, id1, id2, wxUpdateUIEventHandler(func))
3784 #define EVT_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_HELP, winid, wxHelpEventHandler(func))
3785 #define EVT_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_HELP, id1, id2, wxHelpEventHandler(func))
3786 #define EVT_DETAILED_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_DETAILED_HELP, winid, wxHelpEventHandler(func))
3787 #define EVT_DETAILED_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_DETAILED_HELP, id1, id2, wxHelpEventHandler(func))
3789 // Context Menu Events
3790 #define EVT_CONTEXT_MENU(func) wx__DECLARE_EVT0(wxEVT_CONTEXT_MENU, wxContextMenuEventHandler(func))
3791 #define EVT_COMMAND_CONTEXT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_CONTEXT_MENU, winid, wxContextMenuEventHandler(func))
3793 // Clipboard text Events
3794 #define EVT_TEXT_CUT(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_CUT, winid, wxClipboardTextEventHandler(func))
3795 #define EVT_TEXT_COPY(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_COPY, winid, wxClipboardTextEventHandler(func))
3796 #define EVT_TEXT_PASTE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_PASTE, winid, wxClipboardTextEventHandler(func))
3798 // ----------------------------------------------------------------------------
3800 // ----------------------------------------------------------------------------
3802 // list containing event handlers with pending events for them
3804 // notice that each event handler should occur at most once in this list
3805 extern WXDLLIMPEXP_BASE wxList
*wxHandlersWithPendingEvents
;
3807 extern WXDLLIMPEXP_BASE wxCriticalSection
*wxHandlersWithPendingEventsLocker
;
3810 // ----------------------------------------------------------------------------
3812 // ----------------------------------------------------------------------------
3816 // Find a window with the focus, that is also a descendant of the given window.
3817 // This is used to determine the window to initially send commands to.
3818 WXDLLIMPEXP_CORE wxWindow
* wxFindFocusDescendant(wxWindow
* ancestor
);
3822 #endif // _WX_EVENT_H_