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 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) && !defined(__EMX__)
  16 // Some older compilers (such as EMX) cannot handle
  17 // #pragma interface/implementation correctly, iff
  18 // #pragma implementation is used in _two_ translation
  19 // units (as created by e.g. event.cpp compiled for
  20 // libwx_base and event.cpp compiled for libwx_gui_core).
  21 // So we must not use those pragmas for those compilers in
  22 // such files.
  23     #pragma interface "event.h"
  24 #endif
  25
  26 #include "wx/defs.h"
  27 #include "wx/object.h"
  28 #include "wx/clntdata.h"
  29
  30 #if wxUSE_GUI
  31     #include "wx/gdicmn.h"
  32     #include "wx/cursor.h"
  33 #endif
  34
  35 #include "wx/thread.h"
  36
  37 #include "wx/dynarray.h"
  38
  39 // ----------------------------------------------------------------------------
  40 // forward declarations
  41 // ----------------------------------------------------------------------------
  42
  43 class WXDLLIMPEXP_BASE wxList;
  44
  45 #if wxUSE_GUI
  46     class WXDLLIMPEXP_CORE wxDC;
  47     class WXDLLIMPEXP_CORE wxMenu;
  48     class WXDLLIMPEXP_CORE wxWindow;
  49     class WXDLLIMPEXP_CORE wxWindowBase;
  50 #endif // wxUSE_GUI
  51
  52 class WXDLLIMPEXP_BASE wxEvtHandler;
  53
  54 // ----------------------------------------------------------------------------
  55 // Event types
  56 // ----------------------------------------------------------------------------
  57
  58 typedef int wxEventType;
  59
  60 // this is used to make the event table entry type safe, so that for an event
  61 // handler only a function with proper parameter list can be given.
  62 #define wxStaticCastEvent(type, val) wx_static_cast(type, val)
  63
  64 // in previous versions of wxWidgets the event types used to be constants
  65 // which created difficulties with custom/user event types definition
  66 //
  67 // starting from wxWidgets 2.4 the event types are now dynamically assigned
  68 // using wxNewEventType() which solves this problem, however at price of
  69 // several incompatibilities:
  70 //
  71 //  a) event table macros declaration changed, it now uses wxEventTableEntry
  72 //     ctor instead of initialisation from an agregate - the macro
  73 //     DECLARE_EVENT_TABLE_ENTRY may be used to write code which can compile
  74 //     with all versions of wxWidgets
  75 //
  76 //  b) event types can't be used as switch() cases as they're not really
  77 //     constant any more - there is no magic solution here, you just have to
  78 //     change the switch()es to if()s
  79 //
  80 // if these are real problems for you, define WXWIN_COMPATIBILITY_EVENT_TYPES
  81 // to get 100% old behaviour, however you won't be able to use the libraries
  82 // using the new dynamic event type allocation in such case, so avoid it if
  83 // possible.
  84
  85 #if WXWIN_COMPATIBILITY_EVENT_TYPES
  86
  87 #define DECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj) \
  88     { type, winid, idLast, fn, obj }
  89
  90 #define BEGIN_DECLARE_EVENT_TYPES() enum {
  91 #define END_DECLARE_EVENT_TYPES() };
  92 #define DECLARE_EVENT_TYPE(name, value) name = wxEVT_FIRST + value,
  93 #define DECLARE_LOCAL_EVENT_TYPE(name, value) name = wxEVT_USER_FIRST + value,
  94 #define DECLARE_EXPORTED_EVENT_TYPE(expdecl, name, value) \
  95     DECLARE_LOCAL_EVENT_TYPE(name, value)
  96 #define DEFINE_EVENT_TYPE(name)
  97 #define DEFINE_LOCAL_EVENT_TYPE(name)
  98
  99
 100 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
 101
 102 #define DECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj) \
 103     wxEventTableEntry(type, winid, idLast, fn, obj)
 104
 105 #define EMPTY_PARAMETER_VALUE /* Fake macro parameter value */
 106
 107 #define BEGIN_DECLARE_EVENT_TYPES()
 108 #define END_DECLARE_EVENT_TYPES()
 109 #define DECLARE_EXPORTED_EVENT_TYPE(expdecl, name, value) \
 110     extern expdecl const wxEventType name;
 111 #define DECLARE_EVENT_TYPE(name, value) \
 112     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_CORE, name, value)
 113 #define DECLARE_LOCAL_EVENT_TYPE(name, value) \
 114     DECLARE_EXPORTED_EVENT_TYPE(EMPTY_PARAMETER_VALUE, name, value)
 115 #define DEFINE_EVENT_TYPE(name) const wxEventType name = wxNewEventType();
 116 #define DEFINE_LOCAL_EVENT_TYPE(name) DEFINE_EVENT_TYPE(name)
 117
 118 // generate a new unique event type
 119 extern WXDLLIMPEXP_BASE wxEventType wxNewEventType();
 120
 121 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
 122
 123 BEGIN_DECLARE_EVENT_TYPES()
 124
 125 #if WXWIN_COMPATIBILITY_EVENT_TYPES
 126     wxEVT_NULL = 0,
 127     wxEVT_FIRST = 10000,
 128     wxEVT_USER_FIRST = wxEVT_FIRST + 2000,
 129 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
 130     // it is important to still have these as constants to avoid
 131     // initialization order related problems
 132     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_NULL, 0)
 133     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_FIRST, 10000)
 134     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_USER_FIRST, wxEVT_FIRST + 2000)
 135 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
 136
 137     DECLARE_EVENT_TYPE(wxEVT_COMMAND_BUTTON_CLICKED, 1)
 138     DECLARE_EVENT_TYPE(wxEVT_COMMAND_CHECKBOX_CLICKED, 2)
 139     DECLARE_EVENT_TYPE(wxEVT_COMMAND_CHOICE_SELECTED, 3)
 140     DECLARE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_SELECTED, 4)
 141     DECLARE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 5)
 142     DECLARE_EVENT_TYPE(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 6)
 143     // now they are in wx/textctrl.h
 144 #if WXWIN_COMPATIBILITY_EVENT_TYPES
 145     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_UPDATED, 7)
 146     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_ENTER, 8)
 147     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_URL, 13)
 148     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_MAXLEN, 14)
 149 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES
 150     DECLARE_EVENT_TYPE(wxEVT_COMMAND_MENU_SELECTED, 9)
 151     DECLARE_EVENT_TYPE(wxEVT_COMMAND_SLIDER_UPDATED, 10)
 152     DECLARE_EVENT_TYPE(wxEVT_COMMAND_RADIOBOX_SELECTED, 11)
 153     DECLARE_EVENT_TYPE(wxEVT_COMMAND_RADIOBUTTON_SELECTED, 12)
 154
 155     // wxEVT_COMMAND_SCROLLBAR_UPDATED is now obsolete since we use
 156     // wxEVT_SCROLL... events
 157
 158     DECLARE_EVENT_TYPE(wxEVT_COMMAND_SCROLLBAR_UPDATED, 13)
 159     DECLARE_EVENT_TYPE(wxEVT_COMMAND_VLBOX_SELECTED, 14)
 160     DECLARE_EVENT_TYPE(wxEVT_COMMAND_COMBOBOX_SELECTED, 15)
 161     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TOOL_RCLICKED, 16)
 162     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TOOL_ENTER, 17)
 163     DECLARE_EVENT_TYPE(wxEVT_COMMAND_SPINCTRL_UPDATED, 18)
 164
 165         // Sockets and timers send events, too
 166     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_SOCKET, 50)
 167     DECLARE_EVENT_TYPE(wxEVT_TIMER , 80)
 168
 169         // Mouse event types
 170     DECLARE_EVENT_TYPE(wxEVT_LEFT_DOWN, 100)
 171     DECLARE_EVENT_TYPE(wxEVT_LEFT_UP, 101)
 172     DECLARE_EVENT_TYPE(wxEVT_MIDDLE_DOWN, 102)
 173     DECLARE_EVENT_TYPE(wxEVT_MIDDLE_UP, 103)
 174     DECLARE_EVENT_TYPE(wxEVT_RIGHT_DOWN, 104)
 175     DECLARE_EVENT_TYPE(wxEVT_RIGHT_UP, 105)
 176     DECLARE_EVENT_TYPE(wxEVT_MOTION, 106)
 177     DECLARE_EVENT_TYPE(wxEVT_ENTER_WINDOW, 107)
 178     DECLARE_EVENT_TYPE(wxEVT_LEAVE_WINDOW, 108)
 179     DECLARE_EVENT_TYPE(wxEVT_LEFT_DCLICK, 109)
 180     DECLARE_EVENT_TYPE(wxEVT_MIDDLE_DCLICK, 110)
 181     DECLARE_EVENT_TYPE(wxEVT_RIGHT_DCLICK, 111)
 182     DECLARE_EVENT_TYPE(wxEVT_SET_FOCUS, 112)
 183     DECLARE_EVENT_TYPE(wxEVT_KILL_FOCUS, 113)
 184     DECLARE_EVENT_TYPE(wxEVT_CHILD_FOCUS, 114)
 185     DECLARE_EVENT_TYPE(wxEVT_MOUSEWHEEL, 115)
 186
 187         // Non-client mouse events
 188     DECLARE_EVENT_TYPE(wxEVT_NC_LEFT_DOWN, 200)
 189     DECLARE_EVENT_TYPE(wxEVT_NC_LEFT_UP, 201)
 190     DECLARE_EVENT_TYPE(wxEVT_NC_MIDDLE_DOWN, 202)
 191     DECLARE_EVENT_TYPE(wxEVT_NC_MIDDLE_UP, 203)
 192     DECLARE_EVENT_TYPE(wxEVT_NC_RIGHT_DOWN, 204)
 193     DECLARE_EVENT_TYPE(wxEVT_NC_RIGHT_UP, 205)
 194     DECLARE_EVENT_TYPE(wxEVT_NC_MOTION, 206)
 195     DECLARE_EVENT_TYPE(wxEVT_NC_ENTER_WINDOW, 207)
 196     DECLARE_EVENT_TYPE(wxEVT_NC_LEAVE_WINDOW, 208)
 197     DECLARE_EVENT_TYPE(wxEVT_NC_LEFT_DCLICK, 209)
 198     DECLARE_EVENT_TYPE(wxEVT_NC_MIDDLE_DCLICK, 210)
 199     DECLARE_EVENT_TYPE(wxEVT_NC_RIGHT_DCLICK, 211)
 200
 201         // Character input event type
 202     DECLARE_EVENT_TYPE(wxEVT_CHAR, 212)
 203     DECLARE_EVENT_TYPE(wxEVT_CHAR_HOOK, 213)
 204     DECLARE_EVENT_TYPE(wxEVT_NAVIGATION_KEY, 214)
 205     DECLARE_EVENT_TYPE(wxEVT_KEY_DOWN, 215)
 206     DECLARE_EVENT_TYPE(wxEVT_KEY_UP, 216)
 207 #if wxUSE_HOTKEY
 208     DECLARE_EVENT_TYPE(wxEVT_HOTKEY, 217)
 209 #endif
 210         // Set cursor event
 211     DECLARE_EVENT_TYPE(wxEVT_SET_CURSOR, 230)
 212
 213         // wxScrollBar and wxSlider event identifiers
 214     DECLARE_EVENT_TYPE(wxEVT_SCROLL_TOP, 300)
 215     DECLARE_EVENT_TYPE(wxEVT_SCROLL_BOTTOM, 301)
 216     DECLARE_EVENT_TYPE(wxEVT_SCROLL_LINEUP, 302)
 217     DECLARE_EVENT_TYPE(wxEVT_SCROLL_LINEDOWN, 303)
 218     DECLARE_EVENT_TYPE(wxEVT_SCROLL_PAGEUP, 304)
 219     DECLARE_EVENT_TYPE(wxEVT_SCROLL_PAGEDOWN, 305)
 220     DECLARE_EVENT_TYPE(wxEVT_SCROLL_THUMBTRACK, 306)
 221     DECLARE_EVENT_TYPE(wxEVT_SCROLL_THUMBRELEASE, 307)
 222     DECLARE_EVENT_TYPE(wxEVT_SCROLL_ENDSCROLL, 308)
 223
 224         // Scroll events from wxWindow
 225     DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_TOP, 320)
 226     DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_BOTTOM, 321)
 227     DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEUP, 322)
 228     DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEDOWN, 323)
 229     DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEUP, 324)
 230     DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEDOWN, 325)
 231     DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBTRACK, 326)
 232     DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBRELEASE, 327)
 233
 234         // System events
 235     DECLARE_EVENT_TYPE(wxEVT_SIZE, 400)
 236     DECLARE_EVENT_TYPE(wxEVT_MOVE, 401)
 237     DECLARE_EVENT_TYPE(wxEVT_CLOSE_WINDOW, 402)
 238     DECLARE_EVENT_TYPE(wxEVT_END_SESSION, 403)
 239     DECLARE_EVENT_TYPE(wxEVT_QUERY_END_SESSION, 404)
 240     DECLARE_EVENT_TYPE(wxEVT_ACTIVATE_APP, 405)
 241     DECLARE_EVENT_TYPE(wxEVT_POWER, 406)
 242     DECLARE_EVENT_TYPE(wxEVT_ACTIVATE, 409)
 243     DECLARE_EVENT_TYPE(wxEVT_CREATE, 410)
 244     DECLARE_EVENT_TYPE(wxEVT_DESTROY, 411)
 245     DECLARE_EVENT_TYPE(wxEVT_SHOW, 412)
 246     DECLARE_EVENT_TYPE(wxEVT_ICONIZE, 413)
 247     DECLARE_EVENT_TYPE(wxEVT_MAXIMIZE, 414)
 248     DECLARE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_CHANGED, 415)
 249     DECLARE_EVENT_TYPE(wxEVT_PAINT, 416)
 250     DECLARE_EVENT_TYPE(wxEVT_ERASE_BACKGROUND, 417)
 251     DECLARE_EVENT_TYPE(wxEVT_NC_PAINT, 418)
 252     DECLARE_EVENT_TYPE(wxEVT_PAINT_ICON, 419)
 253     DECLARE_EVENT_TYPE(wxEVT_MENU_OPEN, 420)
 254     DECLARE_EVENT_TYPE(wxEVT_MENU_CLOSE, 421)
 255     DECLARE_EVENT_TYPE(wxEVT_MENU_HIGHLIGHT, 422)
 256     // DECLARE_EVENT_TYPE(wxEVT_POPUP_MENU_INIT, 423) -- free slot
 257     DECLARE_EVENT_TYPE(wxEVT_CONTEXT_MENU, 424)
 258     DECLARE_EVENT_TYPE(wxEVT_SYS_COLOUR_CHANGED, 425)
 259     DECLARE_EVENT_TYPE(wxEVT_DISPLAY_CHANGED, 426)
 260     DECLARE_EVENT_TYPE(wxEVT_SETTING_CHANGED, 427)
 261     DECLARE_EVENT_TYPE(wxEVT_QUERY_NEW_PALETTE, 428)
 262     DECLARE_EVENT_TYPE(wxEVT_PALETTE_CHANGED, 429)
 263     DECLARE_EVENT_TYPE(wxEVT_JOY_BUTTON_DOWN, 430)
 264     DECLARE_EVENT_TYPE(wxEVT_JOY_BUTTON_UP, 431)
 265     DECLARE_EVENT_TYPE(wxEVT_JOY_MOVE, 432)
 266     DECLARE_EVENT_TYPE(wxEVT_JOY_ZMOVE, 433)
 267     DECLARE_EVENT_TYPE(wxEVT_DROP_FILES, 434)
 268     DECLARE_EVENT_TYPE(wxEVT_DRAW_ITEM, 435)
 269     DECLARE_EVENT_TYPE(wxEVT_MEASURE_ITEM, 436)
 270     DECLARE_EVENT_TYPE(wxEVT_COMPARE_ITEM, 437)
 271     DECLARE_EVENT_TYPE(wxEVT_INIT_DIALOG, 438)
 272     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_IDLE, 439)
 273     DECLARE_EVENT_TYPE(wxEVT_UPDATE_UI, 440)
 274     DECLARE_EVENT_TYPE(wxEVT_SIZING, 441)
 275     DECLARE_EVENT_TYPE(wxEVT_MOVING, 442)
 276
 277         // Generic command events
 278         // Note: a click is a higher-level event than button down/up
 279     DECLARE_EVENT_TYPE(wxEVT_COMMAND_LEFT_CLICK, 500)
 280     DECLARE_EVENT_TYPE(wxEVT_COMMAND_LEFT_DCLICK, 501)
 281     DECLARE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_CLICK, 502)
 282     DECLARE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_DCLICK, 503)
 283     DECLARE_EVENT_TYPE(wxEVT_COMMAND_SET_FOCUS, 504)
 284     DECLARE_EVENT_TYPE(wxEVT_COMMAND_KILL_FOCUS, 505)
 285     DECLARE_EVENT_TYPE(wxEVT_COMMAND_ENTER, 506)
 286
 287         // Help events
 288     DECLARE_EVENT_TYPE(wxEVT_HELP, 1050)
 289     DECLARE_EVENT_TYPE(wxEVT_DETAILED_HELP, 1051)
 290
 291 END_DECLARE_EVENT_TYPES()
 292
 293 // these 2 events are the same
 294 #define wxEVT_COMMAND_TOOL_CLICKED wxEVT_COMMAND_MENU_SELECTED
 295
 296 // ----------------------------------------------------------------------------
 297 // Compatibility
 298 // ----------------------------------------------------------------------------
 299
 300 // this event is also used by wxComboBox and wxSpinCtrl which don't include
 301 // wx/textctrl.h in all ports [yet], so declare it here as well
 302 //
 303 // still, any new code using it should include wx/textctrl.h explicitly
 304 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
 305     extern const wxEventType WXDLLIMPEXP_CORE wxEVT_COMMAND_TEXT_UPDATED;
 306 #endif
 307
 308 // the predefined constants for the number of times we propagate event
 309 // upwards window child-parent chain
 310 enum Propagation_state
 311 {
 312     // don't propagate it at all
 313     wxEVENT_PROPAGATE_NONE = 0,
 314
 315     // propagate it until it is processed
 316     wxEVENT_PROPAGATE_MAX = INT_MAX
 317 };
 318
 319 /*
 320  * wxWidgets events, covering all interesting things that might happen
 321  * (button clicking, resizing, setting text in widgets, etc.).
 322  *
 323  * For each completely new event type, derive a new event class.
 324  * An event CLASS represents a C++ class defining a range of similar event TYPES;
 325  * examples are canvas events, panel item command events.
 326  * An event TYPE is a unique identifier for a particular system event,
 327  * such as a button press or a listbox deselection.
 328  *
 329  */
 330
 331 class WXDLLIMPEXP_BASE wxEvent : public wxObject
 332 {
 333 private:
 334     wxEvent& operator=(const wxEvent&);
 335
 336 protected:
 337     wxEvent(const wxEvent&);                   // for implementing Clone()
 338
 339 public:
 340     wxEvent(int winid = 0, wxEventType commandType = wxEVT_NULL );
 341
 342     void SetEventType(wxEventType typ) { m_eventType = typ; }
 343     wxEventType GetEventType() const { return m_eventType; }
 344     wxObject *GetEventObject() const { return m_eventObject; }
 345     void SetEventObject(wxObject *obj) { m_eventObject = obj; }
 346     long GetTimestamp() const { return m_timeStamp; }
 347     void SetTimestamp(long ts = 0) { m_timeStamp = ts; }
 348     int GetId() const { return m_id; }
 349     void SetId(int Id) { m_id = Id; }
 350
 351     // Can instruct event processor that we wish to ignore this event
 352     // (treat as if the event table entry had not been found): this must be done
 353     // to allow the event processing by the base classes (calling event.Skip()
 354     // is the analog of calling the base class version of a virtual function)
 355     void Skip(bool skip = true) { m_skipped = skip; }
 356     bool GetSkipped() const { return m_skipped; };
 357
 358     // this function is used to create a copy of the event polymorphically and
 359     // all derived classes must implement it because otherwise wxPostEvent()
 360     // for them wouldn't work (it needs to do a copy of the event)
 361     virtual wxEvent *Clone() const = 0;
 362
 363     // Implementation only: this test is explicitly anti OO and this function
 364     // exists only for optimization purposes.
 365     bool IsCommandEvent() const { return m_isCommandEvent; }
 366
 367     // Determine if this event should be propagating to the parent window.
 368     bool ShouldPropagate() const
 369         { return m_propagationLevel != wxEVENT_PROPAGATE_NONE; }
 370
 371     // Stop an event from propagating to its parent window, returns the old
 372     // propagation level value
 373     int StopPropagation()
 374     {
 375         int propagationLevel = m_propagationLevel;
 376         m_propagationLevel = wxEVENT_PROPAGATE_NONE;
 377         return propagationLevel;
 378     }
 379
 380     // Resume the event propagation by restoring the propagation level
 381     // (returned by StopPropagation())
 382     void ResumePropagation(int propagationLevel)
 383     {
 384         m_propagationLevel = propagationLevel;
 385     }
 386
 387 #if WXWIN_COMPATIBILITY_2_4
 388 public:
 389 #else
 390 protected:
 391 #endif
 392     wxObject*         m_eventObject;
 393     wxEventType       m_eventType;
 394     long              m_timeStamp;
 395     int               m_id;
 396
 397 public:
 398     // m_callbackUserData is for internal usage only
 399     wxObject*         m_callbackUserData;
 400
 401 protected:
 402     // the propagation level: while it is positive, we propagate the event to
 403     // the parent window (if any)
 404     //
 405     // this one doesn't have to be public, we don't have to worry about
 406     // backwards compatibility as it is new
 407     int               m_propagationLevel;
 408
 409 #if WXWIN_COMPATIBILITY_2_4
 410 public:
 411 #else
 412 protected:
 413 #endif
 414     bool              m_skipped;
 415     bool              m_isCommandEvent;
 416
 417 private:
 418     // it needs to access our m_propagationLevel
 419     friend class WXDLLIMPEXP_BASE wxPropagateOnce;
 420
 421     DECLARE_ABSTRACT_CLASS(wxEvent)
 422 };
 423
 424 /*
 425  * Helper class to temporarily change an event not to propagate.
 426  */
 427 class WXDLLIMPEXP_BASE wxPropagationDisabler
 428 {
 429 public:
 430     wxPropagationDisabler(wxEvent& event) : m_event(event)
 431     {
 432         m_propagationLevelOld = m_event.StopPropagation();
 433     }
 434
 435     ~wxPropagationDisabler()
 436     {
 437         m_event.ResumePropagation(m_propagationLevelOld);
 438     }
 439
 440 private:
 441     wxEvent& m_event;
 442     int m_propagationLevelOld;
 443
 444     DECLARE_NO_COPY_CLASS(wxPropagationDisabler)
 445 };
 446
 447 /*
 448  * Another one to temporarily lower propagation level.
 449  */
 450 class WXDLLIMPEXP_BASE wxPropagateOnce
 451 {
 452 public:
 453     wxPropagateOnce(wxEvent& event) : m_event(event)
 454     {
 455         wxASSERT_MSG( m_event.m_propagationLevel > 0,
 456                         _T("shouldn't be used unless ShouldPropagate()!") );
 457
 458         m_event.m_propagationLevel--;
 459     }
 460
 461     ~wxPropagateOnce()
 462     {
 463         m_event.m_propagationLevel++;
 464     }
 465
 466 private:
 467     wxEvent& m_event;
 468
 469     DECLARE_NO_COPY_CLASS(wxPropagateOnce)
 470 };
 471
 472 #if wxUSE_GUI
 473
 474
 475 // Item or menu event class
 476 /*
 477  wxEVT_COMMAND_BUTTON_CLICKED
 478  wxEVT_COMMAND_CHECKBOX_CLICKED
 479  wxEVT_COMMAND_CHOICE_SELECTED
 480  wxEVT_COMMAND_LISTBOX_SELECTED
 481  wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
 482  wxEVT_COMMAND_TEXT_UPDATED
 483  wxEVT_COMMAND_TEXT_ENTER
 484  wxEVT_COMMAND_MENU_SELECTED
 485  wxEVT_COMMAND_SLIDER_UPDATED
 486  wxEVT_COMMAND_RADIOBOX_SELECTED
 487  wxEVT_COMMAND_RADIOBUTTON_SELECTED
 488  wxEVT_COMMAND_SCROLLBAR_UPDATED
 489  wxEVT_COMMAND_VLBOX_SELECTED
 490  wxEVT_COMMAND_COMBOBOX_SELECTED
 491  wxEVT_COMMAND_TOGGLEBUTTON_CLICKED
 492 */
 493
 494 #if WXWIN_COMPATIBILITY_2_4
 495 // Backwards compatibility for wxCommandEvent::m_commandString, will lead to compilation errors in some cases of usage
 496 class WXDLLIMPEXP_CORE wxCommandEvent;
 497
 498 class WXDLLIMPEXP_CORE wxCommandEventStringHelper
 499 {
 500 public:
 501     wxCommandEventStringHelper(wxCommandEvent * evt)
 502         : m_evt(evt)
 503         { }
 504
 505     void operator=(const wxString &str);
 506     operator wxString();
 507     const wxChar* c_str() const;
 508
 509 private:
 510     wxCommandEvent* m_evt;
 511 };
 512 #endif
 513
 514 #ifdef __VISUALC__
 515     // 'this' : used in base member initializer list (for m_commandString)
 516     #pragma warning(disable:4355)
 517 #endif
 518
 519 class WXDLLIMPEXP_CORE wxCommandEvent : public wxEvent
 520 {
 521 public:
 522     wxCommandEvent(wxEventType commandType = wxEVT_NULL, int winid = 0);
 523
 524     wxCommandEvent(const wxCommandEvent& event)
 525         : wxEvent(event),
 526 #if WXWIN_COMPATIBILITY_2_4
 527           m_commandString(this),
 528 #endif
 529           m_cmdString(event.m_cmdString),
 530           m_commandInt(event.m_commandInt),
 531           m_extraLong(event.m_extraLong),
 532           m_clientData(event.m_clientData),
 533           m_clientObject(event.m_clientObject)
 534         { }
 535
 536     // Set/Get client data from controls
 537     void SetClientData(void* clientData) { m_clientData = clientData; }
 538     void *GetClientData() const { return m_clientData; }
 539
 540     // Set/Get client object from controls
 541     void SetClientObject(wxClientData* clientObject) { m_clientObject = clientObject; }
 542     wxClientData *GetClientObject() const { return m_clientObject; }
 543
 544     // Get listbox selection if single-choice
 545     int GetSelection() const { return m_commandInt; }
 546
 547     // Set/Get listbox/choice selection string
 548     void SetString(const wxString& s) { m_cmdString = s; }
 549     wxString GetString() const;
 550
 551     // Get checkbox value
 552     bool IsChecked() const { return m_commandInt != 0; }
 553
 554     // true if the listbox event was a selection.
 555     bool IsSelection() const { return (m_extraLong != 0); }
 556
 557     void SetExtraLong(long extraLong) { m_extraLong = extraLong; }
 558     long GetExtraLong() const { return m_extraLong; }
 559
 560     void SetInt(int i) { m_commandInt = i; }
 561     long GetInt() const { return m_commandInt; }
 562
 563     virtual wxEvent *Clone() const { return new wxCommandEvent(*this); }
 564
 565 #if WXWIN_COMPATIBILITY_2_4
 566 public:
 567     wxCommandEventStringHelper m_commandString;
 568 #else
 569 protected:
 570 #endif
 571     wxString          m_cmdString;     // String event argument
 572     int               m_commandInt;
 573     long              m_extraLong;     // Additional information (e.g. select/deselect)
 574     void*             m_clientData;    // Arbitrary client data
 575     wxClientData*     m_clientObject;  // Arbitrary client object
 576
 577 private:
 578     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCommandEvent)
 579 };
 580
 581 #ifdef __VISUALC__
 582     #pragma warning(default:4355)
 583 #endif
 584
 585 #if WXWIN_COMPATIBILITY_2_4
 586 inline void wxCommandEventStringHelper::operator=(const wxString &str)
 587 {
 588     m_evt->SetString(str);
 589 }
 590
 591 inline wxCommandEventStringHelper::operator wxString()
 592 {
 593     return m_evt->GetString();
 594 }
 595
 596 inline const wxChar* wxCommandEventStringHelper::c_str() const
 597 {
 598     return m_evt->GetString().c_str();
 599 }
 600 #endif
 601
 602 // this class adds a possibility to react (from the user) code to a control
 603 // notification: allow or veto the operation being reported.
 604 class WXDLLIMPEXP_CORE wxNotifyEvent  : public wxCommandEvent
 605 {
 606 public:
 607     wxNotifyEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
 608         : wxCommandEvent(commandType, winid)
 609         { m_bAllow = true; }
 610
 611     wxNotifyEvent(const wxNotifyEvent& event)
 612         : wxCommandEvent(event)
 613         { m_bAllow = event.m_bAllow; }
 614
 615     // veto the operation (usually it's allowed by default)
 616     void Veto() { m_bAllow = false; }
 617
 618     // allow the operation if it was disabled by default
 619     void Allow() { m_bAllow = true; }
 620
 621     // for implementation code only: is the operation allowed?
 622     bool IsAllowed() const { return m_bAllow; }
 623
 624     virtual wxEvent *Clone() const { return new wxNotifyEvent(*this); }
 625
 626 private:
 627     bool m_bAllow;
 628
 629 private:
 630     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNotifyEvent)
 631 };
 632
 633 // Scroll event class, derived form wxCommandEvent. wxScrollEvents are
 634 // sent by wxSlider and wxScrollBar.
 635 /*
 636  wxEVT_SCROLL_TOP
 637  wxEVT_SCROLL_BOTTOM
 638  wxEVT_SCROLL_LINEUP
 639  wxEVT_SCROLL_LINEDOWN
 640  wxEVT_SCROLL_PAGEUP
 641  wxEVT_SCROLL_PAGEDOWN
 642  wxEVT_SCROLL_THUMBTRACK
 643  wxEVT_SCROLL_THUMBRELEASE
 644  wxEVT_SCROLL_ENDSCROLL
 645 */
 646
 647 class WXDLLIMPEXP_CORE wxScrollEvent : public wxCommandEvent
 648 {
 649 public:
 650     wxScrollEvent(wxEventType commandType = wxEVT_NULL,
 651                   int winid = 0, int pos = 0, int orient = 0);
 652
 653     int GetOrientation() const { return (int) m_extraLong; }
 654     int GetPosition() const { return m_commandInt; }
 655     void SetOrientation(int orient) { m_extraLong = (long) orient; }
 656     void SetPosition(int pos) { m_commandInt = pos; }
 657
 658     virtual wxEvent *Clone() const { return new wxScrollEvent(*this); }
 659
 660 private:
 661     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollEvent)
 662 };
 663
 664 // ScrollWin event class, derived fom wxEvent. wxScrollWinEvents
 665 // are sent by wxWindow.
 666 /*
 667  wxEVT_SCROLLWIN_TOP
 668  wxEVT_SCROLLWIN_BOTTOM
 669  wxEVT_SCROLLWIN_LINEUP
 670  wxEVT_SCROLLWIN_LINEDOWN
 671  wxEVT_SCROLLWIN_PAGEUP
 672  wxEVT_SCROLLWIN_PAGEDOWN
 673  wxEVT_SCROLLWIN_THUMBTRACK
 674  wxEVT_SCROLLWIN_THUMBRELEASE
 675 */
 676
 677 class WXDLLIMPEXP_CORE wxScrollWinEvent : public wxEvent
 678 {
 679 public:
 680     wxScrollWinEvent(wxEventType commandType = wxEVT_NULL,
 681                      int pos = 0, int orient = 0);
 682     wxScrollWinEvent(const wxScrollWinEvent & event) : wxEvent(event)
 683         {    m_commandInt = event.m_commandInt;
 684             m_extraLong = event.m_extraLong;    }
 685
 686     int GetOrientation() const { return (int) m_extraLong; }
 687     int GetPosition() const { return m_commandInt; }
 688     void SetOrientation(int orient) { m_extraLong = (long) orient; }
 689     void SetPosition(int pos) { m_commandInt = pos; }
 690
 691     virtual wxEvent *Clone() const { return new wxScrollWinEvent(*this); }
 692
 693 #if WXWIN_COMPATIBILITY_2_4
 694 public:
 695 #else
 696 protected:
 697 #endif
 698     int               m_commandInt;
 699     long              m_extraLong;
 700
 701 private:
 702     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollWinEvent)
 703 };
 704
 705 // Mouse event class
 706
 707 /*
 708  wxEVT_LEFT_DOWN
 709  wxEVT_LEFT_UP
 710  wxEVT_MIDDLE_DOWN
 711  wxEVT_MIDDLE_UP
 712  wxEVT_RIGHT_DOWN
 713  wxEVT_RIGHT_UP
 714  wxEVT_MOTION
 715  wxEVT_ENTER_WINDOW
 716  wxEVT_LEAVE_WINDOW
 717  wxEVT_LEFT_DCLICK
 718  wxEVT_MIDDLE_DCLICK
 719  wxEVT_RIGHT_DCLICK
 720  wxEVT_NC_LEFT_DOWN
 721  wxEVT_NC_LEFT_UP,
 722  wxEVT_NC_MIDDLE_DOWN,
 723  wxEVT_NC_MIDDLE_UP,
 724  wxEVT_NC_RIGHT_DOWN,
 725  wxEVT_NC_RIGHT_UP,
 726  wxEVT_NC_MOTION,
 727  wxEVT_NC_ENTER_WINDOW,
 728  wxEVT_NC_LEAVE_WINDOW,
 729  wxEVT_NC_LEFT_DCLICK,
 730  wxEVT_NC_MIDDLE_DCLICK,
 731  wxEVT_NC_RIGHT_DCLICK,
 732 */
 733
 734 // the symbolic names for the mouse buttons
 735 enum
 736 {
 737     wxMOUSE_BTN_ANY     = -1,
 738     wxMOUSE_BTN_NONE    = 0,
 739     wxMOUSE_BTN_LEFT    = 1,
 740     wxMOUSE_BTN_MIDDLE  = 2,
 741     wxMOUSE_BTN_RIGHT   = 3
 742 };
 743
 744 class WXDLLIMPEXP_CORE wxMouseEvent : public wxEvent
 745 {
 746 public:
 747     wxMouseEvent(wxEventType mouseType = wxEVT_NULL);
 748     wxMouseEvent(const wxMouseEvent& event)    : wxEvent(event)
 749         { Assign(event); }
 750
 751     // Was it a button event? (*doesn't* mean: is any button *down*?)
 752     bool IsButton() const { return Button(wxMOUSE_BTN_ANY); }
 753
 754     // Was it a down event from this (or any) button?
 755     bool ButtonDown(int but = wxMOUSE_BTN_ANY) const;
 756
 757     // Was it a dclick event from this (or any) button?
 758     bool ButtonDClick(int but = wxMOUSE_BTN_ANY) const;
 759
 760     // Was it a up event from this (or any) button?
 761     bool ButtonUp(int but = wxMOUSE_BTN_ANY) const;
 762
 763     // Was the given button?
 764     bool Button(int but) const;
 765
 766     // Was the given button in Down state?
 767     bool ButtonIsDown(int but) const;
 768
 769     // Get the button which is changing state (wxMOUSE_BTN_NONE if none)
 770     int GetButton() const;
 771
 772     // Find state of shift/control keys
 773     bool ControlDown() const { return m_controlDown; }
 774     bool MetaDown() const { return m_metaDown; }
 775     bool AltDown() const { return m_altDown; }
 776     bool ShiftDown() const { return m_shiftDown; }
 777     bool CmdDown() const
 778     {
 779 #if defined(__WXMAC__) || defined(__WXCOCOA__)
 780         return MetaDown();
 781 #else
 782         return ControlDown();
 783 #endif
 784     }
 785
 786     // Find which event was just generated
 787     bool LeftDown() const { return (m_eventType == wxEVT_LEFT_DOWN); }
 788     bool MiddleDown() const { return (m_eventType == wxEVT_MIDDLE_DOWN); }
 789     bool RightDown() const { return (m_eventType == wxEVT_RIGHT_DOWN); }
 790
 791     bool LeftUp() const { return (m_eventType == wxEVT_LEFT_UP); }
 792     bool MiddleUp() const { return (m_eventType == wxEVT_MIDDLE_UP); }
 793     bool RightUp() const { return (m_eventType == wxEVT_RIGHT_UP); }
 794
 795     bool LeftDClick() const { return (m_eventType == wxEVT_LEFT_DCLICK); }
 796     bool MiddleDClick() const { return (m_eventType == wxEVT_MIDDLE_DCLICK); }
 797     bool RightDClick() const { return (m_eventType == wxEVT_RIGHT_DCLICK); }
 798
 799     // Find the current state of the mouse buttons (regardless
 800     // of current event type)
 801     bool LeftIsDown() const { return m_leftDown; }
 802     bool MiddleIsDown() const { return m_middleDown; }
 803     bool RightIsDown() const { return m_rightDown; }
 804
 805     // True if a button is down and the mouse is moving
 806     bool Dragging() const
 807     {
 808         return (m_eventType == wxEVT_MOTION) && ButtonIsDown(wxMOUSE_BTN_ANY);
 809     }
 810
 811     // True if the mouse is moving, and no button is down
 812     bool Moving() const
 813     {
 814         return (m_eventType == wxEVT_MOTION) && !ButtonIsDown(wxMOUSE_BTN_ANY);
 815     }
 816
 817     // True if the mouse is just entering the window
 818     bool Entering() const { return (m_eventType == wxEVT_ENTER_WINDOW); }
 819
 820     // True if the mouse is just leaving the window
 821     bool Leaving() const { return (m_eventType == wxEVT_LEAVE_WINDOW); }
 822
 823     // Find the position of the event
 824     void GetPosition(wxCoord *xpos, wxCoord *ypos) const
 825     {
 826         if (xpos)
 827             *xpos = m_x;
 828         if (ypos)
 829             *ypos = m_y;
 830     }
 831
 832     void GetPosition(long *xpos, long *ypos) const
 833     {
 834         if (xpos)
 835             *xpos = (long)m_x;
 836         if (ypos)
 837             *ypos = (long)m_y;
 838     }
 839
 840     // Find the position of the event
 841     wxPoint GetPosition() const { return wxPoint(m_x, m_y); }
 842
 843     // Find the logical position of the event given the DC
 844     wxPoint GetLogicalPosition(const wxDC& dc) const;
 845
 846     // Get X position
 847     wxCoord GetX() const { return m_x; }
 848
 849     // Get Y position
 850     wxCoord GetY() const { return m_y; }
 851
 852     // Get wheel rotation, positive or negative indicates direction of
 853     // rotation.  Current devices all send an event when rotation is equal to
 854     // +/-WheelDelta, but this allows for finer resolution devices to be
 855     // created in the future.  Because of this you shouldn't assume that one
 856     // event is equal to 1 line or whatever, but you should be able to either
 857     // do partial line scrolling or wait until +/-WheelDelta rotation values
 858     // have been accumulated before scrolling.
 859     int GetWheelRotation() const { return m_wheelRotation; }
 860
 861     // Get wheel delta, normally 120.  This is the threshold for action to be
 862     // taken, and one such action (for example, scrolling one increment)
 863     // should occur for each delta.
 864     int GetWheelDelta() const { return m_wheelDelta; }
 865
 866     // Returns the configured number of lines (or whatever) to be scrolled per
 867     // wheel action.  Defaults to one.
 868     int GetLinesPerAction() const { return m_linesPerAction; }
 869
 870     // Is the system set to do page scrolling?
 871     bool IsPageScroll() const { return ((unsigned int)m_linesPerAction == UINT_MAX); }
 872
 873     virtual wxEvent *Clone() const { return new wxMouseEvent(*this); }
 874
 875     wxMouseEvent& operator=(const wxMouseEvent& event) { Assign(event); return *this; }
 876
 877 public:
 878     wxCoord m_x, m_y;
 879
 880     bool          m_leftDown;
 881     bool          m_middleDown;
 882     bool          m_rightDown;
 883
 884     bool          m_controlDown;
 885     bool          m_shiftDown;
 886     bool          m_altDown;
 887     bool          m_metaDown;
 888
 889     int           m_wheelRotation;
 890     int           m_wheelDelta;
 891     int           m_linesPerAction;
 892
 893 protected:
 894     void Assign(const wxMouseEvent& evt);
 895
 896 private:
 897     DECLARE_DYNAMIC_CLASS(wxMouseEvent)
 898 };
 899
 900 // Cursor set event
 901
 902 /*
 903    wxEVT_SET_CURSOR
 904  */
 905
 906 class WXDLLIMPEXP_CORE wxSetCursorEvent : public wxEvent
 907 {
 908 public:
 909     wxSetCursorEvent(wxCoord x = 0, wxCoord y = 0)
 910         : wxEvent(0, wxEVT_SET_CURSOR),
 911           m_x(x), m_y(y), m_cursor()
 912         { }
 913
 914     wxSetCursorEvent(const wxSetCursorEvent & event)
 915         : wxEvent(event),
 916           m_x(event.m_x),
 917           m_y(event.m_y),
 918           m_cursor(event.m_cursor)
 919         { }
 920
 921     wxCoord GetX() const { return m_x; }
 922     wxCoord GetY() const { return m_y; }
 923
 924     void SetCursor(const wxCursor& cursor) { m_cursor = cursor; }
 925     const wxCursor& GetCursor() const { return m_cursor; }
 926     bool HasCursor() const { return m_cursor.Ok(); }
 927
 928     virtual wxEvent *Clone() const { return new wxSetCursorEvent(*this); }
 929
 930 private:
 931     wxCoord  m_x, m_y;
 932     wxCursor m_cursor;
 933
 934 private:
 935     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSetCursorEvent)
 936 };
 937
 938 // Keyboard input event class
 939
 940 /*
 941  wxEVT_CHAR
 942  wxEVT_CHAR_HOOK
 943  wxEVT_KEY_DOWN
 944  wxEVT_KEY_UP
 945  wxEVT_HOTKEY
 946  */
 947
 948 class WXDLLIMPEXP_CORE wxKeyEvent : public wxEvent
 949 {
 950 public:
 951     wxKeyEvent(wxEventType keyType = wxEVT_NULL);
 952     wxKeyEvent(const wxKeyEvent& evt);
 953
 954     // Find state of shift/control keys
 955     bool ControlDown() const { return m_controlDown; }
 956     bool MetaDown() const { return m_metaDown; }
 957     bool AltDown() const { return m_altDown; }
 958     bool ShiftDown() const { return m_shiftDown; }
 959
 960     // "Cmd" is a pseudo key which is Control for PC and Unix platforms but
 961     // Apple ("Command") key under Macs: it makes often sense to use it instead
 962     // of, say, ControlDown() because Cmd key is used for the same thing under
 963     // Mac as Ctrl elsewhere (but Ctrl still exists, just not used for this
 964     // purpose under Mac)
 965     bool CmdDown() const
 966     {
 967 #if defined(__WXMAC__) || defined(__WXCOCOA__)
 968         return MetaDown();
 969 #else
 970         return ControlDown();
 971 #endif
 972     }
 973
 974     // exclude MetaDown() from HasModifiers() because NumLock under X is often
 975     // configured as mod2 modifier, yet the key events even when it is pressed
 976     // should be processed normally, not like Ctrl- or Alt-key
 977     bool HasModifiers() const { return ControlDown() || AltDown(); }
 978
 979     // get the key code: an ASCII7 char or an element of wxKeyCode enum
 980     int GetKeyCode() const { return (int)m_keyCode; }
 981
 982 #if wxUSE_UNICODE
 983     // get the Unicode character corresponding to this key
 984     wxChar GetUnicodeKey() const { return m_uniChar; }
 985 #endif // wxUSE_UNICODE
 986
 987     // get the raw key code (platform-dependent)
 988     wxUint32 GetRawKeyCode() const { return m_rawCode; }
 989
 990     // get the raw key flags (platform-dependent)
 991     wxUint32 GetRawKeyFlags() const { return m_rawFlags; }
 992
 993     // Find the position of the event
 994     void GetPosition(wxCoord *xpos, wxCoord *ypos) const
 995     {
 996         if (xpos) *xpos = m_x;
 997         if (ypos) *ypos = m_y;
 998     }
 999
1000     void GetPosition(long *xpos, long *ypos) const
1001     {
1002         if (xpos) *xpos = (long)m_x;
1003         if (ypos) *ypos = (long)m_y;
1004     }
1005
1006     wxPoint GetPosition() const
1007         { return wxPoint(m_x, m_y); }
1008
1009     // Get X position
1010     wxCoord GetX() const { return m_x; }
1011
1012     // Get Y position
1013     wxCoord GetY() const { return m_y; }
1014
1015     // deprecated, Use GetKeyCode instead.
1016     wxDEPRECATED( long KeyCode() const );
1017
1018     virtual wxEvent *Clone() const { return new wxKeyEvent(*this); }
1019
1020     // we do need to copy wxKeyEvent sometimes (in wxTreeCtrl code, for
1021     // example)
1022     wxKeyEvent& operator=(const wxKeyEvent& evt)
1023     {
1024         m_x = evt.m_x;
1025         m_y = evt.m_y;
1026
1027         m_keyCode = evt.m_keyCode;
1028
1029         m_controlDown = evt.m_controlDown;
1030         m_shiftDown = evt.m_shiftDown;
1031         m_altDown = evt.m_altDown;
1032         m_metaDown = evt.m_metaDown;
1033         m_scanCode = evt.m_scanCode;
1034         m_rawCode = evt.m_rawCode;
1035         m_rawFlags = evt.m_rawFlags;
1036 #if wxUSE_UNICODE
1037         m_uniChar = evt.m_uniChar;
1038 #endif
1039
1040         return *this;
1041     }
1042
1043 public:
1044     wxCoord       m_x, m_y;
1045
1046     long          m_keyCode;
1047
1048     bool          m_controlDown;
1049     bool          m_shiftDown;
1050     bool          m_altDown;
1051     bool          m_metaDown;
1052     bool          m_scanCode;
1053
1054 #if wxUSE_UNICODE
1055     // This contains the full Unicode character
1056     // in a character events in Unicode mode
1057     wxChar        m_uniChar;
1058 #endif
1059
1060     // these fields contain the platform-specific information about
1061     // key that was pressed
1062     wxUint32      m_rawCode;
1063     wxUint32      m_rawFlags;
1064
1065 private:
1066     DECLARE_DYNAMIC_CLASS(wxKeyEvent)
1067 };
1068
1069 // Size event class
1070 /*
1071  wxEVT_SIZE
1072  */
1073
1074 class WXDLLIMPEXP_CORE wxSizeEvent : public wxEvent
1075 {
1076 public:
1077     wxSizeEvent() : wxEvent(0, wxEVT_SIZE)
1078         { }
1079     wxSizeEvent(const wxSize& sz, int winid = 0)
1080         : wxEvent(winid, wxEVT_SIZE),
1081           m_size(sz)
1082         { }
1083     wxSizeEvent(const wxSizeEvent & event)
1084         : wxEvent(event),
1085           m_size(event.m_size), m_rect(event.m_rect)
1086         { }
1087     wxSizeEvent(const wxRect& rect, int id = 0)
1088         : m_size(rect.GetSize()), m_rect(rect)
1089         { m_eventType = wxEVT_SIZING; m_id = id; }
1090
1091     wxSize GetSize() const { return m_size; }
1092     wxRect GetRect() const { return m_rect; }
1093     void SetRect(wxRect rect) { m_rect = rect; }
1094
1095     virtual wxEvent *Clone() const { return new wxSizeEvent(*this); }
1096
1097 public:
1098     // For internal usage only. Will be converted to protected members.
1099     wxSize m_size;
1100     wxRect m_rect; // Used for wxEVT_SIZING
1101
1102 private:
1103     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSizeEvent)
1104 };
1105
1106 // Move event class
1107
1108 /*
1109  wxEVT_MOVE
1110  */
1111
1112 class WXDLLIMPEXP_CORE wxMoveEvent : public wxEvent
1113 {
1114 public:
1115     wxMoveEvent()
1116         : wxEvent(0, wxEVT_MOVE)
1117         { }
1118     wxMoveEvent(const wxPoint& pos, int winid = 0)
1119         : wxEvent(winid, wxEVT_MOVE),
1120           m_pos(pos)
1121         { }
1122     wxMoveEvent(const wxMoveEvent& event)
1123         : wxEvent(event),
1124           m_pos(event.m_pos)
1125     { }
1126     wxMoveEvent(const wxRect& rect, int id = 0)
1127         : m_pos(rect.GetPosition()), m_rect(rect)
1128         { m_eventType = wxEVT_MOVING; m_id = id; }
1129
1130     wxPoint GetPosition() const { return m_pos; }
1131     void SetPosition(const wxPoint& pos) { m_pos = pos; }
1132     wxRect GetRect() const { return m_rect; }
1133     void SetRect(wxRect rect) { m_rect = rect; }
1134
1135     virtual wxEvent *Clone() const { return new wxMoveEvent(*this); }
1136
1137 #if WXWIN_COMPATIBILITY_2_4
1138 public:
1139 #else
1140 protected:
1141 #endif
1142     wxPoint m_pos;
1143     wxRect m_rect;
1144
1145 private:
1146     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMoveEvent)
1147 };
1148
1149 // Paint event class
1150 /*
1151  wxEVT_PAINT
1152  wxEVT_NC_PAINT
1153  wxEVT_PAINT_ICON
1154  */
1155
1156 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1157     // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined
1158     extern WXDLLIMPEXP_CORE int g_isPainting;
1159 #endif // debug
1160
1161 class WXDLLIMPEXP_CORE wxPaintEvent : public wxEvent
1162 {
1163 public:
1164     wxPaintEvent(int Id = 0)
1165         : wxEvent(Id, wxEVT_PAINT)
1166     {
1167 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1168         // set the internal flag for the duration of processing of WM_PAINT
1169         g_isPainting++;
1170 #endif // debug
1171     }
1172
1173     // default copy ctor and dtor are normally fine, we only need them to keep
1174     // g_isPainting updated in debug build
1175 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1176     wxPaintEvent(const wxPaintEvent& event)
1177             : wxEvent(event)
1178     {
1179         g_isPainting++;
1180     }
1181
1182     ~wxPaintEvent()
1183     {
1184         g_isPainting--;
1185     }
1186 #endif // debug
1187
1188     virtual wxEvent *Clone() const { return new wxPaintEvent(*this); }
1189
1190 private:
1191     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaintEvent)
1192 };
1193
1194 class WXDLLIMPEXP_CORE wxNcPaintEvent : public wxEvent
1195 {
1196 public:
1197     wxNcPaintEvent(int winid = 0)
1198         : wxEvent(winid, wxEVT_NC_PAINT)
1199         { }
1200
1201     virtual wxEvent *Clone() const { return new wxNcPaintEvent(*this); }
1202
1203 private:
1204     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNcPaintEvent)
1205 };
1206
1207 // Erase background event class
1208 /*
1209  wxEVT_ERASE_BACKGROUND
1210  */
1211
1212 class WXDLLIMPEXP_CORE wxEraseEvent : public wxEvent
1213 {
1214 public:
1215     wxEraseEvent(int Id = 0, wxDC *dc = (wxDC *) NULL)
1216         : wxEvent(Id, wxEVT_ERASE_BACKGROUND),
1217           m_dc(dc)
1218         { }
1219
1220     wxEraseEvent(const wxEraseEvent& event)
1221         : wxEvent(event),
1222           m_dc(event.m_dc)
1223         { }
1224
1225     wxDC *GetDC() const { return m_dc; }
1226
1227     virtual wxEvent *Clone() const { return new wxEraseEvent(*this); }
1228
1229 #if WXWIN_COMPATIBILITY_2_4
1230 public:
1231 #else
1232 protected:
1233 #endif
1234     wxDC *m_dc;
1235
1236 private:
1237     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxEraseEvent)
1238 };
1239
1240 // Focus event class
1241 /*
1242  wxEVT_SET_FOCUS
1243  wxEVT_KILL_FOCUS
1244  */
1245
1246 class WXDLLIMPEXP_CORE wxFocusEvent : public wxEvent
1247 {
1248 public:
1249     wxFocusEvent(wxEventType type = wxEVT_NULL, int winid = 0)
1250         : wxEvent(winid, type)
1251         { m_win = NULL; }
1252
1253     wxFocusEvent(const wxFocusEvent& event)
1254         : wxEvent(event)
1255         { m_win = event.m_win; }
1256
1257     // The window associated with this event is the window which had focus
1258     // before for SET event and the window which will have focus for the KILL
1259     // one. NB: it may be NULL in both cases!
1260     wxWindow *GetWindow() const { return m_win; }
1261     void SetWindow(wxWindow *win) { m_win = win; }
1262
1263     virtual wxEvent *Clone() const { return new wxFocusEvent(*this); }
1264
1265 private:
1266     wxWindow *m_win;
1267
1268 private:
1269     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFocusEvent)
1270 };
1271
1272 // wxChildFocusEvent notifies the parent that a child has got the focus: unlike
1273 // wxFocusEvent it is propagated upwards the window chain
1274 class WXDLLIMPEXP_CORE wxChildFocusEvent : public wxCommandEvent
1275 {
1276 public:
1277     wxChildFocusEvent(wxWindow *win = NULL);
1278
1279     wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1280
1281     virtual wxEvent *Clone() const { return new wxChildFocusEvent(*this); }
1282
1283 private:
1284     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxChildFocusEvent)
1285 };
1286
1287 // Activate event class
1288 /*
1289  wxEVT_ACTIVATE
1290  wxEVT_ACTIVATE_APP
1291  */
1292
1293 class WXDLLIMPEXP_CORE wxActivateEvent : public wxEvent
1294 {
1295 public:
1296     wxActivateEvent(wxEventType type = wxEVT_NULL, bool active = true, int Id = 0)
1297         : wxEvent(Id, type)
1298         { m_active = active; }
1299     wxActivateEvent(const wxActivateEvent& event)
1300         : wxEvent(event)
1301     { m_active = event.m_active; }
1302
1303     bool GetActive() const { return m_active; }
1304
1305     virtual wxEvent *Clone() const { return new wxActivateEvent(*this); }
1306
1307 private:
1308     bool m_active;
1309
1310 private:
1311     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxActivateEvent)
1312 };
1313
1314 // InitDialog event class
1315 /*
1316  wxEVT_INIT_DIALOG
1317  */
1318
1319 class WXDLLIMPEXP_CORE wxInitDialogEvent : public wxEvent
1320 {
1321 public:
1322     wxInitDialogEvent(int Id = 0)
1323         : wxEvent(Id, wxEVT_INIT_DIALOG)
1324         { }
1325
1326     virtual wxEvent *Clone() const { return new wxInitDialogEvent(*this); }
1327
1328 private:
1329     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxInitDialogEvent)
1330 };
1331
1332 // Miscellaneous menu event class
1333 /*
1334  wxEVT_MENU_OPEN,
1335  wxEVT_MENU_CLOSE,
1336  wxEVT_MENU_HIGHLIGHT,
1337 */
1338
1339 class WXDLLIMPEXP_CORE wxMenuEvent : public wxEvent
1340 {
1341 public:
1342     wxMenuEvent(wxEventType type = wxEVT_NULL, int winid = 0, wxMenu* menu = NULL)
1343         : wxEvent(winid, type)
1344         { m_menuId = winid; m_menu = menu; }
1345     wxMenuEvent(const wxMenuEvent & event)
1346         : wxEvent(event)
1347     { m_menuId = event.m_menuId; m_menu = event.m_menu; }
1348
1349     // only for wxEVT_MENU_HIGHLIGHT
1350     int GetMenuId() const { return m_menuId; }
1351
1352     // only for wxEVT_MENU_OPEN/CLOSE
1353     bool IsPopup() const { return m_menuId == wxID_ANY; }
1354
1355     // only for wxEVT_MENU_OPEN/CLOSE
1356     wxMenu* GetMenu() const { return m_menu; }
1357
1358     virtual wxEvent *Clone() const { return new wxMenuEvent(*this); }
1359
1360 private:
1361     int     m_menuId;
1362     wxMenu* m_menu;
1363
1364     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMenuEvent)
1365 };
1366
1367 // Window close or session close event class
1368 /*
1369  wxEVT_CLOSE_WINDOW,
1370  wxEVT_END_SESSION,
1371  wxEVT_QUERY_END_SESSION
1372  */
1373
1374 class WXDLLIMPEXP_CORE wxCloseEvent : public wxEvent
1375 {
1376 public:
1377     wxCloseEvent(wxEventType type = wxEVT_NULL, int winid = 0)
1378         : wxEvent(winid, type),
1379           m_loggingOff(true),
1380           m_veto(false),      // should be false by default
1381           m_canVeto(true) {}
1382
1383     wxCloseEvent(const wxCloseEvent & event)
1384         : wxEvent(event),
1385         m_loggingOff(event.m_loggingOff),
1386         m_veto(event.m_veto),
1387         m_canVeto(event.m_canVeto) {}
1388
1389     void SetLoggingOff(bool logOff) { m_loggingOff = logOff; }
1390     bool GetLoggingOff() const { return m_loggingOff; }
1391
1392     void Veto(bool veto = true)
1393     {
1394         // GetVeto() will return false anyhow...
1395         wxCHECK_RET( m_canVeto,
1396                      wxT("call to Veto() ignored (can't veto this event)") );
1397
1398         m_veto = veto;
1399     }
1400     void SetCanVeto(bool canVeto) { m_canVeto = canVeto; }
1401     // No more asserts here please, the one you put here was wrong.
1402     bool CanVeto() const { return m_canVeto; }
1403     bool GetVeto() const { return m_canVeto && m_veto; }
1404
1405     virtual wxEvent *Clone() const { return new wxCloseEvent(*this); }
1406
1407 protected:
1408     bool m_loggingOff;
1409     bool m_veto, m_canVeto;
1410
1411 private:
1412     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCloseEvent)
1413
1414 };
1415
1416 /*
1417  wxEVT_SHOW
1418  */
1419
1420 class WXDLLIMPEXP_CORE wxShowEvent : public wxEvent
1421 {
1422 public:
1423     wxShowEvent(int winid = 0, bool show = false)
1424         : wxEvent(winid, wxEVT_SHOW)
1425         { m_show = show; }
1426     wxShowEvent(const wxShowEvent & event)
1427         : wxEvent(event)
1428     { m_show = event.m_show; }
1429
1430     void SetShow(bool show) { m_show = show; }
1431     bool GetShow() const { return m_show; }
1432
1433     virtual wxEvent *Clone() const { return new wxShowEvent(*this); }
1434
1435 protected:
1436     bool m_show;
1437
1438 private:
1439     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxShowEvent)
1440 };
1441
1442 /*
1443  wxEVT_ICONIZE
1444  */
1445
1446 class WXDLLIMPEXP_CORE wxIconizeEvent : public wxEvent
1447 {
1448 public:
1449     wxIconizeEvent(int winid = 0, bool iconized = true)
1450         : wxEvent(winid, wxEVT_ICONIZE)
1451         { m_iconized = iconized; }
1452     wxIconizeEvent(const wxIconizeEvent & event)
1453         : wxEvent(event)
1454     { m_iconized = event.m_iconized; }
1455
1456     // return true if the frame was iconized, false if restored
1457     bool Iconized() const { return m_iconized; }
1458
1459     virtual wxEvent *Clone() const { return new wxIconizeEvent(*this); }
1460
1461 protected:
1462     bool m_iconized;
1463
1464 private:
1465     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIconizeEvent)
1466 };
1467 /*
1468  wxEVT_MAXIMIZE
1469  */
1470
1471 class WXDLLIMPEXP_CORE wxMaximizeEvent : public wxEvent
1472 {
1473 public:
1474     wxMaximizeEvent(int winid = 0)
1475         : wxEvent(winid, wxEVT_MAXIMIZE)
1476         { }
1477
1478     virtual wxEvent *Clone() const { return new wxMaximizeEvent(*this); }
1479
1480 private:
1481     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMaximizeEvent)
1482 };
1483
1484 // Joystick event class
1485 /*
1486  wxEVT_JOY_BUTTON_DOWN,
1487  wxEVT_JOY_BUTTON_UP,
1488  wxEVT_JOY_MOVE,
1489  wxEVT_JOY_ZMOVE
1490 */
1491
1492 // Which joystick? Same as Windows ids so no conversion necessary.
1493 enum
1494 {
1495     wxJOYSTICK1,
1496     wxJOYSTICK2
1497 };
1498
1499 // Which button is down?
1500 enum
1501 {
1502     wxJOY_BUTTON_ANY = -1,
1503     wxJOY_BUTTON1    = 1,
1504     wxJOY_BUTTON2    = 2,
1505     wxJOY_BUTTON3    = 4,
1506     wxJOY_BUTTON4    = 8
1507 };
1508
1509 class WXDLLIMPEXP_CORE wxJoystickEvent : public wxEvent
1510 {
1511 #if WXWIN_COMPATIBILITY_2_4
1512 public:
1513 #else
1514 protected:
1515 #endif
1516     wxPoint   m_pos;
1517     int       m_zPosition;
1518     int       m_buttonChange;   // Which button changed?
1519     int       m_buttonState;    // Which buttons are down?
1520     int       m_joyStick;       // Which joystick?
1521
1522 public:
1523     wxJoystickEvent(wxEventType type = wxEVT_NULL,
1524                     int state = 0,
1525                     int joystick = wxJOYSTICK1,
1526                     int change = 0)
1527         : wxEvent(0, type),
1528           m_pos(),
1529           m_zPosition(0),
1530           m_buttonChange(change),
1531           m_buttonState(state),
1532           m_joyStick(joystick)
1533     {
1534     }
1535     wxJoystickEvent(const wxJoystickEvent & event)
1536         : wxEvent(event),
1537           m_pos(event.m_pos),
1538           m_zPosition(event.m_zPosition),
1539           m_buttonChange(event.m_buttonChange),
1540           m_buttonState(event.m_buttonState),
1541           m_joyStick(event.m_joyStick)
1542     { }
1543
1544     wxPoint GetPosition() const { return m_pos; }
1545     int GetZPosition() const { return m_zPosition; }
1546     int GetButtonState() const { return m_buttonState; }
1547     int GetButtonChange() const { return m_buttonChange; }
1548     int GetJoystick() const { return m_joyStick; }
1549
1550     void SetJoystick(int stick) { m_joyStick = stick; }
1551     void SetButtonState(int state) { m_buttonState = state; }
1552     void SetButtonChange(int change) { m_buttonChange = change; }
1553     void SetPosition(const wxPoint& pos) { m_pos = pos; }
1554     void SetZPosition(int zPos) { m_zPosition = zPos; }
1555
1556     // Was it a button event? (*doesn't* mean: is any button *down*?)
1557     bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) ||
1558             (GetEventType() == wxEVT_JOY_BUTTON_UP)); }
1559
1560     // Was it a move event?
1561     bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE); }
1562
1563     // Was it a zmove event?
1564     bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE); }
1565
1566     // Was it a down event from button 1, 2, 3, 4 or any?
1567     bool ButtonDown(int but = wxJOY_BUTTON_ANY) const
1568     { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) &&
1569             ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
1570
1571     // Was it a up event from button 1, 2, 3 or any?
1572     bool ButtonUp(int but = wxJOY_BUTTON_ANY) const
1573     { return ((GetEventType() == wxEVT_JOY_BUTTON_UP) &&
1574             ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
1575
1576     // Was the given button 1,2,3,4 or any in Down state?
1577     bool ButtonIsDown(int but =  wxJOY_BUTTON_ANY) const
1578     { return (((but == wxJOY_BUTTON_ANY) && (m_buttonState != 0)) ||
1579             ((m_buttonState & but) == but)); }
1580
1581     virtual wxEvent *Clone() const { return new wxJoystickEvent(*this); }
1582
1583 private:
1584     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxJoystickEvent)
1585 };
1586
1587 // Drop files event class
1588 /*
1589  wxEVT_DROP_FILES
1590  */
1591
1592 class WXDLLIMPEXP_CORE wxDropFilesEvent : public wxEvent
1593 {
1594 public:
1595     int       m_noFiles;
1596     wxPoint   m_pos;
1597     wxString* m_files;
1598
1599     wxDropFilesEvent(wxEventType type = wxEVT_NULL,
1600                      int noFiles = 0,
1601                      wxString *files = (wxString *) NULL)
1602         : wxEvent(0, type),
1603           m_noFiles(noFiles),
1604           m_pos(),
1605           m_files(files)
1606         { }
1607
1608     // we need a copy ctor to avoid deleting m_files pointer twice
1609     wxDropFilesEvent(const wxDropFilesEvent& other)
1610         : wxEvent(other),
1611           m_noFiles(other.m_noFiles),
1612           m_pos(other.m_pos),
1613           m_files(NULL)
1614     {
1615         m_files = new wxString[m_noFiles];
1616         for ( int n = 0; n < m_noFiles; n++ )
1617         {
1618             m_files[n] = other.m_files[n];
1619         }
1620     }
1621
1622     virtual ~wxDropFilesEvent()
1623     {
1624         delete [] m_files;
1625     }
1626
1627     wxPoint GetPosition() const { return m_pos; }
1628     int GetNumberOfFiles() const { return m_noFiles; }
1629     wxString *GetFiles() const { return m_files; }
1630
1631     virtual wxEvent *Clone() const { return new wxDropFilesEvent(*this); }
1632
1633 private:
1634     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDropFilesEvent)
1635 };
1636
1637 // Update UI event
1638 /*
1639  wxEVT_UPDATE_UI
1640  */
1641
1642 // Whether to always send update events to windows, or
1643 // to only send update events to those with the
1644 // wxWS_EX_PROCESS_UI_UPDATES style.
1645
1646 enum wxUpdateUIMode
1647 {
1648         // Send UI update events to all windows
1649     wxUPDATE_UI_PROCESS_ALL,
1650
1651         // Send UI update events to windows that have
1652         // the wxWS_EX_PROCESS_UI_UPDATES flag specified
1653     wxUPDATE_UI_PROCESS_SPECIFIED
1654 };
1655
1656 class WXDLLIMPEXP_CORE wxUpdateUIEvent : public wxCommandEvent
1657 {
1658 public:
1659     wxUpdateUIEvent(wxWindowID commandId = 0)
1660         : wxCommandEvent(wxEVT_UPDATE_UI, commandId)
1661     {
1662         m_checked =
1663         m_enabled =
1664         m_setEnabled =
1665         m_setText =
1666         m_setChecked = false;
1667     }
1668     wxUpdateUIEvent(const wxUpdateUIEvent & event)
1669         : wxCommandEvent(event),
1670           m_checked(event.m_checked),
1671           m_enabled(event.m_enabled),
1672           m_setEnabled(event.m_setEnabled),
1673           m_setText(event.m_setText),
1674           m_setChecked(event.m_setChecked),
1675           m_text(event.m_text)
1676     { }
1677
1678     bool GetChecked() const { return m_checked; }
1679     bool GetEnabled() const { return m_enabled; }
1680     wxString GetText() const { return m_text; }
1681     bool GetSetText() const { return m_setText; }
1682     bool GetSetChecked() const { return m_setChecked; }
1683     bool GetSetEnabled() const { return m_setEnabled; }
1684
1685     void Check(bool check) { m_checked = check; m_setChecked = true; }
1686     void Enable(bool enable) { m_enabled = enable; m_setEnabled = true; }
1687     void SetText(const wxString& text) { m_text = text; m_setText = true; }
1688
1689     // Sets the interval between updates in milliseconds.
1690     // Set to -1 to disable updates, or to 0 to update as frequently as possible.
1691     static void SetUpdateInterval(long updateInterval) { sm_updateInterval = updateInterval; }
1692
1693     // Returns the current interval between updates in milliseconds
1694     static long GetUpdateInterval() { return sm_updateInterval; }
1695
1696     // Can we update this window?
1697     static bool CanUpdate(wxWindowBase *win);
1698
1699     // Reset the update time to provide a delay until the next
1700     // time we should update
1701     static void ResetUpdateTime();
1702
1703     // Specify how wxWidgets will send update events: to
1704     // all windows, or only to those which specify that they
1705     // will process the events.
1706     static void SetMode(wxUpdateUIMode mode) { sm_updateMode = mode; }
1707
1708     // Returns the UI update mode
1709     static wxUpdateUIMode GetMode() { return sm_updateMode; }
1710
1711     virtual wxEvent *Clone() const { return new wxUpdateUIEvent(*this); }
1712
1713 protected:
1714     bool          m_checked;
1715     bool          m_enabled;
1716     bool          m_setEnabled;
1717     bool          m_setText;
1718     bool          m_setChecked;
1719     wxString      m_text;
1720 #if wxUSE_LONGLONG
1721     static wxLongLong       sm_lastUpdate;
1722 #endif
1723     static long             sm_updateInterval;
1724     static wxUpdateUIMode   sm_updateMode;
1725
1726 private:
1727     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxUpdateUIEvent)
1728 };
1729
1730 /*
1731  wxEVT_SYS_COLOUR_CHANGED
1732  */
1733
1734 // TODO: shouldn't all events record the window ID?
1735 class WXDLLIMPEXP_CORE wxSysColourChangedEvent : public wxEvent
1736 {
1737 public:
1738     wxSysColourChangedEvent()
1739         : wxEvent(0, wxEVT_SYS_COLOUR_CHANGED)
1740         { }
1741
1742     virtual wxEvent *Clone() const { return new wxSysColourChangedEvent(*this); }
1743
1744 private:
1745     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSysColourChangedEvent)
1746 };
1747
1748 /*
1749  wxEVT_MOUSE_CAPTURE_CHANGED
1750  The window losing the capture receives this message
1751  (even if it released the capture itself).
1752  */
1753
1754 class WXDLLIMPEXP_CORE wxMouseCaptureChangedEvent : public wxEvent
1755 {
1756 public:
1757     wxMouseCaptureChangedEvent(wxWindowID winid = 0, wxWindow* gainedCapture = NULL)
1758         : wxEvent(winid, wxEVT_MOUSE_CAPTURE_CHANGED),
1759           m_gainedCapture(gainedCapture)
1760         { }
1761
1762     wxMouseCaptureChangedEvent(const wxMouseCaptureChangedEvent& event)
1763         : wxEvent(event),
1764           m_gainedCapture(event.m_gainedCapture)
1765         { }
1766
1767     virtual wxEvent *Clone() const { return new wxMouseCaptureChangedEvent(*this); }
1768
1769     wxWindow* GetCapturedWindow() const { return m_gainedCapture; };
1770
1771 private:
1772     wxWindow* m_gainedCapture;
1773
1774     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureChangedEvent)
1775 };
1776
1777 /*
1778  wxEVT_DISPLAY_CHANGED
1779  */
1780 class WXDLLIMPEXP_CORE wxDisplayChangedEvent : public wxEvent
1781 {
1782 private:
1783     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDisplayChangedEvent)
1784
1785 public:
1786     wxDisplayChangedEvent()
1787         : wxEvent(0, wxEVT_DISPLAY_CHANGED)
1788         { }
1789
1790     virtual wxEvent *Clone() const { return new wxDisplayChangedEvent(*this); }
1791 };
1792
1793 /*
1794  wxEVT_PALETTE_CHANGED
1795  */
1796
1797 class WXDLLIMPEXP_CORE wxPaletteChangedEvent : public wxEvent
1798 {
1799 public:
1800     wxPaletteChangedEvent(wxWindowID winid = 0)
1801         : wxEvent(winid, wxEVT_PALETTE_CHANGED),
1802           m_changedWindow((wxWindow *) NULL)
1803         { }
1804
1805     wxPaletteChangedEvent(const wxPaletteChangedEvent& event)
1806         : wxEvent(event),
1807           m_changedWindow(event.m_changedWindow)
1808         { }
1809
1810     void SetChangedWindow(wxWindow* win) { m_changedWindow = win; }
1811     wxWindow* GetChangedWindow() const { return m_changedWindow; }
1812
1813     virtual wxEvent *Clone() const { return new wxPaletteChangedEvent(*this); }
1814
1815 protected:
1816     wxWindow*     m_changedWindow;
1817
1818 private:
1819     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaletteChangedEvent)
1820 };
1821
1822 /*
1823  wxEVT_QUERY_NEW_PALETTE
1824  Indicates the window is getting keyboard focus and should re-do its palette.
1825  */
1826
1827 class WXDLLIMPEXP_CORE wxQueryNewPaletteEvent : public wxEvent
1828 {
1829 public:
1830     wxQueryNewPaletteEvent(wxWindowID winid = 0)
1831         : wxEvent(winid, wxEVT_QUERY_NEW_PALETTE),
1832           m_paletteRealized(false)
1833         { }
1834     wxQueryNewPaletteEvent(const wxQueryNewPaletteEvent & event)
1835         : wxEvent(event),
1836         m_paletteRealized(event.m_paletteRealized)
1837     { }
1838
1839     // App sets this if it changes the palette.
1840     void SetPaletteRealized(bool realized) { m_paletteRealized = realized; }
1841     bool GetPaletteRealized() const { return m_paletteRealized; }
1842
1843     virtual wxEvent *Clone() const { return new wxQueryNewPaletteEvent(*this); }
1844
1845 protected:
1846     bool m_paletteRealized;
1847
1848 private:
1849     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxQueryNewPaletteEvent)
1850 };
1851
1852 /*
1853  Event generated by dialog navigation keys
1854  wxEVT_NAVIGATION_KEY
1855  */
1856 // NB: don't derive from command event to avoid being propagated to the parent
1857 class WXDLLIMPEXP_CORE wxNavigationKeyEvent : public wxEvent
1858 {
1859 public:
1860     wxNavigationKeyEvent()
1861         : wxEvent(0, wxEVT_NAVIGATION_KEY),
1862           m_flags(IsForward | FromTab),    // defaults are for TAB
1863           m_focus((wxWindow *)NULL)
1864         {
1865             m_propagationLevel = wxEVENT_PROPAGATE_NONE;
1866         }
1867
1868     wxNavigationKeyEvent(const wxNavigationKeyEvent& event)
1869         : wxEvent(event),
1870           m_flags(event.m_flags),
1871           m_focus(event.m_focus)
1872         { }
1873
1874     // direction: forward (true) or backward (false)
1875     bool GetDirection() const
1876         { return (m_flags & IsForward) != 0; }
1877     void SetDirection(bool bForward)
1878         { if ( bForward ) m_flags |= IsForward; else m_flags &= ~IsForward; }
1879
1880     // it may be a window change event (MDI, notebook pages...) or a control
1881     // change event
1882     bool IsWindowChange() const
1883         { return (m_flags & WinChange) != 0; }
1884     void SetWindowChange(bool bIs)
1885         { if ( bIs ) m_flags |= WinChange; else m_flags &= ~WinChange; }
1886
1887     // Set to true under MSW if the event was generated using the tab key.
1888     // This is required for proper navogation over radio buttons
1889     bool IsFromTab() const
1890         { return (m_flags & FromTab) != 0; }
1891     void SetFromTab(bool bIs)
1892         { if ( bIs ) m_flags |= FromTab; else m_flags &= ~FromTab; }
1893
1894     // the child which has the focus currently (may be NULL - use
1895     // wxWindow::FindFocus then)
1896     wxWindow* GetCurrentFocus() const { return m_focus; }
1897     void SetCurrentFocus(wxWindow *win) { m_focus = win; }
1898
1899     // Set flags
1900     void SetFlags(long flags) { m_flags = flags; }
1901
1902     virtual wxEvent *Clone() const { return new wxNavigationKeyEvent(*this); }
1903
1904     enum
1905     {
1906         IsBackward = 0x0000,
1907         IsForward = 0x0001,
1908         WinChange = 0x0002,
1909         FromTab = 0x0004
1910     };
1911
1912     long m_flags;
1913     wxWindow *m_focus;
1914
1915 private:
1916     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNavigationKeyEvent)
1917 };
1918
1919 // Window creation/destruction events: the first is sent as soon as window is
1920 // created (i.e. the underlying GUI object exists), but when the C++ object is
1921 // fully initialized (so virtual functions may be called). The second,
1922 // wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
1923 // still safe to call virtual functions at this moment
1924 /*
1925  wxEVT_CREATE
1926  wxEVT_DESTROY
1927  */
1928
1929 class WXDLLIMPEXP_CORE wxWindowCreateEvent : public wxCommandEvent
1930 {
1931 public:
1932     wxWindowCreateEvent(wxWindow *win = NULL);
1933
1934     wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1935
1936     virtual wxEvent *Clone() const { return new wxWindowCreateEvent(*this); }
1937
1938 private:
1939     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowCreateEvent)
1940 };
1941
1942 class WXDLLIMPEXP_CORE wxWindowDestroyEvent : public wxCommandEvent
1943 {
1944 public:
1945     wxWindowDestroyEvent(wxWindow *win = NULL);
1946
1947     wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1948
1949     virtual wxEvent *Clone() const { return new wxWindowDestroyEvent(*this); }
1950
1951 private:
1952     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowDestroyEvent)
1953 };
1954
1955 // A help event is sent when the user clicks on a window in context-help mode.
1956 /*
1957  wxEVT_HELP
1958  wxEVT_DETAILED_HELP
1959 */
1960
1961 class WXDLLIMPEXP_CORE wxHelpEvent : public wxCommandEvent
1962 {
1963 public:
1964     wxHelpEvent(wxEventType type = wxEVT_NULL,
1965                 wxWindowID winid = 0,
1966                 const wxPoint& pt = wxDefaultPosition)
1967         : wxCommandEvent(type, winid),
1968           m_pos(pt), m_target(), m_link()
1969     { }
1970     wxHelpEvent(const wxHelpEvent & event)
1971         : wxCommandEvent(event),
1972           m_pos(event.m_pos),
1973           m_target(event.m_target),
1974           m_link(event.m_link)
1975     { }
1976
1977     // Position of event (in screen coordinates)
1978     const wxPoint& GetPosition() const { return m_pos; }
1979     void SetPosition(const wxPoint& pos) { m_pos = pos; }
1980
1981     // Optional link to further help
1982     const wxString& GetLink() const { return m_link; }
1983     void SetLink(const wxString& link) { m_link = link; }
1984
1985     // Optional target to display help in. E.g. a window specification
1986     const wxString& GetTarget() const { return m_target; }
1987     void SetTarget(const wxString& target) { m_target = target; }
1988
1989     virtual wxEvent *Clone() const { return new wxHelpEvent(*this); }
1990
1991 protected:
1992     wxPoint   m_pos;
1993     wxString  m_target;
1994     wxString  m_link;
1995
1996 private:
1997     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHelpEvent)
1998 };
1999
2000 // A Context event is sent when the user right clicks on a window or
2001 // presses Shift-F10
2002 // NOTE : Under windows this is a repackaged WM_CONTETXMENU message
2003 //        Under other systems it may have to be generated from a right click event
2004 /*
2005  wxEVT_CONTEXT_MENU
2006 */
2007
2008 class WXDLLIMPEXP_CORE wxContextMenuEvent : public wxCommandEvent
2009 {
2010 public:
2011     wxContextMenuEvent(wxEventType type = wxEVT_NULL,
2012                        wxWindowID winid = 0,
2013                        const wxPoint& pt = wxDefaultPosition)
2014         : wxCommandEvent(type, winid),
2015           m_pos(pt)
2016     { }
2017     wxContextMenuEvent(const wxContextMenuEvent & event)
2018         : wxCommandEvent(event),
2019         m_pos(event.m_pos)
2020     { }
2021
2022     // Position of event (in screen coordinates)
2023     const wxPoint& GetPosition() const { return m_pos; }
2024     void SetPosition(const wxPoint& pos) { m_pos = pos; }
2025
2026     virtual wxEvent *Clone() const { return new wxContextMenuEvent(*this); }
2027
2028 protected:
2029     wxPoint   m_pos;
2030
2031 private:
2032     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxContextMenuEvent)
2033 };
2034
2035 // Idle event
2036 /*
2037  wxEVT_IDLE
2038  */
2039
2040 // Whether to always send idle events to windows, or
2041 // to only send update events to those with the
2042 // wxWS_EX_PROCESS_IDLE style.
2043
2044 enum wxIdleMode
2045 {
2046         // Send idle events to all windows
2047     wxIDLE_PROCESS_ALL,
2048
2049         // Send idle events to windows that have
2050         // the wxWS_EX_PROCESS_IDLE flag specified
2051     wxIDLE_PROCESS_SPECIFIED
2052 };
2053
2054 class WXDLLIMPEXP_CORE wxIdleEvent : public wxEvent
2055 {
2056 public:
2057     wxIdleEvent()
2058         : wxEvent(0, wxEVT_IDLE),
2059           m_requestMore(false)
2060         { }
2061     wxIdleEvent(const wxIdleEvent & event)
2062         : wxEvent(event),
2063           m_requestMore(event.m_requestMore)
2064     { }
2065
2066     void RequestMore(bool needMore = true) { m_requestMore = needMore; }
2067     bool MoreRequested() const { return m_requestMore; }
2068
2069     virtual wxEvent *Clone() const { return new wxIdleEvent(*this); }
2070
2071     // Specify how wxWidgets will send idle events: to
2072     // all windows, or only to those which specify that they
2073     // will process the events.
2074     static void SetMode(wxIdleMode mode) { sm_idleMode = mode; }
2075
2076     // Returns the idle event mode
2077     static wxIdleMode GetMode() { return sm_idleMode; }
2078
2079     // Can we send an idle event?
2080     static bool CanSend(wxWindow* win);
2081
2082 protected:
2083     bool m_requestMore;
2084     static wxIdleMode sm_idleMode;
2085
2086 private:
2087     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIdleEvent)
2088 };
2089
2090 #endif // wxUSE_GUI
2091
2092 /* TODO
2093  wxEVT_POWER,
2094  wxEVT_MOUSE_CAPTURE_CHANGED,
2095  wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
2096 // wxEVT_FONT_CHANGED,  // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
2097                         // wxEVT_FONT_CHANGED to all other windows (maybe).
2098  wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
2099  wxEVT_MEASURE_ITEM,
2100  wxEVT_COMPARE_ITEM
2101 */
2102
2103
2104 // ============================================================================
2105 // event handler and related classes
2106 // ============================================================================
2107
2108 typedef void (wxEvtHandler::*wxObjectEventFunction)(wxEvent&);
2109
2110 // we can't have ctors nor base struct in backwards compatibility mode or
2111 // otherwise we won't be able to initialize the objects with an agregate, so
2112 // we have to keep both versions
2113 #if WXWIN_COMPATIBILITY_EVENT_TYPES
2114
2115 struct WXDLLIMPEXP_BASE wxEventTableEntry
2116 {
2117     // For some reason, this can't be wxEventType, or VC++ complains.
2118     int m_eventType;            // main event type
2119     int m_id;                   // control/menu/toolbar id
2120     int m_lastId;               // used for ranges of ids
2121     wxObjectEventFunction m_fn; // function to call: not wxEventFunction,
2122                                 // because of dependency problems
2123
2124     wxObject* m_callbackUserData;
2125 };
2126
2127 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
2128
2129 // struct containing the members common to static and dynamic event tables
2130 // entries
2131 struct WXDLLIMPEXP_BASE wxEventTableEntryBase
2132 {
2133 private:
2134     wxEventTableEntryBase& operator=(const wxEventTableEntryBase& event);
2135
2136 public:
2137     wxEventTableEntryBase(int winid, int idLast,
2138                           wxObjectEventFunction fn, wxObject *data)
2139         : m_id(winid),
2140           m_lastId(idLast),
2141           m_fn(fn),
2142           m_callbackUserData(data)
2143     { }
2144
2145     wxEventTableEntryBase(const wxEventTableEntryBase& event)
2146         : m_id(event.m_id),
2147           m_lastId(event.m_lastId),
2148           m_fn(event.m_fn),
2149           m_callbackUserData(event.m_callbackUserData)
2150     { }
2151
2152     // the range of ids for this entry: if m_lastId == wxID_ANY, the range
2153     // consists only of m_id, otherwise it is m_id..m_lastId inclusive
2154     int m_id,
2155         m_lastId;
2156
2157     // function to call: not wxEventFunction, because of dependency problems
2158     wxObjectEventFunction m_fn;
2159
2160     // arbitrary user data asosciated with the callback
2161     wxObject* m_callbackUserData;
2162 };
2163
2164 // an entry from a static event table
2165 struct WXDLLIMPEXP_BASE wxEventTableEntry : public wxEventTableEntryBase
2166 {
2167     wxEventTableEntry(const int& evType, int winid, int idLast,
2168                       wxObjectEventFunction fn, wxObject *data)
2169         : wxEventTableEntryBase(winid, idLast, fn, data),
2170         m_eventType(evType)
2171     { }
2172
2173     // the reference to event type: this allows us to not care about the
2174     // (undefined) order in which the event table entries and the event types
2175     // are initialized: initially the value of this reference might be
2176     // invalid, but by the time it is used for the first time, all global
2177     // objects will have been initialized (including the event type constants)
2178     // and so it will have the correct value when it is needed
2179     const int& m_eventType;
2180
2181 private:
2182     wxEventTableEntry& operator=(const wxEventTableEntry&);
2183 };
2184
2185 class WXDLLIMPEXP_BASE wxEvtHandler;
2186
2187 // an entry used in dynamic event table managed by wxEvtHandler::Connect()
2188 struct WXDLLIMPEXP_BASE wxDynamicEventTableEntry : public wxEventTableEntryBase
2189 {
2190     wxDynamicEventTableEntry(int evType, int winid, int idLast,
2191                              wxObjectEventFunction fn, wxObject *data, wxEvtHandler* eventSink)
2192         : wxEventTableEntryBase(winid, idLast, fn, data),
2193           m_eventType(evType),
2194           m_eventSink(eventSink)
2195     { }
2196
2197     // not a reference here as we can't keep a reference to a temporary int
2198     // created to wrap the constant value typically passed to Connect() - nor
2199     // do we need it
2200     int m_eventType;
2201
2202     // Pointer to object whose function is fn - so we don't assume the
2203     // EventFunction is always a member of the EventHandler receiving the
2204     // message
2205     wxEvtHandler* m_eventSink;
2206
2207     DECLARE_NO_COPY_CLASS(wxDynamicEventTableEntry)
2208 };
2209
2210 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
2211
2212 // ----------------------------------------------------------------------------
2213 // wxEventTable: an array of event entries terminated with {0, 0, 0, 0, 0}
2214 // ----------------------------------------------------------------------------
2215
2216 struct WXDLLIMPEXP_BASE wxEventTable
2217 {
2218     const wxEventTable *baseTable;    // base event table (next in chain)
2219     const wxEventTableEntry *entries; // bottom of entry array
2220 };
2221
2222 // ----------------------------------------------------------------------------
2223 // wxEventHashTable: a helper of wxEvtHandler to speed up wxEventTable lookups.
2224 // ----------------------------------------------------------------------------
2225
2226 WX_DEFINE_ARRAY_PTR(const wxEventTableEntry*, wxEventTableEntryPointerArray);
2227 class WXDLLIMPEXP_BASE wxEvtHandler;
2228
2229 class WXDLLIMPEXP_BASE wxEventHashTable
2230 {
2231 private:
2232     // Internal data structs
2233     struct EventTypeTable
2234     {
2235         wxEventType                   eventType;
2236         wxEventTableEntryPointerArray eventEntryTable;
2237     };
2238     typedef EventTypeTable* EventTypeTablePointer;
2239
2240 public:
2241     // Constructor, needs the event table it needs to hash later on.
2242     // Note: hashing of the event table is not done in the constructor as it
2243     //       can be that the event table is not yet full initialize, the hash
2244     //       will gets initialized when handling the first event look-up request.
2245     wxEventHashTable(const wxEventTable &table);
2246     // Destructor.
2247     ~wxEventHashTable();
2248
2249     // Handle the given event, in other words search the event table hash
2250     // and call self->ProcessEvent() if a match was found.
2251     bool HandleEvent(wxEvent &event, wxEvtHandler *self);
2252
2253     // Clear table
2254     void Clear();
2255
2256     // Clear all tables
2257     static void ClearAll();
2258
2259 protected:
2260     // Init the hash table with the entries of the static event table.
2261     void InitHashTable();
2262     // Helper funtion of InitHashTable() to insert 1 entry into the hash table.
2263     void AddEntry(const wxEventTableEntry &entry);
2264     // Allocate and init with null pointers the base hash table.
2265     void AllocEventTypeTable(size_t size);
2266     // Grow the hash table in size and transfer all items currently
2267     // in the table to the correct location in the new table.
2268     void GrowEventTypeTable();
2269
2270 protected:
2271     const wxEventTable    &m_table;
2272     bool                   m_rebuildHash;
2273
2274     size_t                 m_size;
2275     EventTypeTablePointer *m_eventTypeTable;
2276
2277     static wxEventHashTable* sm_first;
2278     wxEventHashTable* m_previous;
2279     wxEventHashTable* m_next;
2280
2281     DECLARE_NO_COPY_CLASS(wxEventHashTable)
2282 };
2283
2284 // ----------------------------------------------------------------------------
2285 // wxEvtHandler: the base class for all objects handling wxWidgets events
2286 // ----------------------------------------------------------------------------
2287
2288 class WXDLLIMPEXP_BASE wxEvtHandler : public wxObject
2289 {
2290 public:
2291     wxEvtHandler();
2292     virtual ~wxEvtHandler();
2293
2294     wxEvtHandler *GetNextHandler() const { return m_nextHandler; }
2295     wxEvtHandler *GetPreviousHandler() const { return m_previousHandler; }
2296     void SetNextHandler(wxEvtHandler *handler) { m_nextHandler = handler; }
2297     void SetPreviousHandler(wxEvtHandler *handler) { m_previousHandler = handler; }
2298
2299     void SetEvtHandlerEnabled(bool enabled) { m_enabled = enabled; }
2300     bool GetEvtHandlerEnabled() const { return m_enabled; }
2301
2302     // process an event right now
2303     virtual bool ProcessEvent(wxEvent& event);
2304
2305     // add an event to be processed later
2306     void AddPendingEvent(wxEvent& event);
2307
2308     // process all pending events
2309     void ProcessPendingEvents();
2310
2311 #if wxUSE_THREADS
2312     bool ProcessThreadEvent(wxEvent& event);
2313 #endif
2314
2315     // Dynamic association of a member function handler with the event handler,
2316     // winid and event type
2317     void Connect(int winid,
2318                  int lastId,
2319                  int eventType,
2320                  wxObjectEventFunction func,
2321                  wxObject *userData = (wxObject *) NULL,
2322                  wxEvtHandler *eventSink = (wxEvtHandler *) NULL);
2323
2324     // Convenience function: take just one id
2325     void Connect(int winid,
2326                  int eventType,
2327                  wxObjectEventFunction func,
2328                  wxObject *userData = (wxObject *) NULL,
2329                  wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2330         { Connect(winid, wxID_ANY, eventType, func, userData, eventSink); }
2331
2332     // Even more convenient: without id (same as using id of wxID_ANY)
2333     void Connect(int eventType,
2334                  wxObjectEventFunction func,
2335                  wxObject *userData = (wxObject *) NULL,
2336                  wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2337         { Connect(wxID_ANY, wxID_ANY, eventType, func, userData, eventSink); }
2338
2339     bool Disconnect(int winid,
2340                     int lastId,
2341                     wxEventType eventType,
2342                     wxObjectEventFunction func = NULL,
2343                     wxObject *userData = (wxObject *) NULL,
2344                     wxEvtHandler *eventSink = (wxEvtHandler *) NULL);
2345
2346     bool Disconnect(int winid = wxID_ANY,
2347                     wxEventType eventType = wxEVT_NULL,
2348                     wxObjectEventFunction func = NULL,
2349                     wxObject *userData = (wxObject *) NULL,
2350                     wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2351         { return Disconnect(winid, wxID_ANY, eventType, func, userData, eventSink); }
2352
2353
2354     wxList* GetDynamicEventTable() const { return m_dynamicEvents ; }
2355
2356     // User data can be associated with each wxEvtHandler
2357     void SetClientObject( wxClientData *data ) { DoSetClientObject(data); }
2358     wxClientData *GetClientObject() const { return DoGetClientObject(); }
2359
2360     void SetClientData( void *data ) { DoSetClientData(data); }
2361     void *GetClientData() const { return DoGetClientData(); }
2362
2363     // check if the given event table entry matches this event and call the
2364     // handler if it does
2365     //
2366     // return true if the event was processed, false otherwise (no match or the
2367     // handler decided to skip the event)
2368     static bool ProcessEventIfMatches(const wxEventTableEntryBase& tableEntry,
2369                                       wxEvtHandler *handler,
2370                                       wxEvent& event);
2371
2372     // implementation from now on
2373     virtual bool SearchEventTable(wxEventTable& table, wxEvent& event);
2374     bool SearchDynamicEventTable( wxEvent& event );
2375
2376 #if wxUSE_THREADS
2377     void ClearEventLocker();
2378 #endif // wxUSE_THREADS
2379
2380     // Avoid problems at exit by cleaning up static hash table gracefully
2381     void ClearEventHashTable() { GetEventHashTable().Clear(); }
2382
2383 private:
2384     static const wxEventTableEntry sm_eventTableEntries[];
2385
2386 protected:
2387     // hooks for wxWindow used by ProcessEvent()
2388     // -----------------------------------------
2389
2390     // This one is called before trying our own event table to allow plugging
2391     // in the validators.
2392     //
2393     // NB: This method is intentionally *not* inside wxUSE_VALIDATORS!
2394     //     It is part of wxBase which doesn't use validators and the code
2395     //     is compiled out when building wxBase w/o GUI classes, which affects
2396     //     binary compatiblity and wxBase library can't be used by GUI
2397     //     ports.
2398     virtual bool TryValidator(wxEvent& WXUNUSED(event)) { return false; }
2399
2400     // this one is called after failing to find the event handle in our own
2401     // table to give a chance to the other windows to process it
2402     //
2403     // base class implementation passes the event to wxTheApp
2404     virtual bool TryParent(wxEvent& event);
2405
2406
2407     static const wxEventTable sm_eventTable;
2408     virtual const wxEventTable *GetEventTable() const;
2409
2410     static wxEventHashTable   sm_eventHashTable;
2411     virtual wxEventHashTable& GetEventHashTable() const;
2412
2413     wxEvtHandler*       m_nextHandler;
2414     wxEvtHandler*       m_previousHandler;
2415     wxList*             m_dynamicEvents;
2416     wxList*             m_pendingEvents;
2417
2418 #if wxUSE_THREADS
2419 #if defined (__VISAGECPP__)
2420     wxCriticalSection   m_eventsLocker;
2421 #  else
2422     wxCriticalSection*  m_eventsLocker;
2423 #  endif
2424 #endif
2425
2426     // Is event handler enabled?
2427     bool                m_enabled;
2428
2429
2430     // The user data: either an object which will be deleted by the container
2431     // when it's deleted or some raw pointer which we do nothing with - only
2432     // one type of data can be used with the given window (i.e. you cannot set
2433     // the void data and then associate the container with wxClientData or vice
2434     // versa)
2435     union
2436     {
2437         wxClientData *m_clientObject;
2438         void         *m_clientData;
2439     };
2440
2441     // what kind of data do we have?
2442     wxClientDataType m_clientDataType;
2443
2444     // client data accessors
2445     virtual void DoSetClientObject( wxClientData *data );
2446     virtual wxClientData *DoGetClientObject() const;
2447
2448     virtual void DoSetClientData( void *data );
2449     virtual void *DoGetClientData() const;
2450
2451 private:
2452     DECLARE_DYNAMIC_CLASS_NO_COPY(wxEvtHandler)
2453 };
2454
2455 // Post a message to the given eventhandler which will be processed during the
2456 // next event loop iteration
2457 inline void wxPostEvent(wxEvtHandler *dest, wxEvent& event)
2458 {
2459     wxCHECK_RET( dest, wxT("need an object to post event to in wxPostEvent") );
2460
2461     dest->AddPendingEvent(event);
2462 }
2463
2464 typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&);
2465
2466 #define wxEventHandler(func) \
2467     (wxObjectEventFunction)wxStaticCastEvent(wxEventFunction, &func)
2468
2469 #if wxUSE_GUI
2470
2471 typedef void (wxEvtHandler::*wxCommandEventFunction)(wxCommandEvent&);
2472 typedef void (wxEvtHandler::*wxScrollEventFunction)(wxScrollEvent&);
2473 typedef void (wxEvtHandler::*wxScrollWinEventFunction)(wxScrollWinEvent&);
2474 typedef void (wxEvtHandler::*wxSizeEventFunction)(wxSizeEvent&);
2475 typedef void (wxEvtHandler::*wxMoveEventFunction)(wxMoveEvent&);
2476 typedef void (wxEvtHandler::*wxPaintEventFunction)(wxPaintEvent&);
2477 typedef void (wxEvtHandler::*wxNcPaintEventFunction)(wxNcPaintEvent&);
2478 typedef void (wxEvtHandler::*wxEraseEventFunction)(wxEraseEvent&);
2479 typedef void (wxEvtHandler::*wxMouseEventFunction)(wxMouseEvent&);
2480 typedef void (wxEvtHandler::*wxCharEventFunction)(wxKeyEvent&);
2481 typedef void (wxEvtHandler::*wxFocusEventFunction)(wxFocusEvent&);
2482 typedef void (wxEvtHandler::*wxChildFocusEventFunction)(wxChildFocusEvent&);
2483 typedef void (wxEvtHandler::*wxActivateEventFunction)(wxActivateEvent&);
2484 typedef void (wxEvtHandler::*wxMenuEventFunction)(wxMenuEvent&);
2485 typedef void (wxEvtHandler::*wxJoystickEventFunction)(wxJoystickEvent&);
2486 typedef void (wxEvtHandler::*wxDropFilesEventFunction)(wxDropFilesEvent&);
2487 typedef void (wxEvtHandler::*wxInitDialogEventFunction)(wxInitDialogEvent&);
2488 typedef void (wxEvtHandler::*wxSysColourChangedEventFunction)(wxSysColourChangedEvent&);
2489 typedef void (wxEvtHandler::*wxDisplayChangedEventFunction)(wxDisplayChangedEvent&);
2490 typedef void (wxEvtHandler::*wxUpdateUIEventFunction)(wxUpdateUIEvent&);
2491 typedef void (wxEvtHandler::*wxIdleEventFunction)(wxIdleEvent&);
2492 typedef void (wxEvtHandler::*wxCloseEventFunction)(wxCloseEvent&);
2493 typedef void (wxEvtHandler::*wxShowEventFunction)(wxShowEvent&);
2494 typedef void (wxEvtHandler::*wxIconizeEventFunction)(wxIconizeEvent&);
2495 typedef void (wxEvtHandler::*wxMaximizeEventFunction)(wxMaximizeEvent&);
2496 typedef void (wxEvtHandler::*wxNavigationKeyEventFunction)(wxNavigationKeyEvent&);
2497 typedef void (wxEvtHandler::*wxPaletteChangedEventFunction)(wxPaletteChangedEvent&);
2498 typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction)(wxQueryNewPaletteEvent&);
2499 typedef void (wxEvtHandler::*wxWindowCreateEventFunction)(wxWindowCreateEvent&);
2500 typedef void (wxEvtHandler::*wxWindowDestroyEventFunction)(wxWindowDestroyEvent&);
2501 typedef void (wxEvtHandler::*wxSetCursorEventFunction)(wxSetCursorEvent&);
2502 typedef void (wxEvtHandler::*wxNotifyEventFunction)(wxNotifyEvent&);
2503 typedef void (wxEvtHandler::*wxHelpEventFunction)(wxHelpEvent&);
2504 typedef void (wxEvtHandler::*wxContextMenuEventFunction)(wxContextMenuEvent&);
2505 typedef void (wxEvtHandler::*wxMouseCaptureChangedEventFunction)(wxMouseCaptureChangedEvent&);
2506
2507 // these typedefs don't have the same name structure as the others, keep for
2508 // backwards compatibility only
2509 #if WXWIN_COMPATIBILITY_2_4
2510     typedef wxSysColourChangedEventFunction wxSysColourChangedFunction;
2511     typedef wxDisplayChangedEventFunction wxDisplayChangedFunction;
2512 #endif // WXWIN_COMPATIBILITY_2_4
2513
2514
2515 #define wxCommandEventHandler(func) \
2516     (wxObjectEventFunction)wxStaticCastEvent(wxCommandEventFunction, &func)
2517 #define wxScrollEventHandler(func) \
2518     (wxObjectEventFunction)wxStaticCastEvent(wxScrollEventFunction, &func)
2519 #define wxScrollWinEventHandler(func) \
2520     (wxObjectEventFunction)wxStaticCastEvent(wxScrollWinEventFunction, &func)
2521 #define wxSizeEventHandler(func) \
2522     (wxObjectEventFunction)wxStaticCastEvent(wxSizeEventFunction, &func)
2523 #define wxMoveEventHandler(func) \
2524     (wxObjectEventFunction)wxStaticCastEvent(wxMoveEventFunction, &func)
2525 #define wxPaintEventHandler(func) \
2526     (wxObjectEventFunction)wxStaticCastEvent(wxPaintEventFunction, &func)
2527 #define wxNcPaintEventHandler(func) \
2528     (wxObjectEventFunction)wxStaticCastEvent(wxNcPaintEventFunction, &func)
2529 #define wxEraseEventHandler(func) \
2530     (wxObjectEventFunction)wxStaticCastEvent(wxEraseEventFunction, &func)
2531 #define wxMouseEventHandler(func) \
2532     (wxObjectEventFunction)wxStaticCastEvent(wxMouseEventFunction, &func)
2533 #define wxCharEventHandler(func) \
2534     (wxObjectEventFunction)wxStaticCastEvent(wxCharEventFunction, &func)
2535 #define wxKeyEventHandler(func) wxCharEventHandler(func)
2536 #define wxFocusEventHandler(func) \
2537     (wxObjectEventFunction)wxStaticCastEvent(wxFocusEventFunction, &func)
2538 #define wxChildFocusEventHandler(func) \
2539     (wxObjectEventFunction)wxStaticCastEvent(wxChildFocusEventFunction, &func)
2540 #define wxActivateEventHandler(func) \
2541     (wxObjectEventFunction)wxStaticCastEvent(wxActivateEventFunction, &func)
2542 #define wxMenuEventHandler(func) \
2543     (wxObjectEventFunction)wxStaticCastEvent(wxMenuEventFunction, &func)
2544 #define wxJoystickEventHandler(func) \
2545     (wxObjectEventFunction)wxStaticCastEvent(wxJoystickEventFunction, &func)
2546 #define wxDropFilesEventHandler(func) \
2547     (wxObjectEventFunction)wxStaticCastEvent(wxDropFilesEventFunction, &func)
2548 #define wxInitDialogEventHandler(func) \
2549     (wxObjectEventFunction)wxStaticCastEvent(wxInitDialogEventFunction, &func)
2550 #define wxSysColourChangedEventHandler(func) \
2551     (wxObjectEventFunction)wxStaticCastEvent(wxSysColourChangedEventFunction, &func)
2552 #define wxDisplayChangedEventHandler(func) \
2553     (wxObjectEventFunction)wxStaticCastEvent(wxDisplayChangedEventFunction, &func)
2554 #define wxUpdateUIEventHandler(func) \
2555     (wxObjectEventFunction)wxStaticCastEvent(wxUpdateUIEventFunction, &func)
2556 #define wxIdleEventHandler(func) \
2557     (wxObjectEventFunction)wxStaticCastEvent(wxIdleEventFunction, &func)
2558 #define wxCloseEventHandler(func) \
2559     (wxObjectEventFunction)wxStaticCastEvent(wxCloseEventFunction, &func)
2560 #define wxShowEventHandler(func) \
2561     (wxObjectEventFunction)wxStaticCastEvent(wxShowEventFunction, &func)
2562 #define wxIconizeEventHandler(func) \
2563     (wxObjectEventFunction)wxStaticCastEvent(wxIconizeEventFunction, &func)
2564 #define wxMaximizeEventHandler(func) \
2565     (wxObjectEventFunction)wxStaticCastEvent(wxMaximizeEventFunction, &func)
2566 #define wxNavigationKeyEventHandler(func) \
2567     (wxObjectEventFunction)wxStaticCastEvent(wxNavigationKeyEventFunction, &func)
2568 #define wxPaletteChangedEventHandler(func) \
2569     (wxObjectEventFunction)wxStaticCastEvent(wxPaletteChangedEventFunction, &func)
2570 #define wxQueryNewPaletteEventHandler(func) \
2571     (wxObjectEventFunction)wxStaticCastEvent(wxQueryNewPaletteEventFunction, &func)
2572 #define wxWindowCreateEventHandler(func) \
2573     (wxObjectEventFunction)wxStaticCastEvent(wxWindowCreateEventFunction, &func)
2574 #define wxWindowDestroyEventHandler(func) \
2575     (wxObjectEventFunction)wxStaticCastEvent(wxWindowDestroyEventFunction, &func)
2576 #define wxSetCursorEventHandler(func) \
2577     (wxObjectEventFunction)wxStaticCastEvent(wxSetCursorEventFunction, &func)
2578 #define wxNotifyEventHandler(func) \
2579     (wxObjectEventFunction)wxStaticCastEvent(wxNotifyEventFunction, &func)
2580 #define wxHelpEventHandler(func) \
2581     (wxObjectEventFunction)wxStaticCastEvent(wxHelpEventFunction, &func)
2582 #define wxContextMenuEventHandler(func) \
2583     (wxObjectEventFunction)wxStaticCastEvent(wxContextMenuEventFunction, &func)
2584 #define wxMouseCaptureChangedEventHandler(func) \
2585     (wxObjectEventFunction)wxStaticCastEvent(wxMouseCaptureChangedEventFunction, &func)
2586
2587 #endif // wxUSE_GUI
2588
2589 // N.B. In GNU-WIN32, you *have* to take the address of a member function
2590 // (use &) or the compiler crashes...
2591
2592 #define DECLARE_EVENT_TABLE() \
2593     private: \
2594         static const wxEventTableEntry sm_eventTableEntries[]; \
2595     protected: \
2596         static const wxEventTable        sm_eventTable; \
2597         virtual const wxEventTable*      GetEventTable() const; \
2598         static wxEventHashTable          sm_eventHashTable; \
2599         virtual wxEventHashTable&        GetEventHashTable() const;
2600
2601 // N.B.: when building DLL with Borland C++ 5.5 compiler, you must initialize
2602 //       sm_eventTable before using it in GetEventTable() or the compiler gives
2603 //       E2233 (see http://groups.google.com/groups?selm=397dcc8a%241_2%40dnews)
2604
2605 #define BEGIN_EVENT_TABLE(theClass, baseClass) \
2606     const wxEventTable theClass::sm_eventTable = \
2607         { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] }; \
2608     const wxEventTable *theClass::GetEventTable() const \
2609         { return &theClass::sm_eventTable; } \
2610     wxEventHashTable theClass::sm_eventHashTable(theClass::sm_eventTable); \
2611     wxEventHashTable &theClass::GetEventHashTable() const \
2612         { return theClass::sm_eventHashTable; } \
2613     const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
2614
2615 #define END_EVENT_TABLE() DECLARE_EVENT_TABLE_ENTRY( wxEVT_NULL, 0, 0, 0, 0 ) };
2616
2617 /*
2618  * Event table macros
2619  */
2620
2621 // helpers for writing shorter code below: declare an event macro taking 2, 1
2622 // or none ids (the missing ids default to wxID_ANY)
2623 //
2624 // macro arguments:
2625 //  - evt one of wxEVT_XXX constants
2626 //  - id1, id2 ids of the first/last id
2627 //  - fn the function (should be cast to the right type)
2628 #define wx__DECLARE_EVT2(evt, id1, id2, fn) \
2629     DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
2630 #define wx__DECLARE_EVT1(evt, id, fn) \
2631     wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
2632 #define wx__DECLARE_EVT0(evt, fn) \
2633     wx__DECLARE_EVT1(evt, wxID_ANY, fn)
2634
2635
2636 // Generic events
2637 #define EVT_CUSTOM(event, winid, func) \
2638     wx__DECLARE_EVT1(event, winid, wxEventHandler(func))
2639 #define EVT_CUSTOM_RANGE(event, id1, id2, func) \
2640     wx__DECLARE_EVT2(event, id1, id2, wxEventHandler(func))
2641
2642 // EVT_COMMAND
2643 #define EVT_COMMAND(winid, event, func) \
2644     wx__DECLARE_EVT1(event, winid, wxCommandEventHandler(func))
2645 #define EVT_COMMAND_RANGE(id1, id2, event, func) \
2646     wx__DECLARE_EVT2(event, id1, id2, wxCommandEventHandler(func))
2647
2648 #define EVT_NOTIFY(event, winid, func) \
2649     wx__DECLARE_EVT1(event, winid, wxNotifyEventHandler(func))
2650 #define EVT_NOTIFY_RANGE(event, id1, id2, func) \
2651     wx__DECLARE_EVT2(event, id1, id2, wxNotifyEventHandler(func))
2652
2653 // Miscellaneous
2654 #define EVT_SIZE(func)  wx__DECLARE_EVT0(wxEVT_SIZE, wxSizeEventHandler(func))
2655 #define EVT_SIZING(func)  wx__DECLARE_EVT0(wxEVT_SIZING, wxSizeEventHandler(func))
2656 #define EVT_MOVE(func)  wx__DECLARE_EVT0(wxEVT_MOVE, wxMoveEventHandler(func))
2657 #define EVT_MOVING(func)  wx__DECLARE_EVT0(wxEVT_MOVING, wxMoveEventHandler(func))
2658 #define EVT_CLOSE(func)  wx__DECLARE_EVT0(wxEVT_CLOSE_WINDOW, wxCloseEventHandler(func))
2659 #define EVT_END_SESSION(func)  wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
2660 #define EVT_QUERY_END_SESSION(func)  wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
2661 #define EVT_PAINT(func)  wx__DECLARE_EVT0(wxEVT_PAINT, wxPaintEventHandler(func))
2662 #define EVT_NC_PAINT(func)  wx__DECLARE_EVT0(wxEVT_NC_PAINT, wxNcPaintEventHandler(func))
2663 #define EVT_ERASE_BACKGROUND(func)  wx__DECLARE_EVT0(wxEVT_ERASE_BACKGROUND, wxEraseEventHandler(func))
2664 #define EVT_CHAR(func)  wx__DECLARE_EVT0(wxEVT_CHAR, wxCharEventHandler(func))
2665 #define EVT_KEY_DOWN(func)  wx__DECLARE_EVT0(wxEVT_KEY_DOWN, wxKeyEventHandler(func))
2666 #define EVT_KEY_UP(func)  wx__DECLARE_EVT0(wxEVT_KEY_UP, wxKeyEventHandler(func))
2667 #if wxUSE_HOTKEY
2668 #define EVT_HOTKEY(winid, func)  wx__DECLARE_EVT1(wxEVT_HOTKEY, winid, wxCharEventHandler(func))
2669 #endif
2670 #define EVT_CHAR_HOOK(func)  wx__DECLARE_EVT0(wxEVT_CHAR_HOOK, wxCharEventHandler(func))
2671 #define EVT_MENU_OPEN(func)  wx__DECLARE_EVT0(wxEVT_MENU_OPEN, wxMenuEventHandler(func))
2672 #define EVT_MENU_CLOSE(func)  wx__DECLARE_EVT0(wxEVT_MENU_CLOSE, wxMenuEventHandler(func))
2673 #define EVT_MENU_HIGHLIGHT(winid, func)  wx__DECLARE_EVT1(wxEVT_MENU_HIGHLIGHT, winid, wxMenuEventHandler(func))
2674 #define EVT_MENU_HIGHLIGHT_ALL(func)  wx__DECLARE_EVT0(wxEVT_MENU_HIGHLIGHT, wxMenuEventHandler(func))
2675 #define EVT_SET_FOCUS(func)  wx__DECLARE_EVT0(wxEVT_SET_FOCUS, wxFocusEventHandler(func))
2676 #define EVT_KILL_FOCUS(func)  wx__DECLARE_EVT0(wxEVT_KILL_FOCUS, wxFocusEventHandler(func))
2677 #define EVT_CHILD_FOCUS(func)  wx__DECLARE_EVT0(wxEVT_CHILD_FOCUS, wxChildFocusEventHandler(func))
2678 #define EVT_ACTIVATE(func)  wx__DECLARE_EVT0(wxEVT_ACTIVATE, wxActivateEventHandler(func))
2679 #define EVT_ACTIVATE_APP(func)  wx__DECLARE_EVT0(wxEVT_ACTIVATE_APP, wxActivateEventHandler(func))
2680 #define EVT_END_SESSION(func)  wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
2681 #define EVT_QUERY_END_SESSION(func)  wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
2682 #define EVT_DROP_FILES(func)  wx__DECLARE_EVT0(wxEVT_DROP_FILES, wxDropFilesEventHandler(func))
2683 #define EVT_INIT_DIALOG(func)  wx__DECLARE_EVT0(wxEVT_INIT_DIALOG, wxInitDialogEventHandler(func))
2684 #define EVT_SYS_COLOUR_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEventHandler(func))
2685 #define EVT_DISPLAY_CHANGED(func)  wx__DECLARE_EVT0(wxEVT_DISPLAY_CHANGED, wxDisplayChangedEventHandler(func))
2686 #define EVT_SHOW(func) wx__DECLARE_EVT0(wxEVT_SHOW, wxShowEventHandler(func))
2687 #define EVT_MAXIMIZE(func) wx__DECLARE_EVT0(wxEVT_MAXIMIZE, wxMaximizeEventHandler(func))
2688 #define EVT_ICONIZE(func) wx__DECLARE_EVT0(wxEVT_ICONIZE, wxIconizeEventHandler(func))
2689 #define EVT_NAVIGATION_KEY(func) wx__DECLARE_EVT0(wxEVT_NAVIGATION_KEY, wxNavigationKeyEventHandler(func))
2690 #define EVT_PALETTE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_PALETTE_CHANGED, wxPaletteChangedEventHandler(func))
2691 #define EVT_QUERY_NEW_PALETTE(func) wx__DECLARE_EVT0(wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEventHandler(func))
2692 #define EVT_WINDOW_CREATE(func) wx__DECLARE_EVT0(wxEVT_CREATE, wxWindowCreateEventHandler(func))
2693 #define EVT_WINDOW_DESTROY(func) wx__DECLARE_EVT0(wxEVT_DESTROY, wxWindowDestroyEventHandler(func))
2694 #define EVT_SET_CURSOR(func) wx__DECLARE_EVT0(wxEVT_SET_CURSOR, wxSetCursorEventHandler(func))
2695 #define EVT_MOUSE_CAPTURE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEventHandler(func))
2696
2697 // Mouse events
2698 #define EVT_LEFT_DOWN(func) wx__DECLARE_EVT0(wxEVT_LEFT_DOWN, wxMouseEventHandler(func))
2699 #define EVT_LEFT_UP(func) wx__DECLARE_EVT0(wxEVT_LEFT_UP, wxMouseEventHandler(func))
2700 #define EVT_MIDDLE_DOWN(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DOWN, wxMouseEventHandler(func))
2701 #define EVT_MIDDLE_UP(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_UP, wxMouseEventHandler(func))
2702 #define EVT_RIGHT_DOWN(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DOWN, wxMouseEventHandler(func))
2703 #define EVT_RIGHT_UP(func) wx__DECLARE_EVT0(wxEVT_RIGHT_UP, wxMouseEventHandler(func))
2704 #define EVT_MOTION(func) wx__DECLARE_EVT0(wxEVT_MOTION, wxMouseEventHandler(func))
2705 #define EVT_LEFT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_LEFT_DCLICK, wxMouseEventHandler(func))
2706 #define EVT_MIDDLE_DCLICK(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DCLICK, wxMouseEventHandler(func))
2707 #define EVT_RIGHT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DCLICK, wxMouseEventHandler(func))
2708 #define EVT_LEAVE_WINDOW(func) wx__DECLARE_EVT0(wxEVT_LEAVE_WINDOW, wxMouseEventHandler(func))
2709 #define EVT_ENTER_WINDOW(func) wx__DECLARE_EVT0(wxEVT_ENTER_WINDOW, wxMouseEventHandler(func))
2710 #define EVT_MOUSEWHEEL(func) wx__DECLARE_EVT0(wxEVT_MOUSEWHEEL, wxMouseEventHandler(func))
2711
2712 // All mouse events
2713 #define EVT_MOUSE_EVENTS(func) \
2714     EVT_LEFT_DOWN(func) \
2715     EVT_LEFT_UP(func) \
2716     EVT_MIDDLE_DOWN(func) \
2717     EVT_MIDDLE_UP(func) \
2718     EVT_RIGHT_DOWN(func) \
2719     EVT_RIGHT_UP(func) \
2720     EVT_MOTION(func) \
2721     EVT_LEFT_DCLICK(func) \
2722     EVT_MIDDLE_DCLICK(func) \
2723     EVT_RIGHT_DCLICK(func) \
2724     EVT_LEAVE_WINDOW(func) \
2725     EVT_ENTER_WINDOW(func) \
2726     EVT_MOUSEWHEEL(func)
2727
2728 // Scrolling from wxWindow (sent to wxScrolledWindow)
2729 #define EVT_SCROLLWIN_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_TOP, wxScrollWinEventHandler(func))
2730 #define EVT_SCROLLWIN_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEventHandler(func))
2731 #define EVT_SCROLLWIN_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEUP, wxScrollWinEventHandler(func))
2732 #define EVT_SCROLLWIN_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEventHandler(func))
2733 #define EVT_SCROLLWIN_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEventHandler(func))
2734 #define EVT_SCROLLWIN_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEventHandler(func))
2735 #define EVT_SCROLLWIN_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEventHandler(func))
2736 #define EVT_SCROLLWIN_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEventHandler(func))
2737
2738 #define EVT_SCROLLWIN(func) \
2739     EVT_SCROLLWIN_TOP(func) \
2740     EVT_SCROLLWIN_BOTTOM(func) \
2741     EVT_SCROLLWIN_LINEUP(func) \
2742     EVT_SCROLLWIN_LINEDOWN(func) \
2743     EVT_SCROLLWIN_PAGEUP(func) \
2744     EVT_SCROLLWIN_PAGEDOWN(func) \
2745     EVT_SCROLLWIN_THUMBTRACK(func) \
2746     EVT_SCROLLWIN_THUMBRELEASE(func)
2747
2748 // Scrolling from wxSlider and wxScrollBar
2749 #define EVT_SCROLL_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_TOP, wxScrollEventHandler(func))
2750 #define EVT_SCROLL_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLL_BOTTOM, wxScrollEventHandler(func))
2751 #define EVT_SCROLL_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEUP, wxScrollEventHandler(func))
2752 #define EVT_SCROLL_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEDOWN, wxScrollEventHandler(func))
2753 #define EVT_SCROLL_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEUP, wxScrollEventHandler(func))
2754 #define EVT_SCROLL_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler(func))
2755 #define EVT_SCROLL_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler(func))
2756 #define EVT_SCROLL_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBRELEASE, wxScrollEventHandler(func))
2757 #define EVT_SCROLL_ENDSCROLL(func) wx__DECLARE_EVT0(wxEVT_SCROLL_ENDSCROLL, wxScrollEventHandler(func))
2758
2759 #define EVT_SCROLL(func) \
2760     EVT_SCROLL_TOP(func) \
2761     EVT_SCROLL_BOTTOM(func) \
2762     EVT_SCROLL_LINEUP(func) \
2763     EVT_SCROLL_LINEDOWN(func) \
2764     EVT_SCROLL_PAGEUP(func) \
2765     EVT_SCROLL_PAGEDOWN(func) \
2766     EVT_SCROLL_THUMBTRACK(func) \
2767     EVT_SCROLL_THUMBRELEASE(func)
2768
2769 // Scrolling from wxSlider and wxScrollBar, with an id
2770 #define EVT_COMMAND_SCROLL_TOP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_TOP, winid, wxScrollEventHandler(func))
2771 #define EVT_COMMAND_SCROLL_BOTTOM(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_BOTTOM, winid, wxScrollEventHandler(func))
2772 #define EVT_COMMAND_SCROLL_LINEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEUP, winid, wxScrollEventHandler(func))
2773 #define EVT_COMMAND_SCROLL_LINEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEDOWN, winid, wxScrollEventHandler(func))
2774 #define EVT_COMMAND_SCROLL_PAGEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEUP, winid, wxScrollEventHandler(func))
2775 #define EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEDOWN, winid, wxScrollEventHandler(func))
2776 #define EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBTRACK, winid, wxScrollEventHandler(func))
2777 #define EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBRELEASE, winid, wxScrollEventHandler(func))
2778 #define EVT_COMMAND_SCROLL_ENDSCROLL(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_ENDSCROLL, winid, wxScrollEventHandler(func))
2779
2780 #define EVT_COMMAND_SCROLL(winid, func) \
2781     EVT_COMMAND_SCROLL_TOP(winid, func) \
2782     EVT_COMMAND_SCROLL_BOTTOM(winid, func) \
2783     EVT_COMMAND_SCROLL_LINEUP(winid, func) \
2784     EVT_COMMAND_SCROLL_LINEDOWN(winid, func) \
2785     EVT_COMMAND_SCROLL_PAGEUP(winid, func) \
2786     EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) \
2787     EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) \
2788     EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func)
2789
2790 // Convenience macros for commonly-used commands
2791 #define EVT_CHECKBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKBOX_CLICKED, winid, wxCommandEventHandler(func))
2792 #define EVT_CHOICE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHOICE_SELECTED, winid, wxCommandEventHandler(func))
2793 #define EVT_LISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_SELECTED, winid, wxCommandEventHandler(func))
2794 #define EVT_LISTBOX_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, winid, wxCommandEventHandler(func))
2795 #define EVT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_MENU_SELECTED, winid, wxCommandEventHandler(func))
2796 #define EVT_MENU_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_MENU_SELECTED, id1, id2, wxCommandEventHandler(func))
2797 #if defined(__SMARTPHONE__)
2798 #  define EVT_BUTTON(winid, func) EVT_MENU(winid, func)
2799 #else
2800 #  define EVT_BUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_BUTTON_CLICKED, winid, wxCommandEventHandler(func))
2801 #endif
2802 #define EVT_SLIDER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SLIDER_UPDATED, winid, wxCommandEventHandler(func))
2803 #define EVT_RADIOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBOX_SELECTED, winid, wxCommandEventHandler(func))
2804 #define EVT_RADIOBUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBUTTON_SELECTED, winid, wxCommandEventHandler(func))
2805 // EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events
2806 #define EVT_SCROLLBAR(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SCROLLBAR_UPDATED, winid, wxCommandEventHandler(func))
2807 #define EVT_VLBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_VLBOX_SELECTED, winid, wxCommandEventHandler(func))
2808 #define EVT_COMBOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_SELECTED, winid, wxCommandEventHandler(func))
2809 #define EVT_TOOL(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_CLICKED, winid, wxCommandEventHandler(func))
2810 #define EVT_TOOL_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_CLICKED, id1, id2, wxCommandEventHandler(func))
2811 #define EVT_TOOL_RCLICKED(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_RCLICKED, winid, wxCommandEventHandler(func))
2812 #define EVT_TOOL_RCLICKED_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, wxCommandEventHandler(func))
2813 #define EVT_TOOL_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_ENTER, winid, wxCommandEventHandler(func))
2814 #define EVT_CHECKLISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, winid, wxCommandEventHandler(func))
2815
2816 // Generic command events
2817 #define EVT_COMMAND_LEFT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_CLICK, winid, wxCommandEventHandler(func))
2818 #define EVT_COMMAND_LEFT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_DCLICK, winid, wxCommandEventHandler(func))
2819 #define EVT_COMMAND_RIGHT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_CLICK, winid, wxCommandEventHandler(func))
2820 #define EVT_COMMAND_RIGHT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_DCLICK, winid, wxCommandEventHandler(func))
2821 #define EVT_COMMAND_SET_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SET_FOCUS, winid, wxCommandEventHandler(func))
2822 #define EVT_COMMAND_KILL_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_KILL_FOCUS, winid, wxCommandEventHandler(func))
2823 #define EVT_COMMAND_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_ENTER, winid, wxCommandEventHandler(func))
2824
2825 // Joystick events
2826
2827 #define EVT_JOY_BUTTON_DOWN(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_DOWN, wxJoystickEventHandler(func))
2828 #define EVT_JOY_BUTTON_UP(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_UP, wxJoystickEventHandler(func))
2829 #define EVT_JOY_MOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_MOVE, wxJoystickEventHandler(func))
2830 #define EVT_JOY_ZMOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_ZMOVE, wxJoystickEventHandler(func))
2831
2832 // These are obsolete, see _BUTTON_ events
2833 #if WXWIN_COMPATIBILITY_2_4
2834     #define EVT_JOY_DOWN(func) EVT_JOY_BUTTON_DOWN(func)
2835     #define EVT_JOY_UP(func) EVT_JOY_BUTTON_UP(func)
2836 #endif // WXWIN_COMPATIBILITY_2_4
2837
2838 // All joystick events
2839 #define EVT_JOYSTICK_EVENTS(func) \
2840     EVT_JOY_BUTTON_DOWN(func) \
2841     EVT_JOY_BUTTON_UP(func) \
2842     EVT_JOY_MOVE(func) \
2843     EVT_JOY_ZMOVE(func)
2844
2845 // Idle event
2846 #define EVT_IDLE(func) wx__DECLARE_EVT0(wxEVT_IDLE, wxIdleEventHandler(func))
2847
2848 // Update UI event
2849 #define EVT_UPDATE_UI(winid, func) wx__DECLARE_EVT1(wxEVT_UPDATE_UI, winid, wxUpdateUIEventHandler(func))
2850 #define EVT_UPDATE_UI_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_UPDATE_UI, id1, id2, wxUpdateUIEventHandler(func))
2851
2852 // Help events
2853 #define EVT_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_HELP, winid, wxHelpEventHandler(func))
2854 #define EVT_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_HELP, id1, id2, wxHelpEventHandler(func))
2855 #define EVT_DETAILED_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_DETAILED_HELP, winid, wxHelpEventHandler(func))
2856 #define EVT_DETAILED_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_DETAILED_HELP, id1, id2, wxHelpEventHandler(func))
2857
2858 // Context Menu Events
2859 #define EVT_CONTEXT_MENU(func) wx__DECLARE_EVT0(wxEVT_CONTEXT_MENU, wxContextMenuEventHandler(func))
2860 #define EVT_COMMAND_CONTEXT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_CONTEXT_MENU, winid, wxContextMenuEventHandler(func))
2861
2862 // ----------------------------------------------------------------------------
2863 // Global data
2864 // ----------------------------------------------------------------------------
2865
2866 // for pending event processing - notice that there is intentionally no
2867 // WXDLLEXPORT here
2868 extern WXDLLIMPEXP_BASE wxList *wxPendingEvents;
2869 #if wxUSE_THREADS
2870     extern WXDLLIMPEXP_BASE wxCriticalSection *wxPendingEventsLocker;
2871 #endif
2872
2873 // ----------------------------------------------------------------------------
2874 // Helper functions
2875 // ----------------------------------------------------------------------------
2876
2877 #if wxUSE_GUI
2878
2879 // Find a window with the focus, that is also a descendant of the given window.
2880 // This is used to determine the window to initially send commands to.
2881 wxWindow* wxFindFocusDescendant(wxWindow* ancestor);
2882
2883 #endif // wxUSE_GUI
2884
2885 #endif // _WX_EVENT_H__
2886