]> git.saurik.com Git - wxWidgets.git/blame - include/wx/event.h
fix crash caused by an wxMDIClientWindow's GTK signal handler being called when 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) \
3c778901
VZ
81 wxEventTableEntry(type, winid, idLast, wxNewEventFunctor(type, fn), obj)
82
83#define DECLARE_EVENT_TABLE_TERMINATOR() \
84 wxEventTableEntry(wxEVT_NULL, 0, 0, 0, 0)
cbee8f8d 85
c058cafa
VZ
86// obsolete event declaration/definition macros, we don't need them any longer
87// but we keep them for compatibility as it doesn't cost us anything anyhow
2e4df4bf
VZ
88#define BEGIN_DECLARE_EVENT_TYPES()
89#define END_DECLARE_EVENT_TYPES()
886dd7d2
VZ
90#define DECLARE_EXPORTED_EVENT_TYPE(expdecl, name, value) \
91 extern expdecl const wxEventType name;
85664da6 92#define DECLARE_EVENT_TYPE(name, value) \
bddd7a8d 93 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_CORE, name, value)
886dd7d2 94#define DECLARE_LOCAL_EVENT_TYPE(name, value) \
bde626ce 95 DECLARE_EXPORTED_EVENT_TYPE(wxEMPTY_PARAMETER_VALUE, name, value)
71499aaf 96#define DEFINE_EVENT_TYPE(name) const wxEventType name = wxNewEventType();
886dd7d2 97#define DEFINE_LOCAL_EVENT_TYPE(name) DEFINE_EVENT_TYPE(name)
cbee8f8d
VZ
98
99// generate a new unique event type
bddd7a8d 100extern WXDLLIMPEXP_BASE wxEventType wxNewEventType();
cbee8f8d 101
111d41b2 102// New macros to create templatized event types:
3c778901
VZ
103
104#if wxEVENTS_COMPATIBILITY_2_8
111d41b2
VZ
105
106 // Define/Declare a wxEventType-based event type:
107
3c778901 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 ) \
9b11752c 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 ) \
9b11752c 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
898a466a
VZ
261// Create a functor for the legacy events: handler can be NULL and its default
262// value is used by the event table macros
03f3617b
VZ
263
264inline wxObjectEventFunctor *
48def411 265wxNewEventFunctor(const wxEventType& WXUNUSED(evtType),
03f3617b 266 wxObjectEventFunction method,
898a466a 267 wxEvtHandler *handler = NULL)
03f3617b
VZ
268{
269 return new wxObjectEventFunctor(method, handler);
270}
271
272inline wxObjectEventFunctor
f3ff831f 273wxMakeEventFunctor(const wxEventType& WXUNUSED(evtType),
03f3617b
VZ
274 wxObjectEventFunction method,
275 wxEvtHandler *handler)
276{
277 return wxObjectEventFunctor(method, handler);
278}
279
f3ff831f 280#else // !wxEVENTS_COMPATIBILITY_2_8
3c778901 281
f3ff831f
VZ
282// functor forwarding the event to anything callable (function, static method,
283// generalized functor...)
284template <typename EventTag, typename Functor>
412fcdc1 285class wxEventFunctorFunction : public wxEventFunctor
3c778901
VZ
286{
287public:
f3ff831f
VZ
288 typedef typename EventTag::EventClass EventArg;
289
290 wxEventFunctorFunction(Functor handler)
3c778901
VZ
291 {
292 m_handler = handler;
293 }
294
295 virtual void operator()(wxEvtHandler *WXUNUSED(handler), wxEvent& event)
296 {
f3ff831f 297 m_handler(static_cast<EventArg&>(event));
3c778901
VZ
298 }
299
f3ff831f 300 virtual bool Matches(const wxEventFunctor& WXUNUSED(func)) const
3c778901 301 {
f3ff831f
VZ
302 // we have no way to compare arbitrary functors so just consider them
303 // to be equal: this means that disconnecting a functor will always
304 // find the last functor connected which in turn implies that it's
305 // probably a bad idea to connect more than one functor if you plan to
306 // disconnect them but this limitation doesn't seem very important in
307 // practice
308 return true;
3c778901
VZ
309 }
310
311private:
f3ff831f
VZ
312 Functor m_handler;
313};
314
f3ff831f
VZ
315namespace wxPrivate
316{
317
a01ada05
VZ
318// helper template defining nested "type" typedef as the event class
319// corresponding to the given event type
320template <typename T> struct EventClassOf;
321
322// the typed events provide the information about the class of the events they
323// carry themselves:
324template <typename T>
325struct EventClassOf< wxEventTypeTag<T> >
326{
327 typedef typename wxEventTypeTag<T>::EventClass type;
328};
329
330// for the old untyped events we don't have information about the exact event
331// class carried by them
332template <>
333struct EventClassOf<wxEventType>
334{
335 typedef wxEvent type;
336};
337
338
339// helper class defining operations different for method functors using an
340// object of wxEvtHandler-derived class as handler and the others
f3ff831f
VZ
341template <typename T, typename A, bool> struct HandlerImpl;
342
343// specialization for handlers deriving from wxEvtHandler
344template <typename T, typename A>
345struct HandlerImpl<T, A, true>
346{
347 static bool IsEvtHandler()
348 { return true; }
349 static T *ConvertFromEvtHandler(wxEvtHandler *p)
350 { return static_cast<T *>(p); }
351 static wxEvtHandler *ConvertToEvtHandler(T *p)
352 { return p; }
353 static wxEventFunction ConvertToEvtFunction(void (T::*f)(A&))
a01ada05
VZ
354 { return static_cast<wxEventFunction>(
355 reinterpret_cast<void (T::*)(wxEvent&)>(f)); }
3c778901
VZ
356};
357
f3ff831f
VZ
358// specialization for handlers not deriving from wxEvtHandler
359template <typename T, typename A>
360struct HandlerImpl<T, A, false>
361{
362 static bool IsEvtHandler()
363 { return false; }
364 static T *ConvertFromEvtHandler(wxEvtHandler *)
365 { return NULL; }
366 static wxEvtHandler *ConvertToEvtHandler(T *)
367 { return NULL; }
368 static wxEventFunction ConvertToEvtFunction(void (T::*)(A&))
369 { return NULL; }
370};
371
372} // namespace wxPrivate
3c778901 373
f3ff831f
VZ
374// functor forwarding the event to a method of the given object
375//
376// notice that the object class may be different from the class in which the
377// method is defined but it must be convertible to this class
a01ada05
VZ
378//
379// also, the type of the handler parameter doesn't need to be exactly the same
380// as EventTag::EventClass but it must be its base class -- this is explicitly
381// allowed to handle different events in the same handler taking wxEvent&, for
382// example
383template
384 <typename EventTag, typename Class, typename EventArg, typename ObjClass>
f3ff831f
VZ
385class wxEventFunctorMethod
386 : public wxEventFunctor,
387 private wxPrivate::HandlerImpl
388 <
389 Class,
a01ada05 390 EventArg,
c4021a79 391 wxConvertibleTo<Class, wxEvtHandler>::value != 0
f3ff831f 392 >
3c778901 393{
a01ada05
VZ
394private:
395 static void CheckHandlerArgument(EventArg *) { }
396
3c778901 397public:
a01ada05
VZ
398 // the event class associated with the given event tag
399 typedef typename wxPrivate::EventClassOf<EventTag>::type EventClass;
400
f3ff831f
VZ
401
402 wxEventFunctorMethod(void (Class::*method)(EventArg&), ObjClass *handler)
3c778901 403 {
361ba943 404 wxASSERT_MSG( handler || this->IsEvtHandler(),
f3ff831f
VZ
405 "handlers defined in non-wxEvtHandler-derived classes "
406 "must be connected with a valid sink object" );
407
a01ada05
VZ
408 // if you get an error here it means that the signature of the handler
409 // you're trying to use is not compatible with (i.e. is not the same as
410 // or a base class of) the real event class used for this event type
411 CheckHandlerArgument(static_cast<EventClass *>(NULL));
412
3c778901
VZ
413 m_handler = handler;
414 m_method = method;
415 }
416
f3ff831f 417 virtual void operator()(wxEvtHandler *handler, wxEvent& event)
3c778901 418 {
f3ff831f
VZ
419 Class * realHandler = m_handler;
420 if ( !realHandler )
3c778901 421 {
361ba943 422 realHandler = this->ConvertFromEvtHandler(handler);
3c778901 423
f3ff831f
VZ
424 // this is not supposed to happen but check for it nevertheless
425 wxCHECK_RET( realHandler, "invalid event handler" );
3c778901
VZ
426 }
427
a01ada05
VZ
428 // the real (run-time) type of event is EventClass and we checked in
429 // the ctor that EventClass can be converted to EventArg, so this cast
430 // is always valid
f3ff831f 431 (realHandler->*m_method)(static_cast<EventArg&>(event));
3c778901
VZ
432 }
433
f3ff831f 434 virtual bool Matches(const wxEventFunctor& func) const
3c778901 435 {
f3ff831f
VZ
436 void * const handler = func.GetHandler();
437 if ( handler && GetHandler() != handler )
438 return false;
3c778901 439
f3ff831f
VZ
440 const wxEventFunction method = GetMethod();
441 return !method || GetMethod() == method;
3c778901
VZ
442 }
443
f3ff831f 444 virtual void *GetHandler() const
3c778901 445 {
3c778901
VZ
446 return m_handler;
447 }
448
f3ff831f 449 virtual wxEventFunction GetMethod() const
3c778901 450 {
361ba943 451 return this->ConvertToEvtFunction(m_method);
f3ff831f
VZ
452 }
453
454 virtual wxEvtHandler *GetEvtHandler() const
455 {
361ba943 456 return this->ConvertToEvtHandler(m_handler);
3c778901
VZ
457 }
458
459private:
f3ff831f
VZ
460 ObjClass *m_handler;
461 void (Class::*m_method)(EventArg&);
3c778901
VZ
462};
463
f3ff831f 464
3c778901 465//
f3ff831f
VZ
466// Create functors for the templatized events, either allocated on the heap for
467// wxNewXXX() variants (this is needed in wxEvtHandler::Connect() to store them
468// in dynamic event table) or just by returning them as temporary objects (this
469// is enough for Disconnect() and we allocate unnecessary heap allocation like
470// this)
3c778901 471
3c778901 472
f3ff831f
VZ
473// Create functors wrapping other functors (including functions):
474template <typename EventTag, typename Functor>
475inline wxEventFunctorFunction<EventTag, Functor> *
476wxNewEventFunctor(const EventTag&, Functor func)
3c778901 477{
f3ff831f 478 return new wxEventFunctorFunction<EventTag, Functor>(func);
3c778901
VZ
479}
480
f3ff831f
VZ
481template <typename EventTag, typename Functor>
482inline wxEventFunctorFunction<EventTag, Functor>
483wxMakeEventFunctor(const EventTag&, Functor func)
3c778901 484{
f3ff831f 485 return wxEventFunctorFunction<EventTag, Functor>(func);
3c778901
VZ
486}
487
3c778901 488
f3ff831f
VZ
489// Create functors for methods:
490template
491 <typename EventTag, typename Class, typename EventArg, typename ObjClass>
a01ada05 492inline wxEventFunctorMethod<EventTag, Class, EventArg, ObjClass> *
f3ff831f
VZ
493wxNewEventFunctor(const EventTag&,
494 void (Class::*method)(EventArg&),
495 ObjClass *handler)
3c778901 496{
a01ada05
VZ
497 return new wxEventFunctorMethod<EventTag, Class, EventArg, ObjClass>(
498 method, handler);
3c778901
VZ
499}
500
f3ff831f
VZ
501template
502 <typename EventTag, typename Class, typename EventArg, typename ObjClass>
a01ada05 503inline wxEventFunctorMethod<EventTag, Class, EventArg, ObjClass>
f3ff831f
VZ
504wxMakeEventFunctor(const EventTag&,
505 void (Class::*method)(EventArg&),
506 ObjClass *handler)
3c778901 507{
a01ada05
VZ
508 return wxEventFunctorMethod<EventTag, Class, EventArg, ObjClass>(
509 method, handler);
3c778901
VZ
510}
511
f3ff831f
VZ
512// Special case for the wxNewEventFunctor() calls used inside the event table
513// macros: they don't specify the handler so ObjClass can't be deduced
514template <typename EventTag, typename Class, typename EventArg>
a01ada05 515inline wxEventFunctorMethod<EventTag, Class, EventArg, Class> *
f3ff831f 516wxNewEventFunctor(const EventTag&, void (Class::*method)(EventArg&))
3c778901 517{
a01ada05
VZ
518 return new wxEventFunctorMethod<EventTag, Class, EventArg, Class>(
519 method, NULL);
3c778901
VZ
520}
521
f3ff831f
VZ
522template
523 <typename EventTag, typename Class, typename EventArg, typename ObjClass>
a01ada05 524inline wxEventFunctorMethod<EventTag, Class, EventArg, Class>
f3ff831f 525wxMakeEventFunctor(const EventTag&, void (Class::*method)(EventArg&))
3c778901 526{
a01ada05
VZ
527 return wxEventFunctorMethod<EventTag, Class, EventArg, Class>(
528 method, NULL);
3c778901
VZ
529}
530
531#endif // !wxEVENTS_COMPATIBILITY_2_8
532
f3ff831f 533
c058cafa
VZ
534// many, but not all, standard event types
535
536 // some generic events
537extern WXDLLIMPEXP_BASE const wxEventType wxEVT_NULL;
538extern WXDLLIMPEXP_BASE const wxEventType wxEVT_FIRST;
539extern WXDLLIMPEXP_BASE const wxEventType wxEVT_USER_FIRST;
540
3c778901
VZ
541 // Need events declared to do this
542class WXDLLIMPEXP_FWD_CORE wxCommandEvent;
f6a3e0ba 543class WXDLLIMPEXP_FWD_CORE wxThreadEvent;
3c778901
VZ
544class WXDLLIMPEXP_FWD_CORE wxMouseEvent;
545class WXDLLIMPEXP_FWD_CORE wxFocusEvent;
546class WXDLLIMPEXP_FWD_CORE wxChildFocusEvent;
547class WXDLLIMPEXP_FWD_CORE wxKeyEvent;
548class WXDLLIMPEXP_FWD_CORE wxNavigationKeyEvent;
549class WXDLLIMPEXP_FWD_CORE wxSetCursorEvent;
550class WXDLLIMPEXP_FWD_CORE wxScrollEvent;
dca94103 551class WXDLLIMPEXP_FWD_CORE wxSpinEvent;
3c778901
VZ
552class WXDLLIMPEXP_FWD_CORE wxScrollWinEvent;
553class WXDLLIMPEXP_FWD_CORE wxSizeEvent;
554class WXDLLIMPEXP_FWD_CORE wxMoveEvent;
555class WXDLLIMPEXP_FWD_CORE wxCloseEvent;
556class WXDLLIMPEXP_FWD_CORE wxActivateEvent;
557class WXDLLIMPEXP_FWD_CORE wxWindowCreateEvent;
558class WXDLLIMPEXP_FWD_CORE wxWindowDestroyEvent;
559class WXDLLIMPEXP_FWD_CORE wxShowEvent;
560class WXDLLIMPEXP_FWD_CORE wxIconizeEvent;
561class WXDLLIMPEXP_FWD_CORE wxMaximizeEvent;
562class WXDLLIMPEXP_FWD_CORE wxMouseCaptureChangedEvent;
563class WXDLLIMPEXP_FWD_CORE wxMouseCaptureLostEvent;
564class WXDLLIMPEXP_FWD_CORE wxPaintEvent;
565class WXDLLIMPEXP_FWD_CORE wxEraseEvent;
566class WXDLLIMPEXP_FWD_CORE wxNcPaintEvent;
567class WXDLLIMPEXP_FWD_CORE wxMenuEvent;
568class WXDLLIMPEXP_FWD_CORE wxContextMenuEvent;
569class WXDLLIMPEXP_FWD_CORE wxSysColourChangedEvent;
570class WXDLLIMPEXP_FWD_CORE wxDisplayChangedEvent;
571class WXDLLIMPEXP_FWD_CORE wxQueryNewPaletteEvent;
572class WXDLLIMPEXP_FWD_CORE wxPaletteChangedEvent;
573class WXDLLIMPEXP_FWD_CORE wxJoystickEvent;
574class WXDLLIMPEXP_FWD_CORE wxDropFilesEvent;
575class WXDLLIMPEXP_FWD_CORE wxInitDialogEvent;
576class WXDLLIMPEXP_FWD_CORE wxIdleEvent;
577class WXDLLIMPEXP_FWD_CORE wxUpdateUIEvent;
578class WXDLLIMPEXP_FWD_CORE wxClipboardTextEvent;
579class WXDLLIMPEXP_FWD_CORE wxHelpEvent;
580
581
c058cafa 582 // Command events
9b11752c
VZ
583wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEvent);
584wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_CHECKBOX_CLICKED, wxCommandEvent);
585wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_CHOICE_SELECTED, wxCommandEvent);
586wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_LISTBOX_SELECTED, wxCommandEvent);
587wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, wxCommandEvent);
588wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, wxCommandEvent);
589wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_MENU_SELECTED, wxCommandEvent);
590wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_SLIDER_UPDATED, wxCommandEvent);
591wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_RADIOBOX_SELECTED, wxCommandEvent);
592wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_RADIOBUTTON_SELECTED, wxCommandEvent);
c058cafa
VZ
593
594// wxEVT_COMMAND_SCROLLBAR_UPDATED is deprecated, use wxEVT_SCROLL... events
9b11752c
VZ
595wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_SCROLLBAR_UPDATED, wxCommandEvent);
596wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_VLBOX_SELECTED, wxCommandEvent);
597wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_COMBOBOX_SELECTED, wxCommandEvent);
598wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TOOL_RCLICKED, wxCommandEvent);
599wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, wxCommandEvent);
600wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TOOL_ENTER, wxCommandEvent);
c058cafa 601
d48b06bd 602 // Thread events
9b11752c 603wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_THREAD, wxThreadEvent);
d48b06bd 604
c058cafa 605 // Mouse event types
9b11752c
VZ
606wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_LEFT_DOWN, wxMouseEvent);
607wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_LEFT_UP, wxMouseEvent);
608wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MIDDLE_DOWN, wxMouseEvent);
609wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MIDDLE_UP, wxMouseEvent);
610wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_RIGHT_DOWN, wxMouseEvent);
611wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_RIGHT_UP, wxMouseEvent);
612wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOTION, wxMouseEvent);
613wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_ENTER_WINDOW, wxMouseEvent);
614wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_LEAVE_WINDOW, wxMouseEvent);
615wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_LEFT_DCLICK, wxMouseEvent);
616wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MIDDLE_DCLICK, wxMouseEvent);
617wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_RIGHT_DCLICK, wxMouseEvent);
618wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SET_FOCUS, wxFocusEvent);
619wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_KILL_FOCUS, wxFocusEvent);
620wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_CHILD_FOCUS, wxChildFocusEvent);
621wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOUSEWHEEL, wxMouseEvent);
622wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_AUX1_DOWN, wxMouseEvent);
623wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_AUX1_UP, wxMouseEvent);
624wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_AUX1_DCLICK, wxMouseEvent);
625wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_AUX2_DOWN, wxMouseEvent);
626wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_AUX2_UP, wxMouseEvent);
627wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_AUX2_DCLICK, wxMouseEvent);
c058cafa
VZ
628
629 // Character input event type
9b11752c
VZ
630wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_CHAR, wxKeyEvent);
631wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_CHAR_HOOK, wxKeyEvent);
632wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_NAVIGATION_KEY, wxNavigationKeyEvent);
633wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_KEY_DOWN, wxKeyEvent);
634wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_KEY_UP, wxKeyEvent);
5048c832 635#if wxUSE_HOTKEY
9b11752c 636wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_HOTKEY, wxKeyEvent);
5048c832 637#endif
c058cafa 638 // Set cursor event
9b11752c 639wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SET_CURSOR, wxSetCursorEvent);
c058cafa
VZ
640
641 // wxScrollBar and wxSlider event identifiers
9b11752c
VZ
642wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_TOP, wxScrollEvent);
643wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_BOTTOM, wxScrollEvent);
644wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_LINEUP, wxScrollEvent);
645wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_LINEDOWN, wxScrollEvent);
646wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_PAGEUP, wxScrollEvent);
647wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_PAGEDOWN, wxScrollEvent);
648wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_THUMBTRACK, wxScrollEvent);
649wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_THUMBRELEASE, wxScrollEvent);
650wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_CHANGED, wxScrollEvent);
c058cafa 651
dca94103
VZ
652// Due to a bug in older wx versions, wxSpinEvents were being sent with type of
653// wxEVT_SCROLL_LINEUP, wxEVT_SCROLL_LINEDOWN and wxEVT_SCROLL_THUMBTRACK. But
654// with the type-safe events in place, these event types are associated with
655// wxScrollEvent. To allow handling of spin events, new event types have been
656// defined in spinbutt.h/spinnbuttcmn.cpp. To maintain backward compatibility
657// the spin event types are being initialized with the scroll event types.
658
659#if wxUSE_SPINBTN
660
9b11752c
VZ
661wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE, wxEVT_SPIN_UP, wxSpinEvent );
662wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE, wxEVT_SPIN_DOWN, wxSpinEvent );
663wxDECLARE_EXPORTED_EVENT_ALIAS( WXDLLIMPEXP_CORE, wxEVT_SPIN, wxSpinEvent );
dca94103
VZ
664
665#endif
666
c058cafa 667 // Scroll events from wxWindow
9b11752c
VZ
668wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_TOP, wxScrollWinEvent);
669wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEvent);
670wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_LINEUP, wxScrollWinEvent);
671wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEvent);
672wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEvent);
673wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEvent);
674wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEvent);
675wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEvent);
c058cafa
VZ
676
677 // System events
9b11752c
VZ
678wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SIZE, wxSizeEvent);
679wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOVE, wxMoveEvent);
680wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_CLOSE_WINDOW, wxCloseEvent);
681wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_END_SESSION, wxCloseEvent);
682wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_QUERY_END_SESSION, wxCloseEvent);
683wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_ACTIVATE_APP, wxActivateEvent);
684wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_ACTIVATE, wxActivateEvent);
685wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_CREATE, wxWindowCreateEvent);
686wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_DESTROY, wxWindowDestroyEvent);
687wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SHOW, wxShowEvent);
688wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_ICONIZE, wxIconizeEvent);
689wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MAXIMIZE, wxMaximizeEvent);
690wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEvent);
691wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEvent);
692wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_PAINT, wxPaintEvent);
693wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_ERASE_BACKGROUND, wxEraseEvent);
694wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_NC_PAINT, wxNcPaintEvent);
695wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MENU_OPEN, wxMenuEvent);
696wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MENU_CLOSE, wxMenuEvent);
697wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MENU_HIGHLIGHT, wxMenuEvent);
698wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_CONTEXT_MENU, wxContextMenuEvent);
699wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEvent);
700wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_DISPLAY_CHANGED, wxDisplayChangedEvent);
701wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEvent);
702wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_PALETTE_CHANGED, wxPaletteChangedEvent);
703wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_JOY_BUTTON_DOWN, wxJoystickEvent);
704wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_JOY_BUTTON_UP, wxJoystickEvent);
705wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_JOY_MOVE, wxJoystickEvent);
706wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_JOY_ZMOVE, wxJoystickEvent);
707wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_DROP_FILES, wxDropFilesEvent);
708wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_INIT_DIALOG, wxInitDialogEvent);
709wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_BASE, wxEVT_IDLE, wxIdleEvent);
710wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_UPDATE_UI, wxUpdateUIEvent);
711wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SIZING, wxSizeEvent);
712wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOVING, wxMoveEvent);
713wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOVE_START, wxMoveEvent);
714wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOVE_END, wxMoveEvent);
715wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_HIBERNATE, wxActivateEvent);
c058cafa
VZ
716
717 // Clipboard events
9b11752c
VZ
718wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TEXT_COPY, wxClipboardTextEvent);
719wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TEXT_CUT, wxClipboardTextEvent);
720wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TEXT_PASTE, wxClipboardTextEvent);
c058cafa
VZ
721
722 // Generic command events
723 // Note: a click is a higher-level event than button down/up
9b11752c
VZ
724wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_LEFT_CLICK, wxCommandEvent);
725wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_LEFT_DCLICK, wxCommandEvent);
726wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_RIGHT_CLICK, wxCommandEvent);
727wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_RIGHT_DCLICK, wxCommandEvent);
728wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_SET_FOCUS, wxCommandEvent);
729wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_KILL_FOCUS, wxCommandEvent);
730wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_ENTER, wxCommandEvent);
c058cafa
VZ
731
732 // Help events
9b11752c
VZ
733wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_HELP, wxHelpEvent);
734wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_DETAILED_HELP, wxHelpEvent);
96f6c703 735
cbee8f8d
VZ
736// these 2 events are the same
737#define wxEVT_COMMAND_TOOL_CLICKED wxEVT_COMMAND_MENU_SELECTED
96f6c703 738
ad0bae85 739// ----------------------------------------------------------------------------
77d4384e 740// Compatibility
ad0bae85
VZ
741// ----------------------------------------------------------------------------
742
743// this event is also used by wxComboBox and wxSpinCtrl which don't include
744// wx/textctrl.h in all ports [yet], so declare it here as well
745//
746// still, any new code using it should include wx/textctrl.h explicitly
9b11752c 747wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TEXT_UPDATED, wxCommandEvent);
c801d85f 748
d48b06bd
FM
749
750// ----------------------------------------------------------------------------
751// wxEvent(-derived) classes
752// ----------------------------------------------------------------------------
753
1648d51b
VZ
754// the predefined constants for the number of times we propagate event
755// upwards window child-parent chain
d48b06bd 756enum wxEventPropagation
1648d51b
VZ
757{
758 // don't propagate it at all
759 wxEVENT_PROPAGATE_NONE = 0,
760
761 // propagate it until it is processed
762 wxEVENT_PROPAGATE_MAX = INT_MAX
763};
764
d48b06bd 765// The different categories for a wxEvent; see wxEvent::GetEventCategory.
dde19c21 766// NOTE: they are used as OR-combinable flags by wxEventLoopBase::YieldFor
d48b06bd
FM
767enum wxEventCategory
768{
769 // this is the category for those events which are generated to update
770 // the appearance of the GUI but which (usually) do not comport data
771 // processing, i.e. which do not provide input or output data
772 // (e.g. size events, scroll events, etc).
773 // They are events NOT directly generated by the user's input devices.
774 wxEVT_CATEGORY_UI = 1,
775
776 // this category groups those events which are generated directly from the
777 // user through input devices like mouse and keyboard and usually result in
778 // data to be processed from the application.
779 // (e.g. mouse clicks, key presses, etc)
780 wxEVT_CATEGORY_USER_INPUT = 2,
781
782 // this category is for wxSocketEvent
783 wxEVT_CATEGORY_SOCKET = 4,
784
785 // this category is for wxTimerEvent
786 wxEVT_CATEGORY_TIMER = 8,
787
788 // this category is for any event used to send notifications from the
789 // secondary threads to the main one or in general for notifications among
790 // different threads (which may or may not be user-generated)
791 wxEVT_CATEGORY_THREAD = 16,
792
793
794 // implementation only
795
dde19c21 796 // used in the implementations of wxEventLoopBase::YieldFor
d48b06bd
FM
797 wxEVT_CATEGORY_UNKNOWN = 32,
798
dde19c21 799 // a special category used as an argument to wxEventLoopBase::YieldFor to indicate that
d48b06bd
FM
800 // Yield() should leave all wxEvents on the queue while emptying the native event queue
801 // (native events will be processed but the wxEvents they generate will be queued)
802 wxEVT_CATEGORY_CLIPBOARD = 64,
803
804
805 // shortcut masks
806
807 // this category groups those events which are emitted in response to
808 // events of the native toolkit and which typically are not-"delayable".
809 wxEVT_CATEGORY_NATIVE_EVENTS = wxEVT_CATEGORY_UI|wxEVT_CATEGORY_USER_INPUT,
810
dde19c21 811 // used in wxEventLoopBase::YieldFor to specify all event categories should be processed:
d48b06bd
FM
812 wxEVT_CATEGORY_ALL =
813 wxEVT_CATEGORY_UI|wxEVT_CATEGORY_USER_INPUT|wxEVT_CATEGORY_SOCKET| \
814 wxEVT_CATEGORY_TIMER|wxEVT_CATEGORY_THREAD
815};
816
c801d85f 817/*
77ffb593 818 * wxWidgets events, covering all interesting things that might happen
c801d85f
KB
819 * (button clicking, resizing, setting text in widgets, etc.).
820 *
821 * For each completely new event type, derive a new event class.
822 * An event CLASS represents a C++ class defining a range of similar event TYPES;
823 * examples are canvas events, panel item command events.
824 * An event TYPE is a unique identifier for a particular system event,
825 * such as a button press or a listbox deselection.
826 *
827 */
828
bddd7a8d 829class WXDLLIMPEXP_BASE wxEvent : public wxObject
c801d85f 830{
c801d85f 831public:
d9e2e4c2 832 wxEvent(int winid = 0, wxEventType commandType = wxEVT_NULL );
2b854a32
VZ
833
834 void SetEventType(wxEventType typ) { m_eventType = typ; }
835 wxEventType GetEventType() const { return m_eventType; }
d48b06bd 836
2b854a32
VZ
837 wxObject *GetEventObject() const { return m_eventObject; }
838 void SetEventObject(wxObject *obj) { m_eventObject = obj; }
d48b06bd 839
2b854a32
VZ
840 long GetTimestamp() const { return m_timeStamp; }
841 void SetTimestamp(long ts = 0) { m_timeStamp = ts; }
d48b06bd 842
2b854a32
VZ
843 int GetId() const { return m_id; }
844 void SetId(int Id) { m_id = Id; }
845
846 // Can instruct event processor that we wish to ignore this event
847 // (treat as if the event table entry had not been found): this must be done
848 // to allow the event processing by the base classes (calling event.Skip()
a0d9c6cb
WS
849 // is the analog of calling the base class version of a virtual function)
850 void Skip(bool skip = true) { m_skipped = skip; }
47b378bd 851 bool GetSkipped() const { return m_skipped; }
c801d85f 852
29de6f40 853 // This function is used to create a copy of the event polymorphically and
acd15a3f
VZ
854 // all derived classes must implement it because otherwise wxPostEvent()
855 // for them wouldn't work (it needs to do a copy of the event)
856 virtual wxEvent *Clone() const = 0;
a737331d 857
dde19c21 858 // this function is used to selectively process events in wxEventLoopBase::YieldFor
d48b06bd
FM
859 // NOTE: by default it returns wxEVT_CATEGORY_UI just because the major
860 // part of wxWidgets events belong to that category.
861 virtual wxEventCategory GetEventCategory() const
862 { return wxEVT_CATEGORY_UI; }
863
87b6002d 864 // Implementation only: this test is explicitly anti OO and this function
1648d51b
VZ
865 // exists only for optimization purposes.
866 bool IsCommandEvent() const { return m_isCommandEvent; }
867
868 // Determine if this event should be propagating to the parent window.
869 bool ShouldPropagate() const
870 { return m_propagationLevel != wxEVENT_PROPAGATE_NONE; }
871
872 // Stop an event from propagating to its parent window, returns the old
873 // propagation level value
874 int StopPropagation()
875 {
876 int propagationLevel = m_propagationLevel;
877 m_propagationLevel = wxEVENT_PROPAGATE_NONE;
878 return propagationLevel;
879 }
880
881 // Resume the event propagation by restoring the propagation level
882 // (returned by StopPropagation())
883 void ResumePropagation(int propagationLevel)
884 {
885 m_propagationLevel = propagationLevel;
886 }
887
29de6f40
VZ
888
889 // This is for internal use only and is only called by
890 // wxEvtHandler::ProcessEvent() to check whether it's the first time this
891 // event is being processed
892 bool WasProcessed()
893 {
894 if ( m_wasProcessed )
895 return true;
896
897 m_wasProcessed = true;
898
899 return false;
900 }
901
b4b76d61 902protected:
2b854a32 903 wxObject* m_eventObject;
2b854a32
VZ
904 wxEventType m_eventType;
905 long m_timeStamp;
906 int m_id;
b4b76d61
KH
907
908public:
909 // m_callbackUserData is for internal usage only
2b854a32 910 wxObject* m_callbackUserData;
1648d51b
VZ
911
912protected:
913 // the propagation level: while it is positive, we propagate the event to
914 // the parent window (if any)
1648d51b
VZ
915 int m_propagationLevel;
916
42e69d6b 917 bool m_skipped;
193bf013 918 bool m_isCommandEvent;
1c624631 919
29de6f40
VZ
920 // initially false but becomes true as soon as WasProcessed() is called for
921 // the first time, as this is done only by ProcessEvent() it explains the
922 // variable name: it becomes true after ProcessEvent() was called at least
923 // once for this event
924 bool m_wasProcessed;
925
0e097789
VZ
926protected:
927 wxEvent(const wxEvent&); // for implementing Clone()
928 wxEvent& operator=(const wxEvent&); // for derived classes operator=()
929
8e72b8b5 930private:
1648d51b 931 // it needs to access our m_propagationLevel
b5dbe15d 932 friend class WXDLLIMPEXP_FWD_BASE wxPropagateOnce;
1648d51b 933
8e72b8b5 934 DECLARE_ABSTRACT_CLASS(wxEvent)
c801d85f
KB
935};
936
1648d51b
VZ
937/*
938 * Helper class to temporarily change an event not to propagate.
939 */
940class WXDLLIMPEXP_BASE wxPropagationDisabler
941{
942public:
943 wxPropagationDisabler(wxEvent& event) : m_event(event)
944 {
945 m_propagationLevelOld = m_event.StopPropagation();
946 }
947
948 ~wxPropagationDisabler()
949 {
950 m_event.ResumePropagation(m_propagationLevelOld);
951 }
952
953private:
954 wxEvent& m_event;
955 int m_propagationLevelOld;
fc7a2a60 956
c0c133e1 957 wxDECLARE_NO_COPY_CLASS(wxPropagationDisabler);
1648d51b
VZ
958};
959
960/*
961 * Another one to temporarily lower propagation level.
962 */
963class WXDLLIMPEXP_BASE wxPropagateOnce
964{
965public:
966 wxPropagateOnce(wxEvent& event) : m_event(event)
967 {
968 wxASSERT_MSG( m_event.m_propagationLevel > 0,
969 _T("shouldn't be used unless ShouldPropagate()!") );
970
971 m_event.m_propagationLevel--;
972 }
973
974 ~wxPropagateOnce()
975 {
976 m_event.m_propagationLevel++;
977 }
978
979private:
980 wxEvent& m_event;
fc7a2a60 981
c0c133e1 982 wxDECLARE_NO_COPY_CLASS(wxPropagateOnce);
1648d51b
VZ
983};
984
c4fa5aa7 985
e90c1d2a
VZ
986#if wxUSE_GUI
987
1648d51b 988
c801d85f
KB
989// Item or menu event class
990/*
991 wxEVT_COMMAND_BUTTON_CLICKED
992 wxEVT_COMMAND_CHECKBOX_CLICKED
993 wxEVT_COMMAND_CHOICE_SELECTED
994 wxEVT_COMMAND_LISTBOX_SELECTED
995 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
996 wxEVT_COMMAND_TEXT_UPDATED
997 wxEVT_COMMAND_TEXT_ENTER
998 wxEVT_COMMAND_MENU_SELECTED
999 wxEVT_COMMAND_SLIDER_UPDATED
1000 wxEVT_COMMAND_RADIOBOX_SELECTED
1001 wxEVT_COMMAND_RADIOBUTTON_SELECTED
1002 wxEVT_COMMAND_SCROLLBAR_UPDATED
1003 wxEVT_COMMAND_VLBOX_SELECTED
1004 wxEVT_COMMAND_COMBOBOX_SELECTED
1db8dc4a 1005 wxEVT_COMMAND_TOGGLEBUTTON_CLICKED
c801d85f
KB
1006*/
1007
bddd7a8d 1008class WXDLLIMPEXP_CORE wxCommandEvent : public wxEvent
c801d85f 1009{
2b854a32 1010public:
d9e2e4c2 1011 wxCommandEvent(wxEventType commandType = wxEVT_NULL, int winid = 0);
c801d85f 1012
e6a6feba 1013 wxCommandEvent(const wxCommandEvent& event)
497dbbd3 1014 : wxEvent(event),
c3f94162 1015 m_cmdString(event.m_cmdString),
497dbbd3
VZ
1016 m_commandInt(event.m_commandInt),
1017 m_extraLong(event.m_extraLong),
1018 m_clientData(event.m_clientData),
1019 m_clientObject(event.m_clientObject)
e6a6feba
GD
1020 { }
1021
2b854a32
VZ
1022 // Set/Get client data from controls
1023 void SetClientData(void* clientData) { m_clientData = clientData; }
1024 void *GetClientData() const { return m_clientData; }
c801d85f 1025
2b854a32
VZ
1026 // Set/Get client object from controls
1027 void SetClientObject(wxClientData* clientObject) { m_clientObject = clientObject; }
88eadcf2 1028 wxClientData *GetClientObject() const { return m_clientObject; }
f5e27805 1029
2b854a32
VZ
1030 // Get listbox selection if single-choice
1031 int GetSelection() const { return m_commandInt; }
c801d85f 1032
2b854a32 1033 // Set/Get listbox/choice selection string
b4b76d61
KH
1034 void SetString(const wxString& s) { m_cmdString = s; }
1035 wxString GetString() const;
c801d85f 1036
2b854a32 1037 // Get checkbox value
3ca6a5f0 1038 bool IsChecked() const { return m_commandInt != 0; }
c801d85f 1039
a0d9c6cb 1040 // true if the listbox event was a selection.
2b854a32 1041 bool IsSelection() const { return (m_extraLong != 0); }
c801d85f 1042
2b854a32 1043 void SetExtraLong(long extraLong) { m_extraLong = extraLong; }
a7bc03c9 1044 long GetExtraLong() const { return m_extraLong; }
c801d85f 1045
2b854a32 1046 void SetInt(int i) { m_commandInt = i; }
fd587c7a 1047 int GetInt() const { return m_commandInt; }
c801d85f 1048
8e72b8b5 1049 virtual wxEvent *Clone() const { return new wxCommandEvent(*this); }
d48b06bd 1050 virtual wxEventCategory GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT; }
aadbdf11 1051
b4b76d61 1052protected:
b4b76d61 1053 wxString m_cmdString; // String event argument
2b854a32
VZ
1054 int m_commandInt;
1055 long m_extraLong; // Additional information (e.g. select/deselect)
1056 void* m_clientData; // Arbitrary client data
1057 wxClientData* m_clientObject; // Arbitrary client object
f97500b8 1058
8e72b8b5 1059private:
fc7a2a60 1060 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCommandEvent)
c801d85f
KB
1061};
1062
fd3f686c
VZ
1063// this class adds a possibility to react (from the user) code to a control
1064// notification: allow or veto the operation being reported.
bddd7a8d 1065class WXDLLIMPEXP_CORE wxNotifyEvent : public wxCommandEvent
fd3f686c
VZ
1066{
1067public:
d9e2e4c2
DE
1068 wxNotifyEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
1069 : wxCommandEvent(commandType, winid)
a0d9c6cb 1070 { m_bAllow = true; }
e6a6feba
GD
1071
1072 wxNotifyEvent(const wxNotifyEvent& event)
1073 : wxCommandEvent(event)
497dbbd3 1074 { m_bAllow = event.m_bAllow; }
fd3f686c 1075
23f681ec 1076 // veto the operation (usually it's allowed by default)
a0d9c6cb 1077 void Veto() { m_bAllow = false; }
fd3f686c 1078
23f681ec 1079 // allow the operation if it was disabled by default
a0d9c6cb 1080 void Allow() { m_bAllow = true; }
23f681ec 1081
fd3f686c
VZ
1082 // for implementation code only: is the operation allowed?
1083 bool IsAllowed() const { return m_bAllow; }
1084
8e72b8b5 1085 virtual wxEvent *Clone() const { return new wxNotifyEvent(*this); }
924ef850 1086
fd3f686c
VZ
1087private:
1088 bool m_bAllow;
1089
8e72b8b5 1090private:
fc7a2a60 1091 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNotifyEvent)
fd3f686c
VZ
1092};
1093
d48b06bd
FM
1094
1095// Thread event
1096
1e247d69 1097class WXDLLIMPEXP_CORE wxThreadEvent : public wxCommandEvent
d48b06bd
FM
1098{
1099public:
74d60f66
FM
1100 wxThreadEvent(wxEventType eventType = wxEVT_COMMAND_THREAD, int id = wxID_ANY)
1101 : wxCommandEvent(eventType, id)
d48b06bd
FM
1102 { }
1103
1e8af825
FM
1104 wxThreadEvent(const wxThreadEvent& event)
1105 : wxCommandEvent(event)
1106 {
1107 // make sure our string member (which uses COW, aka refcounting) is not
1108 // shared by other wxString instances:
1109 SetString(GetString().c_str());
1110 }
1111
d48b06bd
FM
1112 virtual wxEvent *Clone() const
1113 {
74d60f66 1114 wxThreadEvent* ev = new wxThreadEvent(*this);
d48b06bd 1115
74d60f66
FM
1116 // make sure our string member (which uses COW, aka refcounting) is not
1117 // shared by other wxString instances:
1118 ev->SetString(GetString().c_str());
1119 return ev;
d48b06bd
FM
1120 }
1121
dde19c21 1122 // this is important to avoid that calling wxEventLoopBase::YieldFor thread events
d48b06bd
FM
1123 // gets processed when this is unwanted:
1124 virtual wxEventCategory GetEventCategory() const
1125 { return wxEVT_CATEGORY_THREAD; }
1126
1127private:
1128 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxThreadEvent)
1129};
1130
1131
1132
d1367c3d 1133// Scroll event class, derived form wxCommandEvent. wxScrollEvents are
e8b669d3 1134// sent by wxSlider and wxScrollBar.
c801d85f
KB
1135/*
1136 wxEVT_SCROLL_TOP
1137 wxEVT_SCROLL_BOTTOM
1138 wxEVT_SCROLL_LINEUP
1139 wxEVT_SCROLL_LINEDOWN
1140 wxEVT_SCROLL_PAGEUP
1141 wxEVT_SCROLL_PAGEDOWN
1142 wxEVT_SCROLL_THUMBTRACK
7d56fb8f 1143 wxEVT_SCROLL_THUMBRELEASE
cbc85508 1144 wxEVT_SCROLL_CHANGED
c801d85f
KB
1145*/
1146
bddd7a8d 1147class WXDLLIMPEXP_CORE wxScrollEvent : public wxCommandEvent
c801d85f 1148{
2b854a32
VZ
1149public:
1150 wxScrollEvent(wxEventType commandType = wxEVT_NULL,
d9e2e4c2 1151 int winid = 0, int pos = 0, int orient = 0);
2b854a32 1152
a7bc03c9
VZ
1153 int GetOrientation() const { return (int) m_extraLong; }
1154 int GetPosition() const { return m_commandInt; }
2b854a32
VZ
1155 void SetOrientation(int orient) { m_extraLong = (long) orient; }
1156 void SetPosition(int pos) { m_commandInt = pos; }
f97500b8 1157
8e72b8b5 1158 virtual wxEvent *Clone() const { return new wxScrollEvent(*this); }
f97500b8 1159
8e72b8b5 1160private:
fc7a2a60 1161 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollEvent)
c801d85f
KB
1162};
1163
d1367c3d
RR
1164// ScrollWin event class, derived fom wxEvent. wxScrollWinEvents
1165// are sent by wxWindow.
1166/*
1167 wxEVT_SCROLLWIN_TOP
1168 wxEVT_SCROLLWIN_BOTTOM
1169 wxEVT_SCROLLWIN_LINEUP
1170 wxEVT_SCROLLWIN_LINEDOWN
1171 wxEVT_SCROLLWIN_PAGEUP
1172 wxEVT_SCROLLWIN_PAGEDOWN
1173 wxEVT_SCROLLWIN_THUMBTRACK
7d56fb8f 1174 wxEVT_SCROLLWIN_THUMBRELEASE
d1367c3d
RR
1175*/
1176
bddd7a8d 1177class WXDLLIMPEXP_CORE wxScrollWinEvent : public wxEvent
d1367c3d 1178{
d1367c3d
RR
1179public:
1180 wxScrollWinEvent(wxEventType commandType = wxEVT_NULL,
1181 int pos = 0, int orient = 0);
f3ff831f 1182 wxScrollWinEvent(const wxScrollWinEvent& event) : wxEvent(event)
b2697d42
VZ
1183 { m_commandInt = event.m_commandInt;
1184 m_extraLong = event.m_extraLong; }
d1367c3d 1185
a7bc03c9
VZ
1186 int GetOrientation() const { return (int) m_extraLong; }
1187 int GetPosition() const { return m_commandInt; }
d1367c3d
RR
1188 void SetOrientation(int orient) { m_extraLong = (long) orient; }
1189 void SetPosition(int pos) { m_commandInt = pos; }
1190
8e72b8b5 1191 virtual wxEvent *Clone() const { return new wxScrollWinEvent(*this); }
1e6feb95 1192
b4b76d61 1193protected:
8e72b8b5 1194 int m_commandInt;
20947e08 1195 long m_extraLong;
1e6feb95 1196
8e72b8b5 1197private:
fc7a2a60 1198 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollWinEvent)
d1367c3d
RR
1199};
1200
d48b06bd
FM
1201
1202
c801d85f
KB
1203// Mouse event class
1204
1205/*
1206 wxEVT_LEFT_DOWN
1207 wxEVT_LEFT_UP
1208 wxEVT_MIDDLE_DOWN
1209 wxEVT_MIDDLE_UP
1210 wxEVT_RIGHT_DOWN
1211 wxEVT_RIGHT_UP
1212 wxEVT_MOTION
1213 wxEVT_ENTER_WINDOW
1214 wxEVT_LEAVE_WINDOW
1215 wxEVT_LEFT_DCLICK
1216 wxEVT_MIDDLE_DCLICK
1217 wxEVT_RIGHT_DCLICK
1218 wxEVT_NC_LEFT_DOWN
1219 wxEVT_NC_LEFT_UP,
1220 wxEVT_NC_MIDDLE_DOWN,
1221 wxEVT_NC_MIDDLE_UP,
1222 wxEVT_NC_RIGHT_DOWN,
1223 wxEVT_NC_RIGHT_UP,
1224 wxEVT_NC_MOTION,
1225 wxEVT_NC_ENTER_WINDOW,
1226 wxEVT_NC_LEAVE_WINDOW,
1227 wxEVT_NC_LEFT_DCLICK,
1228 wxEVT_NC_MIDDLE_DCLICK,
1229 wxEVT_NC_RIGHT_DCLICK,
1230*/
1231
497dbbd3
VZ
1232// the symbolic names for the mouse buttons
1233enum
1234{
1235 wxMOUSE_BTN_ANY = -1,
3e89999c
VZ
1236 wxMOUSE_BTN_NONE = 0,
1237 wxMOUSE_BTN_LEFT = 1,
1238 wxMOUSE_BTN_MIDDLE = 2,
01101e2d
VZ
1239 wxMOUSE_BTN_RIGHT = 3,
1240 wxMOUSE_BTN_AUX1 = 4,
1241 wxMOUSE_BTN_AUX2 = 5,
1242 wxMOUSE_BTN_MAX
497dbbd3
VZ
1243};
1244
0e097789
VZ
1245class WXDLLIMPEXP_CORE wxMouseEvent : public wxEvent,
1246 public wxMouseState
c801d85f 1247{
2b854a32
VZ
1248public:
1249 wxMouseEvent(wxEventType mouseType = wxEVT_NULL);
0e097789
VZ
1250 wxMouseEvent(const wxMouseEvent& event)
1251 : wxEvent(event),
1252 wxMouseState(event)
1253 {
1254 Assign(event);
1255 }
c801d85f 1256
2b854a32 1257 // Was it a button event? (*doesn't* mean: is any button *down*?)
497dbbd3 1258 bool IsButton() const { return Button(wxMOUSE_BTN_ANY); }
c801d85f 1259
3e89999c 1260 // Was it a down event from this (or any) button?
497dbbd3 1261 bool ButtonDown(int but = wxMOUSE_BTN_ANY) const;
c801d85f 1262
3e89999c 1263 // Was it a dclick event from this (or any) button?
497dbbd3 1264 bool ButtonDClick(int but = wxMOUSE_BTN_ANY) const;
c801d85f 1265
3e89999c 1266 // Was it a up event from this (or any) button?
497dbbd3 1267 bool ButtonUp(int but = wxMOUSE_BTN_ANY) const;
c801d85f 1268
3e89999c 1269 // Was the given button?
2b854a32 1270 bool Button(int but) const;
c801d85f 1271
3e89999c 1272 // Was the given button in Down state?
2b854a32 1273 bool ButtonIsDown(int but) const;
c801d85f 1274
497dbbd3 1275 // Get the button which is changing state (wxMOUSE_BTN_NONE if none)
1e6feb95
VZ
1276 int GetButton() const;
1277
2b854a32
VZ
1278 // Find which event was just generated
1279 bool LeftDown() const { return (m_eventType == wxEVT_LEFT_DOWN); }
1280 bool MiddleDown() const { return (m_eventType == wxEVT_MIDDLE_DOWN); }
1281 bool RightDown() const { return (m_eventType == wxEVT_RIGHT_DOWN); }
01101e2d
VZ
1282 bool Aux1Down() const { return (m_eventType == wxEVT_AUX1_DOWN); }
1283 bool Aux2Down() const { return (m_eventType == wxEVT_AUX2_DOWN); }
c801d85f 1284
2b854a32
VZ
1285 bool LeftUp() const { return (m_eventType == wxEVT_LEFT_UP); }
1286 bool MiddleUp() const { return (m_eventType == wxEVT_MIDDLE_UP); }
1287 bool RightUp() const { return (m_eventType == wxEVT_RIGHT_UP); }
01101e2d
VZ
1288 bool Aux1Up() const { return (m_eventType == wxEVT_AUX1_UP); }
1289 bool Aux2Up() const { return (m_eventType == wxEVT_AUX2_UP); }
c801d85f 1290
2b854a32
VZ
1291 bool LeftDClick() const { return (m_eventType == wxEVT_LEFT_DCLICK); }
1292 bool MiddleDClick() const { return (m_eventType == wxEVT_MIDDLE_DCLICK); }
1293 bool RightDClick() const { return (m_eventType == wxEVT_RIGHT_DCLICK); }
01101e2d
VZ
1294 bool Aux1DClick() const { return (m_eventType == wxEVT_AUX1_UP); }
1295 bool Aux2DClick() const { return (m_eventType == wxEVT_AUX2_UP); }
c801d85f 1296
2b854a32
VZ
1297 // Find the current state of the mouse buttons (regardless
1298 // of current event type)
1299 bool LeftIsDown() const { return m_leftDown; }
1300 bool MiddleIsDown() const { return m_middleDown; }
1301 bool RightIsDown() const { return m_rightDown; }
01101e2d
VZ
1302 bool Aux1IsDown() const { return m_aux1Down; }
1303 bool Aux2IsDown() const { return m_aux2Down; }
c801d85f 1304
2b854a32
VZ
1305 // True if a button is down and the mouse is moving
1306 bool Dragging() const
1307 {
5b66d31a 1308 return (m_eventType == wxEVT_MOTION) && ButtonIsDown(wxMOUSE_BTN_ANY);
2b854a32 1309 }
c801d85f 1310
2b854a32 1311 // True if the mouse is moving, and no button is down
6f63704f
VZ
1312 bool Moving() const
1313 {
5b66d31a 1314 return (m_eventType == wxEVT_MOTION) && !ButtonIsDown(wxMOUSE_BTN_ANY);
6f63704f 1315 }
c801d85f 1316
2b854a32
VZ
1317 // True if the mouse is just entering the window
1318 bool Entering() const { return (m_eventType == wxEVT_ENTER_WINDOW); }
c801d85f 1319
2b854a32
VZ
1320 // True if the mouse is just leaving the window
1321 bool Leaving() const { return (m_eventType == wxEVT_LEAVE_WINDOW); }
c801d85f 1322
8866abbb
VZ
1323 // Returns the number of mouse clicks associated with this event.
1324 int GetClickCount() const { return m_clickCount; }
1325
1326
2b854a32 1327 // Find the position of the event
20947e08 1328 void GetPosition(wxCoord *xpos, wxCoord *ypos) const
b02da6b1
VZ
1329 {
1330 if (xpos)
20947e08 1331 *xpos = m_x;
b02da6b1
VZ
1332 if (ypos)
1333 *ypos = m_y;
1334 }
1335
bf57d1ad 1336 void GetPosition(long *xpos, long *ypos) const
b02da6b1
VZ
1337 {
1338 if (xpos)
20947e08 1339 *xpos = (long)m_x;
b02da6b1 1340 if (ypos)
bf57d1ad 1341 *ypos = (long)m_y;
b02da6b1 1342 }
c801d85f 1343
2b854a32
VZ
1344 // Find the position of the event
1345 wxPoint GetPosition() const { return wxPoint(m_x, m_y); }
c801d85f 1346
2b854a32 1347 // Find the logical position of the event given the DC
a7bc03c9 1348 wxPoint GetLogicalPosition(const wxDC& dc) const;
c801d85f 1349
2b854a32 1350 // Get X position
6cedba09 1351 wxCoord GetX() const { return m_x; }
c801d85f 1352
2b854a32 1353 // Get Y position
6cedba09 1354 wxCoord GetY() const { return m_y; }
c801d85f 1355
d2c52078
RD
1356 // Get wheel rotation, positive or negative indicates direction of
1357 // rotation. Current devices all send an event when rotation is equal to
1358 // +/-WheelDelta, but this allows for finer resolution devices to be
1359 // created in the future. Because of this you shouldn't assume that one
1360 // event is equal to 1 line or whatever, but you should be able to either
1361 // do partial line scrolling or wait until +/-WheelDelta rotation values
1362 // have been accumulated before scrolling.
1363 int GetWheelRotation() const { return m_wheelRotation; }
1364
1365 // Get wheel delta, normally 120. This is the threshold for action to be
1366 // taken, and one such action (for example, scrolling one increment)
1367 // should occur for each delta.
1368 int GetWheelDelta() const { return m_wheelDelta; }
1369
aea37008
SC
1370 // Gets the axis the wheel operation concerns, 0 being the y axis as on
1371 // most mouse wheels, 1 is the x axis for things like MightyMouse scrolls
1372 // or horizontal trackpad scrolling
1373 int GetWheelAxis() const { return m_wheelAxis; }
1374
d2c52078
RD
1375 // Returns the configured number of lines (or whatever) to be scrolled per
1376 // wheel action. Defaults to one.
1377 int GetLinesPerAction() const { return m_linesPerAction; }
aa767a45 1378
9b9337da 1379 // Is the system set to do page scrolling?
c2bbeff0 1380 bool IsPageScroll() const { return ((unsigned int)m_linesPerAction == UINT_MAX); }
9b9337da 1381
8e72b8b5 1382 virtual wxEvent *Clone() const { return new wxMouseEvent(*this); }
d48b06bd 1383 virtual wxEventCategory GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT; }
aadbdf11 1384
0e097789
VZ
1385 wxMouseEvent& operator=(const wxMouseEvent& event)
1386 {
1387 if (&event != this)
1388 Assign(event);
1389 return *this;
1390 }
c7d176e2 1391
c801d85f 1392public:
b02da6b1
VZ
1393 wxCoord m_x, m_y;
1394
2b854a32
VZ
1395 bool m_leftDown;
1396 bool m_middleDown;
1397 bool m_rightDown;
01101e2d
VZ
1398 bool m_aux1Down;
1399 bool m_aux2Down;
2b854a32 1400
8866abbb
VZ
1401 int m_clickCount;
1402
aea37008 1403 int m_wheelAxis;
d2c52078
RD
1404 int m_wheelRotation;
1405 int m_wheelDelta;
1406 int m_linesPerAction;
1e6feb95 1407
abcbaea7
VZ
1408protected:
1409 void Assign(const wxMouseEvent& evt);
1410
1e6feb95
VZ
1411private:
1412 DECLARE_DYNAMIC_CLASS(wxMouseEvent)
c801d85f
KB
1413};
1414
43b5058d
VZ
1415// Cursor set event
1416
1417/*
1418 wxEVT_SET_CURSOR
1419 */
1420
bddd7a8d 1421class WXDLLIMPEXP_CORE wxSetCursorEvent : public wxEvent
43b5058d
VZ
1422{
1423public:
8e72b8b5 1424 wxSetCursorEvent(wxCoord x = 0, wxCoord y = 0)
497dbbd3
VZ
1425 : wxEvent(0, wxEVT_SET_CURSOR),
1426 m_x(x), m_y(y), m_cursor()
e6a6feba 1427 { }
43b5058d 1428
f3ff831f 1429 wxSetCursorEvent(const wxSetCursorEvent& event)
b2697d42
VZ
1430 : wxEvent(event),
1431 m_x(event.m_x),
1432 m_y(event.m_y),
1433 m_cursor(event.m_cursor)
1434 { }
1d2eddff 1435
43b5058d
VZ
1436 wxCoord GetX() const { return m_x; }
1437 wxCoord GetY() const { return m_y; }
1438
1439 void SetCursor(const wxCursor& cursor) { m_cursor = cursor; }
1440 const wxCursor& GetCursor() const { return m_cursor; }
1441 bool HasCursor() const { return m_cursor.Ok(); }
1442
8e72b8b5 1443 virtual wxEvent *Clone() const { return new wxSetCursorEvent(*this); }
f97500b8 1444
43b5058d
VZ
1445private:
1446 wxCoord m_x, m_y;
1447 wxCursor m_cursor;
f97500b8 1448
8e72b8b5 1449private:
fc7a2a60 1450 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSetCursorEvent)
43b5058d
VZ
1451};
1452
c801d85f
KB
1453// Keyboard input event class
1454
1455/*
1456 wxEVT_CHAR
1457 wxEVT_CHAR_HOOK
4ce81a75 1458 wxEVT_KEY_DOWN
c801d85f 1459 wxEVT_KEY_UP
5048c832 1460 wxEVT_HOTKEY
c801d85f
KB
1461 */
1462
0e097789
VZ
1463class WXDLLIMPEXP_CORE wxKeyEvent : public wxEvent,
1464 public wxKeyboardState
c801d85f 1465{
c801d85f 1466public:
2b854a32 1467 wxKeyEvent(wxEventType keyType = wxEVT_NULL);
b2697d42 1468 wxKeyEvent(const wxKeyEvent& evt);
c801d85f 1469
f6bcfd97
BP
1470 // get the key code: an ASCII7 char or an element of wxKeyCode enum
1471 int GetKeyCode() const { return (int)m_keyCode; }
c801d85f 1472
a3db5254
VZ
1473#if wxUSE_UNICODE
1474 // get the Unicode character corresponding to this key
1475 wxChar GetUnicodeKey() const { return m_uniChar; }
1476#endif // wxUSE_UNICODE
1477
9c7df356
VZ
1478 // get the raw key code (platform-dependent)
1479 wxUint32 GetRawKeyCode() const { return m_rawCode; }
1480
1481 // get the raw key flags (platform-dependent)
1482 wxUint32 GetRawKeyFlags() const { return m_rawFlags; }
1483
2b854a32 1484 // Find the position of the event
b02da6b1
VZ
1485 void GetPosition(wxCoord *xpos, wxCoord *ypos) const
1486 {
20947e08 1487 if (xpos) *xpos = m_x;
b02da6b1
VZ
1488 if (ypos) *ypos = m_y;
1489 }
1490
bf57d1ad 1491 void GetPosition(long *xpos, long *ypos) const
b02da6b1 1492 {
20947e08 1493 if (xpos) *xpos = (long)m_x;
bf57d1ad 1494 if (ypos) *ypos = (long)m_y;
b02da6b1 1495 }
803ef874
JS
1496
1497 wxPoint GetPosition() const
1498 { return wxPoint(m_x, m_y); }
c801d85f 1499
2b854a32 1500 // Get X position
b02da6b1 1501 wxCoord GetX() const { return m_x; }
c801d85f 1502
2b854a32 1503 // Get Y position
b02da6b1 1504 wxCoord GetY() const { return m_y; }
c801d85f 1505
8e72b8b5 1506 virtual wxEvent *Clone() const { return new wxKeyEvent(*this); }
d48b06bd 1507 virtual wxEventCategory GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT; }
f97500b8
VZ
1508
1509 // we do need to copy wxKeyEvent sometimes (in wxTreeCtrl code, for
1510 // example)
1511 wxKeyEvent& operator=(const wxKeyEvent& evt)
1512 {
3232da9d 1513 if ( &evt != this )
162e998c 1514 {
0e097789 1515 wxEvent::operator=(evt);
3232da9d
VZ
1516
1517 // Borland C++ 5.82 doesn't compile an explicit call to an
1518 // implicitly defined operator=() so need to do it this way:
1519 *static_cast<wxKeyboardState *>(this) = evt;
0e097789 1520
162e998c
PC
1521 m_x = evt.m_x;
1522 m_y = evt.m_y;
1523
1524 m_keyCode = evt.m_keyCode;
1525
162e998c
PC
1526 m_rawCode = evt.m_rawCode;
1527 m_rawFlags = evt.m_rawFlags;
cedea72f 1528#if wxUSE_UNICODE
162e998c 1529 m_uniChar = evt.m_uniChar;
cedea72f 1530#endif
162e998c 1531 }
f97500b8
VZ
1532 return *this;
1533 }
1534
2b854a32 1535public:
b02da6b1
VZ
1536 wxCoord m_x, m_y;
1537
2b854a32 1538 long m_keyCode;
b02da6b1 1539
2b5f62a0
VZ
1540#if wxUSE_UNICODE
1541 // This contains the full Unicode character
1542 // in a character events in Unicode mode
1543 wxChar m_uniChar;
1544#endif
1545
1546 // these fields contain the platform-specific information about
1547 // key that was pressed
9c7df356
VZ
1548 wxUint32 m_rawCode;
1549 wxUint32 m_rawFlags;
1550
8e72b8b5
RR
1551private:
1552 DECLARE_DYNAMIC_CLASS(wxKeyEvent)
c801d85f
KB
1553};
1554
1555// Size event class
1556/*
1557 wxEVT_SIZE
1558 */
1559
bddd7a8d 1560class WXDLLIMPEXP_CORE wxSizeEvent : public wxEvent
c801d85f 1561{
2b854a32 1562public:
497dbbd3 1563 wxSizeEvent() : wxEvent(0, wxEVT_SIZE)
e6a6feba 1564 { }
d9e2e4c2
DE
1565 wxSizeEvent(const wxSize& sz, int winid = 0)
1566 : wxEvent(winid, wxEVT_SIZE),
497dbbd3 1567 m_size(sz)
e6a6feba 1568 { }
f3ff831f 1569 wxSizeEvent(const wxSizeEvent& event)
b2697d42 1570 : wxEvent(event),
5706de1c 1571 m_size(event.m_size), m_rect(event.m_rect)
b2697d42 1572 { }
5706de1c 1573 wxSizeEvent(const wxRect& rect, int id = 0)
e00865fa 1574 : m_size(rect.GetSize()), m_rect(rect)
5706de1c 1575 { m_eventType = wxEVT_SIZING; m_id = id; }
c2bbeff0 1576
2b854a32 1577 wxSize GetSize() const { return m_size; }
5706de1c 1578 wxRect GetRect() const { return m_rect; }
fbfb8bcc 1579 void SetRect(const wxRect& rect) { m_rect = rect; }
aadbdf11 1580
8e72b8b5
RR
1581 virtual wxEvent *Clone() const { return new wxSizeEvent(*this); }
1582
1583public:
b4b76d61 1584 // For internal usage only. Will be converted to protected members.
8e72b8b5 1585 wxSize m_size;
5706de1c 1586 wxRect m_rect; // Used for wxEVT_SIZING
8e72b8b5 1587
f97500b8 1588private:
fc7a2a60 1589 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSizeEvent)
c801d85f
KB
1590};
1591
1592// Move event class
1593
1594/*
1595 wxEVT_MOVE
1596 */
1597
bddd7a8d 1598class WXDLLIMPEXP_CORE wxMoveEvent : public wxEvent
c801d85f 1599{
2b854a32 1600public:
e6a6feba
GD
1601 wxMoveEvent()
1602 : wxEvent(0, wxEVT_MOVE)
e6a6feba 1603 { }
d9e2e4c2
DE
1604 wxMoveEvent(const wxPoint& pos, int winid = 0)
1605 : wxEvent(winid, wxEVT_MOVE),
497dbbd3 1606 m_pos(pos)
e6a6feba 1607 { }
1d2eddff
JS
1608 wxMoveEvent(const wxMoveEvent& event)
1609 : wxEvent(event),
b2697d42
VZ
1610 m_pos(event.m_pos)
1611 { }
5706de1c
JS
1612 wxMoveEvent(const wxRect& rect, int id = 0)
1613 : m_pos(rect.GetPosition()), m_rect(rect)
1614 { m_eventType = wxEVT_MOVING; m_id = id; }
c2bbeff0 1615
2b854a32 1616 wxPoint GetPosition() const { return m_pos; }
d7f03cae 1617 void SetPosition(const wxPoint& pos) { m_pos = pos; }
5706de1c 1618 wxRect GetRect() const { return m_rect; }
fbfb8bcc 1619 void SetRect(const wxRect& rect) { m_rect = rect; }
aadbdf11 1620
8e72b8b5 1621 virtual wxEvent *Clone() const { return new wxMoveEvent(*this); }
f97500b8 1622
b4b76d61 1623protected:
8e72b8b5 1624 wxPoint m_pos;
5706de1c 1625 wxRect m_rect;
f97500b8 1626
8e72b8b5 1627private:
fc7a2a60 1628 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMoveEvent)
c801d85f
KB
1629};
1630
1631// Paint event class
1632/*
1633 wxEVT_PAINT
1634 wxEVT_NC_PAINT
1635 wxEVT_PAINT_ICON
1636 */
1637
b078fa02
JS
1638#if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1639 // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined
bddd7a8d 1640 extern WXDLLIMPEXP_CORE int g_isPainting;
edccf428
VZ
1641#endif // debug
1642
bddd7a8d 1643class WXDLLIMPEXP_CORE wxPaintEvent : public wxEvent
c801d85f 1644{
2b854a32 1645public:
edccf428 1646 wxPaintEvent(int Id = 0)
e6a6feba 1647 : wxEvent(Id, wxEVT_PAINT)
edccf428 1648 {
b078fa02 1649#if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
edccf428
VZ
1650 // set the internal flag for the duration of processing of WM_PAINT
1651 g_isPainting++;
1652#endif // debug
1653 }
1654
4e689ecd
VZ
1655 // default copy ctor and dtor are normally fine, we only need them to keep
1656 // g_isPainting updated in debug build
b078fa02 1657#if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
4e689ecd
VZ
1658 wxPaintEvent(const wxPaintEvent& event)
1659 : wxEvent(event)
1660 {
1661 g_isPainting++;
1662 }
1663
d3c7fc99 1664 virtual ~wxPaintEvent()
edccf428
VZ
1665 {
1666 g_isPainting--;
1667 }
1668#endif // debug
8e72b8b5
RR
1669
1670 virtual wxEvent *Clone() const { return new wxPaintEvent(*this); }
f97500b8 1671
8e72b8b5 1672private:
fc7a2a60 1673 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaintEvent)
c801d85f
KB
1674};
1675
bddd7a8d 1676class WXDLLIMPEXP_CORE wxNcPaintEvent : public wxEvent
1e6feb95
VZ
1677{
1678public:
d9e2e4c2
DE
1679 wxNcPaintEvent(int winid = 0)
1680 : wxEvent(winid, wxEVT_NC_PAINT)
e6a6feba 1681 { }
f97500b8 1682
8e72b8b5 1683 virtual wxEvent *Clone() const { return new wxNcPaintEvent(*this); }
1e6feb95
VZ
1684
1685private:
fc7a2a60 1686 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNcPaintEvent)
1e6feb95
VZ
1687};
1688
c801d85f
KB
1689// Erase background event class
1690/*
1691 wxEVT_ERASE_BACKGROUND
1692 */
1693
bddd7a8d 1694class WXDLLIMPEXP_CORE wxEraseEvent : public wxEvent
c801d85f 1695{
2b854a32 1696public:
03f3617b 1697 wxEraseEvent(int Id = 0, wxDC *dc = NULL)
497dbbd3
VZ
1698 : wxEvent(Id, wxEVT_ERASE_BACKGROUND),
1699 m_dc(dc)
e6a6feba
GD
1700 { }
1701
1702 wxEraseEvent(const wxEraseEvent& event)
497dbbd3
VZ
1703 : wxEvent(event),
1704 m_dc(event.m_dc)
e6a6feba 1705 { }
f97500b8 1706
2b854a32 1707 wxDC *GetDC() const { return m_dc; }
aadbdf11 1708
8e72b8b5 1709 virtual wxEvent *Clone() const { return new wxEraseEvent(*this); }
f97500b8 1710
b4b76d61 1711protected:
8e72b8b5
RR
1712 wxDC *m_dc;
1713
1714private:
fc7a2a60 1715 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxEraseEvent)
c801d85f
KB
1716};
1717
1718// Focus event class
1719/*
1720 wxEVT_SET_FOCUS
1721 wxEVT_KILL_FOCUS
1722 */
1723
bddd7a8d 1724class WXDLLIMPEXP_CORE wxFocusEvent : public wxEvent
c801d85f 1725{
2b854a32 1726public:
d9e2e4c2
DE
1727 wxFocusEvent(wxEventType type = wxEVT_NULL, int winid = 0)
1728 : wxEvent(winid, type)
497dbbd3 1729 { m_win = NULL; }
e6a6feba
GD
1730
1731 wxFocusEvent(const wxFocusEvent& event)
1732 : wxEvent(event)
497dbbd3 1733 { m_win = event.m_win; }
1e6feb95 1734
8e72b8b5 1735 // The window associated with this event is the window which had focus
1e6feb95 1736 // before for SET event and the window which will have focus for the KILL
8e72b8b5 1737 // one. NB: it may be NULL in both cases!
1e6feb95
VZ
1738 wxWindow *GetWindow() const { return m_win; }
1739 void SetWindow(wxWindow *win) { m_win = win; }
1740
8e72b8b5 1741 virtual wxEvent *Clone() const { return new wxFocusEvent(*this); }
f97500b8 1742
1e6feb95
VZ
1743private:
1744 wxWindow *m_win;
1745
8e72b8b5 1746private:
fc7a2a60 1747 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFocusEvent)
c801d85f
KB
1748};
1749
456bc6d9 1750// wxChildFocusEvent notifies the parent that a child has got the focus: unlike
1648d51b 1751// wxFocusEvent it is propagated upwards the window chain
bddd7a8d 1752class WXDLLIMPEXP_CORE wxChildFocusEvent : public wxCommandEvent
456bc6d9
VZ
1753{
1754public:
1755 wxChildFocusEvent(wxWindow *win = NULL);
1756
1757 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1758
8e72b8b5 1759 virtual wxEvent *Clone() const { return new wxChildFocusEvent(*this); }
f97500b8 1760
8e72b8b5 1761private:
fc7a2a60 1762 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxChildFocusEvent)
456bc6d9
VZ
1763};
1764
c801d85f
KB
1765// Activate event class
1766/*
1767 wxEVT_ACTIVATE
1768 wxEVT_ACTIVATE_APP
afafd942 1769 wxEVT_HIBERNATE
c801d85f
KB
1770 */
1771
bddd7a8d 1772class WXDLLIMPEXP_CORE wxActivateEvent : public wxEvent
c801d85f 1773{
2b854a32 1774public:
a0d9c6cb 1775 wxActivateEvent(wxEventType type = wxEVT_NULL, bool active = true, int Id = 0)
e6a6feba 1776 : wxEvent(Id, type)
497dbbd3 1777 { m_active = active; }
1d2eddff
JS
1778 wxActivateEvent(const wxActivateEvent& event)
1779 : wxEvent(event)
b2697d42 1780 { m_active = event.m_active; }
c2bbeff0 1781
2b854a32 1782 bool GetActive() const { return m_active; }
c801d85f 1783
8e72b8b5 1784 virtual wxEvent *Clone() const { return new wxActivateEvent(*this); }
aadbdf11 1785
2b854a32
VZ
1786private:
1787 bool m_active;
8e72b8b5
RR
1788
1789private:
fc7a2a60 1790 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxActivateEvent)
c801d85f
KB
1791};
1792
1793// InitDialog event class
1794/*
1795 wxEVT_INIT_DIALOG
1796 */
1797
bddd7a8d 1798class WXDLLIMPEXP_CORE wxInitDialogEvent : public wxEvent
c801d85f 1799{
2b854a32
VZ
1800public:
1801 wxInitDialogEvent(int Id = 0)
e6a6feba
GD
1802 : wxEvent(Id, wxEVT_INIT_DIALOG)
1803 { }
8e72b8b5
RR
1804
1805 virtual wxEvent *Clone() const { return new wxInitDialogEvent(*this); }
f97500b8
VZ
1806
1807private:
fc7a2a60 1808 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxInitDialogEvent)
c801d85f
KB
1809};
1810
1811// Miscellaneous menu event class
1812/*
ccef86c7
VZ
1813 wxEVT_MENU_OPEN,
1814 wxEVT_MENU_CLOSE,
c801d85f 1815 wxEVT_MENU_HIGHLIGHT,
c801d85f
KB
1816*/
1817
bddd7a8d 1818class WXDLLIMPEXP_CORE wxMenuEvent : public wxEvent
c801d85f 1819{
c801d85f 1820public:
92f1a59c 1821 wxMenuEvent(wxEventType type = wxEVT_NULL, int winid = 0, wxMenu* menu = NULL)
d9e2e4c2 1822 : wxEvent(winid, type)
fc7a2a60 1823 { m_menuId = winid; m_menu = menu; }
f3ff831f 1824 wxMenuEvent(const wxMenuEvent& event)
1d2eddff 1825 : wxEvent(event)
92f1a59c 1826 { m_menuId = event.m_menuId; m_menu = event.m_menu; }
c2bbeff0 1827
ccef86c7 1828 // only for wxEVT_MENU_HIGHLIGHT
aadbdf11 1829 int GetMenuId() const { return m_menuId; }
c801d85f 1830
ccef86c7 1831 // only for wxEVT_MENU_OPEN/CLOSE
1a18887b 1832 bool IsPopup() const { return m_menuId == wxID_ANY; }
ccef86c7 1833
92f1a59c
JS
1834 // only for wxEVT_MENU_OPEN/CLOSE
1835 wxMenu* GetMenu() const { return m_menu; }
1836
8e72b8b5 1837 virtual wxEvent *Clone() const { return new wxMenuEvent(*this); }
f97500b8 1838
2b854a32 1839private:
92f1a59c
JS
1840 int m_menuId;
1841 wxMenu* m_menu;
f97500b8 1842
fc7a2a60 1843 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMenuEvent)
c801d85f
KB
1844};
1845
1846// Window close or session close event class
1847/*
1848 wxEVT_CLOSE_WINDOW,
1849 wxEVT_END_SESSION,
1850 wxEVT_QUERY_END_SESSION
1851 */
1852
bddd7a8d 1853class WXDLLIMPEXP_CORE wxCloseEvent : public wxEvent
c801d85f 1854{
c801d85f 1855public:
d9e2e4c2
DE
1856 wxCloseEvent(wxEventType type = wxEVT_NULL, int winid = 0)
1857 : wxEvent(winid, type),
a0d9c6cb
WS
1858 m_loggingOff(true),
1859 m_veto(false), // should be false by default
1860 m_canVeto(true) {}
a3bf7524 1861
f3ff831f 1862 wxCloseEvent(const wxCloseEvent& event)
1d2eddff 1863 : wxEvent(event),
b2697d42
VZ
1864 m_loggingOff(event.m_loggingOff),
1865 m_veto(event.m_veto),
a3bf7524 1866 m_canVeto(event.m_canVeto) {}
c2bbeff0 1867
2b854a32 1868 void SetLoggingOff(bool logOff) { m_loggingOff = logOff; }
4bcfcdef
VZ
1869 bool GetLoggingOff() const
1870 {
1871 // m_loggingOff flag is only used by wxEVT_[QUERY_]END_SESSION, it
1872 // doesn't make sense for wxEVT_CLOSE_WINDOW
1873 wxASSERT_MSG( m_eventType != wxEVT_CLOSE_WINDOW,
1874 _T("this flag is for end session events only") );
1875
1876 return m_loggingOff;
1877 }
2b854a32 1878
a0d9c6cb 1879 void Veto(bool veto = true)
fe4e9e6c 1880 {
a0d9c6cb 1881 // GetVeto() will return false anyhow...
fe4e9e6c 1882 wxCHECK_RET( m_canVeto,
223d09f6 1883 wxT("call to Veto() ignored (can't veto this event)") );
fe4e9e6c
VZ
1884
1885 m_veto = veto;
1886 }
2b854a32
VZ
1887 void SetCanVeto(bool canVeto) { m_canVeto = canVeto; }
1888 bool CanVeto() const { return m_canVeto; }
fe4e9e6c 1889 bool GetVeto() const { return m_canVeto && m_veto; }
c801d85f 1890
8e72b8b5 1891 virtual wxEvent *Clone() const { return new wxCloseEvent(*this); }
aadbdf11 1892
2b854a32 1893protected:
4bcfcdef
VZ
1894 bool m_loggingOff,
1895 m_veto,
1896 m_canVeto;
2b854a32 1897
8e72b8b5 1898private:
fc7a2a60 1899 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCloseEvent)
c801d85f
KB
1900};
1901
1902/*
1903 wxEVT_SHOW
1904 */
1905
bddd7a8d 1906class WXDLLIMPEXP_CORE wxShowEvent : public wxEvent
c801d85f 1907{
c801d85f 1908public:
a0d9c6cb 1909 wxShowEvent(int winid = 0, bool show = false)
d9e2e4c2 1910 : wxEvent(winid, wxEVT_SHOW)
497dbbd3 1911 { m_show = show; }
f3ff831f 1912 wxShowEvent(const wxShowEvent& event)
1d2eddff 1913 : wxEvent(event)
b2697d42 1914 { m_show = event.m_show; }
c2bbeff0 1915
2b854a32 1916 void SetShow(bool show) { m_show = show; }
d317fdeb
VZ
1917
1918 // return true if the window was shown, false if hidden
1919 bool IsShown() const { return m_show; }
1920
831b64f3 1921#if WXWIN_COMPATIBILITY_2_8
d317fdeb
VZ
1922 wxDEPRECATED( bool GetShow() const { return IsShown(); } )
1923#endif
c801d85f 1924
8e72b8b5 1925 virtual wxEvent *Clone() const { return new wxShowEvent(*this); }
aadbdf11 1926
c801d85f 1927protected:
2b854a32 1928 bool m_show;
3dd9b88a 1929
8e72b8b5 1930private:
fc7a2a60 1931 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxShowEvent)
c801d85f
KB
1932};
1933
1934/*
1935 wxEVT_ICONIZE
1936 */
1937
bddd7a8d 1938class WXDLLIMPEXP_CORE wxIconizeEvent : public wxEvent
c801d85f 1939{
2b854a32 1940public:
a0d9c6cb 1941 wxIconizeEvent(int winid = 0, bool iconized = true)
d9e2e4c2 1942 : wxEvent(winid, wxEVT_ICONIZE)
497dbbd3 1943 { m_iconized = iconized; }
f3ff831f 1944 wxIconizeEvent(const wxIconizeEvent& event)
1d2eddff 1945 : wxEvent(event)
b2697d42 1946 { m_iconized = event.m_iconized; }
c2bbeff0 1947
831b64f3 1948#if WXWIN_COMPATIBILITY_2_8
d317fdeb
VZ
1949 wxDEPRECATED( bool Iconized() const { return IsIconized(); } )
1950#endif
3dd9b88a 1951 // return true if the frame was iconized, false if restored
d317fdeb 1952 bool IsIconized() const { return m_iconized; }
3dd9b88a 1953
8e72b8b5 1954 virtual wxEvent *Clone() const { return new wxIconizeEvent(*this); }
f97500b8 1955
3dd9b88a
VZ
1956protected:
1957 bool m_iconized;
1958
8e72b8b5 1959private:
fc7a2a60 1960 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIconizeEvent)
c801d85f 1961};
c801d85f
KB
1962/*
1963 wxEVT_MAXIMIZE
1964 */
1965
bddd7a8d 1966class WXDLLIMPEXP_CORE wxMaximizeEvent : public wxEvent
c801d85f 1967{
2b854a32 1968public:
d9e2e4c2
DE
1969 wxMaximizeEvent(int winid = 0)
1970 : wxEvent(winid, wxEVT_MAXIMIZE)
e6a6feba 1971 { }
3dd9b88a 1972
8e72b8b5 1973 virtual wxEvent *Clone() const { return new wxMaximizeEvent(*this); }
f97500b8 1974
8e72b8b5 1975private:
fc7a2a60 1976 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMaximizeEvent)
c801d85f
KB
1977};
1978
1979// Joystick event class
1980/*
1981 wxEVT_JOY_BUTTON_DOWN,
1982 wxEVT_JOY_BUTTON_UP,
1983 wxEVT_JOY_MOVE,
1984 wxEVT_JOY_ZMOVE
1985*/
1986
1987// Which joystick? Same as Windows ids so no conversion necessary.
497dbbd3
VZ
1988enum
1989{
1990 wxJOYSTICK1,
1991 wxJOYSTICK2
1992};
c801d85f
KB
1993
1994// Which button is down?
497dbbd3
VZ
1995enum
1996{
1997 wxJOY_BUTTON_ANY = -1,
1998 wxJOY_BUTTON1 = 1,
1999 wxJOY_BUTTON2 = 2,
2000 wxJOY_BUTTON3 = 4,
2001 wxJOY_BUTTON4 = 8
2002};
c801d85f 2003
bddd7a8d 2004class WXDLLIMPEXP_CORE wxJoystickEvent : public wxEvent
c801d85f 2005{
b4b76d61 2006protected:
2b854a32
VZ
2007 wxPoint m_pos;
2008 int m_zPosition;
497dbbd3
VZ
2009 int m_buttonChange; // Which button changed?
2010 int m_buttonState; // Which buttons are down?
2011 int m_joyStick; // Which joystick?
2b854a32 2012
b4b76d61 2013public:
2b854a32
VZ
2014 wxJoystickEvent(wxEventType type = wxEVT_NULL,
2015 int state = 0,
2016 int joystick = wxJOYSTICK1,
2017 int change = 0)
497dbbd3 2018 : wxEvent(0, type),
8b5d5223 2019 m_pos(),
497dbbd3
VZ
2020 m_zPosition(0),
2021 m_buttonChange(change),
2022 m_buttonState(state),
2023 m_joyStick(joystick)
2b854a32 2024 {
2b854a32 2025 }
f3ff831f 2026 wxJoystickEvent(const wxJoystickEvent& event)
b2697d42
VZ
2027 : wxEvent(event),
2028 m_pos(event.m_pos),
2029 m_zPosition(event.m_zPosition),
2030 m_buttonChange(event.m_buttonChange),
2031 m_buttonState(event.m_buttonState),
2032 m_joyStick(event.m_joyStick)
1d2eddff 2033 { }
c2bbeff0 2034
2b854a32
VZ
2035 wxPoint GetPosition() const { return m_pos; }
2036 int GetZPosition() const { return m_zPosition; }
2037 int GetButtonState() const { return m_buttonState; }
2038 int GetButtonChange() const { return m_buttonChange; }
2039 int GetJoystick() const { return m_joyStick; }
2040
2041 void SetJoystick(int stick) { m_joyStick = stick; }
2042 void SetButtonState(int state) { m_buttonState = state; }
2043 void SetButtonChange(int change) { m_buttonChange = change; }
2044 void SetPosition(const wxPoint& pos) { m_pos = pos; }
2045 void SetZPosition(int zPos) { m_zPosition = zPos; }
2046
2047 // Was it a button event? (*doesn't* mean: is any button *down*?)
2048 bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) ||
b70ababc 2049 (GetEventType() == wxEVT_JOY_BUTTON_UP)); }
2b854a32
VZ
2050
2051 // Was it a move event?
a7bc03c9 2052 bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE); }
2b854a32
VZ
2053
2054 // Was it a zmove event?
a7bc03c9 2055 bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE); }
2b854a32
VZ
2056
2057 // Was it a down event from button 1, 2, 3, 4 or any?
2058 bool ButtonDown(int but = wxJOY_BUTTON_ANY) const
c801d85f 2059 { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) &&
2b854a32 2060 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
c801d85f 2061
2b854a32
VZ
2062 // Was it a up event from button 1, 2, 3 or any?
2063 bool ButtonUp(int but = wxJOY_BUTTON_ANY) const
c801d85f 2064 { return ((GetEventType() == wxEVT_JOY_BUTTON_UP) &&
2b854a32 2065 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
c801d85f 2066
2b854a32
VZ
2067 // Was the given button 1,2,3,4 or any in Down state?
2068 bool ButtonIsDown(int but = wxJOY_BUTTON_ANY) const
c801d85f 2069 { return (((but == wxJOY_BUTTON_ANY) && (m_buttonState != 0)) ||
2b854a32 2070 ((m_buttonState & but) == but)); }
f305c661 2071
8e72b8b5 2072 virtual wxEvent *Clone() const { return new wxJoystickEvent(*this); }
f97500b8 2073
8e72b8b5 2074private:
fc7a2a60 2075 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxJoystickEvent)
c801d85f
KB
2076};
2077
2078// Drop files event class
2079/*
2080 wxEVT_DROP_FILES
2081 */
2082
bddd7a8d 2083class WXDLLIMPEXP_CORE wxDropFilesEvent : public wxEvent
c801d85f 2084{
2b854a32
VZ
2085public:
2086 int m_noFiles;
2087 wxPoint m_pos;
c3c39620 2088 wxString* m_files;
2b854a32
VZ
2089
2090 wxDropFilesEvent(wxEventType type = wxEVT_NULL,
2091 int noFiles = 0,
03f3617b 2092 wxString *files = NULL)
497dbbd3
VZ
2093 : wxEvent(0, type),
2094 m_noFiles(noFiles),
2095 m_pos(),
2096 m_files(files)
e6a6feba 2097 { }
2b854a32 2098
c3c39620
VZ
2099 // we need a copy ctor to avoid deleting m_files pointer twice
2100 wxDropFilesEvent(const wxDropFilesEvent& other)
497dbbd3
VZ
2101 : wxEvent(other),
2102 m_noFiles(other.m_noFiles),
2103 m_pos(other.m_pos),
2104 m_files(NULL)
c3c39620 2105 {
c3c39620
VZ
2106 m_files = new wxString[m_noFiles];
2107 for ( int n = 0; n < m_noFiles; n++ )
2108 {
2109 m_files[n] = other.m_files[n];
2110 }
2111 }
2112
2113 virtual ~wxDropFilesEvent()
2114 {
2115 delete [] m_files;
2116 }
2117
2b854a32
VZ
2118 wxPoint GetPosition() const { return m_pos; }
2119 int GetNumberOfFiles() const { return m_noFiles; }
2120 wxString *GetFiles() const { return m_files; }
f305c661 2121
c3c39620 2122 virtual wxEvent *Clone() const { return new wxDropFilesEvent(*this); }
f97500b8 2123
8e72b8b5 2124private:
fc7a2a60 2125 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDropFilesEvent)
c801d85f
KB
2126};
2127
c801d85f
KB
2128// Update UI event
2129/*
2130 wxEVT_UPDATE_UI
2131 */
2132
e39af974
JS
2133// Whether to always send update events to windows, or
2134// to only send update events to those with the
2135// wxWS_EX_PROCESS_UI_UPDATES style.
2136
2137enum wxUpdateUIMode
2138{
2139 // Send UI update events to all windows
2140 wxUPDATE_UI_PROCESS_ALL,
2141
2142 // Send UI update events to windows that have
2143 // the wxWS_EX_PROCESS_UI_UPDATES flag specified
2144 wxUPDATE_UI_PROCESS_SPECIFIED
2145};
2146
bddd7a8d 2147class WXDLLIMPEXP_CORE wxUpdateUIEvent : public wxCommandEvent
c801d85f 2148{
2b854a32
VZ
2149public:
2150 wxUpdateUIEvent(wxWindowID commandId = 0)
e6a6feba 2151 : wxCommandEvent(wxEVT_UPDATE_UI, commandId)
497dbbd3
VZ
2152 {
2153 m_checked =
2154 m_enabled =
a3a4105d 2155 m_shown =
497dbbd3 2156 m_setEnabled =
a3a4105d 2157 m_setShown =
9b9337da 2158 m_setText =
a0d9c6cb 2159 m_setChecked = false;
497dbbd3 2160 }
f3ff831f 2161 wxUpdateUIEvent(const wxUpdateUIEvent& event)
1d2eddff 2162 : wxCommandEvent(event),
b2697d42
VZ
2163 m_checked(event.m_checked),
2164 m_enabled(event.m_enabled),
a3a4105d 2165 m_shown(event.m_shown),
b2697d42 2166 m_setEnabled(event.m_setEnabled),
a3a4105d 2167 m_setShown(event.m_setShown),
b2697d42
VZ
2168 m_setText(event.m_setText),
2169 m_setChecked(event.m_setChecked),
2170 m_text(event.m_text)
2171 { }
c2bbeff0 2172
2b854a32
VZ
2173 bool GetChecked() const { return m_checked; }
2174 bool GetEnabled() const { return m_enabled; }
a3a4105d 2175 bool GetShown() const { return m_shown; }
2b854a32
VZ
2176 wxString GetText() const { return m_text; }
2177 bool GetSetText() const { return m_setText; }
2178 bool GetSetChecked() const { return m_setChecked; }
2179 bool GetSetEnabled() const { return m_setEnabled; }
a3a4105d 2180 bool GetSetShown() const { return m_setShown; }
2b854a32 2181
a0d9c6cb
WS
2182 void Check(bool check) { m_checked = check; m_setChecked = true; }
2183 void Enable(bool enable) { m_enabled = enable; m_setEnabled = true; }
a3a4105d 2184 void Show(bool show) { m_shown = show; m_setShown = true; }
a0d9c6cb 2185 void SetText(const wxString& text) { m_text = text; m_setText = true; }
c801d85f 2186
0b30bb0b
JS
2187 // Sets the interval between updates in milliseconds.
2188 // Set to -1 to disable updates, or to 0 to update as frequently as possible.
e39af974 2189 static void SetUpdateInterval(long updateInterval) { sm_updateInterval = updateInterval; }
0b30bb0b
JS
2190
2191 // Returns the current interval between updates in milliseconds
a7bc03c9 2192 static long GetUpdateInterval() { return sm_updateInterval; }
0b30bb0b 2193
e39af974 2194 // Can we update this window?
a7bc03c9 2195 static bool CanUpdate(wxWindowBase *win);
0b30bb0b
JS
2196
2197 // Reset the update time to provide a delay until the next
2198 // time we should update
a7bc03c9 2199 static void ResetUpdateTime();
0b30bb0b 2200
77ffb593 2201 // Specify how wxWidgets will send update events: to
e39af974
JS
2202 // all windows, or only to those which specify that they
2203 // will process the events.
2204 static void SetMode(wxUpdateUIMode mode) { sm_updateMode = mode; }
2205
2206 // Returns the UI update mode
a7bc03c9 2207 static wxUpdateUIMode GetMode() { return sm_updateMode; }
e39af974 2208
8e72b8b5 2209 virtual wxEvent *Clone() const { return new wxUpdateUIEvent(*this); }
f305c661 2210
2b854a32
VZ
2211protected:
2212 bool m_checked;
2213 bool m_enabled;
a3a4105d 2214 bool m_shown;
2b854a32 2215 bool m_setEnabled;
a3a4105d 2216 bool m_setShown;
2b854a32
VZ
2217 bool m_setText;
2218 bool m_setChecked;
2219 wxString m_text;
0b30bb0b 2220#if wxUSE_LONGLONG
e39af974 2221 static wxLongLong sm_lastUpdate;
0b30bb0b 2222#endif
e39af974
JS
2223 static long sm_updateInterval;
2224 static wxUpdateUIMode sm_updateMode;
f97500b8 2225
8e72b8b5 2226private:
fc7a2a60 2227 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxUpdateUIEvent)
c801d85f
KB
2228};
2229
2230/*
2231 wxEVT_SYS_COLOUR_CHANGED
2232 */
2233
2234// TODO: shouldn't all events record the window ID?
bddd7a8d 2235class WXDLLIMPEXP_CORE wxSysColourChangedEvent : public wxEvent
c801d85f 2236{
2b854a32
VZ
2237public:
2238 wxSysColourChangedEvent()
e6a6feba
GD
2239 : wxEvent(0, wxEVT_SYS_COLOUR_CHANGED)
2240 { }
f97500b8 2241
8e72b8b5 2242 virtual wxEvent *Clone() const { return new wxSysColourChangedEvent(*this); }
f97500b8 2243
8e72b8b5 2244private:
fc7a2a60 2245 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSysColourChangedEvent)
c801d85f
KB
2246};
2247
a5e84126
JS
2248/*
2249 wxEVT_MOUSE_CAPTURE_CHANGED
2250 The window losing the capture receives this message
2251 (even if it released the capture itself).
2252 */
2253
bddd7a8d 2254class WXDLLIMPEXP_CORE wxMouseCaptureChangedEvent : public wxEvent
a5e84126
JS
2255{
2256public:
d9e2e4c2
DE
2257 wxMouseCaptureChangedEvent(wxWindowID winid = 0, wxWindow* gainedCapture = NULL)
2258 : wxEvent(winid, wxEVT_MOUSE_CAPTURE_CHANGED),
497dbbd3 2259 m_gainedCapture(gainedCapture)
e6a6feba
GD
2260 { }
2261
2262 wxMouseCaptureChangedEvent(const wxMouseCaptureChangedEvent& event)
497dbbd3
VZ
2263 : wxEvent(event),
2264 m_gainedCapture(event.m_gainedCapture)
e6a6feba 2265 { }
a5e84126
JS
2266
2267 virtual wxEvent *Clone() const { return new wxMouseCaptureChangedEvent(*this); }
2268
47b378bd 2269 wxWindow* GetCapturedWindow() const { return m_gainedCapture; }
a5e84126
JS
2270
2271private:
2272 wxWindow* m_gainedCapture;
fc7a2a60
VZ
2273
2274 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureChangedEvent)
a5e84126
JS
2275};
2276
63e819f2
VS
2277/*
2278 wxEVT_MOUSE_CAPTURE_LOST
2279 The window losing the capture receives this message, unless it released it
2280 it itself or unless wxWindow::CaptureMouse was called on another window
2281 (and so capture will be restored when the new capturer releases it).
2282 */
2283
2284class WXDLLIMPEXP_CORE wxMouseCaptureLostEvent : public wxEvent
2285{
2286public:
2287 wxMouseCaptureLostEvent(wxWindowID winid = 0)
2288 : wxEvent(winid, wxEVT_MOUSE_CAPTURE_LOST)
2289 {}
2290
2291 wxMouseCaptureLostEvent(const wxMouseCaptureLostEvent& event)
2292 : wxEvent(event)
2293 {}
2294
2295 virtual wxEvent *Clone() const { return new wxMouseCaptureLostEvent(*this); }
2296
2297 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureLostEvent)
2298};
2299
574c939e
KB
2300/*
2301 wxEVT_DISPLAY_CHANGED
2302 */
bddd7a8d 2303class WXDLLIMPEXP_CORE wxDisplayChangedEvent : public wxEvent
574c939e
KB
2304{
2305private:
fc7a2a60 2306 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDisplayChangedEvent)
574c939e
KB
2307
2308public:
2309 wxDisplayChangedEvent()
e6a6feba
GD
2310 : wxEvent(0, wxEVT_DISPLAY_CHANGED)
2311 { }
574c939e
KB
2312
2313 virtual wxEvent *Clone() const { return new wxDisplayChangedEvent(*this); }
2314};
2315
f7bd2698
JS
2316/*
2317 wxEVT_PALETTE_CHANGED
2318 */
2319
bddd7a8d 2320class WXDLLIMPEXP_CORE wxPaletteChangedEvent : public wxEvent
f7bd2698 2321{
f7bd2698 2322public:
d9e2e4c2
DE
2323 wxPaletteChangedEvent(wxWindowID winid = 0)
2324 : wxEvent(winid, wxEVT_PALETTE_CHANGED),
03f3617b 2325 m_changedWindow(NULL)
497dbbd3 2326 { }
e6a6feba
GD
2327
2328 wxPaletteChangedEvent(const wxPaletteChangedEvent& event)
497dbbd3
VZ
2329 : wxEvent(event),
2330 m_changedWindow(event.m_changedWindow)
e6a6feba 2331 { }
f7bd2698 2332
2b854a32
VZ
2333 void SetChangedWindow(wxWindow* win) { m_changedWindow = win; }
2334 wxWindow* GetChangedWindow() const { return m_changedWindow; }
f7bd2698 2335
8e72b8b5 2336 virtual wxEvent *Clone() const { return new wxPaletteChangedEvent(*this); }
f305c661 2337
f7bd2698 2338protected:
2b854a32 2339 wxWindow* m_changedWindow;
8e72b8b5
RR
2340
2341private:
fc7a2a60 2342 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaletteChangedEvent)
f7bd2698
JS
2343};
2344
2345/*
2346 wxEVT_QUERY_NEW_PALETTE
2347 Indicates the window is getting keyboard focus and should re-do its palette.
2348 */
2349
bddd7a8d 2350class WXDLLIMPEXP_CORE wxQueryNewPaletteEvent : public wxEvent
f7bd2698 2351{
f7bd2698 2352public:
d9e2e4c2
DE
2353 wxQueryNewPaletteEvent(wxWindowID winid = 0)
2354 : wxEvent(winid, wxEVT_QUERY_NEW_PALETTE),
a0d9c6cb 2355 m_paletteRealized(false)
e6a6feba 2356 { }
f3ff831f 2357 wxQueryNewPaletteEvent(const wxQueryNewPaletteEvent& event)
1d2eddff 2358 : wxEvent(event),
b2697d42
VZ
2359 m_paletteRealized(event.m_paletteRealized)
2360 { }
c2bbeff0 2361
2b854a32
VZ
2362 // App sets this if it changes the palette.
2363 void SetPaletteRealized(bool realized) { m_paletteRealized = realized; }
2364 bool GetPaletteRealized() const { return m_paletteRealized; }
f7bd2698 2365
8e72b8b5 2366 virtual wxEvent *Clone() const { return new wxQueryNewPaletteEvent(*this); }
f305c661 2367
f7bd2698 2368protected:
2b854a32 2369 bool m_paletteRealized;
f97500b8 2370
8e72b8b5 2371private:
fc7a2a60 2372 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxQueryNewPaletteEvent)
f7bd2698
JS
2373};
2374
7fdefd57
VZ
2375/*
2376 Event generated by dialog navigation keys
2377 wxEVT_NAVIGATION_KEY
2378 */
d9506e77 2379// NB: don't derive from command event to avoid being propagated to the parent
bddd7a8d 2380class WXDLLIMPEXP_CORE wxNavigationKeyEvent : public wxEvent
7fdefd57 2381{
7fdefd57 2382public:
d9506e77 2383 wxNavigationKeyEvent()
497dbbd3 2384 : wxEvent(0, wxEVT_NAVIGATION_KEY),
298ca00c 2385 m_flags(IsForward | FromTab), // defaults are for TAB
03f3617b 2386 m_focus(NULL)
aef35d0e
VZ
2387 {
2388 m_propagationLevel = wxEVENT_PROPAGATE_NONE;
2389 }
d9506e77 2390
e6a6feba 2391 wxNavigationKeyEvent(const wxNavigationKeyEvent& event)
497dbbd3
VZ
2392 : wxEvent(event),
2393 m_flags(event.m_flags),
2394 m_focus(event.m_focus)
e6a6feba 2395 { }
7fdefd57 2396
2b854a32 2397 // direction: forward (true) or backward (false)
d9506e77
VZ
2398 bool GetDirection() const
2399 { return (m_flags & IsForward) != 0; }
2400 void SetDirection(bool bForward)
2401 { if ( bForward ) m_flags |= IsForward; else m_flags &= ~IsForward; }
7fdefd57 2402
2b854a32
VZ
2403 // it may be a window change event (MDI, notebook pages...) or a control
2404 // change event
d9506e77
VZ
2405 bool IsWindowChange() const
2406 { return (m_flags & WinChange) != 0; }
2407 void SetWindowChange(bool bIs)
2408 { if ( bIs ) m_flags |= WinChange; else m_flags &= ~WinChange; }
2409
298ca00c
VZ
2410 // Set to true under MSW if the event was generated using the tab key.
2411 // This is required for proper navogation over radio buttons
2412 bool IsFromTab() const
2413 { return (m_flags & FromTab) != 0; }
2414 void SetFromTab(bool bIs)
2415 { if ( bIs ) m_flags |= FromTab; else m_flags &= ~FromTab; }
2416
2b854a32
VZ
2417 // the child which has the focus currently (may be NULL - use
2418 // wxWindow::FindFocus then)
d9506e77
VZ
2419 wxWindow* GetCurrentFocus() const { return m_focus; }
2420 void SetCurrentFocus(wxWindow *win) { m_focus = win; }
2421
54a69edf
JS
2422 // Set flags
2423 void SetFlags(long flags) { m_flags = flags; }
2424
8e72b8b5
RR
2425 virtual wxEvent *Clone() const { return new wxNavigationKeyEvent(*this); }
2426
1e8af825 2427 enum wxNavigationKeyEventFlags
d9506e77 2428 {
f2de9fee 2429 IsBackward = 0x0000,
d9506e77 2430 IsForward = 0x0001,
298ca00c
VZ
2431 WinChange = 0x0002,
2432 FromTab = 0x0004
d9506e77
VZ
2433 };
2434
2435 long m_flags;
2436 wxWindow *m_focus;
2437
8e72b8b5 2438private:
fc7a2a60 2439 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNavigationKeyEvent)
7fdefd57
VZ
2440};
2441
42e69d6b
VZ
2442// Window creation/destruction events: the first is sent as soon as window is
2443// created (i.e. the underlying GUI object exists), but when the C++ object is
2444// fully initialized (so virtual functions may be called). The second,
2445// wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
2446// still safe to call virtual functions at this moment
2447/*
2448 wxEVT_CREATE
2449 wxEVT_DESTROY
2450 */
2451
bddd7a8d 2452class WXDLLIMPEXP_CORE wxWindowCreateEvent : public wxCommandEvent
42e69d6b 2453{
42e69d6b
VZ
2454public:
2455 wxWindowCreateEvent(wxWindow *win = NULL);
2456
2457 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
f97500b8 2458
8e72b8b5 2459 virtual wxEvent *Clone() const { return new wxWindowCreateEvent(*this); }
f97500b8 2460
8e72b8b5 2461private:
fc7a2a60 2462 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowCreateEvent)
42e69d6b
VZ
2463};
2464
bddd7a8d 2465class WXDLLIMPEXP_CORE wxWindowDestroyEvent : public wxCommandEvent
42e69d6b 2466{
42e69d6b
VZ
2467public:
2468 wxWindowDestroyEvent(wxWindow *win = NULL);
2469
2470 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
f97500b8 2471
8e72b8b5
RR
2472 virtual wxEvent *Clone() const { return new wxWindowDestroyEvent(*this); }
2473
2474private:
fc7a2a60 2475 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowDestroyEvent)
42e69d6b
VZ
2476};
2477
bd83cb56 2478// A help event is sent when the user clicks on a window in context-help mode.
b96340e6 2479/*
bd83cb56
VZ
2480 wxEVT_HELP
2481 wxEVT_DETAILED_HELP
2482*/
b96340e6 2483
bddd7a8d 2484class WXDLLIMPEXP_CORE wxHelpEvent : public wxCommandEvent
b96340e6 2485{
b96340e6 2486public:
b107e8d5
VZ
2487 // how was this help event generated?
2488 enum Origin
2489 {
2490 Origin_Unknown, // unrecognized event source
2491 Origin_Keyboard, // event generated from F1 key press
2492 Origin_HelpButton // event from [?] button on the title bar (Windows)
2493 };
2494
bd83cb56 2495 wxHelpEvent(wxEventType type = wxEVT_NULL,
d9e2e4c2 2496 wxWindowID winid = 0,
b107e8d5
VZ
2497 const wxPoint& pt = wxDefaultPosition,
2498 Origin origin = Origin_Unknown)
d9e2e4c2 2499 : wxCommandEvent(type, winid),
b107e8d5
VZ
2500 m_pos(pt),
2501 m_origin(GuessOrigin(origin))
e6a6feba 2502 { }
f3ff831f 2503 wxHelpEvent(const wxHelpEvent& event)
1d2eddff 2504 : wxCommandEvent(event),
b2697d42
VZ
2505 m_pos(event.m_pos),
2506 m_target(event.m_target),
b107e8d5
VZ
2507 m_link(event.m_link),
2508 m_origin(event.m_origin)
1d2eddff 2509 { }
c2bbeff0 2510
bd83cb56
VZ
2511 // Position of event (in screen coordinates)
2512 const wxPoint& GetPosition() const { return m_pos; }
2513 void SetPosition(const wxPoint& pos) { m_pos = pos; }
b96340e6 2514
bd83cb56
VZ
2515 // Optional link to further help
2516 const wxString& GetLink() const { return m_link; }
2517 void SetLink(const wxString& link) { m_link = link; }
fb6261e9 2518
bd83cb56
VZ
2519 // Optional target to display help in. E.g. a window specification
2520 const wxString& GetTarget() const { return m_target; }
2521 void SetTarget(const wxString& target) { m_target = target; }
fb6261e9 2522
8e72b8b5 2523 virtual wxEvent *Clone() const { return new wxHelpEvent(*this); }
f97500b8 2524
b107e8d5
VZ
2525 // optional indication of the event source
2526 Origin GetOrigin() const { return m_origin; }
2527 void SetOrigin(Origin origin) { m_origin = origin; }
2528
bd83cb56
VZ
2529protected:
2530 wxPoint m_pos;
2531 wxString m_target;
2532 wxString m_link;
b107e8d5
VZ
2533 Origin m_origin;
2534
2535 // we can try to guess the event origin ourselves, even if none is
2536 // specified in the ctor
2537 static Origin GuessOrigin(Origin origin);
bd83cb56
VZ
2538
2539private:
fc7a2a60 2540 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHelpEvent)
b96340e6
JS
2541};
2542
78c91815
VZ
2543// A Clipboard Text event is sent when a window intercepts text copy/cut/paste
2544// message, i.e. the user has cut/copied/pasted data from/into a text control
2545// via ctrl-C/X/V, ctrl/shift-del/insert, a popup menu command, etc.
2546// NOTE : under windows these events are *NOT* generated automatically
2547// for a Rich Edit text control.
2548/*
2549wxEVT_COMMAND_TEXT_COPY
2550wxEVT_COMMAND_TEXT_CUT
2551wxEVT_COMMAND_TEXT_PASTE
2552*/
2553
2554class WXDLLIMPEXP_CORE wxClipboardTextEvent : public wxCommandEvent
2555{
2556public:
2557 wxClipboardTextEvent(wxEventType type = wxEVT_NULL,
2558 wxWindowID winid = 0)
2559 : wxCommandEvent(type, winid)
2560 { }
f3ff831f 2561 wxClipboardTextEvent(const wxClipboardTextEvent& event)
78c91815
VZ
2562 : wxCommandEvent(event)
2563 { }
2564
2565 virtual wxEvent *Clone() const { return new wxClipboardTextEvent(*this); }
2566
2567private:
2568 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxClipboardTextEvent)
2569};
2570
69231000
JS
2571// A Context event is sent when the user right clicks on a window or
2572// presses Shift-F10
2573// NOTE : Under windows this is a repackaged WM_CONTETXMENU message
2574// Under other systems it may have to be generated from a right click event
2575/*
2576 wxEVT_CONTEXT_MENU
2577*/
2578
bddd7a8d 2579class WXDLLIMPEXP_CORE wxContextMenuEvent : public wxCommandEvent
69231000
JS
2580{
2581public:
2582 wxContextMenuEvent(wxEventType type = wxEVT_NULL,
d9e2e4c2 2583 wxWindowID winid = 0,
e6a6feba 2584 const wxPoint& pt = wxDefaultPosition)
d9e2e4c2 2585 : wxCommandEvent(type, winid),
497dbbd3 2586 m_pos(pt)
e6a6feba 2587 { }
f3ff831f 2588 wxContextMenuEvent(const wxContextMenuEvent& event)
1d2eddff 2589 : wxCommandEvent(event),
b2697d42 2590 m_pos(event.m_pos)
1d2eddff 2591 { }
c2bbeff0 2592
69231000
JS
2593 // Position of event (in screen coordinates)
2594 const wxPoint& GetPosition() const { return m_pos; }
2595 void SetPosition(const wxPoint& pos) { m_pos = pos; }
2596
8e72b8b5 2597 virtual wxEvent *Clone() const { return new wxContextMenuEvent(*this); }
f97500b8 2598
69231000
JS
2599protected:
2600 wxPoint m_pos;
2601
2602private:
fc7a2a60 2603 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxContextMenuEvent)
69231000
JS
2604};
2605
b46b1d59
VZ
2606#endif // wxUSE_GUI
2607
e90c1d2a
VZ
2608// Idle event
2609/*
2610 wxEVT_IDLE
2611 */
2612
e39af974
JS
2613// Whether to always send idle events to windows, or
2614// to only send update events to those with the
2615// wxWS_EX_PROCESS_IDLE style.
2616
2617enum wxIdleMode
2618{
2619 // Send idle events to all windows
2620 wxIDLE_PROCESS_ALL,
2621
2622 // Send idle events to windows that have
2623 // the wxWS_EX_PROCESS_IDLE flag specified
2624 wxIDLE_PROCESS_SPECIFIED
2625};
2626
b46b1d59 2627class WXDLLIMPEXP_BASE wxIdleEvent : public wxEvent
e90c1d2a 2628{
e90c1d2a
VZ
2629public:
2630 wxIdleEvent()
497dbbd3 2631 : wxEvent(0, wxEVT_IDLE),
a0d9c6cb 2632 m_requestMore(false)
e6a6feba 2633 { }
f3ff831f 2634 wxIdleEvent(const wxIdleEvent& event)
1d2eddff 2635 : wxEvent(event),
b2697d42
VZ
2636 m_requestMore(event.m_requestMore)
2637 { }
c2bbeff0 2638
a0d9c6cb 2639 void RequestMore(bool needMore = true) { m_requestMore = needMore; }
e90c1d2a
VZ
2640 bool MoreRequested() const { return m_requestMore; }
2641
8e72b8b5 2642 virtual wxEvent *Clone() const { return new wxIdleEvent(*this); }
e90c1d2a 2643
77ffb593 2644 // Specify how wxWidgets will send idle events: to
e39af974
JS
2645 // all windows, or only to those which specify that they
2646 // will process the events.
2647 static void SetMode(wxIdleMode mode) { sm_idleMode = mode; }
2648
2649 // Returns the idle event mode
a7bc03c9 2650 static wxIdleMode GetMode() { return sm_idleMode; }
e39af974 2651
e90c1d2a
VZ
2652protected:
2653 bool m_requestMore;
e39af974 2654 static wxIdleMode sm_idleMode;
f97500b8 2655
8e72b8b5 2656private:
fc7a2a60 2657 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIdleEvent)
e90c1d2a
VZ
2658};
2659
e5fb7191 2660/* TODO
c801d85f
KB
2661 wxEVT_MOUSE_CAPTURE_CHANGED,
2662 wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
c801d85f
KB
2663// wxEVT_FONT_CHANGED, // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
2664 // wxEVT_FONT_CHANGED to all other windows (maybe).
2665 wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
2666 wxEVT_MEASURE_ITEM,
2667 wxEVT_COMPARE_ITEM
2668*/
2669
88a9f974 2670
d48b06bd 2671
8e193f38
VZ
2672// ============================================================================
2673// event handler and related classes
2674// ============================================================================
2675
c801d85f 2676
6164f93c
VZ
2677// struct containing the members common to static and dynamic event tables
2678// entries
bddd7a8d 2679struct WXDLLIMPEXP_BASE wxEventTableEntryBase
77d4384e 2680{
d9e2e4c2 2681 wxEventTableEntryBase(int winid, int idLast,
3c778901 2682 wxEventFunctor* fn, wxObject *data)
d9e2e4c2 2683 : m_id(winid),
497dbbd3
VZ
2684 m_lastId(idLast),
2685 m_fn(fn),
2686 m_callbackUserData(data)
e6a6feba
GD
2687 { }
2688
3c778901
VZ
2689 wxEventTableEntryBase( const wxEventTableEntryBase &entry )
2690 : m_id( entry.m_id ),
2691 m_lastId( entry.m_lastId ),
2692 m_fn( entry.m_fn ),
2693 m_callbackUserData( entry.m_callbackUserData )
2694 {
2695 // This is a 'hack' to ensure that only one instance tries to delete
2696 // the functor pointer. It is safe as long as the only place where the
2697 // copy constructor is being called is when the static event tables are
2698 // being initialized (a temporary instance is created and then this
2699 // constructor is called).
2700
f3ff831f 2701 const_cast<wxEventTableEntryBase&>( entry ).m_fn = NULL;
3c778901
VZ
2702 }
2703
2704 ~wxEventTableEntryBase()
2705 {
0b632977 2706 delete m_fn;
3c778901 2707 }
6164f93c 2708
497dbbd3
VZ
2709 // the range of ids for this entry: if m_lastId == wxID_ANY, the range
2710 // consists only of m_id, otherwise it is m_id..m_lastId inclusive
2711 int m_id,
2712 m_lastId;
82a5f02c 2713
3c778901
VZ
2714 // function/method/functor to call
2715 wxEventFunctor* m_fn;
77d4384e 2716
3c778901 2717 // arbitrary user data associated with the callback
77d4384e 2718 wxObject* m_callbackUserData;
3c778901
VZ
2719
2720private:
c0c133e1 2721 wxDECLARE_NO_ASSIGN_CLASS(wxEventTableEntryBase);
77d4384e
RR
2722};
2723
6164f93c 2724// an entry from a static event table
bddd7a8d 2725struct WXDLLIMPEXP_BASE wxEventTableEntry : public wxEventTableEntryBase
c801d85f 2726{
d9e2e4c2 2727 wxEventTableEntry(const int& evType, int winid, int idLast,
3c778901 2728 wxEventFunctor* fn, wxObject *data)
d9e2e4c2 2729 : wxEventTableEntryBase(winid, idLast, fn, data),
e6a6feba
GD
2730 m_eventType(evType)
2731 { }
6164f93c
VZ
2732
2733 // the reference to event type: this allows us to not care about the
2734 // (undefined) order in which the event table entries and the event types
2735 // are initialized: initially the value of this reference might be
2736 // invalid, but by the time it is used for the first time, all global
2737 // objects will have been initialized (including the event type constants)
2738 // and so it will have the correct value when it is needed
2739 const int& m_eventType;
fc7a2a60
VZ
2740
2741private:
c0c133e1 2742 wxDECLARE_NO_ASSIGN_CLASS(wxEventTableEntry);
6164f93c
VZ
2743};
2744
2745// an entry used in dynamic event table managed by wxEvtHandler::Connect()
bddd7a8d 2746struct WXDLLIMPEXP_BASE wxDynamicEventTableEntry : public wxEventTableEntryBase
6164f93c 2747{
d9e2e4c2 2748 wxDynamicEventTableEntry(int evType, int winid, int idLast,
3c778901 2749 wxEventFunctor* fn, wxObject *data)
d9e2e4c2 2750 : wxEventTableEntryBase(winid, idLast, fn, data),
3c778901 2751 m_eventType(evType)
e6a6feba 2752 { }
6164f93c
VZ
2753
2754 // not a reference here as we can't keep a reference to a temporary int
2755 // created to wrap the constant value typically passed to Connect() - nor
2756 // do we need it
2757 int m_eventType;
65b17727 2758
3c778901 2759private:
c0c133e1 2760 wxDECLARE_NO_ASSIGN_CLASS(wxDynamicEventTableEntry);
c801d85f
KB
2761};
2762
2e4df4bf
VZ
2763// ----------------------------------------------------------------------------
2764// wxEventTable: an array of event entries terminated with {0, 0, 0, 0, 0}
2765// ----------------------------------------------------------------------------
886dd7d2 2766
bddd7a8d 2767struct WXDLLIMPEXP_BASE wxEventTable
c801d85f 2768{
0b5eceb6
VZ
2769 const wxEventTable *baseTable; // base event table (next in chain)
2770 const wxEventTableEntry *entries; // bottom of entry array
c801d85f
KB
2771};
2772
b5a98acd
VZ
2773// ----------------------------------------------------------------------------
2774// wxEventHashTable: a helper of wxEvtHandler to speed up wxEventTable lookups.
2775// ----------------------------------------------------------------------------
2776
d5d29b8a 2777WX_DEFINE_ARRAY_PTR(const wxEventTableEntry*, wxEventTableEntryPointerArray);
b5a98acd
VZ
2778
2779class WXDLLIMPEXP_BASE wxEventHashTable
2780{
2781private:
2782 // Internal data structs
2783 struct EventTypeTable
2784 {
2785 wxEventType eventType;
2786 wxEventTableEntryPointerArray eventEntryTable;
2787 };
2788 typedef EventTypeTable* EventTypeTablePointer;
2789
2790public:
2791 // Constructor, needs the event table it needs to hash later on.
1c624631
VZ
2792 // Note: hashing of the event table is not done in the constructor as it
2793 // can be that the event table is not yet full initialize, the hash
b5a98acd
VZ
2794 // will gets initialized when handling the first event look-up request.
2795 wxEventHashTable(const wxEventTable &table);
2796 // Destructor.
2797 ~wxEventHashTable();
2798
1c624631 2799 // Handle the given event, in other words search the event table hash
b5a98acd 2800 // and call self->ProcessEvent() if a match was found.
f3ff831f 2801 bool HandleEvent(wxEvent& event, wxEvtHandler *self);
b5a98acd 2802
afa039f9
JS
2803 // Clear table
2804 void Clear();
2805
aa767a45 2806#if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
afa039f9
JS
2807 // Clear all tables
2808 static void ClearAll();
a0826b11 2809#endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING
afa039f9 2810
b5a98acd
VZ
2811protected:
2812 // Init the hash table with the entries of the static event table.
2813 void InitHashTable();
2814 // Helper funtion of InitHashTable() to insert 1 entry into the hash table.
2815 void AddEntry(const wxEventTableEntry &entry);
2816 // Allocate and init with null pointers the base hash table.
2817 void AllocEventTypeTable(size_t size);
1c624631 2818 // Grow the hash table in size and transfer all items currently
b5a98acd
VZ
2819 // in the table to the correct location in the new table.
2820 void GrowEventTypeTable();
2821
2822protected:
2823 const wxEventTable &m_table;
2824 bool m_rebuildHash;
2825
2826 size_t m_size;
2827 EventTypeTablePointer *m_eventTypeTable;
fc7a2a60 2828
afa039f9
JS
2829 static wxEventHashTable* sm_first;
2830 wxEventHashTable* m_previous;
2831 wxEventHashTable* m_next;
2832
c0c133e1 2833 wxDECLARE_NO_COPY_CLASS(wxEventHashTable);
b5a98acd
VZ
2834};
2835
6164f93c 2836// ----------------------------------------------------------------------------
77ffb593 2837// wxEvtHandler: the base class for all objects handling wxWidgets events
6164f93c
VZ
2838// ----------------------------------------------------------------------------
2839
4732e2dc 2840class WXDLLIMPEXP_BASE wxEvtHandler : public wxObject
4732e2dc 2841 , public wxTrackable
c801d85f 2842{
2b854a32
VZ
2843public:
2844 wxEvtHandler();
6164f93c 2845 virtual ~wxEvtHandler();
2b854a32 2846
7f853dd0
FM
2847
2848 // Event handler chain
2849 // -------------------
2850
2b854a32
VZ
2851 wxEvtHandler *GetNextHandler() const { return m_nextHandler; }
2852 wxEvtHandler *GetPreviousHandler() const { return m_previousHandler; }
7f853dd0
FM
2853 virtual void SetNextHandler(wxEvtHandler *handler) { m_nextHandler = handler; }
2854 virtual void SetPreviousHandler(wxEvtHandler *handler) { m_previousHandler = handler; }
2b854a32 2855
8e193f38 2856 void SetEvtHandlerEnabled(bool enabled) { m_enabled = enabled; }
2b854a32
VZ
2857 bool GetEvtHandlerEnabled() const { return m_enabled; }
2858
7f853dd0
FM
2859 void Unlink();
2860 bool IsUnlinked() const;
2861
2862
2863
2864 // Event queuing and processing
2865 // ----------------------------
2866
c3f94162
VZ
2867 // Process an event right now: this can only be called from the main
2868 // thread, use QueueEvent() for scheduling the events for
2869 // processing from other threads.
8e193f38 2870 virtual bool ProcessEvent(wxEvent& event);
2b854a32 2871
937013e0
VS
2872 // Process an event by calling ProcessEvent and handling any exceptions
2873 // thrown by event handlers. It's mostly useful when processing wx events
2874 // when called from C code (e.g. in GTK+ callback) when the exception
2875 // wouldn't correctly propagate to wxEventLoop.
2876 bool SafelyProcessEvent(wxEvent& event);
7f853dd0 2877 // NOTE: uses ProcessEvent()
937013e0 2878
c3f94162
VZ
2879 // Schedule the given event to be processed later. It takes ownership of
2880 // the event pointer, i.e. it will be deleted later. This is safe to call
2881 // from multiple threads although you still need to ensure that wxString
2882 // fields of the event object are deep copies and not use the same string
2883 // buffer as other wxString objects in this thread.
2884 virtual void QueueEvent(wxEvent *event);
2885
2886 // Add an event to be processed later: notice that this function is not
2887 // safe to call from threads other than main, use QueueEvent()
2888 virtual void AddPendingEvent(const wxEvent& event)
2889 {
2890 // notice that the thread-safety problem comes from the fact that
2891 // Clone() doesn't make deep copies of wxString fields of wxEvent
2892 // object and so the same wxString could be used from both threads when
2893 // the event object is destroyed in this one -- QueueEvent() avoids
2894 // this problem as the event pointer is not used any more in this
2895 // thread at all after it is called.
2896 QueueEvent(event.Clone());
2897 }
2b854a32 2898
8e193f38 2899 void ProcessPendingEvents();
7f853dd0 2900 // NOTE: uses ProcessEvent()
2b854a32 2901
cae9e7b1
FM
2902 void DeletePendingEvents();
2903
7214297d 2904#if wxUSE_THREADS
76bfdc9a 2905 bool ProcessThreadEvent(const wxEvent& event);
cae9e7b1 2906 // NOTE: uses AddPendingEvent(); call only from secondary threads
7214297d 2907#endif
2b854a32 2908
7f853dd0
FM
2909
2910 // Connecting and disconnecting
2911 // ----------------------------
2912
f3ff831f
VZ
2913 // These functions are used for old, untyped, event handlers and don't
2914 // check that the type of the function passed to them actually matches the
2915 // type of the event. They also only allow connecting events to methods of
2916 // wxEvtHandler-derived classes.
2917 //
2918 // The template Connect() methods below are safer and allow connecting
2919 // events to arbitrary functions or functors -- but require compiler
2920 // support for templates.
2921
2b854a32 2922 // Dynamic association of a member function handler with the event handler,
d9e2e4c2 2923 // winid and event type
7fa03f04
VZ
2924 void Connect(int winid,
2925 int lastId,
c9c1faa4 2926 wxEventType eventType,
7fa03f04 2927 wxObjectEventFunction func,
03f3617b
VZ
2928 wxObject *userData = NULL,
2929 wxEvtHandler *eventSink = NULL)
3c778901 2930 {
f3ff831f
VZ
2931 DoConnect(winid, lastId, eventType,
2932 wxNewEventFunctor(eventType, func, eventSink),
2933 userData);
3c778901 2934 }
2b854a32
VZ
2935
2936 // Convenience function: take just one id
7fa03f04 2937 void Connect(int winid,
c9c1faa4 2938 wxEventType eventType,
7fa03f04 2939 wxObjectEventFunction func,
03f3617b
VZ
2940 wxObject *userData = NULL,
2941 wxEvtHandler *eventSink = NULL)
65b17727 2942 { Connect(winid, wxID_ANY, eventType, func, userData, eventSink); }
2b854a32 2943
7fa03f04 2944 // Even more convenient: without id (same as using id of wxID_ANY)
c9c1faa4 2945 void Connect(wxEventType eventType,
7fa03f04 2946 wxObjectEventFunction func,
03f3617b
VZ
2947 wxObject *userData = NULL,
2948 wxEvtHandler *eventSink = NULL)
7fa03f04
VZ
2949 { Connect(wxID_ANY, wxID_ANY, eventType, func, userData, eventSink); }
2950
2951 bool Disconnect(int winid,
2952 int lastId,
2953 wxEventType eventType,
2954 wxObjectEventFunction func = NULL,
03f3617b
VZ
2955 wxObject *userData = NULL,
2956 wxEvtHandler *eventSink = NULL)
3c778901 2957 {
f3ff831f
VZ
2958 return DoDisconnect(winid, lastId, eventType,
2959 wxMakeEventFunctor(eventType, func, eventSink),
2960 userData );
3c778901 2961 }
7fa03f04 2962
e554d626 2963 bool Disconnect(int winid = wxID_ANY,
7fa03f04
VZ
2964 wxEventType eventType = wxEVT_NULL,
2965 wxObjectEventFunction func = NULL,
03f3617b
VZ
2966 wxObject *userData = NULL,
2967 wxEvtHandler *eventSink = NULL)
65b17727 2968 { return Disconnect(winid, wxID_ANY, eventType, func, userData, eventSink); }
98243fed 2969
bdbe28fa 2970 bool Disconnect(wxEventType eventType,
e0685bb0 2971 wxObjectEventFunction func,
03f3617b
VZ
2972 wxObject *userData = NULL,
2973 wxEvtHandler *eventSink = NULL)
bdbe28fa 2974 { return Disconnect(wxID_ANY, eventType, func, userData, eventSink); }
f3ff831f 2975
3c778901 2976#if !wxEVENTS_COMPATIBILITY_2_8
5293e4b7 2977 // Bind arbitrary functor (including just a function) to an event:
f3ff831f 2978 template <typename EventTag, typename Functor>
5293e4b7
VZ
2979 void Bind(const EventTag& eventType,
2980 Functor func,
2981 int winid = wxID_ANY,
2982 int lastId = wxID_ANY,
2983 wxObject *userData = NULL)
f3ff831f
VZ
2984 {
2985 DoConnect(winid, lastId, eventType,
5293e4b7 2986 wxNewEventFunctor(eventType, func),
f3ff831f 2987 userData);
111d41b2
VZ
2988 }
2989
111d41b2 2990
5293e4b7
VZ
2991 template <typename EventTag, typename Functor>
2992 bool Unbind(const EventTag& eventType,
2993 Functor func,
2994 int winid = wxID_ANY,
2995 int lastId = wxID_ANY,
2996 wxObject *userData = NULL)
3c778901 2997 {
f3ff831f 2998 return DoDisconnect(winid, lastId, eventType,
5293e4b7 2999 wxMakeEventFunctor(eventType, func),
f3ff831f 3000 userData);
3c778901 3001 }
3c778901 3002
f3ff831f 3003
5293e4b7
VZ
3004 // Bind a method of a class (called on the specified eventSink which must
3005 // be convertible to this class) object to an event:
3c778901 3006
f3ff831f
VZ
3007 template
3008 <typename EventTag, typename Class, typename EventArg, typename ObjClass>
5293e4b7
VZ
3009 void Bind(const EventTag &eventType,
3010 void (Class::*func)(EventArg &),
3011 ObjClass *eventSink,
3012 int winid = wxID_ANY,
3013 int lastId = wxID_ANY,
3014 wxObject *userData = NULL)
f3ff831f
VZ
3015 {
3016 DoConnect(winid, lastId, eventType,
3017 wxNewEventFunctor(eventType, func, eventSink),
3018 userData);
3c778901
VZ
3019 }
3020
f3ff831f
VZ
3021 template
3022 <typename EventTag, typename Class, typename EventArg, typename ObjClass>
5293e4b7
VZ
3023 bool Unbind(const EventTag &eventType,
3024 void (Class::*func)(EventArg&),
3025 ObjClass *eventSink,
3026 int winid = wxID_ANY,
3027 int lastId = wxID_ANY,
3028 wxObject *userData = NULL )
f3ff831f
VZ
3029 {
3030 return DoDisconnect(winid, lastId, eventType,
3031 wxMakeEventFunctor(eventType, func, eventSink),
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
cc6ceca7 3157 wxEventConnectionRef *FindRefInTrackerList(wxEvtHandler *eventSink);
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))
c801d85f
KB
3755
3756// Generic command events
7fa03f04
VZ
3757#define EVT_COMMAND_LEFT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_CLICK, winid, wxCommandEventHandler(func))
3758#define EVT_COMMAND_LEFT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_DCLICK, winid, wxCommandEventHandler(func))
3759#define EVT_COMMAND_RIGHT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_CLICK, winid, wxCommandEventHandler(func))
3760#define EVT_COMMAND_RIGHT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_DCLICK, winid, wxCommandEventHandler(func))
3761#define EVT_COMMAND_SET_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SET_FOCUS, winid, wxCommandEventHandler(func))
3762#define EVT_COMMAND_KILL_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_KILL_FOCUS, winid, wxCommandEventHandler(func))
3763#define EVT_COMMAND_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_ENTER, winid, wxCommandEventHandler(func))
c801d85f
KB
3764
3765// Joystick events
1241ab8b 3766
7fa03f04
VZ
3767#define EVT_JOY_BUTTON_DOWN(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_DOWN, wxJoystickEventHandler(func))
3768#define EVT_JOY_BUTTON_UP(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_UP, wxJoystickEventHandler(func))
3769#define EVT_JOY_MOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_MOVE, wxJoystickEventHandler(func))
3770#define EVT_JOY_ZMOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_ZMOVE, wxJoystickEventHandler(func))
c801d85f
KB
3771
3772// All joystick events
3773#define EVT_JOYSTICK_EVENTS(func) \
7fa03f04
VZ
3774 EVT_JOY_BUTTON_DOWN(func) \
3775 EVT_JOY_BUTTON_UP(func) \
3776 EVT_JOY_MOVE(func) \
3777 EVT_JOY_ZMOVE(func)
c801d85f
KB
3778
3779// Idle event
7fa03f04 3780#define EVT_IDLE(func) wx__DECLARE_EVT0(wxEVT_IDLE, wxIdleEventHandler(func))
c801d85f
KB
3781
3782// Update UI event
7fa03f04
VZ
3783#define EVT_UPDATE_UI(winid, func) wx__DECLARE_EVT1(wxEVT_UPDATE_UI, winid, wxUpdateUIEventHandler(func))
3784#define EVT_UPDATE_UI_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_UPDATE_UI, id1, id2, wxUpdateUIEventHandler(func))
c801d85f 3785
b96340e6 3786// Help events
7fa03f04
VZ
3787#define EVT_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_HELP, winid, wxHelpEventHandler(func))
3788#define EVT_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_HELP, id1, id2, wxHelpEventHandler(func))
3789#define EVT_DETAILED_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_DETAILED_HELP, winid, wxHelpEventHandler(func))
3790#define EVT_DETAILED_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_DETAILED_HELP, id1, id2, wxHelpEventHandler(func))
fb6261e9 3791
69231000 3792// Context Menu Events
7fa03f04 3793#define EVT_CONTEXT_MENU(func) wx__DECLARE_EVT0(wxEVT_CONTEXT_MENU, wxContextMenuEventHandler(func))
5cd2a6ae 3794#define EVT_COMMAND_CONTEXT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_CONTEXT_MENU, winid, wxContextMenuEventHandler(func))
69231000 3795
78c91815
VZ
3796// Clipboard text Events
3797#define EVT_TEXT_CUT(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_CUT, winid, wxClipboardTextEventHandler(func))
3798#define EVT_TEXT_COPY(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_COPY, winid, wxClipboardTextEventHandler(func))
3799#define EVT_TEXT_PASTE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_PASTE, winid, wxClipboardTextEventHandler(func))
3800
d48b06bd
FM
3801// Thread events
3802#define EVT_THREAD(id, func) wx__DECLARE_EVT1(wxEVT_COMMAND_THREAD, id, wxThreadEventHandler(func))
3803
e90c1d2a
VZ
3804// ----------------------------------------------------------------------------
3805// Helper functions
3806// ----------------------------------------------------------------------------
3807
23172836
VZ
3808// This is an ugly hack to allow the use of Bind() instead of Connect() inside
3809// the library code if the library was built with support for it, here is how
3810// it is used:
3811//
3812// class SomeEventHandlingClass : wxBIND_OR_CONNECT_HACK_BASE_CLASS
3813// public SomeBaseClass
3814// {
3815// public:
3816// SomeEventHandlingClass(wxWindow *win)
3817// {
3818// // connect to the event for the given window
3819// wxBIND_OR_CONNECT_HACK(win, wxEVT_SOMETHING, wxSomeEventHandler,
3820// SomeEventHandlingClass::OnSomeEvent, this);
3821// }
3822//
3823// private:
3824// void OnSomeEvent(wxSomeEvent&) { ... }
3825// };
3826//
3827// This is *not* meant to be used by library users, it is only defined here
3828// (and not in a private header) because the base class must be visible from
3829// other public headers, please do NOT use this in your code, it will be
3830// removed from future wx versions without warning.
3831#if wxEVENTS_COMPATIBILITY_2_8
3832 #define wxBIND_OR_CONNECT_HACK_BASE_CLASS public wxEvtHandler,
3833 #define wxBIND_OR_CONNECT_HACK_ONLY_BASE_CLASS : public wxEvtHandler
3834 #define wxBIND_OR_CONNECT_HACK(w, evt, handler, func, obj) \
3835 win->Connect(evt, handler(func), NULL, obj)
3836#else // wxEVENTS_COMPATIBILITY_2_8
3837 #define wxBIND_OR_CONNECT_HACK_BASE_CLASS
3838 #define wxBIND_OR_CONNECT_HACK_ONLY_BASE_CLASS
3839 #define wxBIND_OR_CONNECT_HACK(w, evt, handler, func, obj) \
3840 win->Bind(evt, &func, obj)
3841#endif // wxEVENTS_COMPATIBILITY_2_8/!wxEVENTS_COMPATIBILITY_2_8
3842
e90c1d2a 3843#if wxUSE_GUI
e702ff0f
JS
3844
3845// Find a window with the focus, that is also a descendant of the given window.
3846// This is used to determine the window to initially send commands to.
9f8b9d9c 3847WXDLLIMPEXP_CORE wxWindow* wxFindFocusDescendant(wxWindow* ancestor);
e702ff0f 3848
e90c1d2a
VZ
3849#endif // wxUSE_GUI
3850
204abcd4 3851#endif // _WX_EVENT_H_