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