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