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