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     virtual void operator()(wxEvtHandler *, wxEvent &) = 0;
 203
 204     virtual bool operator==(const wxEventFunctor& other) const = 0;
 205
 206     virtual wxEvtHandler *GetHandler() const { return NULL; }
 207
 208     virtual wxObjectEventFunction GetMethod() const { return NULL; }
 209 };
 210
 211 // A plain method functor
 212 class WXDLLIMPEXP_BASE wxObjectEventFunctor : public wxEventFunctor
 213 {
 214 public:
 215     wxObjectEventFunctor(wxObjectEventFunction method, wxEvtHandler *handler)
 216     {
 217         m_handler = handler;
 218         m_method = method;
 219     }
 220
 221     virtual void operator()(wxEvtHandler *handler, wxEvent& event)
 222     {
 223         wxEvtHandler * const realHandler = m_handler ? m_handler : handler;
 224
 225         (realHandler->*m_method)(event);
 226     }
 227
 228     virtual bool operator==(const wxEventFunctor& other) const
 229     {
 230         wxEvtHandler * const handler = other.GetHandler();
 231         const wxObjectEventFunction method = other.GetMethod();
 232
 233         return (m_handler == handler || !handler) &&
 234                (m_method == method || !method);
 235     }
 236
 237     virtual wxEvtHandler *GetHandler() const { return m_handler; }
 238     virtual wxObjectEventFunction GetMethod() const { return m_method; }
 239
 240 private:
 241     wxEvtHandler *m_handler;
 242     wxObjectEventFunction m_method;
 243 };
 244
 245 #if !wxEVENTS_COMPATIBILITY_2_8
 246
 247 template <typename EventType>
 248 class WXDLLIMPEXP_BASE wxEventFunctorFunction : public wxEventFunctor
 249 {
 250 public:
 251     wxEventFunctorFunction(void (*handler)(typename EventType::CorrespondingEvent &))
 252     {
 253         m_handler = handler;
 254     }
 255
 256     virtual void operator()(wxEvtHandler *WXUNUSED(handler), wxEvent& event)
 257     {
 258         // Protect against wrong event i.e. wxMouseEvent evt(wxEVT_PAINT):
 259         wxASSERT( dynamic_cast< typename EventType::CorrespondingEvent * >( &event ) != NULL );
 260
 261         // Will throw a std::bad_cast exception in release build:
 262         ( *m_handler )( dynamic_cast< typename EventType::CorrespondingEvent & >( event ));
 263     }
 264
 265     virtual bool operator == ( const wxEventFunctor &right ) const
 266     {
 267         wxEventFunctorFunction const &other = dynamic_cast< wxEventFunctorFunction const & >( right );
 268
 269         return m_handler == other.m_handler || other.m_handler == NULL;
 270     }
 271
 272 private:
 273     void ( *m_handler )( typename EventType::CorrespondingEvent & );
 274 };
 275
 276
 277 template <typename EventType, typename Class, typename Derived>
 278 class WXDLLIMPEXP_BASE wxEventFunctorMethod : public wxEventFunctor
 279 {
 280 public:
 281     wxEventFunctorMethod( void ( Class::*method )( typename EventType::CorrespondingEvent & ),
 282             Derived *handler )
 283     {
 284         m_handler = handler;
 285         m_method =  method;
 286     }
 287
 288     virtual void operator () ( wxEvtHandler *handler, wxEvent &event )
 289     {
 290         // Compile-time type check 1: This requires Derived to derive from or
 291         // be of the same type as Class
 292         Class *realHandler = m_handler;
 293
 294         if( m_handler == NULL )
 295         {
 296             // Verify that the handler does indeed derive from the class
 297             // containing the handler method
 298             wxASSERT( dynamic_cast< Class * >( handler) != NULL );
 299
 300             realHandler = dynamic_cast< Class * >( handler );
 301         }
 302
 303         // Protect against wrong event i.e. wxMouseEvent evt(wxEVT_PAINT):
 304         wxASSERT( dynamic_cast< typename EventType::CorrespondingEvent * >( &event ) != NULL );
 305
 306         // Will throw a std::bad_cast exception in release build:
 307         ( realHandler->*m_method )( dynamic_cast< typename EventType::CorrespondingEvent & >( event ));
 308     }
 309
 310     virtual bool operator == ( const wxEventFunctor &right ) const
 311     {
 312         wxEventFunctorMethod const &other = dynamic_cast< wxEventFunctorMethod const & >( right );
 313
 314         return (( m_handler == other.m_handler || other.m_handler == NULL ) &&
 315                 ( m_method == other.m_method || other.m_method == NULL ));
 316     }
 317
 318     virtual wxEvtHandler *GetHandler() const
 319     {
 320         // This makes sure Derived derives from wxEvtHandler (it is still
 321         // possible and even ok if Class does not derive from wxEvtHandler. In
 322         // this case Derived would end up using multiple inheritance: class
 323         // Derived : public wxEvtHandler, public Class { } where Class contains
 324         // the method to call, but wxEvtHandler contains the wxTrackable and
 325         // code for weak ref support
 326         return m_handler;
 327     }
 328
 329     virtual wxObjectEventFunction GetMethod() const
 330     {
 331         return reinterpret_cast<wxObjectEventFunction>(m_method);
 332     }
 333
 334 private:
 335     Derived *m_handler;
 336     void (Class::*m_method)(typename EventType::CorrespondingEvent&);
 337 };
 338
 339
 340 template <typename EventType, typename Functor>
 341 class WXDLLIMPEXP_BASE wxEventFunctorAdapter : public wxEventFunctor
 342 {
 343 public:
 344     wxEventFunctorAdapter( Functor &functor )
 345     {
 346         m_functor = functor;
 347     }
 348
 349     virtual void operator () ( wxEvtHandler *WXUNUSED( handler ), wxEvent &event )
 350     {
 351         // Protect against wrong event i.e. wxMouseEvent evt(wxEVT_PAINT):
 352         wxASSERT( dynamic_cast< typename EventType::CorrespondingEvent * >( &event ) != NULL );
 353
 354         // Will throw a std::bad_cast exception in release build:
 355         m_functor( dynamic_cast< typename EventType::CorrespondingEvent & >( event ));
 356     }
 357
 358     virtual bool operator == ( const wxEventFunctor &right ) const
 359     {
 360         wxEventFunctorAdapter const &other = dynamic_cast< wxEventFunctorAdapter const & >( right );
 361
 362         return m_functor == other.m_functor;
 363     }
 364
 365 private:
 366     Functor m_functor;
 367 };
 368
 369 #endif // wxEVENTS_COMPATIBILITY_2_8
 370
 371 // Create a functor for the legacy events:
 372
 373 inline wxObjectEventFunctor *
 374 wxNewEventFunctor(wxEventType WXUNUSED(evtType),
 375                   wxObjectEventFunction method,
 376                   wxEvtHandler *handler = NULL)
 377 {
 378     return new wxObjectEventFunctor(method, handler);
 379 }
 380
 381 inline wxObjectEventFunctor
 382 wxConstructEventFunctor(wxEventType WXUNUSED(evtType),
 383                         wxObjectEventFunction method,
 384                         wxEvtHandler *handler = NULL)
 385 {
 386     return wxObjectEventFunctor(method, handler);
 387 }
 388
 389 #if !wxEVENTS_COMPATIBILITY_2_8
 390
 391 //
 392 // Create functors for the templatized events (needed in wxEvtHandler::Connect):
 393 //
 394
 395 // Create a functor for functions:
 396
 397 template <typename EventType>
 398 inline wxEventFunctorFunction<EventType> *
 399 wxNewEventFunctor(const EventType &,
 400                   void (*function)(typename EventType::CorrespondingEvent&))
 401 {
 402     return new wxEventFunctorFunction<EventType>(function);
 403 }
 404
 405 // Create a functor for methods:
 406
 407 template <typename EventType, typename Class>
 408 inline wxEventFunctorMethod<EventType, Class, Class> *
 409 wxNewEventFunctor(const EventType &,
 410                   void (Class::*method)(typename EventType::CorrespondingEvent&))
 411 {
 412     return new wxEventFunctorMethod<EventType, Class, Class>(method, NULL);
 413 }
 414
 415 template <typename EventType, typename Class, typename Derived>
 416 inline wxEventFunctorMethod<EventType, Class, Derived> *
 417 wxNewEventFunctor(const EventType &,
 418                   void (Class::*method)(typename EventType::CorrespondingEvent &),
 419                   Derived *handler )
 420 {
 421     return new wxEventFunctorMethod<EventType, Class, Derived>(method, handler);
 422 }
 423
 424 // Create a functor for arbitrary functors (like boost::function):
 425 template <typename EventType, typename Functor>
 426 inline wxEventFunctorAdapter<EventType, Functor> *
 427 wxNewEventFunctor(const EventType &,
 428                   Functor& functor )
 429 {
 430     return new wxEventFunctorAdapter<EventType, Functor>(functor);
 431 }
 432
 433 //
 434 // Construct functors for the templatized events (needed in wxEvtHandler::Disconnect):
 435 //
 436
 437 // Construct a functor for functions:
 438
 439 template <typename EventType>
 440 inline wxEventFunctorFunction<EventType>
 441 wxConstructEventFunctor(const EventType &,
 442                         void (*function)(typename EventType::CorrespondingEvent&))
 443 {
 444     return wxEventFunctorFunction<EventType>(function);
 445 }
 446
 447 // Construct a functor for methods:
 448
 449 template <typename EventType, typename Class>
 450 inline wxEventFunctorMethod<EventType, Class, Class>
 451 wxConstructEventFunctor(const EventType &,
 452                         void (Class::*method)(typename EventType::CorrespondingEvent&))
 453 {
 454     return wxEventFunctorMethod<EventType, Class, Class>(method, NULL);
 455 }
 456
 457 template <typename EventType, typename Class, typename Derived>
 458 inline wxEventFunctorMethod<EventType, Class, Derived>
 459 wxConstructEventFunctor(const EventType &,
 460                         void (Class::*method)(typename EventType::CorrespondingEvent&),
 461                         Derived *handler)
 462 {
 463     return wxEventFunctorMethod<EventType, Class, Derived>(method, handler);
 464 }
 465
 466 // Construct a functor for arbitrary functors (like boost:function):
 467
 468 template <typename EventType, typename Functor>
 469 inline wxEventFunctorAdapter<EventType, Functor>
 470 wxConstructEventFunctor(const EventType &,
 471                         Functor& functor)
 472 {
 473     return wxEventFunctorAdapter<EventType, Functor>(functor);
 474 }
 475
 476 #endif // !wxEVENTS_COMPATIBILITY_2_8
 477
 478 // many, but not all, standard event types
 479
 480     // some generic events
 481 extern WXDLLIMPEXP_BASE const wxEventType wxEVT_NULL;
 482 extern WXDLLIMPEXP_BASE const wxEventType wxEVT_FIRST;
 483 extern WXDLLIMPEXP_BASE const wxEventType wxEVT_USER_FIRST;
 484
 485     // Need events declared to do this
 486 class WXDLLIMPEXP_FWD_CORE wxCommandEvent;
 487 class WXDLLIMPEXP_FWD_CORE wxMouseEvent;
 488 class WXDLLIMPEXP_FWD_CORE wxFocusEvent;
 489 class WXDLLIMPEXP_FWD_CORE wxChildFocusEvent;
 490 class WXDLLIMPEXP_FWD_CORE wxKeyEvent;
 491 class WXDLLIMPEXP_FWD_CORE wxNavigationKeyEvent;
 492 class WXDLLIMPEXP_FWD_CORE wxSetCursorEvent;
 493 class WXDLLIMPEXP_FWD_CORE wxScrollEvent;
 494 class WXDLLIMPEXP_FWD_CORE wxScrollWinEvent;
 495 class WXDLLIMPEXP_FWD_CORE wxSizeEvent;
 496 class WXDLLIMPEXP_FWD_CORE wxMoveEvent;
 497 class WXDLLIMPEXP_FWD_CORE wxCloseEvent;
 498 class WXDLLIMPEXP_FWD_CORE wxActivateEvent;
 499 class WXDLLIMPEXP_FWD_CORE wxWindowCreateEvent;
 500 class WXDLLIMPEXP_FWD_CORE wxWindowDestroyEvent;
 501 class WXDLLIMPEXP_FWD_CORE wxShowEvent;
 502 class WXDLLIMPEXP_FWD_CORE wxIconizeEvent;
 503 class WXDLLIMPEXP_FWD_CORE wxMaximizeEvent;
 504 class WXDLLIMPEXP_FWD_CORE wxMouseCaptureChangedEvent;
 505 class WXDLLIMPEXP_FWD_CORE wxMouseCaptureLostEvent;
 506 class WXDLLIMPEXP_FWD_CORE wxPaintEvent;
 507 class WXDLLIMPEXP_FWD_CORE wxEraseEvent;
 508 class WXDLLIMPEXP_FWD_CORE wxNcPaintEvent;
 509 class WXDLLIMPEXP_FWD_CORE wxMenuEvent;
 510 class WXDLLIMPEXP_FWD_CORE wxContextMenuEvent;
 511 class WXDLLIMPEXP_FWD_CORE wxSysColourChangedEvent;
 512 class WXDLLIMPEXP_FWD_CORE wxDisplayChangedEvent;
 513 class WXDLLIMPEXP_FWD_CORE wxQueryNewPaletteEvent;
 514 class WXDLLIMPEXP_FWD_CORE wxPaletteChangedEvent;
 515 class WXDLLIMPEXP_FWD_CORE wxJoystickEvent;
 516 class WXDLLIMPEXP_FWD_CORE wxDropFilesEvent;
 517 class WXDLLIMPEXP_FWD_CORE wxInitDialogEvent;
 518 class WXDLLIMPEXP_FWD_CORE wxIdleEvent;
 519 class WXDLLIMPEXP_FWD_CORE wxUpdateUIEvent;
 520 class WXDLLIMPEXP_FWD_CORE wxClipboardTextEvent;
 521 class WXDLLIMPEXP_FWD_CORE wxHelpEvent;
 522
 523
 524     // Command events
 525 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEvent)
 526 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_CHECKBOX_CLICKED, wxCommandEvent)
 527 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_CHOICE_SELECTED, wxCommandEvent)
 528 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_LISTBOX_SELECTED, wxCommandEvent)
 529 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, wxCommandEvent)
 530 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, wxCommandEvent)
 531 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_MENU_SELECTED, wxCommandEvent)
 532 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_SLIDER_UPDATED, wxCommandEvent)
 533 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_RADIOBOX_SELECTED, wxCommandEvent)
 534 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_RADIOBUTTON_SELECTED, wxCommandEvent)
 535
 536 // wxEVT_COMMAND_SCROLLBAR_UPDATED is deprecated, use wxEVT_SCROLL... events
 537 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_SCROLLBAR_UPDATED, wxCommandEvent)
 538 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_VLBOX_SELECTED, wxCommandEvent)
 539 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_COMBOBOX_SELECTED, wxCommandEvent)
 540 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TOOL_RCLICKED, wxCommandEvent)
 541 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, wxCommandEvent)
 542 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TOOL_ENTER, wxCommandEvent)
 543
 544     // Mouse event types
 545 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_LEFT_DOWN, wxMouseEvent)
 546 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_LEFT_UP, wxMouseEvent)
 547 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MIDDLE_DOWN, wxMouseEvent)
 548 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MIDDLE_UP, wxMouseEvent)
 549 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_RIGHT_DOWN, wxMouseEvent)
 550 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_RIGHT_UP, wxMouseEvent)
 551 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOTION, wxMouseEvent)
 552 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_ENTER_WINDOW, wxMouseEvent)
 553 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_LEAVE_WINDOW, wxMouseEvent)
 554 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_LEFT_DCLICK, wxMouseEvent)
 555 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MIDDLE_DCLICK, wxMouseEvent)
 556 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_RIGHT_DCLICK, wxMouseEvent)
 557 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SET_FOCUS, wxFocusEvent)
 558 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_KILL_FOCUS, wxFocusEvent)
 559 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_CHILD_FOCUS, wxChildFocusEvent)
 560 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOUSEWHEEL, wxMouseEvent)
 561 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_AUX1_DOWN, wxMouseEvent)
 562 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_AUX1_UP, wxMouseEvent)
 563 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_AUX1_DCLICK, wxMouseEvent)
 564 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_AUX2_DOWN, wxMouseEvent)
 565 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_AUX2_UP, wxMouseEvent)
 566 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_AUX2_DCLICK, wxMouseEvent)
 567
 568     // Character input event type
 569 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_CHAR, wxKeyEvent)
 570 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_CHAR_HOOK, wxKeyEvent)
 571 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_NAVIGATION_KEY, wxNavigationKeyEvent)
 572 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_KEY_DOWN, wxKeyEvent)
 573 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_KEY_UP, wxKeyEvent)
 574 #if wxUSE_HOTKEY
 575 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_HOTKEY, wxKeyEvent)
 576 #endif
 577     // Set cursor event
 578 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SET_CURSOR, wxSetCursorEvent)
 579
 580     // wxScrollBar and wxSlider event identifiers
 581 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_TOP, wxScrollEvent)
 582 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_BOTTOM, wxScrollEvent)
 583 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_LINEUP, wxScrollEvent)
 584 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_LINEDOWN, wxScrollEvent)
 585 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_PAGEUP, wxScrollEvent)
 586 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_PAGEDOWN, wxScrollEvent)
 587 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_THUMBTRACK, wxScrollEvent)
 588 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_THUMBRELEASE, wxScrollEvent)
 589 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLL_CHANGED, wxScrollEvent)
 590
 591     // Scroll events from wxWindow
 592 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_TOP, wxScrollWinEvent)
 593 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEvent)
 594 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_LINEUP, wxScrollWinEvent)
 595 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEvent)
 596 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEvent)
 597 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEvent)
 598 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEvent)
 599 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEvent)
 600
 601     // System events
 602 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SIZE, wxSizeEvent)
 603 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOVE, wxMoveEvent)
 604 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_CLOSE_WINDOW, wxCloseEvent)
 605 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_END_SESSION, wxCloseEvent)
 606 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_QUERY_END_SESSION, wxCloseEvent)
 607 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_ACTIVATE_APP, wxActivateEvent)
 608 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_ACTIVATE, wxActivateEvent)
 609 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_CREATE, wxWindowCreateEvent)
 610 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_DESTROY, wxWindowDestroyEvent)
 611 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SHOW, wxShowEvent)
 612 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_ICONIZE, wxIconizeEvent)
 613 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MAXIMIZE, wxMaximizeEvent)
 614 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEvent)
 615 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEvent)
 616 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_PAINT, wxPaintEvent)
 617 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_ERASE_BACKGROUND, wxEraseEvent)
 618 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_NC_PAINT, wxNcPaintEvent)
 619 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MENU_OPEN, wxMenuEvent)
 620 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MENU_CLOSE, wxMenuEvent)
 621 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MENU_HIGHLIGHT, wxMenuEvent)
 622 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_CONTEXT_MENU, wxContextMenuEvent)
 623 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEvent)
 624 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_DISPLAY_CHANGED, wxDisplayChangedEvent)
 625 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEvent)
 626 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_PALETTE_CHANGED, wxPaletteChangedEvent)
 627 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_JOY_BUTTON_DOWN, wxJoystickEvent)
 628 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_JOY_BUTTON_UP, wxJoystickEvent)
 629 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_JOY_MOVE, wxJoystickEvent)
 630 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_JOY_ZMOVE, wxJoystickEvent)
 631 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_DROP_FILES, wxDropFilesEvent)
 632 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_INIT_DIALOG, wxInitDialogEvent)
 633 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_BASE, wxEVT_IDLE, wxIdleEvent)
 634 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_UPDATE_UI, wxUpdateUIEvent)
 635 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SIZING, wxSizeEvent)
 636 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOVING, wxMoveEvent)
 637 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOVE_START, wxMoveEvent)
 638 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_MOVE_END, wxMoveEvent)
 639 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_HIBERNATE, wxActivateEvent)
 640
 641     // Clipboard events
 642 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TEXT_COPY, wxClipboardTextEvent)
 643 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TEXT_CUT, wxClipboardTextEvent)
 644 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TEXT_PASTE, wxClipboardTextEvent)
 645
 646     // Generic command events
 647     // Note: a click is a higher-level event than button down/up
 648 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_LEFT_CLICK, wxCommandEvent)
 649 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_LEFT_DCLICK, wxCommandEvent)
 650 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_RIGHT_CLICK, wxCommandEvent)
 651 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_RIGHT_DCLICK, wxCommandEvent)
 652 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_SET_FOCUS, wxCommandEvent)
 653 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_KILL_FOCUS, wxCommandEvent)
 654 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_ENTER, wxCommandEvent)
 655
 656     // Help events
 657 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_HELP, wxHelpEvent)
 658 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_DETAILED_HELP, wxHelpEvent)
 659
 660 // these 2 events are the same
 661 #define wxEVT_COMMAND_TOOL_CLICKED wxEVT_COMMAND_MENU_SELECTED
 662
 663 // ----------------------------------------------------------------------------
 664 // Compatibility
 665 // ----------------------------------------------------------------------------
 666
 667 // this event is also used by wxComboBox and wxSpinCtrl which don't include
 668 // wx/textctrl.h in all ports [yet], so declare it here as well
 669 //
 670 // still, any new code using it should include wx/textctrl.h explicitly
 671 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TEXT_UPDATED, wxCommandEvent)
 672
 673 // the predefined constants for the number of times we propagate event
 674 // upwards window child-parent chain
 675 enum Propagation_state
 676 {
 677     // don't propagate it at all
 678     wxEVENT_PROPAGATE_NONE = 0,
 679
 680     // propagate it until it is processed
 681     wxEVENT_PROPAGATE_MAX = INT_MAX
 682 };
 683
 684 /*
 685  * wxWidgets events, covering all interesting things that might happen
 686  * (button clicking, resizing, setting text in widgets, etc.).
 687  *
 688  * For each completely new event type, derive a new event class.
 689  * An event CLASS represents a C++ class defining a range of similar event TYPES;
 690  * examples are canvas events, panel item command events.
 691  * An event TYPE is a unique identifier for a particular system event,
 692  * such as a button press or a listbox deselection.
 693  *
 694  */
 695
 696 class WXDLLIMPEXP_BASE wxEvent : public wxObject
 697 {
 698 public:
 699     wxEvent(int winid = 0, wxEventType commandType = wxEVT_NULL );
 700
 701     void SetEventType(wxEventType typ) { m_eventType = typ; }
 702     wxEventType GetEventType() const { return m_eventType; }
 703     wxObject *GetEventObject() const { return m_eventObject; }
 704     void SetEventObject(wxObject *obj) { m_eventObject = obj; }
 705     long GetTimestamp() const { return m_timeStamp; }
 706     void SetTimestamp(long ts = 0) { m_timeStamp = ts; }
 707     int GetId() const { return m_id; }
 708     void SetId(int Id) { m_id = Id; }
 709
 710     // Can instruct event processor that we wish to ignore this event
 711     // (treat as if the event table entry had not been found): this must be done
 712     // to allow the event processing by the base classes (calling event.Skip()
 713     // is the analog of calling the base class version of a virtual function)
 714     void Skip(bool skip = true) { m_skipped = skip; }
 715     bool GetSkipped() const { return m_skipped; }
 716
 717     // this function is used to create a copy of the event polymorphically and
 718     // all derived classes must implement it because otherwise wxPostEvent()
 719     // for them wouldn't work (it needs to do a copy of the event)
 720     virtual wxEvent *Clone() const = 0;
 721
 722     // Implementation only: this test is explicitly anti OO and this function
 723     // exists only for optimization purposes.
 724     bool IsCommandEvent() const { return m_isCommandEvent; }
 725
 726     // Determine if this event should be propagating to the parent window.
 727     bool ShouldPropagate() const
 728         { return m_propagationLevel != wxEVENT_PROPAGATE_NONE; }
 729
 730     // Stop an event from propagating to its parent window, returns the old
 731     // propagation level value
 732     int StopPropagation()
 733     {
 734         int propagationLevel = m_propagationLevel;
 735         m_propagationLevel = wxEVENT_PROPAGATE_NONE;
 736         return propagationLevel;
 737     }
 738
 739     // Resume the event propagation by restoring the propagation level
 740     // (returned by StopPropagation())
 741     void ResumePropagation(int propagationLevel)
 742     {
 743         m_propagationLevel = propagationLevel;
 744     }
 745
 746 protected:
 747     wxObject*         m_eventObject;
 748     wxEventType       m_eventType;
 749     long              m_timeStamp;
 750     int               m_id;
 751
 752 public:
 753     // m_callbackUserData is for internal usage only
 754     wxObject*         m_callbackUserData;
 755
 756 protected:
 757     // the propagation level: while it is positive, we propagate the event to
 758     // the parent window (if any)
 759     //
 760     // this one doesn't have to be public, we don't have to worry about
 761     // backwards compatibility as it is new
 762     int               m_propagationLevel;
 763
 764     bool              m_skipped;
 765     bool              m_isCommandEvent;
 766
 767 protected:
 768     wxEvent(const wxEvent&);            // for implementing Clone()
 769     wxEvent& operator=(const wxEvent&); // for derived classes operator=()
 770
 771 private:
 772     // it needs to access our m_propagationLevel
 773     friend class WXDLLIMPEXP_FWD_BASE wxPropagateOnce;
 774
 775     DECLARE_ABSTRACT_CLASS(wxEvent)
 776 };
 777
 778 /*
 779  * Helper class to temporarily change an event not to propagate.
 780  */
 781 class WXDLLIMPEXP_BASE wxPropagationDisabler
 782 {
 783 public:
 784     wxPropagationDisabler(wxEvent& event) : m_event(event)
 785     {
 786         m_propagationLevelOld = m_event.StopPropagation();
 787     }
 788
 789     ~wxPropagationDisabler()
 790     {
 791         m_event.ResumePropagation(m_propagationLevelOld);
 792     }
 793
 794 private:
 795     wxEvent& m_event;
 796     int m_propagationLevelOld;
 797
 798     DECLARE_NO_COPY_CLASS(wxPropagationDisabler)
 799 };
 800
 801 /*
 802  * Another one to temporarily lower propagation level.
 803  */
 804 class WXDLLIMPEXP_BASE wxPropagateOnce
 805 {
 806 public:
 807     wxPropagateOnce(wxEvent& event) : m_event(event)
 808     {
 809         wxASSERT_MSG( m_event.m_propagationLevel > 0,
 810                         _T("shouldn't be used unless ShouldPropagate()!") );
 811
 812         m_event.m_propagationLevel--;
 813     }
 814
 815     ~wxPropagateOnce()
 816     {
 817         m_event.m_propagationLevel++;
 818     }
 819
 820 private:
 821     wxEvent& m_event;
 822
 823     DECLARE_NO_COPY_CLASS(wxPropagateOnce)
 824 };
 825
 826
 827 #if wxUSE_GUI
 828
 829
 830 // Item or menu event class
 831 /*
 832  wxEVT_COMMAND_BUTTON_CLICKED
 833  wxEVT_COMMAND_CHECKBOX_CLICKED
 834  wxEVT_COMMAND_CHOICE_SELECTED
 835  wxEVT_COMMAND_LISTBOX_SELECTED
 836  wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
 837  wxEVT_COMMAND_TEXT_UPDATED
 838  wxEVT_COMMAND_TEXT_ENTER
 839  wxEVT_COMMAND_MENU_SELECTED
 840  wxEVT_COMMAND_SLIDER_UPDATED
 841  wxEVT_COMMAND_RADIOBOX_SELECTED
 842  wxEVT_COMMAND_RADIOBUTTON_SELECTED
 843  wxEVT_COMMAND_SCROLLBAR_UPDATED
 844  wxEVT_COMMAND_VLBOX_SELECTED
 845  wxEVT_COMMAND_COMBOBOX_SELECTED
 846  wxEVT_COMMAND_TOGGLEBUTTON_CLICKED
 847 */
 848
 849 class WXDLLIMPEXP_CORE wxCommandEvent : public wxEvent
 850 {
 851 public:
 852     wxCommandEvent(wxEventType commandType = wxEVT_NULL, int winid = 0);
 853
 854     wxCommandEvent(const wxCommandEvent& event)
 855         : wxEvent(event),
 856           m_cmdString(event.m_cmdString),
 857           m_commandInt(event.m_commandInt),
 858           m_extraLong(event.m_extraLong),
 859           m_clientData(event.m_clientData),
 860           m_clientObject(event.m_clientObject)
 861         { }
 862
 863     // Set/Get client data from controls
 864     void SetClientData(void* clientData) { m_clientData = clientData; }
 865     void *GetClientData() const { return m_clientData; }
 866
 867     // Set/Get client object from controls
 868     void SetClientObject(wxClientData* clientObject) { m_clientObject = clientObject; }
 869     wxClientData *GetClientObject() const { return m_clientObject; }
 870
 871     // Get listbox selection if single-choice
 872     int GetSelection() const { return m_commandInt; }
 873
 874     // Set/Get listbox/choice selection string
 875     void SetString(const wxString& s) { m_cmdString = s; }
 876     wxString GetString() const;
 877
 878     // Get checkbox value
 879     bool IsChecked() const { return m_commandInt != 0; }
 880
 881     // true if the listbox event was a selection.
 882     bool IsSelection() const { return (m_extraLong != 0); }
 883
 884     void SetExtraLong(long extraLong) { m_extraLong = extraLong; }
 885     long GetExtraLong() const { return m_extraLong; }
 886
 887     void SetInt(int i) { m_commandInt = i; }
 888     int GetInt() const { return m_commandInt; }
 889
 890     virtual wxEvent *Clone() const { return new wxCommandEvent(*this); }
 891
 892 protected:
 893     wxString          m_cmdString;     // String event argument
 894     int               m_commandInt;
 895     long              m_extraLong;     // Additional information (e.g. select/deselect)
 896     void*             m_clientData;    // Arbitrary client data
 897     wxClientData*     m_clientObject;  // Arbitrary client object
 898
 899 private:
 900     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCommandEvent)
 901 };
 902
 903 // this class adds a possibility to react (from the user) code to a control
 904 // notification: allow or veto the operation being reported.
 905 class WXDLLIMPEXP_CORE wxNotifyEvent  : public wxCommandEvent
 906 {
 907 public:
 908     wxNotifyEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
 909         : wxCommandEvent(commandType, winid)
 910         { m_bAllow = true; }
 911
 912     wxNotifyEvent(const wxNotifyEvent& event)
 913         : wxCommandEvent(event)
 914         { m_bAllow = event.m_bAllow; }
 915
 916     // veto the operation (usually it's allowed by default)
 917     void Veto() { m_bAllow = false; }
 918
 919     // allow the operation if it was disabled by default
 920     void Allow() { m_bAllow = true; }
 921
 922     // for implementation code only: is the operation allowed?
 923     bool IsAllowed() const { return m_bAllow; }
 924
 925     virtual wxEvent *Clone() const { return new wxNotifyEvent(*this); }
 926
 927 private:
 928     bool m_bAllow;
 929
 930 private:
 931     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNotifyEvent)
 932 };
 933
 934 // Scroll event class, derived form wxCommandEvent. wxScrollEvents are
 935 // sent by wxSlider and wxScrollBar.
 936 /*
 937  wxEVT_SCROLL_TOP
 938  wxEVT_SCROLL_BOTTOM
 939  wxEVT_SCROLL_LINEUP
 940  wxEVT_SCROLL_LINEDOWN
 941  wxEVT_SCROLL_PAGEUP
 942  wxEVT_SCROLL_PAGEDOWN
 943  wxEVT_SCROLL_THUMBTRACK
 944  wxEVT_SCROLL_THUMBRELEASE
 945  wxEVT_SCROLL_CHANGED
 946 */
 947
 948 class WXDLLIMPEXP_CORE wxScrollEvent : public wxCommandEvent
 949 {
 950 public:
 951     wxScrollEvent(wxEventType commandType = wxEVT_NULL,
 952                   int winid = 0, int pos = 0, int orient = 0);
 953
 954     int GetOrientation() const { return (int) m_extraLong; }
 955     int GetPosition() const { return m_commandInt; }
 956     void SetOrientation(int orient) { m_extraLong = (long) orient; }
 957     void SetPosition(int pos) { m_commandInt = pos; }
 958
 959     virtual wxEvent *Clone() const { return new wxScrollEvent(*this); }
 960
 961 private:
 962     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollEvent)
 963 };
 964
 965 // ScrollWin event class, derived fom wxEvent. wxScrollWinEvents
 966 // are sent by wxWindow.
 967 /*
 968  wxEVT_SCROLLWIN_TOP
 969  wxEVT_SCROLLWIN_BOTTOM
 970  wxEVT_SCROLLWIN_LINEUP
 971  wxEVT_SCROLLWIN_LINEDOWN
 972  wxEVT_SCROLLWIN_PAGEUP
 973  wxEVT_SCROLLWIN_PAGEDOWN
 974  wxEVT_SCROLLWIN_THUMBTRACK
 975  wxEVT_SCROLLWIN_THUMBRELEASE
 976 */
 977
 978 class WXDLLIMPEXP_CORE wxScrollWinEvent : public wxEvent
 979 {
 980 public:
 981     wxScrollWinEvent(wxEventType commandType = wxEVT_NULL,
 982                      int pos = 0, int orient = 0);
 983     wxScrollWinEvent(const wxScrollWinEvent & event) : wxEvent(event)
 984         {    m_commandInt = event.m_commandInt;
 985             m_extraLong = event.m_extraLong;    }
 986
 987     int GetOrientation() const { return (int) m_extraLong; }
 988     int GetPosition() const { return m_commandInt; }
 989     void SetOrientation(int orient) { m_extraLong = (long) orient; }
 990     void SetPosition(int pos) { m_commandInt = pos; }
 991
 992     virtual wxEvent *Clone() const { return new wxScrollWinEvent(*this); }
 993
 994 protected:
 995     int               m_commandInt;
 996     long              m_extraLong;
 997
 998 private:
 999     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollWinEvent)
1000 };
1001
1002 // Mouse event class
1003
1004 /*
1005  wxEVT_LEFT_DOWN
1006  wxEVT_LEFT_UP
1007  wxEVT_MIDDLE_DOWN
1008  wxEVT_MIDDLE_UP
1009  wxEVT_RIGHT_DOWN
1010  wxEVT_RIGHT_UP
1011  wxEVT_MOTION
1012  wxEVT_ENTER_WINDOW
1013  wxEVT_LEAVE_WINDOW
1014  wxEVT_LEFT_DCLICK
1015  wxEVT_MIDDLE_DCLICK
1016  wxEVT_RIGHT_DCLICK
1017  wxEVT_NC_LEFT_DOWN
1018  wxEVT_NC_LEFT_UP,
1019  wxEVT_NC_MIDDLE_DOWN,
1020  wxEVT_NC_MIDDLE_UP,
1021  wxEVT_NC_RIGHT_DOWN,
1022  wxEVT_NC_RIGHT_UP,
1023  wxEVT_NC_MOTION,
1024  wxEVT_NC_ENTER_WINDOW,
1025  wxEVT_NC_LEAVE_WINDOW,
1026  wxEVT_NC_LEFT_DCLICK,
1027  wxEVT_NC_MIDDLE_DCLICK,
1028  wxEVT_NC_RIGHT_DCLICK,
1029 */
1030
1031 // the symbolic names for the mouse buttons
1032 enum
1033 {
1034     wxMOUSE_BTN_ANY     = -1,
1035     wxMOUSE_BTN_NONE    = 0,
1036     wxMOUSE_BTN_LEFT    = 1,
1037     wxMOUSE_BTN_MIDDLE  = 2,
1038     wxMOUSE_BTN_RIGHT   = 3,
1039     wxMOUSE_BTN_AUX1    = 4,
1040     wxMOUSE_BTN_AUX2    = 5,
1041     wxMOUSE_BTN_MAX
1042 };
1043
1044 class WXDLLIMPEXP_CORE wxMouseEvent : public wxEvent,
1045                                       public wxMouseState
1046 {
1047 public:
1048     wxMouseEvent(wxEventType mouseType = wxEVT_NULL);
1049     wxMouseEvent(const wxMouseEvent& event)
1050         : wxEvent(event),
1051           wxMouseState(event)
1052     {
1053         Assign(event);
1054     }
1055
1056     // Was it a button event? (*doesn't* mean: is any button *down*?)
1057     bool IsButton() const { return Button(wxMOUSE_BTN_ANY); }
1058
1059     // Was it a down event from this (or any) button?
1060     bool ButtonDown(int but = wxMOUSE_BTN_ANY) const;
1061
1062     // Was it a dclick event from this (or any) button?
1063     bool ButtonDClick(int but = wxMOUSE_BTN_ANY) const;
1064
1065     // Was it a up event from this (or any) button?
1066     bool ButtonUp(int but = wxMOUSE_BTN_ANY) const;
1067
1068     // Was the given button?
1069     bool Button(int but) const;
1070
1071     // Was the given button in Down state?
1072     bool ButtonIsDown(int but) const;
1073
1074     // Get the button which is changing state (wxMOUSE_BTN_NONE if none)
1075     int GetButton() const;
1076
1077     // Find which event was just generated
1078     bool LeftDown() const { return (m_eventType == wxEVT_LEFT_DOWN); }
1079     bool MiddleDown() const { return (m_eventType == wxEVT_MIDDLE_DOWN); }
1080     bool RightDown() const { return (m_eventType == wxEVT_RIGHT_DOWN); }
1081     bool Aux1Down() const { return (m_eventType == wxEVT_AUX1_DOWN); }
1082     bool Aux2Down() const { return (m_eventType == wxEVT_AUX2_DOWN); }
1083
1084     bool LeftUp() const { return (m_eventType == wxEVT_LEFT_UP); }
1085     bool MiddleUp() const { return (m_eventType == wxEVT_MIDDLE_UP); }
1086     bool RightUp() const { return (m_eventType == wxEVT_RIGHT_UP); }
1087     bool Aux1Up() const { return (m_eventType == wxEVT_AUX1_UP); }
1088     bool Aux2Up() const { return (m_eventType == wxEVT_AUX2_UP); }
1089
1090     bool LeftDClick() const { return (m_eventType == wxEVT_LEFT_DCLICK); }
1091     bool MiddleDClick() const { return (m_eventType == wxEVT_MIDDLE_DCLICK); }
1092     bool RightDClick() const { return (m_eventType == wxEVT_RIGHT_DCLICK); }
1093     bool Aux1DClick() const { return (m_eventType == wxEVT_AUX1_UP); }
1094     bool Aux2DClick() const { return (m_eventType == wxEVT_AUX2_UP); }
1095
1096     // Find the current state of the mouse buttons (regardless
1097     // of current event type)
1098     bool LeftIsDown() const { return m_leftDown; }
1099     bool MiddleIsDown() const { return m_middleDown; }
1100     bool RightIsDown() const { return m_rightDown; }
1101     bool Aux1IsDown() const { return m_aux1Down; }
1102     bool Aux2IsDown() const { return m_aux2Down; }
1103
1104     // True if a button is down and the mouse is moving
1105     bool Dragging() const
1106     {
1107         return (m_eventType == wxEVT_MOTION) && ButtonIsDown(wxMOUSE_BTN_ANY);
1108     }
1109
1110     // True if the mouse is moving, and no button is down
1111     bool Moving() const
1112     {
1113         return (m_eventType == wxEVT_MOTION) && !ButtonIsDown(wxMOUSE_BTN_ANY);
1114     }
1115
1116     // True if the mouse is just entering the window
1117     bool Entering() const { return (m_eventType == wxEVT_ENTER_WINDOW); }
1118
1119     // True if the mouse is just leaving the window
1120     bool Leaving() const { return (m_eventType == wxEVT_LEAVE_WINDOW); }
1121
1122     // Returns the number of mouse clicks associated with this event.
1123     int GetClickCount() const { return m_clickCount; }
1124
1125
1126     // Find the position of the event
1127     void GetPosition(wxCoord *xpos, wxCoord *ypos) const
1128     {
1129         if (xpos)
1130             *xpos = m_x;
1131         if (ypos)
1132             *ypos = m_y;
1133     }
1134
1135     void GetPosition(long *xpos, long *ypos) const
1136     {
1137         if (xpos)
1138             *xpos = (long)m_x;
1139         if (ypos)
1140             *ypos = (long)m_y;
1141     }
1142
1143     // Find the position of the event
1144     wxPoint GetPosition() const { return wxPoint(m_x, m_y); }
1145
1146     // Find the logical position of the event given the DC
1147     wxPoint GetLogicalPosition(const wxDC& dc) const;
1148
1149     // Get X position
1150     wxCoord GetX() const { return m_x; }
1151
1152     // Get Y position
1153     wxCoord GetY() const { return m_y; }
1154
1155     // Get wheel rotation, positive or negative indicates direction of
1156     // rotation.  Current devices all send an event when rotation is equal to
1157     // +/-WheelDelta, but this allows for finer resolution devices to be
1158     // created in the future.  Because of this you shouldn't assume that one
1159     // event is equal to 1 line or whatever, but you should be able to either
1160     // do partial line scrolling or wait until +/-WheelDelta rotation values
1161     // have been accumulated before scrolling.
1162     int GetWheelRotation() const { return m_wheelRotation; }
1163
1164     // Get wheel delta, normally 120.  This is the threshold for action to be
1165     // taken, and one such action (for example, scrolling one increment)
1166     // should occur for each delta.
1167     int GetWheelDelta() const { return m_wheelDelta; }
1168
1169     // Gets the axis the wheel operation concerns, 0 being the y axis as on
1170     // most mouse wheels, 1 is the x axis for things like MightyMouse scrolls
1171     // or horizontal trackpad scrolling
1172     int GetWheelAxis() const { return m_wheelAxis; }
1173
1174     // Returns the configured number of lines (or whatever) to be scrolled per
1175     // wheel action.  Defaults to one.
1176     int GetLinesPerAction() const { return m_linesPerAction; }
1177
1178     // Is the system set to do page scrolling?
1179     bool IsPageScroll() const { return ((unsigned int)m_linesPerAction == UINT_MAX); }
1180
1181     virtual wxEvent *Clone() const { return new wxMouseEvent(*this); }
1182
1183     wxMouseEvent& operator=(const wxMouseEvent& event)
1184     {
1185         if (&event != this)
1186             Assign(event);
1187         return *this;
1188     }
1189
1190 public:
1191     wxCoord m_x, m_y;
1192
1193     bool          m_leftDown;
1194     bool          m_middleDown;
1195     bool          m_rightDown;
1196     bool          m_aux1Down;
1197     bool          m_aux2Down;
1198
1199     int           m_clickCount;
1200
1201     int           m_wheelAxis;
1202     int           m_wheelRotation;
1203     int           m_wheelDelta;
1204     int           m_linesPerAction;
1205
1206 protected:
1207     void Assign(const wxMouseEvent& evt);
1208
1209 private:
1210     DECLARE_DYNAMIC_CLASS(wxMouseEvent)
1211 };
1212
1213 // Cursor set event
1214
1215 /*
1216    wxEVT_SET_CURSOR
1217  */
1218
1219 class WXDLLIMPEXP_CORE wxSetCursorEvent : public wxEvent
1220 {
1221 public:
1222     wxSetCursorEvent(wxCoord x = 0, wxCoord y = 0)
1223         : wxEvent(0, wxEVT_SET_CURSOR),
1224           m_x(x), m_y(y), m_cursor()
1225         { }
1226
1227     wxSetCursorEvent(const wxSetCursorEvent & event)
1228         : wxEvent(event),
1229           m_x(event.m_x),
1230           m_y(event.m_y),
1231           m_cursor(event.m_cursor)
1232         { }
1233
1234     wxCoord GetX() const { return m_x; }
1235     wxCoord GetY() const { return m_y; }
1236
1237     void SetCursor(const wxCursor& cursor) { m_cursor = cursor; }
1238     const wxCursor& GetCursor() const { return m_cursor; }
1239     bool HasCursor() const { return m_cursor.Ok(); }
1240
1241     virtual wxEvent *Clone() const { return new wxSetCursorEvent(*this); }
1242
1243 private:
1244     wxCoord  m_x, m_y;
1245     wxCursor m_cursor;
1246
1247 private:
1248     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSetCursorEvent)
1249 };
1250
1251 // Keyboard input event class
1252
1253 /*
1254  wxEVT_CHAR
1255  wxEVT_CHAR_HOOK
1256  wxEVT_KEY_DOWN
1257  wxEVT_KEY_UP
1258  wxEVT_HOTKEY
1259  */
1260
1261 class WXDLLIMPEXP_CORE wxKeyEvent : public wxEvent,
1262                                     public wxKeyboardState
1263 {
1264 public:
1265     wxKeyEvent(wxEventType keyType = wxEVT_NULL);
1266     wxKeyEvent(const wxKeyEvent& evt);
1267
1268     // get the key code: an ASCII7 char or an element of wxKeyCode enum
1269     int GetKeyCode() const { return (int)m_keyCode; }
1270
1271 #if wxUSE_UNICODE
1272     // get the Unicode character corresponding to this key
1273     wxChar GetUnicodeKey() const { return m_uniChar; }
1274 #endif // wxUSE_UNICODE
1275
1276     // get the raw key code (platform-dependent)
1277     wxUint32 GetRawKeyCode() const { return m_rawCode; }
1278
1279     // get the raw key flags (platform-dependent)
1280     wxUint32 GetRawKeyFlags() const { return m_rawFlags; }
1281
1282     // Find the position of the event
1283     void GetPosition(wxCoord *xpos, wxCoord *ypos) const
1284     {
1285         if (xpos) *xpos = m_x;
1286         if (ypos) *ypos = m_y;
1287     }
1288
1289     void GetPosition(long *xpos, long *ypos) const
1290     {
1291         if (xpos) *xpos = (long)m_x;
1292         if (ypos) *ypos = (long)m_y;
1293     }
1294
1295     wxPoint GetPosition() const
1296         { return wxPoint(m_x, m_y); }
1297
1298     // Get X position
1299     wxCoord GetX() const { return m_x; }
1300
1301     // Get Y position
1302     wxCoord GetY() const { return m_y; }
1303
1304     virtual wxEvent *Clone() const { return new wxKeyEvent(*this); }
1305
1306     // we do need to copy wxKeyEvent sometimes (in wxTreeCtrl code, for
1307     // example)
1308     wxKeyEvent& operator=(const wxKeyEvent& evt)
1309     {
1310         if ( &evt != this )
1311         {
1312             wxEvent::operator=(evt);
1313
1314             // Borland C++ 5.82 doesn't compile an explicit call to an
1315             // implicitly defined operator=() so need to do it this way:
1316             *static_cast<wxKeyboardState *>(this) = evt;
1317
1318             m_x = evt.m_x;
1319             m_y = evt.m_y;
1320
1321             m_keyCode = evt.m_keyCode;
1322
1323             m_scanCode = evt.m_scanCode;
1324             m_rawCode = evt.m_rawCode;
1325             m_rawFlags = evt.m_rawFlags;
1326 #if wxUSE_UNICODE
1327             m_uniChar = evt.m_uniChar;
1328 #endif
1329         }
1330         return *this;
1331     }
1332
1333 public:
1334     wxCoord       m_x, m_y;
1335
1336     long          m_keyCode;
1337
1338     // FIXME: what is this for? relation to m_rawXXX?
1339     bool          m_scanCode;
1340
1341 #if wxUSE_UNICODE
1342     // This contains the full Unicode character
1343     // in a character events in Unicode mode
1344     wxChar        m_uniChar;
1345 #endif
1346
1347     // these fields contain the platform-specific information about
1348     // key that was pressed
1349     wxUint32      m_rawCode;
1350     wxUint32      m_rawFlags;
1351
1352 private:
1353     DECLARE_DYNAMIC_CLASS(wxKeyEvent)
1354 };
1355
1356 // Size event class
1357 /*
1358  wxEVT_SIZE
1359  */
1360
1361 class WXDLLIMPEXP_CORE wxSizeEvent : public wxEvent
1362 {
1363 public:
1364     wxSizeEvent() : wxEvent(0, wxEVT_SIZE)
1365         { }
1366     wxSizeEvent(const wxSize& sz, int winid = 0)
1367         : wxEvent(winid, wxEVT_SIZE),
1368           m_size(sz)
1369         { }
1370     wxSizeEvent(const wxSizeEvent & event)
1371         : wxEvent(event),
1372           m_size(event.m_size), m_rect(event.m_rect)
1373         { }
1374     wxSizeEvent(const wxRect& rect, int id = 0)
1375         : m_size(rect.GetSize()), m_rect(rect)
1376         { m_eventType = wxEVT_SIZING; m_id = id; }
1377
1378     wxSize GetSize() const { return m_size; }
1379     wxRect GetRect() const { return m_rect; }
1380     void SetRect(const wxRect& rect) { m_rect = rect; }
1381
1382     virtual wxEvent *Clone() const { return new wxSizeEvent(*this); }
1383
1384 public:
1385     // For internal usage only. Will be converted to protected members.
1386     wxSize m_size;
1387     wxRect m_rect; // Used for wxEVT_SIZING
1388
1389 private:
1390     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSizeEvent)
1391 };
1392
1393 // Move event class
1394
1395 /*
1396  wxEVT_MOVE
1397  */
1398
1399 class WXDLLIMPEXP_CORE wxMoveEvent : public wxEvent
1400 {
1401 public:
1402     wxMoveEvent()
1403         : wxEvent(0, wxEVT_MOVE)
1404         { }
1405     wxMoveEvent(const wxPoint& pos, int winid = 0)
1406         : wxEvent(winid, wxEVT_MOVE),
1407           m_pos(pos)
1408         { }
1409     wxMoveEvent(const wxMoveEvent& event)
1410         : wxEvent(event),
1411           m_pos(event.m_pos)
1412     { }
1413     wxMoveEvent(const wxRect& rect, int id = 0)
1414         : m_pos(rect.GetPosition()), m_rect(rect)
1415         { m_eventType = wxEVT_MOVING; m_id = id; }
1416
1417     wxPoint GetPosition() const { return m_pos; }
1418     void SetPosition(const wxPoint& pos) { m_pos = pos; }
1419     wxRect GetRect() const { return m_rect; }
1420     void SetRect(const wxRect& rect) { m_rect = rect; }
1421
1422     virtual wxEvent *Clone() const { return new wxMoveEvent(*this); }
1423
1424 protected:
1425     wxPoint m_pos;
1426     wxRect m_rect;
1427
1428 private:
1429     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMoveEvent)
1430 };
1431
1432 // Paint event class
1433 /*
1434  wxEVT_PAINT
1435  wxEVT_NC_PAINT
1436  wxEVT_PAINT_ICON
1437  */
1438
1439 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1440     // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined
1441     extern WXDLLIMPEXP_CORE int g_isPainting;
1442 #endif // debug
1443
1444 class WXDLLIMPEXP_CORE wxPaintEvent : public wxEvent
1445 {
1446 public:
1447     wxPaintEvent(int Id = 0)
1448         : wxEvent(Id, wxEVT_PAINT)
1449     {
1450 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1451         // set the internal flag for the duration of processing of WM_PAINT
1452         g_isPainting++;
1453 #endif // debug
1454     }
1455
1456     // default copy ctor and dtor are normally fine, we only need them to keep
1457     // g_isPainting updated in debug build
1458 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1459     wxPaintEvent(const wxPaintEvent& event)
1460             : wxEvent(event)
1461     {
1462         g_isPainting++;
1463     }
1464
1465     virtual ~wxPaintEvent()
1466     {
1467         g_isPainting--;
1468     }
1469 #endif // debug
1470
1471     virtual wxEvent *Clone() const { return new wxPaintEvent(*this); }
1472
1473 private:
1474     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaintEvent)
1475 };
1476
1477 class WXDLLIMPEXP_CORE wxNcPaintEvent : public wxEvent
1478 {
1479 public:
1480     wxNcPaintEvent(int winid = 0)
1481         : wxEvent(winid, wxEVT_NC_PAINT)
1482         { }
1483
1484     virtual wxEvent *Clone() const { return new wxNcPaintEvent(*this); }
1485
1486 private:
1487     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNcPaintEvent)
1488 };
1489
1490 // Erase background event class
1491 /*
1492  wxEVT_ERASE_BACKGROUND
1493  */
1494
1495 class WXDLLIMPEXP_CORE wxEraseEvent : public wxEvent
1496 {
1497 public:
1498     wxEraseEvent(int Id = 0, wxDC *dc = (wxDC *) NULL)
1499         : wxEvent(Id, wxEVT_ERASE_BACKGROUND),
1500           m_dc(dc)
1501         { }
1502
1503     wxEraseEvent(const wxEraseEvent& event)
1504         : wxEvent(event),
1505           m_dc(event.m_dc)
1506         { }
1507
1508     wxDC *GetDC() const { return m_dc; }
1509
1510     virtual wxEvent *Clone() const { return new wxEraseEvent(*this); }
1511
1512 protected:
1513     wxDC *m_dc;
1514
1515 private:
1516     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxEraseEvent)
1517 };
1518
1519 // Focus event class
1520 /*
1521  wxEVT_SET_FOCUS
1522  wxEVT_KILL_FOCUS
1523  */
1524
1525 class WXDLLIMPEXP_CORE wxFocusEvent : public wxEvent
1526 {
1527 public:
1528     wxFocusEvent(wxEventType type = wxEVT_NULL, int winid = 0)
1529         : wxEvent(winid, type)
1530         { m_win = NULL; }
1531
1532     wxFocusEvent(const wxFocusEvent& event)
1533         : wxEvent(event)
1534         { m_win = event.m_win; }
1535
1536     // The window associated with this event is the window which had focus
1537     // before for SET event and the window which will have focus for the KILL
1538     // one. NB: it may be NULL in both cases!
1539     wxWindow *GetWindow() const { return m_win; }
1540     void SetWindow(wxWindow *win) { m_win = win; }
1541
1542     virtual wxEvent *Clone() const { return new wxFocusEvent(*this); }
1543
1544 private:
1545     wxWindow *m_win;
1546
1547 private:
1548     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFocusEvent)
1549 };
1550
1551 // wxChildFocusEvent notifies the parent that a child has got the focus: unlike
1552 // wxFocusEvent it is propagated upwards the window chain
1553 class WXDLLIMPEXP_CORE wxChildFocusEvent : public wxCommandEvent
1554 {
1555 public:
1556     wxChildFocusEvent(wxWindow *win = NULL);
1557
1558     wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1559
1560     virtual wxEvent *Clone() const { return new wxChildFocusEvent(*this); }
1561
1562 private:
1563     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxChildFocusEvent)
1564 };
1565
1566 // Activate event class
1567 /*
1568  wxEVT_ACTIVATE
1569  wxEVT_ACTIVATE_APP
1570  wxEVT_HIBERNATE
1571  */
1572
1573 class WXDLLIMPEXP_CORE wxActivateEvent : public wxEvent
1574 {
1575 public:
1576     wxActivateEvent(wxEventType type = wxEVT_NULL, bool active = true, int Id = 0)
1577         : wxEvent(Id, type)
1578         { m_active = active; }
1579     wxActivateEvent(const wxActivateEvent& event)
1580         : wxEvent(event)
1581     { m_active = event.m_active; }
1582
1583     bool GetActive() const { return m_active; }
1584
1585     virtual wxEvent *Clone() const { return new wxActivateEvent(*this); }
1586
1587 private:
1588     bool m_active;
1589
1590 private:
1591     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxActivateEvent)
1592 };
1593
1594 // InitDialog event class
1595 /*
1596  wxEVT_INIT_DIALOG
1597  */
1598
1599 class WXDLLIMPEXP_CORE wxInitDialogEvent : public wxEvent
1600 {
1601 public:
1602     wxInitDialogEvent(int Id = 0)
1603         : wxEvent(Id, wxEVT_INIT_DIALOG)
1604         { }
1605
1606     virtual wxEvent *Clone() const { return new wxInitDialogEvent(*this); }
1607
1608 private:
1609     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxInitDialogEvent)
1610 };
1611
1612 // Miscellaneous menu event class
1613 /*
1614  wxEVT_MENU_OPEN,
1615  wxEVT_MENU_CLOSE,
1616  wxEVT_MENU_HIGHLIGHT,
1617 */
1618
1619 class WXDLLIMPEXP_CORE wxMenuEvent : public wxEvent
1620 {
1621 public:
1622     wxMenuEvent(wxEventType type = wxEVT_NULL, int winid = 0, wxMenu* menu = NULL)
1623         : wxEvent(winid, type)
1624         { m_menuId = winid; m_menu = menu; }
1625     wxMenuEvent(const wxMenuEvent & event)
1626         : wxEvent(event)
1627     { m_menuId = event.m_menuId; m_menu = event.m_menu; }
1628
1629     // only for wxEVT_MENU_HIGHLIGHT
1630     int GetMenuId() const { return m_menuId; }
1631
1632     // only for wxEVT_MENU_OPEN/CLOSE
1633     bool IsPopup() const { return m_menuId == wxID_ANY; }
1634
1635     // only for wxEVT_MENU_OPEN/CLOSE
1636     wxMenu* GetMenu() const { return m_menu; }
1637
1638     virtual wxEvent *Clone() const { return new wxMenuEvent(*this); }
1639
1640 private:
1641     int     m_menuId;
1642     wxMenu* m_menu;
1643
1644     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMenuEvent)
1645 };
1646
1647 // Window close or session close event class
1648 /*
1649  wxEVT_CLOSE_WINDOW,
1650  wxEVT_END_SESSION,
1651  wxEVT_QUERY_END_SESSION
1652  */
1653
1654 class WXDLLIMPEXP_CORE wxCloseEvent : public wxEvent
1655 {
1656 public:
1657     wxCloseEvent(wxEventType type = wxEVT_NULL, int winid = 0)
1658         : wxEvent(winid, type),
1659           m_loggingOff(true),
1660           m_veto(false),      // should be false by default
1661           m_canVeto(true) {}
1662
1663     wxCloseEvent(const wxCloseEvent & event)
1664         : wxEvent(event),
1665         m_loggingOff(event.m_loggingOff),
1666         m_veto(event.m_veto),
1667         m_canVeto(event.m_canVeto) {}
1668
1669     void SetLoggingOff(bool logOff) { m_loggingOff = logOff; }
1670     bool GetLoggingOff() const
1671     {
1672         // m_loggingOff flag is only used by wxEVT_[QUERY_]END_SESSION, it
1673         // doesn't make sense for wxEVT_CLOSE_WINDOW
1674         wxASSERT_MSG( m_eventType != wxEVT_CLOSE_WINDOW,
1675                       _T("this flag is for end session events only") );
1676
1677         return m_loggingOff;
1678     }
1679
1680     void Veto(bool veto = true)
1681     {
1682         // GetVeto() will return false anyhow...
1683         wxCHECK_RET( m_canVeto,
1684                      wxT("call to Veto() ignored (can't veto this event)") );
1685
1686         m_veto = veto;
1687     }
1688     void SetCanVeto(bool canVeto) { m_canVeto = canVeto; }
1689     bool CanVeto() const { return m_canVeto; }
1690     bool GetVeto() const { return m_canVeto && m_veto; }
1691
1692     virtual wxEvent *Clone() const { return new wxCloseEvent(*this); }
1693
1694 protected:
1695     bool m_loggingOff,
1696          m_veto,
1697          m_canVeto;
1698
1699 private:
1700     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCloseEvent)
1701 };
1702
1703 /*
1704  wxEVT_SHOW
1705  */
1706
1707 class WXDLLIMPEXP_CORE wxShowEvent : public wxEvent
1708 {
1709 public:
1710     wxShowEvent(int winid = 0, bool show = false)
1711         : wxEvent(winid, wxEVT_SHOW)
1712         { m_show = show; }
1713     wxShowEvent(const wxShowEvent & event)
1714         : wxEvent(event)
1715     { m_show = event.m_show; }
1716
1717     void SetShow(bool show) { m_show = show; }
1718
1719     // return true if the window was shown, false if hidden
1720     bool IsShown() const { return m_show; }
1721
1722 #if WXWIN_COMPATIBILITY_2_8
1723     wxDEPRECATED( bool GetShow() const { return IsShown(); } )
1724 #endif
1725
1726     virtual wxEvent *Clone() const { return new wxShowEvent(*this); }
1727
1728 protected:
1729     bool m_show;
1730
1731 private:
1732     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxShowEvent)
1733 };
1734
1735 /*
1736  wxEVT_ICONIZE
1737  */
1738
1739 class WXDLLIMPEXP_CORE wxIconizeEvent : public wxEvent
1740 {
1741 public:
1742     wxIconizeEvent(int winid = 0, bool iconized = true)
1743         : wxEvent(winid, wxEVT_ICONIZE)
1744         { m_iconized = iconized; }
1745     wxIconizeEvent(const wxIconizeEvent & event)
1746         : wxEvent(event)
1747     { m_iconized = event.m_iconized; }
1748
1749 #if WXWIN_COMPATIBILITY_2_8
1750     wxDEPRECATED( bool Iconized() const { return IsIconized(); } )
1751 #endif
1752     // return true if the frame was iconized, false if restored
1753     bool IsIconized() const { return m_iconized; }
1754
1755     virtual wxEvent *Clone() const { return new wxIconizeEvent(*this); }
1756
1757 protected:
1758     bool m_iconized;
1759
1760 private:
1761     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIconizeEvent)
1762 };
1763 /*
1764  wxEVT_MAXIMIZE
1765  */
1766
1767 class WXDLLIMPEXP_CORE wxMaximizeEvent : public wxEvent
1768 {
1769 public:
1770     wxMaximizeEvent(int winid = 0)
1771         : wxEvent(winid, wxEVT_MAXIMIZE)
1772         { }
1773
1774     virtual wxEvent *Clone() const { return new wxMaximizeEvent(*this); }
1775
1776 private:
1777     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMaximizeEvent)
1778 };
1779
1780 // Joystick event class
1781 /*
1782  wxEVT_JOY_BUTTON_DOWN,
1783  wxEVT_JOY_BUTTON_UP,
1784  wxEVT_JOY_MOVE,
1785  wxEVT_JOY_ZMOVE
1786 */
1787
1788 // Which joystick? Same as Windows ids so no conversion necessary.
1789 enum
1790 {
1791     wxJOYSTICK1,
1792     wxJOYSTICK2
1793 };
1794
1795 // Which button is down?
1796 enum
1797 {
1798     wxJOY_BUTTON_ANY = -1,
1799     wxJOY_BUTTON1    = 1,
1800     wxJOY_BUTTON2    = 2,
1801     wxJOY_BUTTON3    = 4,
1802     wxJOY_BUTTON4    = 8
1803 };
1804
1805 class WXDLLIMPEXP_CORE wxJoystickEvent : public wxEvent
1806 {
1807 protected:
1808     wxPoint   m_pos;
1809     int       m_zPosition;
1810     int       m_buttonChange;   // Which button changed?
1811     int       m_buttonState;    // Which buttons are down?
1812     int       m_joyStick;       // Which joystick?
1813
1814 public:
1815     wxJoystickEvent(wxEventType type = wxEVT_NULL,
1816                     int state = 0,
1817                     int joystick = wxJOYSTICK1,
1818                     int change = 0)
1819         : wxEvent(0, type),
1820           m_pos(),
1821           m_zPosition(0),
1822           m_buttonChange(change),
1823           m_buttonState(state),
1824           m_joyStick(joystick)
1825     {
1826     }
1827     wxJoystickEvent(const wxJoystickEvent & event)
1828         : wxEvent(event),
1829           m_pos(event.m_pos),
1830           m_zPosition(event.m_zPosition),
1831           m_buttonChange(event.m_buttonChange),
1832           m_buttonState(event.m_buttonState),
1833           m_joyStick(event.m_joyStick)
1834     { }
1835
1836     wxPoint GetPosition() const { return m_pos; }
1837     int GetZPosition() const { return m_zPosition; }
1838     int GetButtonState() const { return m_buttonState; }
1839     int GetButtonChange() const { return m_buttonChange; }
1840     int GetJoystick() const { return m_joyStick; }
1841
1842     void SetJoystick(int stick) { m_joyStick = stick; }
1843     void SetButtonState(int state) { m_buttonState = state; }
1844     void SetButtonChange(int change) { m_buttonChange = change; }
1845     void SetPosition(const wxPoint& pos) { m_pos = pos; }
1846     void SetZPosition(int zPos) { m_zPosition = zPos; }
1847
1848     // Was it a button event? (*doesn't* mean: is any button *down*?)
1849     bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) ||
1850             (GetEventType() == wxEVT_JOY_BUTTON_UP)); }
1851
1852     // Was it a move event?
1853     bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE); }
1854
1855     // Was it a zmove event?
1856     bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE); }
1857
1858     // Was it a down event from button 1, 2, 3, 4 or any?
1859     bool ButtonDown(int but = wxJOY_BUTTON_ANY) const
1860     { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) &&
1861             ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
1862
1863     // Was it a up event from button 1, 2, 3 or any?
1864     bool ButtonUp(int but = wxJOY_BUTTON_ANY) const
1865     { return ((GetEventType() == wxEVT_JOY_BUTTON_UP) &&
1866             ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
1867
1868     // Was the given button 1,2,3,4 or any in Down state?
1869     bool ButtonIsDown(int but =  wxJOY_BUTTON_ANY) const
1870     { return (((but == wxJOY_BUTTON_ANY) && (m_buttonState != 0)) ||
1871             ((m_buttonState & but) == but)); }
1872
1873     virtual wxEvent *Clone() const { return new wxJoystickEvent(*this); }
1874
1875 private:
1876     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxJoystickEvent)
1877 };
1878
1879 // Drop files event class
1880 /*
1881  wxEVT_DROP_FILES
1882  */
1883
1884 class WXDLLIMPEXP_CORE wxDropFilesEvent : public wxEvent
1885 {
1886 public:
1887     int       m_noFiles;
1888     wxPoint   m_pos;
1889     wxString* m_files;
1890
1891     wxDropFilesEvent(wxEventType type = wxEVT_NULL,
1892                      int noFiles = 0,
1893                      wxString *files = (wxString *) NULL)
1894         : wxEvent(0, type),
1895           m_noFiles(noFiles),
1896           m_pos(),
1897           m_files(files)
1898         { }
1899
1900     // we need a copy ctor to avoid deleting m_files pointer twice
1901     wxDropFilesEvent(const wxDropFilesEvent& other)
1902         : wxEvent(other),
1903           m_noFiles(other.m_noFiles),
1904           m_pos(other.m_pos),
1905           m_files(NULL)
1906     {
1907         m_files = new wxString[m_noFiles];
1908         for ( int n = 0; n < m_noFiles; n++ )
1909         {
1910             m_files[n] = other.m_files[n];
1911         }
1912     }
1913
1914     virtual ~wxDropFilesEvent()
1915     {
1916         delete [] m_files;
1917     }
1918
1919     wxPoint GetPosition() const { return m_pos; }
1920     int GetNumberOfFiles() const { return m_noFiles; }
1921     wxString *GetFiles() const { return m_files; }
1922
1923     virtual wxEvent *Clone() const { return new wxDropFilesEvent(*this); }
1924
1925 private:
1926     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDropFilesEvent)
1927 };
1928
1929 // Update UI event
1930 /*
1931  wxEVT_UPDATE_UI
1932  */
1933
1934 // Whether to always send update events to windows, or
1935 // to only send update events to those with the
1936 // wxWS_EX_PROCESS_UI_UPDATES style.
1937
1938 enum wxUpdateUIMode
1939 {
1940         // Send UI update events to all windows
1941     wxUPDATE_UI_PROCESS_ALL,
1942
1943         // Send UI update events to windows that have
1944         // the wxWS_EX_PROCESS_UI_UPDATES flag specified
1945     wxUPDATE_UI_PROCESS_SPECIFIED
1946 };
1947
1948 class WXDLLIMPEXP_CORE wxUpdateUIEvent : public wxCommandEvent
1949 {
1950 public:
1951     wxUpdateUIEvent(wxWindowID commandId = 0)
1952         : wxCommandEvent(wxEVT_UPDATE_UI, commandId)
1953     {
1954         m_checked =
1955         m_enabled =
1956         m_shown =
1957         m_setEnabled =
1958         m_setShown =
1959         m_setText =
1960         m_setChecked = false;
1961     }
1962     wxUpdateUIEvent(const wxUpdateUIEvent & event)
1963         : wxCommandEvent(event),
1964           m_checked(event.m_checked),
1965           m_enabled(event.m_enabled),
1966           m_shown(event.m_shown),
1967           m_setEnabled(event.m_setEnabled),
1968           m_setShown(event.m_setShown),
1969           m_setText(event.m_setText),
1970           m_setChecked(event.m_setChecked),
1971           m_text(event.m_text)
1972     { }
1973
1974     bool GetChecked() const { return m_checked; }
1975     bool GetEnabled() const { return m_enabled; }
1976     bool GetShown() const { return m_shown; }
1977     wxString GetText() const { return m_text; }
1978     bool GetSetText() const { return m_setText; }
1979     bool GetSetChecked() const { return m_setChecked; }
1980     bool GetSetEnabled() const { return m_setEnabled; }
1981     bool GetSetShown() const { return m_setShown; }
1982
1983     void Check(bool check) { m_checked = check; m_setChecked = true; }
1984     void Enable(bool enable) { m_enabled = enable; m_setEnabled = true; }
1985     void Show(bool show) { m_shown = show; m_setShown = true; }
1986     void SetText(const wxString& text) { m_text = text; m_setText = true; }
1987
1988     // Sets the interval between updates in milliseconds.
1989     // Set to -1 to disable updates, or to 0 to update as frequently as possible.
1990     static void SetUpdateInterval(long updateInterval) { sm_updateInterval = updateInterval; }
1991
1992     // Returns the current interval between updates in milliseconds
1993     static long GetUpdateInterval() { return sm_updateInterval; }
1994
1995     // Can we update this window?
1996     static bool CanUpdate(wxWindowBase *win);
1997
1998     // Reset the update time to provide a delay until the next
1999     // time we should update
2000     static void ResetUpdateTime();
2001
2002     // Specify how wxWidgets will send update events: to
2003     // all windows, or only to those which specify that they
2004     // will process the events.
2005     static void SetMode(wxUpdateUIMode mode) { sm_updateMode = mode; }
2006
2007     // Returns the UI update mode
2008     static wxUpdateUIMode GetMode() { return sm_updateMode; }
2009
2010     virtual wxEvent *Clone() const { return new wxUpdateUIEvent(*this); }
2011
2012 protected:
2013     bool          m_checked;
2014     bool          m_enabled;
2015     bool          m_shown;
2016     bool          m_setEnabled;
2017     bool          m_setShown;
2018     bool          m_setText;
2019     bool          m_setChecked;
2020     wxString      m_text;
2021 #if wxUSE_LONGLONG
2022     static wxLongLong       sm_lastUpdate;
2023 #endif
2024     static long             sm_updateInterval;
2025     static wxUpdateUIMode   sm_updateMode;
2026
2027 private:
2028     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxUpdateUIEvent)
2029 };
2030
2031 /*
2032  wxEVT_SYS_COLOUR_CHANGED
2033  */
2034
2035 // TODO: shouldn't all events record the window ID?
2036 class WXDLLIMPEXP_CORE wxSysColourChangedEvent : public wxEvent
2037 {
2038 public:
2039     wxSysColourChangedEvent()
2040         : wxEvent(0, wxEVT_SYS_COLOUR_CHANGED)
2041         { }
2042
2043     virtual wxEvent *Clone() const { return new wxSysColourChangedEvent(*this); }
2044
2045 private:
2046     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSysColourChangedEvent)
2047 };
2048
2049 /*
2050  wxEVT_MOUSE_CAPTURE_CHANGED
2051  The window losing the capture receives this message
2052  (even if it released the capture itself).
2053  */
2054
2055 class WXDLLIMPEXP_CORE wxMouseCaptureChangedEvent : public wxEvent
2056 {
2057 public:
2058     wxMouseCaptureChangedEvent(wxWindowID winid = 0, wxWindow* gainedCapture = NULL)
2059         : wxEvent(winid, wxEVT_MOUSE_CAPTURE_CHANGED),
2060           m_gainedCapture(gainedCapture)
2061         { }
2062
2063     wxMouseCaptureChangedEvent(const wxMouseCaptureChangedEvent& event)
2064         : wxEvent(event),
2065           m_gainedCapture(event.m_gainedCapture)
2066         { }
2067
2068     virtual wxEvent *Clone() const { return new wxMouseCaptureChangedEvent(*this); }
2069
2070     wxWindow* GetCapturedWindow() const { return m_gainedCapture; }
2071
2072 private:
2073     wxWindow* m_gainedCapture;
2074
2075     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureChangedEvent)
2076 };
2077
2078 /*
2079  wxEVT_MOUSE_CAPTURE_LOST
2080  The window losing the capture receives this message, unless it released it
2081  it itself or unless wxWindow::CaptureMouse was called on another window
2082  (and so capture will be restored when the new capturer releases it).
2083  */
2084
2085 class WXDLLIMPEXP_CORE wxMouseCaptureLostEvent : public wxEvent
2086 {
2087 public:
2088     wxMouseCaptureLostEvent(wxWindowID winid = 0)
2089         : wxEvent(winid, wxEVT_MOUSE_CAPTURE_LOST)
2090     {}
2091
2092     wxMouseCaptureLostEvent(const wxMouseCaptureLostEvent& event)
2093         : wxEvent(event)
2094     {}
2095
2096     virtual wxEvent *Clone() const { return new wxMouseCaptureLostEvent(*this); }
2097
2098     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureLostEvent)
2099 };
2100
2101 /*
2102  wxEVT_DISPLAY_CHANGED
2103  */
2104 class WXDLLIMPEXP_CORE wxDisplayChangedEvent : public wxEvent
2105 {
2106 private:
2107     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDisplayChangedEvent)
2108
2109 public:
2110     wxDisplayChangedEvent()
2111         : wxEvent(0, wxEVT_DISPLAY_CHANGED)
2112         { }
2113
2114     virtual wxEvent *Clone() const { return new wxDisplayChangedEvent(*this); }
2115 };
2116
2117 /*
2118  wxEVT_PALETTE_CHANGED
2119  */
2120
2121 class WXDLLIMPEXP_CORE wxPaletteChangedEvent : public wxEvent
2122 {
2123 public:
2124     wxPaletteChangedEvent(wxWindowID winid = 0)
2125         : wxEvent(winid, wxEVT_PALETTE_CHANGED),
2126           m_changedWindow((wxWindow *) NULL)
2127         { }
2128
2129     wxPaletteChangedEvent(const wxPaletteChangedEvent& event)
2130         : wxEvent(event),
2131           m_changedWindow(event.m_changedWindow)
2132         { }
2133
2134     void SetChangedWindow(wxWindow* win) { m_changedWindow = win; }
2135     wxWindow* GetChangedWindow() const { return m_changedWindow; }
2136
2137     virtual wxEvent *Clone() const { return new wxPaletteChangedEvent(*this); }
2138
2139 protected:
2140     wxWindow*     m_changedWindow;
2141
2142 private:
2143     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaletteChangedEvent)
2144 };
2145
2146 /*
2147  wxEVT_QUERY_NEW_PALETTE
2148  Indicates the window is getting keyboard focus and should re-do its palette.
2149  */
2150
2151 class WXDLLIMPEXP_CORE wxQueryNewPaletteEvent : public wxEvent
2152 {
2153 public:
2154     wxQueryNewPaletteEvent(wxWindowID winid = 0)
2155         : wxEvent(winid, wxEVT_QUERY_NEW_PALETTE),
2156           m_paletteRealized(false)
2157         { }
2158     wxQueryNewPaletteEvent(const wxQueryNewPaletteEvent & event)
2159         : wxEvent(event),
2160         m_paletteRealized(event.m_paletteRealized)
2161     { }
2162
2163     // App sets this if it changes the palette.
2164     void SetPaletteRealized(bool realized) { m_paletteRealized = realized; }
2165     bool GetPaletteRealized() const { return m_paletteRealized; }
2166
2167     virtual wxEvent *Clone() const { return new wxQueryNewPaletteEvent(*this); }
2168
2169 protected:
2170     bool m_paletteRealized;
2171
2172 private:
2173     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxQueryNewPaletteEvent)
2174 };
2175
2176 /*
2177  Event generated by dialog navigation keys
2178  wxEVT_NAVIGATION_KEY
2179  */
2180 // NB: don't derive from command event to avoid being propagated to the parent
2181 class WXDLLIMPEXP_CORE wxNavigationKeyEvent : public wxEvent
2182 {
2183 public:
2184     wxNavigationKeyEvent()
2185         : wxEvent(0, wxEVT_NAVIGATION_KEY),
2186           m_flags(IsForward | FromTab),    // defaults are for TAB
2187           m_focus((wxWindow *)NULL)
2188         {
2189             m_propagationLevel = wxEVENT_PROPAGATE_NONE;
2190         }
2191
2192     wxNavigationKeyEvent(const wxNavigationKeyEvent& event)
2193         : wxEvent(event),
2194           m_flags(event.m_flags),
2195           m_focus(event.m_focus)
2196         { }
2197
2198     // direction: forward (true) or backward (false)
2199     bool GetDirection() const
2200         { return (m_flags & IsForward) != 0; }
2201     void SetDirection(bool bForward)
2202         { if ( bForward ) m_flags |= IsForward; else m_flags &= ~IsForward; }
2203
2204     // it may be a window change event (MDI, notebook pages...) or a control
2205     // change event
2206     bool IsWindowChange() const
2207         { return (m_flags & WinChange) != 0; }
2208     void SetWindowChange(bool bIs)
2209         { if ( bIs ) m_flags |= WinChange; else m_flags &= ~WinChange; }
2210
2211     // Set to true under MSW if the event was generated using the tab key.
2212     // This is required for proper navogation over radio buttons
2213     bool IsFromTab() const
2214         { return (m_flags & FromTab) != 0; }
2215     void SetFromTab(bool bIs)
2216         { if ( bIs ) m_flags |= FromTab; else m_flags &= ~FromTab; }
2217
2218     // the child which has the focus currently (may be NULL - use
2219     // wxWindow::FindFocus then)
2220     wxWindow* GetCurrentFocus() const { return m_focus; }
2221     void SetCurrentFocus(wxWindow *win) { m_focus = win; }
2222
2223     // Set flags
2224     void SetFlags(long flags) { m_flags = flags; }
2225
2226     virtual wxEvent *Clone() const { return new wxNavigationKeyEvent(*this); }
2227
2228     enum
2229     {
2230         IsBackward = 0x0000,
2231         IsForward = 0x0001,
2232         WinChange = 0x0002,
2233         FromTab = 0x0004
2234     };
2235
2236     long m_flags;
2237     wxWindow *m_focus;
2238
2239 private:
2240     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNavigationKeyEvent)
2241 };
2242
2243 // Window creation/destruction events: the first is sent as soon as window is
2244 // created (i.e. the underlying GUI object exists), but when the C++ object is
2245 // fully initialized (so virtual functions may be called). The second,
2246 // wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
2247 // still safe to call virtual functions at this moment
2248 /*
2249  wxEVT_CREATE
2250  wxEVT_DESTROY
2251  */
2252
2253 class WXDLLIMPEXP_CORE wxWindowCreateEvent : public wxCommandEvent
2254 {
2255 public:
2256     wxWindowCreateEvent(wxWindow *win = NULL);
2257
2258     wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
2259
2260     virtual wxEvent *Clone() const { return new wxWindowCreateEvent(*this); }
2261
2262 private:
2263     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowCreateEvent)
2264 };
2265
2266 class WXDLLIMPEXP_CORE wxWindowDestroyEvent : public wxCommandEvent
2267 {
2268 public:
2269     wxWindowDestroyEvent(wxWindow *win = NULL);
2270
2271     wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
2272
2273     virtual wxEvent *Clone() const { return new wxWindowDestroyEvent(*this); }
2274
2275 private:
2276     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowDestroyEvent)
2277 };
2278
2279 // A help event is sent when the user clicks on a window in context-help mode.
2280 /*
2281  wxEVT_HELP
2282  wxEVT_DETAILED_HELP
2283 */
2284
2285 class WXDLLIMPEXP_CORE wxHelpEvent : public wxCommandEvent
2286 {
2287 public:
2288     // how was this help event generated?
2289     enum Origin
2290     {
2291         Origin_Unknown,    // unrecognized event source
2292         Origin_Keyboard,   // event generated from F1 key press
2293         Origin_HelpButton  // event from [?] button on the title bar (Windows)
2294     };
2295
2296     wxHelpEvent(wxEventType type = wxEVT_NULL,
2297                 wxWindowID winid = 0,
2298                 const wxPoint& pt = wxDefaultPosition,
2299                 Origin origin = Origin_Unknown)
2300         : wxCommandEvent(type, winid),
2301           m_pos(pt),
2302           m_origin(GuessOrigin(origin))
2303     { }
2304     wxHelpEvent(const wxHelpEvent & event)
2305         : wxCommandEvent(event),
2306           m_pos(event.m_pos),
2307           m_target(event.m_target),
2308           m_link(event.m_link),
2309           m_origin(event.m_origin)
2310     { }
2311
2312     // Position of event (in screen coordinates)
2313     const wxPoint& GetPosition() const { return m_pos; }
2314     void SetPosition(const wxPoint& pos) { m_pos = pos; }
2315
2316     // Optional link to further help
2317     const wxString& GetLink() const { return m_link; }
2318     void SetLink(const wxString& link) { m_link = link; }
2319
2320     // Optional target to display help in. E.g. a window specification
2321     const wxString& GetTarget() const { return m_target; }
2322     void SetTarget(const wxString& target) { m_target = target; }
2323
2324     virtual wxEvent *Clone() const { return new wxHelpEvent(*this); }
2325
2326     // optional indication of the event source
2327     Origin GetOrigin() const { return m_origin; }
2328     void SetOrigin(Origin origin) { m_origin = origin; }
2329
2330 protected:
2331     wxPoint   m_pos;
2332     wxString  m_target;
2333     wxString  m_link;
2334     Origin    m_origin;
2335
2336     // we can try to guess the event origin ourselves, even if none is
2337     // specified in the ctor
2338     static Origin GuessOrigin(Origin origin);
2339
2340 private:
2341     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHelpEvent)
2342 };
2343
2344 // A Clipboard Text event is sent when a window intercepts text copy/cut/paste
2345 // message, i.e. the user has cut/copied/pasted data from/into a text control
2346 // via ctrl-C/X/V, ctrl/shift-del/insert, a popup menu command, etc.
2347 // NOTE : under windows these events are *NOT* generated automatically
2348 // for a Rich Edit text control.
2349 /*
2350 wxEVT_COMMAND_TEXT_COPY
2351 wxEVT_COMMAND_TEXT_CUT
2352 wxEVT_COMMAND_TEXT_PASTE
2353 */
2354
2355 class WXDLLIMPEXP_CORE wxClipboardTextEvent : public wxCommandEvent
2356 {
2357 public:
2358     wxClipboardTextEvent(wxEventType type = wxEVT_NULL,
2359                      wxWindowID winid = 0)
2360         : wxCommandEvent(type, winid)
2361     { }
2362     wxClipboardTextEvent(const wxClipboardTextEvent & event)
2363         : wxCommandEvent(event)
2364     { }
2365
2366     virtual wxEvent *Clone() const { return new wxClipboardTextEvent(*this); }
2367
2368 private:
2369     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxClipboardTextEvent)
2370 };
2371
2372 // A Context event is sent when the user right clicks on a window or
2373 // presses Shift-F10
2374 // NOTE : Under windows this is a repackaged WM_CONTETXMENU message
2375 //        Under other systems it may have to be generated from a right click event
2376 /*
2377  wxEVT_CONTEXT_MENU
2378 */
2379
2380 class WXDLLIMPEXP_CORE wxContextMenuEvent : public wxCommandEvent
2381 {
2382 public:
2383     wxContextMenuEvent(wxEventType type = wxEVT_NULL,
2384                        wxWindowID winid = 0,
2385                        const wxPoint& pt = wxDefaultPosition)
2386         : wxCommandEvent(type, winid),
2387           m_pos(pt)
2388     { }
2389     wxContextMenuEvent(const wxContextMenuEvent & event)
2390         : wxCommandEvent(event),
2391         m_pos(event.m_pos)
2392     { }
2393
2394     // Position of event (in screen coordinates)
2395     const wxPoint& GetPosition() const { return m_pos; }
2396     void SetPosition(const wxPoint& pos) { m_pos = pos; }
2397
2398     virtual wxEvent *Clone() const { return new wxContextMenuEvent(*this); }
2399
2400 protected:
2401     wxPoint   m_pos;
2402
2403 private:
2404     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxContextMenuEvent)
2405 };
2406
2407 #endif // wxUSE_GUI
2408
2409 // Idle event
2410 /*
2411  wxEVT_IDLE
2412  */
2413
2414 // Whether to always send idle events to windows, or
2415 // to only send update events to those with the
2416 // wxWS_EX_PROCESS_IDLE style.
2417
2418 enum wxIdleMode
2419 {
2420         // Send idle events to all windows
2421     wxIDLE_PROCESS_ALL,
2422
2423         // Send idle events to windows that have
2424         // the wxWS_EX_PROCESS_IDLE flag specified
2425     wxIDLE_PROCESS_SPECIFIED
2426 };
2427
2428 class WXDLLIMPEXP_BASE wxIdleEvent : public wxEvent
2429 {
2430 public:
2431     wxIdleEvent()
2432         : wxEvent(0, wxEVT_IDLE),
2433           m_requestMore(false)
2434         { }
2435     wxIdleEvent(const wxIdleEvent & event)
2436         : wxEvent(event),
2437           m_requestMore(event.m_requestMore)
2438     { }
2439
2440     void RequestMore(bool needMore = true) { m_requestMore = needMore; }
2441     bool MoreRequested() const { return m_requestMore; }
2442
2443     virtual wxEvent *Clone() const { return new wxIdleEvent(*this); }
2444
2445     // Specify how wxWidgets will send idle events: to
2446     // all windows, or only to those which specify that they
2447     // will process the events.
2448     static void SetMode(wxIdleMode mode) { sm_idleMode = mode; }
2449
2450     // Returns the idle event mode
2451     static wxIdleMode GetMode() { return sm_idleMode; }
2452
2453 protected:
2454     bool m_requestMore;
2455     static wxIdleMode sm_idleMode;
2456
2457 private:
2458     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIdleEvent)
2459 };
2460
2461 /* TODO
2462  wxEVT_MOUSE_CAPTURE_CHANGED,
2463  wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
2464 // wxEVT_FONT_CHANGED,  // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
2465                         // wxEVT_FONT_CHANGED to all other windows (maybe).
2466  wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
2467  wxEVT_MEASURE_ITEM,
2468  wxEVT_COMPARE_ITEM
2469 */
2470
2471
2472 // ============================================================================
2473 // event handler and related classes
2474 // ============================================================================
2475
2476
2477 // struct containing the members common to static and dynamic event tables
2478 // entries
2479 struct WXDLLIMPEXP_BASE wxEventTableEntryBase
2480 {
2481     wxEventTableEntryBase(int winid, int idLast,
2482                           wxEventFunctor* fn, wxObject *data)
2483         : m_id(winid),
2484           m_lastId(idLast),
2485           m_fn(fn),
2486           m_callbackUserData(data)
2487     { }
2488
2489     wxEventTableEntryBase( const wxEventTableEntryBase &entry )
2490         : m_id( entry.m_id ),
2491           m_lastId( entry.m_lastId ),
2492           m_fn( entry.m_fn ),
2493           m_callbackUserData( entry.m_callbackUserData )
2494     {
2495         // This is a 'hack' to ensure that only one instance tries to delete
2496         // the functor pointer. It is safe as long as the only place where the
2497         // copy constructor is being called is when the static event tables are
2498         // being initialized (a temporary instance is created and then this
2499         // constructor is called).
2500
2501         const_cast< wxEventTableEntryBase & >( entry ).m_fn = NULL;
2502     }
2503
2504     ~wxEventTableEntryBase()
2505     {
2506         delete m_fn;
2507     }
2508
2509     // the range of ids for this entry: if m_lastId == wxID_ANY, the range
2510     // consists only of m_id, otherwise it is m_id..m_lastId inclusive
2511     int m_id,
2512         m_lastId;
2513
2514     // function/method/functor to call
2515     wxEventFunctor* m_fn;
2516
2517     // arbitrary user data associated with the callback
2518     wxObject* m_callbackUserData;
2519
2520 private:
2521     wxEventTableEntryBase &operator = ( const wxEventTableEntryBase & );
2522 };
2523
2524 // an entry from a static event table
2525 struct WXDLLIMPEXP_BASE wxEventTableEntry : public wxEventTableEntryBase
2526 {
2527     wxEventTableEntry(const int& evType, int winid, int idLast,
2528                       wxEventFunctor* fn, wxObject *data)
2529         : wxEventTableEntryBase(winid, idLast, fn, data),
2530         m_eventType(evType)
2531     { }
2532
2533     // the reference to event type: this allows us to not care about the
2534     // (undefined) order in which the event table entries and the event types
2535     // are initialized: initially the value of this reference might be
2536     // invalid, but by the time it is used for the first time, all global
2537     // objects will have been initialized (including the event type constants)
2538     // and so it will have the correct value when it is needed
2539     const int& m_eventType;
2540
2541 private:
2542     wxEventTableEntry &operator = ( const wxEventTableEntry & );
2543 };
2544
2545 // an entry used in dynamic event table managed by wxEvtHandler::Connect()
2546 struct WXDLLIMPEXP_BASE wxDynamicEventTableEntry : public wxEventTableEntryBase
2547 {
2548     wxDynamicEventTableEntry(int evType, int winid, int idLast,
2549                              wxEventFunctor* fn, wxObject *data)
2550         : wxEventTableEntryBase(winid, idLast, fn, data),
2551           m_eventType(evType)
2552     { }
2553
2554     // not a reference here as we can't keep a reference to a temporary int
2555     // created to wrap the constant value typically passed to Connect() - nor
2556     // do we need it
2557     int m_eventType;
2558
2559 private:
2560     wxDynamicEventTableEntry &operator = ( const wxDynamicEventTableEntry & );
2561 };
2562
2563 // ----------------------------------------------------------------------------
2564 // wxEventTable: an array of event entries terminated with {0, 0, 0, 0, 0}
2565 // ----------------------------------------------------------------------------
2566
2567 struct WXDLLIMPEXP_BASE wxEventTable
2568 {
2569     const wxEventTable *baseTable;    // base event table (next in chain)
2570     const wxEventTableEntry *entries; // bottom of entry array
2571 };
2572
2573 // ----------------------------------------------------------------------------
2574 // wxEventHashTable: a helper of wxEvtHandler to speed up wxEventTable lookups.
2575 // ----------------------------------------------------------------------------
2576
2577 WX_DEFINE_ARRAY_PTR(const wxEventTableEntry*, wxEventTableEntryPointerArray);
2578
2579 class WXDLLIMPEXP_BASE wxEventHashTable
2580 {
2581 private:
2582     // Internal data structs
2583     struct EventTypeTable
2584     {
2585         wxEventType                   eventType;
2586         wxEventTableEntryPointerArray eventEntryTable;
2587     };
2588     typedef EventTypeTable* EventTypeTablePointer;
2589
2590 public:
2591     // Constructor, needs the event table it needs to hash later on.
2592     // Note: hashing of the event table is not done in the constructor as it
2593     //       can be that the event table is not yet full initialize, the hash
2594     //       will gets initialized when handling the first event look-up request.
2595     wxEventHashTable(const wxEventTable &table);
2596     // Destructor.
2597     ~wxEventHashTable();
2598
2599     // Handle the given event, in other words search the event table hash
2600     // and call self->ProcessEvent() if a match was found.
2601     bool HandleEvent(wxEvent &event, wxEvtHandler *self);
2602
2603     // Clear table
2604     void Clear();
2605
2606 #if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
2607     // Clear all tables
2608     static void ClearAll();
2609 #endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING
2610
2611 protected:
2612     // Init the hash table with the entries of the static event table.
2613     void InitHashTable();
2614     // Helper funtion of InitHashTable() to insert 1 entry into the hash table.
2615     void AddEntry(const wxEventTableEntry &entry);
2616     // Allocate and init with null pointers the base hash table.
2617     void AllocEventTypeTable(size_t size);
2618     // Grow the hash table in size and transfer all items currently
2619     // in the table to the correct location in the new table.
2620     void GrowEventTypeTable();
2621
2622 protected:
2623     const wxEventTable    &m_table;
2624     bool                   m_rebuildHash;
2625
2626     size_t                 m_size;
2627     EventTypeTablePointer *m_eventTypeTable;
2628
2629     static wxEventHashTable* sm_first;
2630     wxEventHashTable* m_previous;
2631     wxEventHashTable* m_next;
2632
2633     DECLARE_NO_COPY_CLASS(wxEventHashTable)
2634 };
2635
2636 // ----------------------------------------------------------------------------
2637 // wxEvtHandler: the base class for all objects handling wxWidgets events
2638 // ----------------------------------------------------------------------------
2639
2640 class WXDLLIMPEXP_BASE wxEvtHandler : public wxObject
2641                                     , public wxTrackable
2642 {
2643 public:
2644     wxEvtHandler();
2645     virtual ~wxEvtHandler();
2646
2647     wxEvtHandler *GetNextHandler() const { return m_nextHandler; }
2648     wxEvtHandler *GetPreviousHandler() const { return m_previousHandler; }
2649     void SetNextHandler(wxEvtHandler *handler) { m_nextHandler = handler; }
2650     void SetPreviousHandler(wxEvtHandler *handler) { m_previousHandler = handler; }
2651
2652     void SetEvtHandlerEnabled(bool enabled) { m_enabled = enabled; }
2653     bool GetEvtHandlerEnabled() const { return m_enabled; }
2654
2655     // Process an event right now: this can only be called from the main
2656     // thread, use QueueEvent() for scheduling the events for
2657     // processing from other threads.
2658     virtual bool ProcessEvent(wxEvent& event);
2659
2660     // Process an event by calling ProcessEvent and handling any exceptions
2661     // thrown by event handlers. It's mostly useful when processing wx events
2662     // when called from C code (e.g. in GTK+ callback) when the exception
2663     // wouldn't correctly propagate to wxEventLoop.
2664     bool SafelyProcessEvent(wxEvent& event);
2665
2666     // Schedule the given event to be processed later. It takes ownership of
2667     // the event pointer, i.e. it will be deleted later. This is safe to call
2668     // from multiple threads although you still need to ensure that wxString
2669     // fields of the event object are deep copies and not use the same string
2670     // buffer as other wxString objects in this thread.
2671     virtual void QueueEvent(wxEvent *event);
2672
2673     // Add an event to be processed later: notice that this function is not
2674     // safe to call from threads other than main, use QueueEvent()
2675     virtual void AddPendingEvent(const wxEvent& event)
2676     {
2677         // notice that the thread-safety problem comes from the fact that
2678         // Clone() doesn't make deep copies of wxString fields of wxEvent
2679         // object and so the same wxString could be used from both threads when
2680         // the event object is destroyed in this one -- QueueEvent() avoids
2681         // this problem as the event pointer is not used any more in this
2682         // thread at all after it is called.
2683         QueueEvent(event.Clone());
2684     }
2685
2686     void ProcessPendingEvents();
2687
2688 #if wxUSE_THREADS
2689     bool ProcessThreadEvent(const wxEvent& event);
2690 #endif
2691
2692     // Dynamic association of a member function handler with the event handler,
2693     // winid and event type
2694     void Connect(int winid,
2695                  int lastId,
2696                  wxEventType eventType,
2697                  wxObjectEventFunction func,
2698                  wxObject *userData = (wxObject *) NULL,
2699                  wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2700     {
2701         wxObjectEventFunctor *functor = wxNewEventFunctor( eventType, func, eventSink );
2702
2703         Subscribe( winid, lastId, eventType, functor, userData );
2704     }
2705
2706     // Convenience function: take just one id
2707     void Connect(int winid,
2708                  wxEventType eventType,
2709                  wxObjectEventFunction func,
2710                  wxObject *userData = (wxObject *) NULL,
2711                  wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2712         { Connect(winid, wxID_ANY, eventType, func, userData, eventSink); }
2713
2714     // Even more convenient: without id (same as using id of wxID_ANY)
2715     void Connect(wxEventType eventType,
2716                  wxObjectEventFunction func,
2717                  wxObject *userData = (wxObject *) NULL,
2718                  wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2719         { Connect(wxID_ANY, wxID_ANY, eventType, func, userData, eventSink); }
2720
2721     bool Disconnect(int winid,
2722                     int lastId,
2723                     wxEventType eventType,
2724                     wxObjectEventFunction func = NULL,
2725                     wxObject *userData = (wxObject *) NULL,
2726                     wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2727     {
2728         wxObjectEventFunctor functor = wxConstructEventFunctor( eventType, func, eventSink );
2729
2730         return Unsubscribe( winid, lastId, eventType, functor, userData );
2731     }
2732
2733     bool Disconnect(int winid = wxID_ANY,
2734                     wxEventType eventType = wxEVT_NULL,
2735                     wxObjectEventFunction func = NULL,
2736                     wxObject *userData = (wxObject *) NULL,
2737                     wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2738         { return Disconnect(winid, wxID_ANY, eventType, func, userData, eventSink); }
2739
2740     bool Disconnect(wxEventType eventType,
2741                     wxObjectEventFunction func,
2742                     wxObject *userData = (wxObject *) NULL,
2743                     wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2744         { return Disconnect(wxID_ANY, eventType, func, userData, eventSink); }
2745
2746
2747 #if !wxEVENTS_COMPATIBILITY_2_8
2748     //
2749     // Connect a function to an event:
2750     //
2751     template <typename EventType>
2752     void Connect(int winid,
2753                  int lastId,
2754                  const EventType &eventType,
2755                  void (*func)(typename EventType::CorrespondingEvent&),
2756                  wxObject* userData = NULL)
2757     {
2758         wxEventFunctorFunction< EventType > *functor = wxNewEventFunctor( eventType, func );
2759
2760         Subscribe( winid, lastId, eventType, functor, userData );
2761     }
2762
2763     template <typename EventType>
2764     void Connect( int winid,
2765             const EventType &eventType,
2766             void ( *func )( typename EventType::CorrespondingEvent & ),
2767             wxObject* userData = NULL )
2768         { Connect( winid, wxID_ANY, eventType, func, userData ); }
2769
2770     template <typename EventType>
2771     void Connect( const EventType &eventType,
2772             void ( *func )( typename EventType::CorrespondingEvent & ),
2773             wxObject* userData = NULL )
2774         { Connect( wxID_ANY, wxID_ANY, eventType, func, userData ); }
2775
2776     //
2777     // Connect a method to an event:
2778     //
2779
2780     template <typename EventType, typename Class>
2781     void Connect( int winid,
2782             int lastId,
2783             const EventType &eventType,
2784             void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2785             wxObject *userData = NULL )
2786         {
2787             wxEventFunctorMethod< EventType, Class, Class > *functor =
2788                 wxNewEventFunctor( eventType, func, static_cast< Class * const >( this ));
2789
2790             Subscribe( winid, lastId, eventType, functor, userData );
2791         }
2792
2793     template <typename EventType, typename Class>
2794     void Connect( int winid,
2795             const EventType &eventType,
2796             void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2797             wxObject *userData = NULL )
2798         { Connect( winid, wxID_ANY, eventType, func, userData ); }
2799
2800     template <typename EventType, typename Class>
2801     void Connect( const EventType &eventType,
2802             void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2803             wxObject *userData = NULL )
2804         { Connect( wxID_ANY, wxID_ANY, eventType, func, userData ); }
2805
2806     template <typename EventType, typename Class, typename Derived>
2807     void Connect( int winid,
2808             int lastId,
2809             const EventType &eventType,
2810             void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2811             wxObject *userData = NULL,
2812             Derived *eventSink = NULL )
2813         {
2814             wxEventFunctorMethod< EventType, Class, Derived > *functor =
2815                 wxNewEventFunctor( eventType, func, eventSink );
2816
2817             Subscribe( winid, lastId, eventType, functor, userData );
2818         }
2819
2820     template <typename EventType, typename Class, typename Derived>
2821     void Connect( int winid,
2822             const EventType &eventType,
2823             void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2824             wxObject *userData = NULL,
2825             Derived *eventSink = NULL )
2826         { Connect( winid, wxID_ANY, eventType, func, userData, eventSink ); }
2827
2828     template <typename EventType, typename Class, typename Derived>
2829     void Connect( const EventType &eventType,
2830             void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2831             wxObject *userData = NULL,
2832             Derived *eventSink = NULL )
2833         { Connect( wxID_ANY, wxID_ANY, eventType, func, userData, eventSink ); }
2834
2835     template <typename Sender, typename EventType, typename Class, typename Derived>
2836     static void Connect( Sender *sender,
2837             int winid,
2838             int lastId,
2839             const EventType &eventType,
2840             void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2841             wxObject *userData = NULL,
2842             Derived *eventSink = NULL )
2843     {
2844         wxEventFunctorMethod< EventType, Class, Derived > *functor =
2845             wxNewEventFunctor( eventType, func, eventSink );
2846
2847         sender->Subscribe( winid, lastId, eventType, functor, userData );
2848     }
2849
2850     template <typename Sender, typename EventType, typename Class, typename Derived>
2851     static void Connect( Sender *sender,
2852             int winid,
2853             const EventType &eventType,
2854             void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2855             wxObject *userData = NULL,
2856             Derived *eventSink = NULL )
2857         { Connect( sender, winid, wxID_ANY, eventType, func, userData, eventSink ); }
2858
2859     template <typename Sender, typename EventType, typename Class, typename Derived>
2860     static void Connect( Sender *sender,
2861             const EventType &eventType,
2862             void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2863             wxObject *userData = NULL,
2864             Derived *eventSink = NULL )
2865         { Connect( sender, wxID_ANY, wxID_ANY, eventType, func, userData, eventSink ); }
2866
2867     //
2868     // Connect an arbitrary functor to an event:
2869     //
2870
2871     template <typename EventType, typename Functor>
2872     void Connect( int winid,
2873             int lastId,
2874             const EventType &eventType,
2875             Functor &functor,
2876             wxObject* userData = NULL)
2877     {
2878         wxEventFunctorAdapter< EventType, Functor > *adapter =
2879             wxNewEventFunctor( eventType, functor );
2880
2881         Subscribe( winid, lastId, eventType, adapter, userData );
2882     }
2883     template <typename EventType, typename Functor>
2884     void Connect( int winid,
2885             const EventType &eventType,
2886             Functor &functor,
2887             wxObject* userData = NULL)
2888         { Connect( winid, wxID_ANY, eventType, functor, userData ); }
2889
2890     template <typename EventType, typename Functor>
2891     void Connect( const EventType &eventType,
2892             Functor &functor,
2893             wxObject* userData = NULL)
2894         { Connect( wxID_ANY, wxID_ANY, eventType, functor, userData ); }
2895
2896     //
2897     // Disconnect a function from an event:
2898     //
2899
2900     template <typename EventType>
2901     bool Disconnect( int winid,
2902         int lastId,
2903         const EventType &eventType,
2904         void ( *func )( typename EventType::CorrespondingEvent & ),
2905         wxObject* userData = NULL )
2906     {
2907         wxEventFunctorFunction< EventType > functor = wxConstructEventFunctor( eventType, func );
2908
2909         return Unsubscribe( winid, lastId, eventType, functor, userData );
2910     }
2911
2912     template <typename EventType>
2913     bool Disconnect( int winid,
2914             const EventType &eventType,
2915             void ( *func )( typename EventType::CorrespondingEvent & ),
2916             wxObject* userData = NULL )
2917         { return Disconnect( winid, wxID_ANY, eventType, func, userData ); }
2918
2919     template <typename EventType>
2920     bool Disconnect( const EventType &eventType,
2921             void ( *func )( typename EventType::CorrespondingEvent & ),
2922             wxObject* userData = NULL )
2923         { return Disconnect( wxID_ANY, wxID_ANY, eventType, func, userData ); }
2924
2925     //
2926     // Disconnect a method from an event:
2927     //
2928
2929     template <typename EventType, typename Class>
2930     bool Disconnect( int winid,
2931             int lastId,
2932             const EventType &eventType,
2933             void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2934             wxObject *userData = NULL )
2935         {
2936             wxEventFunctorMethod< EventType, Class, Class > functor =
2937                 wxConstructEventFunctor( eventType, func, static_cast< Class * const >( this ));
2938
2939             return Unsubscribe( winid, lastId, eventType, functor, userData );
2940         }
2941
2942     template <typename EventType, typename Class>
2943     bool Disconnect( int winid,
2944             const EventType &eventType,
2945             void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2946             wxObject *userData = NULL )
2947         { return Disconnect( winid, wxID_ANY, eventType, func, userData ); }
2948
2949     template <typename EventType, typename Class>
2950     bool Disconnect( const EventType &eventType,
2951             void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2952             wxObject *userData = NULL )
2953         { return Disconnect( wxID_ANY, wxID_ANY, eventType, func, userData ); }
2954
2955     template <typename EventType, typename Class, typename Derived>
2956     bool Disconnect( int winid,
2957             int lastId,
2958             const EventType &eventType,
2959             void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2960             wxObject *userData = NULL,
2961             Derived *eventSink = NULL )
2962         {
2963             wxEventFunctorMethod< EventType, Class, Derived > functor =
2964                 wxConstructEventFunctor( eventType, func, eventSink );
2965
2966             return Unsubscribe( winid, lastId, eventType, functor, userData );
2967         }
2968
2969     template <typename EventType, typename Class, typename Derived>
2970     bool Disconnect( int winid,
2971             const EventType &eventType,
2972             void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2973             wxObject *userData = NULL,
2974             Derived *eventSink = NULL )
2975         { return Disconnect( winid, wxID_ANY, eventType, func, userData, eventSink ); }
2976
2977     template <typename EventType, typename Class, typename Derived>
2978     bool Disconnect( const EventType &eventType,
2979             void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2980             wxObject *userData = NULL,
2981             Derived *eventSink = NULL )
2982         { return Disconnect( wxID_ANY, wxID_ANY, eventType, func, userData, eventSink ); }
2983
2984     template <typename Sender, typename EventType, typename Class, typename Derived>
2985     static bool Disconnect( Sender *sender,
2986             int winid,
2987             int lastId,
2988             const EventType &eventType,
2989             void ( Class::*func )( typename EventType::CorrespondingEvent & ),
2990             wxObject *userData = NULL,
2991             Derived *eventSink = NULL )
2992     {
2993         wxEventFunctorMethod< EventType, Class, Derived > functor =
2994             wxConstructEventFunctor( eventType, func, eventSink );
2995
2996         return sender->Unsubscribe( winid, lastId, eventType, functor, userData );
2997     }
2998
2999     template <typename Sender, typename EventType, typename Class, typename Derived>
3000     static bool Disconnect( Sender *sender,
3001             int winid,
3002             const EventType &eventType,
3003             void ( Class::*func )( typename EventType::CorrespondingEvent & ),
3004             wxObject *userData = NULL,
3005             Derived *eventSink = NULL )
3006         { return Disconnect( sender, winid, wxID_ANY, eventType, func, userData, eventSink ); }
3007
3008     template <typename Sender, typename EventType, typename Class, typename Derived>
3009     static bool Disconnect( Sender *sender,
3010             const EventType &eventType,
3011             void ( Class::*func )( typename EventType::CorrespondingEvent & ),
3012             wxObject *userData = NULL,
3013             Derived *eventSink = NULL )
3014         { return Disconnect( sender, wxID_ANY, wxID_ANY, eventType, func, userData, eventSink ); }
3015
3016     //
3017     // Disconnect an arbitrary functor from an event:
3018     //
3019
3020     template <typename EventType, typename Functor>
3021     bool Disconnect( int winid,
3022             int lastId,
3023             const EventType &eventType,
3024             Functor &functor,
3025             wxObject* userData = NULL)
3026     {
3027         wxEventFunctorAdapter< EventType, Functor > adapter =
3028             wxConstructEventFunctor( eventType, functor );
3029
3030         return Unsubscribe( winid, lastId, eventType, adapter, userData );
3031     }
3032
3033     template <typename EventType, typename Functor>
3034     bool Disconnect( int winid,
3035             const EventType &eventType,
3036             Functor &functor,
3037             wxObject* userData = NULL)
3038         { return Disconnect( winid, wxID_ANY, eventType, functor, userData ); }
3039
3040     template <typename EventType, typename Functor>
3041     bool Disconnect( const EventType &eventType,
3042             Functor &functor,
3043             wxObject* userData = NULL)
3044         { return Disconnect( wxID_ANY, wxID_ANY, eventType, functor, userData ); }
3045
3046 #endif // !wxEVENTS_COMPATIBILITY_2_8
3047
3048
3049     wxList* GetDynamicEventTable() const { return m_dynamicEvents ; }
3050
3051     // User data can be associated with each wxEvtHandler
3052     void SetClientObject( wxClientData *data ) { DoSetClientObject(data); }
3053     wxClientData *GetClientObject() const { return DoGetClientObject(); }
3054
3055     void SetClientData( void *data ) { DoSetClientData(data); }
3056     void *GetClientData() const { return DoGetClientData(); }
3057
3058
3059     // implementation from now on
3060     // --------------------------
3061
3062     // check if the given event table entry matches this event and call the
3063     // handler if it 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 ProcessEventIfMatches(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_