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