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