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