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