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