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