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