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