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