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