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