include/wx/event.h

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