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