]> git.saurik.com Git - wxWidgets.git/blob - include/wx/event.h
optimize FindItem(data) performance (closes #9870)
[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 // the symbolic names for the mouse buttons
1232 enum
1233 {
1234 wxMOUSE_BTN_ANY = -1,
1235 wxMOUSE_BTN_NONE = 0,
1236 wxMOUSE_BTN_LEFT = 1,
1237 wxMOUSE_BTN_MIDDLE = 2,
1238 wxMOUSE_BTN_RIGHT = 3,
1239 wxMOUSE_BTN_AUX1 = 4,
1240 wxMOUSE_BTN_AUX2 = 5,
1241 wxMOUSE_BTN_MAX
1242 };
1243
1244 class WXDLLIMPEXP_CORE wxMouseEvent : public wxEvent,
1245 public wxMouseState
1246 {
1247 public:
1248 wxMouseEvent(wxEventType mouseType = wxEVT_NULL);
1249 wxMouseEvent(const wxMouseEvent& event)
1250 : wxEvent(event),
1251 wxMouseState(event)
1252 {
1253 Assign(event);
1254 }
1255
1256 // Was it a button event? (*doesn't* mean: is any button *down*?)
1257 bool IsButton() const { return Button(wxMOUSE_BTN_ANY); }
1258
1259 // Was it a down event from this (or any) button?
1260 bool ButtonDown(int but = wxMOUSE_BTN_ANY) const;
1261
1262 // Was it a dclick event from this (or any) button?
1263 bool ButtonDClick(int but = wxMOUSE_BTN_ANY) const;
1264
1265 // Was it a up event from this (or any) button?
1266 bool ButtonUp(int but = wxMOUSE_BTN_ANY) const;
1267
1268 // Was the given button?
1269 bool Button(int but) const;
1270
1271 // Was the given button in Down state?
1272 bool ButtonIsDown(int but) const;
1273
1274 // Get the button which is changing state (wxMOUSE_BTN_NONE if none)
1275 int GetButton() const;
1276
1277 // Find which event was just generated
1278 bool LeftDown() const { return (m_eventType == wxEVT_LEFT_DOWN); }
1279 bool MiddleDown() const { return (m_eventType == wxEVT_MIDDLE_DOWN); }
1280 bool RightDown() const { return (m_eventType == wxEVT_RIGHT_DOWN); }
1281 bool Aux1Down() const { return (m_eventType == wxEVT_AUX1_DOWN); }
1282 bool Aux2Down() const { return (m_eventType == wxEVT_AUX2_DOWN); }
1283
1284 bool LeftUp() const { return (m_eventType == wxEVT_LEFT_UP); }
1285 bool MiddleUp() const { return (m_eventType == wxEVT_MIDDLE_UP); }
1286 bool RightUp() const { return (m_eventType == wxEVT_RIGHT_UP); }
1287 bool Aux1Up() const { return (m_eventType == wxEVT_AUX1_UP); }
1288 bool Aux2Up() const { return (m_eventType == wxEVT_AUX2_UP); }
1289
1290 bool LeftDClick() const { return (m_eventType == wxEVT_LEFT_DCLICK); }
1291 bool MiddleDClick() const { return (m_eventType == wxEVT_MIDDLE_DCLICK); }
1292 bool RightDClick() const { return (m_eventType == wxEVT_RIGHT_DCLICK); }
1293 bool Aux1DClick() const { return (m_eventType == wxEVT_AUX1_UP); }
1294 bool Aux2DClick() const { return (m_eventType == wxEVT_AUX2_UP); }
1295
1296 // Find the current state of the mouse buttons (regardless
1297 // of current event type)
1298 bool LeftIsDown() const { return m_leftDown; }
1299 bool MiddleIsDown() const { return m_middleDown; }
1300 bool RightIsDown() const { return m_rightDown; }
1301 bool Aux1IsDown() const { return m_aux1Down; }
1302 bool Aux2IsDown() const { return m_aux2Down; }
1303
1304 // True if a button is down and the mouse is moving
1305 bool Dragging() const
1306 {
1307 return (m_eventType == wxEVT_MOTION) && ButtonIsDown(wxMOUSE_BTN_ANY);
1308 }
1309
1310 // True if the mouse is moving, and no button is down
1311 bool Moving() const
1312 {
1313 return (m_eventType == wxEVT_MOTION) && !ButtonIsDown(wxMOUSE_BTN_ANY);
1314 }
1315
1316 // True if the mouse is just entering the window
1317 bool Entering() const { return (m_eventType == wxEVT_ENTER_WINDOW); }
1318
1319 // True if the mouse is just leaving the window
1320 bool Leaving() const { return (m_eventType == wxEVT_LEAVE_WINDOW); }
1321
1322 // Returns the number of mouse clicks associated with this event.
1323 int GetClickCount() const { return m_clickCount; }
1324
1325
1326 // Find the position of the event
1327 void GetPosition(wxCoord *xpos, wxCoord *ypos) const
1328 {
1329 if (xpos)
1330 *xpos = m_x;
1331 if (ypos)
1332 *ypos = m_y;
1333 }
1334
1335 void GetPosition(long *xpos, long *ypos) const
1336 {
1337 if (xpos)
1338 *xpos = (long)m_x;
1339 if (ypos)
1340 *ypos = (long)m_y;
1341 }
1342
1343 // Find the position of the event
1344 wxPoint GetPosition() const { return wxPoint(m_x, m_y); }
1345
1346 // Find the logical position of the event given the DC
1347 wxPoint GetLogicalPosition(const wxDC& dc) const;
1348
1349 // Get X position
1350 wxCoord GetX() const { return m_x; }
1351
1352 // Get Y position
1353 wxCoord GetY() const { return m_y; }
1354
1355 // Get wheel rotation, positive or negative indicates direction of
1356 // rotation. Current devices all send an event when rotation is equal to
1357 // +/-WheelDelta, but this allows for finer resolution devices to be
1358 // created in the future. Because of this you shouldn't assume that one
1359 // event is equal to 1 line or whatever, but you should be able to either
1360 // do partial line scrolling or wait until +/-WheelDelta rotation values
1361 // have been accumulated before scrolling.
1362 int GetWheelRotation() const { return m_wheelRotation; }
1363
1364 // Get wheel delta, normally 120. This is the threshold for action to be
1365 // taken, and one such action (for example, scrolling one increment)
1366 // should occur for each delta.
1367 int GetWheelDelta() const { return m_wheelDelta; }
1368
1369 // Gets the axis the wheel operation concerns, 0 being the y axis as on
1370 // most mouse wheels, 1 is the x axis for things like MightyMouse scrolls
1371 // or horizontal trackpad scrolling
1372 int GetWheelAxis() const { return m_wheelAxis; }
1373
1374 // Returns the configured number of lines (or whatever) to be scrolled per
1375 // wheel action. Defaults to one.
1376 int GetLinesPerAction() const { return m_linesPerAction; }
1377
1378 // Is the system set to do page scrolling?
1379 bool IsPageScroll() const { return ((unsigned int)m_linesPerAction == UINT_MAX); }
1380
1381 virtual wxEvent *Clone() const { return new wxMouseEvent(*this); }
1382 virtual wxEventCategory GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT; }
1383
1384 wxMouseEvent& operator=(const wxMouseEvent& event)
1385 {
1386 if (&event != this)
1387 Assign(event);
1388 return *this;
1389 }
1390
1391 public:
1392 wxCoord m_x, m_y;
1393
1394 bool m_leftDown;
1395 bool m_middleDown;
1396 bool m_rightDown;
1397 bool m_aux1Down;
1398 bool m_aux2Down;
1399
1400 int m_clickCount;
1401
1402 int m_wheelAxis;
1403 int m_wheelRotation;
1404 int m_wheelDelta;
1405 int m_linesPerAction;
1406
1407 protected:
1408 void Assign(const wxMouseEvent& evt);
1409
1410 private:
1411 DECLARE_DYNAMIC_CLASS(wxMouseEvent)
1412 };
1413
1414 // Cursor set event
1415
1416 /*
1417 wxEVT_SET_CURSOR
1418 */
1419
1420 class WXDLLIMPEXP_CORE wxSetCursorEvent : public wxEvent
1421 {
1422 public:
1423 wxSetCursorEvent(wxCoord x = 0, wxCoord y = 0)
1424 : wxEvent(0, wxEVT_SET_CURSOR),
1425 m_x(x), m_y(y), m_cursor()
1426 { }
1427
1428 wxSetCursorEvent(const wxSetCursorEvent& event)
1429 : wxEvent(event),
1430 m_x(event.m_x),
1431 m_y(event.m_y),
1432 m_cursor(event.m_cursor)
1433 { }
1434
1435 wxCoord GetX() const { return m_x; }
1436 wxCoord GetY() const { return m_y; }
1437
1438 void SetCursor(const wxCursor& cursor) { m_cursor = cursor; }
1439 const wxCursor& GetCursor() const { return m_cursor; }
1440 bool HasCursor() const { return m_cursor.Ok(); }
1441
1442 virtual wxEvent *Clone() const { return new wxSetCursorEvent(*this); }
1443
1444 private:
1445 wxCoord m_x, m_y;
1446 wxCursor m_cursor;
1447
1448 private:
1449 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSetCursorEvent)
1450 };
1451
1452 // Keyboard input event class
1453
1454 /*
1455 wxEVT_CHAR
1456 wxEVT_CHAR_HOOK
1457 wxEVT_KEY_DOWN
1458 wxEVT_KEY_UP
1459 wxEVT_HOTKEY
1460 */
1461
1462 class WXDLLIMPEXP_CORE wxKeyEvent : public wxEvent,
1463 public wxKeyboardState
1464 {
1465 public:
1466 wxKeyEvent(wxEventType keyType = wxEVT_NULL);
1467 wxKeyEvent(const wxKeyEvent& evt);
1468
1469 // get the key code: an ASCII7 char or an element of wxKeyCode enum
1470 int GetKeyCode() const { return (int)m_keyCode; }
1471
1472 #if wxUSE_UNICODE
1473 // get the Unicode character corresponding to this key
1474 wxChar GetUnicodeKey() const { return m_uniChar; }
1475 #endif // wxUSE_UNICODE
1476
1477 // get the raw key code (platform-dependent)
1478 wxUint32 GetRawKeyCode() const { return m_rawCode; }
1479
1480 // get the raw key flags (platform-dependent)
1481 wxUint32 GetRawKeyFlags() const { return m_rawFlags; }
1482
1483 // Find the position of the event
1484 void GetPosition(wxCoord *xpos, wxCoord *ypos) const
1485 {
1486 if (xpos) *xpos = m_x;
1487 if (ypos) *ypos = m_y;
1488 }
1489
1490 void GetPosition(long *xpos, long *ypos) const
1491 {
1492 if (xpos) *xpos = (long)m_x;
1493 if (ypos) *ypos = (long)m_y;
1494 }
1495
1496 wxPoint GetPosition() const
1497 { return wxPoint(m_x, m_y); }
1498
1499 // Get X position
1500 wxCoord GetX() const { return m_x; }
1501
1502 // Get Y position
1503 wxCoord GetY() const { return m_y; }
1504
1505 virtual wxEvent *Clone() const { return new wxKeyEvent(*this); }
1506 virtual wxEventCategory GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT; }
1507
1508 // we do need to copy wxKeyEvent sometimes (in wxTreeCtrl code, for
1509 // example)
1510 wxKeyEvent& operator=(const wxKeyEvent& evt)
1511 {
1512 if ( &evt != this )
1513 {
1514 wxEvent::operator=(evt);
1515
1516 // Borland C++ 5.82 doesn't compile an explicit call to an
1517 // implicitly defined operator=() so need to do it this way:
1518 *static_cast<wxKeyboardState *>(this) = evt;
1519
1520 m_x = evt.m_x;
1521 m_y = evt.m_y;
1522
1523 m_keyCode = evt.m_keyCode;
1524
1525 m_rawCode = evt.m_rawCode;
1526 m_rawFlags = evt.m_rawFlags;
1527 #if wxUSE_UNICODE
1528 m_uniChar = evt.m_uniChar;
1529 #endif
1530 }
1531 return *this;
1532 }
1533
1534 public:
1535 wxCoord m_x, m_y;
1536
1537 long m_keyCode;
1538
1539 #if wxUSE_UNICODE
1540 // This contains the full Unicode character
1541 // in a character events in Unicode mode
1542 wxChar m_uniChar;
1543 #endif
1544
1545 // these fields contain the platform-specific information about
1546 // key that was pressed
1547 wxUint32 m_rawCode;
1548 wxUint32 m_rawFlags;
1549
1550 private:
1551 DECLARE_DYNAMIC_CLASS(wxKeyEvent)
1552 };
1553
1554 // Size event class
1555 /*
1556 wxEVT_SIZE
1557 */
1558
1559 class WXDLLIMPEXP_CORE wxSizeEvent : public wxEvent
1560 {
1561 public:
1562 wxSizeEvent() : wxEvent(0, wxEVT_SIZE)
1563 { }
1564 wxSizeEvent(const wxSize& sz, int winid = 0)
1565 : wxEvent(winid, wxEVT_SIZE),
1566 m_size(sz)
1567 { }
1568 wxSizeEvent(const wxSizeEvent& event)
1569 : wxEvent(event),
1570 m_size(event.m_size), m_rect(event.m_rect)
1571 { }
1572 wxSizeEvent(const wxRect& rect, int id = 0)
1573 : m_size(rect.GetSize()), m_rect(rect)
1574 { m_eventType = wxEVT_SIZING; m_id = id; }
1575
1576 wxSize GetSize() const { return m_size; }
1577 wxRect GetRect() const { return m_rect; }
1578 void SetRect(const wxRect& rect) { m_rect = rect; }
1579
1580 virtual wxEvent *Clone() const { return new wxSizeEvent(*this); }
1581
1582 public:
1583 // For internal usage only. Will be converted to protected members.
1584 wxSize m_size;
1585 wxRect m_rect; // Used for wxEVT_SIZING
1586
1587 private:
1588 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSizeEvent)
1589 };
1590
1591 // Move event class
1592
1593 /*
1594 wxEVT_MOVE
1595 */
1596
1597 class WXDLLIMPEXP_CORE wxMoveEvent : public wxEvent
1598 {
1599 public:
1600 wxMoveEvent()
1601 : wxEvent(0, wxEVT_MOVE)
1602 { }
1603 wxMoveEvent(const wxPoint& pos, int winid = 0)
1604 : wxEvent(winid, wxEVT_MOVE),
1605 m_pos(pos)
1606 { }
1607 wxMoveEvent(const wxMoveEvent& event)
1608 : wxEvent(event),
1609 m_pos(event.m_pos)
1610 { }
1611 wxMoveEvent(const wxRect& rect, int id = 0)
1612 : m_pos(rect.GetPosition()), m_rect(rect)
1613 { m_eventType = wxEVT_MOVING; m_id = id; }
1614
1615 wxPoint GetPosition() const { return m_pos; }
1616 void SetPosition(const wxPoint& pos) { m_pos = pos; }
1617 wxRect GetRect() const { return m_rect; }
1618 void SetRect(const wxRect& rect) { m_rect = rect; }
1619
1620 virtual wxEvent *Clone() const { return new wxMoveEvent(*this); }
1621
1622 protected:
1623 wxPoint m_pos;
1624 wxRect m_rect;
1625
1626 private:
1627 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMoveEvent)
1628 };
1629
1630 // Paint event class
1631 /*
1632 wxEVT_PAINT
1633 wxEVT_NC_PAINT
1634 wxEVT_PAINT_ICON
1635 */
1636
1637 #if wxDEBUG_LEVEL && (defined(__WXMSW__) || defined(__WXPM__))
1638 #define wxHAS_PAINT_DEBUG
1639
1640 // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined
1641 extern WXDLLIMPEXP_CORE int g_isPainting;
1642 #endif // debug
1643
1644 class WXDLLIMPEXP_CORE wxPaintEvent : public wxEvent
1645 {
1646 public:
1647 wxPaintEvent(int Id = 0)
1648 : wxEvent(Id, wxEVT_PAINT)
1649 {
1650 #ifdef wxHAS_PAINT_DEBUG
1651 // set the internal flag for the duration of redrawing
1652 g_isPainting++;
1653 #endif // debug
1654 }
1655
1656 // default copy ctor and dtor are normally fine, we only need them to keep
1657 // g_isPainting updated in debug build
1658 #ifdef wxHAS_PAINT_DEBUG
1659 wxPaintEvent(const wxPaintEvent& event)
1660 : wxEvent(event)
1661 {
1662 g_isPainting++;
1663 }
1664
1665 virtual ~wxPaintEvent()
1666 {
1667 g_isPainting--;
1668 }
1669 #endif // debug
1670
1671 virtual wxEvent *Clone() const { return new wxPaintEvent(*this); }
1672
1673 private:
1674 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaintEvent)
1675 };
1676
1677 class WXDLLIMPEXP_CORE wxNcPaintEvent : public wxEvent
1678 {
1679 public:
1680 wxNcPaintEvent(int winid = 0)
1681 : wxEvent(winid, wxEVT_NC_PAINT)
1682 { }
1683
1684 virtual wxEvent *Clone() const { return new wxNcPaintEvent(*this); }
1685
1686 private:
1687 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNcPaintEvent)
1688 };
1689
1690 // Erase background event class
1691 /*
1692 wxEVT_ERASE_BACKGROUND
1693 */
1694
1695 class WXDLLIMPEXP_CORE wxEraseEvent : public wxEvent
1696 {
1697 public:
1698 wxEraseEvent(int Id = 0, wxDC *dc = NULL)
1699 : wxEvent(Id, wxEVT_ERASE_BACKGROUND),
1700 m_dc(dc)
1701 { }
1702
1703 wxEraseEvent(const wxEraseEvent& event)
1704 : wxEvent(event),
1705 m_dc(event.m_dc)
1706 { }
1707
1708 wxDC *GetDC() const { return m_dc; }
1709
1710 virtual wxEvent *Clone() const { return new wxEraseEvent(*this); }
1711
1712 protected:
1713 wxDC *m_dc;
1714
1715 private:
1716 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxEraseEvent)
1717 };
1718
1719 // Focus event class
1720 /*
1721 wxEVT_SET_FOCUS
1722 wxEVT_KILL_FOCUS
1723 */
1724
1725 class WXDLLIMPEXP_CORE wxFocusEvent : public wxEvent
1726 {
1727 public:
1728 wxFocusEvent(wxEventType type = wxEVT_NULL, int winid = 0)
1729 : wxEvent(winid, type)
1730 { m_win = NULL; }
1731
1732 wxFocusEvent(const wxFocusEvent& event)
1733 : wxEvent(event)
1734 { m_win = event.m_win; }
1735
1736 // The window associated with this event is the window which had focus
1737 // before for SET event and the window which will have focus for the KILL
1738 // one. NB: it may be NULL in both cases!
1739 wxWindow *GetWindow() const { return m_win; }
1740 void SetWindow(wxWindow *win) { m_win = win; }
1741
1742 virtual wxEvent *Clone() const { return new wxFocusEvent(*this); }
1743
1744 private:
1745 wxWindow *m_win;
1746
1747 private:
1748 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFocusEvent)
1749 };
1750
1751 // wxChildFocusEvent notifies the parent that a child has got the focus: unlike
1752 // wxFocusEvent it is propagated upwards the window chain
1753 class WXDLLIMPEXP_CORE wxChildFocusEvent : public wxCommandEvent
1754 {
1755 public:
1756 wxChildFocusEvent(wxWindow *win = NULL);
1757
1758 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1759
1760 virtual wxEvent *Clone() const { return new wxChildFocusEvent(*this); }
1761
1762 private:
1763 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxChildFocusEvent)
1764 };
1765
1766 // Activate event class
1767 /*
1768 wxEVT_ACTIVATE
1769 wxEVT_ACTIVATE_APP
1770 wxEVT_HIBERNATE
1771 */
1772
1773 class WXDLLIMPEXP_CORE wxActivateEvent : public wxEvent
1774 {
1775 public:
1776 wxActivateEvent(wxEventType type = wxEVT_NULL, bool active = true, int Id = 0)
1777 : wxEvent(Id, type)
1778 { m_active = active; }
1779 wxActivateEvent(const wxActivateEvent& event)
1780 : wxEvent(event)
1781 { m_active = event.m_active; }
1782
1783 bool GetActive() const { return m_active; }
1784
1785 virtual wxEvent *Clone() const { return new wxActivateEvent(*this); }
1786
1787 private:
1788 bool m_active;
1789
1790 private:
1791 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxActivateEvent)
1792 };
1793
1794 // InitDialog event class
1795 /*
1796 wxEVT_INIT_DIALOG
1797 */
1798
1799 class WXDLLIMPEXP_CORE wxInitDialogEvent : public wxEvent
1800 {
1801 public:
1802 wxInitDialogEvent(int Id = 0)
1803 : wxEvent(Id, wxEVT_INIT_DIALOG)
1804 { }
1805
1806 virtual wxEvent *Clone() const { return new wxInitDialogEvent(*this); }
1807
1808 private:
1809 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxInitDialogEvent)
1810 };
1811
1812 // Miscellaneous menu event class
1813 /*
1814 wxEVT_MENU_OPEN,
1815 wxEVT_MENU_CLOSE,
1816 wxEVT_MENU_HIGHLIGHT,
1817 */
1818
1819 class WXDLLIMPEXP_CORE wxMenuEvent : public wxEvent
1820 {
1821 public:
1822 wxMenuEvent(wxEventType type = wxEVT_NULL, int winid = 0, wxMenu* menu = NULL)
1823 : wxEvent(winid, type)
1824 { m_menuId = winid; m_menu = menu; }
1825 wxMenuEvent(const wxMenuEvent& event)
1826 : wxEvent(event)
1827 { m_menuId = event.m_menuId; m_menu = event.m_menu; }
1828
1829 // only for wxEVT_MENU_HIGHLIGHT
1830 int GetMenuId() const { return m_menuId; }
1831
1832 // only for wxEVT_MENU_OPEN/CLOSE
1833 bool IsPopup() const { return m_menuId == wxID_ANY; }
1834
1835 // only for wxEVT_MENU_OPEN/CLOSE
1836 wxMenu* GetMenu() const { return m_menu; }
1837
1838 virtual wxEvent *Clone() const { return new wxMenuEvent(*this); }
1839
1840 private:
1841 int m_menuId;
1842 wxMenu* m_menu;
1843
1844 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMenuEvent)
1845 };
1846
1847 // Window close or session close event class
1848 /*
1849 wxEVT_CLOSE_WINDOW,
1850 wxEVT_END_SESSION,
1851 wxEVT_QUERY_END_SESSION
1852 */
1853
1854 class WXDLLIMPEXP_CORE wxCloseEvent : public wxEvent
1855 {
1856 public:
1857 wxCloseEvent(wxEventType type = wxEVT_NULL, int winid = 0)
1858 : wxEvent(winid, type),
1859 m_loggingOff(true),
1860 m_veto(false), // should be false by default
1861 m_canVeto(true) {}
1862
1863 wxCloseEvent(const wxCloseEvent& event)
1864 : wxEvent(event),
1865 m_loggingOff(event.m_loggingOff),
1866 m_veto(event.m_veto),
1867 m_canVeto(event.m_canVeto) {}
1868
1869 void SetLoggingOff(bool logOff) { m_loggingOff = logOff; }
1870 bool GetLoggingOff() const
1871 {
1872 // m_loggingOff flag is only used by wxEVT_[QUERY_]END_SESSION, it
1873 // doesn't make sense for wxEVT_CLOSE_WINDOW
1874 wxASSERT_MSG( m_eventType != wxEVT_CLOSE_WINDOW,
1875 _T("this flag is for end session events only") );
1876
1877 return m_loggingOff;
1878 }
1879
1880 void Veto(bool veto = true)
1881 {
1882 // GetVeto() will return false anyhow...
1883 wxCHECK_RET( m_canVeto,
1884 wxT("call to Veto() ignored (can't veto this event)") );
1885
1886 m_veto = veto;
1887 }
1888 void SetCanVeto(bool canVeto) { m_canVeto = canVeto; }
1889 bool CanVeto() const { return m_canVeto; }
1890 bool GetVeto() const { return m_canVeto && m_veto; }
1891
1892 virtual wxEvent *Clone() const { return new wxCloseEvent(*this); }
1893
1894 protected:
1895 bool m_loggingOff,
1896 m_veto,
1897 m_canVeto;
1898
1899 private:
1900 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCloseEvent)
1901 };
1902
1903 /*
1904 wxEVT_SHOW
1905 */
1906
1907 class WXDLLIMPEXP_CORE wxShowEvent : public wxEvent
1908 {
1909 public:
1910 wxShowEvent(int winid = 0, bool show = false)
1911 : wxEvent(winid, wxEVT_SHOW)
1912 { m_show = show; }
1913 wxShowEvent(const wxShowEvent& event)
1914 : wxEvent(event)
1915 { m_show = event.m_show; }
1916
1917 void SetShow(bool show) { m_show = show; }
1918
1919 // return true if the window was shown, false if hidden
1920 bool IsShown() const { return m_show; }
1921
1922 #if WXWIN_COMPATIBILITY_2_8
1923 wxDEPRECATED( bool GetShow() const { return IsShown(); } )
1924 #endif
1925
1926 virtual wxEvent *Clone() const { return new wxShowEvent(*this); }
1927
1928 protected:
1929 bool m_show;
1930
1931 private:
1932 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxShowEvent)
1933 };
1934
1935 /*
1936 wxEVT_ICONIZE
1937 */
1938
1939 class WXDLLIMPEXP_CORE wxIconizeEvent : public wxEvent
1940 {
1941 public:
1942 wxIconizeEvent(int winid = 0, bool iconized = true)
1943 : wxEvent(winid, wxEVT_ICONIZE)
1944 { m_iconized = iconized; }
1945 wxIconizeEvent(const wxIconizeEvent& event)
1946 : wxEvent(event)
1947 { m_iconized = event.m_iconized; }
1948
1949 #if WXWIN_COMPATIBILITY_2_8
1950 wxDEPRECATED( bool Iconized() const { return IsIconized(); } )
1951 #endif
1952 // return true if the frame was iconized, false if restored
1953 bool IsIconized() const { return m_iconized; }
1954
1955 virtual wxEvent *Clone() const { return new wxIconizeEvent(*this); }
1956
1957 protected:
1958 bool m_iconized;
1959
1960 private:
1961 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIconizeEvent)
1962 };
1963 /*
1964 wxEVT_MAXIMIZE
1965 */
1966
1967 class WXDLLIMPEXP_CORE wxMaximizeEvent : public wxEvent
1968 {
1969 public:
1970 wxMaximizeEvent(int winid = 0)
1971 : wxEvent(winid, wxEVT_MAXIMIZE)
1972 { }
1973
1974 virtual wxEvent *Clone() const { return new wxMaximizeEvent(*this); }
1975
1976 private:
1977 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMaximizeEvent)
1978 };
1979
1980 // Joystick event class
1981 /*
1982 wxEVT_JOY_BUTTON_DOWN,
1983 wxEVT_JOY_BUTTON_UP,
1984 wxEVT_JOY_MOVE,
1985 wxEVT_JOY_ZMOVE
1986 */
1987
1988 // Which joystick? Same as Windows ids so no conversion necessary.
1989 enum
1990 {
1991 wxJOYSTICK1,
1992 wxJOYSTICK2
1993 };
1994
1995 // Which button is down?
1996 enum
1997 {
1998 wxJOY_BUTTON_ANY = -1,
1999 wxJOY_BUTTON1 = 1,
2000 wxJOY_BUTTON2 = 2,
2001 wxJOY_BUTTON3 = 4,
2002 wxJOY_BUTTON4 = 8
2003 };
2004
2005 class WXDLLIMPEXP_CORE wxJoystickEvent : public wxEvent
2006 {
2007 protected:
2008 wxPoint m_pos;
2009 int m_zPosition;
2010 int m_buttonChange; // Which button changed?
2011 int m_buttonState; // Which buttons are down?
2012 int m_joyStick; // Which joystick?
2013
2014 public:
2015 wxJoystickEvent(wxEventType type = wxEVT_NULL,
2016 int state = 0,
2017 int joystick = wxJOYSTICK1,
2018 int change = 0)
2019 : wxEvent(0, type),
2020 m_pos(),
2021 m_zPosition(0),
2022 m_buttonChange(change),
2023 m_buttonState(state),
2024 m_joyStick(joystick)
2025 {
2026 }
2027 wxJoystickEvent(const wxJoystickEvent& event)
2028 : wxEvent(event),
2029 m_pos(event.m_pos),
2030 m_zPosition(event.m_zPosition),
2031 m_buttonChange(event.m_buttonChange),
2032 m_buttonState(event.m_buttonState),
2033 m_joyStick(event.m_joyStick)
2034 { }
2035
2036 wxPoint GetPosition() const { return m_pos; }
2037 int GetZPosition() const { return m_zPosition; }
2038 int GetButtonState() const { return m_buttonState; }
2039 int GetButtonChange() const { return m_buttonChange; }
2040 int GetJoystick() const { return m_joyStick; }
2041
2042 void SetJoystick(int stick) { m_joyStick = stick; }
2043 void SetButtonState(int state) { m_buttonState = state; }
2044 void SetButtonChange(int change) { m_buttonChange = change; }
2045 void SetPosition(const wxPoint& pos) { m_pos = pos; }
2046 void SetZPosition(int zPos) { m_zPosition = zPos; }
2047
2048 // Was it a button event? (*doesn't* mean: is any button *down*?)
2049 bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) ||
2050 (GetEventType() == wxEVT_JOY_BUTTON_UP)); }
2051
2052 // Was it a move event?
2053 bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE); }
2054
2055 // Was it a zmove event?
2056 bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE); }
2057
2058 // Was it a down event from button 1, 2, 3, 4 or any?
2059 bool ButtonDown(int but = wxJOY_BUTTON_ANY) const
2060 { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) &&
2061 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
2062
2063 // Was it a up event from button 1, 2, 3 or any?
2064 bool ButtonUp(int but = wxJOY_BUTTON_ANY) const
2065 { return ((GetEventType() == wxEVT_JOY_BUTTON_UP) &&
2066 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
2067
2068 // Was the given button 1,2,3,4 or any in Down state?
2069 bool ButtonIsDown(int but = wxJOY_BUTTON_ANY) const
2070 { return (((but == wxJOY_BUTTON_ANY) && (m_buttonState != 0)) ||
2071 ((m_buttonState & but) == but)); }
2072
2073 virtual wxEvent *Clone() const { return new wxJoystickEvent(*this); }
2074
2075 private:
2076 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxJoystickEvent)
2077 };
2078
2079 // Drop files event class
2080 /*
2081 wxEVT_DROP_FILES
2082 */
2083
2084 class WXDLLIMPEXP_CORE wxDropFilesEvent : public wxEvent
2085 {
2086 public:
2087 int m_noFiles;
2088 wxPoint m_pos;
2089 wxString* m_files;
2090
2091 wxDropFilesEvent(wxEventType type = wxEVT_NULL,
2092 int noFiles = 0,
2093 wxString *files = NULL)
2094 : wxEvent(0, type),
2095 m_noFiles(noFiles),
2096 m_pos(),
2097 m_files(files)
2098 { }
2099
2100 // we need a copy ctor to avoid deleting m_files pointer twice
2101 wxDropFilesEvent(const wxDropFilesEvent& other)
2102 : wxEvent(other),
2103 m_noFiles(other.m_noFiles),
2104 m_pos(other.m_pos),
2105 m_files(NULL)
2106 {
2107 m_files = new wxString[m_noFiles];
2108 for ( int n = 0; n < m_noFiles; n++ )
2109 {
2110 m_files[n] = other.m_files[n];
2111 }
2112 }
2113
2114 virtual ~wxDropFilesEvent()
2115 {
2116 delete [] m_files;
2117 }
2118
2119 wxPoint GetPosition() const { return m_pos; }
2120 int GetNumberOfFiles() const { return m_noFiles; }
2121 wxString *GetFiles() const { return m_files; }
2122
2123 virtual wxEvent *Clone() const { return new wxDropFilesEvent(*this); }
2124
2125 private:
2126 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDropFilesEvent)
2127 };
2128
2129 // Update UI event
2130 /*
2131 wxEVT_UPDATE_UI
2132 */
2133
2134 // Whether to always send update events to windows, or
2135 // to only send update events to those with the
2136 // wxWS_EX_PROCESS_UI_UPDATES style.
2137
2138 enum wxUpdateUIMode
2139 {
2140 // Send UI update events to all windows
2141 wxUPDATE_UI_PROCESS_ALL,
2142
2143 // Send UI update events to windows that have
2144 // the wxWS_EX_PROCESS_UI_UPDATES flag specified
2145 wxUPDATE_UI_PROCESS_SPECIFIED
2146 };
2147
2148 class WXDLLIMPEXP_CORE wxUpdateUIEvent : public wxCommandEvent
2149 {
2150 public:
2151 wxUpdateUIEvent(wxWindowID commandId = 0)
2152 : wxCommandEvent(wxEVT_UPDATE_UI, commandId)
2153 {
2154 m_checked =
2155 m_enabled =
2156 m_shown =
2157 m_setEnabled =
2158 m_setShown =
2159 m_setText =
2160 m_setChecked = false;
2161 }
2162 wxUpdateUIEvent(const wxUpdateUIEvent& event)
2163 : wxCommandEvent(event),
2164 m_checked(event.m_checked),
2165 m_enabled(event.m_enabled),
2166 m_shown(event.m_shown),
2167 m_setEnabled(event.m_setEnabled),
2168 m_setShown(event.m_setShown),
2169 m_setText(event.m_setText),
2170 m_setChecked(event.m_setChecked),
2171 m_text(event.m_text)
2172 { }
2173
2174 bool GetChecked() const { return m_checked; }
2175 bool GetEnabled() const { return m_enabled; }
2176 bool GetShown() const { return m_shown; }
2177 wxString GetText() const { return m_text; }
2178 bool GetSetText() const { return m_setText; }
2179 bool GetSetChecked() const { return m_setChecked; }
2180 bool GetSetEnabled() const { return m_setEnabled; }
2181 bool GetSetShown() const { return m_setShown; }
2182
2183 void Check(bool check) { m_checked = check; m_setChecked = true; }
2184 void Enable(bool enable) { m_enabled = enable; m_setEnabled = true; }
2185 void Show(bool show) { m_shown = show; m_setShown = true; }
2186 void SetText(const wxString& text) { m_text = text; m_setText = true; }
2187
2188 // Sets the interval between updates in milliseconds.
2189 // Set to -1 to disable updates, or to 0 to update as frequently as possible.
2190 static void SetUpdateInterval(long updateInterval) { sm_updateInterval = updateInterval; }
2191
2192 // Returns the current interval between updates in milliseconds
2193 static long GetUpdateInterval() { return sm_updateInterval; }
2194
2195 // Can we update this window?
2196 static bool CanUpdate(wxWindowBase *win);
2197
2198 // Reset the update time to provide a delay until the next
2199 // time we should update
2200 static void ResetUpdateTime();
2201
2202 // Specify how wxWidgets will send update events: to
2203 // all windows, or only to those which specify that they
2204 // will process the events.
2205 static void SetMode(wxUpdateUIMode mode) { sm_updateMode = mode; }
2206
2207 // Returns the UI update mode
2208 static wxUpdateUIMode GetMode() { return sm_updateMode; }
2209
2210 virtual wxEvent *Clone() const { return new wxUpdateUIEvent(*this); }
2211
2212 protected:
2213 bool m_checked;
2214 bool m_enabled;
2215 bool m_shown;
2216 bool m_setEnabled;
2217 bool m_setShown;
2218 bool m_setText;
2219 bool m_setChecked;
2220 wxString m_text;
2221 #if wxUSE_LONGLONG
2222 static wxLongLong sm_lastUpdate;
2223 #endif
2224 static long sm_updateInterval;
2225 static wxUpdateUIMode sm_updateMode;
2226
2227 private:
2228 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxUpdateUIEvent)
2229 };
2230
2231 /*
2232 wxEVT_SYS_COLOUR_CHANGED
2233 */
2234
2235 // TODO: shouldn't all events record the window ID?
2236 class WXDLLIMPEXP_CORE wxSysColourChangedEvent : public wxEvent
2237 {
2238 public:
2239 wxSysColourChangedEvent()
2240 : wxEvent(0, wxEVT_SYS_COLOUR_CHANGED)
2241 { }
2242
2243 virtual wxEvent *Clone() const { return new wxSysColourChangedEvent(*this); }
2244
2245 private:
2246 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSysColourChangedEvent)
2247 };
2248
2249 /*
2250 wxEVT_MOUSE_CAPTURE_CHANGED
2251 The window losing the capture receives this message
2252 (even if it released the capture itself).
2253 */
2254
2255 class WXDLLIMPEXP_CORE wxMouseCaptureChangedEvent : public wxEvent
2256 {
2257 public:
2258 wxMouseCaptureChangedEvent(wxWindowID winid = 0, wxWindow* gainedCapture = NULL)
2259 : wxEvent(winid, wxEVT_MOUSE_CAPTURE_CHANGED),
2260 m_gainedCapture(gainedCapture)
2261 { }
2262
2263 wxMouseCaptureChangedEvent(const wxMouseCaptureChangedEvent& event)
2264 : wxEvent(event),
2265 m_gainedCapture(event.m_gainedCapture)
2266 { }
2267
2268 virtual wxEvent *Clone() const { return new wxMouseCaptureChangedEvent(*this); }
2269
2270 wxWindow* GetCapturedWindow() const { return m_gainedCapture; }
2271
2272 private:
2273 wxWindow* m_gainedCapture;
2274
2275 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureChangedEvent)
2276 };
2277
2278 /*
2279 wxEVT_MOUSE_CAPTURE_LOST
2280 The window losing the capture receives this message, unless it released it
2281 it itself or unless wxWindow::CaptureMouse was called on another window
2282 (and so capture will be restored when the new capturer releases it).
2283 */
2284
2285 class WXDLLIMPEXP_CORE wxMouseCaptureLostEvent : public wxEvent
2286 {
2287 public:
2288 wxMouseCaptureLostEvent(wxWindowID winid = 0)
2289 : wxEvent(winid, wxEVT_MOUSE_CAPTURE_LOST)
2290 {}
2291
2292 wxMouseCaptureLostEvent(const wxMouseCaptureLostEvent& event)
2293 : wxEvent(event)
2294 {}
2295
2296 virtual wxEvent *Clone() const { return new wxMouseCaptureLostEvent(*this); }
2297
2298 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureLostEvent)
2299 };
2300
2301 /*
2302 wxEVT_DISPLAY_CHANGED
2303 */
2304 class WXDLLIMPEXP_CORE wxDisplayChangedEvent : public wxEvent
2305 {
2306 private:
2307 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDisplayChangedEvent)
2308
2309 public:
2310 wxDisplayChangedEvent()
2311 : wxEvent(0, wxEVT_DISPLAY_CHANGED)
2312 { }
2313
2314 virtual wxEvent *Clone() const { return new wxDisplayChangedEvent(*this); }
2315 };
2316
2317 /*
2318 wxEVT_PALETTE_CHANGED
2319 */
2320
2321 class WXDLLIMPEXP_CORE wxPaletteChangedEvent : public wxEvent
2322 {
2323 public:
2324 wxPaletteChangedEvent(wxWindowID winid = 0)
2325 : wxEvent(winid, wxEVT_PALETTE_CHANGED),
2326 m_changedWindow(NULL)
2327 { }
2328
2329 wxPaletteChangedEvent(const wxPaletteChangedEvent& event)
2330 : wxEvent(event),
2331 m_changedWindow(event.m_changedWindow)
2332 { }
2333
2334 void SetChangedWindow(wxWindow* win) { m_changedWindow = win; }
2335 wxWindow* GetChangedWindow() const { return m_changedWindow; }
2336
2337 virtual wxEvent *Clone() const { return new wxPaletteChangedEvent(*this); }
2338
2339 protected:
2340 wxWindow* m_changedWindow;
2341
2342 private:
2343 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaletteChangedEvent)
2344 };
2345
2346 /*
2347 wxEVT_QUERY_NEW_PALETTE
2348 Indicates the window is getting keyboard focus and should re-do its palette.
2349 */
2350
2351 class WXDLLIMPEXP_CORE wxQueryNewPaletteEvent : public wxEvent
2352 {
2353 public:
2354 wxQueryNewPaletteEvent(wxWindowID winid = 0)
2355 : wxEvent(winid, wxEVT_QUERY_NEW_PALETTE),
2356 m_paletteRealized(false)
2357 { }
2358 wxQueryNewPaletteEvent(const wxQueryNewPaletteEvent& event)
2359 : wxEvent(event),
2360 m_paletteRealized(event.m_paletteRealized)
2361 { }
2362
2363 // App sets this if it changes the palette.
2364 void SetPaletteRealized(bool realized) { m_paletteRealized = realized; }
2365 bool GetPaletteRealized() const { return m_paletteRealized; }
2366
2367 virtual wxEvent *Clone() const { return new wxQueryNewPaletteEvent(*this); }
2368
2369 protected:
2370 bool m_paletteRealized;
2371
2372 private:
2373 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxQueryNewPaletteEvent)
2374 };
2375
2376 /*
2377 Event generated by dialog navigation keys
2378 wxEVT_NAVIGATION_KEY
2379 */
2380 // NB: don't derive from command event to avoid being propagated to the parent
2381 class WXDLLIMPEXP_CORE wxNavigationKeyEvent : public wxEvent
2382 {
2383 public:
2384 wxNavigationKeyEvent()
2385 : wxEvent(0, wxEVT_NAVIGATION_KEY),
2386 m_flags(IsForward | FromTab), // defaults are for TAB
2387 m_focus(NULL)
2388 {
2389 m_propagationLevel = wxEVENT_PROPAGATE_NONE;
2390 }
2391
2392 wxNavigationKeyEvent(const wxNavigationKeyEvent& event)
2393 : wxEvent(event),
2394 m_flags(event.m_flags),
2395 m_focus(event.m_focus)
2396 { }
2397
2398 // direction: forward (true) or backward (false)
2399 bool GetDirection() const
2400 { return (m_flags & IsForward) != 0; }
2401 void SetDirection(bool bForward)
2402 { if ( bForward ) m_flags |= IsForward; else m_flags &= ~IsForward; }
2403
2404 // it may be a window change event (MDI, notebook pages...) or a control
2405 // change event
2406 bool IsWindowChange() const
2407 { return (m_flags & WinChange) != 0; }
2408 void SetWindowChange(bool bIs)
2409 { if ( bIs ) m_flags |= WinChange; else m_flags &= ~WinChange; }
2410
2411 // Set to true under MSW if the event was generated using the tab key.
2412 // This is required for proper navogation over radio buttons
2413 bool IsFromTab() const
2414 { return (m_flags & FromTab) != 0; }
2415 void SetFromTab(bool bIs)
2416 { if ( bIs ) m_flags |= FromTab; else m_flags &= ~FromTab; }
2417
2418 // the child which has the focus currently (may be NULL - use
2419 // wxWindow::FindFocus then)
2420 wxWindow* GetCurrentFocus() const { return m_focus; }
2421 void SetCurrentFocus(wxWindow *win) { m_focus = win; }
2422
2423 // Set flags
2424 void SetFlags(long flags) { m_flags = flags; }
2425
2426 virtual wxEvent *Clone() const { return new wxNavigationKeyEvent(*this); }
2427
2428 enum wxNavigationKeyEventFlags
2429 {
2430 IsBackward = 0x0000,
2431 IsForward = 0x0001,
2432 WinChange = 0x0002,
2433 FromTab = 0x0004
2434 };
2435
2436 long m_flags;
2437 wxWindow *m_focus;
2438
2439 private:
2440 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNavigationKeyEvent)
2441 };
2442
2443 // Window creation/destruction events: the first is sent as soon as window is
2444 // created (i.e. the underlying GUI object exists), but when the C++ object is
2445 // fully initialized (so virtual functions may be called). The second,
2446 // wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
2447 // still safe to call virtual functions at this moment
2448 /*
2449 wxEVT_CREATE
2450 wxEVT_DESTROY
2451 */
2452
2453 class WXDLLIMPEXP_CORE wxWindowCreateEvent : public wxCommandEvent
2454 {
2455 public:
2456 wxWindowCreateEvent(wxWindow *win = NULL);
2457
2458 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
2459
2460 virtual wxEvent *Clone() const { return new wxWindowCreateEvent(*this); }
2461
2462 private:
2463 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowCreateEvent)
2464 };
2465
2466 class WXDLLIMPEXP_CORE wxWindowDestroyEvent : public wxCommandEvent
2467 {
2468 public:
2469 wxWindowDestroyEvent(wxWindow *win = NULL);
2470
2471 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
2472
2473 virtual wxEvent *Clone() const { return new wxWindowDestroyEvent(*this); }
2474
2475 private:
2476 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowDestroyEvent)
2477 };
2478
2479 // A help event is sent when the user clicks on a window in context-help mode.
2480 /*
2481 wxEVT_HELP
2482 wxEVT_DETAILED_HELP
2483 */
2484
2485 class WXDLLIMPEXP_CORE wxHelpEvent : public wxCommandEvent
2486 {
2487 public:
2488 // how was this help event generated?
2489 enum Origin
2490 {
2491 Origin_Unknown, // unrecognized event source
2492 Origin_Keyboard, // event generated from F1 key press
2493 Origin_HelpButton // event from [?] button on the title bar (Windows)
2494 };
2495
2496 wxHelpEvent(wxEventType type = wxEVT_NULL,
2497 wxWindowID winid = 0,
2498 const wxPoint& pt = wxDefaultPosition,
2499 Origin origin = Origin_Unknown)
2500 : wxCommandEvent(type, winid),
2501 m_pos(pt),
2502 m_origin(GuessOrigin(origin))
2503 { }
2504 wxHelpEvent(const wxHelpEvent& event)
2505 : wxCommandEvent(event),
2506 m_pos(event.m_pos),
2507 m_target(event.m_target),
2508 m_link(event.m_link),
2509 m_origin(event.m_origin)
2510 { }
2511
2512 // Position of event (in screen coordinates)
2513 const wxPoint& GetPosition() const { return m_pos; }
2514 void SetPosition(const wxPoint& pos) { m_pos = pos; }
2515
2516 // Optional link to further help
2517 const wxString& GetLink() const { return m_link; }
2518 void SetLink(const wxString& link) { m_link = link; }
2519
2520 // Optional target to display help in. E.g. a window specification
2521 const wxString& GetTarget() const { return m_target; }
2522 void SetTarget(const wxString& target) { m_target = target; }
2523
2524 virtual wxEvent *Clone() const { return new wxHelpEvent(*this); }
2525
2526 // optional indication of the event source
2527 Origin GetOrigin() const { return m_origin; }
2528 void SetOrigin(Origin origin) { m_origin = origin; }
2529
2530 protected:
2531 wxPoint m_pos;
2532 wxString m_target;
2533 wxString m_link;
2534 Origin m_origin;
2535
2536 // we can try to guess the event origin ourselves, even if none is
2537 // specified in the ctor
2538 static Origin GuessOrigin(Origin origin);
2539
2540 private:
2541 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHelpEvent)
2542 };
2543
2544 // A Clipboard Text event is sent when a window intercepts text copy/cut/paste
2545 // message, i.e. the user has cut/copied/pasted data from/into a text control
2546 // via ctrl-C/X/V, ctrl/shift-del/insert, a popup menu command, etc.
2547 // NOTE : under windows these events are *NOT* generated automatically
2548 // for a Rich Edit text control.
2549 /*
2550 wxEVT_COMMAND_TEXT_COPY
2551 wxEVT_COMMAND_TEXT_CUT
2552 wxEVT_COMMAND_TEXT_PASTE
2553 */
2554
2555 class WXDLLIMPEXP_CORE wxClipboardTextEvent : public wxCommandEvent
2556 {
2557 public:
2558 wxClipboardTextEvent(wxEventType type = wxEVT_NULL,
2559 wxWindowID winid = 0)
2560 : wxCommandEvent(type, winid)
2561 { }
2562 wxClipboardTextEvent(const wxClipboardTextEvent& event)
2563 : wxCommandEvent(event)
2564 { }
2565
2566 virtual wxEvent *Clone() const { return new wxClipboardTextEvent(*this); }
2567
2568 private:
2569 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxClipboardTextEvent)
2570 };
2571
2572 // A Context event is sent when the user right clicks on a window or
2573 // presses Shift-F10
2574 // NOTE : Under windows this is a repackaged WM_CONTETXMENU message
2575 // Under other systems it may have to be generated from a right click event
2576 /*
2577 wxEVT_CONTEXT_MENU
2578 */
2579
2580 class WXDLLIMPEXP_CORE wxContextMenuEvent : public wxCommandEvent
2581 {
2582 public:
2583 wxContextMenuEvent(wxEventType type = wxEVT_NULL,
2584 wxWindowID winid = 0,
2585 const wxPoint& pt = wxDefaultPosition)
2586 : wxCommandEvent(type, winid),
2587 m_pos(pt)
2588 { }
2589 wxContextMenuEvent(const wxContextMenuEvent& event)
2590 : wxCommandEvent(event),
2591 m_pos(event.m_pos)
2592 { }
2593
2594 // Position of event (in screen coordinates)
2595 const wxPoint& GetPosition() const { return m_pos; }
2596 void SetPosition(const wxPoint& pos) { m_pos = pos; }
2597
2598 virtual wxEvent *Clone() const { return new wxContextMenuEvent(*this); }
2599
2600 protected:
2601 wxPoint m_pos;
2602
2603 private:
2604 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxContextMenuEvent)
2605 };
2606
2607 #endif // wxUSE_GUI
2608
2609 // Idle event
2610 /*
2611 wxEVT_IDLE
2612 */
2613
2614 // Whether to always send idle events to windows, or
2615 // to only send update events to those with the
2616 // wxWS_EX_PROCESS_IDLE style.
2617
2618 enum wxIdleMode
2619 {
2620 // Send idle events to all windows
2621 wxIDLE_PROCESS_ALL,
2622
2623 // Send idle events to windows that have
2624 // the wxWS_EX_PROCESS_IDLE flag specified
2625 wxIDLE_PROCESS_SPECIFIED
2626 };
2627
2628 class WXDLLIMPEXP_BASE wxIdleEvent : public wxEvent
2629 {
2630 public:
2631 wxIdleEvent()
2632 : wxEvent(0, wxEVT_IDLE),
2633 m_requestMore(false)
2634 { }
2635 wxIdleEvent(const wxIdleEvent& event)
2636 : wxEvent(event),
2637 m_requestMore(event.m_requestMore)
2638 { }
2639
2640 void RequestMore(bool needMore = true) { m_requestMore = needMore; }
2641 bool MoreRequested() const { return m_requestMore; }
2642
2643 virtual wxEvent *Clone() const { return new wxIdleEvent(*this); }
2644
2645 // Specify how wxWidgets will send idle events: to
2646 // all windows, or only to those which specify that they
2647 // will process the events.
2648 static void SetMode(wxIdleMode mode) { sm_idleMode = mode; }
2649
2650 // Returns the idle event mode
2651 static wxIdleMode GetMode() { return sm_idleMode; }
2652
2653 protected:
2654 bool m_requestMore;
2655 static wxIdleMode sm_idleMode;
2656
2657 private:
2658 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIdleEvent)
2659 };
2660
2661 /* TODO
2662 wxEVT_MOUSE_CAPTURE_CHANGED,
2663 wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
2664 // wxEVT_FONT_CHANGED, // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
2665 // wxEVT_FONT_CHANGED to all other windows (maybe).
2666 wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
2667 wxEVT_MEASURE_ITEM,
2668 wxEVT_COMPARE_ITEM
2669 */
2670
2671
2672
2673 // ============================================================================
2674 // event handler and related classes
2675 // ============================================================================
2676
2677
2678 // struct containing the members common to static and dynamic event tables
2679 // entries
2680 struct WXDLLIMPEXP_BASE wxEventTableEntryBase
2681 {
2682 wxEventTableEntryBase(int winid, int idLast,
2683 wxEventFunctor* fn, wxObject *data)
2684 : m_id(winid),
2685 m_lastId(idLast),
2686 m_fn(fn),
2687 m_callbackUserData(data)
2688 { }
2689
2690 wxEventTableEntryBase( const wxEventTableEntryBase &entry )
2691 : m_id( entry.m_id ),
2692 m_lastId( entry.m_lastId ),
2693 m_fn( entry.m_fn ),
2694 m_callbackUserData( entry.m_callbackUserData )
2695 {
2696 // This is a 'hack' to ensure that only one instance tries to delete
2697 // the functor pointer. It is safe as long as the only place where the
2698 // copy constructor is being called is when the static event tables are
2699 // being initialized (a temporary instance is created and then this
2700 // constructor is called).
2701
2702 const_cast<wxEventTableEntryBase&>( entry ).m_fn = NULL;
2703 }
2704
2705 ~wxEventTableEntryBase()
2706 {
2707 delete m_fn;
2708 }
2709
2710 // the range of ids for this entry: if m_lastId == wxID_ANY, the range
2711 // consists only of m_id, otherwise it is m_id..m_lastId inclusive
2712 int m_id,
2713 m_lastId;
2714
2715 // function/method/functor to call
2716 wxEventFunctor* m_fn;
2717
2718 // arbitrary user data associated with the callback
2719 wxObject* m_callbackUserData;
2720
2721 private:
2722 wxDECLARE_NO_ASSIGN_CLASS(wxEventTableEntryBase);
2723 };
2724
2725 // an entry from a static event table
2726 struct WXDLLIMPEXP_BASE wxEventTableEntry : public wxEventTableEntryBase
2727 {
2728 wxEventTableEntry(const int& evType, int winid, int idLast,
2729 wxEventFunctor* fn, wxObject *data)
2730 : wxEventTableEntryBase(winid, idLast, fn, data),
2731 m_eventType(evType)
2732 { }
2733
2734 // the reference to event type: this allows us to not care about the
2735 // (undefined) order in which the event table entries and the event types
2736 // are initialized: initially the value of this reference might be
2737 // invalid, but by the time it is used for the first time, all global
2738 // objects will have been initialized (including the event type constants)
2739 // and so it will have the correct value when it is needed
2740 const int& m_eventType;
2741
2742 private:
2743 wxDECLARE_NO_ASSIGN_CLASS(wxEventTableEntry);
2744 };
2745
2746 // an entry used in dynamic event table managed by wxEvtHandler::Connect()
2747 struct WXDLLIMPEXP_BASE wxDynamicEventTableEntry : public wxEventTableEntryBase
2748 {
2749 wxDynamicEventTableEntry(int evType, int winid, int idLast,
2750 wxEventFunctor* fn, wxObject *data)
2751 : wxEventTableEntryBase(winid, idLast, fn, data),
2752 m_eventType(evType)
2753 { }
2754
2755 // not a reference here as we can't keep a reference to a temporary int
2756 // created to wrap the constant value typically passed to Connect() - nor
2757 // do we need it
2758 int m_eventType;
2759
2760 private:
2761 wxDECLARE_NO_ASSIGN_CLASS(wxDynamicEventTableEntry);
2762 };
2763
2764 // ----------------------------------------------------------------------------
2765 // wxEventTable: an array of event entries terminated with {0, 0, 0, 0, 0}
2766 // ----------------------------------------------------------------------------
2767
2768 struct WXDLLIMPEXP_BASE wxEventTable
2769 {
2770 const wxEventTable *baseTable; // base event table (next in chain)
2771 const wxEventTableEntry *entries; // bottom of entry array
2772 };
2773
2774 // ----------------------------------------------------------------------------
2775 // wxEventHashTable: a helper of wxEvtHandler to speed up wxEventTable lookups.
2776 // ----------------------------------------------------------------------------
2777
2778 WX_DEFINE_ARRAY_PTR(const wxEventTableEntry*, wxEventTableEntryPointerArray);
2779
2780 class WXDLLIMPEXP_BASE wxEventHashTable
2781 {
2782 private:
2783 // Internal data structs
2784 struct EventTypeTable
2785 {
2786 wxEventType eventType;
2787 wxEventTableEntryPointerArray eventEntryTable;
2788 };
2789 typedef EventTypeTable* EventTypeTablePointer;
2790
2791 public:
2792 // Constructor, needs the event table it needs to hash later on.
2793 // Note: hashing of the event table is not done in the constructor as it
2794 // can be that the event table is not yet full initialize, the hash
2795 // will gets initialized when handling the first event look-up request.
2796 wxEventHashTable(const wxEventTable &table);
2797 // Destructor.
2798 ~wxEventHashTable();
2799
2800 // Handle the given event, in other words search the event table hash
2801 // and call self->ProcessEvent() if a match was found.
2802 bool HandleEvent(wxEvent& event, wxEvtHandler *self);
2803
2804 // Clear table
2805 void Clear();
2806
2807 #if wxUSE_MEMORY_TRACING
2808 // Clear all tables: only used to work around problems in memory tracing
2809 // code
2810 static void ClearAll();
2811 #endif // wxUSE_MEMORY_TRACING
2812
2813 protected:
2814 // Init the hash table with the entries of the static event table.
2815 void InitHashTable();
2816 // Helper funtion of InitHashTable() to insert 1 entry into the hash table.
2817 void AddEntry(const wxEventTableEntry &entry);
2818 // Allocate and init with null pointers the base hash table.
2819 void AllocEventTypeTable(size_t size);
2820 // Grow the hash table in size and transfer all items currently
2821 // in the table to the correct location in the new table.
2822 void GrowEventTypeTable();
2823
2824 protected:
2825 const wxEventTable &m_table;
2826 bool m_rebuildHash;
2827
2828 size_t m_size;
2829 EventTypeTablePointer *m_eventTypeTable;
2830
2831 static wxEventHashTable* sm_first;
2832 wxEventHashTable* m_previous;
2833 wxEventHashTable* m_next;
2834
2835 wxDECLARE_NO_COPY_CLASS(wxEventHashTable);
2836 };
2837
2838 // ----------------------------------------------------------------------------
2839 // wxEvtHandler: the base class for all objects handling wxWidgets events
2840 // ----------------------------------------------------------------------------
2841
2842 class WXDLLIMPEXP_BASE wxEvtHandler : public wxObject
2843 , public wxTrackable
2844 {
2845 public:
2846 wxEvtHandler();
2847 virtual ~wxEvtHandler();
2848
2849
2850 // Event handler chain
2851 // -------------------
2852
2853 wxEvtHandler *GetNextHandler() const { return m_nextHandler; }
2854 wxEvtHandler *GetPreviousHandler() const { return m_previousHandler; }
2855 virtual void SetNextHandler(wxEvtHandler *handler) { m_nextHandler = handler; }
2856 virtual void SetPreviousHandler(wxEvtHandler *handler) { m_previousHandler = handler; }
2857
2858 void SetEvtHandlerEnabled(bool enabled) { m_enabled = enabled; }
2859 bool GetEvtHandlerEnabled() const { return m_enabled; }
2860
2861 void Unlink();
2862 bool IsUnlinked() const;
2863
2864
2865
2866 // Event queuing and processing
2867 // ----------------------------
2868
2869 // Process an event right now: this can only be called from the main
2870 // thread, use QueueEvent() for scheduling the events for
2871 // processing from other threads.
2872 virtual bool ProcessEvent(wxEvent& event);
2873
2874 // Process an event by calling ProcessEvent and handling any exceptions
2875 // thrown by event handlers. It's mostly useful when processing wx events
2876 // when called from C code (e.g. in GTK+ callback) when the exception
2877 // wouldn't correctly propagate to wxEventLoop.
2878 bool SafelyProcessEvent(wxEvent& event);
2879 // NOTE: uses ProcessEvent()
2880
2881 // Schedule the given event to be processed later. It takes ownership of
2882 // the event pointer, i.e. it will be deleted later. This is safe to call
2883 // from multiple threads although you still need to ensure that wxString
2884 // fields of the event object are deep copies and not use the same string
2885 // buffer as other wxString objects in this thread.
2886 virtual void QueueEvent(wxEvent *event);
2887
2888 // Add an event to be processed later: notice that this function is not
2889 // safe to call from threads other than main, use QueueEvent()
2890 virtual void AddPendingEvent(const wxEvent& event)
2891 {
2892 // notice that the thread-safety problem comes from the fact that
2893 // Clone() doesn't make deep copies of wxString fields of wxEvent
2894 // object and so the same wxString could be used from both threads when
2895 // the event object is destroyed in this one -- QueueEvent() avoids
2896 // this problem as the event pointer is not used any more in this
2897 // thread at all after it is called.
2898 QueueEvent(event.Clone());
2899 }
2900
2901 void ProcessPendingEvents();
2902 // NOTE: uses ProcessEvent()
2903
2904 void DeletePendingEvents();
2905
2906 #if wxUSE_THREADS
2907 bool ProcessThreadEvent(const wxEvent& event);
2908 // NOTE: uses AddPendingEvent(); call only from secondary threads
2909 #endif
2910
2911
2912 // Connecting and disconnecting
2913 // ----------------------------
2914
2915 // These functions are used for old, untyped, event handlers and don't
2916 // check that the type of the function passed to them actually matches the
2917 // type of the event. They also only allow connecting events to methods of
2918 // wxEvtHandler-derived classes.
2919 //
2920 // The template Connect() methods below are safer and allow connecting
2921 // events to arbitrary functions or functors -- but require compiler
2922 // support for templates.
2923
2924 // Dynamic association of a member function handler with the event handler,
2925 // winid and event type
2926 void Connect(int winid,
2927 int lastId,
2928 wxEventType eventType,
2929 wxObjectEventFunction func,
2930 wxObject *userData = NULL,
2931 wxEvtHandler *eventSink = NULL)
2932 {
2933 DoConnect(winid, lastId, eventType,
2934 wxNewEventFunctor(eventType, func, eventSink),
2935 userData);
2936 }
2937
2938 // Convenience function: take just one id
2939 void Connect(int winid,
2940 wxEventType eventType,
2941 wxObjectEventFunction func,
2942 wxObject *userData = NULL,
2943 wxEvtHandler *eventSink = NULL)
2944 { Connect(winid, wxID_ANY, eventType, func, userData, eventSink); }
2945
2946 // Even more convenient: without id (same as using id of wxID_ANY)
2947 void Connect(wxEventType eventType,
2948 wxObjectEventFunction func,
2949 wxObject *userData = NULL,
2950 wxEvtHandler *eventSink = NULL)
2951 { Connect(wxID_ANY, wxID_ANY, eventType, func, userData, eventSink); }
2952
2953 bool Disconnect(int winid,
2954 int lastId,
2955 wxEventType eventType,
2956 wxObjectEventFunction func = NULL,
2957 wxObject *userData = NULL,
2958 wxEvtHandler *eventSink = NULL)
2959 {
2960 return DoDisconnect(winid, lastId, eventType,
2961 wxMakeEventFunctor(eventType, func, eventSink),
2962 userData );
2963 }
2964
2965 bool Disconnect(int winid = wxID_ANY,
2966 wxEventType eventType = wxEVT_NULL,
2967 wxObjectEventFunction func = NULL,
2968 wxObject *userData = NULL,
2969 wxEvtHandler *eventSink = NULL)
2970 { return Disconnect(winid, wxID_ANY, eventType, func, userData, eventSink); }
2971
2972 bool Disconnect(wxEventType eventType,
2973 wxObjectEventFunction func,
2974 wxObject *userData = NULL,
2975 wxEvtHandler *eventSink = NULL)
2976 { return Disconnect(wxID_ANY, eventType, func, userData, eventSink); }
2977
2978 #if !wxEVENTS_COMPATIBILITY_2_8
2979 // Bind arbitrary functor (including just a function) to an event:
2980 template <typename EventTag, typename Functor>
2981 void Bind(const EventTag& eventType,
2982 Functor functor,
2983 int winid = wxID_ANY,
2984 int lastId = wxID_ANY,
2985 wxObject *userData = NULL)
2986 {
2987 DoConnect(winid, lastId, eventType,
2988 wxNewEventFunctor(eventType, functor),
2989 userData);
2990 }
2991
2992
2993 template <typename EventTag, typename Functor>
2994 bool Unbind(const EventTag& eventType,
2995 Functor functor,
2996 int winid = wxID_ANY,
2997 int lastId = wxID_ANY,
2998 wxObject *userData = NULL)
2999 {
3000 return DoDisconnect(winid, lastId, eventType,
3001 wxMakeEventFunctor(eventType, functor),
3002 userData);
3003 }
3004
3005
3006 // Bind a method of a class (called on the specified handler which must
3007 // be convertible to this class) object to an event:
3008
3009 template <typename EventTag, typename Class, typename EventArg, typename EventHandler>
3010 void Bind(const EventTag &eventType,
3011 void (Class::*method)(EventArg &),
3012 EventHandler *handler,
3013 int winid = wxID_ANY,
3014 int lastId = wxID_ANY,
3015 wxObject *userData = NULL)
3016 {
3017 DoConnect(winid, lastId, eventType,
3018 wxNewEventFunctor(eventType, method, handler),
3019 userData);
3020 }
3021
3022 template <typename EventTag, typename Class, typename EventArg, typename EventHandler>
3023 bool Unbind(const EventTag &eventType,
3024 void (Class::*method)(EventArg&),
3025 EventHandler *handler,
3026 int winid = wxID_ANY,
3027 int lastId = wxID_ANY,
3028 wxObject *userData = NULL )
3029 {
3030 return DoDisconnect(winid, lastId, eventType,
3031 wxMakeEventFunctor(eventType, method, handler),
3032 userData);
3033 }
3034 #endif // !wxEVENTS_COMPATIBILITY_2_8
3035
3036 wxList* GetDynamicEventTable() const { return m_dynamicEvents ; }
3037
3038 // User data can be associated with each wxEvtHandler
3039 void SetClientObject( wxClientData *data ) { DoSetClientObject(data); }
3040 wxClientData *GetClientObject() const { return DoGetClientObject(); }
3041
3042 void SetClientData( void *data ) { DoSetClientData(data); }
3043 void *GetClientData() const { return DoGetClientData(); }
3044
3045
3046 // implementation from now on
3047 // --------------------------
3048
3049 // check if the given event table entry matches this event by id (the check
3050 // for the event type should be done by caller) and call the handler if it
3051 // does
3052 //
3053 // return true if the event was processed, false otherwise (no match or the
3054 // handler decided to skip the event)
3055 static bool ProcessEventIfMatchesId(const wxEventTableEntryBase& tableEntry,
3056 wxEvtHandler *handler,
3057 wxEvent& event);
3058
3059 virtual bool SearchEventTable(wxEventTable& table, wxEvent& event);
3060 bool SearchDynamicEventTable( wxEvent& event );
3061
3062 // Avoid problems at exit by cleaning up static hash table gracefully
3063 void ClearEventHashTable() { GetEventHashTable().Clear(); }
3064 void OnSinkDestroyed( wxEvtHandler *sink );
3065
3066
3067 // The method tries to process the event in this event handler.
3068 //
3069 // It is meant to be called from ProcessEvent() only and is not virtual,
3070 // additional event handlers can be hooked into the normal event processing
3071 // logic using TryBefore() and TryAfter() hooks.
3072 bool ProcessEventHere(wxEvent& event);
3073
3074
3075 private:
3076 void DoConnect(int winid,
3077 int lastId,
3078 wxEventType eventType,
3079 wxEventFunctor *func,
3080 wxObject* userData = NULL);
3081
3082 bool DoDisconnect(int winid,
3083 int lastId,
3084 wxEventType eventType,
3085 const wxEventFunctor& func,
3086 wxObject *userData = NULL);
3087
3088 static const wxEventTableEntry sm_eventTableEntries[];
3089
3090 protected:
3091 // hooks for wxWindow used by ProcessEvent()
3092 // -----------------------------------------
3093
3094 // this one is called before trying our own event table to allow plugging
3095 // in the event handlers overriding the default logic, this is used by e.g.
3096 // validators.
3097 virtual bool TryBefore(wxEvent& event);
3098
3099 // this one is called after failing to find the event handle in our own
3100 // table to give a chance to the other windows to process it
3101 //
3102 // base class implementation passes the event to wxTheApp
3103 virtual bool TryAfter(wxEvent& event);
3104
3105 #ifdef WXWIN_COMPATIBILITY_2_8
3106 // deprecated method: override TryBefore() instead of this one
3107 wxDEPRECATED_BUT_USED_INTERNALLY_INLINE(
3108 virtual bool TryValidator(wxEvent& WXUNUSED(event)), return false; )
3109
3110 wxDEPRECATED_BUT_USED_INTERNALLY_INLINE(
3111 virtual bool TryParent(wxEvent& event), return DoTryApp(event); )
3112 #endif // WXWIN_COMPATIBILITY_2_8
3113
3114
3115 static const wxEventTable sm_eventTable;
3116 virtual const wxEventTable *GetEventTable() const;
3117
3118 static wxEventHashTable sm_eventHashTable;
3119 virtual wxEventHashTable& GetEventHashTable() const;
3120
3121 wxEvtHandler* m_nextHandler;
3122 wxEvtHandler* m_previousHandler;
3123 wxList* m_dynamicEvents;
3124 wxList* m_pendingEvents;
3125
3126 #if wxUSE_THREADS
3127 // critical section protecting m_pendingEvents
3128 wxCriticalSection m_pendingEventsLock;
3129 #endif // wxUSE_THREADS
3130
3131 // Is event handler enabled?
3132 bool m_enabled;
3133
3134
3135 // The user data: either an object which will be deleted by the container
3136 // when it's deleted or some raw pointer which we do nothing with - only
3137 // one type of data can be used with the given window (i.e. you cannot set
3138 // the void data and then associate the container with wxClientData or vice
3139 // versa)
3140 union
3141 {
3142 wxClientData *m_clientObject;
3143 void *m_clientData;
3144 };
3145
3146 // what kind of data do we have?
3147 wxClientDataType m_clientDataType;
3148
3149 // client data accessors
3150 virtual void DoSetClientObject( wxClientData *data );
3151 virtual wxClientData *DoGetClientObject() const;
3152
3153 virtual void DoSetClientData( void *data );
3154 virtual void *DoGetClientData() const;
3155
3156 // Search tracker objects for event connection with this sink
3157 wxEventConnectionRef *FindRefInTrackerList(wxEvtHandler *handler);
3158
3159 private:
3160 // pass the event to wxTheApp instance, called from TryAfter()
3161 bool DoTryApp(wxEvent& event);
3162
3163 DECLARE_DYNAMIC_CLASS_NO_COPY(wxEvtHandler)
3164 };
3165
3166 WX_DEFINE_ARRAY_WITH_DECL_PTR(wxEvtHandler *, wxEvtHandlerArray, class WXDLLIMPEXP_BASE);
3167
3168 // ----------------------------------------------------------------------------
3169 // wxEventConnectionRef represents all connections between two event handlers
3170 // and enables automatic disconnect when an event handler sink goes out of
3171 // scope. Each connection/disconnect increases/decreases ref count, and
3172 // when it reaches zero the node goes out of scope.
3173 // ----------------------------------------------------------------------------
3174
3175 class wxEventConnectionRef : public wxTrackerNode
3176 {
3177 public:
3178 wxEventConnectionRef() : m_src(NULL), m_sink(NULL), m_refCount(0) { }
3179 wxEventConnectionRef(wxEvtHandler *src, wxEvtHandler *sink)
3180 : m_src(src), m_sink(sink), m_refCount(1)
3181 {
3182 m_sink->AddNode(this);
3183 }
3184
3185 // The sink is being destroyed
3186 virtual void OnObjectDestroy( )
3187 {
3188 if ( m_src )
3189 m_src->OnSinkDestroyed( m_sink );
3190 delete this;
3191 }
3192
3193 virtual wxEventConnectionRef *ToEventConnection() { return this; }
3194
3195 void IncRef() { m_refCount++; }
3196 void DecRef()
3197 {
3198 if ( !--m_refCount )
3199 {
3200 // The sink holds the only external pointer to this object
3201 if ( m_sink )
3202 m_sink->RemoveNode(this);
3203 delete this;
3204 }
3205 }
3206
3207 private:
3208 wxEvtHandler *m_src,
3209 *m_sink;
3210 int m_refCount;
3211
3212 friend class wxEvtHandler;
3213
3214 wxDECLARE_NO_ASSIGN_CLASS(wxEventConnectionRef);
3215 };
3216
3217 inline void wxObjectEventFunctor::operator()(wxEvtHandler *handler, wxEvent& event)
3218 {
3219 wxEvtHandler * const realHandler = m_handler ? m_handler : handler;
3220
3221 (realHandler->*m_method)(event);
3222 }
3223
3224 // Post a message to the given event handler which will be processed during the
3225 // next event loop iteration.
3226 //
3227 // Notice that this one is not thread-safe, use wxQueueEvent()
3228 inline void wxPostEvent(wxEvtHandler *dest, const wxEvent& event)
3229 {
3230 wxCHECK_RET( dest, "need an object to post event to" );
3231
3232 dest->AddPendingEvent(event);
3233 }
3234
3235 // Wrapper around wxEvtHandler::QueueEvent(): adds an event for later
3236 // processing, unlike wxPostEvent it is safe to use from different thread even
3237 // for events with wxString members
3238 inline void wxQueueEvent(wxEvtHandler *dest, wxEvent *event)
3239 {
3240 wxCHECK_RET( dest, "need an object to queue event for" );
3241
3242 dest->QueueEvent(event);
3243 }
3244
3245 typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&);
3246 typedef void (wxEvtHandler::*wxIdleEventFunction)(wxIdleEvent&);
3247
3248 #define wxEventHandler(func) \
3249 wxEVENT_HANDLER_CAST(wxEventFunction, func)
3250 #define wxIdleEventHandler(func) \
3251 wxEVENT_HANDLER_CAST(wxIdleEventFunction, func)
3252
3253 #if wxUSE_GUI
3254
3255 // ----------------------------------------------------------------------------
3256 // wxEventBlocker: helper class to temporarily disable event handling for a window
3257 // ----------------------------------------------------------------------------
3258
3259 class WXDLLIMPEXP_CORE wxEventBlocker : public wxEvtHandler
3260 {
3261 public:
3262 wxEventBlocker(wxWindow *win, wxEventType type = wxEVT_ANY);
3263 virtual ~wxEventBlocker();
3264
3265 void Block(wxEventType type)
3266 {
3267 m_eventsToBlock.push_back(type);
3268 }
3269
3270 virtual bool ProcessEvent(wxEvent& event);
3271
3272 protected:
3273 wxArrayInt m_eventsToBlock;
3274 wxWindow *m_window;
3275
3276 wxDECLARE_NO_COPY_CLASS(wxEventBlocker);
3277 };
3278
3279 typedef void (wxEvtHandler::*wxCommandEventFunction)(wxCommandEvent&);
3280 typedef void (wxEvtHandler::*wxThreadEventFunction)(wxThreadEvent&);
3281 typedef void (wxEvtHandler::*wxScrollEventFunction)(wxScrollEvent&);
3282 typedef void (wxEvtHandler::*wxScrollWinEventFunction)(wxScrollWinEvent&);
3283 typedef void (wxEvtHandler::*wxSizeEventFunction)(wxSizeEvent&);
3284 typedef void (wxEvtHandler::*wxMoveEventFunction)(wxMoveEvent&);
3285 typedef void (wxEvtHandler::*wxPaintEventFunction)(wxPaintEvent&);
3286 typedef void (wxEvtHandler::*wxNcPaintEventFunction)(wxNcPaintEvent&);
3287 typedef void (wxEvtHandler::*wxEraseEventFunction)(wxEraseEvent&);
3288 typedef void (wxEvtHandler::*wxMouseEventFunction)(wxMouseEvent&);
3289 typedef void (wxEvtHandler::*wxCharEventFunction)(wxKeyEvent&);
3290 typedef void (wxEvtHandler::*wxFocusEventFunction)(wxFocusEvent&);
3291 typedef void (wxEvtHandler::*wxChildFocusEventFunction)(wxChildFocusEvent&);
3292 typedef void (wxEvtHandler::*wxActivateEventFunction)(wxActivateEvent&);
3293 typedef void (wxEvtHandler::*wxMenuEventFunction)(wxMenuEvent&);
3294 typedef void (wxEvtHandler::*wxJoystickEventFunction)(wxJoystickEvent&);
3295 typedef void (wxEvtHandler::*wxDropFilesEventFunction)(wxDropFilesEvent&);
3296 typedef void (wxEvtHandler::*wxInitDialogEventFunction)(wxInitDialogEvent&);
3297 typedef void (wxEvtHandler::*wxSysColourChangedEventFunction)(wxSysColourChangedEvent&);
3298 typedef void (wxEvtHandler::*wxDisplayChangedEventFunction)(wxDisplayChangedEvent&);
3299 typedef void (wxEvtHandler::*wxUpdateUIEventFunction)(wxUpdateUIEvent&);
3300 typedef void (wxEvtHandler::*wxCloseEventFunction)(wxCloseEvent&);
3301 typedef void (wxEvtHandler::*wxShowEventFunction)(wxShowEvent&);
3302 typedef void (wxEvtHandler::*wxIconizeEventFunction)(wxIconizeEvent&);
3303 typedef void (wxEvtHandler::*wxMaximizeEventFunction)(wxMaximizeEvent&);
3304 typedef void (wxEvtHandler::*wxNavigationKeyEventFunction)(wxNavigationKeyEvent&);
3305 typedef void (wxEvtHandler::*wxPaletteChangedEventFunction)(wxPaletteChangedEvent&);
3306 typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction)(wxQueryNewPaletteEvent&);
3307 typedef void (wxEvtHandler::*wxWindowCreateEventFunction)(wxWindowCreateEvent&);
3308 typedef void (wxEvtHandler::*wxWindowDestroyEventFunction)(wxWindowDestroyEvent&);
3309 typedef void (wxEvtHandler::*wxSetCursorEventFunction)(wxSetCursorEvent&);
3310 typedef void (wxEvtHandler::*wxNotifyEventFunction)(wxNotifyEvent&);
3311 typedef void (wxEvtHandler::*wxHelpEventFunction)(wxHelpEvent&);
3312 typedef void (wxEvtHandler::*wxContextMenuEventFunction)(wxContextMenuEvent&);
3313 typedef void (wxEvtHandler::*wxMouseCaptureChangedEventFunction)(wxMouseCaptureChangedEvent&);
3314 typedef void (wxEvtHandler::*wxMouseCaptureLostEventFunction)(wxMouseCaptureLostEvent&);
3315 typedef void (wxEvtHandler::*wxClipboardTextEventFunction)(wxClipboardTextEvent&);
3316
3317
3318 #define wxCommandEventHandler(func) \
3319 wxEVENT_HANDLER_CAST(wxCommandEventFunction, func)
3320 #define wxThreadEventHandler(func) \
3321 wxEVENT_HANDLER_CAST(wxThreadEventFunction, func)
3322 #define wxScrollEventHandler(func) \
3323 wxEVENT_HANDLER_CAST(wxScrollEventFunction, func)
3324 #define wxScrollWinEventHandler(func) \
3325 wxEVENT_HANDLER_CAST(wxScrollWinEventFunction, func)
3326 #define wxSizeEventHandler(func) \
3327 wxEVENT_HANDLER_CAST(wxSizeEventFunction, func)
3328 #define wxMoveEventHandler(func) \
3329 wxEVENT_HANDLER_CAST(wxMoveEventFunction, func)
3330 #define wxPaintEventHandler(func) \
3331 wxEVENT_HANDLER_CAST(wxPaintEventFunction, func)
3332 #define wxNcPaintEventHandler(func) \
3333 wxEVENT_HANDLER_CAST(wxNcPaintEventFunction, func)
3334 #define wxEraseEventHandler(func) \
3335 wxEVENT_HANDLER_CAST(wxEraseEventFunction, func)
3336 #define wxMouseEventHandler(func) \
3337 wxEVENT_HANDLER_CAST(wxMouseEventFunction, func)
3338 #define wxCharEventHandler(func) \
3339 wxEVENT_HANDLER_CAST(wxCharEventFunction, func)
3340 #define wxKeyEventHandler(func) wxCharEventHandler(func)
3341 #define wxFocusEventHandler(func) \
3342 wxEVENT_HANDLER_CAST(wxFocusEventFunction, func)
3343 #define wxChildFocusEventHandler(func) \
3344 wxEVENT_HANDLER_CAST(wxChildFocusEventFunction, func)
3345 #define wxActivateEventHandler(func) \
3346 wxEVENT_HANDLER_CAST(wxActivateEventFunction, func)
3347 #define wxMenuEventHandler(func) \
3348 wxEVENT_HANDLER_CAST(wxMenuEventFunction, func)
3349 #define wxJoystickEventHandler(func) \
3350 wxEVENT_HANDLER_CAST(wxJoystickEventFunction, func)
3351 #define wxDropFilesEventHandler(func) \
3352 wxEVENT_HANDLER_CAST(wxDropFilesEventFunction, func)
3353 #define wxInitDialogEventHandler(func) \
3354 wxEVENT_HANDLER_CAST(wxInitDialogEventFunction, func)
3355 #define wxSysColourChangedEventHandler(func) \
3356 wxEVENT_HANDLER_CAST(wxSysColourChangedEventFunction, func)
3357 #define wxDisplayChangedEventHandler(func) \
3358 wxEVENT_HANDLER_CAST(wxDisplayChangedEventFunction, func)
3359 #define wxUpdateUIEventHandler(func) \
3360 wxEVENT_HANDLER_CAST(wxUpdateUIEventFunction, func)
3361 #define wxCloseEventHandler(func) \
3362 wxEVENT_HANDLER_CAST(wxCloseEventFunction, func)
3363 #define wxShowEventHandler(func) \
3364 wxEVENT_HANDLER_CAST(wxShowEventFunction, func)
3365 #define wxIconizeEventHandler(func) \
3366 wxEVENT_HANDLER_CAST(wxIconizeEventFunction, func)
3367 #define wxMaximizeEventHandler(func) \
3368 wxEVENT_HANDLER_CAST(wxMaximizeEventFunction, func)
3369 #define wxNavigationKeyEventHandler(func) \
3370 wxEVENT_HANDLER_CAST(wxNavigationKeyEventFunction, func)
3371 #define wxPaletteChangedEventHandler(func) \
3372 wxEVENT_HANDLER_CAST(wxPaletteChangedEventFunction, func)
3373 #define wxQueryNewPaletteEventHandler(func) \
3374 wxEVENT_HANDLER_CAST(wxQueryNewPaletteEventFunction, func)
3375 #define wxWindowCreateEventHandler(func) \
3376 wxEVENT_HANDLER_CAST(wxWindowCreateEventFunction, func)
3377 #define wxWindowDestroyEventHandler(func) \
3378 wxEVENT_HANDLER_CAST(wxWindowDestroyEventFunction, func)
3379 #define wxSetCursorEventHandler(func) \
3380 wxEVENT_HANDLER_CAST(wxSetCursorEventFunction, func)
3381 #define wxNotifyEventHandler(func) \
3382 wxEVENT_HANDLER_CAST(wxNotifyEventFunction, func)
3383 #define wxHelpEventHandler(func) \
3384 wxEVENT_HANDLER_CAST(wxHelpEventFunction, func)
3385 #define wxContextMenuEventHandler(func) \
3386 wxEVENT_HANDLER_CAST(wxContextMenuEventFunction, func)
3387 #define wxMouseCaptureChangedEventHandler(func) \
3388 wxEVENT_HANDLER_CAST(wxMouseCaptureChangedEventFunction, func)
3389 #define wxMouseCaptureLostEventHandler(func) \
3390 wxEVENT_HANDLER_CAST(wxMouseCaptureLostEventFunction, func)
3391 #define wxClipboardTextEventHandler(func) \
3392 wxEVENT_HANDLER_CAST(wxClipboardTextEventFunction, func)
3393
3394 #endif // wxUSE_GUI
3395
3396 // N.B. In GNU-WIN32, you *have* to take the address of a member function
3397 // (use &) or the compiler crashes...
3398
3399 #define DECLARE_EVENT_TABLE() \
3400 private: \
3401 static const wxEventTableEntry sm_eventTableEntries[]; \
3402 protected: \
3403 static const wxEventTable sm_eventTable; \
3404 virtual const wxEventTable* GetEventTable() const; \
3405 static wxEventHashTable sm_eventHashTable; \
3406 virtual wxEventHashTable& GetEventHashTable() const;
3407
3408 // N.B.: when building DLL with Borland C++ 5.5 compiler, you must initialize
3409 // sm_eventTable before using it in GetEventTable() or the compiler gives
3410 // E2233 (see http://groups.google.com/groups?selm=397dcc8a%241_2%40dnews)
3411
3412 #define BEGIN_EVENT_TABLE(theClass, baseClass) \
3413 const wxEventTable theClass::sm_eventTable = \
3414 { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] }; \
3415 const wxEventTable *theClass::GetEventTable() const \
3416 { return &theClass::sm_eventTable; } \
3417 wxEventHashTable theClass::sm_eventHashTable(theClass::sm_eventTable); \
3418 wxEventHashTable &theClass::GetEventHashTable() const \
3419 { return theClass::sm_eventHashTable; } \
3420 const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
3421
3422 #define BEGIN_EVENT_TABLE_TEMPLATE1(theClass, baseClass, T1) \
3423 template<typename T1> \
3424 const wxEventTable theClass<T1>::sm_eventTable = \
3425 { &baseClass::sm_eventTable, &theClass<T1>::sm_eventTableEntries[0] }; \
3426 template<typename T1> \
3427 const wxEventTable *theClass<T1>::GetEventTable() const \
3428 { return &theClass<T1>::sm_eventTable; } \
3429 template<typename T1> \
3430 wxEventHashTable theClass<T1>::sm_eventHashTable(theClass<T1>::sm_eventTable); \
3431 template<typename T1> \
3432 wxEventHashTable &theClass<T1>::GetEventHashTable() const \
3433 { return theClass<T1>::sm_eventHashTable; } \
3434 template<typename T1> \
3435 const wxEventTableEntry theClass<T1>::sm_eventTableEntries[] = { \
3436
3437 #define BEGIN_EVENT_TABLE_TEMPLATE2(theClass, baseClass, T1, T2) \
3438 template<typename T1, typename T2> \
3439 const wxEventTable theClass<T1, T2>::sm_eventTable = \
3440 { &baseClass::sm_eventTable, &theClass<T1, T2>::sm_eventTableEntries[0] }; \
3441 template<typename T1, typename T2> \
3442 const wxEventTable *theClass<T1, T2>::GetEventTable() const \
3443 { return &theClass<T1, T2>::sm_eventTable; } \
3444 template<typename T1, typename T2> \
3445 wxEventHashTable theClass<T1, T2>::sm_eventHashTable(theClass<T1, T2>::sm_eventTable); \
3446 template<typename T1, typename T2> \
3447 wxEventHashTable &theClass<T1, T2>::GetEventHashTable() const \
3448 { return theClass<T1, T2>::sm_eventHashTable; } \
3449 template<typename T1, typename T2> \
3450 const wxEventTableEntry theClass<T1, T2>::sm_eventTableEntries[] = { \
3451
3452 #define BEGIN_EVENT_TABLE_TEMPLATE3(theClass, baseClass, T1, T2, T3) \
3453 template<typename T1, typename T2, typename T3> \
3454 const wxEventTable theClass<T1, T2, T3>::sm_eventTable = \
3455 { &baseClass::sm_eventTable, &theClass<T1, T2, T3>::sm_eventTableEntries[0] }; \
3456 template<typename T1, typename T2, typename T3> \
3457 const wxEventTable *theClass<T1, T2, T3>::GetEventTable() const \
3458 { return &theClass<T1, T2, T3>::sm_eventTable; } \
3459 template<typename T1, typename T2, typename T3> \
3460 wxEventHashTable theClass<T1, T2, T3>::sm_eventHashTable(theClass<T1, T2, T3>::sm_eventTable); \
3461 template<typename T1, typename T2, typename T3> \
3462 wxEventHashTable &theClass<T1, T2, T3>::GetEventHashTable() const \
3463 { return theClass<T1, T2, T3>::sm_eventHashTable; } \
3464 template<typename T1, typename T2, typename T3> \
3465 const wxEventTableEntry theClass<T1, T2, T3>::sm_eventTableEntries[] = { \
3466
3467 #define BEGIN_EVENT_TABLE_TEMPLATE4(theClass, baseClass, T1, T2, T3, T4) \
3468 template<typename T1, typename T2, typename T3, typename T4> \
3469 const wxEventTable theClass<T1, T2, T3, T4>::sm_eventTable = \
3470 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4>::sm_eventTableEntries[0] }; \
3471 template<typename T1, typename T2, typename T3, typename T4> \
3472 const wxEventTable *theClass<T1, T2, T3, T4>::GetEventTable() const \
3473 { return &theClass<T1, T2, T3, T4>::sm_eventTable; } \
3474 template<typename T1, typename T2, typename T3, typename T4> \
3475 wxEventHashTable theClass<T1, T2, T3, T4>::sm_eventHashTable(theClass<T1, T2, T3, T4>::sm_eventTable); \
3476 template<typename T1, typename T2, typename T3, typename T4> \
3477 wxEventHashTable &theClass<T1, T2, T3, T4>::GetEventHashTable() const \
3478 { return theClass<T1, T2, T3, T4>::sm_eventHashTable; } \
3479 template<typename T1, typename T2, typename T3, typename T4> \
3480 const wxEventTableEntry theClass<T1, T2, T3, T4>::sm_eventTableEntries[] = { \
3481
3482 #define BEGIN_EVENT_TABLE_TEMPLATE5(theClass, baseClass, T1, T2, T3, T4, T5) \
3483 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3484 const wxEventTable theClass<T1, T2, T3, T4, T5>::sm_eventTable = \
3485 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[0] }; \
3486 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3487 const wxEventTable *theClass<T1, T2, T3, T4, T5>::GetEventTable() const \
3488 { return &theClass<T1, T2, T3, T4, T5>::sm_eventTable; } \
3489 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3490 wxEventHashTable theClass<T1, T2, T3, T4, T5>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5>::sm_eventTable); \
3491 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3492 wxEventHashTable &theClass<T1, T2, T3, T4, T5>::GetEventHashTable() const \
3493 { return theClass<T1, T2, T3, T4, T5>::sm_eventHashTable; } \
3494 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3495 const wxEventTableEntry theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[] = { \
3496
3497 #define BEGIN_EVENT_TABLE_TEMPLATE7(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7) \
3498 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3499 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable = \
3500 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[0] }; \
3501 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3502 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventTable() const \
3503 { return &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable; } \
3504 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3505 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable); \
3506 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3507 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventHashTable() const \
3508 { return theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable; } \
3509 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3510 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[] = { \
3511
3512 #define BEGIN_EVENT_TABLE_TEMPLATE8(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7, T8) \
3513 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3514 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable = \
3515 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[0] }; \
3516 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3517 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventTable() const \
3518 { return &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable; } \
3519 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3520 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable); \
3521 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3522 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventHashTable() const \
3523 { return theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable; } \
3524 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3525 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[] = { \
3526
3527 #define END_EVENT_TABLE() DECLARE_EVENT_TABLE_TERMINATOR() };
3528
3529 /*
3530 * Event table macros
3531 */
3532
3533 // helpers for writing shorter code below: declare an event macro taking 2, 1
3534 // or none ids (the missing ids default to wxID_ANY)
3535 //
3536 // macro arguments:
3537 // - evt one of wxEVT_XXX constants
3538 // - id1, id2 ids of the first/last id
3539 // - fn the function (should be cast to the right type)
3540 #define wx__DECLARE_EVT2(evt, id1, id2, fn) \
3541 DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
3542 #define wx__DECLARE_EVT1(evt, id, fn) \
3543 wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
3544 #define wx__DECLARE_EVT0(evt, fn) \
3545 wx__DECLARE_EVT1(evt, wxID_ANY, fn)
3546
3547
3548 // Generic events
3549 #define EVT_CUSTOM(event, winid, func) \
3550 wx__DECLARE_EVT1(event, winid, wxEventHandler(func))
3551 #define EVT_CUSTOM_RANGE(event, id1, id2, func) \
3552 wx__DECLARE_EVT2(event, id1, id2, wxEventHandler(func))
3553
3554 // EVT_COMMAND
3555 #define EVT_COMMAND(winid, event, func) \
3556 wx__DECLARE_EVT1(event, winid, wxCommandEventHandler(func))
3557
3558 #define EVT_COMMAND_RANGE(id1, id2, event, func) \
3559 wx__DECLARE_EVT2(event, id1, id2, wxCommandEventHandler(func))
3560
3561 #define EVT_NOTIFY(event, winid, func) \
3562 wx__DECLARE_EVT1(event, winid, wxNotifyEventHandler(func))
3563
3564 #define EVT_NOTIFY_RANGE(event, id1, id2, func) \
3565 wx__DECLARE_EVT2(event, id1, id2, wxNotifyEventHandler(func))
3566
3567 // Miscellaneous
3568 #define EVT_SIZE(func) wx__DECLARE_EVT0(wxEVT_SIZE, wxSizeEventHandler(func))
3569 #define EVT_SIZING(func) wx__DECLARE_EVT0(wxEVT_SIZING, wxSizeEventHandler(func))
3570 #define EVT_MOVE(func) wx__DECLARE_EVT0(wxEVT_MOVE, wxMoveEventHandler(func))
3571 #define EVT_MOVING(func) wx__DECLARE_EVT0(wxEVT_MOVING, wxMoveEventHandler(func))
3572 #define EVT_MOVE_START(func) wx__DECLARE_EVT0(wxEVT_MOVE_START, wxMoveEventHandler(func))
3573 #define EVT_MOVE_END(func) wx__DECLARE_EVT0(wxEVT_MOVE_END, wxMoveEventHandler(func))
3574 #define EVT_CLOSE(func) wx__DECLARE_EVT0(wxEVT_CLOSE_WINDOW, wxCloseEventHandler(func))
3575 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3576 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3577 #define EVT_PAINT(func) wx__DECLARE_EVT0(wxEVT_PAINT, wxPaintEventHandler(func))
3578 #define EVT_NC_PAINT(func) wx__DECLARE_EVT0(wxEVT_NC_PAINT, wxNcPaintEventHandler(func))
3579 #define EVT_ERASE_BACKGROUND(func) wx__DECLARE_EVT0(wxEVT_ERASE_BACKGROUND, wxEraseEventHandler(func))
3580 #define EVT_CHAR(func) wx__DECLARE_EVT0(wxEVT_CHAR, wxCharEventHandler(func))
3581 #define EVT_KEY_DOWN(func) wx__DECLARE_EVT0(wxEVT_KEY_DOWN, wxKeyEventHandler(func))
3582 #define EVT_KEY_UP(func) wx__DECLARE_EVT0(wxEVT_KEY_UP, wxKeyEventHandler(func))
3583 #if wxUSE_HOTKEY
3584 #define EVT_HOTKEY(winid, func) wx__DECLARE_EVT1(wxEVT_HOTKEY, winid, wxCharEventHandler(func))
3585 #endif
3586 #define EVT_CHAR_HOOK(func) wx__DECLARE_EVT0(wxEVT_CHAR_HOOK, wxCharEventHandler(func))
3587 #define EVT_MENU_OPEN(func) wx__DECLARE_EVT0(wxEVT_MENU_OPEN, wxMenuEventHandler(func))
3588 #define EVT_MENU_CLOSE(func) wx__DECLARE_EVT0(wxEVT_MENU_CLOSE, wxMenuEventHandler(func))
3589 #define EVT_MENU_HIGHLIGHT(winid, func) wx__DECLARE_EVT1(wxEVT_MENU_HIGHLIGHT, winid, wxMenuEventHandler(func))
3590 #define EVT_MENU_HIGHLIGHT_ALL(func) wx__DECLARE_EVT0(wxEVT_MENU_HIGHLIGHT, wxMenuEventHandler(func))
3591 #define EVT_SET_FOCUS(func) wx__DECLARE_EVT0(wxEVT_SET_FOCUS, wxFocusEventHandler(func))
3592 #define EVT_KILL_FOCUS(func) wx__DECLARE_EVT0(wxEVT_KILL_FOCUS, wxFocusEventHandler(func))
3593 #define EVT_CHILD_FOCUS(func) wx__DECLARE_EVT0(wxEVT_CHILD_FOCUS, wxChildFocusEventHandler(func))
3594 #define EVT_ACTIVATE(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE, wxActivateEventHandler(func))
3595 #define EVT_ACTIVATE_APP(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE_APP, wxActivateEventHandler(func))
3596 #define EVT_HIBERNATE(func) wx__DECLARE_EVT0(wxEVT_HIBERNATE, wxActivateEventHandler(func))
3597 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3598 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3599 #define EVT_DROP_FILES(func) wx__DECLARE_EVT0(wxEVT_DROP_FILES, wxDropFilesEventHandler(func))
3600 #define EVT_INIT_DIALOG(func) wx__DECLARE_EVT0(wxEVT_INIT_DIALOG, wxInitDialogEventHandler(func))
3601 #define EVT_SYS_COLOUR_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEventHandler(func))
3602 #define EVT_DISPLAY_CHANGED(func) wx__DECLARE_EVT0(wxEVT_DISPLAY_CHANGED, wxDisplayChangedEventHandler(func))
3603 #define EVT_SHOW(func) wx__DECLARE_EVT0(wxEVT_SHOW, wxShowEventHandler(func))
3604 #define EVT_MAXIMIZE(func) wx__DECLARE_EVT0(wxEVT_MAXIMIZE, wxMaximizeEventHandler(func))
3605 #define EVT_ICONIZE(func) wx__DECLARE_EVT0(wxEVT_ICONIZE, wxIconizeEventHandler(func))
3606 #define EVT_NAVIGATION_KEY(func) wx__DECLARE_EVT0(wxEVT_NAVIGATION_KEY, wxNavigationKeyEventHandler(func))
3607 #define EVT_PALETTE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_PALETTE_CHANGED, wxPaletteChangedEventHandler(func))
3608 #define EVT_QUERY_NEW_PALETTE(func) wx__DECLARE_EVT0(wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEventHandler(func))
3609 #define EVT_WINDOW_CREATE(func) wx__DECLARE_EVT0(wxEVT_CREATE, wxWindowCreateEventHandler(func))
3610 #define EVT_WINDOW_DESTROY(func) wx__DECLARE_EVT0(wxEVT_DESTROY, wxWindowDestroyEventHandler(func))
3611 #define EVT_SET_CURSOR(func) wx__DECLARE_EVT0(wxEVT_SET_CURSOR, wxSetCursorEventHandler(func))
3612 #define EVT_MOUSE_CAPTURE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEventHandler(func))
3613 #define EVT_MOUSE_CAPTURE_LOST(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEventHandler(func))
3614
3615 // Mouse events
3616 #define EVT_LEFT_DOWN(func) wx__DECLARE_EVT0(wxEVT_LEFT_DOWN, wxMouseEventHandler(func))
3617 #define EVT_LEFT_UP(func) wx__DECLARE_EVT0(wxEVT_LEFT_UP, wxMouseEventHandler(func))
3618 #define EVT_MIDDLE_DOWN(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DOWN, wxMouseEventHandler(func))
3619 #define EVT_MIDDLE_UP(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_UP, wxMouseEventHandler(func))
3620 #define EVT_RIGHT_DOWN(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DOWN, wxMouseEventHandler(func))
3621 #define EVT_RIGHT_UP(func) wx__DECLARE_EVT0(wxEVT_RIGHT_UP, wxMouseEventHandler(func))
3622 #define EVT_MOTION(func) wx__DECLARE_EVT0(wxEVT_MOTION, wxMouseEventHandler(func))
3623 #define EVT_LEFT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_LEFT_DCLICK, wxMouseEventHandler(func))
3624 #define EVT_MIDDLE_DCLICK(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DCLICK, wxMouseEventHandler(func))
3625 #define EVT_RIGHT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DCLICK, wxMouseEventHandler(func))
3626 #define EVT_LEAVE_WINDOW(func) wx__DECLARE_EVT0(wxEVT_LEAVE_WINDOW, wxMouseEventHandler(func))
3627 #define EVT_ENTER_WINDOW(func) wx__DECLARE_EVT0(wxEVT_ENTER_WINDOW, wxMouseEventHandler(func))
3628 #define EVT_MOUSEWHEEL(func) wx__DECLARE_EVT0(wxEVT_MOUSEWHEEL, wxMouseEventHandler(func))
3629 #define EVT_MOUSE_AUX1_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX1_DOWN, wxMouseEventHandler(func))
3630 #define EVT_MOUSE_AUX1_UP(func) wx__DECLARE_EVT0(wxEVT_AUX1_UP, wxMouseEventHandler(func))
3631 #define EVT_MOUSE_AUX1_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX1_DCLICK, wxMouseEventHandler(func))
3632 #define EVT_MOUSE_AUX2_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX2_DOWN, wxMouseEventHandler(func))
3633 #define EVT_MOUSE_AUX2_UP(func) wx__DECLARE_EVT0(wxEVT_AUX2_UP, wxMouseEventHandler(func))
3634 #define EVT_MOUSE_AUX2_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX2_DCLICK, wxMouseEventHandler(func))
3635
3636 // All mouse events
3637 #define EVT_MOUSE_EVENTS(func) \
3638 EVT_LEFT_DOWN(func) \
3639 EVT_LEFT_UP(func) \
3640 EVT_LEFT_DCLICK(func) \
3641 EVT_MIDDLE_DOWN(func) \
3642 EVT_MIDDLE_UP(func) \
3643 EVT_MIDDLE_DCLICK(func) \
3644 EVT_RIGHT_DOWN(func) \
3645 EVT_RIGHT_UP(func) \
3646 EVT_RIGHT_DCLICK(func) \
3647 EVT_MOUSE_AUX1_DOWN(func) \
3648 EVT_MOUSE_AUX1_UP(func) \
3649 EVT_MOUSE_AUX1_DCLICK(func) \
3650 EVT_MOUSE_AUX2_DOWN(func) \
3651 EVT_MOUSE_AUX2_UP(func) \
3652 EVT_MOUSE_AUX2_DCLICK(func) \
3653 EVT_MOTION(func) \
3654 EVT_LEAVE_WINDOW(func) \
3655 EVT_ENTER_WINDOW(func) \
3656 EVT_MOUSEWHEEL(func)
3657
3658 // Scrolling from wxWindow (sent to wxScrolledWindow)
3659 #define EVT_SCROLLWIN_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_TOP, wxScrollWinEventHandler(func))
3660 #define EVT_SCROLLWIN_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEventHandler(func))
3661 #define EVT_SCROLLWIN_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEUP, wxScrollWinEventHandler(func))
3662 #define EVT_SCROLLWIN_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEventHandler(func))
3663 #define EVT_SCROLLWIN_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEventHandler(func))
3664 #define EVT_SCROLLWIN_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEventHandler(func))
3665 #define EVT_SCROLLWIN_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEventHandler(func))
3666 #define EVT_SCROLLWIN_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEventHandler(func))
3667
3668 #define EVT_SCROLLWIN(func) \
3669 EVT_SCROLLWIN_TOP(func) \
3670 EVT_SCROLLWIN_BOTTOM(func) \
3671 EVT_SCROLLWIN_LINEUP(func) \
3672 EVT_SCROLLWIN_LINEDOWN(func) \
3673 EVT_SCROLLWIN_PAGEUP(func) \
3674 EVT_SCROLLWIN_PAGEDOWN(func) \
3675 EVT_SCROLLWIN_THUMBTRACK(func) \
3676 EVT_SCROLLWIN_THUMBRELEASE(func)
3677
3678 // Scrolling from wxSlider and wxScrollBar
3679 #define EVT_SCROLL_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_TOP, wxScrollEventHandler(func))
3680 #define EVT_SCROLL_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLL_BOTTOM, wxScrollEventHandler(func))
3681 #define EVT_SCROLL_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEUP, wxScrollEventHandler(func))
3682 #define EVT_SCROLL_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEDOWN, wxScrollEventHandler(func))
3683 #define EVT_SCROLL_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEUP, wxScrollEventHandler(func))
3684 #define EVT_SCROLL_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler(func))
3685 #define EVT_SCROLL_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler(func))
3686 #define EVT_SCROLL_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBRELEASE, wxScrollEventHandler(func))
3687 #define EVT_SCROLL_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SCROLL_CHANGED, wxScrollEventHandler(func))
3688
3689 #define EVT_SCROLL(func) \
3690 EVT_SCROLL_TOP(func) \
3691 EVT_SCROLL_BOTTOM(func) \
3692 EVT_SCROLL_LINEUP(func) \
3693 EVT_SCROLL_LINEDOWN(func) \
3694 EVT_SCROLL_PAGEUP(func) \
3695 EVT_SCROLL_PAGEDOWN(func) \
3696 EVT_SCROLL_THUMBTRACK(func) \
3697 EVT_SCROLL_THUMBRELEASE(func) \
3698 EVT_SCROLL_CHANGED(func)
3699
3700 // Scrolling from wxSlider and wxScrollBar, with an id
3701 #define EVT_COMMAND_SCROLL_TOP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_TOP, winid, wxScrollEventHandler(func))
3702 #define EVT_COMMAND_SCROLL_BOTTOM(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_BOTTOM, winid, wxScrollEventHandler(func))
3703 #define EVT_COMMAND_SCROLL_LINEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEUP, winid, wxScrollEventHandler(func))
3704 #define EVT_COMMAND_SCROLL_LINEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEDOWN, winid, wxScrollEventHandler(func))
3705 #define EVT_COMMAND_SCROLL_PAGEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEUP, winid, wxScrollEventHandler(func))
3706 #define EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEDOWN, winid, wxScrollEventHandler(func))
3707 #define EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBTRACK, winid, wxScrollEventHandler(func))
3708 #define EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBRELEASE, winid, wxScrollEventHandler(func))
3709 #define EVT_COMMAND_SCROLL_CHANGED(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_CHANGED, winid, wxScrollEventHandler(func))
3710
3711 #define EVT_COMMAND_SCROLL(winid, func) \
3712 EVT_COMMAND_SCROLL_TOP(winid, func) \
3713 EVT_COMMAND_SCROLL_BOTTOM(winid, func) \
3714 EVT_COMMAND_SCROLL_LINEUP(winid, func) \
3715 EVT_COMMAND_SCROLL_LINEDOWN(winid, func) \
3716 EVT_COMMAND_SCROLL_PAGEUP(winid, func) \
3717 EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) \
3718 EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) \
3719 EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) \
3720 EVT_COMMAND_SCROLL_CHANGED(winid, func)
3721
3722 #if WXWIN_COMPATIBILITY_2_6
3723 // compatibility macros for the old name, deprecated in 2.8
3724 #define wxEVT_SCROLL_ENDSCROLL wxEVT_SCROLL_CHANGED
3725 #define EVT_COMMAND_SCROLL_ENDSCROLL EVT_COMMAND_SCROLL_CHANGED
3726 #define EVT_SCROLL_ENDSCROLL EVT_SCROLL_CHANGED
3727 #endif // WXWIN_COMPATIBILITY_2_6
3728
3729 // Convenience macros for commonly-used commands
3730 #define EVT_CHECKBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKBOX_CLICKED, winid, wxCommandEventHandler(func))
3731 #define EVT_CHOICE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHOICE_SELECTED, winid, wxCommandEventHandler(func))
3732 #define EVT_LISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_SELECTED, winid, wxCommandEventHandler(func))
3733 #define EVT_LISTBOX_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, winid, wxCommandEventHandler(func))
3734 #define EVT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_MENU_SELECTED, winid, wxCommandEventHandler(func))
3735 #define EVT_MENU_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_MENU_SELECTED, id1, id2, wxCommandEventHandler(func))
3736 #if defined(__SMARTPHONE__)
3737 # define EVT_BUTTON(winid, func) EVT_MENU(winid, func)
3738 #else
3739 # define EVT_BUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_BUTTON_CLICKED, winid, wxCommandEventHandler(func))
3740 #endif
3741 #define EVT_SLIDER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SLIDER_UPDATED, winid, wxCommandEventHandler(func))
3742 #define EVT_RADIOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBOX_SELECTED, winid, wxCommandEventHandler(func))
3743 #define EVT_RADIOBUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBUTTON_SELECTED, winid, wxCommandEventHandler(func))
3744 // EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events
3745 #define EVT_SCROLLBAR(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SCROLLBAR_UPDATED, winid, wxCommandEventHandler(func))
3746 #define EVT_VLBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_VLBOX_SELECTED, winid, wxCommandEventHandler(func))
3747 #define EVT_COMBOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_SELECTED, winid, wxCommandEventHandler(func))
3748 #define EVT_TOOL(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_CLICKED, winid, wxCommandEventHandler(func))
3749 #define EVT_TOOL_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, winid, wxCommandEventHandler(func))
3750 #define EVT_TOOL_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_CLICKED, id1, id2, wxCommandEventHandler(func))
3751 #define EVT_TOOL_RCLICKED(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_RCLICKED, winid, wxCommandEventHandler(func))
3752 #define EVT_TOOL_RCLICKED_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, wxCommandEventHandler(func))
3753 #define EVT_TOOL_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_ENTER, winid, wxCommandEventHandler(func))
3754 #define EVT_CHECKLISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, winid, wxCommandEventHandler(func))
3755 #define EVT_COMBOBOX_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_DROPDOWN, winid, wxCommandEventHandler(func))
3756 #define EVT_COMBOBOX_CLOSEUP(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_CLOSEUP, winid, wxCommandEventHandler(func))
3757
3758 // Generic command events
3759 #define EVT_COMMAND_LEFT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_CLICK, winid, wxCommandEventHandler(func))
3760 #define EVT_COMMAND_LEFT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_DCLICK, winid, wxCommandEventHandler(func))
3761 #define EVT_COMMAND_RIGHT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_CLICK, winid, wxCommandEventHandler(func))
3762 #define EVT_COMMAND_RIGHT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_DCLICK, winid, wxCommandEventHandler(func))
3763 #define EVT_COMMAND_SET_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SET_FOCUS, winid, wxCommandEventHandler(func))
3764 #define EVT_COMMAND_KILL_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_KILL_FOCUS, winid, wxCommandEventHandler(func))
3765 #define EVT_COMMAND_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_ENTER, winid, wxCommandEventHandler(func))
3766
3767 // Joystick events
3768
3769 #define EVT_JOY_BUTTON_DOWN(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_DOWN, wxJoystickEventHandler(func))
3770 #define EVT_JOY_BUTTON_UP(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_UP, wxJoystickEventHandler(func))
3771 #define EVT_JOY_MOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_MOVE, wxJoystickEventHandler(func))
3772 #define EVT_JOY_ZMOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_ZMOVE, wxJoystickEventHandler(func))
3773
3774 // All joystick events
3775 #define EVT_JOYSTICK_EVENTS(func) \
3776 EVT_JOY_BUTTON_DOWN(func) \
3777 EVT_JOY_BUTTON_UP(func) \
3778 EVT_JOY_MOVE(func) \
3779 EVT_JOY_ZMOVE(func)
3780
3781 // Idle event
3782 #define EVT_IDLE(func) wx__DECLARE_EVT0(wxEVT_IDLE, wxIdleEventHandler(func))
3783
3784 // Update UI event
3785 #define EVT_UPDATE_UI(winid, func) wx__DECLARE_EVT1(wxEVT_UPDATE_UI, winid, wxUpdateUIEventHandler(func))
3786 #define EVT_UPDATE_UI_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_UPDATE_UI, id1, id2, wxUpdateUIEventHandler(func))
3787
3788 // Help events
3789 #define EVT_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_HELP, winid, wxHelpEventHandler(func))
3790 #define EVT_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_HELP, id1, id2, wxHelpEventHandler(func))
3791 #define EVT_DETAILED_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_DETAILED_HELP, winid, wxHelpEventHandler(func))
3792 #define EVT_DETAILED_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_DETAILED_HELP, id1, id2, wxHelpEventHandler(func))
3793
3794 // Context Menu Events
3795 #define EVT_CONTEXT_MENU(func) wx__DECLARE_EVT0(wxEVT_CONTEXT_MENU, wxContextMenuEventHandler(func))
3796 #define EVT_COMMAND_CONTEXT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_CONTEXT_MENU, winid, wxContextMenuEventHandler(func))
3797
3798 // Clipboard text Events
3799 #define EVT_TEXT_CUT(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_CUT, winid, wxClipboardTextEventHandler(func))
3800 #define EVT_TEXT_COPY(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_COPY, winid, wxClipboardTextEventHandler(func))
3801 #define EVT_TEXT_PASTE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_PASTE, winid, wxClipboardTextEventHandler(func))
3802
3803 // Thread events
3804 #define EVT_THREAD(id, func) wx__DECLARE_EVT1(wxEVT_COMMAND_THREAD, id, wxThreadEventHandler(func))
3805
3806 // ----------------------------------------------------------------------------
3807 // Helper functions
3808 // ----------------------------------------------------------------------------
3809
3810 // This is an ugly hack to allow the use of Bind() instead of Connect() inside
3811 // the library code if the library was built with support for it, here is how
3812 // it is used:
3813 //
3814 // class SomeEventHandlingClass : wxBIND_OR_CONNECT_HACK_BASE_CLASS
3815 // public SomeBaseClass
3816 // {
3817 // public:
3818 // SomeEventHandlingClass(wxWindow *win)
3819 // {
3820 // // connect to the event for the given window
3821 // wxBIND_OR_CONNECT_HACK(win, wxEVT_SOMETHING, wxSomeEventHandler,
3822 // SomeEventHandlingClass::OnSomeEvent, this);
3823 // }
3824 //
3825 // private:
3826 // void OnSomeEvent(wxSomeEvent&) { ... }
3827 // };
3828 //
3829 // This is *not* meant to be used by library users, it is only defined here
3830 // (and not in a private header) because the base class must be visible from
3831 // other public headers, please do NOT use this in your code, it will be
3832 // removed from future wx versions without warning.
3833 #if wxEVENTS_COMPATIBILITY_2_8
3834 #define wxBIND_OR_CONNECT_HACK_BASE_CLASS public wxEvtHandler,
3835 #define wxBIND_OR_CONNECT_HACK_ONLY_BASE_CLASS : public wxEvtHandler
3836 #define wxBIND_OR_CONNECT_HACK(w, evt, handler, func, obj) \
3837 win->Connect(evt, handler(func), NULL, obj)
3838 #else // wxEVENTS_COMPATIBILITY_2_8
3839 #define wxBIND_OR_CONNECT_HACK_BASE_CLASS
3840 #define wxBIND_OR_CONNECT_HACK_ONLY_BASE_CLASS
3841 #define wxBIND_OR_CONNECT_HACK(w, evt, handler, func, obj) \
3842 win->Bind(evt, &func, obj)
3843 #endif // wxEVENTS_COMPATIBILITY_2_8/!wxEVENTS_COMPATIBILITY_2_8
3844
3845 #if wxUSE_GUI
3846
3847 // Find a window with the focus, that is also a descendant of the given window.
3848 // This is used to determine the window to initially send commands to.
3849 WXDLLIMPEXP_CORE wxWindow* wxFindFocusDescendant(wxWindow* ancestor);
3850
3851 #endif // wxUSE_GUI
3852
3853 #endif // _WX_EVENT_H_