include/wx/event.h

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