include/wx/event.h

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