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