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