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