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