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