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