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