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