disable new event code unconditionally for now
[wxWidgets.git] / include / wx / event.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/event.h
3 // Purpose: Event classes
4 // Author: Julian Smart
5 // Modified by:
6 // Created: 01/02/97
7 // RCS-ID: $Id$
8 // Copyright: (c) wxWidgets team
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_EVENT_H_
13 #define _WX_EVENT_H_
14
15 #include "wx/defs.h"
16 #include "wx/cpp.h"
17 #include "wx/object.h"
18 #include "wx/clntdata.h"
19
20 #if wxUSE_GUI
21 #include "wx/gdicmn.h"
22 #include "wx/cursor.h"
23 #include "wx/mousestate.h"
24 #endif
25
26 #include "wx/dynarray.h"
27 #include "wx/thread.h"
28 #include "wx/tracker.h"
29
30 // ----------------------------------------------------------------------------
31 // forward declarations
32 // ----------------------------------------------------------------------------
33
34 class WXDLLIMPEXP_FWD_BASE wxList;
35 class WXDLLIMPEXP_FWD_BASE wxEvent;
36 #if wxUSE_GUI
37 class WXDLLIMPEXP_FWD_CORE wxDC;
38 class WXDLLIMPEXP_FWD_CORE wxMenu;
39 class WXDLLIMPEXP_FWD_CORE wxWindow;
40 class WXDLLIMPEXP_FWD_CORE wxWindowBase;
41 #endif // wxUSE_GUI
42
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
53 // wxEvtHandler.
54 #ifdef __VISUALC__
55 #define wxMSVC_FWD_MULTIPLE_BASES __multiple_inheritance
56 #else
57 #define wxMSVC_FWD_MULTIPLE_BASES
58 #endif
59
60 class WXDLLIMPEXP_FWD_BASE wxMSVC_FWD_MULTIPLE_BASES wxEvtHandler;
61 class wxEventConnectionRef;
62
63 // ----------------------------------------------------------------------------
64 // Event types
65 // ----------------------------------------------------------------------------
66
67 typedef int wxEventType;
68
69 #define wxEVT_ANY ((wxEventType)-1)
70
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)
74
75 #define DECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj) \
76 wxEventTableEntry(type, winid, idLast, wxNewEventFunctor(type, fn), obj)
77
78 #define DECLARE_EVENT_TABLE_TERMINATOR() \
79 wxEventTableEntry(wxEVT_NULL, 0, 0, 0, 0)
80
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)
93
94 // generate a new unique event type
95 extern WXDLLIMPEXP_BASE wxEventType wxNewEventType();
96
97 // FIXME: currently the new events code is disabled because it creates too
98 // many problems, it should be reenabled a.s.a.p. or removed
99 #undef wxEVENTS_COMPATIBILITY_2_8
100 #define wxEVENTS_COMPATIBILITY_2_8 1
101
102 // macros to create an event type depending on whether type safe events are
103 // enabled.
104
105 #if wxEVENTS_COMPATIBILITY_2_8
106 #define wxDEFINE_EVENT( name, type ) \
107 const wxEventType name( wxNewEventType() );
108
109 #define wxDECLARE_EXPORTED_EVENT( expdecl, name, type ) \
110 extern const expdecl wxEventType name;
111
112 #define wxDEFINE_EVENT_REFERENCE( name, type, value ) \
113 const wxEventType& name = value;
114
115 #define wxDECLARE_EXPORTED_EVENT_REFERENCE( expdecl, name, type ) \
116 extern const expdecl wxEventType& name;
117
118 #define wxDECLARE_LOCAL_EVENT( name, type ) \
119 wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type )
120
121 #define wxEVENT_HANDLER_CAST( functype, func ) \
122 ( wxObjectEventFunction )( wxEventFunction )wxStaticCastEvent( functype, &func )
123 #else
124 #define wxDEFINE_EVENT( name, type ) \
125 const wxTypedEventType< type > name( wxNewEventType() );
126
127 #define wxDECLARE_EXPORTED_EVENT( expdecl, name, type ) \
128 extern const expdecl wxTypedEventType< type > name;
129
130 #define wxDEFINE_EVENT_REFERENCE( name, type, value ) \
131 const wxTypedEventTypeReference< type > name( value );
132
133 #define wxDECLARE_EXPORTED_EVENT_REFERENCE( expdecl, name, type ) \
134 extern const expdecl wxTypedEventTypeReference< type > name;
135
136 #define wxDECLARE_LOCAL_EVENT( name, type ) \
137 wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type )
138
139 #define wxEVENT_HANDLER_CAST( functype, func ) \
140 ( &func )
141 #endif
142
143 // template which associates the correct event object with the event type
144
145 #if !wxEVENTS_COMPATIBILITY_2_8
146
147 template <typename Event>
148 class WXDLLIMPEXP_BASE wxTypedEventType
149 {
150 public:
151 typedef Event CorrespondingEvent;
152
153 wxTypedEventType(wxEventType type) { m_type = type; }
154
155 // used for static event tables
156 operator const wxEventType&() const { return m_type; }
157
158 private:
159 wxEventType m_type;
160 };
161
162 // Due to a bug in older wx versions wxSpinEvents were being sent with type of
163 // wxEVT_SCROLL_LINEUP, wxEVT_SCROLL_LINEDOWN and wxEVT_SCROLL_THUMBTRACK. But
164 // with the type-safe events in place, these event types are associated with
165 // wxScrollEvent. To allow handling of spin events, new event types have been
166 // defined in spinbutt.h/spinnbuttcmn.cpp. To maintain backward compatibility
167 // the spin event types are being initialized with the scroll event types. But
168 // this presents as with the same static initialization order problem we also
169 // have for the static event tables. So we use the same solution and the
170 // template definition below holds a reference to a wxEventType.
171 template <typename Event>
172 class WXDLLIMPEXP_BASE wxTypedEventTypeReference
173 {
174 public:
175 typedef Event CorrespondingEvent;
176
177 wxTypedEventTypeReference(const wxEventType& type) : m_type(type) { }
178
179 // used for static event tables
180 operator const wxEventType&() const { return m_type; }
181
182 private:
183 const wxEventType &m_type;
184 };
185
186 #endif // !wxEVENTS_COMPATIBILITY_2_8
187
188 // These are needed for the functor definitions
189 typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&);
190
191 // We had some trouble (specifically with eVC for ARM WinCE build) with using
192 // wxEventFunction in the past so we had introduced wxObjectEventFunction which
193 // used to be a typedef for a member of wxObject and not wxEvtHandler to work
194 // around this but as eVC is not really supported any longer we now only keep
195 // this for backwards compatibility and, despite its name, this is a typedef
196 // for wxEvtHandler member now -- but if we have the same problem with another
197 // compiler we can restore its old definition for it.
198 typedef wxEventFunction wxObjectEventFunction;
199
200
201 // the functors which will be stored in the static/dynamic tables
202 class WXDLLIMPEXP_BASE wxEventFunctor
203 {
204 public:
205 virtual ~wxEventFunctor();
206
207 // this operator is used to actually invoke the event handler
208 virtual void operator()(wxEvtHandler *, wxEvent &) = 0;
209
210 // this function tests whether this functor is matched, for the purpose of
211 // finding it in an event table in Disconnect(), by the given func
212 virtual bool Matches(const wxEventFunctor& func) const = 0;
213
214 virtual wxEvtHandler *GetHandler() const { return NULL; }
215
216 virtual wxObjectEventFunction GetMethod() const { return NULL; }
217 };
218
219 // A plain method functor
220 class WXDLLIMPEXP_BASE wxObjectEventFunctor : public wxEventFunctor
221 {
222 public:
223 wxObjectEventFunctor(wxObjectEventFunction method, wxEvtHandler *handler)
224 {
225 m_handler = handler;
226 m_method = method;
227 }
228
229 virtual void operator()(wxEvtHandler *handler, wxEvent& event)
230 {
231 wxEvtHandler * const realHandler = m_handler ? m_handler : handler;
232
233 (realHandler->*m_method)(event);
234 }
235
236 virtual bool Matches(const wxEventFunctor& other) const
237 {
238 wxEvtHandler * const handler = other.GetHandler();
239
240 return (m_handler == handler || !handler) &&
241 (m_method == other.GetMethod());
242 }
243
244 virtual wxEvtHandler *GetHandler() const { return m_handler; }
245 virtual wxObjectEventFunction GetMethod() const { return m_method; }
246
247 private:
248 wxEvtHandler *m_handler;
249 wxObjectEventFunction m_method;
250 };
251
252 // Create a functor for the legacy events: handler can be NULL and its default
253 // value is used by the event table macros
254
255 inline wxObjectEventFunctor *
256 wxNewEventFunctor(wxEventType WXUNUSED(evtType),
257 wxObjectEventFunction method,
258 wxEvtHandler *handler = NULL)
259 {
260 return new wxObjectEventFunctor(method, handler);
261 }
262
263 inline wxObjectEventFunctor
264 wxConstructEventFunctor(wxEventType WXUNUSED(evtType),
265 wxObjectEventFunction method,
266 wxEvtHandler *handler)
267 {
268 return wxObjectEventFunctor(method, handler);
269 }
270
271 #if !wxEVENTS_COMPATIBILITY_2_8
272
273 template <typename EventType>
274 class WXDLLIMPEXP_BASE wxEventFunctorFunction : public wxEventFunctor
275 {
276 public:
277 wxEventFunctorFunction(void (*handler)(typename EventType::CorrespondingEvent &))
278 {
279 m_handler = handler;
280 }
281
282 virtual void operator()(wxEvtHandler *WXUNUSED(handler), wxEvent& event)
283 {
284 // Protect against wrong event i.e. wxMouseEvent evt(wxEVT_PAINT):
285 wxASSERT( dynamic_cast< typename EventType::CorrespondingEvent * >( &event ) != NULL );
286
287 // Will throw a std::bad_cast exception in release build:
288 ( *m_handler )( dynamic_cast< typename EventType::CorrespondingEvent & >( event ));
289 }
290
291 virtual bool Matches( const wxEventFunctor &right ) const
292 {
293 wxEventFunctorFunction const &other = dynamic_cast< wxEventFunctorFunction const & >( right );
294
295 return m_handler == other.m_handler || other.m_handler == NULL;
296 }
297
298 private:
299 void ( *m_handler )( typename EventType::CorrespondingEvent & );
300 };
301
302
303 template <typename EventType, typename Class, typename Derived>
304 class WXDLLIMPEXP_BASE wxEventFunctorMethod : public wxEventFunctor
305 {
306 public:
307 wxEventFunctorMethod( void ( Class::*method )( typename EventType::CorrespondingEvent & ),
308 Derived *handler )
309 {
310 m_handler = handler;
311 m_method = method;
312 }
313
314 virtual void operator () ( wxEvtHandler *handler, wxEvent &event )
315 {
316 // Compile-time type check 1: This requires Derived to derive from or
317 // be of the same type as Class
318 Class *realHandler = m_handler;
319
320 if( m_handler == NULL )
321 {
322 // Verify that the handler does indeed derive from the class
323 // containing the handler method
324 wxASSERT( dynamic_cast< Class * >( handler) != NULL );
325
326 realHandler = dynamic_cast< Class * >( handler );
327 }
328
329 // Protect against wrong event i.e. wxMouseEvent evt(wxEVT_PAINT):
330 wxASSERT( dynamic_cast< typename EventType::CorrespondingEvent * >( &event ) != NULL );
331
332 // Will throw a std::bad_cast exception in release build:
333 ( realHandler->*m_method )( dynamic_cast< typename EventType::CorrespondingEvent & >( event ));
334 }
335
336 virtual bool Matches( const wxEventFunctor &right ) const
337 {
338 wxEventFunctorMethod const &other = dynamic_cast< wxEventFunctorMethod const & >( right );
339
340 return (( m_handler == other.m_handler || other.m_handler == NULL ) &&
341 ( m_method == other.m_method || other.m_method == NULL ));
342 }
343
344 virtual wxEvtHandler *GetHandler() const
345 {
346 // This makes sure Derived derives from wxEvtHandler (it is still
347 // possible and even ok if Class does not derive from wxEvtHandler. In
348 // this case Derived would end up using multiple inheritance: class
349 // Derived : public wxEvtHandler, public Class { } where Class contains
350 // the method to call, but wxEvtHandler contains the wxTrackable and
351 // code for weak ref support
352 return m_handler;
353 }
354
355 virtual wxObjectEventFunction GetMethod() const
356 {
357 return reinterpret_cast<wxObjectEventFunction>(m_method);
358 }
359
360 private:
361 Derived *m_handler;
362 void (Class::*m_method)(typename EventType::CorrespondingEvent&);
363 };
364
365
366 template <typename EventType, typename Functor>
367 class WXDLLIMPEXP_BASE wxEventFunctorAdapter : public wxEventFunctor
368 {
369 public:
370 wxEventFunctorAdapter( Functor &functor )
371 {
372 m_functor = functor;
373 }
374
375 virtual void operator () ( wxEvtHandler *WXUNUSED( handler ), wxEvent &event )
376 {
377 // Protect against wrong event i.e. wxMouseEvent evt(wxEVT_PAINT):
378 wxASSERT( dynamic_cast< typename EventType::CorrespondingEvent * >( &event ) != NULL );
379
380 // Will throw a std::bad_cast exception in release build:
381 m_functor( dynamic_cast< typename EventType::CorrespondingEvent & >( event ));
382 }
383
384 virtual bool Matches( const wxEventFunctor &right ) const
385 {
386 wxEventFunctorAdapter const &other = dynamic_cast< wxEventFunctorAdapter const & >( right );
387
388 return m_functor == other.m_functor;
389 }
390
391 private:
392 Functor m_functor;
393 };
394
395 //
396 // Create functors for the templatized events (needed in wxEvtHandler::Connect):
397 //
398
399 // Create a functor for functions:
400
401 template <typename EventType>
402 inline wxEventFunctorFunction<EventType> *
403 wxNewEventFunctor(const EventType &,
404 void (*function)(typename EventType::CorrespondingEvent&))
405 {
406 return new wxEventFunctorFunction<EventType>(function);
407 }
408
409 // Create a functor for methods:
410
411 template <typename EventType, typename Class>
412 inline wxEventFunctorMethod<EventType, Class, Class> *
413 wxNewEventFunctor(const EventType &,
414 void (Class::*method)(typename EventType::CorrespondingEvent&))
415 {
416 return new wxEventFunctorMethod<EventType, Class, Class>(method, NULL);
417 }
418
419 template <typename EventType, typename Class, typename Derived>
420 inline wxEventFunctorMethod<EventType, Class, Derived> *
421 wxNewEventFunctor(const EventType &,
422 void (Class::*method)(typename EventType::CorrespondingEvent &),
423 Derived *handler )
424 {
425 return new wxEventFunctorMethod<EventType, Class, Derived>(method, handler);
426 }
427
428 // Create a functor for arbitrary functors (like boost::function):
429 template <typename EventType, typename Functor>
430 inline wxEventFunctorAdapter<EventType, Functor> *
431 wxNewEventFunctor(const EventType &,
432 Functor& functor )
433 {
434 return new wxEventFunctorAdapter<EventType, Functor>(functor);
435 }
436
437 //
438 // Construct functors for the templatized events (needed in wxEvtHandler::Disconnect):
439 //
440
441 // Construct a functor for functions:
442
443 template <typename EventType>
444 inline wxEventFunctorFunction<EventType>
445 wxConstructEventFunctor(const EventType &,
446 void (*function)(typename EventType::CorrespondingEvent&))
447 {
448 return wxEventFunctorFunction<EventType>(function);
449 }
450
451 // Construct a functor for methods:
452
453 template <typename EventType, typename Class>
454 inline wxEventFunctorMethod<EventType, Class, Class>
455 wxConstructEventFunctor(const EventType &,
456 void (Class::*method)(typename EventType::CorrespondingEvent&))
457 {
458 return wxEventFunctorMethod<EventType, Class, Class>(method, NULL);
459 }
460
461 template <typename EventType, typename Class, typename Derived>
462 inline wxEventFunctorMethod<EventType, Class, Derived>
463 wxConstructEventFunctor(const EventType &,
464 void (Class::*method)(typename EventType::CorrespondingEvent&),
465 Derived *handler)
466 {
467 return wxEventFunctorMethod<EventType, Class, Derived>(method, handler);
468 }
469
470 // Construct a functor for arbitrary functors (like boost:function):
471
472 template <typename EventType, typename Functor>
473 inline wxEventFunctorAdapter<EventType, Functor>
474 wxConstructEventFunctor(const EventType &,
475 Functor& functor)
476 {
477 return wxEventFunctorAdapter<EventType, Functor>(functor);
478 }
479
480 #endif // !wxEVENTS_COMPATIBILITY_2_8
481
482 // many, but not all, standard event types
483
484 // some generic events
485 extern WXDLLIMPEXP_BASE const wxEventType wxEVT_NULL;
486 extern WXDLLIMPEXP_BASE const wxEventType wxEVT_FIRST;
487 extern WXDLLIMPEXP_BASE const wxEventType wxEVT_USER_FIRST;
488
489 // Need events declared to do this
490 class WXDLLIMPEXP_FWD_CORE wxCommandEvent;
491 class WXDLLIMPEXP_FWD_CORE wxMouseEvent;
492 class WXDLLIMPEXP_FWD_CORE wxFocusEvent;
493 class WXDLLIMPEXP_FWD_CORE wxChildFocusEvent;
494 class WXDLLIMPEXP_FWD_CORE wxKeyEvent;
495 class WXDLLIMPEXP_FWD_CORE wxNavigationKeyEvent;
496 class WXDLLIMPEXP_FWD_CORE wxSetCursorEvent;
497 class WXDLLIMPEXP_FWD_CORE wxScrollEvent;
498 class WXDLLIMPEXP_FWD_CORE wxScrollWinEvent;
499 class WXDLLIMPEXP_FWD_CORE wxSizeEvent;
500 class WXDLLIMPEXP_FWD_CORE wxMoveEvent;
501 class WXDLLIMPEXP_FWD_CORE wxCloseEvent;
502 class WXDLLIMPEXP_FWD_CORE wxActivateEvent;
503 class WXDLLIMPEXP_FWD_CORE wxWindowCreateEvent;
504 class WXDLLIMPEXP_FWD_CORE wxWindowDestroyEvent;
505 class WXDLLIMPEXP_FWD_CORE wxShowEvent;
506 class WXDLLIMPEXP_FWD_CORE wxIconizeEvent;
507 class WXDLLIMPEXP_FWD_CORE wxMaximizeEvent;
508 class WXDLLIMPEXP_FWD_CORE wxMouseCaptureChangedEvent;
509 class WXDLLIMPEXP_FWD_CORE wxMouseCaptureLostEvent;
510 class WXDLLIMPEXP_FWD_CORE wxPaintEvent;
511 class WXDLLIMPEXP_FWD_CORE wxEraseEvent;
512 class WXDLLIMPEXP_FWD_CORE wxNcPaintEvent;
513 class WXDLLIMPEXP_FWD_CORE wxMenuEvent;
514 class WXDLLIMPEXP_FWD_CORE wxContextMenuEvent;
515 class WXDLLIMPEXP_FWD_CORE wxSysColourChangedEvent;
516 class WXDLLIMPEXP_FWD_CORE wxDisplayChangedEvent;
517 class WXDLLIMPEXP_FWD_CORE wxQueryNewPaletteEvent;
518 class WXDLLIMPEXP_FWD_CORE wxPaletteChangedEvent;
519 class WXDLLIMPEXP_FWD_CORE wxJoystickEvent;
520 class WXDLLIMPEXP_FWD_CORE wxDropFilesEvent;
521 class WXDLLIMPEXP_FWD_CORE wxInitDialogEvent;
522 class WXDLLIMPEXP_FWD_CORE wxIdleEvent;
523 class WXDLLIMPEXP_FWD_CORE wxUpdateUIEvent;
524 class WXDLLIMPEXP_FWD_CORE wxClipboardTextEvent;
525 class WXDLLIMPEXP_FWD_CORE wxHelpEvent;
526
527
528 // Command events
529 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEvent)
530 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_CHECKBOX_CLICKED, wxCommandEvent)
531 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_CHOICE_SELECTED, wxCommandEvent)
532 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_LISTBOX_SELECTED, wxCommandEvent)
533 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, wxCommandEvent)
534 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, wxCommandEvent)
535 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_MENU_SELECTED, wxCommandEvent)
536 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_SLIDER_UPDATED, wxCommandEvent)
537 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_RADIOBOX_SELECTED, wxCommandEvent)
538 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_RADIOBUTTON_SELECTED, wxCommandEvent)
539
540 // wxEVT_COMMAND_SCROLLBAR_UPDATED is deprecated, use wxEVT_SCROLL... events
541 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_SCROLLBAR_UPDATED, wxCommandEvent)
542 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_VLBOX_SELECTED, wxCommandEvent)
543 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_COMBOBOX_SELECTED, wxCommandEvent)
544 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TOOL_RCLICKED, wxCommandEvent)
545 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, wxCommandEvent)
546 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TOOL_ENTER, wxCommandEvent)
547
548 // Mouse event types
549 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_LEFT_DOWN, wxMouseEvent)
550 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_LEFT_UP, wxMouseEvent)
551 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MIDDLE_DOWN, wxMouseEvent)
552 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MIDDLE_UP, wxMouseEvent)
553 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_RIGHT_DOWN, wxMouseEvent)
554 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_RIGHT_UP, wxMouseEvent)
555 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOTION, wxMouseEvent)
556 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_ENTER_WINDOW, wxMouseEvent)
557 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_LEAVE_WINDOW, wxMouseEvent)
558 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_LEFT_DCLICK, wxMouseEvent)
559 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MIDDLE_DCLICK, wxMouseEvent)
560 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_RIGHT_DCLICK, wxMouseEvent)
561 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SET_FOCUS, wxFocusEvent)
562 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_KILL_FOCUS, wxFocusEvent)
563 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_CHILD_FOCUS, wxChildFocusEvent)
564 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOUSEWHEEL, wxMouseEvent)
565 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_AUX1_DOWN, wxMouseEvent)
566 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_AUX1_UP, wxMouseEvent)
567 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_AUX1_DCLICK, wxMouseEvent)
568 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_AUX2_DOWN, wxMouseEvent)
569 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_AUX2_UP, wxMouseEvent)
570 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_AUX2_DCLICK, wxMouseEvent)
571
572 // Character input event type
573 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_CHAR, wxKeyEvent)
574 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_CHAR_HOOK, wxKeyEvent)
575 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_NAVIGATION_KEY, wxNavigationKeyEvent)
576 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_KEY_DOWN, wxKeyEvent)
577 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_KEY_UP, wxKeyEvent)
578 #if wxUSE_HOTKEY
579 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_HOTKEY, wxKeyEvent)
580 #endif
581 // Set cursor event
582 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SET_CURSOR, wxSetCursorEvent)
583
584 // wxScrollBar and wxSlider event identifiers
585 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_TOP, wxScrollEvent)
586 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_BOTTOM, wxScrollEvent)
587 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_LINEUP, wxScrollEvent)
588 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_LINEDOWN, wxScrollEvent)
589 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_PAGEUP, wxScrollEvent)
590 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_PAGEDOWN, wxScrollEvent)
591 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_THUMBTRACK, wxScrollEvent)
592 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_THUMBRELEASE, wxScrollEvent)
593 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_CHANGED, wxScrollEvent)
594
595 // Scroll events from wxWindow
596 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_TOP, wxScrollWinEvent)
597 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEvent)
598 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_LINEUP, wxScrollWinEvent)
599 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEvent)
600 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEvent)
601 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEvent)
602 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEvent)
603 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEvent)
604
605 // System events
606 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SIZE, wxSizeEvent)
607 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOVE, wxMoveEvent)
608 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_CLOSE_WINDOW, wxCloseEvent)
609 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_END_SESSION, wxCloseEvent)
610 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_QUERY_END_SESSION, wxCloseEvent)
611 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_ACTIVATE_APP, wxActivateEvent)
612 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_ACTIVATE, wxActivateEvent)
613 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_CREATE, wxWindowCreateEvent)
614 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_DESTROY, wxWindowDestroyEvent)
615 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SHOW, wxShowEvent)
616 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_ICONIZE, wxIconizeEvent)
617 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MAXIMIZE, wxMaximizeEvent)
618 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEvent)
619 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEvent)
620 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_PAINT, wxPaintEvent)
621 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_ERASE_BACKGROUND, wxEraseEvent)
622 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_NC_PAINT, wxNcPaintEvent)
623 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MENU_OPEN, wxMenuEvent)
624 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MENU_CLOSE, wxMenuEvent)
625 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MENU_HIGHLIGHT, wxMenuEvent)
626 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_CONTEXT_MENU, wxContextMenuEvent)
627 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEvent)
628 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_DISPLAY_CHANGED, wxDisplayChangedEvent)
629 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEvent)
630 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_PALETTE_CHANGED, wxPaletteChangedEvent)
631 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_JOY_BUTTON_DOWN, wxJoystickEvent)
632 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_JOY_BUTTON_UP, wxJoystickEvent)
633 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_JOY_MOVE, wxJoystickEvent)
634 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_JOY_ZMOVE, wxJoystickEvent)
635 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_DROP_FILES, wxDropFilesEvent)
636 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_INIT_DIALOG, wxInitDialogEvent)
637 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_BASE, wxEVT_IDLE, wxIdleEvent)
638 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_UPDATE_UI, wxUpdateUIEvent)
639 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SIZING, wxSizeEvent)
640 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOVING, wxMoveEvent)
641 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOVE_START, wxMoveEvent)
642 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOVE_END, wxMoveEvent)
643 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_HIBERNATE, wxActivateEvent)
644
645 // Clipboard events
646 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TEXT_COPY, wxClipboardTextEvent)
647 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TEXT_CUT, wxClipboardTextEvent)
648 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TEXT_PASTE, wxClipboardTextEvent)
649
650 // Generic command events
651 // Note: a click is a higher-level event than button down/up
652 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_LEFT_CLICK, wxCommandEvent)
653 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_LEFT_DCLICK, wxCommandEvent)
654 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_RIGHT_CLICK, wxCommandEvent)
655 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_RIGHT_DCLICK, wxCommandEvent)
656 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_SET_FOCUS, wxCommandEvent)
657 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_KILL_FOCUS, wxCommandEvent)
658 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_ENTER, wxCommandEvent)
659
660 // Help events
661 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_HELP, wxHelpEvent)
662 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_DETAILED_HELP, wxHelpEvent)
663
664 // these 2 events are the same
665 #define wxEVT_COMMAND_TOOL_CLICKED wxEVT_COMMAND_MENU_SELECTED
666
667 // ----------------------------------------------------------------------------
668 // Compatibility
669 // ----------------------------------------------------------------------------
670
671 // this event is also used by wxComboBox and wxSpinCtrl which don't include
672 // wx/textctrl.h in all ports [yet], so declare it here as well
673 //
674 // still, any new code using it should include wx/textctrl.h explicitly
675 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TEXT_UPDATED, wxCommandEvent)
676
677 // the predefined constants for the number of times we propagate event
678 // upwards window child-parent chain
679 enum Propagation_state
680 {
681 // don't propagate it at all
682 wxEVENT_PROPAGATE_NONE = 0,
683
684 // propagate it until it is processed
685 wxEVENT_PROPAGATE_MAX = INT_MAX
686 };
687
688 /*
689 * wxWidgets events, covering all interesting things that might happen
690 * (button clicking, resizing, setting text in widgets, etc.).
691 *
692 * For each completely new event type, derive a new event class.
693 * An event CLASS represents a C++ class defining a range of similar event TYPES;
694 * examples are canvas events, panel item command events.
695 * An event TYPE is a unique identifier for a particular system event,
696 * such as a button press or a listbox deselection.
697 *
698 */
699
700 class WXDLLIMPEXP_BASE wxEvent : public wxObject
701 {
702 public:
703 wxEvent(int winid = 0, wxEventType commandType = wxEVT_NULL );
704
705 void SetEventType(wxEventType typ) { m_eventType = typ; }
706 wxEventType GetEventType() const { return m_eventType; }
707 wxObject *GetEventObject() const { return m_eventObject; }
708 void SetEventObject(wxObject *obj) { m_eventObject = obj; }
709 long GetTimestamp() const { return m_timeStamp; }
710 void SetTimestamp(long ts = 0) { m_timeStamp = ts; }
711 int GetId() const { return m_id; }
712 void SetId(int Id) { m_id = Id; }
713
714 // Can instruct event processor that we wish to ignore this event
715 // (treat as if the event table entry had not been found): this must be done
716 // to allow the event processing by the base classes (calling event.Skip()
717 // is the analog of calling the base class version of a virtual function)
718 void Skip(bool skip = true) { m_skipped = skip; }
719 bool GetSkipped() const { return m_skipped; }
720
721 // this function is used to create a copy of the event polymorphically and
722 // all derived classes must implement it because otherwise wxPostEvent()
723 // for them wouldn't work (it needs to do a copy of the event)
724 virtual wxEvent *Clone() const = 0;
725
726 // Implementation only: this test is explicitly anti OO and this function
727 // exists only for optimization purposes.
728 bool IsCommandEvent() const { return m_isCommandEvent; }
729
730 // Determine if this event should be propagating to the parent window.
731 bool ShouldPropagate() const
732 { return m_propagationLevel != wxEVENT_PROPAGATE_NONE; }
733
734 // Stop an event from propagating to its parent window, returns the old
735 // propagation level value
736 int StopPropagation()
737 {
738 int propagationLevel = m_propagationLevel;
739 m_propagationLevel = wxEVENT_PROPAGATE_NONE;
740 return propagationLevel;
741 }
742
743 // Resume the event propagation by restoring the propagation level
744 // (returned by StopPropagation())
745 void ResumePropagation(int propagationLevel)
746 {
747 m_propagationLevel = propagationLevel;
748 }
749
750 protected:
751 wxObject* m_eventObject;
752 wxEventType m_eventType;
753 long m_timeStamp;
754 int m_id;
755
756 public:
757 // m_callbackUserData is for internal usage only
758 wxObject* m_callbackUserData;
759
760 protected:
761 // the propagation level: while it is positive, we propagate the event to
762 // the parent window (if any)
763 //
764 // this one doesn't have to be public, we don't have to worry about
765 // backwards compatibility as it is new
766 int m_propagationLevel;
767
768 bool m_skipped;
769 bool m_isCommandEvent;
770
771 protected:
772 wxEvent(const wxEvent&); // for implementing Clone()
773 wxEvent& operator=(const wxEvent&); // for derived classes operator=()
774
775 private:
776 // it needs to access our m_propagationLevel
777 friend class WXDLLIMPEXP_FWD_BASE wxPropagateOnce;
778
779 DECLARE_ABSTRACT_CLASS(wxEvent)
780 };
781
782 /*
783 * Helper class to temporarily change an event not to propagate.
784 */
785 class WXDLLIMPEXP_BASE wxPropagationDisabler
786 {
787 public:
788 wxPropagationDisabler(wxEvent& event) : m_event(event)
789 {
790 m_propagationLevelOld = m_event.StopPropagation();
791 }
792
793 ~wxPropagationDisabler()
794 {
795 m_event.ResumePropagation(m_propagationLevelOld);
796 }
797
798 private:
799 wxEvent& m_event;
800 int m_propagationLevelOld;
801
802 DECLARE_NO_COPY_CLASS(wxPropagationDisabler)
803 };
804
805 /*
806 * Another one to temporarily lower propagation level.
807 */
808 class WXDLLIMPEXP_BASE wxPropagateOnce
809 {
810 public:
811 wxPropagateOnce(wxEvent& event) : m_event(event)
812 {
813 wxASSERT_MSG( m_event.m_propagationLevel > 0,
814 _T("shouldn't be used unless ShouldPropagate()!") );
815
816 m_event.m_propagationLevel--;
817 }
818
819 ~wxPropagateOnce()
820 {
821 m_event.m_propagationLevel++;
822 }
823
824 private:
825 wxEvent& m_event;
826
827 DECLARE_NO_COPY_CLASS(wxPropagateOnce)
828 };
829
830
831 #if wxUSE_GUI
832
833
834 // Item or menu event class
835 /*
836 wxEVT_COMMAND_BUTTON_CLICKED
837 wxEVT_COMMAND_CHECKBOX_CLICKED
838 wxEVT_COMMAND_CHOICE_SELECTED
839 wxEVT_COMMAND_LISTBOX_SELECTED
840 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
841 wxEVT_COMMAND_TEXT_UPDATED
842 wxEVT_COMMAND_TEXT_ENTER
843 wxEVT_COMMAND_MENU_SELECTED
844 wxEVT_COMMAND_SLIDER_UPDATED
845 wxEVT_COMMAND_RADIOBOX_SELECTED
846 wxEVT_COMMAND_RADIOBUTTON_SELECTED
847 wxEVT_COMMAND_SCROLLBAR_UPDATED
848 wxEVT_COMMAND_VLBOX_SELECTED
849 wxEVT_COMMAND_COMBOBOX_SELECTED
850 wxEVT_COMMAND_TOGGLEBUTTON_CLICKED
851 */
852
853 class WXDLLIMPEXP_CORE wxCommandEvent : public wxEvent
854 {
855 public:
856 wxCommandEvent(wxEventType commandType = wxEVT_NULL, int winid = 0);
857
858 wxCommandEvent(const wxCommandEvent& event)
859 : wxEvent(event),
860 m_cmdString(event.m_cmdString),
861 m_commandInt(event.m_commandInt),
862 m_extraLong(event.m_extraLong),
863 m_clientData(event.m_clientData),
864 m_clientObject(event.m_clientObject)
865 { }
866
867 // Set/Get client data from controls
868 void SetClientData(void* clientData) { m_clientData = clientData; }
869 void *GetClientData() const { return m_clientData; }
870
871 // Set/Get client object from controls
872 void SetClientObject(wxClientData* clientObject) { m_clientObject = clientObject; }
873 wxClientData *GetClientObject() const { return m_clientObject; }
874
875 // Get listbox selection if single-choice
876 int GetSelection() const { return m_commandInt; }
877
878 // Set/Get listbox/choice selection string
879 void SetString(const wxString& s) { m_cmdString = s; }
880 wxString GetString() const;
881
882 // Get checkbox value
883 bool IsChecked() const { return m_commandInt != 0; }
884
885 // true if the listbox event was a selection.
886 bool IsSelection() const { return (m_extraLong != 0); }
887
888 void SetExtraLong(long extraLong) { m_extraLong = extraLong; }
889 long GetExtraLong() const { return m_extraLong; }
890
891 void SetInt(int i) { m_commandInt = i; }
892 int GetInt() const { return m_commandInt; }
893
894 virtual wxEvent *Clone() const { return new wxCommandEvent(*this); }
895
896 protected:
897 wxString m_cmdString; // String event argument
898 int m_commandInt;
899 long m_extraLong; // Additional information (e.g. select/deselect)
900 void* m_clientData; // Arbitrary client data
901 wxClientData* m_clientObject; // Arbitrary client object
902
903 private:
904 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCommandEvent)
905 };
906
907 // this class adds a possibility to react (from the user) code to a control
908 // notification: allow or veto the operation being reported.
909 class WXDLLIMPEXP_CORE wxNotifyEvent : public wxCommandEvent
910 {
911 public:
912 wxNotifyEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
913 : wxCommandEvent(commandType, winid)
914 { m_bAllow = true; }
915
916 wxNotifyEvent(const wxNotifyEvent& event)
917 : wxCommandEvent(event)
918 { m_bAllow = event.m_bAllow; }
919
920 // veto the operation (usually it's allowed by default)
921 void Veto() { m_bAllow = false; }
922
923 // allow the operation if it was disabled by default
924 void Allow() { m_bAllow = true; }
925
926 // for implementation code only: is the operation allowed?
927 bool IsAllowed() const { return m_bAllow; }
928
929 virtual wxEvent *Clone() const { return new wxNotifyEvent(*this); }
930
931 private:
932 bool m_bAllow;
933
934 private:
935 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNotifyEvent)
936 };
937
938 // Scroll event class, derived form wxCommandEvent. wxScrollEvents are
939 // sent by wxSlider and wxScrollBar.
940 /*
941 wxEVT_SCROLL_TOP
942 wxEVT_SCROLL_BOTTOM
943 wxEVT_SCROLL_LINEUP
944 wxEVT_SCROLL_LINEDOWN
945 wxEVT_SCROLL_PAGEUP
946 wxEVT_SCROLL_PAGEDOWN
947 wxEVT_SCROLL_THUMBTRACK
948 wxEVT_SCROLL_THUMBRELEASE
949 wxEVT_SCROLL_CHANGED
950 */
951
952 class WXDLLIMPEXP_CORE wxScrollEvent : public wxCommandEvent
953 {
954 public:
955 wxScrollEvent(wxEventType commandType = wxEVT_NULL,
956 int winid = 0, int pos = 0, int orient = 0);
957
958 int GetOrientation() const { return (int) m_extraLong; }
959 int GetPosition() const { return m_commandInt; }
960 void SetOrientation(int orient) { m_extraLong = (long) orient; }
961 void SetPosition(int pos) { m_commandInt = pos; }
962
963 virtual wxEvent *Clone() const { return new wxScrollEvent(*this); }
964
965 private:
966 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollEvent)
967 };
968
969 // ScrollWin event class, derived fom wxEvent. wxScrollWinEvents
970 // are sent by wxWindow.
971 /*
972 wxEVT_SCROLLWIN_TOP
973 wxEVT_SCROLLWIN_BOTTOM
974 wxEVT_SCROLLWIN_LINEUP
975 wxEVT_SCROLLWIN_LINEDOWN
976 wxEVT_SCROLLWIN_PAGEUP
977 wxEVT_SCROLLWIN_PAGEDOWN
978 wxEVT_SCROLLWIN_THUMBTRACK
979 wxEVT_SCROLLWIN_THUMBRELEASE
980 */
981
982 class WXDLLIMPEXP_CORE wxScrollWinEvent : public wxEvent
983 {
984 public:
985 wxScrollWinEvent(wxEventType commandType = wxEVT_NULL,
986 int pos = 0, int orient = 0);
987 wxScrollWinEvent(const wxScrollWinEvent & event) : wxEvent(event)
988 { m_commandInt = event.m_commandInt;
989 m_extraLong = event.m_extraLong; }
990
991 int GetOrientation() const { return (int) m_extraLong; }
992 int GetPosition() const { return m_commandInt; }
993 void SetOrientation(int orient) { m_extraLong = (long) orient; }
994 void SetPosition(int pos) { m_commandInt = pos; }
995
996 virtual wxEvent *Clone() const { return new wxScrollWinEvent(*this); }
997
998 protected:
999 int m_commandInt;
1000 long m_extraLong;
1001
1002 private:
1003 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollWinEvent)
1004 };
1005
1006 // Mouse event class
1007
1008 /*
1009 wxEVT_LEFT_DOWN
1010 wxEVT_LEFT_UP
1011 wxEVT_MIDDLE_DOWN
1012 wxEVT_MIDDLE_UP
1013 wxEVT_RIGHT_DOWN
1014 wxEVT_RIGHT_UP
1015 wxEVT_MOTION
1016 wxEVT_ENTER_WINDOW
1017 wxEVT_LEAVE_WINDOW
1018 wxEVT_LEFT_DCLICK
1019 wxEVT_MIDDLE_DCLICK
1020 wxEVT_RIGHT_DCLICK
1021 wxEVT_NC_LEFT_DOWN
1022 wxEVT_NC_LEFT_UP,
1023 wxEVT_NC_MIDDLE_DOWN,
1024 wxEVT_NC_MIDDLE_UP,
1025 wxEVT_NC_RIGHT_DOWN,
1026 wxEVT_NC_RIGHT_UP,
1027 wxEVT_NC_MOTION,
1028 wxEVT_NC_ENTER_WINDOW,
1029 wxEVT_NC_LEAVE_WINDOW,
1030 wxEVT_NC_LEFT_DCLICK,
1031 wxEVT_NC_MIDDLE_DCLICK,
1032 wxEVT_NC_RIGHT_DCLICK,
1033 */
1034
1035 // the symbolic names for the mouse buttons
1036 enum
1037 {
1038 wxMOUSE_BTN_ANY = -1,
1039 wxMOUSE_BTN_NONE = 0,
1040 wxMOUSE_BTN_LEFT = 1,
1041 wxMOUSE_BTN_MIDDLE = 2,
1042 wxMOUSE_BTN_RIGHT = 3,
1043 wxMOUSE_BTN_AUX1 = 4,
1044 wxMOUSE_BTN_AUX2 = 5,
1045 wxMOUSE_BTN_MAX
1046 };
1047
1048 class WXDLLIMPEXP_CORE wxMouseEvent : public wxEvent,
1049 public wxMouseState
1050 {
1051 public:
1052 wxMouseEvent(wxEventType mouseType = wxEVT_NULL);
1053 wxMouseEvent(const wxMouseEvent& event)
1054 : wxEvent(event),
1055 wxMouseState(event)
1056 {
1057 Assign(event);
1058 }
1059
1060 // Was it a button event? (*doesn't* mean: is any button *down*?)
1061 bool IsButton() const { return Button(wxMOUSE_BTN_ANY); }
1062
1063 // Was it a down event from this (or any) button?
1064 bool ButtonDown(int but = wxMOUSE_BTN_ANY) const;
1065
1066 // Was it a dclick event from this (or any) button?
1067 bool ButtonDClick(int but = wxMOUSE_BTN_ANY) const;
1068
1069 // Was it a up event from this (or any) button?
1070 bool ButtonUp(int but = wxMOUSE_BTN_ANY) const;
1071
1072 // Was the given button?
1073 bool Button(int but) const;
1074
1075 // Was the given button in Down state?
1076 bool ButtonIsDown(int but) const;
1077
1078 // Get the button which is changing state (wxMOUSE_BTN_NONE if none)
1079 int GetButton() const;
1080
1081 // Find which event was just generated
1082 bool LeftDown() const { return (m_eventType == wxEVT_LEFT_DOWN); }
1083 bool MiddleDown() const { return (m_eventType == wxEVT_MIDDLE_DOWN); }
1084 bool RightDown() const { return (m_eventType == wxEVT_RIGHT_DOWN); }
1085 bool Aux1Down() const { return (m_eventType == wxEVT_AUX1_DOWN); }
1086 bool Aux2Down() const { return (m_eventType == wxEVT_AUX2_DOWN); }
1087
1088 bool LeftUp() const { return (m_eventType == wxEVT_LEFT_UP); }
1089 bool MiddleUp() const { return (m_eventType == wxEVT_MIDDLE_UP); }
1090 bool RightUp() const { return (m_eventType == wxEVT_RIGHT_UP); }
1091 bool Aux1Up() const { return (m_eventType == wxEVT_AUX1_UP); }
1092 bool Aux2Up() const { return (m_eventType == wxEVT_AUX2_UP); }
1093
1094 bool LeftDClick() const { return (m_eventType == wxEVT_LEFT_DCLICK); }
1095 bool MiddleDClick() const { return (m_eventType == wxEVT_MIDDLE_DCLICK); }
1096 bool RightDClick() const { return (m_eventType == wxEVT_RIGHT_DCLICK); }
1097 bool Aux1DClick() const { return (m_eventType == wxEVT_AUX1_UP); }
1098 bool Aux2DClick() const { return (m_eventType == wxEVT_AUX2_UP); }
1099
1100 // Find the current state of the mouse buttons (regardless
1101 // of current event type)
1102 bool LeftIsDown() const { return m_leftDown; }
1103 bool MiddleIsDown() const { return m_middleDown; }
1104 bool RightIsDown() const { return m_rightDown; }
1105 bool Aux1IsDown() const { return m_aux1Down; }
1106 bool Aux2IsDown() const { return m_aux2Down; }
1107
1108 // True if a button is down and the mouse is moving
1109 bool Dragging() const
1110 {
1111 return (m_eventType == wxEVT_MOTION) && ButtonIsDown(wxMOUSE_BTN_ANY);
1112 }
1113
1114 // True if the mouse is moving, and no button is down
1115 bool Moving() const
1116 {
1117 return (m_eventType == wxEVT_MOTION) && !ButtonIsDown(wxMOUSE_BTN_ANY);
1118 }
1119
1120 // True if the mouse is just entering the window
1121 bool Entering() const { return (m_eventType == wxEVT_ENTER_WINDOW); }
1122
1123 // True if the mouse is just leaving the window
1124 bool Leaving() const { return (m_eventType == wxEVT_LEAVE_WINDOW); }
1125
1126 // Returns the number of mouse clicks associated with this event.
1127 int GetClickCount() const { return m_clickCount; }
1128
1129
1130 // Find the position of the event
1131 void GetPosition(wxCoord *xpos, wxCoord *ypos) const
1132 {
1133 if (xpos)
1134 *xpos = m_x;
1135 if (ypos)
1136 *ypos = m_y;
1137 }
1138
1139 void GetPosition(long *xpos, long *ypos) const
1140 {
1141 if (xpos)
1142 *xpos = (long)m_x;
1143 if (ypos)
1144 *ypos = (long)m_y;
1145 }
1146
1147 // Find the position of the event
1148 wxPoint GetPosition() const { return wxPoint(m_x, m_y); }
1149
1150 // Find the logical position of the event given the DC
1151 wxPoint GetLogicalPosition(const wxDC& dc) const;
1152
1153 // Get X position
1154 wxCoord GetX() const { return m_x; }
1155
1156 // Get Y position
1157 wxCoord GetY() const { return m_y; }
1158
1159 // Get wheel rotation, positive or negative indicates direction of
1160 // rotation. Current devices all send an event when rotation is equal to
1161 // +/-WheelDelta, but this allows for finer resolution devices to be
1162 // created in the future. Because of this you shouldn't assume that one
1163 // event is equal to 1 line or whatever, but you should be able to either
1164 // do partial line scrolling or wait until +/-WheelDelta rotation values
1165 // have been accumulated before scrolling.
1166 int GetWheelRotation() const { return m_wheelRotation; }
1167
1168 // Get wheel delta, normally 120. This is the threshold for action to be
1169 // taken, and one such action (for example, scrolling one increment)
1170 // should occur for each delta.
1171 int GetWheelDelta() const { return m_wheelDelta; }
1172
1173 // Gets the axis the wheel operation concerns, 0 being the y axis as on
1174 // most mouse wheels, 1 is the x axis for things like MightyMouse scrolls
1175 // or horizontal trackpad scrolling
1176 int GetWheelAxis() const { return m_wheelAxis; }
1177
1178 // Returns the configured number of lines (or whatever) to be scrolled per
1179 // wheel action. Defaults to one.
1180 int GetLinesPerAction() const { return m_linesPerAction; }
1181
1182 // Is the system set to do page scrolling?
1183 bool IsPageScroll() const { return ((unsigned int)m_linesPerAction == UINT_MAX); }
1184
1185 virtual wxEvent *Clone() const { return new wxMouseEvent(*this); }
1186
1187 wxMouseEvent& operator=(const wxMouseEvent& event)
1188 {
1189 if (&event != this)
1190 Assign(event);
1191 return *this;
1192 }
1193
1194 public:
1195 wxCoord m_x, m_y;
1196
1197 bool m_leftDown;
1198 bool m_middleDown;
1199 bool m_rightDown;
1200 bool m_aux1Down;
1201 bool m_aux2Down;
1202
1203 int m_clickCount;
1204
1205 int m_wheelAxis;
1206 int m_wheelRotation;
1207 int m_wheelDelta;
1208 int m_linesPerAction;
1209
1210 protected:
1211 void Assign(const wxMouseEvent& evt);
1212
1213 private:
1214 DECLARE_DYNAMIC_CLASS(wxMouseEvent)
1215 };
1216
1217 // Cursor set event
1218
1219 /*
1220 wxEVT_SET_CURSOR
1221 */
1222
1223 class WXDLLIMPEXP_CORE wxSetCursorEvent : public wxEvent
1224 {
1225 public:
1226 wxSetCursorEvent(wxCoord x = 0, wxCoord y = 0)
1227 : wxEvent(0, wxEVT_SET_CURSOR),
1228 m_x(x), m_y(y), m_cursor()
1229 { }
1230
1231 wxSetCursorEvent(const wxSetCursorEvent & event)
1232 : wxEvent(event),
1233 m_x(event.m_x),
1234 m_y(event.m_y),
1235 m_cursor(event.m_cursor)
1236 { }
1237
1238 wxCoord GetX() const { return m_x; }
1239 wxCoord GetY() const { return m_y; }
1240
1241 void SetCursor(const wxCursor& cursor) { m_cursor = cursor; }
1242 const wxCursor& GetCursor() const { return m_cursor; }
1243 bool HasCursor() const { return m_cursor.Ok(); }
1244
1245 virtual wxEvent *Clone() const { return new wxSetCursorEvent(*this); }
1246
1247 private:
1248 wxCoord m_x, m_y;
1249 wxCursor m_cursor;
1250
1251 private:
1252 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSetCursorEvent)
1253 };
1254
1255 // Keyboard input event class
1256
1257 /*
1258 wxEVT_CHAR
1259 wxEVT_CHAR_HOOK
1260 wxEVT_KEY_DOWN
1261 wxEVT_KEY_UP
1262 wxEVT_HOTKEY
1263 */
1264
1265 class WXDLLIMPEXP_CORE wxKeyEvent : public wxEvent,
1266 public wxKeyboardState
1267 {
1268 public:
1269 wxKeyEvent(wxEventType keyType = wxEVT_NULL);
1270 wxKeyEvent(const wxKeyEvent& evt);
1271
1272 // get the key code: an ASCII7 char or an element of wxKeyCode enum
1273 int GetKeyCode() const { return (int)m_keyCode; }
1274
1275 #if wxUSE_UNICODE
1276 // get the Unicode character corresponding to this key
1277 wxChar GetUnicodeKey() const { return m_uniChar; }
1278 #endif // wxUSE_UNICODE
1279
1280 // get the raw key code (platform-dependent)
1281 wxUint32 GetRawKeyCode() const { return m_rawCode; }
1282
1283 // get the raw key flags (platform-dependent)
1284 wxUint32 GetRawKeyFlags() const { return m_rawFlags; }
1285
1286 // Find the position of the event
1287 void GetPosition(wxCoord *xpos, wxCoord *ypos) const
1288 {
1289 if (xpos) *xpos = m_x;
1290 if (ypos) *ypos = m_y;
1291 }
1292
1293 void GetPosition(long *xpos, long *ypos) const
1294 {
1295 if (xpos) *xpos = (long)m_x;
1296 if (ypos) *ypos = (long)m_y;
1297 }
1298
1299 wxPoint GetPosition() const
1300 { return wxPoint(m_x, m_y); }
1301
1302 // Get X position
1303 wxCoord GetX() const { return m_x; }
1304
1305 // Get Y position
1306 wxCoord GetY() const { return m_y; }
1307
1308 virtual wxEvent *Clone() const { return new wxKeyEvent(*this); }
1309
1310 // we do need to copy wxKeyEvent sometimes (in wxTreeCtrl code, for
1311 // example)
1312 wxKeyEvent& operator=(const wxKeyEvent& evt)
1313 {
1314 if ( &evt != this )
1315 {
1316 wxEvent::operator=(evt);
1317
1318 // Borland C++ 5.82 doesn't compile an explicit call to an
1319 // implicitly defined operator=() so need to do it this way:
1320 *static_cast<wxKeyboardState *>(this) = evt;
1321
1322 m_x = evt.m_x;
1323 m_y = evt.m_y;
1324
1325 m_keyCode = evt.m_keyCode;
1326
1327 m_scanCode = evt.m_scanCode;
1328 m_rawCode = evt.m_rawCode;
1329 m_rawFlags = evt.m_rawFlags;
1330 #if wxUSE_UNICODE
1331 m_uniChar = evt.m_uniChar;
1332 #endif
1333 }
1334 return *this;
1335 }
1336
1337 public:
1338 wxCoord m_x, m_y;
1339
1340 long m_keyCode;
1341
1342 // FIXME: what is this for? relation to m_rawXXX?
1343 bool m_scanCode;
1344
1345 #if wxUSE_UNICODE
1346 // This contains the full Unicode character
1347 // in a character events in Unicode mode
1348 wxChar m_uniChar;
1349 #endif
1350
1351 // these fields contain the platform-specific information about
1352 // key that was pressed
1353 wxUint32 m_rawCode;
1354 wxUint32 m_rawFlags;
1355
1356 private:
1357 DECLARE_DYNAMIC_CLASS(wxKeyEvent)
1358 };
1359
1360 // Size event class
1361 /*
1362 wxEVT_SIZE
1363 */
1364
1365 class WXDLLIMPEXP_CORE wxSizeEvent : public wxEvent
1366 {
1367 public:
1368 wxSizeEvent() : wxEvent(0, wxEVT_SIZE)
1369 { }
1370 wxSizeEvent(const wxSize& sz, int winid = 0)
1371 : wxEvent(winid, wxEVT_SIZE),
1372 m_size(sz)
1373 { }
1374 wxSizeEvent(const wxSizeEvent & event)
1375 : wxEvent(event),
1376 m_size(event.m_size), m_rect(event.m_rect)
1377 { }
1378 wxSizeEvent(const wxRect& rect, int id = 0)
1379 : m_size(rect.GetSize()), m_rect(rect)
1380 { m_eventType = wxEVT_SIZING; m_id = id; }
1381
1382 wxSize GetSize() const { return m_size; }
1383 wxRect GetRect() const { return m_rect; }
1384 void SetRect(const wxRect& rect) { m_rect = rect; }
1385
1386 virtual wxEvent *Clone() const { return new wxSizeEvent(*this); }
1387
1388 public:
1389 // For internal usage only. Will be converted to protected members.
1390 wxSize m_size;
1391 wxRect m_rect; // Used for wxEVT_SIZING
1392
1393 private:
1394 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSizeEvent)
1395 };
1396
1397 // Move event class
1398
1399 /*
1400 wxEVT_MOVE
1401 */
1402
1403 class WXDLLIMPEXP_CORE wxMoveEvent : public wxEvent
1404 {
1405 public:
1406 wxMoveEvent()
1407 : wxEvent(0, wxEVT_MOVE)
1408 { }
1409 wxMoveEvent(const wxPoint& pos, int winid = 0)
1410 : wxEvent(winid, wxEVT_MOVE),
1411 m_pos(pos)
1412 { }
1413 wxMoveEvent(const wxMoveEvent& event)
1414 : wxEvent(event),
1415 m_pos(event.m_pos)
1416 { }
1417 wxMoveEvent(const wxRect& rect, int id = 0)
1418 : m_pos(rect.GetPosition()), m_rect(rect)
1419 { m_eventType = wxEVT_MOVING; m_id = id; }
1420
1421 wxPoint GetPosition() const { return m_pos; }
1422 void SetPosition(const wxPoint& pos) { m_pos = pos; }
1423 wxRect GetRect() const { return m_rect; }
1424 void SetRect(const wxRect& rect) { m_rect = rect; }
1425
1426 virtual wxEvent *Clone() const { return new wxMoveEvent(*this); }
1427
1428 protected:
1429 wxPoint m_pos;
1430 wxRect m_rect;
1431
1432 private:
1433 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMoveEvent)
1434 };
1435
1436 // Paint event class
1437 /*
1438 wxEVT_PAINT
1439 wxEVT_NC_PAINT
1440 wxEVT_PAINT_ICON
1441 */
1442
1443 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1444 // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined
1445 extern WXDLLIMPEXP_CORE int g_isPainting;
1446 #endif // debug
1447
1448 class WXDLLIMPEXP_CORE wxPaintEvent : public wxEvent
1449 {
1450 public:
1451 wxPaintEvent(int Id = 0)
1452 : wxEvent(Id, wxEVT_PAINT)
1453 {
1454 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1455 // set the internal flag for the duration of processing of WM_PAINT
1456 g_isPainting++;
1457 #endif // debug
1458 }
1459
1460 // default copy ctor and dtor are normally fine, we only need them to keep
1461 // g_isPainting updated in debug build
1462 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1463 wxPaintEvent(const wxPaintEvent& event)
1464 : wxEvent(event)
1465 {
1466 g_isPainting++;
1467 }
1468
1469 virtual ~wxPaintEvent()
1470 {
1471 g_isPainting--;
1472 }
1473 #endif // debug
1474
1475 virtual wxEvent *Clone() const { return new wxPaintEvent(*this); }
1476
1477 private:
1478 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaintEvent)
1479 };
1480
1481 class WXDLLIMPEXP_CORE wxNcPaintEvent : public wxEvent
1482 {
1483 public:
1484 wxNcPaintEvent(int winid = 0)
1485 : wxEvent(winid, wxEVT_NC_PAINT)
1486 { }
1487
1488 virtual wxEvent *Clone() const { return new wxNcPaintEvent(*this); }
1489
1490 private:
1491 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNcPaintEvent)
1492 };
1493
1494 // Erase background event class
1495 /*
1496 wxEVT_ERASE_BACKGROUND
1497 */
1498
1499 class WXDLLIMPEXP_CORE wxEraseEvent : public wxEvent
1500 {
1501 public:
1502 wxEraseEvent(int Id = 0, wxDC *dc = NULL)
1503 : wxEvent(Id, wxEVT_ERASE_BACKGROUND),
1504 m_dc(dc)
1505 { }
1506
1507 wxEraseEvent(const wxEraseEvent& event)
1508 : wxEvent(event),
1509 m_dc(event.m_dc)
1510 { }
1511
1512 wxDC *GetDC() const { return m_dc; }
1513
1514 virtual wxEvent *Clone() const { return new wxEraseEvent(*this); }
1515
1516 protected:
1517 wxDC *m_dc;
1518
1519 private:
1520 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxEraseEvent)
1521 };
1522
1523 // Focus event class
1524 /*
1525 wxEVT_SET_FOCUS
1526 wxEVT_KILL_FOCUS
1527 */
1528
1529 class WXDLLIMPEXP_CORE wxFocusEvent : public wxEvent
1530 {
1531 public:
1532 wxFocusEvent(wxEventType type = wxEVT_NULL, int winid = 0)
1533 : wxEvent(winid, type)
1534 { m_win = NULL; }
1535
1536 wxFocusEvent(const wxFocusEvent& event)
1537 : wxEvent(event)
1538 { m_win = event.m_win; }
1539
1540 // The window associated with this event is the window which had focus
1541 // before for SET event and the window which will have focus for the KILL
1542 // one. NB: it may be NULL in both cases!
1543 wxWindow *GetWindow() const { return m_win; }
1544 void SetWindow(wxWindow *win) { m_win = win; }
1545
1546 virtual wxEvent *Clone() const { return new wxFocusEvent(*this); }
1547
1548 private:
1549 wxWindow *m_win;
1550
1551 private:
1552 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFocusEvent)
1553 };
1554
1555 // wxChildFocusEvent notifies the parent that a child has got the focus: unlike
1556 // wxFocusEvent it is propagated upwards the window chain
1557 class WXDLLIMPEXP_CORE wxChildFocusEvent : public wxCommandEvent
1558 {
1559 public:
1560 wxChildFocusEvent(wxWindow *win = NULL);
1561
1562 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1563
1564 virtual wxEvent *Clone() const { return new wxChildFocusEvent(*this); }
1565
1566 private:
1567 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxChildFocusEvent)
1568 };
1569
1570 // Activate event class
1571 /*
1572 wxEVT_ACTIVATE
1573 wxEVT_ACTIVATE_APP
1574 wxEVT_HIBERNATE
1575 */
1576
1577 class WXDLLIMPEXP_CORE wxActivateEvent : public wxEvent
1578 {
1579 public:
1580 wxActivateEvent(wxEventType type = wxEVT_NULL, bool active = true, int Id = 0)
1581 : wxEvent(Id, type)
1582 { m_active = active; }
1583 wxActivateEvent(const wxActivateEvent& event)
1584 : wxEvent(event)
1585 { m_active = event.m_active; }
1586
1587 bool GetActive() const { return m_active; }
1588
1589 virtual wxEvent *Clone() const { return new wxActivateEvent(*this); }
1590
1591 private:
1592 bool m_active;
1593
1594 private:
1595 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxActivateEvent)
1596 };
1597
1598 // InitDialog event class
1599 /*
1600 wxEVT_INIT_DIALOG
1601 */
1602
1603 class WXDLLIMPEXP_CORE wxInitDialogEvent : public wxEvent
1604 {
1605 public:
1606 wxInitDialogEvent(int Id = 0)
1607 : wxEvent(Id, wxEVT_INIT_DIALOG)
1608 { }
1609
1610 virtual wxEvent *Clone() const { return new wxInitDialogEvent(*this); }
1611
1612 private:
1613 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxInitDialogEvent)
1614 };
1615
1616 // Miscellaneous menu event class
1617 /*
1618 wxEVT_MENU_OPEN,
1619 wxEVT_MENU_CLOSE,
1620 wxEVT_MENU_HIGHLIGHT,
1621 */
1622
1623 class WXDLLIMPEXP_CORE wxMenuEvent : public wxEvent
1624 {
1625 public:
1626 wxMenuEvent(wxEventType type = wxEVT_NULL, int winid = 0, wxMenu* menu = NULL)
1627 : wxEvent(winid, type)
1628 { m_menuId = winid; m_menu = menu; }
1629 wxMenuEvent(const wxMenuEvent & event)
1630 : wxEvent(event)
1631 { m_menuId = event.m_menuId; m_menu = event.m_menu; }
1632
1633 // only for wxEVT_MENU_HIGHLIGHT
1634 int GetMenuId() const { return m_menuId; }
1635
1636 // only for wxEVT_MENU_OPEN/CLOSE
1637 bool IsPopup() const { return m_menuId == wxID_ANY; }
1638
1639 // only for wxEVT_MENU_OPEN/CLOSE
1640 wxMenu* GetMenu() const { return m_menu; }
1641
1642 virtual wxEvent *Clone() const { return new wxMenuEvent(*this); }
1643
1644 private:
1645 int m_menuId;
1646 wxMenu* m_menu;
1647
1648 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMenuEvent)
1649 };
1650
1651 // Window close or session close event class
1652 /*
1653 wxEVT_CLOSE_WINDOW,
1654 wxEVT_END_SESSION,
1655 wxEVT_QUERY_END_SESSION
1656 */
1657
1658 class WXDLLIMPEXP_CORE wxCloseEvent : public wxEvent
1659 {
1660 public:
1661 wxCloseEvent(wxEventType type = wxEVT_NULL, int winid = 0)
1662 : wxEvent(winid, type),
1663 m_loggingOff(true),
1664 m_veto(false), // should be false by default
1665 m_canVeto(true) {}
1666
1667 wxCloseEvent(const wxCloseEvent & event)
1668 : wxEvent(event),
1669 m_loggingOff(event.m_loggingOff),
1670 m_veto(event.m_veto),
1671 m_canVeto(event.m_canVeto) {}
1672
1673 void SetLoggingOff(bool logOff) { m_loggingOff = logOff; }
1674 bool GetLoggingOff() const
1675 {
1676 // m_loggingOff flag is only used by wxEVT_[QUERY_]END_SESSION, it
1677 // doesn't make sense for wxEVT_CLOSE_WINDOW
1678 wxASSERT_MSG( m_eventType != wxEVT_CLOSE_WINDOW,
1679 _T("this flag is for end session events only") );
1680
1681 return m_loggingOff;
1682 }
1683
1684 void Veto(bool veto = true)
1685 {
1686 // GetVeto() will return false anyhow...
1687 wxCHECK_RET( m_canVeto,
1688 wxT("call to Veto() ignored (can't veto this event)") );
1689
1690 m_veto = veto;
1691 }
1692 void SetCanVeto(bool canVeto) { m_canVeto = canVeto; }
1693 bool CanVeto() const { return m_canVeto; }
1694 bool GetVeto() const { return m_canVeto && m_veto; }
1695
1696 virtual wxEvent *Clone() const { return new wxCloseEvent(*this); }
1697
1698 protected:
1699 bool m_loggingOff,
1700 m_veto,
1701 m_canVeto;
1702
1703 private:
1704 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCloseEvent)
1705 };
1706
1707 /*
1708 wxEVT_SHOW
1709 */
1710
1711 class WXDLLIMPEXP_CORE wxShowEvent : public wxEvent
1712 {
1713 public:
1714 wxShowEvent(int winid = 0, bool show = false)
1715 : wxEvent(winid, wxEVT_SHOW)
1716 { m_show = show; }
1717 wxShowEvent(const wxShowEvent & event)
1718 : wxEvent(event)
1719 { m_show = event.m_show; }
1720
1721 void SetShow(bool show) { m_show = show; }
1722
1723 // return true if the window was shown, false if hidden
1724 bool IsShown() const { return m_show; }
1725
1726 #if WXWIN_COMPATIBILITY_2_8
1727 wxDEPRECATED( bool GetShow() const { return IsShown(); } )
1728 #endif
1729
1730 virtual wxEvent *Clone() const { return new wxShowEvent(*this); }
1731
1732 protected:
1733 bool m_show;
1734
1735 private:
1736 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxShowEvent)
1737 };
1738
1739 /*
1740 wxEVT_ICONIZE
1741 */
1742
1743 class WXDLLIMPEXP_CORE wxIconizeEvent : public wxEvent
1744 {
1745 public:
1746 wxIconizeEvent(int winid = 0, bool iconized = true)
1747 : wxEvent(winid, wxEVT_ICONIZE)
1748 { m_iconized = iconized; }
1749 wxIconizeEvent(const wxIconizeEvent & event)
1750 : wxEvent(event)
1751 { m_iconized = event.m_iconized; }
1752
1753 #if WXWIN_COMPATIBILITY_2_8
1754 wxDEPRECATED( bool Iconized() const { return IsIconized(); } )
1755 #endif
1756 // return true if the frame was iconized, false if restored
1757 bool IsIconized() const { return m_iconized; }
1758
1759 virtual wxEvent *Clone() const { return new wxIconizeEvent(*this); }
1760
1761 protected:
1762 bool m_iconized;
1763
1764 private:
1765 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIconizeEvent)
1766 };
1767 /*
1768 wxEVT_MAXIMIZE
1769 */
1770
1771 class WXDLLIMPEXP_CORE wxMaximizeEvent : public wxEvent
1772 {
1773 public:
1774 wxMaximizeEvent(int winid = 0)
1775 : wxEvent(winid, wxEVT_MAXIMIZE)
1776 { }
1777
1778 virtual wxEvent *Clone() const { return new wxMaximizeEvent(*this); }
1779
1780 private:
1781 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMaximizeEvent)
1782 };
1783
1784 // Joystick event class
1785 /*
1786 wxEVT_JOY_BUTTON_DOWN,
1787 wxEVT_JOY_BUTTON_UP,
1788 wxEVT_JOY_MOVE,
1789 wxEVT_JOY_ZMOVE
1790 */
1791
1792 // Which joystick? Same as Windows ids so no conversion necessary.
1793 enum
1794 {
1795 wxJOYSTICK1,
1796 wxJOYSTICK2
1797 };
1798
1799 // Which button is down?
1800 enum
1801 {
1802 wxJOY_BUTTON_ANY = -1,
1803 wxJOY_BUTTON1 = 1,
1804 wxJOY_BUTTON2 = 2,
1805 wxJOY_BUTTON3 = 4,
1806 wxJOY_BUTTON4 = 8
1807 };
1808
1809 class WXDLLIMPEXP_CORE wxJoystickEvent : public wxEvent
1810 {
1811 protected:
1812 wxPoint m_pos;
1813 int m_zPosition;
1814 int m_buttonChange; // Which button changed?
1815 int m_buttonState; // Which buttons are down?
1816 int m_joyStick; // Which joystick?
1817
1818 public:
1819 wxJoystickEvent(wxEventType type = wxEVT_NULL,
1820 int state = 0,
1821 int joystick = wxJOYSTICK1,
1822 int change = 0)
1823 : wxEvent(0, type),
1824 m_pos(),
1825 m_zPosition(0),
1826 m_buttonChange(change),
1827 m_buttonState(state),
1828 m_joyStick(joystick)
1829 {
1830 }
1831 wxJoystickEvent(const wxJoystickEvent & event)
1832 : wxEvent(event),
1833 m_pos(event.m_pos),
1834 m_zPosition(event.m_zPosition),
1835 m_buttonChange(event.m_buttonChange),
1836 m_buttonState(event.m_buttonState),
1837 m_joyStick(event.m_joyStick)
1838 { }
1839
1840 wxPoint GetPosition() const { return m_pos; }
1841 int GetZPosition() const { return m_zPosition; }
1842 int GetButtonState() const { return m_buttonState; }
1843 int GetButtonChange() const { return m_buttonChange; }
1844 int GetJoystick() const { return m_joyStick; }
1845
1846 void SetJoystick(int stick) { m_joyStick = stick; }
1847 void SetButtonState(int state) { m_buttonState = state; }
1848 void SetButtonChange(int change) { m_buttonChange = change; }
1849 void SetPosition(const wxPoint& pos) { m_pos = pos; }
1850 void SetZPosition(int zPos) { m_zPosition = zPos; }
1851
1852 // Was it a button event? (*doesn't* mean: is any button *down*?)
1853 bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) ||
1854 (GetEventType() == wxEVT_JOY_BUTTON_UP)); }
1855
1856 // Was it a move event?
1857 bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE); }
1858
1859 // Was it a zmove event?
1860 bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE); }
1861
1862 // Was it a down event from button 1, 2, 3, 4 or any?
1863 bool ButtonDown(int but = wxJOY_BUTTON_ANY) const
1864 { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) &&
1865 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
1866
1867 // Was it a up event from button 1, 2, 3 or any?
1868 bool ButtonUp(int but = wxJOY_BUTTON_ANY) const
1869 { return ((GetEventType() == wxEVT_JOY_BUTTON_UP) &&
1870 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
1871
1872 // Was the given button 1,2,3,4 or any in Down state?
1873 bool ButtonIsDown(int but = wxJOY_BUTTON_ANY) const
1874 { return (((but == wxJOY_BUTTON_ANY) && (m_buttonState != 0)) ||
1875 ((m_buttonState & but) == but)); }
1876
1877 virtual wxEvent *Clone() const { return new wxJoystickEvent(*this); }
1878
1879 private:
1880 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxJoystickEvent)
1881 };
1882
1883 // Drop files event class
1884 /*
1885 wxEVT_DROP_FILES
1886 */
1887
1888 class WXDLLIMPEXP_CORE wxDropFilesEvent : public wxEvent
1889 {
1890 public:
1891 int m_noFiles;
1892 wxPoint m_pos;
1893 wxString* m_files;
1894
1895 wxDropFilesEvent(wxEventType type = wxEVT_NULL,
1896 int noFiles = 0,
1897 wxString *files = NULL)
1898 : wxEvent(0, type),
1899 m_noFiles(noFiles),
1900 m_pos(),
1901 m_files(files)
1902 { }
1903
1904 // we need a copy ctor to avoid deleting m_files pointer twice
1905 wxDropFilesEvent(const wxDropFilesEvent& other)
1906 : wxEvent(other),
1907 m_noFiles(other.m_noFiles),
1908 m_pos(other.m_pos),
1909 m_files(NULL)
1910 {
1911 m_files = new wxString[m_noFiles];
1912 for ( int n = 0; n < m_noFiles; n++ )
1913 {
1914 m_files[n] = other.m_files[n];
1915 }
1916 }
1917
1918 virtual ~wxDropFilesEvent()
1919 {
1920 delete [] m_files;
1921 }
1922
1923 wxPoint GetPosition() const { return m_pos; }
1924 int GetNumberOfFiles() const { return m_noFiles; }
1925 wxString *GetFiles() const { return m_files; }
1926
1927 virtual wxEvent *Clone() const { return new wxDropFilesEvent(*this); }
1928
1929 private:
1930 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDropFilesEvent)
1931 };
1932
1933 // Update UI event
1934 /*
1935 wxEVT_UPDATE_UI
1936 */
1937
1938 // Whether to always send update events to windows, or
1939 // to only send update events to those with the
1940 // wxWS_EX_PROCESS_UI_UPDATES style.
1941
1942 enum wxUpdateUIMode
1943 {
1944 // Send UI update events to all windows
1945 wxUPDATE_UI_PROCESS_ALL,
1946
1947 // Send UI update events to windows that have
1948 // the wxWS_EX_PROCESS_UI_UPDATES flag specified
1949 wxUPDATE_UI_PROCESS_SPECIFIED
1950 };
1951
1952 class WXDLLIMPEXP_CORE wxUpdateUIEvent : public wxCommandEvent
1953 {
1954 public:
1955 wxUpdateUIEvent(wxWindowID commandId = 0)
1956 : wxCommandEvent(wxEVT_UPDATE_UI, commandId)
1957 {
1958 m_checked =
1959 m_enabled =
1960 m_shown =
1961 m_setEnabled =
1962 m_setShown =
1963 m_setText =
1964 m_setChecked = false;
1965 }
1966 wxUpdateUIEvent(const wxUpdateUIEvent & event)
1967 : wxCommandEvent(event),
1968 m_checked(event.m_checked),
1969 m_enabled(event.m_enabled),
1970 m_shown(event.m_shown),
1971 m_setEnabled(event.m_setEnabled),
1972 m_setShown(event.m_setShown),
1973 m_setText(event.m_setText),
1974 m_setChecked(event.m_setChecked),
1975 m_text(event.m_text)
1976 { }
1977
1978 bool GetChecked() const { return m_checked; }
1979 bool GetEnabled() const { return m_enabled; }
1980 bool GetShown() const { return m_shown; }
1981 wxString GetText() const { return m_text; }
1982 bool GetSetText() const { return m_setText; }
1983 bool GetSetChecked() const { return m_setChecked; }
1984 bool GetSetEnabled() const { return m_setEnabled; }
1985 bool GetSetShown() const { return m_setShown; }
1986
1987 void Check(bool check) { m_checked = check; m_setChecked = true; }
1988 void Enable(bool enable) { m_enabled = enable; m_setEnabled = true; }
1989 void Show(bool show) { m_shown = show; m_setShown = true; }
1990 void SetText(const wxString& text) { m_text = text; m_setText = true; }
1991
1992 // Sets the interval between updates in milliseconds.
1993 // Set to -1 to disable updates, or to 0 to update as frequently as possible.
1994 static void SetUpdateInterval(long updateInterval) { sm_updateInterval = updateInterval; }
1995
1996 // Returns the current interval between updates in milliseconds
1997 static long GetUpdateInterval() { return sm_updateInterval; }
1998
1999 // Can we update this window?
2000 static bool CanUpdate(wxWindowBase *win);
2001
2002 // Reset the update time to provide a delay until the next
2003 // time we should update
2004 static void ResetUpdateTime();
2005
2006 // Specify how wxWidgets will send update events: to
2007 // all windows, or only to those which specify that they
2008 // will process the events.
2009 static void SetMode(wxUpdateUIMode mode) { sm_updateMode = mode; }
2010
2011 // Returns the UI update mode
2012 static wxUpdateUIMode GetMode() { return sm_updateMode; }
2013
2014 virtual wxEvent *Clone() const { return new wxUpdateUIEvent(*this); }
2015
2016 protected:
2017 bool m_checked;
2018 bool m_enabled;
2019 bool m_shown;
2020 bool m_setEnabled;
2021 bool m_setShown;
2022 bool m_setText;
2023 bool m_setChecked;
2024 wxString m_text;
2025 #if wxUSE_LONGLONG
2026 static wxLongLong sm_lastUpdate;
2027 #endif
2028 static long sm_updateInterval;
2029 static wxUpdateUIMode sm_updateMode;
2030
2031 private:
2032 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxUpdateUIEvent)
2033 };
2034
2035 /*
2036 wxEVT_SYS_COLOUR_CHANGED
2037 */
2038
2039 // TODO: shouldn't all events record the window ID?
2040 class WXDLLIMPEXP_CORE wxSysColourChangedEvent : public wxEvent
2041 {
2042 public:
2043 wxSysColourChangedEvent()
2044 : wxEvent(0, wxEVT_SYS_COLOUR_CHANGED)
2045 { }
2046
2047 virtual wxEvent *Clone() const { return new wxSysColourChangedEvent(*this); }
2048
2049 private:
2050 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSysColourChangedEvent)
2051 };
2052
2053 /*
2054 wxEVT_MOUSE_CAPTURE_CHANGED
2055 The window losing the capture receives this message
2056 (even if it released the capture itself).
2057 */
2058
2059 class WXDLLIMPEXP_CORE wxMouseCaptureChangedEvent : public wxEvent
2060 {
2061 public:
2062 wxMouseCaptureChangedEvent(wxWindowID winid = 0, wxWindow* gainedCapture = NULL)
2063 : wxEvent(winid, wxEVT_MOUSE_CAPTURE_CHANGED),
2064 m_gainedCapture(gainedCapture)
2065 { }
2066
2067 wxMouseCaptureChangedEvent(const wxMouseCaptureChangedEvent& event)
2068 : wxEvent(event),
2069 m_gainedCapture(event.m_gainedCapture)
2070 { }
2071
2072 virtual wxEvent *Clone() const { return new wxMouseCaptureChangedEvent(*this); }
2073
2074 wxWindow* GetCapturedWindow() const { return m_gainedCapture; }
2075
2076 private:
2077 wxWindow* m_gainedCapture;
2078
2079 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureChangedEvent)
2080 };
2081
2082 /*
2083 wxEVT_MOUSE_CAPTURE_LOST
2084 The window losing the capture receives this message, unless it released it
2085 it itself or unless wxWindow::CaptureMouse was called on another window
2086 (and so capture will be restored when the new capturer releases it).
2087 */
2088
2089 class WXDLLIMPEXP_CORE wxMouseCaptureLostEvent : public wxEvent
2090 {
2091 public:
2092 wxMouseCaptureLostEvent(wxWindowID winid = 0)
2093 : wxEvent(winid, wxEVT_MOUSE_CAPTURE_LOST)
2094 {}
2095
2096 wxMouseCaptureLostEvent(const wxMouseCaptureLostEvent& event)
2097 : wxEvent(event)
2098 {}
2099
2100 virtual wxEvent *Clone() const { return new wxMouseCaptureLostEvent(*this); }
2101
2102 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureLostEvent)
2103 };
2104
2105 /*
2106 wxEVT_DISPLAY_CHANGED
2107 */
2108 class WXDLLIMPEXP_CORE wxDisplayChangedEvent : public wxEvent
2109 {
2110 private:
2111 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDisplayChangedEvent)
2112
2113 public:
2114 wxDisplayChangedEvent()
2115 : wxEvent(0, wxEVT_DISPLAY_CHANGED)
2116 { }
2117
2118 virtual wxEvent *Clone() const { return new wxDisplayChangedEvent(*this); }
2119 };
2120
2121 /*
2122 wxEVT_PALETTE_CHANGED
2123 */
2124
2125 class WXDLLIMPEXP_CORE wxPaletteChangedEvent : public wxEvent
2126 {
2127 public:
2128 wxPaletteChangedEvent(wxWindowID winid = 0)
2129 : wxEvent(winid, wxEVT_PALETTE_CHANGED),
2130 m_changedWindow(NULL)
2131 { }
2132
2133 wxPaletteChangedEvent(const wxPaletteChangedEvent& event)
2134 : wxEvent(event),
2135 m_changedWindow(event.m_changedWindow)
2136 { }
2137
2138 void SetChangedWindow(wxWindow* win) { m_changedWindow = win; }
2139 wxWindow* GetChangedWindow() const { return m_changedWindow; }
2140
2141 virtual wxEvent *Clone() const { return new wxPaletteChangedEvent(*this); }
2142
2143 protected:
2144 wxWindow* m_changedWindow;
2145
2146 private:
2147 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaletteChangedEvent)
2148 };
2149
2150 /*
2151 wxEVT_QUERY_NEW_PALETTE
2152 Indicates the window is getting keyboard focus and should re-do its palette.
2153 */
2154
2155 class WXDLLIMPEXP_CORE wxQueryNewPaletteEvent : public wxEvent
2156 {
2157 public:
2158 wxQueryNewPaletteEvent(wxWindowID winid = 0)
2159 : wxEvent(winid, wxEVT_QUERY_NEW_PALETTE),
2160 m_paletteRealized(false)
2161 { }
2162 wxQueryNewPaletteEvent(const wxQueryNewPaletteEvent & event)
2163 : wxEvent(event),
2164 m_paletteRealized(event.m_paletteRealized)
2165 { }
2166
2167 // App sets this if it changes the palette.
2168 void SetPaletteRealized(bool realized) { m_paletteRealized = realized; }
2169 bool GetPaletteRealized() const { return m_paletteRealized; }
2170
2171 virtual wxEvent *Clone() const { return new wxQueryNewPaletteEvent(*this); }
2172
2173 protected:
2174 bool m_paletteRealized;
2175
2176 private:
2177 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxQueryNewPaletteEvent)
2178 };
2179
2180 /*
2181 Event generated by dialog navigation keys
2182 wxEVT_NAVIGATION_KEY
2183 */
2184 // NB: don't derive from command event to avoid being propagated to the parent
2185 class WXDLLIMPEXP_CORE wxNavigationKeyEvent : public wxEvent
2186 {
2187 public:
2188 wxNavigationKeyEvent()
2189 : wxEvent(0, wxEVT_NAVIGATION_KEY),
2190 m_flags(IsForward | FromTab), // defaults are for TAB
2191 m_focus(NULL)
2192 {
2193 m_propagationLevel = wxEVENT_PROPAGATE_NONE;
2194 }
2195
2196 wxNavigationKeyEvent(const wxNavigationKeyEvent& event)
2197 : wxEvent(event),
2198 m_flags(event.m_flags),
2199 m_focus(event.m_focus)
2200 { }
2201
2202 // direction: forward (true) or backward (false)
2203 bool GetDirection() const
2204 { return (m_flags & IsForward) != 0; }
2205 void SetDirection(bool bForward)
2206 { if ( bForward ) m_flags |= IsForward; else m_flags &= ~IsForward; }
2207
2208 // it may be a window change event (MDI, notebook pages...) or a control
2209 // change event
2210 bool IsWindowChange() const
2211 { return (m_flags & WinChange) != 0; }
2212 void SetWindowChange(bool bIs)
2213 { if ( bIs ) m_flags |= WinChange; else m_flags &= ~WinChange; }
2214
2215 // Set to true under MSW if the event was generated using the tab key.
2216 // This is required for proper navogation over radio buttons
2217 bool IsFromTab() const
2218 { return (m_flags & FromTab) != 0; }
2219 void SetFromTab(bool bIs)
2220 { if ( bIs ) m_flags |= FromTab; else m_flags &= ~FromTab; }
2221
2222 // the child which has the focus currently (may be NULL - use
2223 // wxWindow::FindFocus then)
2224 wxWindow* GetCurrentFocus() const { return m_focus; }
2225 void SetCurrentFocus(wxWindow *win) { m_focus = win; }
2226
2227 // Set flags
2228 void SetFlags(long flags) { m_flags = flags; }
2229
2230 virtual wxEvent *Clone() const { return new wxNavigationKeyEvent(*this); }
2231
2232 enum
2233 {
2234 IsBackward = 0x0000,
2235 IsForward = 0x0001,
2236 WinChange = 0x0002,
2237 FromTab = 0x0004
2238 };
2239
2240 long m_flags;
2241 wxWindow *m_focus;
2242
2243 private:
2244 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNavigationKeyEvent)
2245 };
2246
2247 // Window creation/destruction events: the first is sent as soon as window is
2248 // created (i.e. the underlying GUI object exists), but when the C++ object is
2249 // fully initialized (so virtual functions may be called). The second,
2250 // wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
2251 // still safe to call virtual functions at this moment
2252 /*
2253 wxEVT_CREATE
2254 wxEVT_DESTROY
2255 */
2256
2257 class WXDLLIMPEXP_CORE wxWindowCreateEvent : public wxCommandEvent
2258 {
2259 public:
2260 wxWindowCreateEvent(wxWindow *win = NULL);
2261
2262 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
2263
2264 virtual wxEvent *Clone() const { return new wxWindowCreateEvent(*this); }
2265
2266 private:
2267 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowCreateEvent)
2268 };
2269
2270 class WXDLLIMPEXP_CORE wxWindowDestroyEvent : public wxCommandEvent
2271 {
2272 public:
2273 wxWindowDestroyEvent(wxWindow *win = NULL);
2274
2275 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
2276
2277 virtual wxEvent *Clone() const { return new wxWindowDestroyEvent(*this); }
2278
2279 private:
2280 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowDestroyEvent)
2281 };
2282
2283 // A help event is sent when the user clicks on a window in context-help mode.
2284 /*
2285 wxEVT_HELP
2286 wxEVT_DETAILED_HELP
2287 */
2288
2289 class WXDLLIMPEXP_CORE wxHelpEvent : public wxCommandEvent
2290 {
2291 public:
2292 // how was this help event generated?
2293 enum Origin
2294 {
2295 Origin_Unknown, // unrecognized event source
2296 Origin_Keyboard, // event generated from F1 key press
2297 Origin_HelpButton // event from [?] button on the title bar (Windows)
2298 };
2299
2300 wxHelpEvent(wxEventType type = wxEVT_NULL,
2301 wxWindowID winid = 0,
2302 const wxPoint& pt = wxDefaultPosition,
2303 Origin origin = Origin_Unknown)
2304 : wxCommandEvent(type, winid),
2305 m_pos(pt),
2306 m_origin(GuessOrigin(origin))
2307 { }
2308 wxHelpEvent(const wxHelpEvent & event)
2309 : wxCommandEvent(event),
2310 m_pos(event.m_pos),
2311 m_target(event.m_target),
2312 m_link(event.m_link),
2313 m_origin(event.m_origin)
2314 { }
2315
2316 // Position of event (in screen coordinates)
2317 const wxPoint& GetPosition() const { return m_pos; }
2318 void SetPosition(const wxPoint& pos) { m_pos = pos; }
2319
2320 // Optional link to further help
2321 const wxString& GetLink() const { return m_link; }
2322 void SetLink(const wxString& link) { m_link = link; }
2323
2324 // Optional target to display help in. E.g. a window specification
2325 const wxString& GetTarget() const { return m_target; }
2326 void SetTarget(const wxString& target) { m_target = target; }
2327
2328 virtual wxEvent *Clone() const { return new wxHelpEvent(*this); }
2329
2330 // optional indication of the event source
2331 Origin GetOrigin() const { return m_origin; }
2332 void SetOrigin(Origin origin) { m_origin = origin; }
2333
2334 protected:
2335 wxPoint m_pos;
2336 wxString m_target;
2337 wxString m_link;
2338 Origin m_origin;
2339
2340 // we can try to guess the event origin ourselves, even if none is
2341 // specified in the ctor
2342 static Origin GuessOrigin(Origin origin);
2343
2344 private:
2345 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHelpEvent)
2346 };
2347
2348 // A Clipboard Text event is sent when a window intercepts text copy/cut/paste
2349 // message, i.e. the user has cut/copied/pasted data from/into a text control
2350 // via ctrl-C/X/V, ctrl/shift-del/insert, a popup menu command, etc.
2351 // NOTE : under windows these events are *NOT* generated automatically
2352 // for a Rich Edit text control.
2353 /*
2354 wxEVT_COMMAND_TEXT_COPY
2355 wxEVT_COMMAND_TEXT_CUT
2356 wxEVT_COMMAND_TEXT_PASTE
2357 */
2358
2359 class WXDLLIMPEXP_CORE wxClipboardTextEvent : public wxCommandEvent
2360 {
2361 public:
2362 wxClipboardTextEvent(wxEventType type = wxEVT_NULL,
2363 wxWindowID winid = 0)
2364 : wxCommandEvent(type, winid)
2365 { }
2366 wxClipboardTextEvent(const wxClipboardTextEvent & event)
2367 : wxCommandEvent(event)
2368 { }
2369
2370 virtual wxEvent *Clone() const { return new wxClipboardTextEvent(*this); }
2371
2372 private:
2373 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxClipboardTextEvent)
2374 };
2375
2376 // A Context event is sent when the user right clicks on a window or
2377 // presses Shift-F10
2378 // NOTE : Under windows this is a repackaged WM_CONTETXMENU message
2379 // Under other systems it may have to be generated from a right click event
2380 /*
2381 wxEVT_CONTEXT_MENU
2382 */
2383
2384 class WXDLLIMPEXP_CORE wxContextMenuEvent : public wxCommandEvent
2385 {
2386 public:
2387 wxContextMenuEvent(wxEventType type = wxEVT_NULL,
2388 wxWindowID winid = 0,
2389 const wxPoint& pt = wxDefaultPosition)
2390 : wxCommandEvent(type, winid),
2391 m_pos(pt)
2392 { }
2393 wxContextMenuEvent(const wxContextMenuEvent & event)
2394 : wxCommandEvent(event),
2395 m_pos(event.m_pos)
2396 { }
2397
2398 // Position of event (in screen coordinates)
2399 const wxPoint& GetPosition() const { return m_pos; }
2400 void SetPosition(const wxPoint& pos) { m_pos = pos; }
2401
2402 virtual wxEvent *Clone() const { return new wxContextMenuEvent(*this); }
2403
2404 protected:
2405 wxPoint m_pos;
2406
2407 private:
2408 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxContextMenuEvent)
2409 };
2410
2411 #endif // wxUSE_GUI
2412
2413 // Idle event
2414 /*
2415 wxEVT_IDLE
2416 */
2417
2418 // Whether to always send idle events to windows, or
2419 // to only send update events to those with the
2420 // wxWS_EX_PROCESS_IDLE style.
2421
2422 enum wxIdleMode
2423 {
2424 // Send idle events to all windows
2425 wxIDLE_PROCESS_ALL,
2426
2427 // Send idle events to windows that have
2428 // the wxWS_EX_PROCESS_IDLE flag specified
2429 wxIDLE_PROCESS_SPECIFIED
2430 };
2431
2432 class WXDLLIMPEXP_BASE wxIdleEvent : public wxEvent
2433 {
2434 public:
2435 wxIdleEvent()
2436 : wxEvent(0, wxEVT_IDLE),
2437 m_requestMore(false)
2438 { }
2439 wxIdleEvent(const wxIdleEvent & event)
2440 : wxEvent(event),
2441 m_requestMore(event.m_requestMore)
2442 { }
2443
2444 void RequestMore(bool needMore = true) { m_requestMore = needMore; }
2445 bool MoreRequested() const { return m_requestMore; }
2446
2447 virtual wxEvent *Clone() const { return new wxIdleEvent(*this); }
2448
2449 // Specify how wxWidgets will send idle events: to
2450 // all windows, or only to those which specify that they
2451 // will process the events.
2452 static void SetMode(wxIdleMode mode) { sm_idleMode = mode; }
2453
2454 // Returns the idle event mode
2455 static wxIdleMode GetMode() { return sm_idleMode; }
2456
2457 protected:
2458 bool m_requestMore;
2459 static wxIdleMode sm_idleMode;
2460
2461 private:
2462 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIdleEvent)
2463 };
2464
2465 /* TODO
2466 wxEVT_MOUSE_CAPTURE_CHANGED,
2467 wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
2468 // wxEVT_FONT_CHANGED, // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
2469 // wxEVT_FONT_CHANGED to all other windows (maybe).
2470 wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
2471 wxEVT_MEASURE_ITEM,
2472 wxEVT_COMPARE_ITEM
2473 */
2474
2475
2476 // ============================================================================
2477 // event handler and related classes
2478 // ============================================================================
2479
2480
2481 // struct containing the members common to static and dynamic event tables
2482 // entries
2483 struct WXDLLIMPEXP_BASE wxEventTableEntryBase
2484 {
2485 wxEventTableEntryBase(int winid, int idLast,
2486 wxEventFunctor* fn, wxObject *data)
2487 : m_id(winid),
2488 m_lastId(idLast),
2489 m_fn(fn),
2490 m_callbackUserData(data)
2491 { }
2492
2493 wxEventTableEntryBase( const wxEventTableEntryBase &entry )
2494 : m_id( entry.m_id ),
2495 m_lastId( entry.m_lastId ),
2496 m_fn( entry.m_fn ),
2497 m_callbackUserData( entry.m_callbackUserData )
2498 {
2499 // This is a 'hack' to ensure that only one instance tries to delete
2500 // the functor pointer. It is safe as long as the only place where the
2501 // copy constructor is being called is when the static event tables are
2502 // being initialized (a temporary instance is created and then this
2503 // constructor is called).
2504
2505 const_cast< wxEventTableEntryBase & >( entry ).m_fn = NULL;
2506 }
2507
2508 ~wxEventTableEntryBase()
2509 {
2510 delete m_fn;
2511 }
2512
2513 // the range of ids for this entry: if m_lastId == wxID_ANY, the range
2514 // consists only of m_id, otherwise it is m_id..m_lastId inclusive
2515 int m_id,
2516 m_lastId;
2517
2518 // function/method/functor to call
2519 wxEventFunctor* m_fn;
2520
2521 // arbitrary user data associated with the callback
2522 wxObject* m_callbackUserData;
2523
2524 private:
2525 wxEventTableEntryBase &operator = ( const wxEventTableEntryBase & );
2526 };
2527
2528 // an entry from a static event table
2529 struct WXDLLIMPEXP_BASE wxEventTableEntry : public wxEventTableEntryBase
2530 {
2531 wxEventTableEntry(const int& evType, int winid, int idLast,
2532 wxEventFunctor* fn, wxObject *data)
2533 : wxEventTableEntryBase(winid, idLast, fn, data),
2534 m_eventType(evType)
2535 { }
2536
2537 // the reference to event type: this allows us to not care about the
2538 // (undefined) order in which the event table entries and the event types
2539 // are initialized: initially the value of this reference might be
2540 // invalid, but by the time it is used for the first time, all global
2541 // objects will have been initialized (including the event type constants)
2542 // and so it will have the correct value when it is needed
2543 const int& m_eventType;
2544
2545 private:
2546 wxEventTableEntry &operator = ( const wxEventTableEntry & );
2547 };
2548
2549 // an entry used in dynamic event table managed by wxEvtHandler::Connect()
2550 struct WXDLLIMPEXP_BASE wxDynamicEventTableEntry : public wxEventTableEntryBase
2551 {
2552 wxDynamicEventTableEntry(int evType, int winid, int idLast,
2553 wxEventFunctor* fn, wxObject *data)
2554 : wxEventTableEntryBase(winid, idLast, fn, data),
2555 m_eventType(evType)
2556 { }
2557
2558 // not a reference here as we can't keep a reference to a temporary int
2559 // created to wrap the constant value typically passed to Connect() - nor
2560 // do we need it
2561 int m_eventType;
2562
2563 private:
2564 wxDynamicEventTableEntry &operator = ( const wxDynamicEventTableEntry & );
2565 };
2566
2567 // ----------------------------------------------------------------------------
2568 // wxEventTable: an array of event entries terminated with {0, 0, 0, 0, 0}
2569 // ----------------------------------------------------------------------------
2570
2571 struct WXDLLIMPEXP_BASE wxEventTable
2572 {
2573 const wxEventTable *baseTable; // base event table (next in chain)
2574 const wxEventTableEntry *entries; // bottom of entry array
2575 };
2576
2577 // ----------------------------------------------------------------------------
2578 // wxEventHashTable: a helper of wxEvtHandler to speed up wxEventTable lookups.
2579 // ----------------------------------------------------------------------------
2580
2581 WX_DEFINE_ARRAY_PTR(const wxEventTableEntry*, wxEventTableEntryPointerArray);
2582
2583 class WXDLLIMPEXP_BASE wxEventHashTable
2584 {
2585 private:
2586 // Internal data structs
2587 struct EventTypeTable
2588 {
2589 wxEventType eventType;
2590 wxEventTableEntryPointerArray eventEntryTable;
2591 };
2592 typedef EventTypeTable* EventTypeTablePointer;
2593
2594 public:
2595 // Constructor, needs the event table it needs to hash later on.
2596 // Note: hashing of the event table is not done in the constructor as it
2597 // can be that the event table is not yet full initialize, the hash
2598 // will gets initialized when handling the first event look-up request.
2599 wxEventHashTable(const wxEventTable &table);
2600 // Destructor.
2601 ~wxEventHashTable();
2602
2603 // Handle the given event, in other words search the event table hash
2604 // and call self->ProcessEvent() if a match was found.
2605 bool HandleEvent(wxEvent &event, wxEvtHandler *self);
2606
2607 // Clear table
2608 void Clear();
2609
2610 #if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
2611 // Clear all tables
2612 static void ClearAll();
2613 #endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING
2614
2615 protected:
2616 // Init the hash table with the entries of the static event table.
2617 void InitHashTable();
2618 // Helper funtion of InitHashTable() to insert 1 entry into the hash table.
2619 void AddEntry(const wxEventTableEntry &entry);
2620 // Allocate and init with null pointers the base hash table.
2621 void AllocEventTypeTable(size_t size);
2622 // Grow the hash table in size and transfer all items currently
2623 // in the table to the correct location in the new table.
2624 void GrowEventTypeTable();
2625
2626 protected:
2627 const wxEventTable &m_table;
2628 bool m_rebuildHash;
2629
2630 size_t m_size;
2631 EventTypeTablePointer *m_eventTypeTable;
2632
2633 static wxEventHashTable* sm_first;
2634 wxEventHashTable* m_previous;
2635 wxEventHashTable* m_next;
2636
2637 DECLARE_NO_COPY_CLASS(wxEventHashTable)
2638 };
2639
2640 // ----------------------------------------------------------------------------
2641 // wxEvtHandler: the base class for all objects handling wxWidgets events
2642 // ----------------------------------------------------------------------------
2643
2644 class WXDLLIMPEXP_BASE wxEvtHandler : public wxObject
2645 , public wxTrackable
2646 {
2647 public:
2648 wxEvtHandler();
2649 virtual ~wxEvtHandler();
2650
2651 wxEvtHandler *GetNextHandler() const { return m_nextHandler; }
2652 wxEvtHandler *GetPreviousHandler() const { return m_previousHandler; }
2653 void SetNextHandler(wxEvtHandler *handler) { m_nextHandler = handler; }
2654 void SetPreviousHandler(wxEvtHandler *handler) { m_previousHandler = handler; }
2655
2656 void SetEvtHandlerEnabled(bool enabled) { m_enabled = enabled; }
2657 bool GetEvtHandlerEnabled() const { return m_enabled; }
2658
2659 // Process an event right now: this can only be called from the main
2660 // thread, use QueueEvent() for scheduling the events for
2661 // processing from other threads.
2662 virtual bool ProcessEvent(wxEvent& event);
2663
2664 // Process an event by calling ProcessEvent and handling any exceptions
2665 // thrown by event handlers. It's mostly useful when processing wx events
2666 // when called from C code (e.g. in GTK+ callback) when the exception
2667 // wouldn't correctly propagate to wxEventLoop.
2668 bool SafelyProcessEvent(wxEvent& event);
2669
2670 // Schedule the given event to be processed later. It takes ownership of
2671 // the event pointer, i.e. it will be deleted later. This is safe to call
2672 // from multiple threads although you still need to ensure that wxString
2673 // fields of the event object are deep copies and not use the same string
2674 // buffer as other wxString objects in this thread.
2675 virtual void QueueEvent(wxEvent *event);
2676
2677 // Add an event to be processed later: notice that this function is not
2678 // safe to call from threads other than main, use QueueEvent()
2679 virtual void AddPendingEvent(const wxEvent& event)
2680 {
2681 // notice that the thread-safety problem comes from the fact that
2682 // Clone() doesn't make deep copies of wxString fields of wxEvent
2683 // object and so the same wxString could be used from both threads when
2684 // the event object is destroyed in this one -- QueueEvent() avoids
2685 // this problem as the event pointer is not used any more in this
2686 // thread at all after it is called.
2687 QueueEvent(event.Clone());
2688 }
2689
2690 void ProcessPendingEvents();
2691
2692 #if wxUSE_THREADS
2693 bool ProcessThreadEvent(const wxEvent& event);
2694 #endif
2695
2696 // Dynamic association of a member function handler with the event handler,
2697 // winid and event type
2698 void Connect(int winid,
2699 int lastId,
2700 wxEventType eventType,
2701 wxObjectEventFunction func,
2702 wxObject *userData = NULL,
2703 wxEvtHandler *eventSink = NULL)
2704 {
2705 wxObjectEventFunctor *functor = wxNewEventFunctor( eventType, func, eventSink );
2706
2707 Subscribe( winid, lastId, eventType, functor, userData );
2708 }
2709
2710 // Convenience function: take just one id
2711 void Connect(int winid,
2712 wxEventType eventType,
2713 wxObjectEventFunction func,
2714 wxObject *userData = NULL,
2715 wxEvtHandler *eventSink = NULL)
2716 { Connect(winid, wxID_ANY, eventType, func, userData, eventSink); }
2717
2718 // Even more convenient: without id (same as using id of wxID_ANY)
2719 void Connect(wxEventType eventType,
2720 wxObjectEventFunction func,
2721 wxObject *userData = NULL,
2722 wxEvtHandler *eventSink = NULL)
2723 { Connect(wxID_ANY, wxID_ANY, eventType, func, userData, eventSink); }
2724
2725 bool Disconnect(int winid,
2726 int lastId,
2727 wxEventType eventType,
2728 wxObjectEventFunction func = NULL,
2729 wxObject *userData = NULL,
2730 wxEvtHandler *eventSink = NULL)
2731 {
2732 wxObjectEventFunctor functor = wxConstructEventFunctor( eventType, func, eventSink );
2733
2734 return Unsubscribe( winid, lastId, eventType, functor, userData );
2735 }
2736
2737 bool Disconnect(int winid = wxID_ANY,
2738 wxEventType eventType = wxEVT_NULL,
2739 wxObjectEventFunction func = NULL,
2740 wxObject *userData = NULL,
2741 wxEvtHandler *eventSink = NULL)
2742 { return Disconnect(winid, wxID_ANY, eventType, func, userData, eventSink); }
2743
2744 bool Disconnect(wxEventType eventType,
2745 wxObjectEventFunction func,
2746 wxObject *userData = NULL,
2747 wxEvtHandler *eventSink = NULL)
2748 { return Disconnect(wxID_ANY, eventType, func, userData, eventSink); }
2749
2750
2751 #if !wxEVENTS_COMPATIBILITY_2_8
2752 //
2753 // Connect a function to an event:
2754 //
2755 template <typename EventType>
2756 void Connect(int winid,
2757 int lastId,
2758 const EventType &eventType,
2759 void (*func)(typename EventType::CorrespondingEvent&),
2760 wxObject* userData = NULL)
2761 {
2762 wxEventFunctorFunction< EventType > *functor = wxNewEventFunctor( eventType, func );
2763
2764 Subscribe( winid, lastId, eventType, functor, userData );
2765 }
2766
2767 template <typename EventType>
2768 void Connect( int winid,
2769 const EventType &eventType,
2770 void ( *func )( typename EventType::CorrespondingEvent & ),
2771 wxObject* userData = NULL )
2772 { Connect( winid, wxID_ANY, eventType, func, userData ); }
2773
2774 template <typename EventType>
2775 void Connect( const EventType &eventType,
2776 void ( *func )( typename EventType::CorrespondingEvent & ),
2777 wxObject* userData = NULL )
2778 { Connect( wxID_ANY, wxID_ANY, eventType, func, userData ); }
2779
2780 //
2781 // Connect a method to an event:
2782 //
2783
2784 template <typename EventType, typename Class>
2785 void Connect( int winid,
2786 int lastId,
2787 const EventType &eventType,
2788 void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2789 wxObject *userData = NULL )
2790 {
2791 wxEventFunctorMethod< EventType, Class, Class > *functor =
2792 wxNewEventFunctor( eventType, func, static_cast< Class * const >( this ));
2793
2794 Subscribe( winid, lastId, eventType, functor, userData );
2795 }
2796
2797 template <typename EventType, typename Class>
2798 void Connect( int winid,
2799 const EventType &eventType,
2800 void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2801 wxObject *userData = NULL )
2802 { Connect( winid, wxID_ANY, eventType, func, userData ); }
2803
2804 template <typename EventType, typename Class>
2805 void Connect( const EventType &eventType,
2806 void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2807 wxObject *userData = NULL )
2808 { Connect( wxID_ANY, wxID_ANY, eventType, func, userData ); }
2809
2810 template <typename EventType, typename Class, typename Derived>
2811 void Connect( int winid,
2812 int lastId,
2813 const EventType &eventType,
2814 void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2815 wxObject *userData = NULL,
2816 Derived *eventSink = NULL )
2817 {
2818 wxEventFunctorMethod< EventType, Class, Derived > *functor =
2819 wxNewEventFunctor( eventType, func, eventSink );
2820
2821 Subscribe( winid, lastId, eventType, functor, userData );
2822 }
2823
2824 template <typename EventType, typename Class, typename Derived>
2825 void Connect( int winid,
2826 const EventType &eventType,
2827 void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2828 wxObject *userData = NULL,
2829 Derived *eventSink = NULL )
2830 { Connect( winid, wxID_ANY, eventType, func, userData, eventSink ); }
2831
2832 template <typename EventType, typename Class, typename Derived>
2833 void Connect( const EventType &eventType,
2834 void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2835 wxObject *userData = NULL,
2836 Derived *eventSink = NULL )
2837 { Connect( wxID_ANY, wxID_ANY, eventType, func, userData, eventSink ); }
2838
2839 template <typename Sender, typename EventType, typename Class, typename Derived>
2840 static void Connect( Sender *sender,
2841 int winid,
2842 int lastId,
2843 const EventType &eventType,
2844 void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2845 wxObject *userData = NULL,
2846 Derived *eventSink = NULL )
2847 {
2848 wxEventFunctorMethod< EventType, Class, Derived > *functor =
2849 wxNewEventFunctor( eventType, func, eventSink );
2850
2851 sender->Subscribe( winid, lastId, eventType, functor, userData );
2852 }
2853
2854 template <typename Sender, typename EventType, typename Class, typename Derived>
2855 static void Connect( Sender *sender,
2856 int winid,
2857 const EventType &eventType,
2858 void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2859 wxObject *userData = NULL,
2860 Derived *eventSink = NULL )
2861 { Connect( sender, winid, wxID_ANY, eventType, func, userData, eventSink ); }
2862
2863 template <typename Sender, typename EventType, typename Class, typename Derived>
2864 static void Connect( Sender *sender,
2865 const EventType &eventType,
2866 void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2867 wxObject *userData = NULL,
2868 Derived *eventSink = NULL )
2869 { Connect( sender, wxID_ANY, wxID_ANY, eventType, func, userData, eventSink ); }
2870
2871 //
2872 // Connect an arbitrary functor to an event:
2873 //
2874
2875 template <typename EventType, typename Functor>
2876 void Connect( int winid,
2877 int lastId,
2878 const EventType &eventType,
2879 Functor &functor,
2880 wxObject* userData = NULL)
2881 {
2882 wxEventFunctorAdapter< EventType, Functor > *adapter =
2883 wxNewEventFunctor( eventType, functor );
2884
2885 Subscribe( winid, lastId, eventType, adapter, userData );
2886 }
2887 template <typename EventType, typename Functor>
2888 void Connect( int winid,
2889 const EventType &eventType,
2890 Functor &functor,
2891 wxObject* userData = NULL)
2892 { Connect( winid, wxID_ANY, eventType, functor, userData ); }
2893
2894 template <typename EventType, typename Functor>
2895 void Connect( const EventType &eventType,
2896 Functor &functor,
2897 wxObject* userData = NULL)
2898 { Connect( wxID_ANY, wxID_ANY, eventType, functor, userData ); }
2899
2900 //
2901 // Disconnect a function from an event:
2902 //
2903
2904 template <typename EventType>
2905 bool Disconnect( int winid,
2906 int lastId,
2907 const EventType &eventType,
2908 void ( *func )( typename EventType::CorrespondingEvent & ),
2909 wxObject* userData = NULL )
2910 {
2911 wxEventFunctorFunction< EventType > functor = wxConstructEventFunctor( eventType, func );
2912
2913 return Unsubscribe( winid, lastId, eventType, functor, userData );
2914 }
2915
2916 template <typename EventType>
2917 bool Disconnect( int winid,
2918 const EventType &eventType,
2919 void ( *func )( typename EventType::CorrespondingEvent & ),
2920 wxObject* userData = NULL )
2921 { return Disconnect( winid, wxID_ANY, eventType, func, userData ); }
2922
2923 template <typename EventType>
2924 bool Disconnect( const EventType &eventType,
2925 void ( *func )( typename EventType::CorrespondingEvent & ),
2926 wxObject* userData = NULL )
2927 { return Disconnect( wxID_ANY, wxID_ANY, eventType, func, userData ); }
2928
2929 //
2930 // Disconnect a method from an event:
2931 //
2932
2933 template <typename EventType, typename Class>
2934 bool Disconnect( int winid,
2935 int lastId,
2936 const EventType &eventType,
2937 void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2938 wxObject *userData = NULL )
2939 {
2940 wxEventFunctorMethod< EventType, Class, Class > functor =
2941 wxConstructEventFunctor( eventType, func, static_cast< Class * const >( this ));
2942
2943 return Unsubscribe( winid, lastId, eventType, functor, userData );
2944 }
2945
2946 template <typename EventType, typename Class>
2947 bool Disconnect( int winid,
2948 const EventType &eventType,
2949 void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2950 wxObject *userData = NULL )
2951 { return Disconnect( winid, wxID_ANY, eventType, func, userData ); }
2952
2953 template <typename EventType, typename Class>
2954 bool Disconnect( const EventType &eventType,
2955 void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2956 wxObject *userData = NULL )
2957 { return Disconnect( wxID_ANY, wxID_ANY, eventType, func, userData ); }
2958
2959 template <typename EventType, typename Class, typename Derived>
2960 bool Disconnect( int winid,
2961 int lastId,
2962 const EventType &eventType,
2963 void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2964 wxObject *userData = NULL,
2965 Derived *eventSink = NULL )
2966 {
2967 wxEventFunctorMethod< EventType, Class, Derived > functor =
2968 wxConstructEventFunctor( eventType, func, eventSink );
2969
2970 return Unsubscribe( winid, lastId, eventType, functor, userData );
2971 }
2972
2973 template <typename EventType, typename Class, typename Derived>
2974 bool Disconnect( int winid,
2975 const EventType &eventType,
2976 void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2977 wxObject *userData = NULL,
2978 Derived *eventSink = NULL )
2979 { return Disconnect( winid, wxID_ANY, eventType, func, userData, eventSink ); }
2980
2981 template <typename EventType, typename Class, typename Derived>
2982 bool Disconnect( const EventType &eventType,
2983 void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2984 wxObject *userData = NULL,
2985 Derived *eventSink = NULL )
2986 { return Disconnect( wxID_ANY, wxID_ANY, eventType, func, userData, eventSink ); }
2987
2988 template <typename Sender, typename EventType, typename Class, typename Derived>
2989 static bool Disconnect( Sender *sender,
2990 int winid,
2991 int lastId,
2992 const EventType &eventType,
2993 void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2994 wxObject *userData = NULL,
2995 Derived *eventSink = NULL )
2996 {
2997 wxEventFunctorMethod< EventType, Class, Derived > functor =
2998 wxConstructEventFunctor( eventType, func, eventSink );
2999
3000 return sender->Unsubscribe( winid, lastId, eventType, functor, userData );
3001 }
3002
3003 template <typename Sender, typename EventType, typename Class, typename Derived>
3004 static bool Disconnect( Sender *sender,
3005 int winid,
3006 const EventType &eventType,
3007 void ( Class::*func )( typename EventType::CorrespondingEvent & ),
3008 wxObject *userData = NULL,
3009 Derived *eventSink = NULL )
3010 { return Disconnect( sender, winid, wxID_ANY, eventType, func, userData, eventSink ); }
3011
3012 template <typename Sender, typename EventType, typename Class, typename Derived>
3013 static bool Disconnect( Sender *sender,
3014 const EventType &eventType,
3015 void ( Class::*func )( typename EventType::CorrespondingEvent & ),
3016 wxObject *userData = NULL,
3017 Derived *eventSink = NULL )
3018 { return Disconnect( sender, wxID_ANY, wxID_ANY, eventType, func, userData, eventSink ); }
3019
3020 //
3021 // Disconnect an arbitrary functor from an event:
3022 //
3023
3024 template <typename EventType, typename Functor>
3025 bool Disconnect( int winid,
3026 int lastId,
3027 const EventType &eventType,
3028 Functor &functor,
3029 wxObject* userData = NULL)
3030 {
3031 wxEventFunctorAdapter< EventType, Functor > adapter =
3032 wxConstructEventFunctor( eventType, functor );
3033
3034 return Unsubscribe( winid, lastId, eventType, adapter, userData );
3035 }
3036
3037 template <typename EventType, typename Functor>
3038 bool Disconnect( int winid,
3039 const EventType &eventType,
3040 Functor &functor,
3041 wxObject* userData = NULL)
3042 { return Disconnect( winid, wxID_ANY, eventType, functor, userData ); }
3043
3044 template <typename EventType, typename Functor>
3045 bool Disconnect( const EventType &eventType,
3046 Functor &functor,
3047 wxObject* userData = NULL)
3048 { return Disconnect( wxID_ANY, wxID_ANY, eventType, functor, userData ); }
3049
3050 #endif // !wxEVENTS_COMPATIBILITY_2_8
3051
3052
3053 wxList* GetDynamicEventTable() const { return m_dynamicEvents ; }
3054
3055 // User data can be associated with each wxEvtHandler
3056 void SetClientObject( wxClientData *data ) { DoSetClientObject(data); }
3057 wxClientData *GetClientObject() const { return DoGetClientObject(); }
3058
3059 void SetClientData( void *data ) { DoSetClientData(data); }
3060 void *GetClientData() const { return DoGetClientData(); }
3061
3062
3063 // implementation from now on
3064 // --------------------------
3065
3066 // check if the given event table entry matches this event by id (the check
3067 // for the event type should be done by caller) and call the handler if it
3068 // does
3069 //
3070 // return true if the event was processed, false otherwise (no match or the
3071 // handler decided to skip the event)
3072 static bool ProcessEventIfMatchesId(const wxEventTableEntryBase& tableEntry,
3073 wxEvtHandler *handler,
3074 wxEvent& event);
3075
3076 virtual bool SearchEventTable(wxEventTable& table, wxEvent& event);
3077 bool SearchDynamicEventTable( wxEvent& event );
3078
3079 // Avoid problems at exit by cleaning up static hash table gracefully
3080 void ClearEventHashTable() { GetEventHashTable().Clear(); }
3081 void OnSinkDestroyed( wxEvtHandler *sink );
3082
3083
3084 // The method processing the event in this event handler (or rather in this
3085 // event handler chain as it also tries the next handler and so on), i.e.
3086 // it returns true if we processed this event or false if we didn't but
3087 // does not call TryParent() in the latter case. It also doesn't call
3088 // wxApp::FilterEvent() before processing it, this is supposed to be done
3089 // by the public ProcessEvent() only once for every event we handle.
3090 //
3091 // It is meant to be called from ProcessEvent() only and is not virtual,
3092 // additional event handlers can be hooked into the normal event processing
3093 // logic using TryValidator() hook.
3094 bool ProcessEventHere(wxEvent& event);
3095
3096
3097 private:
3098 void Subscribe(int winid,
3099 int lastId,
3100 wxEventType eventType,
3101 wxEventFunctor *func,
3102 wxObject* userData);
3103
3104 bool Unsubscribe(int winid,
3105 int lastId,
3106 wxEventType eventType,
3107 const wxEventFunctor &func,
3108 wxObject *userData);
3109
3110 static const wxEventTableEntry sm_eventTableEntries[];
3111
3112 protected:
3113 // hooks for wxWindow used by ProcessEvent()
3114 // -----------------------------------------
3115
3116 // This one is called before trying our own event table to allow plugging
3117 // in the validators.
3118 //
3119 // NB: This method is intentionally *not* inside wxUSE_VALIDATORS!
3120 // It is part of wxBase which doesn't use validators and the code
3121 // is compiled out when building wxBase w/o GUI classes, which affects
3122 // binary compatibility and wxBase library can't be used by GUI
3123 // ports.
3124 virtual bool TryValidator(wxEvent& WXUNUSED(event)) { return false; }
3125
3126 // this one is called after failing to find the event handle in our own
3127 // table to give a chance to the other windows to process it
3128 //
3129 // base class implementation passes the event to wxTheApp
3130 virtual bool TryParent(wxEvent& event);
3131
3132
3133 static const wxEventTable sm_eventTable;
3134 virtual const wxEventTable *GetEventTable() const;
3135
3136 static wxEventHashTable sm_eventHashTable;
3137 virtual wxEventHashTable& GetEventHashTable() const;
3138
3139 wxEvtHandler* m_nextHandler;
3140 wxEvtHandler* m_previousHandler;
3141 wxList* m_dynamicEvents;
3142 wxList* m_pendingEvents;
3143
3144 #if wxUSE_THREADS
3145 // critical section protecting m_pendingEvents
3146 wxCriticalSection m_pendingEventsLock;
3147 #endif // wxUSE_THREADS
3148
3149 // Is event handler enabled?
3150 bool m_enabled;
3151
3152
3153 // The user data: either an object which will be deleted by the container
3154 // when it's deleted or some raw pointer which we do nothing with - only
3155 // one type of data can be used with the given window (i.e. you cannot set
3156 // the void data and then associate the container with wxClientData or vice
3157 // versa)
3158 union
3159 {
3160 wxClientData *m_clientObject;
3161 void *m_clientData;
3162 };
3163
3164 // what kind of data do we have?
3165 wxClientDataType m_clientDataType;
3166
3167 // client data accessors
3168 virtual void DoSetClientObject( wxClientData *data );
3169 virtual wxClientData *DoGetClientObject() const;
3170
3171 virtual void DoSetClientData( void *data );
3172 virtual void *DoGetClientData() const;
3173
3174 // Search tracker objects for event connection with this sink
3175 wxEventConnectionRef *FindRefInTrackerList(wxEvtHandler *eventSink);
3176
3177 private:
3178 DECLARE_DYNAMIC_CLASS_NO_COPY(wxEvtHandler)
3179 };
3180
3181 // ----------------------------------------------------------------------------
3182 // wxEventConnectionRef represents all connections between two event handlers
3183 // and enables automatic disconnect when an event handler sink goes out of
3184 // scope. Each connection/disconnect increases/decreases ref count, and
3185 // when it reaches zero the node goes out of scope.
3186 // ----------------------------------------------------------------------------
3187
3188 class wxEventConnectionRef : public wxTrackerNode
3189 {
3190 public:
3191 wxEventConnectionRef() : m_src(NULL), m_sink(NULL), m_refCount(0) { }
3192 wxEventConnectionRef(wxEvtHandler *src, wxEvtHandler *sink)
3193 : m_src(src), m_sink(sink), m_refCount(1)
3194 {
3195 m_sink->AddNode(this);
3196 }
3197
3198 // The sink is being destroyed
3199 virtual void OnObjectDestroy( )
3200 {
3201 if ( m_src )
3202 m_src->OnSinkDestroyed( m_sink );
3203 delete this;
3204 }
3205
3206 virtual wxEventConnectionRef *ToEventConnection() { return this; }
3207
3208 void IncRef() { m_refCount++; }
3209 void DecRef()
3210 {
3211 if ( !--m_refCount )
3212 {
3213 // The sink holds the only external pointer to this object
3214 if ( m_sink )
3215 m_sink->RemoveNode(this);
3216 delete this;
3217 }
3218 }
3219
3220 private:
3221 wxEvtHandler *m_src,
3222 *m_sink;
3223 int m_refCount;
3224
3225 friend class wxEvtHandler;
3226
3227 DECLARE_NO_ASSIGN_CLASS(wxEventConnectionRef)
3228 };
3229
3230 // Post a message to the given event handler which will be processed during the
3231 // next event loop iteration.
3232 //
3233 // Notice that this one is not thread-safe, use wxQueueEvent()
3234 inline void wxPostEvent(wxEvtHandler *dest, const wxEvent& event)
3235 {
3236 wxCHECK_RET( dest, "need an object to post event to" );
3237
3238 dest->AddPendingEvent(event);
3239 }
3240
3241 // Wrapper around wxEvtHandler::QueueEvent(): adds an event for later
3242 // processing, unlike wxPostEvent it is safe to use from different thread even
3243 // for events with wxString members
3244 inline void wxQueueEvent(wxEvtHandler *dest, wxEvent *event)
3245 {
3246 wxCHECK_RET( dest, "need an object to queue event for" );
3247
3248 dest->QueueEvent(event);
3249 }
3250
3251 typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&);
3252 typedef void (wxEvtHandler::*wxIdleEventFunction)(wxIdleEvent&);
3253
3254 #define wxEventHandler(func) \
3255 wxEVENT_HANDLER_CAST(wxEventFunction, func)
3256 #define wxIdleEventHandler(func) \
3257 wxEVENT_HANDLER_CAST(wxIdleEventFunction, func)
3258
3259 #if wxUSE_GUI
3260
3261 // ----------------------------------------------------------------------------
3262 // wxEventBlocker: helper class to temporarily disable event handling for a window
3263 // ----------------------------------------------------------------------------
3264
3265 class WXDLLIMPEXP_CORE wxEventBlocker : public wxEvtHandler
3266 {
3267 public:
3268 wxEventBlocker(wxWindow *win, wxEventType type = wxEVT_ANY);
3269 virtual ~wxEventBlocker();
3270
3271 void Block(wxEventType type)
3272 {
3273 m_eventsToBlock.push_back(type);
3274 }
3275
3276 virtual bool ProcessEvent(wxEvent& event);
3277
3278 protected:
3279 wxArrayInt m_eventsToBlock;
3280 wxWindow *m_window;
3281
3282 DECLARE_NO_COPY_CLASS(wxEventBlocker)
3283 };
3284
3285 typedef void (wxEvtHandler::*wxCommandEventFunction)(wxCommandEvent&);
3286 typedef void (wxEvtHandler::*wxScrollEventFunction)(wxScrollEvent&);
3287 typedef void (wxEvtHandler::*wxScrollWinEventFunction)(wxScrollWinEvent&);
3288 typedef void (wxEvtHandler::*wxSizeEventFunction)(wxSizeEvent&);
3289 typedef void (wxEvtHandler::*wxMoveEventFunction)(wxMoveEvent&);
3290 typedef void (wxEvtHandler::*wxPaintEventFunction)(wxPaintEvent&);
3291 typedef void (wxEvtHandler::*wxNcPaintEventFunction)(wxNcPaintEvent&);
3292 typedef void (wxEvtHandler::*wxEraseEventFunction)(wxEraseEvent&);
3293 typedef void (wxEvtHandler::*wxMouseEventFunction)(wxMouseEvent&);
3294 typedef void (wxEvtHandler::*wxCharEventFunction)(wxKeyEvent&);
3295 typedef void (wxEvtHandler::*wxFocusEventFunction)(wxFocusEvent&);
3296 typedef void (wxEvtHandler::*wxChildFocusEventFunction)(wxChildFocusEvent&);
3297 typedef void (wxEvtHandler::*wxActivateEventFunction)(wxActivateEvent&);
3298 typedef void (wxEvtHandler::*wxMenuEventFunction)(wxMenuEvent&);
3299 typedef void (wxEvtHandler::*wxJoystickEventFunction)(wxJoystickEvent&);
3300 typedef void (wxEvtHandler::*wxDropFilesEventFunction)(wxDropFilesEvent&);
3301 typedef void (wxEvtHandler::*wxInitDialogEventFunction)(wxInitDialogEvent&);
3302 typedef void (wxEvtHandler::*wxSysColourChangedEventFunction)(wxSysColourChangedEvent&);
3303 typedef void (wxEvtHandler::*wxDisplayChangedEventFunction)(wxDisplayChangedEvent&);
3304 typedef void (wxEvtHandler::*wxUpdateUIEventFunction)(wxUpdateUIEvent&);
3305 typedef void (wxEvtHandler::*wxCloseEventFunction)(wxCloseEvent&);
3306 typedef void (wxEvtHandler::*wxShowEventFunction)(wxShowEvent&);
3307 typedef void (wxEvtHandler::*wxIconizeEventFunction)(wxIconizeEvent&);
3308 typedef void (wxEvtHandler::*wxMaximizeEventFunction)(wxMaximizeEvent&);
3309 typedef void (wxEvtHandler::*wxNavigationKeyEventFunction)(wxNavigationKeyEvent&);
3310 typedef void (wxEvtHandler::*wxPaletteChangedEventFunction)(wxPaletteChangedEvent&);
3311 typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction)(wxQueryNewPaletteEvent&);
3312 typedef void (wxEvtHandler::*wxWindowCreateEventFunction)(wxWindowCreateEvent&);
3313 typedef void (wxEvtHandler::*wxWindowDestroyEventFunction)(wxWindowDestroyEvent&);
3314 typedef void (wxEvtHandler::*wxSetCursorEventFunction)(wxSetCursorEvent&);
3315 typedef void (wxEvtHandler::*wxNotifyEventFunction)(wxNotifyEvent&);
3316 typedef void (wxEvtHandler::*wxHelpEventFunction)(wxHelpEvent&);
3317 typedef void (wxEvtHandler::*wxContextMenuEventFunction)(wxContextMenuEvent&);
3318 typedef void (wxEvtHandler::*wxMouseCaptureChangedEventFunction)(wxMouseCaptureChangedEvent&);
3319 typedef void (wxEvtHandler::*wxMouseCaptureLostEventFunction)(wxMouseCaptureLostEvent&);
3320 typedef void (wxEvtHandler::*wxClipboardTextEventFunction)(wxClipboardTextEvent&);
3321
3322
3323 #define wxCommandEventHandler(func) \
3324 wxEVENT_HANDLER_CAST(wxCommandEventFunction, func)
3325 #define wxScrollEventHandler(func) \
3326 wxEVENT_HANDLER_CAST(wxScrollEventFunction, func)
3327 #define wxScrollWinEventHandler(func) \
3328 wxEVENT_HANDLER_CAST(wxScrollWinEventFunction, func)
3329 #define wxSizeEventHandler(func) \
3330 wxEVENT_HANDLER_CAST(wxSizeEventFunction, func)
3331 #define wxMoveEventHandler(func) \
3332 wxEVENT_HANDLER_CAST(wxMoveEventFunction, func)
3333 #define wxPaintEventHandler(func) \
3334 wxEVENT_HANDLER_CAST(wxPaintEventFunction, func)
3335 #define wxNcPaintEventHandler(func) \
3336 wxEVENT_HANDLER_CAST(wxNcPaintEventFunction, func)
3337 #define wxEraseEventHandler(func) \
3338 wxEVENT_HANDLER_CAST(wxEraseEventFunction, func)
3339 #define wxMouseEventHandler(func) \
3340 wxEVENT_HANDLER_CAST(wxMouseEventFunction, func)
3341 #define wxCharEventHandler(func) \
3342 wxEVENT_HANDLER_CAST(wxCharEventFunction, func)
3343 #define wxKeyEventHandler(func) wxCharEventHandler(func)
3344 #define wxFocusEventHandler(func) \
3345 wxEVENT_HANDLER_CAST(wxFocusEventFunction, func)
3346 #define wxChildFocusEventHandler(func) \
3347 wxEVENT_HANDLER_CAST(wxChildFocusEventFunction, func)
3348 #define wxActivateEventHandler(func) \
3349 wxEVENT_HANDLER_CAST(wxActivateEventFunction, func)
3350 #define wxMenuEventHandler(func) \
3351 wxEVENT_HANDLER_CAST(wxMenuEventFunction, func)
3352 #define wxJoystickEventHandler(func) \
3353 wxEVENT_HANDLER_CAST(wxJoystickEventFunction, func)
3354 #define wxDropFilesEventHandler(func) \
3355 wxEVENT_HANDLER_CAST(wxDropFilesEventFunction, func)
3356 #define wxInitDialogEventHandler(func) \
3357 wxEVENT_HANDLER_CAST(wxInitDialogEventFunction, func)
3358 #define wxSysColourChangedEventHandler(func) \
3359 wxEVENT_HANDLER_CAST(wxSysColourChangedEventFunction, func)
3360 #define wxDisplayChangedEventHandler(func) \
3361 wxEVENT_HANDLER_CAST(wxDisplayChangedEventFunction, func)
3362 #define wxUpdateUIEventHandler(func) \
3363 wxEVENT_HANDLER_CAST(wxUpdateUIEventFunction, func)
3364 #define wxCloseEventHandler(func) \
3365 wxEVENT_HANDLER_CAST(wxCloseEventFunction, func)
3366 #define wxShowEventHandler(func) \
3367 wxEVENT_HANDLER_CAST(wxShowEventFunction, func)
3368 #define wxIconizeEventHandler(func) \
3369 wxEVENT_HANDLER_CAST(wxIconizeEventFunction, func)
3370 #define wxMaximizeEventHandler(func) \
3371 wxEVENT_HANDLER_CAST(wxMaximizeEventFunction, func)
3372 #define wxNavigationKeyEventHandler(func) \
3373 wxEVENT_HANDLER_CAST(wxNavigationKeyEventFunction, func)
3374 #define wxPaletteChangedEventHandler(func) \
3375 wxEVENT_HANDLER_CAST(wxPaletteChangedEventFunction, func)
3376 #define wxQueryNewPaletteEventHandler(func) \
3377 wxEVENT_HANDLER_CAST(wxQueryNewPaletteEventFunction, func)
3378 #define wxWindowCreateEventHandler(func) \
3379 wxEVENT_HANDLER_CAST(wxWindowCreateEventFunction, func)
3380 #define wxWindowDestroyEventHandler(func) \
3381 wxEVENT_HANDLER_CAST(wxWindowDestroyEventFunction, func)
3382 #define wxSetCursorEventHandler(func) \
3383 wxEVENT_HANDLER_CAST(wxSetCursorEventFunction, func)
3384 #define wxNotifyEventHandler(func) \
3385 wxEVENT_HANDLER_CAST(wxNotifyEventFunction, func)
3386 #define wxHelpEventHandler(func) \
3387 wxEVENT_HANDLER_CAST(wxHelpEventFunction, func)
3388 #define wxContextMenuEventHandler(func) \
3389 wxEVENT_HANDLER_CAST(wxContextMenuEventFunction, func)
3390 #define wxMouseCaptureChangedEventHandler(func) \
3391 wxEVENT_HANDLER_CAST(wxMouseCaptureChangedEventFunction, func)
3392 #define wxMouseCaptureLostEventHandler(func) \
3393 wxEVENT_HANDLER_CAST(wxMouseCaptureLostEventFunction, func)
3394 #define wxClipboardTextEventHandler(func) \
3395 wxEVENT_HANDLER_CAST(wxClipboardTextEventFunction, func)
3396
3397 #endif // wxUSE_GUI
3398
3399 // N.B. In GNU-WIN32, you *have* to take the address of a member function
3400 // (use &) or the compiler crashes...
3401
3402 #define DECLARE_EVENT_TABLE() \
3403 private: \
3404 static const wxEventTableEntry sm_eventTableEntries[]; \
3405 protected: \
3406 static const wxEventTable sm_eventTable; \
3407 virtual const wxEventTable* GetEventTable() const; \
3408 static wxEventHashTable sm_eventHashTable; \
3409 virtual wxEventHashTable& GetEventHashTable() const;
3410
3411 // N.B.: when building DLL with Borland C++ 5.5 compiler, you must initialize
3412 // sm_eventTable before using it in GetEventTable() or the compiler gives
3413 // E2233 (see http://groups.google.com/groups?selm=397dcc8a%241_2%40dnews)
3414
3415 #define BEGIN_EVENT_TABLE(theClass, baseClass) \
3416 const wxEventTable theClass::sm_eventTable = \
3417 { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] }; \
3418 const wxEventTable *theClass::GetEventTable() const \
3419 { return &theClass::sm_eventTable; } \
3420 wxEventHashTable theClass::sm_eventHashTable(theClass::sm_eventTable); \
3421 wxEventHashTable &theClass::GetEventHashTable() const \
3422 { return theClass::sm_eventHashTable; } \
3423 const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
3424
3425 #define BEGIN_EVENT_TABLE_TEMPLATE1(theClass, baseClass, T1) \
3426 template<typename T1> \
3427 const wxEventTable theClass<T1>::sm_eventTable = \
3428 { &baseClass::sm_eventTable, &theClass<T1>::sm_eventTableEntries[0] }; \
3429 template<typename T1> \
3430 const wxEventTable *theClass<T1>::GetEventTable() const \
3431 { return &theClass<T1>::sm_eventTable; } \
3432 template<typename T1> \
3433 wxEventHashTable theClass<T1>::sm_eventHashTable(theClass<T1>::sm_eventTable); \
3434 template<typename T1> \
3435 wxEventHashTable &theClass<T1>::GetEventHashTable() const \
3436 { return theClass<T1>::sm_eventHashTable; } \
3437 template<typename T1> \
3438 const wxEventTableEntry theClass<T1>::sm_eventTableEntries[] = { \
3439
3440 #define BEGIN_EVENT_TABLE_TEMPLATE2(theClass, baseClass, T1, T2) \
3441 template<typename T1, typename T2> \
3442 const wxEventTable theClass<T1, T2>::sm_eventTable = \
3443 { &baseClass::sm_eventTable, &theClass<T1, T2>::sm_eventTableEntries[0] }; \
3444 template<typename T1, typename T2> \
3445 const wxEventTable *theClass<T1, T2>::GetEventTable() const \
3446 { return &theClass<T1, T2>::sm_eventTable; } \
3447 template<typename T1, typename T2> \
3448 wxEventHashTable theClass<T1, T2>::sm_eventHashTable(theClass<T1, T2>::sm_eventTable); \
3449 template<typename T1, typename T2> \
3450 wxEventHashTable &theClass<T1, T2>::GetEventHashTable() const \
3451 { return theClass<T1, T2>::sm_eventHashTable; } \
3452 template<typename T1, typename T2> \
3453 const wxEventTableEntry theClass<T1, T2>::sm_eventTableEntries[] = { \
3454
3455 #define BEGIN_EVENT_TABLE_TEMPLATE3(theClass, baseClass, T1, T2, T3) \
3456 template<typename T1, typename T2, typename T3> \
3457 const wxEventTable theClass<T1, T2, T3>::sm_eventTable = \
3458 { &baseClass::sm_eventTable, &theClass<T1, T2, T3>::sm_eventTableEntries[0] }; \
3459 template<typename T1, typename T2, typename T3> \
3460 const wxEventTable *theClass<T1, T2, T3>::GetEventTable() const \
3461 { return &theClass<T1, T2, T3>::sm_eventTable; } \
3462 template<typename T1, typename T2, typename T3> \
3463 wxEventHashTable theClass<T1, T2, T3>::sm_eventHashTable(theClass<T1, T2, T3>::sm_eventTable); \
3464 template<typename T1, typename T2, typename T3> \
3465 wxEventHashTable &theClass<T1, T2, T3>::GetEventHashTable() const \
3466 { return theClass<T1, T2, T3>::sm_eventHashTable; } \
3467 template<typename T1, typename T2, typename T3> \
3468 const wxEventTableEntry theClass<T1, T2, T3>::sm_eventTableEntries[] = { \
3469
3470 #define BEGIN_EVENT_TABLE_TEMPLATE4(theClass, baseClass, T1, T2, T3, T4) \
3471 template<typename T1, typename T2, typename T3, typename T4> \
3472 const wxEventTable theClass<T1, T2, T3, T4>::sm_eventTable = \
3473 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4>::sm_eventTableEntries[0] }; \
3474 template<typename T1, typename T2, typename T3, typename T4> \
3475 const wxEventTable *theClass<T1, T2, T3, T4>::GetEventTable() const \
3476 { return &theClass<T1, T2, T3, T4>::sm_eventTable; } \
3477 template<typename T1, typename T2, typename T3, typename T4> \
3478 wxEventHashTable theClass<T1, T2, T3, T4>::sm_eventHashTable(theClass<T1, T2, T3, T4>::sm_eventTable); \
3479 template<typename T1, typename T2, typename T3, typename T4> \
3480 wxEventHashTable &theClass<T1, T2, T3, T4>::GetEventHashTable() const \
3481 { return theClass<T1, T2, T3, T4>::sm_eventHashTable; } \
3482 template<typename T1, typename T2, typename T3, typename T4> \
3483 const wxEventTableEntry theClass<T1, T2, T3, T4>::sm_eventTableEntries[] = { \
3484
3485 #define BEGIN_EVENT_TABLE_TEMPLATE5(theClass, baseClass, T1, T2, T3, T4, T5) \
3486 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3487 const wxEventTable theClass<T1, T2, T3, T4, T5>::sm_eventTable = \
3488 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[0] }; \
3489 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3490 const wxEventTable *theClass<T1, T2, T3, T4, T5>::GetEventTable() const \
3491 { return &theClass<T1, T2, T3, T4, T5>::sm_eventTable; } \
3492 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3493 wxEventHashTable theClass<T1, T2, T3, T4, T5>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5>::sm_eventTable); \
3494 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3495 wxEventHashTable &theClass<T1, T2, T3, T4, T5>::GetEventHashTable() const \
3496 { return theClass<T1, T2, T3, T4, T5>::sm_eventHashTable; } \
3497 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3498 const wxEventTableEntry theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[] = { \
3499
3500 #define BEGIN_EVENT_TABLE_TEMPLATE7(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7) \
3501 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3502 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable = \
3503 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[0] }; \
3504 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3505 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventTable() const \
3506 { return &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable; } \
3507 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3508 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable); \
3509 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3510 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventHashTable() const \
3511 { return theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable; } \
3512 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3513 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[] = { \
3514
3515 #define BEGIN_EVENT_TABLE_TEMPLATE8(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7, T8) \
3516 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3517 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable = \
3518 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[0] }; \
3519 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3520 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventTable() const \
3521 { return &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable; } \
3522 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3523 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable); \
3524 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3525 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventHashTable() const \
3526 { return theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable; } \
3527 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3528 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[] = { \
3529
3530 #define END_EVENT_TABLE() DECLARE_EVENT_TABLE_TERMINATOR() };
3531
3532 /*
3533 * Event table macros
3534 */
3535
3536 // helpers for writing shorter code below: declare an event macro taking 2, 1
3537 // or none ids (the missing ids default to wxID_ANY)
3538 //
3539 // macro arguments:
3540 // - evt one of wxEVT_XXX constants
3541 // - id1, id2 ids of the first/last id
3542 // - fn the function (should be cast to the right type)
3543 #define wx__DECLARE_EVT2(evt, id1, id2, fn) \
3544 DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
3545 #define wx__DECLARE_EVT1(evt, id, fn) \
3546 wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
3547 #define wx__DECLARE_EVT0(evt, fn) \
3548 wx__DECLARE_EVT1(evt, wxID_ANY, fn)
3549
3550
3551 // Generic events
3552 #define EVT_CUSTOM(event, winid, func) \
3553 wx__DECLARE_EVT1(event, winid, wxEventHandler(func))
3554 #define EVT_CUSTOM_RANGE(event, id1, id2, func) \
3555 wx__DECLARE_EVT2(event, id1, id2, wxEventHandler(func))
3556
3557 // EVT_COMMAND
3558 #define EVT_COMMAND(winid, event, func) \
3559 wx__DECLARE_EVT1(event, winid, wxCommandEventHandler(func))
3560
3561 #define EVT_COMMAND_RANGE(id1, id2, event, func) \
3562 wx__DECLARE_EVT2(event, id1, id2, wxCommandEventHandler(func))
3563
3564 #define EVT_NOTIFY(event, winid, func) \
3565 wx__DECLARE_EVT1(event, winid, wxNotifyEventHandler(func))
3566
3567 #define EVT_NOTIFY_RANGE(event, id1, id2, func) \
3568 wx__DECLARE_EVT2(event, id1, id2, wxNotifyEventHandler(func))
3569
3570 // Miscellaneous
3571 #define EVT_SIZE(func) wx__DECLARE_EVT0(wxEVT_SIZE, wxSizeEventHandler(func))
3572 #define EVT_SIZING(func) wx__DECLARE_EVT0(wxEVT_SIZING, wxSizeEventHandler(func))
3573 #define EVT_MOVE(func) wx__DECLARE_EVT0(wxEVT_MOVE, wxMoveEventHandler(func))
3574 #define EVT_MOVING(func) wx__DECLARE_EVT0(wxEVT_MOVING, wxMoveEventHandler(func))
3575 #define EVT_MOVE_START(func) wx__DECLARE_EVT0(wxEVT_MOVE_START, wxMoveEventHandler(func))
3576 #define EVT_MOVE_END(func) wx__DECLARE_EVT0(wxEVT_MOVE_END, wxMoveEventHandler(func))
3577 #define EVT_CLOSE(func) wx__DECLARE_EVT0(wxEVT_CLOSE_WINDOW, wxCloseEventHandler(func))
3578 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3579 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3580 #define EVT_PAINT(func) wx__DECLARE_EVT0(wxEVT_PAINT, wxPaintEventHandler(func))
3581 #define EVT_NC_PAINT(func) wx__DECLARE_EVT0(wxEVT_NC_PAINT, wxNcPaintEventHandler(func))
3582 #define EVT_ERASE_BACKGROUND(func) wx__DECLARE_EVT0(wxEVT_ERASE_BACKGROUND, wxEraseEventHandler(func))
3583 #define EVT_CHAR(func) wx__DECLARE_EVT0(wxEVT_CHAR, wxCharEventHandler(func))
3584 #define EVT_KEY_DOWN(func) wx__DECLARE_EVT0(wxEVT_KEY_DOWN, wxKeyEventHandler(func))
3585 #define EVT_KEY_UP(func) wx__DECLARE_EVT0(wxEVT_KEY_UP, wxKeyEventHandler(func))
3586 #if wxUSE_HOTKEY
3587 #define EVT_HOTKEY(winid, func) wx__DECLARE_EVT1(wxEVT_HOTKEY, winid, wxCharEventHandler(func))
3588 #endif
3589 #define EVT_CHAR_HOOK(func) wx__DECLARE_EVT0(wxEVT_CHAR_HOOK, wxCharEventHandler(func))
3590 #define EVT_MENU_OPEN(func) wx__DECLARE_EVT0(wxEVT_MENU_OPEN, wxMenuEventHandler(func))
3591 #define EVT_MENU_CLOSE(func) wx__DECLARE_EVT0(wxEVT_MENU_CLOSE, wxMenuEventHandler(func))
3592 #define EVT_MENU_HIGHLIGHT(winid, func) wx__DECLARE_EVT1(wxEVT_MENU_HIGHLIGHT, winid, wxMenuEventHandler(func))
3593 #define EVT_MENU_HIGHLIGHT_ALL(func) wx__DECLARE_EVT0(wxEVT_MENU_HIGHLIGHT, wxMenuEventHandler(func))
3594 #define EVT_SET_FOCUS(func) wx__DECLARE_EVT0(wxEVT_SET_FOCUS, wxFocusEventHandler(func))
3595 #define EVT_KILL_FOCUS(func) wx__DECLARE_EVT0(wxEVT_KILL_FOCUS, wxFocusEventHandler(func))
3596 #define EVT_CHILD_FOCUS(func) wx__DECLARE_EVT0(wxEVT_CHILD_FOCUS, wxChildFocusEventHandler(func))
3597 #define EVT_ACTIVATE(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE, wxActivateEventHandler(func))
3598 #define EVT_ACTIVATE_APP(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE_APP, wxActivateEventHandler(func))
3599 #define EVT_HIBERNATE(func) wx__DECLARE_EVT0(wxEVT_HIBERNATE, wxActivateEventHandler(func))
3600 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3601 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3602 #define EVT_DROP_FILES(func) wx__DECLARE_EVT0(wxEVT_DROP_FILES, wxDropFilesEventHandler(func))
3603 #define EVT_INIT_DIALOG(func) wx__DECLARE_EVT0(wxEVT_INIT_DIALOG, wxInitDialogEventHandler(func))
3604 #define EVT_SYS_COLOUR_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEventHandler(func))
3605 #define EVT_DISPLAY_CHANGED(func) wx__DECLARE_EVT0(wxEVT_DISPLAY_CHANGED, wxDisplayChangedEventHandler(func))
3606 #define EVT_SHOW(func) wx__DECLARE_EVT0(wxEVT_SHOW, wxShowEventHandler(func))
3607 #define EVT_MAXIMIZE(func) wx__DECLARE_EVT0(wxEVT_MAXIMIZE, wxMaximizeEventHandler(func))
3608 #define EVT_ICONIZE(func) wx__DECLARE_EVT0(wxEVT_ICONIZE, wxIconizeEventHandler(func))
3609 #define EVT_NAVIGATION_KEY(func) wx__DECLARE_EVT0(wxEVT_NAVIGATION_KEY, wxNavigationKeyEventHandler(func))
3610 #define EVT_PALETTE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_PALETTE_CHANGED, wxPaletteChangedEventHandler(func))
3611 #define EVT_QUERY_NEW_PALETTE(func) wx__DECLARE_EVT0(wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEventHandler(func))
3612 #define EVT_WINDOW_CREATE(func) wx__DECLARE_EVT0(wxEVT_CREATE, wxWindowCreateEventHandler(func))
3613 #define EVT_WINDOW_DESTROY(func) wx__DECLARE_EVT0(wxEVT_DESTROY, wxWindowDestroyEventHandler(func))
3614 #define EVT_SET_CURSOR(func) wx__DECLARE_EVT0(wxEVT_SET_CURSOR, wxSetCursorEventHandler(func))
3615 #define EVT_MOUSE_CAPTURE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEventHandler(func))
3616 #define EVT_MOUSE_CAPTURE_LOST(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEventHandler(func))
3617
3618 // Mouse events
3619 #define EVT_LEFT_DOWN(func) wx__DECLARE_EVT0(wxEVT_LEFT_DOWN, wxMouseEventHandler(func))
3620 #define EVT_LEFT_UP(func) wx__DECLARE_EVT0(wxEVT_LEFT_UP, wxMouseEventHandler(func))
3621 #define EVT_MIDDLE_DOWN(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DOWN, wxMouseEventHandler(func))
3622 #define EVT_MIDDLE_UP(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_UP, wxMouseEventHandler(func))
3623 #define EVT_RIGHT_DOWN(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DOWN, wxMouseEventHandler(func))
3624 #define EVT_RIGHT_UP(func) wx__DECLARE_EVT0(wxEVT_RIGHT_UP, wxMouseEventHandler(func))
3625 #define EVT_MOTION(func) wx__DECLARE_EVT0(wxEVT_MOTION, wxMouseEventHandler(func))
3626 #define EVT_LEFT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_LEFT_DCLICK, wxMouseEventHandler(func))
3627 #define EVT_MIDDLE_DCLICK(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DCLICK, wxMouseEventHandler(func))
3628 #define EVT_RIGHT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DCLICK, wxMouseEventHandler(func))
3629 #define EVT_LEAVE_WINDOW(func) wx__DECLARE_EVT0(wxEVT_LEAVE_WINDOW, wxMouseEventHandler(func))
3630 #define EVT_ENTER_WINDOW(func) wx__DECLARE_EVT0(wxEVT_ENTER_WINDOW, wxMouseEventHandler(func))
3631 #define EVT_MOUSEWHEEL(func) wx__DECLARE_EVT0(wxEVT_MOUSEWHEEL, wxMouseEventHandler(func))
3632 #define EVT_MOUSE_AUX1_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX1_DOWN, wxMouseEventHandler(func))
3633 #define EVT_MOUSE_AUX1_UP(func) wx__DECLARE_EVT0(wxEVT_AUX1_UP, wxMouseEventHandler(func))
3634 #define EVT_MOUSE_AUX1_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX1_DCLICK, wxMouseEventHandler(func))
3635 #define EVT_MOUSE_AUX2_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX2_DOWN, wxMouseEventHandler(func))
3636 #define EVT_MOUSE_AUX2_UP(func) wx__DECLARE_EVT0(wxEVT_AUX2_UP, wxMouseEventHandler(func))
3637 #define EVT_MOUSE_AUX2_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX2_DCLICK, wxMouseEventHandler(func))
3638
3639 // All mouse events
3640 #define EVT_MOUSE_EVENTS(func) \
3641 EVT_LEFT_DOWN(func) \
3642 EVT_LEFT_UP(func) \
3643 EVT_LEFT_DCLICK(func) \
3644 EVT_MIDDLE_DOWN(func) \
3645 EVT_MIDDLE_UP(func) \
3646 EVT_MIDDLE_DCLICK(func) \
3647 EVT_RIGHT_DOWN(func) \
3648 EVT_RIGHT_UP(func) \
3649 EVT_RIGHT_DCLICK(func) \
3650 EVT_MOUSE_AUX1_DOWN(func) \
3651 EVT_MOUSE_AUX1_UP(func) \
3652 EVT_MOUSE_AUX1_DCLICK(func) \
3653 EVT_MOUSE_AUX2_DOWN(func) \
3654 EVT_MOUSE_AUX2_UP(func) \
3655 EVT_MOUSE_AUX2_DCLICK(func) \
3656 EVT_MOTION(func) \
3657 EVT_LEAVE_WINDOW(func) \
3658 EVT_ENTER_WINDOW(func) \
3659 EVT_MOUSEWHEEL(func)
3660
3661 // Scrolling from wxWindow (sent to wxScrolledWindow)
3662 #define EVT_SCROLLWIN_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_TOP, wxScrollWinEventHandler(func))
3663 #define EVT_SCROLLWIN_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEventHandler(func))
3664 #define EVT_SCROLLWIN_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEUP, wxScrollWinEventHandler(func))
3665 #define EVT_SCROLLWIN_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEventHandler(func))
3666 #define EVT_SCROLLWIN_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEventHandler(func))
3667 #define EVT_SCROLLWIN_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEventHandler(func))
3668 #define EVT_SCROLLWIN_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEventHandler(func))
3669 #define EVT_SCROLLWIN_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEventHandler(func))
3670
3671 #define EVT_SCROLLWIN(func) \
3672 EVT_SCROLLWIN_TOP(func) \
3673 EVT_SCROLLWIN_BOTTOM(func) \
3674 EVT_SCROLLWIN_LINEUP(func) \
3675 EVT_SCROLLWIN_LINEDOWN(func) \
3676 EVT_SCROLLWIN_PAGEUP(func) \
3677 EVT_SCROLLWIN_PAGEDOWN(func) \
3678 EVT_SCROLLWIN_THUMBTRACK(func) \
3679 EVT_SCROLLWIN_THUMBRELEASE(func)
3680
3681 // Scrolling from wxSlider and wxScrollBar
3682 #define EVT_SCROLL_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_TOP, wxScrollEventHandler(func))
3683 #define EVT_SCROLL_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLL_BOTTOM, wxScrollEventHandler(func))
3684 #define EVT_SCROLL_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEUP, wxScrollEventHandler(func))
3685 #define EVT_SCROLL_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEDOWN, wxScrollEventHandler(func))
3686 #define EVT_SCROLL_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEUP, wxScrollEventHandler(func))
3687 #define EVT_SCROLL_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler(func))
3688 #define EVT_SCROLL_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler(func))
3689 #define EVT_SCROLL_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBRELEASE, wxScrollEventHandler(func))
3690 #define EVT_SCROLL_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SCROLL_CHANGED, wxScrollEventHandler(func))
3691
3692 #define EVT_SCROLL(func) \
3693 EVT_SCROLL_TOP(func) \
3694 EVT_SCROLL_BOTTOM(func) \
3695 EVT_SCROLL_LINEUP(func) \
3696 EVT_SCROLL_LINEDOWN(func) \
3697 EVT_SCROLL_PAGEUP(func) \
3698 EVT_SCROLL_PAGEDOWN(func) \
3699 EVT_SCROLL_THUMBTRACK(func) \
3700 EVT_SCROLL_THUMBRELEASE(func) \
3701 EVT_SCROLL_CHANGED(func)
3702
3703 // Scrolling from wxSlider and wxScrollBar, with an id
3704 #define EVT_COMMAND_SCROLL_TOP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_TOP, winid, wxScrollEventHandler(func))
3705 #define EVT_COMMAND_SCROLL_BOTTOM(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_BOTTOM, winid, wxScrollEventHandler(func))
3706 #define EVT_COMMAND_SCROLL_LINEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEUP, winid, wxScrollEventHandler(func))
3707 #define EVT_COMMAND_SCROLL_LINEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEDOWN, winid, wxScrollEventHandler(func))
3708 #define EVT_COMMAND_SCROLL_PAGEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEUP, winid, wxScrollEventHandler(func))
3709 #define EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEDOWN, winid, wxScrollEventHandler(func))
3710 #define EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBTRACK, winid, wxScrollEventHandler(func))
3711 #define EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBRELEASE, winid, wxScrollEventHandler(func))
3712 #define EVT_COMMAND_SCROLL_CHANGED(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_CHANGED, winid, wxScrollEventHandler(func))
3713
3714 #define EVT_COMMAND_SCROLL(winid, func) \
3715 EVT_COMMAND_SCROLL_TOP(winid, func) \
3716 EVT_COMMAND_SCROLL_BOTTOM(winid, func) \
3717 EVT_COMMAND_SCROLL_LINEUP(winid, func) \
3718 EVT_COMMAND_SCROLL_LINEDOWN(winid, func) \
3719 EVT_COMMAND_SCROLL_PAGEUP(winid, func) \
3720 EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) \
3721 EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) \
3722 EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) \
3723 EVT_COMMAND_SCROLL_CHANGED(winid, func)
3724
3725 #if WXWIN_COMPATIBILITY_2_6
3726 // compatibility macros for the old name, deprecated in 2.8
3727 #define wxEVT_SCROLL_ENDSCROLL wxEVT_SCROLL_CHANGED
3728 #define EVT_COMMAND_SCROLL_ENDSCROLL EVT_COMMAND_SCROLL_CHANGED
3729 #define EVT_SCROLL_ENDSCROLL EVT_SCROLL_CHANGED
3730 #endif // WXWIN_COMPATIBILITY_2_6
3731
3732 // Convenience macros for commonly-used commands
3733 #define EVT_CHECKBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKBOX_CLICKED, winid, wxCommandEventHandler(func))
3734 #define EVT_CHOICE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHOICE_SELECTED, winid, wxCommandEventHandler(func))
3735 #define EVT_LISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_SELECTED, winid, wxCommandEventHandler(func))
3736 #define EVT_LISTBOX_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, winid, wxCommandEventHandler(func))
3737 #define EVT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_MENU_SELECTED, winid, wxCommandEventHandler(func))
3738 #define EVT_MENU_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_MENU_SELECTED, id1, id2, wxCommandEventHandler(func))
3739 #if defined(__SMARTPHONE__)
3740 # define EVT_BUTTON(winid, func) EVT_MENU(winid, func)
3741 #else
3742 # define EVT_BUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_BUTTON_CLICKED, winid, wxCommandEventHandler(func))
3743 #endif
3744 #define EVT_SLIDER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SLIDER_UPDATED, winid, wxCommandEventHandler(func))
3745 #define EVT_RADIOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBOX_SELECTED, winid, wxCommandEventHandler(func))
3746 #define EVT_RADIOBUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBUTTON_SELECTED, winid, wxCommandEventHandler(func))
3747 // EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events
3748 #define EVT_SCROLLBAR(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SCROLLBAR_UPDATED, winid, wxCommandEventHandler(func))
3749 #define EVT_VLBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_VLBOX_SELECTED, winid, wxCommandEventHandler(func))
3750 #define EVT_COMBOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_SELECTED, winid, wxCommandEventHandler(func))
3751 #define EVT_TOOL(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_CLICKED, winid, wxCommandEventHandler(func))
3752 #define EVT_TOOL_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, winid, wxCommandEventHandler(func))
3753 #define EVT_TOOL_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_CLICKED, id1, id2, wxCommandEventHandler(func))
3754 #define EVT_TOOL_RCLICKED(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_RCLICKED, winid, wxCommandEventHandler(func))
3755 #define EVT_TOOL_RCLICKED_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, wxCommandEventHandler(func))
3756 #define EVT_TOOL_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_ENTER, winid, wxCommandEventHandler(func))
3757 #define EVT_CHECKLISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, winid, wxCommandEventHandler(func))
3758
3759 // Generic command events
3760 #define EVT_COMMAND_LEFT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_CLICK, winid, wxCommandEventHandler(func))
3761 #define EVT_COMMAND_LEFT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_DCLICK, winid, wxCommandEventHandler(func))
3762 #define EVT_COMMAND_RIGHT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_CLICK, winid, wxCommandEventHandler(func))
3763 #define EVT_COMMAND_RIGHT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_DCLICK, winid, wxCommandEventHandler(func))
3764 #define EVT_COMMAND_SET_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SET_FOCUS, winid, wxCommandEventHandler(func))
3765 #define EVT_COMMAND_KILL_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_KILL_FOCUS, winid, wxCommandEventHandler(func))
3766 #define EVT_COMMAND_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_ENTER, winid, wxCommandEventHandler(func))
3767
3768 // Joystick events
3769
3770 #define EVT_JOY_BUTTON_DOWN(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_DOWN, wxJoystickEventHandler(func))
3771 #define EVT_JOY_BUTTON_UP(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_UP, wxJoystickEventHandler(func))
3772 #define EVT_JOY_MOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_MOVE, wxJoystickEventHandler(func))
3773 #define EVT_JOY_ZMOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_ZMOVE, wxJoystickEventHandler(func))
3774
3775 // All joystick events
3776 #define EVT_JOYSTICK_EVENTS(func) \
3777 EVT_JOY_BUTTON_DOWN(func) \
3778 EVT_JOY_BUTTON_UP(func) \
3779 EVT_JOY_MOVE(func) \
3780 EVT_JOY_ZMOVE(func)
3781
3782 // Idle event
3783 #define EVT_IDLE(func) wx__DECLARE_EVT0(wxEVT_IDLE, wxIdleEventHandler(func))
3784
3785 // Update UI event
3786 #define EVT_UPDATE_UI(winid, func) wx__DECLARE_EVT1(wxEVT_UPDATE_UI, winid, wxUpdateUIEventHandler(func))
3787 #define EVT_UPDATE_UI_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_UPDATE_UI, id1, id2, wxUpdateUIEventHandler(func))
3788
3789 // Help events
3790 #define EVT_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_HELP, winid, wxHelpEventHandler(func))
3791 #define EVT_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_HELP, id1, id2, wxHelpEventHandler(func))
3792 #define EVT_DETAILED_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_DETAILED_HELP, winid, wxHelpEventHandler(func))
3793 #define EVT_DETAILED_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_DETAILED_HELP, id1, id2, wxHelpEventHandler(func))
3794
3795 // Context Menu Events
3796 #define EVT_CONTEXT_MENU(func) wx__DECLARE_EVT0(wxEVT_CONTEXT_MENU, wxContextMenuEventHandler(func))
3797 #define EVT_COMMAND_CONTEXT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_CONTEXT_MENU, winid, wxContextMenuEventHandler(func))
3798
3799 // Clipboard text Events
3800 #define EVT_TEXT_CUT(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_CUT, winid, wxClipboardTextEventHandler(func))
3801 #define EVT_TEXT_COPY(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_COPY, winid, wxClipboardTextEventHandler(func))
3802 #define EVT_TEXT_PASTE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_PASTE, winid, wxClipboardTextEventHandler(func))
3803
3804 // ----------------------------------------------------------------------------
3805 // Global data
3806 // ----------------------------------------------------------------------------
3807
3808 // list containing event handlers with pending events for them
3809 //
3810 // notice that each event handler should occur at most once in this list
3811 extern WXDLLIMPEXP_BASE wxList *wxHandlersWithPendingEvents;
3812 #if wxUSE_THREADS
3813 extern WXDLLIMPEXP_BASE wxCriticalSection *wxHandlersWithPendingEventsLocker;
3814 #endif
3815
3816 // ----------------------------------------------------------------------------
3817 // Helper functions
3818 // ----------------------------------------------------------------------------
3819
3820 #if wxUSE_GUI
3821
3822 // Find a window with the focus, that is also a descendant of the given window.
3823 // This is used to determine the window to initially send commands to.
3824 WXDLLIMPEXP_CORE wxWindow* wxFindFocusDescendant(wxWindow* ancestor);
3825
3826 #endif // wxUSE_GUI
3827
3828 #endif // _WX_EVENT_H_