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