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