]> git.saurik.com Git - wxWidgets.git/blob - include/wx/event.h
Don't try to determine the clicked item ourselves in wxMSW wxListBox.
[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
1300 // Set/Get client data from controls
1301 void SetClientData(void* clientData) { m_clientData = clientData; }
1302 void *GetClientData() const { return m_clientData; }
1303
1304 // Set/Get client object from controls
1305 void SetClientObject(wxClientData* clientObject) { m_clientObject = clientObject; }
1306 wxClientData *GetClientObject() const { return m_clientObject; }
1307
1308 // Note: this shadows wxEventBasicPayloadMixin::GetString(), because it does some
1309 // GUI-specific hacks
1310 wxString GetString() const;
1311
1312 // Get listbox selection if single-choice
1313 int GetSelection() const { return m_commandInt; }
1314
1315 // Get checkbox value
1316 bool IsChecked() const { return m_commandInt != 0; }
1317
1318 // true if the listbox event was a selection.
1319 bool IsSelection() const { return (m_extraLong != 0); }
1320
1321 virtual wxEvent *Clone() const { return new wxCommandEvent(*this); }
1322 virtual wxEventCategory GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT; }
1323
1324 protected:
1325 void* m_clientData; // Arbitrary client data
1326 wxClientData* m_clientObject; // Arbitrary client object
1327
1328 private:
1329 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCommandEvent)
1330 };
1331
1332 // this class adds a possibility to react (from the user) code to a control
1333 // notification: allow or veto the operation being reported.
1334 class WXDLLIMPEXP_CORE wxNotifyEvent : public wxCommandEvent
1335 {
1336 public:
1337 wxNotifyEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
1338 : wxCommandEvent(commandType, winid)
1339 { m_bAllow = true; }
1340
1341 wxNotifyEvent(const wxNotifyEvent& event)
1342 : wxCommandEvent(event)
1343 { m_bAllow = event.m_bAllow; }
1344
1345 // veto the operation (usually it's allowed by default)
1346 void Veto() { m_bAllow = false; }
1347
1348 // allow the operation if it was disabled by default
1349 void Allow() { m_bAllow = true; }
1350
1351 // for implementation code only: is the operation allowed?
1352 bool IsAllowed() const { return m_bAllow; }
1353
1354 virtual wxEvent *Clone() const { return new wxNotifyEvent(*this); }
1355
1356 private:
1357 bool m_bAllow;
1358
1359 private:
1360 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNotifyEvent)
1361 };
1362
1363
1364 // Scroll event class, derived form wxCommandEvent. wxScrollEvents are
1365 // sent by wxSlider and wxScrollBar.
1366 /*
1367 wxEVT_SCROLL_TOP
1368 wxEVT_SCROLL_BOTTOM
1369 wxEVT_SCROLL_LINEUP
1370 wxEVT_SCROLL_LINEDOWN
1371 wxEVT_SCROLL_PAGEUP
1372 wxEVT_SCROLL_PAGEDOWN
1373 wxEVT_SCROLL_THUMBTRACK
1374 wxEVT_SCROLL_THUMBRELEASE
1375 wxEVT_SCROLL_CHANGED
1376 */
1377
1378 class WXDLLIMPEXP_CORE wxScrollEvent : public wxCommandEvent
1379 {
1380 public:
1381 wxScrollEvent(wxEventType commandType = wxEVT_NULL,
1382 int winid = 0, int pos = 0, int orient = 0);
1383
1384 int GetOrientation() const { return (int) m_extraLong; }
1385 int GetPosition() const { return m_commandInt; }
1386 void SetOrientation(int orient) { m_extraLong = (long) orient; }
1387 void SetPosition(int pos) { m_commandInt = pos; }
1388
1389 virtual wxEvent *Clone() const { return new wxScrollEvent(*this); }
1390
1391 private:
1392 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollEvent)
1393 };
1394
1395 // ScrollWin event class, derived fom wxEvent. wxScrollWinEvents
1396 // are sent by wxWindow.
1397 /*
1398 wxEVT_SCROLLWIN_TOP
1399 wxEVT_SCROLLWIN_BOTTOM
1400 wxEVT_SCROLLWIN_LINEUP
1401 wxEVT_SCROLLWIN_LINEDOWN
1402 wxEVT_SCROLLWIN_PAGEUP
1403 wxEVT_SCROLLWIN_PAGEDOWN
1404 wxEVT_SCROLLWIN_THUMBTRACK
1405 wxEVT_SCROLLWIN_THUMBRELEASE
1406 */
1407
1408 class WXDLLIMPEXP_CORE wxScrollWinEvent : public wxEvent
1409 {
1410 public:
1411 wxScrollWinEvent(wxEventType commandType = wxEVT_NULL,
1412 int pos = 0, int orient = 0);
1413 wxScrollWinEvent(const wxScrollWinEvent& event) : wxEvent(event)
1414 { m_commandInt = event.m_commandInt;
1415 m_extraLong = event.m_extraLong; }
1416
1417 int GetOrientation() const { return (int) m_extraLong; }
1418 int GetPosition() const { return m_commandInt; }
1419 void SetOrientation(int orient) { m_extraLong = (long) orient; }
1420 void SetPosition(int pos) { m_commandInt = pos; }
1421
1422 virtual wxEvent *Clone() const { return new wxScrollWinEvent(*this); }
1423
1424 protected:
1425 int m_commandInt;
1426 long m_extraLong;
1427
1428 private:
1429 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollWinEvent)
1430 };
1431
1432
1433
1434 // Mouse event class
1435
1436 /*
1437 wxEVT_LEFT_DOWN
1438 wxEVT_LEFT_UP
1439 wxEVT_MIDDLE_DOWN
1440 wxEVT_MIDDLE_UP
1441 wxEVT_RIGHT_DOWN
1442 wxEVT_RIGHT_UP
1443 wxEVT_MOTION
1444 wxEVT_ENTER_WINDOW
1445 wxEVT_LEAVE_WINDOW
1446 wxEVT_LEFT_DCLICK
1447 wxEVT_MIDDLE_DCLICK
1448 wxEVT_RIGHT_DCLICK
1449 */
1450
1451 enum wxMouseWheelAxis
1452 {
1453 wxMOUSE_WHEEL_VERTICAL,
1454 wxMOUSE_WHEEL_HORIZONTAL
1455 };
1456
1457 class WXDLLIMPEXP_CORE wxMouseEvent : public wxEvent,
1458 public wxMouseState
1459 {
1460 public:
1461 wxMouseEvent(wxEventType mouseType = wxEVT_NULL);
1462 wxMouseEvent(const wxMouseEvent& event)
1463 : wxEvent(event),
1464 wxMouseState(event)
1465 {
1466 Assign(event);
1467 }
1468
1469 // Was it a button event? (*doesn't* mean: is any button *down*?)
1470 bool IsButton() const { return Button(wxMOUSE_BTN_ANY); }
1471
1472 // Was it a down event from this (or any) button?
1473 bool ButtonDown(int but = wxMOUSE_BTN_ANY) const;
1474
1475 // Was it a dclick event from this (or any) button?
1476 bool ButtonDClick(int but = wxMOUSE_BTN_ANY) const;
1477
1478 // Was it a up event from this (or any) button?
1479 bool ButtonUp(int but = wxMOUSE_BTN_ANY) const;
1480
1481 // Was this event generated by the given button?
1482 bool Button(int but) const;
1483
1484 // Get the button which is changing state (wxMOUSE_BTN_NONE if none)
1485 int GetButton() const;
1486
1487 // Find which event was just generated
1488 bool LeftDown() const { return (m_eventType == wxEVT_LEFT_DOWN); }
1489 bool MiddleDown() const { return (m_eventType == wxEVT_MIDDLE_DOWN); }
1490 bool RightDown() const { return (m_eventType == wxEVT_RIGHT_DOWN); }
1491 bool Aux1Down() const { return (m_eventType == wxEVT_AUX1_DOWN); }
1492 bool Aux2Down() const { return (m_eventType == wxEVT_AUX2_DOWN); }
1493
1494 bool LeftUp() const { return (m_eventType == wxEVT_LEFT_UP); }
1495 bool MiddleUp() const { return (m_eventType == wxEVT_MIDDLE_UP); }
1496 bool RightUp() const { return (m_eventType == wxEVT_RIGHT_UP); }
1497 bool Aux1Up() const { return (m_eventType == wxEVT_AUX1_UP); }
1498 bool Aux2Up() const { return (m_eventType == wxEVT_AUX2_UP); }
1499
1500 bool LeftDClick() const { return (m_eventType == wxEVT_LEFT_DCLICK); }
1501 bool MiddleDClick() const { return (m_eventType == wxEVT_MIDDLE_DCLICK); }
1502 bool RightDClick() const { return (m_eventType == wxEVT_RIGHT_DCLICK); }
1503 bool Aux1DClick() const { return (m_eventType == wxEVT_AUX1_DCLICK); }
1504 bool Aux2DClick() const { return (m_eventType == wxEVT_AUX2_DCLICK); }
1505
1506 // True if a button is down and the mouse is moving
1507 bool Dragging() const
1508 {
1509 return (m_eventType == wxEVT_MOTION) && ButtonIsDown(wxMOUSE_BTN_ANY);
1510 }
1511
1512 // True if the mouse is moving, and no button is down
1513 bool Moving() const
1514 {
1515 return (m_eventType == wxEVT_MOTION) && !ButtonIsDown(wxMOUSE_BTN_ANY);
1516 }
1517
1518 // True if the mouse is just entering the window
1519 bool Entering() const { return (m_eventType == wxEVT_ENTER_WINDOW); }
1520
1521 // True if the mouse is just leaving the window
1522 bool Leaving() const { return (m_eventType == wxEVT_LEAVE_WINDOW); }
1523
1524 // Returns the number of mouse clicks associated with this event.
1525 int GetClickCount() const { return m_clickCount; }
1526
1527 // Find the logical position of the event given the DC
1528 wxPoint GetLogicalPosition(const wxDC& dc) const;
1529
1530 // Get wheel rotation, positive or negative indicates direction of
1531 // rotation. Current devices all send an event when rotation is equal to
1532 // +/-WheelDelta, but this allows for finer resolution devices to be
1533 // created in the future. Because of this you shouldn't assume that one
1534 // event is equal to 1 line or whatever, but you should be able to either
1535 // do partial line scrolling or wait until +/-WheelDelta rotation values
1536 // have been accumulated before scrolling.
1537 int GetWheelRotation() const { return m_wheelRotation; }
1538
1539 // Get wheel delta, normally 120. This is the threshold for action to be
1540 // taken, and one such action (for example, scrolling one increment)
1541 // should occur for each delta.
1542 int GetWheelDelta() const { return m_wheelDelta; }
1543
1544 // Gets the axis the wheel operation concerns; wxMOUSE_WHEEL_VERTICAL
1545 // (most common case) or wxMOUSE_WHEEL_HORIZONTAL (for horizontal scrolling
1546 // using e.g. a trackpad).
1547 wxMouseWheelAxis GetWheelAxis() const { return m_wheelAxis; }
1548
1549 // Returns the configured number of lines (or whatever) to be scrolled per
1550 // wheel action. Defaults to one.
1551 int GetLinesPerAction() const { return m_linesPerAction; }
1552
1553 // Is the system set to do page scrolling?
1554 bool IsPageScroll() const { return ((unsigned int)m_linesPerAction == UINT_MAX); }
1555
1556 virtual wxEvent *Clone() const { return new wxMouseEvent(*this); }
1557 virtual wxEventCategory GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT; }
1558
1559 wxMouseEvent& operator=(const wxMouseEvent& event)
1560 {
1561 if (&event != this)
1562 Assign(event);
1563 return *this;
1564 }
1565
1566 public:
1567 int m_clickCount;
1568
1569 wxMouseWheelAxis m_wheelAxis;
1570 int m_wheelRotation;
1571 int m_wheelDelta;
1572 int m_linesPerAction;
1573
1574 protected:
1575 void Assign(const wxMouseEvent& evt);
1576
1577 private:
1578 DECLARE_DYNAMIC_CLASS(wxMouseEvent)
1579 };
1580
1581 // Cursor set event
1582
1583 /*
1584 wxEVT_SET_CURSOR
1585 */
1586
1587 class WXDLLIMPEXP_CORE wxSetCursorEvent : public wxEvent
1588 {
1589 public:
1590 wxSetCursorEvent(wxCoord x = 0, wxCoord y = 0)
1591 : wxEvent(0, wxEVT_SET_CURSOR),
1592 m_x(x), m_y(y), m_cursor()
1593 { }
1594
1595 wxSetCursorEvent(const wxSetCursorEvent& event)
1596 : wxEvent(event),
1597 m_x(event.m_x),
1598 m_y(event.m_y),
1599 m_cursor(event.m_cursor)
1600 { }
1601
1602 wxCoord GetX() const { return m_x; }
1603 wxCoord GetY() const { return m_y; }
1604
1605 void SetCursor(const wxCursor& cursor) { m_cursor = cursor; }
1606 const wxCursor& GetCursor() const { return m_cursor; }
1607 bool HasCursor() const { return m_cursor.IsOk(); }
1608
1609 virtual wxEvent *Clone() const { return new wxSetCursorEvent(*this); }
1610
1611 private:
1612 wxCoord m_x, m_y;
1613 wxCursor m_cursor;
1614
1615 private:
1616 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSetCursorEvent)
1617 };
1618
1619 // Keyboard input event class
1620
1621 /*
1622 wxEVT_CHAR
1623 wxEVT_CHAR_HOOK
1624 wxEVT_KEY_DOWN
1625 wxEVT_KEY_UP
1626 wxEVT_HOTKEY
1627 */
1628
1629 // key categories: the bit flags for IsKeyInCategory() function
1630 //
1631 // the enum values used may change in future version of wx
1632 // use the named constants only, or bitwise combinations thereof
1633 enum wxKeyCategoryFlags
1634 {
1635 // arrow keys, on and off numeric keypads
1636 WXK_CATEGORY_ARROW = 1,
1637
1638 // page up and page down keys, on and off numeric keypads
1639 WXK_CATEGORY_PAGING = 2,
1640
1641 // home and end keys, on and off numeric keypads
1642 WXK_CATEGORY_JUMP = 4,
1643
1644 // tab key, on and off numeric keypads
1645 WXK_CATEGORY_TAB = 8,
1646
1647 // backspace and delete keys, on and off numeric keypads
1648 WXK_CATEGORY_CUT = 16,
1649
1650 // all keys usually used for navigation
1651 WXK_CATEGORY_NAVIGATION = WXK_CATEGORY_ARROW |
1652 WXK_CATEGORY_PAGING |
1653 WXK_CATEGORY_JUMP
1654 };
1655
1656 class WXDLLIMPEXP_CORE wxKeyEvent : public wxEvent,
1657 public wxKeyboardState
1658 {
1659 public:
1660 wxKeyEvent(wxEventType keyType = wxEVT_NULL);
1661
1662 // Normal copy ctor and a ctor creating a new event for the same key as the
1663 // given one but a different event type (this is used in implementation
1664 // code only, do not use outside of the library).
1665 wxKeyEvent(const wxKeyEvent& evt);
1666 wxKeyEvent(wxEventType eventType, const wxKeyEvent& evt);
1667
1668 // get the key code: an ASCII7 char or an element of wxKeyCode enum
1669 int GetKeyCode() const { return (int)m_keyCode; }
1670
1671 // returns true iff this event's key code is of a certain type
1672 bool IsKeyInCategory(int category) const;
1673
1674 #if wxUSE_UNICODE
1675 // get the Unicode character corresponding to this key
1676 wxChar GetUnicodeKey() const { return m_uniChar; }
1677 #endif // wxUSE_UNICODE
1678
1679 // get the raw key code (platform-dependent)
1680 wxUint32 GetRawKeyCode() const { return m_rawCode; }
1681
1682 // get the raw key flags (platform-dependent)
1683 wxUint32 GetRawKeyFlags() const { return m_rawFlags; }
1684
1685 // Find the position of the event
1686 void GetPosition(wxCoord *xpos, wxCoord *ypos) const
1687 {
1688 if (xpos) *xpos = m_x;
1689 if (ypos) *ypos = m_y;
1690 }
1691
1692 void GetPosition(long *xpos, long *ypos) const
1693 {
1694 if (xpos) *xpos = (long)m_x;
1695 if (ypos) *ypos = (long)m_y;
1696 }
1697
1698 wxPoint GetPosition() const
1699 { return wxPoint(m_x, m_y); }
1700
1701 // Get X position
1702 wxCoord GetX() const;
1703
1704 // Get Y position
1705 wxCoord GetY() const;
1706
1707 // Can be called from wxEVT_CHAR_HOOK handler to allow generation of normal
1708 // key events even though the event had been handled (by default they would
1709 // not be generated in this case).
1710 void DoAllowNextEvent() { m_allowNext = true; }
1711
1712 // Return the value of the "allow next" flag, for internal use only.
1713 bool IsNextEventAllowed() const { return m_allowNext; }
1714
1715
1716 virtual wxEvent *Clone() const { return new wxKeyEvent(*this); }
1717 virtual wxEventCategory GetEventCategory() const { return wxEVT_CATEGORY_USER_INPUT; }
1718
1719 // we do need to copy wxKeyEvent sometimes (in wxTreeCtrl code, for
1720 // example)
1721 wxKeyEvent& operator=(const wxKeyEvent& evt)
1722 {
1723 if ( &evt != this )
1724 {
1725 wxEvent::operator=(evt);
1726
1727 // Borland C++ 5.82 doesn't compile an explicit call to an
1728 // implicitly defined operator=() so need to do it this way:
1729 *static_cast<wxKeyboardState *>(this) = evt;
1730
1731 DoAssignMembers(evt);
1732 }
1733 return *this;
1734 }
1735
1736 public:
1737 wxCoord m_x, m_y;
1738
1739 long m_keyCode;
1740
1741 #if wxUSE_UNICODE
1742 // This contains the full Unicode character
1743 // in a character events in Unicode mode
1744 wxChar m_uniChar;
1745 #endif
1746
1747 // these fields contain the platform-specific information about
1748 // key that was pressed
1749 wxUint32 m_rawCode;
1750 wxUint32 m_rawFlags;
1751
1752 private:
1753 // Set the event to propagate if necessary, i.e. if it's of wxEVT_CHAR_HOOK
1754 // type. This is used by all ctors.
1755 void InitPropagation()
1756 {
1757 if ( m_eventType == wxEVT_CHAR_HOOK )
1758 m_propagationLevel = wxEVENT_PROPAGATE_MAX;
1759
1760 m_allowNext = false;
1761 }
1762
1763 // Copy only the event data present in this class, this is used by
1764 // AssignKeyData() and copy ctor.
1765 void DoAssignMembers(const wxKeyEvent& evt)
1766 {
1767 m_x = evt.m_x;
1768 m_y = evt.m_y;
1769 m_hasPosition = evt.m_hasPosition;
1770
1771 m_keyCode = evt.m_keyCode;
1772
1773 m_rawCode = evt.m_rawCode;
1774 m_rawFlags = evt.m_rawFlags;
1775 #if wxUSE_UNICODE
1776 m_uniChar = evt.m_uniChar;
1777 #endif
1778 }
1779
1780 // Initialize m_x and m_y using the current mouse cursor position if
1781 // necessary.
1782 void InitPositionIfNecessary() const;
1783
1784 // If this flag is true, the normal key events should still be generated
1785 // even if wxEVT_CHAR_HOOK had been handled. By default it is false as
1786 // handling wxEVT_CHAR_HOOK suppresses all the subsequent events.
1787 bool m_allowNext;
1788
1789 // If true, m_x and m_y were already initialized. If false, try to get them
1790 // when they're requested.
1791 bool m_hasPosition;
1792
1793 DECLARE_DYNAMIC_CLASS(wxKeyEvent)
1794 };
1795
1796 // Size event class
1797 /*
1798 wxEVT_SIZE
1799 */
1800
1801 class WXDLLIMPEXP_CORE wxSizeEvent : public wxEvent
1802 {
1803 public:
1804 wxSizeEvent() : wxEvent(0, wxEVT_SIZE)
1805 { }
1806 wxSizeEvent(const wxSize& sz, int winid = 0)
1807 : wxEvent(winid, wxEVT_SIZE),
1808 m_size(sz)
1809 { }
1810 wxSizeEvent(const wxSizeEvent& event)
1811 : wxEvent(event),
1812 m_size(event.m_size), m_rect(event.m_rect)
1813 { }
1814 wxSizeEvent(const wxRect& rect, int id = 0)
1815 : m_size(rect.GetSize()), m_rect(rect)
1816 { m_eventType = wxEVT_SIZING; m_id = id; }
1817
1818 wxSize GetSize() const { return m_size; }
1819 void SetSize(wxSize size) { m_size = size; }
1820 wxRect GetRect() const { return m_rect; }
1821 void SetRect(const wxRect& rect) { m_rect = rect; }
1822
1823 virtual wxEvent *Clone() const { return new wxSizeEvent(*this); }
1824
1825 public:
1826 // For internal usage only. Will be converted to protected members.
1827 wxSize m_size;
1828 wxRect m_rect; // Used for wxEVT_SIZING
1829
1830 private:
1831 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSizeEvent)
1832 };
1833
1834 // Move event class
1835
1836 /*
1837 wxEVT_MOVE
1838 */
1839
1840 class WXDLLIMPEXP_CORE wxMoveEvent : public wxEvent
1841 {
1842 public:
1843 wxMoveEvent()
1844 : wxEvent(0, wxEVT_MOVE)
1845 { }
1846 wxMoveEvent(const wxPoint& pos, int winid = 0)
1847 : wxEvent(winid, wxEVT_MOVE),
1848 m_pos(pos)
1849 { }
1850 wxMoveEvent(const wxMoveEvent& event)
1851 : wxEvent(event),
1852 m_pos(event.m_pos)
1853 { }
1854 wxMoveEvent(const wxRect& rect, int id = 0)
1855 : m_pos(rect.GetPosition()), m_rect(rect)
1856 { m_eventType = wxEVT_MOVING; m_id = id; }
1857
1858 wxPoint GetPosition() const { return m_pos; }
1859 void SetPosition(const wxPoint& pos) { m_pos = pos; }
1860 wxRect GetRect() const { return m_rect; }
1861 void SetRect(const wxRect& rect) { m_rect = rect; }
1862
1863 virtual wxEvent *Clone() const { return new wxMoveEvent(*this); }
1864
1865 protected:
1866 wxPoint m_pos;
1867 wxRect m_rect;
1868
1869 private:
1870 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMoveEvent)
1871 };
1872
1873 // Paint event class
1874 /*
1875 wxEVT_PAINT
1876 wxEVT_NC_PAINT
1877 */
1878
1879 #if wxDEBUG_LEVEL && (defined(__WXMSW__) || defined(__WXPM__))
1880 #define wxHAS_PAINT_DEBUG
1881
1882 // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined
1883 extern WXDLLIMPEXP_CORE int g_isPainting;
1884 #endif // debug
1885
1886 class WXDLLIMPEXP_CORE wxPaintEvent : public wxEvent
1887 {
1888 public:
1889 wxPaintEvent(int Id = 0)
1890 : wxEvent(Id, wxEVT_PAINT)
1891 {
1892 #ifdef wxHAS_PAINT_DEBUG
1893 // set the internal flag for the duration of redrawing
1894 g_isPainting++;
1895 #endif // debug
1896 }
1897
1898 // default copy ctor and dtor are normally fine, we only need them to keep
1899 // g_isPainting updated in debug build
1900 #ifdef wxHAS_PAINT_DEBUG
1901 wxPaintEvent(const wxPaintEvent& event)
1902 : wxEvent(event)
1903 {
1904 g_isPainting++;
1905 }
1906
1907 virtual ~wxPaintEvent()
1908 {
1909 g_isPainting--;
1910 }
1911 #endif // debug
1912
1913 virtual wxEvent *Clone() const { return new wxPaintEvent(*this); }
1914
1915 private:
1916 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaintEvent)
1917 };
1918
1919 class WXDLLIMPEXP_CORE wxNcPaintEvent : public wxEvent
1920 {
1921 public:
1922 wxNcPaintEvent(int winid = 0)
1923 : wxEvent(winid, wxEVT_NC_PAINT)
1924 { }
1925
1926 virtual wxEvent *Clone() const { return new wxNcPaintEvent(*this); }
1927
1928 private:
1929 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNcPaintEvent)
1930 };
1931
1932 // Erase background event class
1933 /*
1934 wxEVT_ERASE_BACKGROUND
1935 */
1936
1937 class WXDLLIMPEXP_CORE wxEraseEvent : public wxEvent
1938 {
1939 public:
1940 wxEraseEvent(int Id = 0, wxDC *dc = NULL)
1941 : wxEvent(Id, wxEVT_ERASE_BACKGROUND),
1942 m_dc(dc)
1943 { }
1944
1945 wxEraseEvent(const wxEraseEvent& event)
1946 : wxEvent(event),
1947 m_dc(event.m_dc)
1948 { }
1949
1950 wxDC *GetDC() const { return m_dc; }
1951
1952 virtual wxEvent *Clone() const { return new wxEraseEvent(*this); }
1953
1954 protected:
1955 wxDC *m_dc;
1956
1957 private:
1958 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxEraseEvent)
1959 };
1960
1961 // Focus event class
1962 /*
1963 wxEVT_SET_FOCUS
1964 wxEVT_KILL_FOCUS
1965 */
1966
1967 class WXDLLIMPEXP_CORE wxFocusEvent : public wxEvent
1968 {
1969 public:
1970 wxFocusEvent(wxEventType type = wxEVT_NULL, int winid = 0)
1971 : wxEvent(winid, type)
1972 { m_win = NULL; }
1973
1974 wxFocusEvent(const wxFocusEvent& event)
1975 : wxEvent(event)
1976 { m_win = event.m_win; }
1977
1978 // The window associated with this event is the window which had focus
1979 // before for SET event and the window which will have focus for the KILL
1980 // one. NB: it may be NULL in both cases!
1981 wxWindow *GetWindow() const { return m_win; }
1982 void SetWindow(wxWindow *win) { m_win = win; }
1983
1984 virtual wxEvent *Clone() const { return new wxFocusEvent(*this); }
1985
1986 private:
1987 wxWindow *m_win;
1988
1989 private:
1990 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFocusEvent)
1991 };
1992
1993 // wxChildFocusEvent notifies the parent that a child has got the focus: unlike
1994 // wxFocusEvent it is propagated upwards the window chain
1995 class WXDLLIMPEXP_CORE wxChildFocusEvent : public wxCommandEvent
1996 {
1997 public:
1998 wxChildFocusEvent(wxWindow *win = NULL);
1999
2000 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
2001
2002 virtual wxEvent *Clone() const { return new wxChildFocusEvent(*this); }
2003
2004 private:
2005 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxChildFocusEvent)
2006 };
2007
2008 // Activate event class
2009 /*
2010 wxEVT_ACTIVATE
2011 wxEVT_ACTIVATE_APP
2012 wxEVT_HIBERNATE
2013 */
2014
2015 class WXDLLIMPEXP_CORE wxActivateEvent : public wxEvent
2016 {
2017 public:
2018 wxActivateEvent(wxEventType type = wxEVT_NULL, bool active = true, int Id = 0)
2019 : wxEvent(Id, type)
2020 { m_active = active; }
2021 wxActivateEvent(const wxActivateEvent& event)
2022 : wxEvent(event)
2023 { m_active = event.m_active; }
2024
2025 bool GetActive() const { return m_active; }
2026
2027 virtual wxEvent *Clone() const { return new wxActivateEvent(*this); }
2028
2029 private:
2030 bool m_active;
2031
2032 private:
2033 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxActivateEvent)
2034 };
2035
2036 // InitDialog event class
2037 /*
2038 wxEVT_INIT_DIALOG
2039 */
2040
2041 class WXDLLIMPEXP_CORE wxInitDialogEvent : public wxEvent
2042 {
2043 public:
2044 wxInitDialogEvent(int Id = 0)
2045 : wxEvent(Id, wxEVT_INIT_DIALOG)
2046 { }
2047
2048 virtual wxEvent *Clone() const { return new wxInitDialogEvent(*this); }
2049
2050 private:
2051 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxInitDialogEvent)
2052 };
2053
2054 // Miscellaneous menu event class
2055 /*
2056 wxEVT_MENU_OPEN,
2057 wxEVT_MENU_CLOSE,
2058 wxEVT_MENU_HIGHLIGHT,
2059 */
2060
2061 class WXDLLIMPEXP_CORE wxMenuEvent : public wxEvent
2062 {
2063 public:
2064 wxMenuEvent(wxEventType type = wxEVT_NULL, int winid = 0, wxMenu* menu = NULL)
2065 : wxEvent(winid, type)
2066 { m_menuId = winid; m_menu = menu; }
2067 wxMenuEvent(const wxMenuEvent& event)
2068 : wxEvent(event)
2069 { m_menuId = event.m_menuId; m_menu = event.m_menu; }
2070
2071 // only for wxEVT_MENU_HIGHLIGHT
2072 int GetMenuId() const { return m_menuId; }
2073
2074 // only for wxEVT_MENU_OPEN/CLOSE
2075 bool IsPopup() const { return m_menuId == wxID_ANY; }
2076
2077 // only for wxEVT_MENU_OPEN/CLOSE
2078 wxMenu* GetMenu() const { return m_menu; }
2079
2080 virtual wxEvent *Clone() const { return new wxMenuEvent(*this); }
2081
2082 private:
2083 int m_menuId;
2084 wxMenu* m_menu;
2085
2086 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMenuEvent)
2087 };
2088
2089 // Window close or session close event class
2090 /*
2091 wxEVT_CLOSE_WINDOW,
2092 wxEVT_END_SESSION,
2093 wxEVT_QUERY_END_SESSION
2094 */
2095
2096 class WXDLLIMPEXP_CORE wxCloseEvent : public wxEvent
2097 {
2098 public:
2099 wxCloseEvent(wxEventType type = wxEVT_NULL, int winid = 0)
2100 : wxEvent(winid, type),
2101 m_loggingOff(true),
2102 m_veto(false), // should be false by default
2103 m_canVeto(true) {}
2104
2105 wxCloseEvent(const wxCloseEvent& event)
2106 : wxEvent(event),
2107 m_loggingOff(event.m_loggingOff),
2108 m_veto(event.m_veto),
2109 m_canVeto(event.m_canVeto) {}
2110
2111 void SetLoggingOff(bool logOff) { m_loggingOff = logOff; }
2112 bool GetLoggingOff() const
2113 {
2114 // m_loggingOff flag is only used by wxEVT_[QUERY_]END_SESSION, it
2115 // doesn't make sense for wxEVT_CLOSE_WINDOW
2116 wxASSERT_MSG( m_eventType != wxEVT_CLOSE_WINDOW,
2117 wxT("this flag is for end session events only") );
2118
2119 return m_loggingOff;
2120 }
2121
2122 void Veto(bool veto = true)
2123 {
2124 // GetVeto() will return false anyhow...
2125 wxCHECK_RET( m_canVeto,
2126 wxT("call to Veto() ignored (can't veto this event)") );
2127
2128 m_veto = veto;
2129 }
2130 void SetCanVeto(bool canVeto) { m_canVeto = canVeto; }
2131 bool CanVeto() const { return m_canVeto; }
2132 bool GetVeto() const { return m_canVeto && m_veto; }
2133
2134 virtual wxEvent *Clone() const { return new wxCloseEvent(*this); }
2135
2136 protected:
2137 bool m_loggingOff,
2138 m_veto,
2139 m_canVeto;
2140
2141 private:
2142 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCloseEvent)
2143 };
2144
2145 /*
2146 wxEVT_SHOW
2147 */
2148
2149 class WXDLLIMPEXP_CORE wxShowEvent : public wxEvent
2150 {
2151 public:
2152 wxShowEvent(int winid = 0, bool show = false)
2153 : wxEvent(winid, wxEVT_SHOW)
2154 { m_show = show; }
2155 wxShowEvent(const wxShowEvent& event)
2156 : wxEvent(event)
2157 { m_show = event.m_show; }
2158
2159 void SetShow(bool show) { m_show = show; }
2160
2161 // return true if the window was shown, false if hidden
2162 bool IsShown() const { return m_show; }
2163
2164 #if WXWIN_COMPATIBILITY_2_8
2165 wxDEPRECATED( bool GetShow() const { return IsShown(); } )
2166 #endif
2167
2168 virtual wxEvent *Clone() const { return new wxShowEvent(*this); }
2169
2170 protected:
2171 bool m_show;
2172
2173 private:
2174 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxShowEvent)
2175 };
2176
2177 /*
2178 wxEVT_ICONIZE
2179 */
2180
2181 class WXDLLIMPEXP_CORE wxIconizeEvent : public wxEvent
2182 {
2183 public:
2184 wxIconizeEvent(int winid = 0, bool iconized = true)
2185 : wxEvent(winid, wxEVT_ICONIZE)
2186 { m_iconized = iconized; }
2187 wxIconizeEvent(const wxIconizeEvent& event)
2188 : wxEvent(event)
2189 { m_iconized = event.m_iconized; }
2190
2191 #if WXWIN_COMPATIBILITY_2_8
2192 wxDEPRECATED( bool Iconized() const { return IsIconized(); } )
2193 #endif
2194 // return true if the frame was iconized, false if restored
2195 bool IsIconized() const { return m_iconized; }
2196
2197 virtual wxEvent *Clone() const { return new wxIconizeEvent(*this); }
2198
2199 protected:
2200 bool m_iconized;
2201
2202 private:
2203 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIconizeEvent)
2204 };
2205 /*
2206 wxEVT_MAXIMIZE
2207 */
2208
2209 class WXDLLIMPEXP_CORE wxMaximizeEvent : public wxEvent
2210 {
2211 public:
2212 wxMaximizeEvent(int winid = 0)
2213 : wxEvent(winid, wxEVT_MAXIMIZE)
2214 { }
2215
2216 virtual wxEvent *Clone() const { return new wxMaximizeEvent(*this); }
2217
2218 private:
2219 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMaximizeEvent)
2220 };
2221
2222 // Joystick event class
2223 /*
2224 wxEVT_JOY_BUTTON_DOWN,
2225 wxEVT_JOY_BUTTON_UP,
2226 wxEVT_JOY_MOVE,
2227 wxEVT_JOY_ZMOVE
2228 */
2229
2230 // Which joystick? Same as Windows ids so no conversion necessary.
2231 enum
2232 {
2233 wxJOYSTICK1,
2234 wxJOYSTICK2
2235 };
2236
2237 // Which button is down?
2238 enum
2239 {
2240 wxJOY_BUTTON_ANY = -1,
2241 wxJOY_BUTTON1 = 1,
2242 wxJOY_BUTTON2 = 2,
2243 wxJOY_BUTTON3 = 4,
2244 wxJOY_BUTTON4 = 8
2245 };
2246
2247 class WXDLLIMPEXP_CORE wxJoystickEvent : public wxEvent
2248 {
2249 protected:
2250 wxPoint m_pos;
2251 int m_zPosition;
2252 int m_buttonChange; // Which button changed?
2253 int m_buttonState; // Which buttons are down?
2254 int m_joyStick; // Which joystick?
2255
2256 public:
2257 wxJoystickEvent(wxEventType type = wxEVT_NULL,
2258 int state = 0,
2259 int joystick = wxJOYSTICK1,
2260 int change = 0)
2261 : wxEvent(0, type),
2262 m_pos(),
2263 m_zPosition(0),
2264 m_buttonChange(change),
2265 m_buttonState(state),
2266 m_joyStick(joystick)
2267 {
2268 }
2269 wxJoystickEvent(const wxJoystickEvent& event)
2270 : wxEvent(event),
2271 m_pos(event.m_pos),
2272 m_zPosition(event.m_zPosition),
2273 m_buttonChange(event.m_buttonChange),
2274 m_buttonState(event.m_buttonState),
2275 m_joyStick(event.m_joyStick)
2276 { }
2277
2278 wxPoint GetPosition() const { return m_pos; }
2279 int GetZPosition() const { return m_zPosition; }
2280 int GetButtonState() const { return m_buttonState; }
2281 int GetButtonChange() const { return m_buttonChange; }
2282 int GetJoystick() const { return m_joyStick; }
2283
2284 void SetJoystick(int stick) { m_joyStick = stick; }
2285 void SetButtonState(int state) { m_buttonState = state; }
2286 void SetButtonChange(int change) { m_buttonChange = change; }
2287 void SetPosition(const wxPoint& pos) { m_pos = pos; }
2288 void SetZPosition(int zPos) { m_zPosition = zPos; }
2289
2290 // Was it a button event? (*doesn't* mean: is any button *down*?)
2291 bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) ||
2292 (GetEventType() == wxEVT_JOY_BUTTON_UP)); }
2293
2294 // Was it a move event?
2295 bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE); }
2296
2297 // Was it a zmove event?
2298 bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE); }
2299
2300 // Was it a down event from button 1, 2, 3, 4 or any?
2301 bool ButtonDown(int but = wxJOY_BUTTON_ANY) const
2302 { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) &&
2303 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
2304
2305 // Was it a up event from button 1, 2, 3 or any?
2306 bool ButtonUp(int but = wxJOY_BUTTON_ANY) const
2307 { return ((GetEventType() == wxEVT_JOY_BUTTON_UP) &&
2308 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
2309
2310 // Was the given button 1,2,3,4 or any in Down state?
2311 bool ButtonIsDown(int but = wxJOY_BUTTON_ANY) const
2312 { return (((but == wxJOY_BUTTON_ANY) && (m_buttonState != 0)) ||
2313 ((m_buttonState & but) == but)); }
2314
2315 virtual wxEvent *Clone() const { return new wxJoystickEvent(*this); }
2316
2317 private:
2318 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxJoystickEvent)
2319 };
2320
2321 // Drop files event class
2322 /*
2323 wxEVT_DROP_FILES
2324 */
2325
2326 class WXDLLIMPEXP_CORE wxDropFilesEvent : public wxEvent
2327 {
2328 public:
2329 int m_noFiles;
2330 wxPoint m_pos;
2331 wxString* m_files;
2332
2333 wxDropFilesEvent(wxEventType type = wxEVT_NULL,
2334 int noFiles = 0,
2335 wxString *files = NULL)
2336 : wxEvent(0, type),
2337 m_noFiles(noFiles),
2338 m_pos(),
2339 m_files(files)
2340 { }
2341
2342 // we need a copy ctor to avoid deleting m_files pointer twice
2343 wxDropFilesEvent(const wxDropFilesEvent& other)
2344 : wxEvent(other),
2345 m_noFiles(other.m_noFiles),
2346 m_pos(other.m_pos),
2347 m_files(NULL)
2348 {
2349 m_files = new wxString[m_noFiles];
2350 for ( int n = 0; n < m_noFiles; n++ )
2351 {
2352 m_files[n] = other.m_files[n];
2353 }
2354 }
2355
2356 virtual ~wxDropFilesEvent()
2357 {
2358 delete [] m_files;
2359 }
2360
2361 wxPoint GetPosition() const { return m_pos; }
2362 int GetNumberOfFiles() const { return m_noFiles; }
2363 wxString *GetFiles() const { return m_files; }
2364
2365 virtual wxEvent *Clone() const { return new wxDropFilesEvent(*this); }
2366
2367 private:
2368 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDropFilesEvent)
2369 };
2370
2371 // Update UI event
2372 /*
2373 wxEVT_UPDATE_UI
2374 */
2375
2376 // Whether to always send update events to windows, or
2377 // to only send update events to those with the
2378 // wxWS_EX_PROCESS_UI_UPDATES style.
2379
2380 enum wxUpdateUIMode
2381 {
2382 // Send UI update events to all windows
2383 wxUPDATE_UI_PROCESS_ALL,
2384
2385 // Send UI update events to windows that have
2386 // the wxWS_EX_PROCESS_UI_UPDATES flag specified
2387 wxUPDATE_UI_PROCESS_SPECIFIED
2388 };
2389
2390 class WXDLLIMPEXP_CORE wxUpdateUIEvent : public wxCommandEvent
2391 {
2392 public:
2393 wxUpdateUIEvent(wxWindowID commandId = 0)
2394 : wxCommandEvent(wxEVT_UPDATE_UI, commandId)
2395 {
2396 m_checked =
2397 m_enabled =
2398 m_shown =
2399 m_setEnabled =
2400 m_setShown =
2401 m_setText =
2402 m_setChecked = false;
2403 }
2404 wxUpdateUIEvent(const wxUpdateUIEvent& event)
2405 : wxCommandEvent(event),
2406 m_checked(event.m_checked),
2407 m_enabled(event.m_enabled),
2408 m_shown(event.m_shown),
2409 m_setEnabled(event.m_setEnabled),
2410 m_setShown(event.m_setShown),
2411 m_setText(event.m_setText),
2412 m_setChecked(event.m_setChecked),
2413 m_text(event.m_text)
2414 { }
2415
2416 bool GetChecked() const { return m_checked; }
2417 bool GetEnabled() const { return m_enabled; }
2418 bool GetShown() const { return m_shown; }
2419 wxString GetText() const { return m_text; }
2420 bool GetSetText() const { return m_setText; }
2421 bool GetSetChecked() const { return m_setChecked; }
2422 bool GetSetEnabled() const { return m_setEnabled; }
2423 bool GetSetShown() const { return m_setShown; }
2424
2425 void Check(bool check) { m_checked = check; m_setChecked = true; }
2426 void Enable(bool enable) { m_enabled = enable; m_setEnabled = true; }
2427 void Show(bool show) { m_shown = show; m_setShown = true; }
2428 void SetText(const wxString& text) { m_text = text; m_setText = true; }
2429
2430 // Sets the interval between updates in milliseconds.
2431 // Set to -1 to disable updates, or to 0 to update as frequently as possible.
2432 static void SetUpdateInterval(long updateInterval) { sm_updateInterval = updateInterval; }
2433
2434 // Returns the current interval between updates in milliseconds
2435 static long GetUpdateInterval() { return sm_updateInterval; }
2436
2437 // Can we update this window?
2438 static bool CanUpdate(wxWindowBase *win);
2439
2440 // Reset the update time to provide a delay until the next
2441 // time we should update
2442 static void ResetUpdateTime();
2443
2444 // Specify how wxWidgets will send update events: to
2445 // all windows, or only to those which specify that they
2446 // will process the events.
2447 static void SetMode(wxUpdateUIMode mode) { sm_updateMode = mode; }
2448
2449 // Returns the UI update mode
2450 static wxUpdateUIMode GetMode() { return sm_updateMode; }
2451
2452 virtual wxEvent *Clone() const { return new wxUpdateUIEvent(*this); }
2453
2454 protected:
2455 bool m_checked;
2456 bool m_enabled;
2457 bool m_shown;
2458 bool m_setEnabled;
2459 bool m_setShown;
2460 bool m_setText;
2461 bool m_setChecked;
2462 wxString m_text;
2463 #if wxUSE_LONGLONG
2464 static wxLongLong sm_lastUpdate;
2465 #endif
2466 static long sm_updateInterval;
2467 static wxUpdateUIMode sm_updateMode;
2468
2469 private:
2470 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxUpdateUIEvent)
2471 };
2472
2473 /*
2474 wxEVT_SYS_COLOUR_CHANGED
2475 */
2476
2477 // TODO: shouldn't all events record the window ID?
2478 class WXDLLIMPEXP_CORE wxSysColourChangedEvent : public wxEvent
2479 {
2480 public:
2481 wxSysColourChangedEvent()
2482 : wxEvent(0, wxEVT_SYS_COLOUR_CHANGED)
2483 { }
2484
2485 virtual wxEvent *Clone() const { return new wxSysColourChangedEvent(*this); }
2486
2487 private:
2488 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSysColourChangedEvent)
2489 };
2490
2491 /*
2492 wxEVT_MOUSE_CAPTURE_CHANGED
2493 The window losing the capture receives this message
2494 (even if it released the capture itself).
2495 */
2496
2497 class WXDLLIMPEXP_CORE wxMouseCaptureChangedEvent : public wxEvent
2498 {
2499 public:
2500 wxMouseCaptureChangedEvent(wxWindowID winid = 0, wxWindow* gainedCapture = NULL)
2501 : wxEvent(winid, wxEVT_MOUSE_CAPTURE_CHANGED),
2502 m_gainedCapture(gainedCapture)
2503 { }
2504
2505 wxMouseCaptureChangedEvent(const wxMouseCaptureChangedEvent& event)
2506 : wxEvent(event),
2507 m_gainedCapture(event.m_gainedCapture)
2508 { }
2509
2510 virtual wxEvent *Clone() const { return new wxMouseCaptureChangedEvent(*this); }
2511
2512 wxWindow* GetCapturedWindow() const { return m_gainedCapture; }
2513
2514 private:
2515 wxWindow* m_gainedCapture;
2516
2517 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureChangedEvent)
2518 };
2519
2520 /*
2521 wxEVT_MOUSE_CAPTURE_LOST
2522 The window losing the capture receives this message, unless it released it
2523 it itself or unless wxWindow::CaptureMouse was called on another window
2524 (and so capture will be restored when the new capturer releases it).
2525 */
2526
2527 class WXDLLIMPEXP_CORE wxMouseCaptureLostEvent : public wxEvent
2528 {
2529 public:
2530 wxMouseCaptureLostEvent(wxWindowID winid = 0)
2531 : wxEvent(winid, wxEVT_MOUSE_CAPTURE_LOST)
2532 {}
2533
2534 wxMouseCaptureLostEvent(const wxMouseCaptureLostEvent& event)
2535 : wxEvent(event)
2536 {}
2537
2538 virtual wxEvent *Clone() const { return new wxMouseCaptureLostEvent(*this); }
2539
2540 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureLostEvent)
2541 };
2542
2543 /*
2544 wxEVT_DISPLAY_CHANGED
2545 */
2546 class WXDLLIMPEXP_CORE wxDisplayChangedEvent : public wxEvent
2547 {
2548 private:
2549 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDisplayChangedEvent)
2550
2551 public:
2552 wxDisplayChangedEvent()
2553 : wxEvent(0, wxEVT_DISPLAY_CHANGED)
2554 { }
2555
2556 virtual wxEvent *Clone() const { return new wxDisplayChangedEvent(*this); }
2557 };
2558
2559 /*
2560 wxEVT_PALETTE_CHANGED
2561 */
2562
2563 class WXDLLIMPEXP_CORE wxPaletteChangedEvent : public wxEvent
2564 {
2565 public:
2566 wxPaletteChangedEvent(wxWindowID winid = 0)
2567 : wxEvent(winid, wxEVT_PALETTE_CHANGED),
2568 m_changedWindow(NULL)
2569 { }
2570
2571 wxPaletteChangedEvent(const wxPaletteChangedEvent& event)
2572 : wxEvent(event),
2573 m_changedWindow(event.m_changedWindow)
2574 { }
2575
2576 void SetChangedWindow(wxWindow* win) { m_changedWindow = win; }
2577 wxWindow* GetChangedWindow() const { return m_changedWindow; }
2578
2579 virtual wxEvent *Clone() const { return new wxPaletteChangedEvent(*this); }
2580
2581 protected:
2582 wxWindow* m_changedWindow;
2583
2584 private:
2585 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaletteChangedEvent)
2586 };
2587
2588 /*
2589 wxEVT_QUERY_NEW_PALETTE
2590 Indicates the window is getting keyboard focus and should re-do its palette.
2591 */
2592
2593 class WXDLLIMPEXP_CORE wxQueryNewPaletteEvent : public wxEvent
2594 {
2595 public:
2596 wxQueryNewPaletteEvent(wxWindowID winid = 0)
2597 : wxEvent(winid, wxEVT_QUERY_NEW_PALETTE),
2598 m_paletteRealized(false)
2599 { }
2600 wxQueryNewPaletteEvent(const wxQueryNewPaletteEvent& event)
2601 : wxEvent(event),
2602 m_paletteRealized(event.m_paletteRealized)
2603 { }
2604
2605 // App sets this if it changes the palette.
2606 void SetPaletteRealized(bool realized) { m_paletteRealized = realized; }
2607 bool GetPaletteRealized() const { return m_paletteRealized; }
2608
2609 virtual wxEvent *Clone() const { return new wxQueryNewPaletteEvent(*this); }
2610
2611 protected:
2612 bool m_paletteRealized;
2613
2614 private:
2615 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxQueryNewPaletteEvent)
2616 };
2617
2618 /*
2619 Event generated by dialog navigation keys
2620 wxEVT_NAVIGATION_KEY
2621 */
2622 // NB: don't derive from command event to avoid being propagated to the parent
2623 class WXDLLIMPEXP_CORE wxNavigationKeyEvent : public wxEvent
2624 {
2625 public:
2626 wxNavigationKeyEvent()
2627 : wxEvent(0, wxEVT_NAVIGATION_KEY),
2628 m_flags(IsForward | FromTab), // defaults are for TAB
2629 m_focus(NULL)
2630 {
2631 m_propagationLevel = wxEVENT_PROPAGATE_NONE;
2632 }
2633
2634 wxNavigationKeyEvent(const wxNavigationKeyEvent& event)
2635 : wxEvent(event),
2636 m_flags(event.m_flags),
2637 m_focus(event.m_focus)
2638 { }
2639
2640 // direction: forward (true) or backward (false)
2641 bool GetDirection() const
2642 { return (m_flags & IsForward) != 0; }
2643 void SetDirection(bool bForward)
2644 { if ( bForward ) m_flags |= IsForward; else m_flags &= ~IsForward; }
2645
2646 // it may be a window change event (MDI, notebook pages...) or a control
2647 // change event
2648 bool IsWindowChange() const
2649 { return (m_flags & WinChange) != 0; }
2650 void SetWindowChange(bool bIs)
2651 { if ( bIs ) m_flags |= WinChange; else m_flags &= ~WinChange; }
2652
2653 // Set to true under MSW if the event was generated using the tab key.
2654 // This is required for proper navogation over radio buttons
2655 bool IsFromTab() const
2656 { return (m_flags & FromTab) != 0; }
2657 void SetFromTab(bool bIs)
2658 { if ( bIs ) m_flags |= FromTab; else m_flags &= ~FromTab; }
2659
2660 // the child which has the focus currently (may be NULL - use
2661 // wxWindow::FindFocus then)
2662 wxWindow* GetCurrentFocus() const { return m_focus; }
2663 void SetCurrentFocus(wxWindow *win) { m_focus = win; }
2664
2665 // Set flags
2666 void SetFlags(long flags) { m_flags = flags; }
2667
2668 virtual wxEvent *Clone() const { return new wxNavigationKeyEvent(*this); }
2669
2670 enum wxNavigationKeyEventFlags
2671 {
2672 IsBackward = 0x0000,
2673 IsForward = 0x0001,
2674 WinChange = 0x0002,
2675 FromTab = 0x0004
2676 };
2677
2678 long m_flags;
2679 wxWindow *m_focus;
2680
2681 private:
2682 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNavigationKeyEvent)
2683 };
2684
2685 // Window creation/destruction events: the first is sent as soon as window is
2686 // created (i.e. the underlying GUI object exists), but when the C++ object is
2687 // fully initialized (so virtual functions may be called). The second,
2688 // wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
2689 // still safe to call virtual functions at this moment
2690 /*
2691 wxEVT_CREATE
2692 wxEVT_DESTROY
2693 */
2694
2695 class WXDLLIMPEXP_CORE wxWindowCreateEvent : public wxCommandEvent
2696 {
2697 public:
2698 wxWindowCreateEvent(wxWindow *win = NULL);
2699
2700 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
2701
2702 virtual wxEvent *Clone() const { return new wxWindowCreateEvent(*this); }
2703
2704 private:
2705 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowCreateEvent)
2706 };
2707
2708 class WXDLLIMPEXP_CORE wxWindowDestroyEvent : public wxCommandEvent
2709 {
2710 public:
2711 wxWindowDestroyEvent(wxWindow *win = NULL);
2712
2713 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
2714
2715 virtual wxEvent *Clone() const { return new wxWindowDestroyEvent(*this); }
2716
2717 private:
2718 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowDestroyEvent)
2719 };
2720
2721 // A help event is sent when the user clicks on a window in context-help mode.
2722 /*
2723 wxEVT_HELP
2724 wxEVT_DETAILED_HELP
2725 */
2726
2727 class WXDLLIMPEXP_CORE wxHelpEvent : public wxCommandEvent
2728 {
2729 public:
2730 // how was this help event generated?
2731 enum Origin
2732 {
2733 Origin_Unknown, // unrecognized event source
2734 Origin_Keyboard, // event generated from F1 key press
2735 Origin_HelpButton // event from [?] button on the title bar (Windows)
2736 };
2737
2738 wxHelpEvent(wxEventType type = wxEVT_NULL,
2739 wxWindowID winid = 0,
2740 const wxPoint& pt = wxDefaultPosition,
2741 Origin origin = Origin_Unknown)
2742 : wxCommandEvent(type, winid),
2743 m_pos(pt),
2744 m_origin(GuessOrigin(origin))
2745 { }
2746 wxHelpEvent(const wxHelpEvent& event)
2747 : wxCommandEvent(event),
2748 m_pos(event.m_pos),
2749 m_target(event.m_target),
2750 m_link(event.m_link),
2751 m_origin(event.m_origin)
2752 { }
2753
2754 // Position of event (in screen coordinates)
2755 const wxPoint& GetPosition() const { return m_pos; }
2756 void SetPosition(const wxPoint& pos) { m_pos = pos; }
2757
2758 // Optional link to further help
2759 const wxString& GetLink() const { return m_link; }
2760 void SetLink(const wxString& link) { m_link = link; }
2761
2762 // Optional target to display help in. E.g. a window specification
2763 const wxString& GetTarget() const { return m_target; }
2764 void SetTarget(const wxString& target) { m_target = target; }
2765
2766 virtual wxEvent *Clone() const { return new wxHelpEvent(*this); }
2767
2768 // optional indication of the event source
2769 Origin GetOrigin() const { return m_origin; }
2770 void SetOrigin(Origin origin) { m_origin = origin; }
2771
2772 protected:
2773 wxPoint m_pos;
2774 wxString m_target;
2775 wxString m_link;
2776 Origin m_origin;
2777
2778 // we can try to guess the event origin ourselves, even if none is
2779 // specified in the ctor
2780 static Origin GuessOrigin(Origin origin);
2781
2782 private:
2783 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHelpEvent)
2784 };
2785
2786 // A Clipboard Text event is sent when a window intercepts text copy/cut/paste
2787 // message, i.e. the user has cut/copied/pasted data from/into a text control
2788 // via ctrl-C/X/V, ctrl/shift-del/insert, a popup menu command, etc.
2789 // NOTE : under windows these events are *NOT* generated automatically
2790 // for a Rich Edit text control.
2791 /*
2792 wxEVT_COMMAND_TEXT_COPY
2793 wxEVT_COMMAND_TEXT_CUT
2794 wxEVT_COMMAND_TEXT_PASTE
2795 */
2796
2797 class WXDLLIMPEXP_CORE wxClipboardTextEvent : public wxCommandEvent
2798 {
2799 public:
2800 wxClipboardTextEvent(wxEventType type = wxEVT_NULL,
2801 wxWindowID winid = 0)
2802 : wxCommandEvent(type, winid)
2803 { }
2804 wxClipboardTextEvent(const wxClipboardTextEvent& event)
2805 : wxCommandEvent(event)
2806 { }
2807
2808 virtual wxEvent *Clone() const { return new wxClipboardTextEvent(*this); }
2809
2810 private:
2811 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxClipboardTextEvent)
2812 };
2813
2814 // A Context event is sent when the user right clicks on a window or
2815 // presses Shift-F10
2816 // NOTE : Under windows this is a repackaged WM_CONTETXMENU message
2817 // Under other systems it may have to be generated from a right click event
2818 /*
2819 wxEVT_CONTEXT_MENU
2820 */
2821
2822 class WXDLLIMPEXP_CORE wxContextMenuEvent : public wxCommandEvent
2823 {
2824 public:
2825 wxContextMenuEvent(wxEventType type = wxEVT_NULL,
2826 wxWindowID winid = 0,
2827 const wxPoint& pt = wxDefaultPosition)
2828 : wxCommandEvent(type, winid),
2829 m_pos(pt)
2830 { }
2831 wxContextMenuEvent(const wxContextMenuEvent& event)
2832 : wxCommandEvent(event),
2833 m_pos(event.m_pos)
2834 { }
2835
2836 // Position of event (in screen coordinates)
2837 const wxPoint& GetPosition() const { return m_pos; }
2838 void SetPosition(const wxPoint& pos) { m_pos = pos; }
2839
2840 virtual wxEvent *Clone() const { return new wxContextMenuEvent(*this); }
2841
2842 protected:
2843 wxPoint m_pos;
2844
2845 private:
2846 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxContextMenuEvent)
2847 };
2848
2849
2850 /* TODO
2851 wxEVT_MOUSE_CAPTURE_CHANGED,
2852 wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
2853 // wxEVT_FONT_CHANGED, // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
2854 // wxEVT_FONT_CHANGED to all other windows (maybe).
2855 wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
2856 wxEVT_MEASURE_ITEM,
2857 wxEVT_COMPARE_ITEM
2858 */
2859
2860 #endif // wxUSE_GUI
2861
2862
2863 // ============================================================================
2864 // event handler and related classes
2865 // ============================================================================
2866
2867
2868 // struct containing the members common to static and dynamic event tables
2869 // entries
2870 struct WXDLLIMPEXP_BASE wxEventTableEntryBase
2871 {
2872 wxEventTableEntryBase(int winid, int idLast,
2873 wxEventFunctor* fn, wxObject *data)
2874 : m_id(winid),
2875 m_lastId(idLast),
2876 m_fn(fn),
2877 m_callbackUserData(data)
2878 {
2879 wxASSERT_MSG( idLast == wxID_ANY || winid <= idLast,
2880 "invalid IDs range: lower bound > upper bound" );
2881 }
2882
2883 wxEventTableEntryBase( const wxEventTableEntryBase &entry )
2884 : m_id( entry.m_id ),
2885 m_lastId( entry.m_lastId ),
2886 m_fn( entry.m_fn ),
2887 m_callbackUserData( entry.m_callbackUserData )
2888 {
2889 // This is a 'hack' to ensure that only one instance tries to delete
2890 // the functor pointer. It is safe as long as the only place where the
2891 // copy constructor is being called is when the static event tables are
2892 // being initialized (a temporary instance is created and then this
2893 // constructor is called).
2894
2895 const_cast<wxEventTableEntryBase&>( entry ).m_fn = NULL;
2896 }
2897
2898 ~wxEventTableEntryBase()
2899 {
2900 delete m_fn;
2901 }
2902
2903 // the range of ids for this entry: if m_lastId == wxID_ANY, the range
2904 // consists only of m_id, otherwise it is m_id..m_lastId inclusive
2905 int m_id,
2906 m_lastId;
2907
2908 // function/method/functor to call
2909 wxEventFunctor* m_fn;
2910
2911 // arbitrary user data associated with the callback
2912 wxObject* m_callbackUserData;
2913
2914 private:
2915 wxDECLARE_NO_ASSIGN_CLASS(wxEventTableEntryBase);
2916 };
2917
2918 // an entry from a static event table
2919 struct WXDLLIMPEXP_BASE wxEventTableEntry : public wxEventTableEntryBase
2920 {
2921 wxEventTableEntry(const int& evType, int winid, int idLast,
2922 wxEventFunctor* fn, wxObject *data)
2923 : wxEventTableEntryBase(winid, idLast, fn, data),
2924 m_eventType(evType)
2925 { }
2926
2927 // the reference to event type: this allows us to not care about the
2928 // (undefined) order in which the event table entries and the event types
2929 // are initialized: initially the value of this reference might be
2930 // invalid, but by the time it is used for the first time, all global
2931 // objects will have been initialized (including the event type constants)
2932 // and so it will have the correct value when it is needed
2933 const int& m_eventType;
2934
2935 private:
2936 wxDECLARE_NO_ASSIGN_CLASS(wxEventTableEntry);
2937 };
2938
2939 // an entry used in dynamic event table managed by wxEvtHandler::Connect()
2940 struct WXDLLIMPEXP_BASE wxDynamicEventTableEntry : public wxEventTableEntryBase
2941 {
2942 wxDynamicEventTableEntry(int evType, int winid, int idLast,
2943 wxEventFunctor* fn, wxObject *data)
2944 : wxEventTableEntryBase(winid, idLast, fn, data),
2945 m_eventType(evType)
2946 { }
2947
2948 // not a reference here as we can't keep a reference to a temporary int
2949 // created to wrap the constant value typically passed to Connect() - nor
2950 // do we need it
2951 int m_eventType;
2952
2953 private:
2954 wxDECLARE_NO_ASSIGN_CLASS(wxDynamicEventTableEntry);
2955 };
2956
2957 // ----------------------------------------------------------------------------
2958 // wxEventTable: an array of event entries terminated with {0, 0, 0, 0, 0}
2959 // ----------------------------------------------------------------------------
2960
2961 struct WXDLLIMPEXP_BASE wxEventTable
2962 {
2963 const wxEventTable *baseTable; // base event table (next in chain)
2964 const wxEventTableEntry *entries; // bottom of entry array
2965 };
2966
2967 // ----------------------------------------------------------------------------
2968 // wxEventHashTable: a helper of wxEvtHandler to speed up wxEventTable lookups.
2969 // ----------------------------------------------------------------------------
2970
2971 WX_DEFINE_ARRAY_PTR(const wxEventTableEntry*, wxEventTableEntryPointerArray);
2972
2973 class WXDLLIMPEXP_BASE wxEventHashTable
2974 {
2975 private:
2976 // Internal data structs
2977 struct EventTypeTable
2978 {
2979 wxEventType eventType;
2980 wxEventTableEntryPointerArray eventEntryTable;
2981 };
2982 typedef EventTypeTable* EventTypeTablePointer;
2983
2984 public:
2985 // Constructor, needs the event table it needs to hash later on.
2986 // Note: hashing of the event table is not done in the constructor as it
2987 // can be that the event table is not yet full initialize, the hash
2988 // will gets initialized when handling the first event look-up request.
2989 wxEventHashTable(const wxEventTable &table);
2990 // Destructor.
2991 ~wxEventHashTable();
2992
2993 // Handle the given event, in other words search the event table hash
2994 // and call self->ProcessEvent() if a match was found.
2995 bool HandleEvent(wxEvent& event, wxEvtHandler *self);
2996
2997 // Clear table
2998 void Clear();
2999
3000 #if wxUSE_MEMORY_TRACING
3001 // Clear all tables: only used to work around problems in memory tracing
3002 // code
3003 static void ClearAll();
3004 #endif // wxUSE_MEMORY_TRACING
3005
3006 protected:
3007 // Init the hash table with the entries of the static event table.
3008 void InitHashTable();
3009 // Helper funtion of InitHashTable() to insert 1 entry into the hash table.
3010 void AddEntry(const wxEventTableEntry &entry);
3011 // Allocate and init with null pointers the base hash table.
3012 void AllocEventTypeTable(size_t size);
3013 // Grow the hash table in size and transfer all items currently
3014 // in the table to the correct location in the new table.
3015 void GrowEventTypeTable();
3016
3017 protected:
3018 const wxEventTable &m_table;
3019 bool m_rebuildHash;
3020
3021 size_t m_size;
3022 EventTypeTablePointer *m_eventTypeTable;
3023
3024 static wxEventHashTable* sm_first;
3025 wxEventHashTable* m_previous;
3026 wxEventHashTable* m_next;
3027
3028 wxDECLARE_NO_COPY_CLASS(wxEventHashTable);
3029 };
3030
3031 // ----------------------------------------------------------------------------
3032 // wxEvtHandler: the base class for all objects handling wxWidgets events
3033 // ----------------------------------------------------------------------------
3034
3035 class WXDLLIMPEXP_BASE wxEvtHandler : public wxObject
3036 , public wxTrackable
3037 {
3038 public:
3039 wxEvtHandler();
3040 virtual ~wxEvtHandler();
3041
3042
3043 // Event handler chain
3044 // -------------------
3045
3046 wxEvtHandler *GetNextHandler() const { return m_nextHandler; }
3047 wxEvtHandler *GetPreviousHandler() const { return m_previousHandler; }
3048 virtual void SetNextHandler(wxEvtHandler *handler) { m_nextHandler = handler; }
3049 virtual void SetPreviousHandler(wxEvtHandler *handler) { m_previousHandler = handler; }
3050
3051 void SetEvtHandlerEnabled(bool enabled) { m_enabled = enabled; }
3052 bool GetEvtHandlerEnabled() const { return m_enabled; }
3053
3054 void Unlink();
3055 bool IsUnlinked() const;
3056
3057
3058 // Global event filters
3059 // --------------------
3060
3061 // Add an event filter whose FilterEvent() method will be called for each
3062 // and every event processed by wxWidgets. The filters are called in LIFO
3063 // order and wxApp is registered as an event filter by default. The pointer
3064 // must remain valid until it's removed with RemoveFilter() and is not
3065 // deleted by wxEvtHandler.
3066 static void AddFilter(wxEventFilter* filter);
3067
3068 // Remove a filter previously installed with AddFilter().
3069 static void RemoveFilter(wxEventFilter* filter);
3070
3071
3072 // Event queuing and processing
3073 // ----------------------------
3074
3075 // Process an event right now: this can only be called from the main
3076 // thread, use QueueEvent() for scheduling the events for
3077 // processing from other threads.
3078 virtual bool ProcessEvent(wxEvent& event);
3079
3080 // Process an event by calling ProcessEvent and handling any exceptions
3081 // thrown by event handlers. It's mostly useful when processing wx events
3082 // when called from C code (e.g. in GTK+ callback) when the exception
3083 // wouldn't correctly propagate to wxEventLoop.
3084 bool SafelyProcessEvent(wxEvent& event);
3085 // NOTE: uses ProcessEvent()
3086
3087 // This method tries to process the event in this event handler, including
3088 // any preprocessing done by TryBefore() and all the handlers chained to
3089 // it, but excluding the post-processing done in TryAfter().
3090 //
3091 // It is meant to be called from ProcessEvent() only and is not virtual,
3092 // additional event handlers can be hooked into the normal event processing
3093 // logic using TryBefore() and TryAfter() hooks.
3094 //
3095 // You can also call it yourself to forward an event to another handler but
3096 // without propagating it upwards if it's unhandled (this is usually
3097 // unwanted when forwarding as the original handler would already do it if
3098 // needed normally).
3099 bool ProcessEventLocally(wxEvent& event);
3100
3101 // Schedule the given event to be processed later. It takes ownership of
3102 // the event pointer, i.e. it will be deleted later. This is safe to call
3103 // from multiple threads although you still need to ensure that wxString
3104 // fields of the event object are deep copies and not use the same string
3105 // buffer as other wxString objects in this thread.
3106 virtual void QueueEvent(wxEvent *event);
3107
3108 // Add an event to be processed later: notice that this function is not
3109 // safe to call from threads other than main, use QueueEvent()
3110 virtual void AddPendingEvent(const wxEvent& event)
3111 {
3112 // notice that the thread-safety problem comes from the fact that
3113 // Clone() doesn't make deep copies of wxString fields of wxEvent
3114 // object and so the same wxString could be used from both threads when
3115 // the event object is destroyed in this one -- QueueEvent() avoids
3116 // this problem as the event pointer is not used any more in this
3117 // thread at all after it is called.
3118 QueueEvent(event.Clone());
3119 }
3120
3121 void ProcessPendingEvents();
3122 // NOTE: uses ProcessEvent()
3123
3124 void DeletePendingEvents();
3125
3126 #if wxUSE_THREADS
3127 bool ProcessThreadEvent(const wxEvent& event);
3128 // NOTE: uses AddPendingEvent(); call only from secondary threads
3129 #endif
3130
3131
3132 // Connecting and disconnecting
3133 // ----------------------------
3134
3135 // These functions are used for old, untyped, event handlers and don't
3136 // check that the type of the function passed to them actually matches the
3137 // type of the event. They also only allow connecting events to methods of
3138 // wxEvtHandler-derived classes.
3139 //
3140 // The template Connect() methods below are safer and allow connecting
3141 // events to arbitrary functions or functors -- but require compiler
3142 // support for templates.
3143
3144 // Dynamic association of a member function handler with the event handler,
3145 // winid and event type
3146 void Connect(int winid,
3147 int lastId,
3148 wxEventType eventType,
3149 wxObjectEventFunction func,
3150 wxObject *userData = NULL,
3151 wxEvtHandler *eventSink = NULL)
3152 {
3153 DoBind(winid, lastId, eventType,
3154 wxNewEventFunctor(eventType, func, eventSink),
3155 userData);
3156 }
3157
3158 // Convenience function: take just one id
3159 void Connect(int winid,
3160 wxEventType eventType,
3161 wxObjectEventFunction func,
3162 wxObject *userData = NULL,
3163 wxEvtHandler *eventSink = NULL)
3164 { Connect(winid, wxID_ANY, eventType, func, userData, eventSink); }
3165
3166 // Even more convenient: without id (same as using id of wxID_ANY)
3167 void Connect(wxEventType eventType,
3168 wxObjectEventFunction func,
3169 wxObject *userData = NULL,
3170 wxEvtHandler *eventSink = NULL)
3171 { Connect(wxID_ANY, wxID_ANY, eventType, func, userData, eventSink); }
3172
3173 bool Disconnect(int winid,
3174 int lastId,
3175 wxEventType eventType,
3176 wxObjectEventFunction func = NULL,
3177 wxObject *userData = NULL,
3178 wxEvtHandler *eventSink = NULL)
3179 {
3180 return DoUnbind(winid, lastId, eventType,
3181 wxMakeEventFunctor(eventType, func, eventSink),
3182 userData );
3183 }
3184
3185 bool Disconnect(int winid = wxID_ANY,
3186 wxEventType eventType = wxEVT_NULL,
3187 wxObjectEventFunction func = NULL,
3188 wxObject *userData = NULL,
3189 wxEvtHandler *eventSink = NULL)
3190 { return Disconnect(winid, wxID_ANY, eventType, func, userData, eventSink); }
3191
3192 bool Disconnect(wxEventType eventType,
3193 wxObjectEventFunction func,
3194 wxObject *userData = NULL,
3195 wxEvtHandler *eventSink = NULL)
3196 { return Disconnect(wxID_ANY, eventType, func, userData, eventSink); }
3197
3198 #ifdef wxHAS_EVENT_BIND
3199 // Bind functions to an event:
3200 template <typename EventTag, typename EventArg>
3201 void Bind(const EventTag& eventType,
3202 void (*function)(EventArg &),
3203 int winid = wxID_ANY,
3204 int lastId = wxID_ANY,
3205 wxObject *userData = NULL)
3206 {
3207 DoBind(winid, lastId, eventType,
3208 wxNewEventFunctor(eventType, function),
3209 userData);
3210 }
3211
3212
3213 template <typename EventTag, typename EventArg>
3214 bool Unbind(const EventTag& eventType,
3215 void (*function)(EventArg &),
3216 int winid = wxID_ANY,
3217 int lastId = wxID_ANY,
3218 wxObject *userData = NULL)
3219 {
3220 return DoUnbind(winid, lastId, eventType,
3221 wxMakeEventFunctor(eventType, function),
3222 userData);
3223 }
3224
3225 // Bind functors to an event:
3226 template <typename EventTag, typename Functor>
3227 void Bind(const EventTag& eventType,
3228 const Functor &functor,
3229 int winid = wxID_ANY,
3230 int lastId = wxID_ANY,
3231 wxObject *userData = NULL)
3232 {
3233 DoBind(winid, lastId, eventType,
3234 wxNewEventFunctor(eventType, functor),
3235 userData);
3236 }
3237
3238
3239 template <typename EventTag, typename Functor>
3240 bool Unbind(const EventTag& eventType,
3241 const Functor &functor,
3242 int winid = wxID_ANY,
3243 int lastId = wxID_ANY,
3244 wxObject *userData = NULL)
3245 {
3246 return DoUnbind(winid, lastId, eventType,
3247 wxMakeEventFunctor(eventType, functor),
3248 userData);
3249 }
3250
3251
3252 // Bind a method of a class (called on the specified handler which must
3253 // be convertible to this class) object to an event:
3254
3255 template <typename EventTag, typename Class, typename EventArg, typename EventHandler>
3256 void Bind(const EventTag &eventType,
3257 void (Class::*method)(EventArg &),
3258 EventHandler *handler,
3259 int winid = wxID_ANY,
3260 int lastId = wxID_ANY,
3261 wxObject *userData = NULL)
3262 {
3263 DoBind(winid, lastId, eventType,
3264 wxNewEventFunctor(eventType, method, handler),
3265 userData);
3266 }
3267
3268 template <typename EventTag, typename Class, typename EventArg, typename EventHandler>
3269 bool Unbind(const EventTag &eventType,
3270 void (Class::*method)(EventArg&),
3271 EventHandler *handler,
3272 int winid = wxID_ANY,
3273 int lastId = wxID_ANY,
3274 wxObject *userData = NULL )
3275 {
3276 return DoUnbind(winid, lastId, eventType,
3277 wxMakeEventFunctor(eventType, method, handler),
3278 userData);
3279 }
3280 #endif // wxHAS_EVENT_BIND
3281
3282 wxList* GetDynamicEventTable() const { return m_dynamicEvents ; }
3283
3284 // User data can be associated with each wxEvtHandler
3285 void SetClientObject( wxClientData *data ) { DoSetClientObject(data); }
3286 wxClientData *GetClientObject() const { return DoGetClientObject(); }
3287
3288 void SetClientData( void *data ) { DoSetClientData(data); }
3289 void *GetClientData() const { return DoGetClientData(); }
3290
3291
3292 // implementation from now on
3293 // --------------------------
3294
3295 // check if the given event table entry matches this event by id (the check
3296 // for the event type should be done by caller) and call the handler if it
3297 // does
3298 //
3299 // return true if the event was processed, false otherwise (no match or the
3300 // handler decided to skip the event)
3301 static bool ProcessEventIfMatchesId(const wxEventTableEntryBase& tableEntry,
3302 wxEvtHandler *handler,
3303 wxEvent& event);
3304
3305 virtual bool SearchEventTable(wxEventTable& table, wxEvent& event);
3306 bool SearchDynamicEventTable( wxEvent& event );
3307
3308 // Avoid problems at exit by cleaning up static hash table gracefully
3309 void ClearEventHashTable() { GetEventHashTable().Clear(); }
3310 void OnSinkDestroyed( wxEvtHandler *sink );
3311
3312
3313 private:
3314 void DoBind(int winid,
3315 int lastId,
3316 wxEventType eventType,
3317 wxEventFunctor *func,
3318 wxObject* userData = NULL);
3319
3320 bool DoUnbind(int winid,
3321 int lastId,
3322 wxEventType eventType,
3323 const wxEventFunctor& func,
3324 wxObject *userData = NULL);
3325
3326 static const wxEventTableEntry sm_eventTableEntries[];
3327
3328 protected:
3329 // hooks for wxWindow used by ProcessEvent()
3330 // -----------------------------------------
3331
3332 // this one is called before trying our own event table to allow plugging
3333 // in the event handlers overriding the default logic, this is used by e.g.
3334 // validators.
3335 virtual bool TryBefore(wxEvent& event);
3336
3337 // This one is not a hook but just a helper which looks up the handler in
3338 // this object itself.
3339 //
3340 // It is called from ProcessEventLocally() and normally shouldn't be called
3341 // directly as doing it would ignore any chained event handlers
3342 bool TryHereOnly(wxEvent& event);
3343
3344 // Another helper which simply calls pre-processing hook and then tries to
3345 // handle the event at this handler level.
3346 bool TryBeforeAndHere(wxEvent& event)
3347 {
3348 return TryBefore(event) || TryHereOnly(event);
3349 }
3350
3351 // this one is called after failing to find the event handle in our own
3352 // table to give a chance to the other windows to process it
3353 //
3354 // base class implementation passes the event to wxTheApp
3355 virtual bool TryAfter(wxEvent& event);
3356
3357 #if WXWIN_COMPATIBILITY_2_8
3358 // deprecated method: override TryBefore() instead of this one
3359 wxDEPRECATED_BUT_USED_INTERNALLY_INLINE(
3360 virtual bool TryValidator(wxEvent& WXUNUSED(event)), return false; )
3361
3362 wxDEPRECATED_BUT_USED_INTERNALLY_INLINE(
3363 virtual bool TryParent(wxEvent& event), return DoTryApp(event); )
3364 #endif // WXWIN_COMPATIBILITY_2_8
3365
3366
3367 static const wxEventTable sm_eventTable;
3368 virtual const wxEventTable *GetEventTable() const;
3369
3370 static wxEventHashTable sm_eventHashTable;
3371 virtual wxEventHashTable& GetEventHashTable() const;
3372
3373 wxEvtHandler* m_nextHandler;
3374 wxEvtHandler* m_previousHandler;
3375 wxList* m_dynamicEvents;
3376 wxList* m_pendingEvents;
3377
3378 #if wxUSE_THREADS
3379 // critical section protecting m_pendingEvents
3380 wxCriticalSection m_pendingEventsLock;
3381 #endif // wxUSE_THREADS
3382
3383 // Is event handler enabled?
3384 bool m_enabled;
3385
3386
3387 // The user data: either an object which will be deleted by the container
3388 // when it's deleted or some raw pointer which we do nothing with - only
3389 // one type of data can be used with the given window (i.e. you cannot set
3390 // the void data and then associate the container with wxClientData or vice
3391 // versa)
3392 union
3393 {
3394 wxClientData *m_clientObject;
3395 void *m_clientData;
3396 };
3397
3398 // what kind of data do we have?
3399 wxClientDataType m_clientDataType;
3400
3401 // client data accessors
3402 virtual void DoSetClientObject( wxClientData *data );
3403 virtual wxClientData *DoGetClientObject() const;
3404
3405 virtual void DoSetClientData( void *data );
3406 virtual void *DoGetClientData() const;
3407
3408 // Search tracker objects for event connection with this sink
3409 wxEventConnectionRef *FindRefInTrackerList(wxEvtHandler *handler);
3410
3411 private:
3412 // pass the event to wxTheApp instance, called from TryAfter()
3413 bool DoTryApp(wxEvent& event);
3414
3415 // try to process events in all handlers chained to this one
3416 bool DoTryChain(wxEvent& event);
3417
3418 // Head of the event filter linked list.
3419 static wxEventFilter* ms_filterList;
3420
3421 DECLARE_DYNAMIC_CLASS_NO_COPY(wxEvtHandler)
3422 };
3423
3424 WX_DEFINE_ARRAY_WITH_DECL_PTR(wxEvtHandler *, wxEvtHandlerArray, class WXDLLIMPEXP_BASE);
3425
3426
3427 // Define an inline method of wxObjectEventFunctor which couldn't be defined
3428 // before wxEvtHandler declaration: at least Sun CC refuses to compile function
3429 // calls through pointer to member for forward-declared classes (see #12452).
3430 inline void wxObjectEventFunctor::operator()(wxEvtHandler *handler, wxEvent& event)
3431 {
3432 wxEvtHandler * const realHandler = m_handler ? m_handler : handler;
3433
3434 (realHandler->*m_method)(event);
3435 }
3436
3437 // ----------------------------------------------------------------------------
3438 // wxEventConnectionRef represents all connections between two event handlers
3439 // and enables automatic disconnect when an event handler sink goes out of
3440 // scope. Each connection/disconnect increases/decreases ref count, and
3441 // when it reaches zero the node goes out of scope.
3442 // ----------------------------------------------------------------------------
3443
3444 class wxEventConnectionRef : public wxTrackerNode
3445 {
3446 public:
3447 wxEventConnectionRef() : m_src(NULL), m_sink(NULL), m_refCount(0) { }
3448 wxEventConnectionRef(wxEvtHandler *src, wxEvtHandler *sink)
3449 : m_src(src), m_sink(sink), m_refCount(1)
3450 {
3451 m_sink->AddNode(this);
3452 }
3453
3454 // The sink is being destroyed
3455 virtual void OnObjectDestroy( )
3456 {
3457 if ( m_src )
3458 m_src->OnSinkDestroyed( m_sink );
3459 delete this;
3460 }
3461
3462 virtual wxEventConnectionRef *ToEventConnection() { return this; }
3463
3464 void IncRef() { m_refCount++; }
3465 void DecRef()
3466 {
3467 if ( !--m_refCount )
3468 {
3469 // The sink holds the only external pointer to this object
3470 if ( m_sink )
3471 m_sink->RemoveNode(this);
3472 delete this;
3473 }
3474 }
3475
3476 private:
3477 wxEvtHandler *m_src,
3478 *m_sink;
3479 int m_refCount;
3480
3481 friend class wxEvtHandler;
3482
3483 wxDECLARE_NO_ASSIGN_CLASS(wxEventConnectionRef);
3484 };
3485
3486 // Post a message to the given event handler which will be processed during the
3487 // next event loop iteration.
3488 //
3489 // Notice that this one is not thread-safe, use wxQueueEvent()
3490 inline void wxPostEvent(wxEvtHandler *dest, const wxEvent& event)
3491 {
3492 wxCHECK_RET( dest, "need an object to post event to" );
3493
3494 dest->AddPendingEvent(event);
3495 }
3496
3497 // Wrapper around wxEvtHandler::QueueEvent(): adds an event for later
3498 // processing, unlike wxPostEvent it is safe to use from different thread even
3499 // for events with wxString members
3500 inline void wxQueueEvent(wxEvtHandler *dest, wxEvent *event)
3501 {
3502 wxCHECK_RET( dest, "need an object to queue event for" );
3503
3504 dest->QueueEvent(event);
3505 }
3506
3507 typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&);
3508 typedef void (wxEvtHandler::*wxIdleEventFunction)(wxIdleEvent&);
3509 typedef void (wxEvtHandler::*wxThreadEventFunction)(wxThreadEvent&);
3510
3511 #define wxEventHandler(func) \
3512 wxEVENT_HANDLER_CAST(wxEventFunction, func)
3513 #define wxIdleEventHandler(func) \
3514 wxEVENT_HANDLER_CAST(wxIdleEventFunction, func)
3515 #define wxThreadEventHandler(func) \
3516 wxEVENT_HANDLER_CAST(wxThreadEventFunction, func)
3517
3518 #if wxUSE_GUI
3519
3520 // ----------------------------------------------------------------------------
3521 // wxEventBlocker: helper class to temporarily disable event handling for a window
3522 // ----------------------------------------------------------------------------
3523
3524 class WXDLLIMPEXP_CORE wxEventBlocker : public wxEvtHandler
3525 {
3526 public:
3527 wxEventBlocker(wxWindow *win, wxEventType type = wxEVT_ANY);
3528 virtual ~wxEventBlocker();
3529
3530 void Block(wxEventType type)
3531 {
3532 m_eventsToBlock.push_back(type);
3533 }
3534
3535 virtual bool ProcessEvent(wxEvent& event);
3536
3537 protected:
3538 wxArrayInt m_eventsToBlock;
3539 wxWindow *m_window;
3540
3541 wxDECLARE_NO_COPY_CLASS(wxEventBlocker);
3542 };
3543
3544 typedef void (wxEvtHandler::*wxCommandEventFunction)(wxCommandEvent&);
3545 typedef void (wxEvtHandler::*wxScrollEventFunction)(wxScrollEvent&);
3546 typedef void (wxEvtHandler::*wxScrollWinEventFunction)(wxScrollWinEvent&);
3547 typedef void (wxEvtHandler::*wxSizeEventFunction)(wxSizeEvent&);
3548 typedef void (wxEvtHandler::*wxMoveEventFunction)(wxMoveEvent&);
3549 typedef void (wxEvtHandler::*wxPaintEventFunction)(wxPaintEvent&);
3550 typedef void (wxEvtHandler::*wxNcPaintEventFunction)(wxNcPaintEvent&);
3551 typedef void (wxEvtHandler::*wxEraseEventFunction)(wxEraseEvent&);
3552 typedef void (wxEvtHandler::*wxMouseEventFunction)(wxMouseEvent&);
3553 typedef void (wxEvtHandler::*wxCharEventFunction)(wxKeyEvent&);
3554 typedef void (wxEvtHandler::*wxFocusEventFunction)(wxFocusEvent&);
3555 typedef void (wxEvtHandler::*wxChildFocusEventFunction)(wxChildFocusEvent&);
3556 typedef void (wxEvtHandler::*wxActivateEventFunction)(wxActivateEvent&);
3557 typedef void (wxEvtHandler::*wxMenuEventFunction)(wxMenuEvent&);
3558 typedef void (wxEvtHandler::*wxJoystickEventFunction)(wxJoystickEvent&);
3559 typedef void (wxEvtHandler::*wxDropFilesEventFunction)(wxDropFilesEvent&);
3560 typedef void (wxEvtHandler::*wxInitDialogEventFunction)(wxInitDialogEvent&);
3561 typedef void (wxEvtHandler::*wxSysColourChangedEventFunction)(wxSysColourChangedEvent&);
3562 typedef void (wxEvtHandler::*wxDisplayChangedEventFunction)(wxDisplayChangedEvent&);
3563 typedef void (wxEvtHandler::*wxUpdateUIEventFunction)(wxUpdateUIEvent&);
3564 typedef void (wxEvtHandler::*wxCloseEventFunction)(wxCloseEvent&);
3565 typedef void (wxEvtHandler::*wxShowEventFunction)(wxShowEvent&);
3566 typedef void (wxEvtHandler::*wxIconizeEventFunction)(wxIconizeEvent&);
3567 typedef void (wxEvtHandler::*wxMaximizeEventFunction)(wxMaximizeEvent&);
3568 typedef void (wxEvtHandler::*wxNavigationKeyEventFunction)(wxNavigationKeyEvent&);
3569 typedef void (wxEvtHandler::*wxPaletteChangedEventFunction)(wxPaletteChangedEvent&);
3570 typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction)(wxQueryNewPaletteEvent&);
3571 typedef void (wxEvtHandler::*wxWindowCreateEventFunction)(wxWindowCreateEvent&);
3572 typedef void (wxEvtHandler::*wxWindowDestroyEventFunction)(wxWindowDestroyEvent&);
3573 typedef void (wxEvtHandler::*wxSetCursorEventFunction)(wxSetCursorEvent&);
3574 typedef void (wxEvtHandler::*wxNotifyEventFunction)(wxNotifyEvent&);
3575 typedef void (wxEvtHandler::*wxHelpEventFunction)(wxHelpEvent&);
3576 typedef void (wxEvtHandler::*wxContextMenuEventFunction)(wxContextMenuEvent&);
3577 typedef void (wxEvtHandler::*wxMouseCaptureChangedEventFunction)(wxMouseCaptureChangedEvent&);
3578 typedef void (wxEvtHandler::*wxMouseCaptureLostEventFunction)(wxMouseCaptureLostEvent&);
3579 typedef void (wxEvtHandler::*wxClipboardTextEventFunction)(wxClipboardTextEvent&);
3580
3581
3582 #define wxCommandEventHandler(func) \
3583 wxEVENT_HANDLER_CAST(wxCommandEventFunction, func)
3584 #define wxScrollEventHandler(func) \
3585 wxEVENT_HANDLER_CAST(wxScrollEventFunction, func)
3586 #define wxScrollWinEventHandler(func) \
3587 wxEVENT_HANDLER_CAST(wxScrollWinEventFunction, func)
3588 #define wxSizeEventHandler(func) \
3589 wxEVENT_HANDLER_CAST(wxSizeEventFunction, func)
3590 #define wxMoveEventHandler(func) \
3591 wxEVENT_HANDLER_CAST(wxMoveEventFunction, func)
3592 #define wxPaintEventHandler(func) \
3593 wxEVENT_HANDLER_CAST(wxPaintEventFunction, func)
3594 #define wxNcPaintEventHandler(func) \
3595 wxEVENT_HANDLER_CAST(wxNcPaintEventFunction, func)
3596 #define wxEraseEventHandler(func) \
3597 wxEVENT_HANDLER_CAST(wxEraseEventFunction, func)
3598 #define wxMouseEventHandler(func) \
3599 wxEVENT_HANDLER_CAST(wxMouseEventFunction, func)
3600 #define wxCharEventHandler(func) \
3601 wxEVENT_HANDLER_CAST(wxCharEventFunction, func)
3602 #define wxKeyEventHandler(func) wxCharEventHandler(func)
3603 #define wxFocusEventHandler(func) \
3604 wxEVENT_HANDLER_CAST(wxFocusEventFunction, func)
3605 #define wxChildFocusEventHandler(func) \
3606 wxEVENT_HANDLER_CAST(wxChildFocusEventFunction, func)
3607 #define wxActivateEventHandler(func) \
3608 wxEVENT_HANDLER_CAST(wxActivateEventFunction, func)
3609 #define wxMenuEventHandler(func) \
3610 wxEVENT_HANDLER_CAST(wxMenuEventFunction, func)
3611 #define wxJoystickEventHandler(func) \
3612 wxEVENT_HANDLER_CAST(wxJoystickEventFunction, func)
3613 #define wxDropFilesEventHandler(func) \
3614 wxEVENT_HANDLER_CAST(wxDropFilesEventFunction, func)
3615 #define wxInitDialogEventHandler(func) \
3616 wxEVENT_HANDLER_CAST(wxInitDialogEventFunction, func)
3617 #define wxSysColourChangedEventHandler(func) \
3618 wxEVENT_HANDLER_CAST(wxSysColourChangedEventFunction, func)
3619 #define wxDisplayChangedEventHandler(func) \
3620 wxEVENT_HANDLER_CAST(wxDisplayChangedEventFunction, func)
3621 #define wxUpdateUIEventHandler(func) \
3622 wxEVENT_HANDLER_CAST(wxUpdateUIEventFunction, func)
3623 #define wxCloseEventHandler(func) \
3624 wxEVENT_HANDLER_CAST(wxCloseEventFunction, func)
3625 #define wxShowEventHandler(func) \
3626 wxEVENT_HANDLER_CAST(wxShowEventFunction, func)
3627 #define wxIconizeEventHandler(func) \
3628 wxEVENT_HANDLER_CAST(wxIconizeEventFunction, func)
3629 #define wxMaximizeEventHandler(func) \
3630 wxEVENT_HANDLER_CAST(wxMaximizeEventFunction, func)
3631 #define wxNavigationKeyEventHandler(func) \
3632 wxEVENT_HANDLER_CAST(wxNavigationKeyEventFunction, func)
3633 #define wxPaletteChangedEventHandler(func) \
3634 wxEVENT_HANDLER_CAST(wxPaletteChangedEventFunction, func)
3635 #define wxQueryNewPaletteEventHandler(func) \
3636 wxEVENT_HANDLER_CAST(wxQueryNewPaletteEventFunction, func)
3637 #define wxWindowCreateEventHandler(func) \
3638 wxEVENT_HANDLER_CAST(wxWindowCreateEventFunction, func)
3639 #define wxWindowDestroyEventHandler(func) \
3640 wxEVENT_HANDLER_CAST(wxWindowDestroyEventFunction, func)
3641 #define wxSetCursorEventHandler(func) \
3642 wxEVENT_HANDLER_CAST(wxSetCursorEventFunction, func)
3643 #define wxNotifyEventHandler(func) \
3644 wxEVENT_HANDLER_CAST(wxNotifyEventFunction, func)
3645 #define wxHelpEventHandler(func) \
3646 wxEVENT_HANDLER_CAST(wxHelpEventFunction, func)
3647 #define wxContextMenuEventHandler(func) \
3648 wxEVENT_HANDLER_CAST(wxContextMenuEventFunction, func)
3649 #define wxMouseCaptureChangedEventHandler(func) \
3650 wxEVENT_HANDLER_CAST(wxMouseCaptureChangedEventFunction, func)
3651 #define wxMouseCaptureLostEventHandler(func) \
3652 wxEVENT_HANDLER_CAST(wxMouseCaptureLostEventFunction, func)
3653 #define wxClipboardTextEventHandler(func) \
3654 wxEVENT_HANDLER_CAST(wxClipboardTextEventFunction, func)
3655
3656 #endif // wxUSE_GUI
3657
3658 // N.B. In GNU-WIN32, you *have* to take the address of a member function
3659 // (use &) or the compiler crashes...
3660
3661 #define wxDECLARE_EVENT_TABLE() \
3662 private: \
3663 static const wxEventTableEntry sm_eventTableEntries[]; \
3664 protected: \
3665 static const wxEventTable sm_eventTable; \
3666 virtual const wxEventTable* GetEventTable() const; \
3667 static wxEventHashTable sm_eventHashTable; \
3668 virtual wxEventHashTable& GetEventHashTable() const
3669
3670 // N.B.: when building DLL with Borland C++ 5.5 compiler, you must initialize
3671 // sm_eventTable before using it in GetEventTable() or the compiler gives
3672 // E2233 (see http://groups.google.com/groups?selm=397dcc8a%241_2%40dnews)
3673
3674 #define wxBEGIN_EVENT_TABLE(theClass, baseClass) \
3675 const wxEventTable theClass::sm_eventTable = \
3676 { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] }; \
3677 const wxEventTable *theClass::GetEventTable() const \
3678 { return &theClass::sm_eventTable; } \
3679 wxEventHashTable theClass::sm_eventHashTable(theClass::sm_eventTable); \
3680 wxEventHashTable &theClass::GetEventHashTable() const \
3681 { return theClass::sm_eventHashTable; } \
3682 const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
3683
3684 #define wxBEGIN_EVENT_TABLE_TEMPLATE1(theClass, baseClass, T1) \
3685 template<typename T1> \
3686 const wxEventTable theClass<T1>::sm_eventTable = \
3687 { &baseClass::sm_eventTable, &theClass<T1>::sm_eventTableEntries[0] }; \
3688 template<typename T1> \
3689 const wxEventTable *theClass<T1>::GetEventTable() const \
3690 { return &theClass<T1>::sm_eventTable; } \
3691 template<typename T1> \
3692 wxEventHashTable theClass<T1>::sm_eventHashTable(theClass<T1>::sm_eventTable); \
3693 template<typename T1> \
3694 wxEventHashTable &theClass<T1>::GetEventHashTable() const \
3695 { return theClass<T1>::sm_eventHashTable; } \
3696 template<typename T1> \
3697 const wxEventTableEntry theClass<T1>::sm_eventTableEntries[] = { \
3698
3699 #define wxBEGIN_EVENT_TABLE_TEMPLATE2(theClass, baseClass, T1, T2) \
3700 template<typename T1, typename T2> \
3701 const wxEventTable theClass<T1, T2>::sm_eventTable = \
3702 { &baseClass::sm_eventTable, &theClass<T1, T2>::sm_eventTableEntries[0] }; \
3703 template<typename T1, typename T2> \
3704 const wxEventTable *theClass<T1, T2>::GetEventTable() const \
3705 { return &theClass<T1, T2>::sm_eventTable; } \
3706 template<typename T1, typename T2> \
3707 wxEventHashTable theClass<T1, T2>::sm_eventHashTable(theClass<T1, T2>::sm_eventTable); \
3708 template<typename T1, typename T2> \
3709 wxEventHashTable &theClass<T1, T2>::GetEventHashTable() const \
3710 { return theClass<T1, T2>::sm_eventHashTable; } \
3711 template<typename T1, typename T2> \
3712 const wxEventTableEntry theClass<T1, T2>::sm_eventTableEntries[] = { \
3713
3714 #define wxBEGIN_EVENT_TABLE_TEMPLATE3(theClass, baseClass, T1, T2, T3) \
3715 template<typename T1, typename T2, typename T3> \
3716 const wxEventTable theClass<T1, T2, T3>::sm_eventTable = \
3717 { &baseClass::sm_eventTable, &theClass<T1, T2, T3>::sm_eventTableEntries[0] }; \
3718 template<typename T1, typename T2, typename T3> \
3719 const wxEventTable *theClass<T1, T2, T3>::GetEventTable() const \
3720 { return &theClass<T1, T2, T3>::sm_eventTable; } \
3721 template<typename T1, typename T2, typename T3> \
3722 wxEventHashTable theClass<T1, T2, T3>::sm_eventHashTable(theClass<T1, T2, T3>::sm_eventTable); \
3723 template<typename T1, typename T2, typename T3> \
3724 wxEventHashTable &theClass<T1, T2, T3>::GetEventHashTable() const \
3725 { return theClass<T1, T2, T3>::sm_eventHashTable; } \
3726 template<typename T1, typename T2, typename T3> \
3727 const wxEventTableEntry theClass<T1, T2, T3>::sm_eventTableEntries[] = { \
3728
3729 #define wxBEGIN_EVENT_TABLE_TEMPLATE4(theClass, baseClass, T1, T2, T3, T4) \
3730 template<typename T1, typename T2, typename T3, typename T4> \
3731 const wxEventTable theClass<T1, T2, T3, T4>::sm_eventTable = \
3732 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4>::sm_eventTableEntries[0] }; \
3733 template<typename T1, typename T2, typename T3, typename T4> \
3734 const wxEventTable *theClass<T1, T2, T3, T4>::GetEventTable() const \
3735 { return &theClass<T1, T2, T3, T4>::sm_eventTable; } \
3736 template<typename T1, typename T2, typename T3, typename T4> \
3737 wxEventHashTable theClass<T1, T2, T3, T4>::sm_eventHashTable(theClass<T1, T2, T3, T4>::sm_eventTable); \
3738 template<typename T1, typename T2, typename T3, typename T4> \
3739 wxEventHashTable &theClass<T1, T2, T3, T4>::GetEventHashTable() const \
3740 { return theClass<T1, T2, T3, T4>::sm_eventHashTable; } \
3741 template<typename T1, typename T2, typename T3, typename T4> \
3742 const wxEventTableEntry theClass<T1, T2, T3, T4>::sm_eventTableEntries[] = { \
3743
3744 #define wxBEGIN_EVENT_TABLE_TEMPLATE5(theClass, baseClass, T1, T2, T3, T4, T5) \
3745 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3746 const wxEventTable theClass<T1, T2, T3, T4, T5>::sm_eventTable = \
3747 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[0] }; \
3748 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3749 const wxEventTable *theClass<T1, T2, T3, T4, T5>::GetEventTable() const \
3750 { return &theClass<T1, T2, T3, T4, T5>::sm_eventTable; } \
3751 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3752 wxEventHashTable theClass<T1, T2, T3, T4, T5>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5>::sm_eventTable); \
3753 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3754 wxEventHashTable &theClass<T1, T2, T3, T4, T5>::GetEventHashTable() const \
3755 { return theClass<T1, T2, T3, T4, T5>::sm_eventHashTable; } \
3756 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
3757 const wxEventTableEntry theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[] = { \
3758
3759 #define wxBEGIN_EVENT_TABLE_TEMPLATE7(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7) \
3760 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3761 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable = \
3762 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[0] }; \
3763 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3764 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventTable() const \
3765 { return &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable; } \
3766 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3767 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable); \
3768 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3769 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventHashTable() const \
3770 { return theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable; } \
3771 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
3772 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[] = { \
3773
3774 #define wxBEGIN_EVENT_TABLE_TEMPLATE8(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7, T8) \
3775 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3776 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable = \
3777 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[0] }; \
3778 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3779 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventTable() const \
3780 { return &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable; } \
3781 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3782 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable); \
3783 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3784 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventHashTable() const \
3785 { return theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable; } \
3786 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
3787 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[] = { \
3788
3789 #define wxEND_EVENT_TABLE() \
3790 wxDECLARE_EVENT_TABLE_TERMINATOR() };
3791
3792 /*
3793 * Event table macros
3794 */
3795
3796 // helpers for writing shorter code below: declare an event macro taking 2, 1
3797 // or none ids (the missing ids default to wxID_ANY)
3798 //
3799 // macro arguments:
3800 // - evt one of wxEVT_XXX constants
3801 // - id1, id2 ids of the first/last id
3802 // - fn the function (should be cast to the right type)
3803 #define wx__DECLARE_EVT2(evt, id1, id2, fn) \
3804 wxDECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
3805 #define wx__DECLARE_EVT1(evt, id, fn) \
3806 wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
3807 #define wx__DECLARE_EVT0(evt, fn) \
3808 wx__DECLARE_EVT1(evt, wxID_ANY, fn)
3809
3810
3811 // Generic events
3812 #define EVT_CUSTOM(event, winid, func) \
3813 wx__DECLARE_EVT1(event, winid, wxEventHandler(func))
3814 #define EVT_CUSTOM_RANGE(event, id1, id2, func) \
3815 wx__DECLARE_EVT2(event, id1, id2, wxEventHandler(func))
3816
3817 // EVT_COMMAND
3818 #define EVT_COMMAND(winid, event, func) \
3819 wx__DECLARE_EVT1(event, winid, wxCommandEventHandler(func))
3820
3821 #define EVT_COMMAND_RANGE(id1, id2, event, func) \
3822 wx__DECLARE_EVT2(event, id1, id2, wxCommandEventHandler(func))
3823
3824 #define EVT_NOTIFY(event, winid, func) \
3825 wx__DECLARE_EVT1(event, winid, wxNotifyEventHandler(func))
3826
3827 #define EVT_NOTIFY_RANGE(event, id1, id2, func) \
3828 wx__DECLARE_EVT2(event, id1, id2, wxNotifyEventHandler(func))
3829
3830 // Miscellaneous
3831 #define EVT_SIZE(func) wx__DECLARE_EVT0(wxEVT_SIZE, wxSizeEventHandler(func))
3832 #define EVT_SIZING(func) wx__DECLARE_EVT0(wxEVT_SIZING, wxSizeEventHandler(func))
3833 #define EVT_MOVE(func) wx__DECLARE_EVT0(wxEVT_MOVE, wxMoveEventHandler(func))
3834 #define EVT_MOVING(func) wx__DECLARE_EVT0(wxEVT_MOVING, wxMoveEventHandler(func))
3835 #define EVT_MOVE_START(func) wx__DECLARE_EVT0(wxEVT_MOVE_START, wxMoveEventHandler(func))
3836 #define EVT_MOVE_END(func) wx__DECLARE_EVT0(wxEVT_MOVE_END, wxMoveEventHandler(func))
3837 #define EVT_CLOSE(func) wx__DECLARE_EVT0(wxEVT_CLOSE_WINDOW, wxCloseEventHandler(func))
3838 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3839 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3840 #define EVT_PAINT(func) wx__DECLARE_EVT0(wxEVT_PAINT, wxPaintEventHandler(func))
3841 #define EVT_NC_PAINT(func) wx__DECLARE_EVT0(wxEVT_NC_PAINT, wxNcPaintEventHandler(func))
3842 #define EVT_ERASE_BACKGROUND(func) wx__DECLARE_EVT0(wxEVT_ERASE_BACKGROUND, wxEraseEventHandler(func))
3843 #define EVT_CHAR(func) wx__DECLARE_EVT0(wxEVT_CHAR, wxCharEventHandler(func))
3844 #define EVT_KEY_DOWN(func) wx__DECLARE_EVT0(wxEVT_KEY_DOWN, wxKeyEventHandler(func))
3845 #define EVT_KEY_UP(func) wx__DECLARE_EVT0(wxEVT_KEY_UP, wxKeyEventHandler(func))
3846 #if wxUSE_HOTKEY
3847 #define EVT_HOTKEY(winid, func) wx__DECLARE_EVT1(wxEVT_HOTKEY, winid, wxCharEventHandler(func))
3848 #endif
3849 #define EVT_CHAR_HOOK(func) wx__DECLARE_EVT0(wxEVT_CHAR_HOOK, wxCharEventHandler(func))
3850 #define EVT_MENU_OPEN(func) wx__DECLARE_EVT0(wxEVT_MENU_OPEN, wxMenuEventHandler(func))
3851 #define EVT_MENU_CLOSE(func) wx__DECLARE_EVT0(wxEVT_MENU_CLOSE, wxMenuEventHandler(func))
3852 #define EVT_MENU_HIGHLIGHT(winid, func) wx__DECLARE_EVT1(wxEVT_MENU_HIGHLIGHT, winid, wxMenuEventHandler(func))
3853 #define EVT_MENU_HIGHLIGHT_ALL(func) wx__DECLARE_EVT0(wxEVT_MENU_HIGHLIGHT, wxMenuEventHandler(func))
3854 #define EVT_SET_FOCUS(func) wx__DECLARE_EVT0(wxEVT_SET_FOCUS, wxFocusEventHandler(func))
3855 #define EVT_KILL_FOCUS(func) wx__DECLARE_EVT0(wxEVT_KILL_FOCUS, wxFocusEventHandler(func))
3856 #define EVT_CHILD_FOCUS(func) wx__DECLARE_EVT0(wxEVT_CHILD_FOCUS, wxChildFocusEventHandler(func))
3857 #define EVT_ACTIVATE(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE, wxActivateEventHandler(func))
3858 #define EVT_ACTIVATE_APP(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE_APP, wxActivateEventHandler(func))
3859 #define EVT_HIBERNATE(func) wx__DECLARE_EVT0(wxEVT_HIBERNATE, wxActivateEventHandler(func))
3860 #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
3861 #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
3862 #define EVT_DROP_FILES(func) wx__DECLARE_EVT0(wxEVT_DROP_FILES, wxDropFilesEventHandler(func))
3863 #define EVT_INIT_DIALOG(func) wx__DECLARE_EVT0(wxEVT_INIT_DIALOG, wxInitDialogEventHandler(func))
3864 #define EVT_SYS_COLOUR_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEventHandler(func))
3865 #define EVT_DISPLAY_CHANGED(func) wx__DECLARE_EVT0(wxEVT_DISPLAY_CHANGED, wxDisplayChangedEventHandler(func))
3866 #define EVT_SHOW(func) wx__DECLARE_EVT0(wxEVT_SHOW, wxShowEventHandler(func))
3867 #define EVT_MAXIMIZE(func) wx__DECLARE_EVT0(wxEVT_MAXIMIZE, wxMaximizeEventHandler(func))
3868 #define EVT_ICONIZE(func) wx__DECLARE_EVT0(wxEVT_ICONIZE, wxIconizeEventHandler(func))
3869 #define EVT_NAVIGATION_KEY(func) wx__DECLARE_EVT0(wxEVT_NAVIGATION_KEY, wxNavigationKeyEventHandler(func))
3870 #define EVT_PALETTE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_PALETTE_CHANGED, wxPaletteChangedEventHandler(func))
3871 #define EVT_QUERY_NEW_PALETTE(func) wx__DECLARE_EVT0(wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEventHandler(func))
3872 #define EVT_WINDOW_CREATE(func) wx__DECLARE_EVT0(wxEVT_CREATE, wxWindowCreateEventHandler(func))
3873 #define EVT_WINDOW_DESTROY(func) wx__DECLARE_EVT0(wxEVT_DESTROY, wxWindowDestroyEventHandler(func))
3874 #define EVT_SET_CURSOR(func) wx__DECLARE_EVT0(wxEVT_SET_CURSOR, wxSetCursorEventHandler(func))
3875 #define EVT_MOUSE_CAPTURE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEventHandler(func))
3876 #define EVT_MOUSE_CAPTURE_LOST(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEventHandler(func))
3877
3878 // Mouse events
3879 #define EVT_LEFT_DOWN(func) wx__DECLARE_EVT0(wxEVT_LEFT_DOWN, wxMouseEventHandler(func))
3880 #define EVT_LEFT_UP(func) wx__DECLARE_EVT0(wxEVT_LEFT_UP, wxMouseEventHandler(func))
3881 #define EVT_MIDDLE_DOWN(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DOWN, wxMouseEventHandler(func))
3882 #define EVT_MIDDLE_UP(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_UP, wxMouseEventHandler(func))
3883 #define EVT_RIGHT_DOWN(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DOWN, wxMouseEventHandler(func))
3884 #define EVT_RIGHT_UP(func) wx__DECLARE_EVT0(wxEVT_RIGHT_UP, wxMouseEventHandler(func))
3885 #define EVT_MOTION(func) wx__DECLARE_EVT0(wxEVT_MOTION, wxMouseEventHandler(func))
3886 #define EVT_LEFT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_LEFT_DCLICK, wxMouseEventHandler(func))
3887 #define EVT_MIDDLE_DCLICK(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DCLICK, wxMouseEventHandler(func))
3888 #define EVT_RIGHT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DCLICK, wxMouseEventHandler(func))
3889 #define EVT_LEAVE_WINDOW(func) wx__DECLARE_EVT0(wxEVT_LEAVE_WINDOW, wxMouseEventHandler(func))
3890 #define EVT_ENTER_WINDOW(func) wx__DECLARE_EVT0(wxEVT_ENTER_WINDOW, wxMouseEventHandler(func))
3891 #define EVT_MOUSEWHEEL(func) wx__DECLARE_EVT0(wxEVT_MOUSEWHEEL, wxMouseEventHandler(func))
3892 #define EVT_MOUSE_AUX1_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX1_DOWN, wxMouseEventHandler(func))
3893 #define EVT_MOUSE_AUX1_UP(func) wx__DECLARE_EVT0(wxEVT_AUX1_UP, wxMouseEventHandler(func))
3894 #define EVT_MOUSE_AUX1_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX1_DCLICK, wxMouseEventHandler(func))
3895 #define EVT_MOUSE_AUX2_DOWN(func) wx__DECLARE_EVT0(wxEVT_AUX2_DOWN, wxMouseEventHandler(func))
3896 #define EVT_MOUSE_AUX2_UP(func) wx__DECLARE_EVT0(wxEVT_AUX2_UP, wxMouseEventHandler(func))
3897 #define EVT_MOUSE_AUX2_DCLICK(func) wx__DECLARE_EVT0(wxEVT_AUX2_DCLICK, wxMouseEventHandler(func))
3898
3899 // All mouse events
3900 #define EVT_MOUSE_EVENTS(func) \
3901 EVT_LEFT_DOWN(func) \
3902 EVT_LEFT_UP(func) \
3903 EVT_LEFT_DCLICK(func) \
3904 EVT_MIDDLE_DOWN(func) \
3905 EVT_MIDDLE_UP(func) \
3906 EVT_MIDDLE_DCLICK(func) \
3907 EVT_RIGHT_DOWN(func) \
3908 EVT_RIGHT_UP(func) \
3909 EVT_RIGHT_DCLICK(func) \
3910 EVT_MOUSE_AUX1_DOWN(func) \
3911 EVT_MOUSE_AUX1_UP(func) \
3912 EVT_MOUSE_AUX1_DCLICK(func) \
3913 EVT_MOUSE_AUX2_DOWN(func) \
3914 EVT_MOUSE_AUX2_UP(func) \
3915 EVT_MOUSE_AUX2_DCLICK(func) \
3916 EVT_MOTION(func) \
3917 EVT_LEAVE_WINDOW(func) \
3918 EVT_ENTER_WINDOW(func) \
3919 EVT_MOUSEWHEEL(func)
3920
3921 // Scrolling from wxWindow (sent to wxScrolledWindow)
3922 #define EVT_SCROLLWIN_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_TOP, wxScrollWinEventHandler(func))
3923 #define EVT_SCROLLWIN_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEventHandler(func))
3924 #define EVT_SCROLLWIN_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEUP, wxScrollWinEventHandler(func))
3925 #define EVT_SCROLLWIN_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEventHandler(func))
3926 #define EVT_SCROLLWIN_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEventHandler(func))
3927 #define EVT_SCROLLWIN_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEventHandler(func))
3928 #define EVT_SCROLLWIN_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEventHandler(func))
3929 #define EVT_SCROLLWIN_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEventHandler(func))
3930
3931 #define EVT_SCROLLWIN(func) \
3932 EVT_SCROLLWIN_TOP(func) \
3933 EVT_SCROLLWIN_BOTTOM(func) \
3934 EVT_SCROLLWIN_LINEUP(func) \
3935 EVT_SCROLLWIN_LINEDOWN(func) \
3936 EVT_SCROLLWIN_PAGEUP(func) \
3937 EVT_SCROLLWIN_PAGEDOWN(func) \
3938 EVT_SCROLLWIN_THUMBTRACK(func) \
3939 EVT_SCROLLWIN_THUMBRELEASE(func)
3940
3941 // Scrolling from wxSlider and wxScrollBar
3942 #define EVT_SCROLL_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_TOP, wxScrollEventHandler(func))
3943 #define EVT_SCROLL_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLL_BOTTOM, wxScrollEventHandler(func))
3944 #define EVT_SCROLL_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEUP, wxScrollEventHandler(func))
3945 #define EVT_SCROLL_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEDOWN, wxScrollEventHandler(func))
3946 #define EVT_SCROLL_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEUP, wxScrollEventHandler(func))
3947 #define EVT_SCROLL_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler(func))
3948 #define EVT_SCROLL_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler(func))
3949 #define EVT_SCROLL_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBRELEASE, wxScrollEventHandler(func))
3950 #define EVT_SCROLL_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SCROLL_CHANGED, wxScrollEventHandler(func))
3951
3952 #define EVT_SCROLL(func) \
3953 EVT_SCROLL_TOP(func) \
3954 EVT_SCROLL_BOTTOM(func) \
3955 EVT_SCROLL_LINEUP(func) \
3956 EVT_SCROLL_LINEDOWN(func) \
3957 EVT_SCROLL_PAGEUP(func) \
3958 EVT_SCROLL_PAGEDOWN(func) \
3959 EVT_SCROLL_THUMBTRACK(func) \
3960 EVT_SCROLL_THUMBRELEASE(func) \
3961 EVT_SCROLL_CHANGED(func)
3962
3963 // Scrolling from wxSlider and wxScrollBar, with an id
3964 #define EVT_COMMAND_SCROLL_TOP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_TOP, winid, wxScrollEventHandler(func))
3965 #define EVT_COMMAND_SCROLL_BOTTOM(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_BOTTOM, winid, wxScrollEventHandler(func))
3966 #define EVT_COMMAND_SCROLL_LINEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEUP, winid, wxScrollEventHandler(func))
3967 #define EVT_COMMAND_SCROLL_LINEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEDOWN, winid, wxScrollEventHandler(func))
3968 #define EVT_COMMAND_SCROLL_PAGEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEUP, winid, wxScrollEventHandler(func))
3969 #define EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEDOWN, winid, wxScrollEventHandler(func))
3970 #define EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBTRACK, winid, wxScrollEventHandler(func))
3971 #define EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBRELEASE, winid, wxScrollEventHandler(func))
3972 #define EVT_COMMAND_SCROLL_CHANGED(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_CHANGED, winid, wxScrollEventHandler(func))
3973
3974 #define EVT_COMMAND_SCROLL(winid, func) \
3975 EVT_COMMAND_SCROLL_TOP(winid, func) \
3976 EVT_COMMAND_SCROLL_BOTTOM(winid, func) \
3977 EVT_COMMAND_SCROLL_LINEUP(winid, func) \
3978 EVT_COMMAND_SCROLL_LINEDOWN(winid, func) \
3979 EVT_COMMAND_SCROLL_PAGEUP(winid, func) \
3980 EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) \
3981 EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) \
3982 EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) \
3983 EVT_COMMAND_SCROLL_CHANGED(winid, func)
3984
3985 #if WXWIN_COMPATIBILITY_2_6
3986 // compatibility macros for the old name, deprecated in 2.8
3987 #define wxEVT_SCROLL_ENDSCROLL wxEVT_SCROLL_CHANGED
3988 #define EVT_COMMAND_SCROLL_ENDSCROLL EVT_COMMAND_SCROLL_CHANGED
3989 #define EVT_SCROLL_ENDSCROLL EVT_SCROLL_CHANGED
3990 #endif // WXWIN_COMPATIBILITY_2_6
3991
3992 // Convenience macros for commonly-used commands
3993 #define EVT_CHECKBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKBOX_CLICKED, winid, wxCommandEventHandler(func))
3994 #define EVT_CHOICE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHOICE_SELECTED, winid, wxCommandEventHandler(func))
3995 #define EVT_LISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_SELECTED, winid, wxCommandEventHandler(func))
3996 #define EVT_LISTBOX_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, winid, wxCommandEventHandler(func))
3997 #define EVT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_MENU_SELECTED, winid, wxCommandEventHandler(func))
3998 #define EVT_MENU_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_MENU_SELECTED, id1, id2, wxCommandEventHandler(func))
3999 #if defined(__SMARTPHONE__)
4000 # define EVT_BUTTON(winid, func) EVT_MENU(winid, func)
4001 #else
4002 # define EVT_BUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_BUTTON_CLICKED, winid, wxCommandEventHandler(func))
4003 #endif
4004 #define EVT_SLIDER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SLIDER_UPDATED, winid, wxCommandEventHandler(func))
4005 #define EVT_RADIOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBOX_SELECTED, winid, wxCommandEventHandler(func))
4006 #define EVT_RADIOBUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBUTTON_SELECTED, winid, wxCommandEventHandler(func))
4007 // EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events
4008 #define EVT_SCROLLBAR(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SCROLLBAR_UPDATED, winid, wxCommandEventHandler(func))
4009 #define EVT_VLBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_VLBOX_SELECTED, winid, wxCommandEventHandler(func))
4010 #define EVT_COMBOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_SELECTED, winid, wxCommandEventHandler(func))
4011 #define EVT_TOOL(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_CLICKED, winid, wxCommandEventHandler(func))
4012 #define EVT_TOOL_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, winid, wxCommandEventHandler(func))
4013 #define EVT_TOOL_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_CLICKED, id1, id2, wxCommandEventHandler(func))
4014 #define EVT_TOOL_RCLICKED(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_RCLICKED, winid, wxCommandEventHandler(func))
4015 #define EVT_TOOL_RCLICKED_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, wxCommandEventHandler(func))
4016 #define EVT_TOOL_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_ENTER, winid, wxCommandEventHandler(func))
4017 #define EVT_CHECKLISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, winid, wxCommandEventHandler(func))
4018 #define EVT_COMBOBOX_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_DROPDOWN, winid, wxCommandEventHandler(func))
4019 #define EVT_COMBOBOX_CLOSEUP(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_CLOSEUP, winid, wxCommandEventHandler(func))
4020
4021 // Generic command events
4022 #define EVT_COMMAND_LEFT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_CLICK, winid, wxCommandEventHandler(func))
4023 #define EVT_COMMAND_LEFT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_DCLICK, winid, wxCommandEventHandler(func))
4024 #define EVT_COMMAND_RIGHT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_CLICK, winid, wxCommandEventHandler(func))
4025 #define EVT_COMMAND_RIGHT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_DCLICK, winid, wxCommandEventHandler(func))
4026 #define EVT_COMMAND_SET_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SET_FOCUS, winid, wxCommandEventHandler(func))
4027 #define EVT_COMMAND_KILL_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_KILL_FOCUS, winid, wxCommandEventHandler(func))
4028 #define EVT_COMMAND_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_ENTER, winid, wxCommandEventHandler(func))
4029
4030 // Joystick events
4031
4032 #define EVT_JOY_BUTTON_DOWN(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_DOWN, wxJoystickEventHandler(func))
4033 #define EVT_JOY_BUTTON_UP(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_UP, wxJoystickEventHandler(func))
4034 #define EVT_JOY_MOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_MOVE, wxJoystickEventHandler(func))
4035 #define EVT_JOY_ZMOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_ZMOVE, wxJoystickEventHandler(func))
4036
4037 // All joystick events
4038 #define EVT_JOYSTICK_EVENTS(func) \
4039 EVT_JOY_BUTTON_DOWN(func) \
4040 EVT_JOY_BUTTON_UP(func) \
4041 EVT_JOY_MOVE(func) \
4042 EVT_JOY_ZMOVE(func)
4043
4044 // Idle event
4045 #define EVT_IDLE(func) wx__DECLARE_EVT0(wxEVT_IDLE, wxIdleEventHandler(func))
4046
4047 // Update UI event
4048 #define EVT_UPDATE_UI(winid, func) wx__DECLARE_EVT1(wxEVT_UPDATE_UI, winid, wxUpdateUIEventHandler(func))
4049 #define EVT_UPDATE_UI_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_UPDATE_UI, id1, id2, wxUpdateUIEventHandler(func))
4050
4051 // Help events
4052 #define EVT_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_HELP, winid, wxHelpEventHandler(func))
4053 #define EVT_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_HELP, id1, id2, wxHelpEventHandler(func))
4054 #define EVT_DETAILED_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_DETAILED_HELP, winid, wxHelpEventHandler(func))
4055 #define EVT_DETAILED_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_DETAILED_HELP, id1, id2, wxHelpEventHandler(func))
4056
4057 // Context Menu Events
4058 #define EVT_CONTEXT_MENU(func) wx__DECLARE_EVT0(wxEVT_CONTEXT_MENU, wxContextMenuEventHandler(func))
4059 #define EVT_COMMAND_CONTEXT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_CONTEXT_MENU, winid, wxContextMenuEventHandler(func))
4060
4061 // Clipboard text Events
4062 #define EVT_TEXT_CUT(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_CUT, winid, wxClipboardTextEventHandler(func))
4063 #define EVT_TEXT_COPY(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_COPY, winid, wxClipboardTextEventHandler(func))
4064 #define EVT_TEXT_PASTE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_PASTE, winid, wxClipboardTextEventHandler(func))
4065
4066 // Thread events
4067 #define EVT_THREAD(id, func) wx__DECLARE_EVT1(wxEVT_THREAD, id, wxThreadEventHandler(func))
4068 // alias for backward compatibility with 2.9.0:
4069 #define wxEVT_COMMAND_THREAD wxEVT_THREAD
4070
4071 // ----------------------------------------------------------------------------
4072 // Helper functions
4073 // ----------------------------------------------------------------------------
4074
4075 // This is an ugly hack to allow the use of Bind() instead of Connect() inside
4076 // the library code if the library was built with support for it, here is how
4077 // it is used:
4078 //
4079 // class SomeEventHandlingClass : wxBIND_OR_CONNECT_HACK_BASE_CLASS
4080 // public SomeBaseClass
4081 // {
4082 // public:
4083 // SomeEventHandlingClass(wxWindow *win)
4084 // {
4085 // // connect to the event for the given window
4086 // wxBIND_OR_CONNECT_HACK(win, wxEVT_SOMETHING, wxSomeEventHandler,
4087 // SomeEventHandlingClass::OnSomeEvent, this);
4088 // }
4089 //
4090 // private:
4091 // void OnSomeEvent(wxSomeEvent&) { ... }
4092 // };
4093 //
4094 // This is *not* meant to be used by library users, it is only defined here
4095 // (and not in a private header) because the base class must be visible from
4096 // other public headers, please do NOT use this in your code, it will be
4097 // removed from future wx versions without warning.
4098 #ifdef wxHAS_EVENT_BIND
4099 #define wxBIND_OR_CONNECT_HACK_BASE_CLASS
4100 #define wxBIND_OR_CONNECT_HACK_ONLY_BASE_CLASS
4101 #define wxBIND_OR_CONNECT_HACK(win, evt, handler, func, obj) \
4102 win->Bind(evt, &func, obj)
4103 #else // wxHAS_EVENT_BIND
4104 #define wxBIND_OR_CONNECT_HACK_BASE_CLASS public wxEvtHandler,
4105 #define wxBIND_OR_CONNECT_HACK_ONLY_BASE_CLASS : public wxEvtHandler
4106 #define wxBIND_OR_CONNECT_HACK(win, evt, handler, func, obj) \
4107 win->Connect(evt, handler(func), NULL, obj)
4108 #endif // wxHAS_EVENT_BIND
4109
4110 #if wxUSE_GUI
4111
4112 // Find a window with the focus, that is also a descendant of the given window.
4113 // This is used to determine the window to initially send commands to.
4114 WXDLLIMPEXP_CORE wxWindow* wxFindFocusDescendant(wxWindow* ancestor);
4115
4116 #endif // wxUSE_GUI
4117
4118
4119 // ----------------------------------------------------------------------------
4120 // Compatibility macro aliases
4121 // ----------------------------------------------------------------------------
4122
4123 // deprecated variants _not_ requiring a semicolon after them and without wx prefix
4124 // (note that also some wx-prefixed macro do _not_ require a semicolon because
4125 // it's not always possible to force the compire to require it)
4126
4127 #define DECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj) \
4128 wxDECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj)
4129 #define DECLARE_EVENT_TABLE_TERMINATOR() wxDECLARE_EVENT_TABLE_TERMINATOR()
4130 #define DECLARE_EVENT_TABLE() wxDECLARE_EVENT_TABLE();
4131 #define BEGIN_EVENT_TABLE(a,b) wxBEGIN_EVENT_TABLE(a,b)
4132 #define BEGIN_EVENT_TABLE_TEMPLATE1(a,b,c) wxBEGIN_EVENT_TABLE_TEMPLATE1(a,b,c)
4133 #define BEGIN_EVENT_TABLE_TEMPLATE2(a,b,c,d) wxBEGIN_EVENT_TABLE_TEMPLATE1(a,b,c,d)
4134 #define BEGIN_EVENT_TABLE_TEMPLATE3(a,b,c,d,e) wxBEGIN_EVENT_TABLE_TEMPLATE1(a,b,c,d,e)
4135 #define BEGIN_EVENT_TABLE_TEMPLATE4(a,b,c,d,e,f) wxBEGIN_EVENT_TABLE_TEMPLATE1(a,b,c,d,e,f)
4136 #define BEGIN_EVENT_TABLE_TEMPLATE5(a,b,c,d,e,f,g) wxBEGIN_EVENT_TABLE_TEMPLATE1(a,b,c,d,e,f,g)
4137 #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)
4138 #define END_EVENT_TABLE() wxEND_EVENT_TABLE()
4139
4140 // other obsolete event declaration/definition macros; we don't need them any longer
4141 // but we keep them for compatibility as it doesn't cost us anything anyhow
4142 #define BEGIN_DECLARE_EVENT_TYPES()
4143 #define END_DECLARE_EVENT_TYPES()
4144 #define DECLARE_EXPORTED_EVENT_TYPE(expdecl, name, value) \
4145 extern expdecl const wxEventType name;
4146 #define DECLARE_EVENT_TYPE(name, value) \
4147 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_CORE, name, value)
4148 #define DECLARE_LOCAL_EVENT_TYPE(name, value) \
4149 DECLARE_EXPORTED_EVENT_TYPE(wxEMPTY_PARAMETER_VALUE, name, value)
4150 #define DEFINE_EVENT_TYPE(name) const wxEventType name = wxNewEventType();
4151 #define DEFINE_LOCAL_EVENT_TYPE(name) DEFINE_EVENT_TYPE(name)
4152
4153 #endif // _WX_EVENT_H_