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