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