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