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