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