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