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