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