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     // Returns the configured number of lines (or whatever) to be scrolled per
 859     // wheel action.  Defaults to one.
 860     int GetLinesPerAction() const { return m_linesPerAction; }
 861
 862     // Is the system set to do page scrolling?
 863     bool IsPageScroll() const { return ((unsigned int)m_linesPerAction == UINT_MAX); }
 864
 865     virtual wxEvent *Clone() const { return new wxMouseEvent(*this); }
 866
 867     wxMouseEvent& operator=(const wxMouseEvent& event) { Assign(event); return *this; }
 868
 869 public:
 870     wxCoord m_x, m_y;
 871
 872     bool          m_leftDown;
 873     bool          m_middleDown;
 874     bool          m_rightDown;
 875
 876     bool          m_controlDown;
 877     bool          m_shiftDown;
 878     bool          m_altDown;
 879     bool          m_metaDown;
 880
 881     int           m_wheelRotation;
 882     int           m_wheelDelta;
 883     int           m_linesPerAction;
 884
 885 protected:
 886     void Assign(const wxMouseEvent& evt);
 887
 888 private:
 889     DECLARE_DYNAMIC_CLASS(wxMouseEvent)
 890 };
 891
 892 // Cursor set event
 893
 894 /*
 895    wxEVT_SET_CURSOR
 896  */
 897
 898 class WXDLLIMPEXP_CORE wxSetCursorEvent : public wxEvent
 899 {
 900 public:
 901     wxSetCursorEvent(wxCoord x = 0, wxCoord y = 0)
 902         : wxEvent(0, wxEVT_SET_CURSOR),
 903           m_x(x), m_y(y), m_cursor()
 904         { }
 905
 906     wxSetCursorEvent(const wxSetCursorEvent & event)
 907         : wxEvent(event),
 908           m_x(event.m_x),
 909           m_y(event.m_y),
 910           m_cursor(event.m_cursor)
 911         { }
 912
 913     wxCoord GetX() const { return m_x; }
 914     wxCoord GetY() const { return m_y; }
 915
 916     void SetCursor(const wxCursor& cursor) { m_cursor = cursor; }
 917     const wxCursor& GetCursor() const { return m_cursor; }
 918     bool HasCursor() const { return m_cursor.Ok(); }
 919
 920     virtual wxEvent *Clone() const { return new wxSetCursorEvent(*this); }
 921
 922 private:
 923     wxCoord  m_x, m_y;
 924     wxCursor m_cursor;
 925
 926 private:
 927     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSetCursorEvent)
 928 };
 929
 930 // Keyboard input event class
 931
 932 /*
 933  wxEVT_CHAR
 934  wxEVT_CHAR_HOOK
 935  wxEVT_KEY_DOWN
 936  wxEVT_KEY_UP
 937  wxEVT_HOTKEY
 938  */
 939
 940 class WXDLLIMPEXP_CORE wxKeyEvent : public wxEvent
 941 {
 942 public:
 943     wxKeyEvent(wxEventType keyType = wxEVT_NULL);
 944     wxKeyEvent(const wxKeyEvent& evt);
 945
 946     // can be used check if the key event has exactly the given modifiers:
 947     // "GetModifiers() = wxMOD_CONTROL" is easier to write than "ControlDown()
 948     // && !MetaDown() && !AltDown() && !ShiftDown()"
 949     int GetModifiers() const
 950     {
 951         return (m_controlDown ? wxMOD_CONTROL : 0) |
 952                (m_shiftDown ? wxMOD_SHIFT : 0) |
 953                (m_metaDown ? wxMOD_META : 0) |
 954                (m_altDown ? wxMOD_ALT : 0);
 955     }
 956
 957     // Find state of shift/control keys
 958     bool ControlDown() const { return m_controlDown; }
 959     bool ShiftDown() const { return m_shiftDown; }
 960     bool MetaDown() const { return m_metaDown; }
 961     bool AltDown() const { return m_altDown; }
 962
 963     // "Cmd" is a pseudo key which is Control for PC and Unix platforms but
 964     // Apple ("Command") key under Macs: it makes often sense to use it instead
 965     // of, say, ControlDown() because Cmd key is used for the same thing under
 966     // Mac as Ctrl elsewhere (but Ctrl still exists, just not used for this
 967     // purpose under Mac)
 968     bool CmdDown() const
 969     {
 970 #if defined(__WXMAC__) || defined(__WXCOCOA__)
 971         return MetaDown();
 972 #else
 973         return ControlDown();
 974 #endif
 975     }
 976
 977     // exclude MetaDown() from HasModifiers() because NumLock under X is often
 978     // configured as mod2 modifier, yet the key events even when it is pressed
 979     // should be processed normally, not like Ctrl- or Alt-key
 980     bool HasModifiers() const { return ControlDown() || AltDown(); }
 981
 982     // get the key code: an ASCII7 char or an element of wxKeyCode enum
 983     int GetKeyCode() const { return (int)m_keyCode; }
 984
 985 #if wxUSE_UNICODE
 986     // get the Unicode character corresponding to this key
 987     wxChar GetUnicodeKey() const { return m_uniChar; }
 988 #endif // wxUSE_UNICODE
 989
 990     // get the raw key code (platform-dependent)
 991     wxUint32 GetRawKeyCode() const { return m_rawCode; }
 992
 993     // get the raw key flags (platform-dependent)
 994     wxUint32 GetRawKeyFlags() const { return m_rawFlags; }
 995
 996     // Find the position of the event
 997     void GetPosition(wxCoord *xpos, wxCoord *ypos) const
 998     {
 999         if (xpos) *xpos = m_x;
1000         if (ypos) *ypos = m_y;
1001     }
1002
1003     void GetPosition(long *xpos, long *ypos) const
1004     {
1005         if (xpos) *xpos = (long)m_x;
1006         if (ypos) *ypos = (long)m_y;
1007     }
1008
1009     wxPoint GetPosition() const
1010         { return wxPoint(m_x, m_y); }
1011
1012     // Get X position
1013     wxCoord GetX() const { return m_x; }
1014
1015     // Get Y position
1016     wxCoord GetY() const { return m_y; }
1017
1018 #if WXWIN_COMPATIBILITY_2_6
1019     // deprecated, Use GetKeyCode instead.
1020     wxDEPRECATED( long KeyCode() const );
1021 #endif // WXWIN_COMPATIBILITY_2_6
1022
1023     virtual wxEvent *Clone() const { return new wxKeyEvent(*this); }
1024
1025     // we do need to copy wxKeyEvent sometimes (in wxTreeCtrl code, for
1026     // example)
1027     wxKeyEvent& operator=(const wxKeyEvent& evt)
1028     {
1029         m_x = evt.m_x;
1030         m_y = evt.m_y;
1031
1032         m_keyCode = evt.m_keyCode;
1033
1034         m_controlDown = evt.m_controlDown;
1035         m_shiftDown = evt.m_shiftDown;
1036         m_altDown = evt.m_altDown;
1037         m_metaDown = evt.m_metaDown;
1038         m_scanCode = evt.m_scanCode;
1039         m_rawCode = evt.m_rawCode;
1040         m_rawFlags = evt.m_rawFlags;
1041 #if wxUSE_UNICODE
1042         m_uniChar = evt.m_uniChar;
1043 #endif
1044
1045         return *this;
1046     }
1047
1048 public:
1049     wxCoord       m_x, m_y;
1050
1051     long          m_keyCode;
1052
1053     // TODO: replace those with a single m_modifiers bitmask of wxMOD_XXX?
1054     bool          m_controlDown;
1055     bool          m_shiftDown;
1056     bool          m_altDown;
1057     bool          m_metaDown;
1058
1059     // FIXME: what is this for? relation to m_rawXXX?
1060     bool          m_scanCode;
1061
1062 #if wxUSE_UNICODE
1063     // This contains the full Unicode character
1064     // in a character events in Unicode mode
1065     wxChar        m_uniChar;
1066 #endif
1067
1068     // these fields contain the platform-specific information about
1069     // key that was pressed
1070     wxUint32      m_rawCode;
1071     wxUint32      m_rawFlags;
1072
1073 private:
1074     DECLARE_DYNAMIC_CLASS(wxKeyEvent)
1075 };
1076
1077 // Size event class
1078 /*
1079  wxEVT_SIZE
1080  */
1081
1082 class WXDLLIMPEXP_CORE wxSizeEvent : public wxEvent
1083 {
1084 public:
1085     wxSizeEvent() : wxEvent(0, wxEVT_SIZE)
1086         { }
1087     wxSizeEvent(const wxSize& sz, int winid = 0)
1088         : wxEvent(winid, wxEVT_SIZE),
1089           m_size(sz)
1090         { }
1091     wxSizeEvent(const wxSizeEvent & event)
1092         : wxEvent(event),
1093           m_size(event.m_size), m_rect(event.m_rect)
1094         { }
1095     wxSizeEvent(const wxRect& rect, int id = 0)
1096         : m_size(rect.GetSize()), m_rect(rect)
1097         { m_eventType = wxEVT_SIZING; m_id = id; }
1098
1099     wxSize GetSize() const { return m_size; }
1100     wxRect GetRect() const { return m_rect; }
1101     void SetRect(const wxRect& rect) { m_rect = rect; }
1102
1103     virtual wxEvent *Clone() const { return new wxSizeEvent(*this); }
1104
1105 public:
1106     // For internal usage only. Will be converted to protected members.
1107     wxSize m_size;
1108     wxRect m_rect; // Used for wxEVT_SIZING
1109
1110 private:
1111     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSizeEvent)
1112 };
1113
1114 // Move event class
1115
1116 /*
1117  wxEVT_MOVE
1118  */
1119
1120 class WXDLLIMPEXP_CORE wxMoveEvent : public wxEvent
1121 {
1122 public:
1123     wxMoveEvent()
1124         : wxEvent(0, wxEVT_MOVE)
1125         { }
1126     wxMoveEvent(const wxPoint& pos, int winid = 0)
1127         : wxEvent(winid, wxEVT_MOVE),
1128           m_pos(pos)
1129         { }
1130     wxMoveEvent(const wxMoveEvent& event)
1131         : wxEvent(event),
1132           m_pos(event.m_pos)
1133     { }
1134     wxMoveEvent(const wxRect& rect, int id = 0)
1135         : m_pos(rect.GetPosition()), m_rect(rect)
1136         { m_eventType = wxEVT_MOVING; m_id = id; }
1137
1138     wxPoint GetPosition() const { return m_pos; }
1139     void SetPosition(const wxPoint& pos) { m_pos = pos; }
1140     wxRect GetRect() const { return m_rect; }
1141     void SetRect(const wxRect& rect) { m_rect = rect; }
1142
1143     virtual wxEvent *Clone() const { return new wxMoveEvent(*this); }
1144
1145 #if WXWIN_COMPATIBILITY_2_4
1146 public:
1147 #else
1148 protected:
1149 #endif
1150     wxPoint m_pos;
1151     wxRect m_rect;
1152
1153 private:
1154     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMoveEvent)
1155 };
1156
1157 // Paint event class
1158 /*
1159  wxEVT_PAINT
1160  wxEVT_NC_PAINT
1161  wxEVT_PAINT_ICON
1162  */
1163
1164 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1165     // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined
1166     extern WXDLLIMPEXP_CORE int g_isPainting;
1167 #endif // debug
1168
1169 class WXDLLIMPEXP_CORE wxPaintEvent : public wxEvent
1170 {
1171 public:
1172     wxPaintEvent(int Id = 0)
1173         : wxEvent(Id, wxEVT_PAINT)
1174     {
1175 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1176         // set the internal flag for the duration of processing of WM_PAINT
1177         g_isPainting++;
1178 #endif // debug
1179     }
1180
1181     // default copy ctor and dtor are normally fine, we only need them to keep
1182     // g_isPainting updated in debug build
1183 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1184     wxPaintEvent(const wxPaintEvent& event)
1185             : wxEvent(event)
1186     {
1187         g_isPainting++;
1188     }
1189
1190     virtual ~wxPaintEvent()
1191     {
1192         g_isPainting--;
1193     }
1194 #endif // debug
1195
1196     virtual wxEvent *Clone() const { return new wxPaintEvent(*this); }
1197
1198 private:
1199     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaintEvent)
1200 };
1201
1202 class WXDLLIMPEXP_CORE wxNcPaintEvent : public wxEvent
1203 {
1204 public:
1205     wxNcPaintEvent(int winid = 0)
1206         : wxEvent(winid, wxEVT_NC_PAINT)
1207         { }
1208
1209     virtual wxEvent *Clone() const { return new wxNcPaintEvent(*this); }
1210
1211 private:
1212     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNcPaintEvent)
1213 };
1214
1215 // Erase background event class
1216 /*
1217  wxEVT_ERASE_BACKGROUND
1218  */
1219
1220 class WXDLLIMPEXP_CORE wxEraseEvent : public wxEvent
1221 {
1222 public:
1223     wxEraseEvent(int Id = 0, wxDC *dc = (wxDC *) NULL)
1224         : wxEvent(Id, wxEVT_ERASE_BACKGROUND),
1225           m_dc(dc)
1226         { }
1227
1228     wxEraseEvent(const wxEraseEvent& event)
1229         : wxEvent(event),
1230           m_dc(event.m_dc)
1231         { }
1232
1233     wxDC *GetDC() const { return m_dc; }
1234
1235     virtual wxEvent *Clone() const { return new wxEraseEvent(*this); }
1236
1237 #if WXWIN_COMPATIBILITY_2_4
1238 public:
1239 #else
1240 protected:
1241 #endif
1242     wxDC *m_dc;
1243
1244 private:
1245     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxEraseEvent)
1246 };
1247
1248 // Focus event class
1249 /*
1250  wxEVT_SET_FOCUS
1251  wxEVT_KILL_FOCUS
1252  */
1253
1254 class WXDLLIMPEXP_CORE wxFocusEvent : public wxEvent
1255 {
1256 public:
1257     wxFocusEvent(wxEventType type = wxEVT_NULL, int winid = 0)
1258         : wxEvent(winid, type)
1259         { m_win = NULL; }
1260
1261     wxFocusEvent(const wxFocusEvent& event)
1262         : wxEvent(event)
1263         { m_win = event.m_win; }
1264
1265     // The window associated with this event is the window which had focus
1266     // before for SET event and the window which will have focus for the KILL
1267     // one. NB: it may be NULL in both cases!
1268     wxWindow *GetWindow() const { return m_win; }
1269     void SetWindow(wxWindow *win) { m_win = win; }
1270
1271     virtual wxEvent *Clone() const { return new wxFocusEvent(*this); }
1272
1273 private:
1274     wxWindow *m_win;
1275
1276 private:
1277     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFocusEvent)
1278 };
1279
1280 // wxChildFocusEvent notifies the parent that a child has got the focus: unlike
1281 // wxFocusEvent it is propagated upwards the window chain
1282 class WXDLLIMPEXP_CORE wxChildFocusEvent : public wxCommandEvent
1283 {
1284 public:
1285     wxChildFocusEvent(wxWindow *win = NULL);
1286
1287     wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1288
1289     virtual wxEvent *Clone() const { return new wxChildFocusEvent(*this); }
1290
1291 private:
1292     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxChildFocusEvent)
1293 };
1294
1295 // Activate event class
1296 /*
1297  wxEVT_ACTIVATE
1298  wxEVT_ACTIVATE_APP
1299  wxEVT_HIBERNATE
1300  */
1301
1302 class WXDLLIMPEXP_CORE wxActivateEvent : public wxEvent
1303 {
1304 public:
1305     wxActivateEvent(wxEventType type = wxEVT_NULL, bool active = true, int Id = 0)
1306         : wxEvent(Id, type)
1307         { m_active = active; }
1308     wxActivateEvent(const wxActivateEvent& event)
1309         : wxEvent(event)
1310     { m_active = event.m_active; }
1311
1312     bool GetActive() const { return m_active; }
1313
1314     virtual wxEvent *Clone() const { return new wxActivateEvent(*this); }
1315
1316 private:
1317     bool m_active;
1318
1319 private:
1320     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxActivateEvent)
1321 };
1322
1323 // InitDialog event class
1324 /*
1325  wxEVT_INIT_DIALOG
1326  */
1327
1328 class WXDLLIMPEXP_CORE wxInitDialogEvent : public wxEvent
1329 {
1330 public:
1331     wxInitDialogEvent(int Id = 0)
1332         : wxEvent(Id, wxEVT_INIT_DIALOG)
1333         { }
1334
1335     virtual wxEvent *Clone() const { return new wxInitDialogEvent(*this); }
1336
1337 private:
1338     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxInitDialogEvent)
1339 };
1340
1341 // Miscellaneous menu event class
1342 /*
1343  wxEVT_MENU_OPEN,
1344  wxEVT_MENU_CLOSE,
1345  wxEVT_MENU_HIGHLIGHT,
1346 */
1347
1348 class WXDLLIMPEXP_CORE wxMenuEvent : public wxEvent
1349 {
1350 public:
1351     wxMenuEvent(wxEventType type = wxEVT_NULL, int winid = 0, wxMenu* menu = NULL)
1352         : wxEvent(winid, type)
1353         { m_menuId = winid; m_menu = menu; }
1354     wxMenuEvent(const wxMenuEvent & event)
1355         : wxEvent(event)
1356     { m_menuId = event.m_menuId; m_menu = event.m_menu; }
1357
1358     // only for wxEVT_MENU_HIGHLIGHT
1359     int GetMenuId() const { return m_menuId; }
1360
1361     // only for wxEVT_MENU_OPEN/CLOSE
1362     bool IsPopup() const { return m_menuId == wxID_ANY; }
1363
1364     // only for wxEVT_MENU_OPEN/CLOSE
1365     wxMenu* GetMenu() const { return m_menu; }
1366
1367     virtual wxEvent *Clone() const { return new wxMenuEvent(*this); }
1368
1369 private:
1370     int     m_menuId;
1371     wxMenu* m_menu;
1372
1373     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMenuEvent)
1374 };
1375
1376 // Window close or session close event class
1377 /*
1378  wxEVT_CLOSE_WINDOW,
1379  wxEVT_END_SESSION,
1380  wxEVT_QUERY_END_SESSION
1381  */
1382
1383 class WXDLLIMPEXP_CORE wxCloseEvent : public wxEvent
1384 {
1385 public:
1386     wxCloseEvent(wxEventType type = wxEVT_NULL, int winid = 0)
1387         : wxEvent(winid, type),
1388           m_loggingOff(true),
1389           m_veto(false),      // should be false by default
1390           m_canVeto(true) {}
1391
1392     wxCloseEvent(const wxCloseEvent & event)
1393         : wxEvent(event),
1394         m_loggingOff(event.m_loggingOff),
1395         m_veto(event.m_veto),
1396         m_canVeto(event.m_canVeto) {}
1397
1398     void SetLoggingOff(bool logOff) { m_loggingOff = logOff; }
1399     bool GetLoggingOff() const
1400     {
1401         // m_loggingOff flag is only used by wxEVT_[QUERY_]END_SESSION, it
1402         // doesn't make sense for wxEVT_CLOSE_WINDOW
1403         wxASSERT_MSG( m_eventType != wxEVT_CLOSE_WINDOW,
1404                       _T("this flag is for end session events only") );
1405
1406         return m_loggingOff;
1407     }
1408
1409     void Veto(bool veto = true)
1410     {
1411         // GetVeto() will return false anyhow...
1412         wxCHECK_RET( m_canVeto,
1413                      wxT("call to Veto() ignored (can't veto this event)") );
1414
1415         m_veto = veto;
1416     }
1417     void SetCanVeto(bool canVeto) { m_canVeto = canVeto; }
1418     bool CanVeto() const { return m_canVeto; }
1419     bool GetVeto() const { return m_canVeto && m_veto; }
1420
1421     virtual wxEvent *Clone() const { return new wxCloseEvent(*this); }
1422
1423 protected:
1424     bool m_loggingOff,
1425          m_veto,
1426          m_canVeto;
1427
1428 private:
1429     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCloseEvent)
1430 };
1431
1432 /*
1433  wxEVT_SHOW
1434  */
1435
1436 class WXDLLIMPEXP_CORE wxShowEvent : public wxEvent
1437 {
1438 public:
1439     wxShowEvent(int winid = 0, bool show = false)
1440         : wxEvent(winid, wxEVT_SHOW)
1441         { m_show = show; }
1442     wxShowEvent(const wxShowEvent & event)
1443         : wxEvent(event)
1444     { m_show = event.m_show; }
1445
1446     void SetShow(bool show) { m_show = show; }
1447     bool GetShow() const { return m_show; }
1448
1449     virtual wxEvent *Clone() const { return new wxShowEvent(*this); }
1450
1451 protected:
1452     bool m_show;
1453
1454 private:
1455     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxShowEvent)
1456 };
1457
1458 /*
1459  wxEVT_ICONIZE
1460  */
1461
1462 class WXDLLIMPEXP_CORE wxIconizeEvent : public wxEvent
1463 {
1464 public:
1465     wxIconizeEvent(int winid = 0, bool iconized = true)
1466         : wxEvent(winid, wxEVT_ICONIZE)
1467         { m_iconized = iconized; }
1468     wxIconizeEvent(const wxIconizeEvent & event)
1469         : wxEvent(event)
1470     { m_iconized = event.m_iconized; }
1471
1472     // return true if the frame was iconized, false if restored
1473     bool Iconized() const { return m_iconized; }
1474
1475     virtual wxEvent *Clone() const { return new wxIconizeEvent(*this); }
1476
1477 protected:
1478     bool m_iconized;
1479
1480 private:
1481     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIconizeEvent)
1482 };
1483 /*
1484  wxEVT_MAXIMIZE
1485  */
1486
1487 class WXDLLIMPEXP_CORE wxMaximizeEvent : public wxEvent
1488 {
1489 public:
1490     wxMaximizeEvent(int winid = 0)
1491         : wxEvent(winid, wxEVT_MAXIMIZE)
1492         { }
1493
1494     virtual wxEvent *Clone() const { return new wxMaximizeEvent(*this); }
1495
1496 private:
1497     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMaximizeEvent)
1498 };
1499
1500 // Joystick event class
1501 /*
1502  wxEVT_JOY_BUTTON_DOWN,
1503  wxEVT_JOY_BUTTON_UP,
1504  wxEVT_JOY_MOVE,
1505  wxEVT_JOY_ZMOVE
1506 */
1507
1508 // Which joystick? Same as Windows ids so no conversion necessary.
1509 enum
1510 {
1511     wxJOYSTICK1,
1512     wxJOYSTICK2
1513 };
1514
1515 // Which button is down?
1516 enum
1517 {
1518     wxJOY_BUTTON_ANY = -1,
1519     wxJOY_BUTTON1    = 1,
1520     wxJOY_BUTTON2    = 2,
1521     wxJOY_BUTTON3    = 4,
1522     wxJOY_BUTTON4    = 8
1523 };
1524
1525 class WXDLLIMPEXP_CORE wxJoystickEvent : public wxEvent
1526 {
1527 #if WXWIN_COMPATIBILITY_2_4
1528 public:
1529 #else
1530 protected:
1531 #endif
1532     wxPoint   m_pos;
1533     int       m_zPosition;
1534     int       m_buttonChange;   // Which button changed?
1535     int       m_buttonState;    // Which buttons are down?
1536     int       m_joyStick;       // Which joystick?
1537
1538 public:
1539     wxJoystickEvent(wxEventType type = wxEVT_NULL,
1540                     int state = 0,
1541                     int joystick = wxJOYSTICK1,
1542                     int change = 0)
1543         : wxEvent(0, type),
1544           m_pos(),
1545           m_zPosition(0),
1546           m_buttonChange(change),
1547           m_buttonState(state),
1548           m_joyStick(joystick)
1549     {
1550     }
1551     wxJoystickEvent(const wxJoystickEvent & event)
1552         : wxEvent(event),
1553           m_pos(event.m_pos),
1554           m_zPosition(event.m_zPosition),
1555           m_buttonChange(event.m_buttonChange),
1556           m_buttonState(event.m_buttonState),
1557           m_joyStick(event.m_joyStick)
1558     { }
1559
1560     wxPoint GetPosition() const { return m_pos; }
1561     int GetZPosition() const { return m_zPosition; }
1562     int GetButtonState() const { return m_buttonState; }
1563     int GetButtonChange() const { return m_buttonChange; }
1564     int GetJoystick() const { return m_joyStick; }
1565
1566     void SetJoystick(int stick) { m_joyStick = stick; }
1567     void SetButtonState(int state) { m_buttonState = state; }
1568     void SetButtonChange(int change) { m_buttonChange = change; }
1569     void SetPosition(const wxPoint& pos) { m_pos = pos; }
1570     void SetZPosition(int zPos) { m_zPosition = zPos; }
1571
1572     // Was it a button event? (*doesn't* mean: is any button *down*?)
1573     bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) ||
1574             (GetEventType() == wxEVT_JOY_BUTTON_UP)); }
1575
1576     // Was it a move event?
1577     bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE); }
1578
1579     // Was it a zmove event?
1580     bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE); }
1581
1582     // Was it a down event from button 1, 2, 3, 4 or any?
1583     bool ButtonDown(int but = wxJOY_BUTTON_ANY) const
1584     { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) &&
1585             ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
1586
1587     // Was it a up event from button 1, 2, 3 or any?
1588     bool ButtonUp(int but = wxJOY_BUTTON_ANY) const
1589     { return ((GetEventType() == wxEVT_JOY_BUTTON_UP) &&
1590             ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
1591
1592     // Was the given button 1,2,3,4 or any in Down state?
1593     bool ButtonIsDown(int but =  wxJOY_BUTTON_ANY) const
1594     { return (((but == wxJOY_BUTTON_ANY) && (m_buttonState != 0)) ||
1595             ((m_buttonState & but) == but)); }
1596
1597     virtual wxEvent *Clone() const { return new wxJoystickEvent(*this); }
1598
1599 private:
1600     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxJoystickEvent)
1601 };
1602
1603 // Drop files event class
1604 /*
1605  wxEVT_DROP_FILES
1606  */
1607
1608 class WXDLLIMPEXP_CORE wxDropFilesEvent : public wxEvent
1609 {
1610 public:
1611     int       m_noFiles;
1612     wxPoint   m_pos;
1613     wxString* m_files;
1614
1615     wxDropFilesEvent(wxEventType type = wxEVT_NULL,
1616                      int noFiles = 0,
1617                      wxString *files = (wxString *) NULL)
1618         : wxEvent(0, type),
1619           m_noFiles(noFiles),
1620           m_pos(),
1621           m_files(files)
1622         { }
1623
1624     // we need a copy ctor to avoid deleting m_files pointer twice
1625     wxDropFilesEvent(const wxDropFilesEvent& other)
1626         : wxEvent(other),
1627           m_noFiles(other.m_noFiles),
1628           m_pos(other.m_pos),
1629           m_files(NULL)
1630     {
1631         m_files = new wxString[m_noFiles];
1632         for ( int n = 0; n < m_noFiles; n++ )
1633         {
1634             m_files[n] = other.m_files[n];
1635         }
1636     }
1637
1638     virtual ~wxDropFilesEvent()
1639     {
1640         delete [] m_files;
1641     }
1642
1643     wxPoint GetPosition() const { return m_pos; }
1644     int GetNumberOfFiles() const { return m_noFiles; }
1645     wxString *GetFiles() const { return m_files; }
1646
1647     virtual wxEvent *Clone() const { return new wxDropFilesEvent(*this); }
1648
1649 private:
1650     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDropFilesEvent)
1651 };
1652
1653 // Update UI event
1654 /*
1655  wxEVT_UPDATE_UI
1656  */
1657
1658 // Whether to always send update events to windows, or
1659 // to only send update events to those with the
1660 // wxWS_EX_PROCESS_UI_UPDATES style.
1661
1662 enum wxUpdateUIMode
1663 {
1664         // Send UI update events to all windows
1665     wxUPDATE_UI_PROCESS_ALL,
1666
1667         // Send UI update events to windows that have
1668         // the wxWS_EX_PROCESS_UI_UPDATES flag specified
1669     wxUPDATE_UI_PROCESS_SPECIFIED
1670 };
1671
1672 class WXDLLIMPEXP_CORE wxUpdateUIEvent : public wxCommandEvent
1673 {
1674 public:
1675     wxUpdateUIEvent(wxWindowID commandId = 0)
1676         : wxCommandEvent(wxEVT_UPDATE_UI, commandId)
1677     {
1678         m_checked =
1679         m_enabled =
1680         m_shown =
1681         m_setEnabled =
1682         m_setShown =
1683         m_setText =
1684         m_setChecked = false;
1685     }
1686     wxUpdateUIEvent(const wxUpdateUIEvent & event)
1687         : wxCommandEvent(event),
1688           m_checked(event.m_checked),
1689           m_enabled(event.m_enabled),
1690           m_shown(event.m_shown),
1691           m_setEnabled(event.m_setEnabled),
1692           m_setShown(event.m_setShown),
1693           m_setText(event.m_setText),
1694           m_setChecked(event.m_setChecked),
1695           m_text(event.m_text)
1696     { }
1697
1698     bool GetChecked() const { return m_checked; }
1699     bool GetEnabled() const { return m_enabled; }
1700     bool GetShown() const { return m_shown; }
1701     wxString GetText() const { return m_text; }
1702     bool GetSetText() const { return m_setText; }
1703     bool GetSetChecked() const { return m_setChecked; }
1704     bool GetSetEnabled() const { return m_setEnabled; }
1705     bool GetSetShown() const { return m_setShown; }
1706
1707     void Check(bool check) { m_checked = check; m_setChecked = true; }
1708     void Enable(bool enable) { m_enabled = enable; m_setEnabled = true; }
1709     void Show(bool show) { m_shown = show; m_setShown = true; }
1710     void SetText(const wxString& text) { m_text = text; m_setText = true; }
1711
1712     // Sets the interval between updates in milliseconds.
1713     // Set to -1 to disable updates, or to 0 to update as frequently as possible.
1714     static void SetUpdateInterval(long updateInterval) { sm_updateInterval = updateInterval; }
1715
1716     // Returns the current interval between updates in milliseconds
1717     static long GetUpdateInterval() { return sm_updateInterval; }
1718
1719     // Can we update this window?
1720     static bool CanUpdate(wxWindowBase *win);
1721
1722     // Reset the update time to provide a delay until the next
1723     // time we should update
1724     static void ResetUpdateTime();
1725
1726     // Specify how wxWidgets will send update events: to
1727     // all windows, or only to those which specify that they
1728     // will process the events.
1729     static void SetMode(wxUpdateUIMode mode) { sm_updateMode = mode; }
1730
1731     // Returns the UI update mode
1732     static wxUpdateUIMode GetMode() { return sm_updateMode; }
1733
1734     virtual wxEvent *Clone() const { return new wxUpdateUIEvent(*this); }
1735
1736 protected:
1737     bool          m_checked;
1738     bool          m_enabled;
1739     bool          m_shown;
1740     bool          m_setEnabled;
1741     bool          m_setShown;
1742     bool          m_setText;
1743     bool          m_setChecked;
1744     wxString      m_text;
1745 #if wxUSE_LONGLONG
1746     static wxLongLong       sm_lastUpdate;
1747 #endif
1748     static long             sm_updateInterval;
1749     static wxUpdateUIMode   sm_updateMode;
1750
1751 private:
1752     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxUpdateUIEvent)
1753 };
1754
1755 /*
1756  wxEVT_SYS_COLOUR_CHANGED
1757  */
1758
1759 // TODO: shouldn't all events record the window ID?
1760 class WXDLLIMPEXP_CORE wxSysColourChangedEvent : public wxEvent
1761 {
1762 public:
1763     wxSysColourChangedEvent()
1764         : wxEvent(0, wxEVT_SYS_COLOUR_CHANGED)
1765         { }
1766
1767     virtual wxEvent *Clone() const { return new wxSysColourChangedEvent(*this); }
1768
1769 private:
1770     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSysColourChangedEvent)
1771 };
1772
1773 /*
1774  wxEVT_MOUSE_CAPTURE_CHANGED
1775  The window losing the capture receives this message
1776  (even if it released the capture itself).
1777  */
1778
1779 class WXDLLIMPEXP_CORE wxMouseCaptureChangedEvent : public wxEvent
1780 {
1781 public:
1782     wxMouseCaptureChangedEvent(wxWindowID winid = 0, wxWindow* gainedCapture = NULL)
1783         : wxEvent(winid, wxEVT_MOUSE_CAPTURE_CHANGED),
1784           m_gainedCapture(gainedCapture)
1785         { }
1786
1787     wxMouseCaptureChangedEvent(const wxMouseCaptureChangedEvent& event)
1788         : wxEvent(event),
1789           m_gainedCapture(event.m_gainedCapture)
1790         { }
1791
1792     virtual wxEvent *Clone() const { return new wxMouseCaptureChangedEvent(*this); }
1793
1794     wxWindow* GetCapturedWindow() const { return m_gainedCapture; };
1795
1796 private:
1797     wxWindow* m_gainedCapture;
1798
1799     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureChangedEvent)
1800 };
1801
1802 /*
1803  wxEVT_MOUSE_CAPTURE_LOST
1804  The window losing the capture receives this message, unless it released it
1805  it itself or unless wxWindow::CaptureMouse was called on another window
1806  (and so capture will be restored when the new capturer releases it).
1807  */
1808
1809 class WXDLLIMPEXP_CORE wxMouseCaptureLostEvent : public wxEvent
1810 {
1811 public:
1812     wxMouseCaptureLostEvent(wxWindowID winid = 0)
1813         : wxEvent(winid, wxEVT_MOUSE_CAPTURE_LOST)
1814     {}
1815
1816     wxMouseCaptureLostEvent(const wxMouseCaptureLostEvent& event)
1817         : wxEvent(event)
1818     {}
1819
1820     virtual wxEvent *Clone() const { return new wxMouseCaptureLostEvent(*this); }
1821
1822     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureLostEvent)
1823 };
1824
1825 /*
1826  wxEVT_DISPLAY_CHANGED
1827  */
1828 class WXDLLIMPEXP_CORE wxDisplayChangedEvent : public wxEvent
1829 {
1830 private:
1831     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDisplayChangedEvent)
1832
1833 public:
1834     wxDisplayChangedEvent()
1835         : wxEvent(0, wxEVT_DISPLAY_CHANGED)
1836         { }
1837
1838     virtual wxEvent *Clone() const { return new wxDisplayChangedEvent(*this); }
1839 };
1840
1841 /*
1842  wxEVT_PALETTE_CHANGED
1843  */
1844
1845 class WXDLLIMPEXP_CORE wxPaletteChangedEvent : public wxEvent
1846 {
1847 public:
1848     wxPaletteChangedEvent(wxWindowID winid = 0)
1849         : wxEvent(winid, wxEVT_PALETTE_CHANGED),
1850           m_changedWindow((wxWindow *) NULL)
1851         { }
1852
1853     wxPaletteChangedEvent(const wxPaletteChangedEvent& event)
1854         : wxEvent(event),
1855           m_changedWindow(event.m_changedWindow)
1856         { }
1857
1858     void SetChangedWindow(wxWindow* win) { m_changedWindow = win; }
1859     wxWindow* GetChangedWindow() const { return m_changedWindow; }
1860
1861     virtual wxEvent *Clone() const { return new wxPaletteChangedEvent(*this); }
1862
1863 protected:
1864     wxWindow*     m_changedWindow;
1865
1866 private:
1867     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaletteChangedEvent)
1868 };
1869
1870 /*
1871  wxEVT_QUERY_NEW_PALETTE
1872  Indicates the window is getting keyboard focus and should re-do its palette.
1873  */
1874
1875 class WXDLLIMPEXP_CORE wxQueryNewPaletteEvent : public wxEvent
1876 {
1877 public:
1878     wxQueryNewPaletteEvent(wxWindowID winid = 0)
1879         : wxEvent(winid, wxEVT_QUERY_NEW_PALETTE),
1880           m_paletteRealized(false)
1881         { }
1882     wxQueryNewPaletteEvent(const wxQueryNewPaletteEvent & event)
1883         : wxEvent(event),
1884         m_paletteRealized(event.m_paletteRealized)
1885     { }
1886
1887     // App sets this if it changes the palette.
1888     void SetPaletteRealized(bool realized) { m_paletteRealized = realized; }
1889     bool GetPaletteRealized() const { return m_paletteRealized; }
1890
1891     virtual wxEvent *Clone() const { return new wxQueryNewPaletteEvent(*this); }
1892
1893 protected:
1894     bool m_paletteRealized;
1895
1896 private:
1897     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxQueryNewPaletteEvent)
1898 };
1899
1900 /*
1901  Event generated by dialog navigation keys
1902  wxEVT_NAVIGATION_KEY
1903  */
1904 // NB: don't derive from command event to avoid being propagated to the parent
1905 class WXDLLIMPEXP_CORE wxNavigationKeyEvent : public wxEvent
1906 {
1907 public:
1908     wxNavigationKeyEvent()
1909         : wxEvent(0, wxEVT_NAVIGATION_KEY),
1910           m_flags(IsForward | FromTab),    // defaults are for TAB
1911           m_focus((wxWindow *)NULL)
1912         {
1913             m_propagationLevel = wxEVENT_PROPAGATE_NONE;
1914         }
1915
1916     wxNavigationKeyEvent(const wxNavigationKeyEvent& event)
1917         : wxEvent(event),
1918           m_flags(event.m_flags),
1919           m_focus(event.m_focus)
1920         { }
1921
1922     // direction: forward (true) or backward (false)
1923     bool GetDirection() const
1924         { return (m_flags & IsForward) != 0; }
1925     void SetDirection(bool bForward)
1926         { if ( bForward ) m_flags |= IsForward; else m_flags &= ~IsForward; }
1927
1928     // it may be a window change event (MDI, notebook pages...) or a control
1929     // change event
1930     bool IsWindowChange() const
1931         { return (m_flags & WinChange) != 0; }
1932     void SetWindowChange(bool bIs)
1933         { if ( bIs ) m_flags |= WinChange; else m_flags &= ~WinChange; }
1934
1935     // Set to true under MSW if the event was generated using the tab key.
1936     // This is required for proper navogation over radio buttons
1937     bool IsFromTab() const
1938         { return (m_flags & FromTab) != 0; }
1939     void SetFromTab(bool bIs)
1940         { if ( bIs ) m_flags |= FromTab; else m_flags &= ~FromTab; }
1941
1942     // the child which has the focus currently (may be NULL - use
1943     // wxWindow::FindFocus then)
1944     wxWindow* GetCurrentFocus() const { return m_focus; }
1945     void SetCurrentFocus(wxWindow *win) { m_focus = win; }
1946
1947     // Set flags
1948     void SetFlags(long flags) { m_flags = flags; }
1949
1950     virtual wxEvent *Clone() const { return new wxNavigationKeyEvent(*this); }
1951
1952     enum
1953     {
1954         IsBackward = 0x0000,
1955         IsForward = 0x0001,
1956         WinChange = 0x0002,
1957         FromTab = 0x0004
1958     };
1959
1960     long m_flags;
1961     wxWindow *m_focus;
1962
1963 private:
1964     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNavigationKeyEvent)
1965 };
1966
1967 // Window creation/destruction events: the first is sent as soon as window is
1968 // created (i.e. the underlying GUI object exists), but when the C++ object is
1969 // fully initialized (so virtual functions may be called). The second,
1970 // wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
1971 // still safe to call virtual functions at this moment
1972 /*
1973  wxEVT_CREATE
1974  wxEVT_DESTROY
1975  */
1976
1977 class WXDLLIMPEXP_CORE wxWindowCreateEvent : public wxCommandEvent
1978 {
1979 public:
1980     wxWindowCreateEvent(wxWindow *win = NULL);
1981
1982     wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1983
1984     virtual wxEvent *Clone() const { return new wxWindowCreateEvent(*this); }
1985
1986 private:
1987     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowCreateEvent)
1988 };
1989
1990 class WXDLLIMPEXP_CORE wxWindowDestroyEvent : public wxCommandEvent
1991 {
1992 public:
1993     wxWindowDestroyEvent(wxWindow *win = NULL);
1994
1995     wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1996
1997     virtual wxEvent *Clone() const { return new wxWindowDestroyEvent(*this); }
1998
1999 private:
2000     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowDestroyEvent)
2001 };
2002
2003 // A help event is sent when the user clicks on a window in context-help mode.
2004 /*
2005  wxEVT_HELP
2006  wxEVT_DETAILED_HELP
2007 */
2008
2009 class WXDLLIMPEXP_CORE wxHelpEvent : public wxCommandEvent
2010 {
2011 public:
2012     // how was this help event generated?
2013     enum Origin
2014     {
2015         Origin_Unknown,    // unrecognized event source
2016         Origin_Keyboard,   // event generated from F1 key press
2017         Origin_HelpButton  // event from [?] button on the title bar (Windows)
2018     };
2019
2020     wxHelpEvent(wxEventType type = wxEVT_NULL,
2021                 wxWindowID winid = 0,
2022                 const wxPoint& pt = wxDefaultPosition,
2023                 Origin origin = Origin_Unknown)
2024         : wxCommandEvent(type, winid),
2025           m_pos(pt),
2026           m_origin(GuessOrigin(origin))
2027     { }
2028     wxHelpEvent(const wxHelpEvent & event)
2029         : wxCommandEvent(event),
2030           m_pos(event.m_pos),
2031           m_target(event.m_target),
2032           m_link(event.m_link),
2033           m_origin(event.m_origin)
2034     { }
2035
2036     // Position of event (in screen coordinates)
2037     const wxPoint& GetPosition() const { return m_pos; }
2038     void SetPosition(const wxPoint& pos) { m_pos = pos; }
2039
2040     // Optional link to further help
2041     const wxString& GetLink() const { return m_link; }
2042     void SetLink(const wxString& link) { m_link = link; }
2043
2044     // Optional target to display help in. E.g. a window specification
2045     const wxString& GetTarget() const { return m_target; }
2046     void SetTarget(const wxString& target) { m_target = target; }
2047
2048     virtual wxEvent *Clone() const { return new wxHelpEvent(*this); }
2049
2050     // optional indication of the event source
2051     Origin GetOrigin() const { return m_origin; }
2052     void SetOrigin(Origin origin) { m_origin = origin; }
2053
2054 protected:
2055     wxPoint   m_pos;
2056     wxString  m_target;
2057     wxString  m_link;
2058     Origin    m_origin;
2059
2060     // we can try to guess the event origin ourselves, even if none is
2061     // specified in the ctor
2062     static Origin GuessOrigin(Origin origin);
2063
2064 private:
2065     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHelpEvent)
2066 };
2067
2068 // A Clipboard Text event is sent when a window intercepts text copy/cut/paste
2069 // message, i.e. the user has cut/copied/pasted data from/into a text control
2070 // via ctrl-C/X/V, ctrl/shift-del/insert, a popup menu command, etc.
2071 // NOTE : under windows these events are *NOT* generated automatically
2072 // for a Rich Edit text control.
2073 /*
2074 wxEVT_COMMAND_TEXT_COPY
2075 wxEVT_COMMAND_TEXT_CUT
2076 wxEVT_COMMAND_TEXT_PASTE
2077 */
2078
2079 class WXDLLIMPEXP_CORE wxClipboardTextEvent : public wxCommandEvent
2080 {
2081 public:
2082     wxClipboardTextEvent(wxEventType type = wxEVT_NULL,
2083                      wxWindowID winid = 0)
2084         : wxCommandEvent(type, winid)
2085     { }
2086     wxClipboardTextEvent(const wxClipboardTextEvent & event)
2087         : wxCommandEvent(event)
2088     { }
2089
2090     virtual wxEvent *Clone() const { return new wxClipboardTextEvent(*this); }
2091
2092 private:
2093     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxClipboardTextEvent)
2094 };
2095
2096 // A Context event is sent when the user right clicks on a window or
2097 // presses Shift-F10
2098 // NOTE : Under windows this is a repackaged WM_CONTETXMENU message
2099 //        Under other systems it may have to be generated from a right click event
2100 /*
2101  wxEVT_CONTEXT_MENU
2102 */
2103
2104 class WXDLLIMPEXP_CORE wxContextMenuEvent : public wxCommandEvent
2105 {
2106 public:
2107     wxContextMenuEvent(wxEventType type = wxEVT_NULL,
2108                        wxWindowID winid = 0,
2109                        const wxPoint& pt = wxDefaultPosition)
2110         : wxCommandEvent(type, winid),
2111           m_pos(pt)
2112     { }
2113     wxContextMenuEvent(const wxContextMenuEvent & event)
2114         : wxCommandEvent(event),
2115         m_pos(event.m_pos)
2116     { }
2117
2118     // Position of event (in screen coordinates)
2119     const wxPoint& GetPosition() const { return m_pos; }
2120     void SetPosition(const wxPoint& pos) { m_pos = pos; }
2121
2122     virtual wxEvent *Clone() const { return new wxContextMenuEvent(*this); }
2123
2124 protected:
2125     wxPoint   m_pos;
2126
2127 private:
2128     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxContextMenuEvent)
2129 };
2130
2131 // Idle event
2132 /*
2133  wxEVT_IDLE
2134  */
2135
2136 // Whether to always send idle events to windows, or
2137 // to only send update events to those with the
2138 // wxWS_EX_PROCESS_IDLE style.
2139
2140 enum wxIdleMode
2141 {
2142         // Send idle events to all windows
2143     wxIDLE_PROCESS_ALL,
2144
2145         // Send idle events to windows that have
2146         // the wxWS_EX_PROCESS_IDLE flag specified
2147     wxIDLE_PROCESS_SPECIFIED
2148 };
2149
2150 class WXDLLIMPEXP_CORE wxIdleEvent : public wxEvent
2151 {
2152 public:
2153     wxIdleEvent()
2154         : wxEvent(0, wxEVT_IDLE),
2155           m_requestMore(false)
2156         { }
2157     wxIdleEvent(const wxIdleEvent & event)
2158         : wxEvent(event),
2159           m_requestMore(event.m_requestMore)
2160     { }
2161
2162     void RequestMore(bool needMore = true) { m_requestMore = needMore; }
2163     bool MoreRequested() const { return m_requestMore; }
2164
2165     virtual wxEvent *Clone() const { return new wxIdleEvent(*this); }
2166
2167     // Specify how wxWidgets will send idle events: to
2168     // all windows, or only to those which specify that they
2169     // will process the events.
2170     static void SetMode(wxIdleMode mode) { sm_idleMode = mode; }
2171
2172     // Returns the idle event mode
2173     static wxIdleMode GetMode() { return sm_idleMode; }
2174
2175     // Can we send an idle event?
2176     static bool CanSend(wxWindow* win);
2177
2178 protected:
2179     bool m_requestMore;
2180     static wxIdleMode sm_idleMode;
2181
2182 private:
2183     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIdleEvent)
2184 };
2185
2186 #endif // wxUSE_GUI
2187
2188 /* TODO
2189  wxEVT_MOUSE_CAPTURE_CHANGED,
2190  wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
2191 // wxEVT_FONT_CHANGED,  // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
2192                         // wxEVT_FONT_CHANGED to all other windows (maybe).
2193  wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
2194  wxEVT_MEASURE_ITEM,
2195  wxEVT_COMPARE_ITEM
2196 */
2197
2198
2199 // ============================================================================
2200 // event handler and related classes
2201 // ============================================================================
2202
2203 // for backwards compatibility and to prevent eVC 4 for ARM from crashing with
2204 // internal compiler error when compiling wx, we define wxObjectEventFunction
2205 // as a wxObject method even though it can only be a wxEvtHandler one
2206 typedef void (wxObject::*wxObjectEventFunction)(wxEvent&);
2207
2208 // we can't have ctors nor base struct in backwards compatibility mode or
2209 // otherwise we won't be able to initialize the objects with an agregate, so
2210 // we have to keep both versions
2211 #if WXWIN_COMPATIBILITY_EVENT_TYPES
2212
2213 struct WXDLLIMPEXP_BASE wxEventTableEntry
2214 {
2215     // For some reason, this can't be wxEventType, or VC++ complains.
2216     int m_eventType;            // main event type
2217     int m_id;                   // control/menu/toolbar id
2218     int m_lastId;               // used for ranges of ids
2219     wxObjectEventFunction m_fn; // function to call: not wxEventFunction,
2220                                 // because of dependency problems
2221
2222     wxObject* m_callbackUserData;
2223 };
2224
2225 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
2226
2227 // struct containing the members common to static and dynamic event tables
2228 // entries
2229 struct WXDLLIMPEXP_BASE wxEventTableEntryBase
2230 {
2231 private:
2232     wxEventTableEntryBase& operator=(const wxEventTableEntryBase& event);
2233
2234 public:
2235     wxEventTableEntryBase(int winid, int idLast,
2236                           wxObjectEventFunction fn, wxObject *data)
2237         : m_id(winid),
2238           m_lastId(idLast),
2239           m_fn(fn),
2240           m_callbackUserData(data)
2241     { }
2242
2243     wxEventTableEntryBase(const wxEventTableEntryBase& event)
2244         : m_id(event.m_id),
2245           m_lastId(event.m_lastId),
2246           m_fn(event.m_fn),
2247           m_callbackUserData(event.m_callbackUserData)
2248     { }
2249
2250     // the range of ids for this entry: if m_lastId == wxID_ANY, the range
2251     // consists only of m_id, otherwise it is m_id..m_lastId inclusive
2252     int m_id,
2253         m_lastId;
2254
2255     // function to call: not wxEventFunction, because of dependency problems
2256     wxObjectEventFunction m_fn;
2257
2258     // arbitrary user data asosciated with the callback
2259     wxObject* m_callbackUserData;
2260 };
2261
2262 // an entry from a static event table
2263 struct WXDLLIMPEXP_BASE wxEventTableEntry : public wxEventTableEntryBase
2264 {
2265     wxEventTableEntry(const int& evType, int winid, int idLast,
2266                       wxObjectEventFunction fn, wxObject *data)
2267         : wxEventTableEntryBase(winid, idLast, fn, data),
2268         m_eventType(evType)
2269     { }
2270
2271     // the reference to event type: this allows us to not care about the
2272     // (undefined) order in which the event table entries and the event types
2273     // are initialized: initially the value of this reference might be
2274     // invalid, but by the time it is used for the first time, all global
2275     // objects will have been initialized (including the event type constants)
2276     // and so it will have the correct value when it is needed
2277     const int& m_eventType;
2278
2279 private:
2280     wxEventTableEntry& operator=(const wxEventTableEntry&);
2281 };
2282
2283 // an entry used in dynamic event table managed by wxEvtHandler::Connect()
2284 struct WXDLLIMPEXP_BASE wxDynamicEventTableEntry : public wxEventTableEntryBase
2285 {
2286     wxDynamicEventTableEntry(int evType, int winid, int idLast,
2287                              wxObjectEventFunction fn, wxObject *data, wxEvtHandler* eventSink)
2288         : wxEventTableEntryBase(winid, idLast, fn, data),
2289           m_eventType(evType),
2290           m_eventSink(eventSink)
2291     { }
2292
2293     // not a reference here as we can't keep a reference to a temporary int
2294     // created to wrap the constant value typically passed to Connect() - nor
2295     // do we need it
2296     int m_eventType;
2297
2298     // Pointer to object whose function is fn - so we don't assume the
2299     // EventFunction is always a member of the EventHandler receiving the
2300     // message
2301     wxEvtHandler* m_eventSink;
2302
2303     DECLARE_NO_COPY_CLASS(wxDynamicEventTableEntry)
2304 };
2305
2306 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
2307
2308 // ----------------------------------------------------------------------------
2309 // wxEventTable: an array of event entries terminated with {0, 0, 0, 0, 0}
2310 // ----------------------------------------------------------------------------
2311
2312 struct WXDLLIMPEXP_BASE wxEventTable
2313 {
2314     const wxEventTable *baseTable;    // base event table (next in chain)
2315     const wxEventTableEntry *entries; // bottom of entry array
2316 };
2317
2318 // ----------------------------------------------------------------------------
2319 // wxEventHashTable: a helper of wxEvtHandler to speed up wxEventTable lookups.
2320 // ----------------------------------------------------------------------------
2321
2322 WX_DEFINE_ARRAY_PTR(const wxEventTableEntry*, wxEventTableEntryPointerArray);
2323
2324 class WXDLLIMPEXP_BASE wxEventHashTable
2325 {
2326 private:
2327     // Internal data structs
2328     struct EventTypeTable
2329     {
2330         wxEventType                   eventType;
2331         wxEventTableEntryPointerArray eventEntryTable;
2332     };
2333     typedef EventTypeTable* EventTypeTablePointer;
2334
2335 public:
2336     // Constructor, needs the event table it needs to hash later on.
2337     // Note: hashing of the event table is not done in the constructor as it
2338     //       can be that the event table is not yet full initialize, the hash
2339     //       will gets initialized when handling the first event look-up request.
2340     wxEventHashTable(const wxEventTable &table);
2341     // Destructor.
2342     ~wxEventHashTable();
2343
2344     // Handle the given event, in other words search the event table hash
2345     // and call self->ProcessEvent() if a match was found.
2346     bool HandleEvent(wxEvent &event, wxEvtHandler *self);
2347
2348     // Clear table
2349     void Clear();
2350
2351     // Clear all tables
2352     static void ClearAll();
2353
2354 protected:
2355     // Init the hash table with the entries of the static event table.
2356     void InitHashTable();
2357     // Helper funtion of InitHashTable() to insert 1 entry into the hash table.
2358     void AddEntry(const wxEventTableEntry &entry);
2359     // Allocate and init with null pointers the base hash table.
2360     void AllocEventTypeTable(size_t size);
2361     // Grow the hash table in size and transfer all items currently
2362     // in the table to the correct location in the new table.
2363     void GrowEventTypeTable();
2364
2365 protected:
2366     const wxEventTable    &m_table;
2367     bool                   m_rebuildHash;
2368
2369     size_t                 m_size;
2370     EventTypeTablePointer *m_eventTypeTable;
2371
2372     static wxEventHashTable* sm_first;
2373     wxEventHashTable* m_previous;
2374     wxEventHashTable* m_next;
2375
2376     DECLARE_NO_COPY_CLASS(wxEventHashTable)
2377 };
2378
2379 // ----------------------------------------------------------------------------
2380 // wxEvtHandler: the base class for all objects handling wxWidgets events
2381 // ----------------------------------------------------------------------------
2382
2383 class WXDLLIMPEXP_BASE wxEvtHandler : public wxObject
2384 {
2385 public:
2386     wxEvtHandler();
2387     virtual ~wxEvtHandler();
2388
2389     wxEvtHandler *GetNextHandler() const { return m_nextHandler; }
2390     wxEvtHandler *GetPreviousHandler() const { return m_previousHandler; }
2391     void SetNextHandler(wxEvtHandler *handler) { m_nextHandler = handler; }
2392     void SetPreviousHandler(wxEvtHandler *handler) { m_previousHandler = handler; }
2393
2394     void SetEvtHandlerEnabled(bool enabled) { m_enabled = enabled; }
2395     bool GetEvtHandlerEnabled() const { return m_enabled; }
2396
2397     // process an event right now
2398     virtual bool ProcessEvent(wxEvent& event);
2399
2400     // add an event to be processed later
2401     void AddPendingEvent(wxEvent& event);
2402
2403     void ProcessPendingEvents();
2404
2405 #if wxUSE_THREADS
2406     bool ProcessThreadEvent(wxEvent& event);
2407 #endif
2408
2409     // Dynamic association of a member function handler with the event handler,
2410     // winid and event type
2411     void Connect(int winid,
2412                  int lastId,
2413                  int eventType,
2414                  wxObjectEventFunction func,
2415                  wxObject *userData = (wxObject *) NULL,
2416                  wxEvtHandler *eventSink = (wxEvtHandler *) NULL);
2417
2418     // Convenience function: take just one id
2419     void Connect(int winid,
2420                  int eventType,
2421                  wxObjectEventFunction func,
2422                  wxObject *userData = (wxObject *) NULL,
2423                  wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2424         { Connect(winid, wxID_ANY, eventType, func, userData, eventSink); }
2425
2426     // Even more convenient: without id (same as using id of wxID_ANY)
2427     void Connect(int eventType,
2428                  wxObjectEventFunction func,
2429                  wxObject *userData = (wxObject *) NULL,
2430                  wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2431         { Connect(wxID_ANY, wxID_ANY, eventType, func, userData, eventSink); }
2432
2433     bool Disconnect(int winid,
2434                     int lastId,
2435                     wxEventType eventType,
2436                     wxObjectEventFunction func = NULL,
2437                     wxObject *userData = (wxObject *) NULL,
2438                     wxEvtHandler *eventSink = (wxEvtHandler *) NULL);
2439
2440     bool Disconnect(int winid = wxID_ANY,
2441                     wxEventType eventType = wxEVT_NULL,
2442                     wxObjectEventFunction func = NULL,
2443                     wxObject *userData = (wxObject *) NULL,
2444                     wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2445         { return Disconnect(winid, wxID_ANY, eventType, func, userData, eventSink); }
2446
2447     bool Disconnect(wxEventType eventType,
2448                     wxObjectEventFunction func,
2449                     wxObject *userData = (wxObject *) NULL,
2450                     wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2451         { return Disconnect(wxID_ANY, eventType, func, userData, eventSink); }
2452
2453     wxList* GetDynamicEventTable() const { return m_dynamicEvents ; }
2454
2455     // User data can be associated with each wxEvtHandler
2456     void SetClientObject( wxClientData *data ) { DoSetClientObject(data); }
2457     wxClientData *GetClientObject() const { return DoGetClientObject(); }
2458
2459     void SetClientData( void *data ) { DoSetClientData(data); }
2460     void *GetClientData() const { return DoGetClientData(); }
2461
2462     // check if the given event table entry matches this event and call the
2463     // handler if it does
2464     //
2465     // return true if the event was processed, false otherwise (no match or the
2466     // handler decided to skip the event)
2467     static bool ProcessEventIfMatches(const wxEventTableEntryBase& tableEntry,
2468                                       wxEvtHandler *handler,
2469                                       wxEvent& event);
2470
2471     // implementation from now on
2472     virtual bool SearchEventTable(wxEventTable& table, wxEvent& event);
2473     bool SearchDynamicEventTable( wxEvent& event );
2474
2475 #if wxUSE_THREADS
2476     void ClearEventLocker();
2477 #endif // wxUSE_THREADS
2478
2479     // Avoid problems at exit by cleaning up static hash table gracefully
2480     void ClearEventHashTable() { GetEventHashTable().Clear(); }
2481
2482 private:
2483     static const wxEventTableEntry sm_eventTableEntries[];
2484
2485 protected:
2486     // hooks for wxWindow used by ProcessEvent()
2487     // -----------------------------------------
2488
2489     // This one is called before trying our own event table to allow plugging
2490     // in the validators.
2491     //
2492     // NB: This method is intentionally *not* inside wxUSE_VALIDATORS!
2493     //     It is part of wxBase which doesn't use validators and the code
2494     //     is compiled out when building wxBase w/o GUI classes, which affects
2495     //     binary compatibility and wxBase library can't be used by GUI
2496     //     ports.
2497     virtual bool TryValidator(wxEvent& WXUNUSED(event)) { return false; }
2498
2499     // this one is called after failing to find the event handle in our own
2500     // table to give a chance to the other windows to process it
2501     //
2502     // base class implementation passes the event to wxTheApp
2503     virtual bool TryParent(wxEvent& event);
2504
2505
2506     static const wxEventTable sm_eventTable;
2507     virtual const wxEventTable *GetEventTable() const;
2508
2509     static wxEventHashTable   sm_eventHashTable;
2510     virtual wxEventHashTable& GetEventHashTable() const;
2511
2512     wxEvtHandler*       m_nextHandler;
2513     wxEvtHandler*       m_previousHandler;
2514     wxList*             m_dynamicEvents;
2515     wxList*             m_pendingEvents;
2516
2517 #if wxUSE_THREADS
2518 #if defined (__VISAGECPP__)
2519     const wxCriticalSection& Lock() const { return m_eventsLocker; }
2520     wxCriticalSection& Lock() { return m_eventsLocker; }
2521
2522     wxCriticalSection   m_eventsLocker;
2523 #  else
2524     const wxCriticalSection& Lock() const { return *m_eventsLocker; }
2525     wxCriticalSection& Lock() { return *m_eventsLocker; }
2526
2527     wxCriticalSection*  m_eventsLocker;
2528 #  endif
2529 #endif
2530
2531     // Is event handler enabled?
2532     bool                m_enabled;
2533
2534
2535     // The user data: either an object which will be deleted by the container
2536     // when it's deleted or some raw pointer which we do nothing with - only
2537     // one type of data can be used with the given window (i.e. you cannot set
2538     // the void data and then associate the container with wxClientData or vice
2539     // versa)
2540     union
2541     {
2542         wxClientData *m_clientObject;
2543         void         *m_clientData;
2544     };
2545
2546     // what kind of data do we have?
2547     wxClientDataType m_clientDataType;
2548
2549     // client data accessors
2550     virtual void DoSetClientObject( wxClientData *data );
2551     virtual wxClientData *DoGetClientObject() const;
2552
2553     virtual void DoSetClientData( void *data );
2554     virtual void *DoGetClientData() const;
2555
2556 private:
2557     DECLARE_DYNAMIC_CLASS_NO_COPY(wxEvtHandler)
2558 };
2559
2560 // Post a message to the given eventhandler which will be processed during the
2561 // next event loop iteration
2562 inline void wxPostEvent(wxEvtHandler *dest, wxEvent& event)
2563 {
2564     wxCHECK_RET( dest, wxT("need an object to post event to in wxPostEvent") );
2565
2566     dest->AddPendingEvent(event);
2567 }
2568
2569 typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&);
2570
2571 #define wxEventHandler(func) \
2572     (wxObjectEventFunction)wxStaticCastEvent(wxEventFunction, &func)
2573
2574 #if wxUSE_GUI
2575
2576 // ----------------------------------------------------------------------------
2577 // wxEventBlocker: helper class to temporarily disable event handling for a window
2578 // ----------------------------------------------------------------------------
2579
2580 class WXDLLIMPEXP_BASE wxEventBlocker : public wxEvtHandler
2581 {
2582 public:
2583     wxEventBlocker(wxWindow *win, wxEventType type = wxEVT_ANY);
2584     virtual ~wxEventBlocker();
2585
2586     void Block(wxEventType type)
2587     {
2588         m_eventsToBlock.push_back(type);
2589     }
2590
2591     virtual bool ProcessEvent(wxEvent& event);
2592
2593 protected:
2594     wxArrayInt m_eventsToBlock;
2595     wxWindow *m_window;
2596
2597     DECLARE_NO_COPY_CLASS(wxEventBlocker)
2598 };
2599
2600 typedef void (wxEvtHandler::*wxCommandEventFunction)(wxCommandEvent&);
2601 typedef void (wxEvtHandler::*wxScrollEventFunction)(wxScrollEvent&);
2602 typedef void (wxEvtHandler::*wxScrollWinEventFunction)(wxScrollWinEvent&);
2603 typedef void (wxEvtHandler::*wxSizeEventFunction)(wxSizeEvent&);
2604 typedef void (wxEvtHandler::*wxMoveEventFunction)(wxMoveEvent&);
2605 typedef void (wxEvtHandler::*wxPaintEventFunction)(wxPaintEvent&);
2606 typedef void (wxEvtHandler::*wxNcPaintEventFunction)(wxNcPaintEvent&);
2607 typedef void (wxEvtHandler::*wxEraseEventFunction)(wxEraseEvent&);
2608 typedef void (wxEvtHandler::*wxMouseEventFunction)(wxMouseEvent&);
2609 typedef void (wxEvtHandler::*wxCharEventFunction)(wxKeyEvent&);
2610 typedef void (wxEvtHandler::*wxFocusEventFunction)(wxFocusEvent&);
2611 typedef void (wxEvtHandler::*wxChildFocusEventFunction)(wxChildFocusEvent&);
2612 typedef void (wxEvtHandler::*wxActivateEventFunction)(wxActivateEvent&);
2613 typedef void (wxEvtHandler::*wxMenuEventFunction)(wxMenuEvent&);
2614 typedef void (wxEvtHandler::*wxJoystickEventFunction)(wxJoystickEvent&);
2615 typedef void (wxEvtHandler::*wxDropFilesEventFunction)(wxDropFilesEvent&);
2616 typedef void (wxEvtHandler::*wxInitDialogEventFunction)(wxInitDialogEvent&);
2617 typedef void (wxEvtHandler::*wxSysColourChangedEventFunction)(wxSysColourChangedEvent&);
2618 typedef void (wxEvtHandler::*wxDisplayChangedEventFunction)(wxDisplayChangedEvent&);
2619 typedef void (wxEvtHandler::*wxUpdateUIEventFunction)(wxUpdateUIEvent&);
2620 typedef void (wxEvtHandler::*wxIdleEventFunction)(wxIdleEvent&);
2621 typedef void (wxEvtHandler::*wxCloseEventFunction)(wxCloseEvent&);
2622 typedef void (wxEvtHandler::*wxShowEventFunction)(wxShowEvent&);
2623 typedef void (wxEvtHandler::*wxIconizeEventFunction)(wxIconizeEvent&);
2624 typedef void (wxEvtHandler::*wxMaximizeEventFunction)(wxMaximizeEvent&);
2625 typedef void (wxEvtHandler::*wxNavigationKeyEventFunction)(wxNavigationKeyEvent&);
2626 typedef void (wxEvtHandler::*wxPaletteChangedEventFunction)(wxPaletteChangedEvent&);
2627 typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction)(wxQueryNewPaletteEvent&);
2628 typedef void (wxEvtHandler::*wxWindowCreateEventFunction)(wxWindowCreateEvent&);
2629 typedef void (wxEvtHandler::*wxWindowDestroyEventFunction)(wxWindowDestroyEvent&);
2630 typedef void (wxEvtHandler::*wxSetCursorEventFunction)(wxSetCursorEvent&);
2631 typedef void (wxEvtHandler::*wxNotifyEventFunction)(wxNotifyEvent&);
2632 typedef void (wxEvtHandler::*wxHelpEventFunction)(wxHelpEvent&);
2633 typedef void (wxEvtHandler::*wxContextMenuEventFunction)(wxContextMenuEvent&);
2634 typedef void (wxEvtHandler::*wxMouseCaptureChangedEventFunction)(wxMouseCaptureChangedEvent&);
2635 typedef void (wxEvtHandler::*wxMouseCaptureLostEventFunction)(wxMouseCaptureLostEvent&);
2636 typedef void (wxEvtHandler::*wxClipboardTextEventFunction)(wxClipboardTextEvent&);
2637
2638 // these typedefs don't have the same name structure as the others, keep for
2639 // backwards compatibility only
2640 #if WXWIN_COMPATIBILITY_2_4
2641     typedef wxSysColourChangedEventFunction wxSysColourChangedFunction;
2642     typedef wxDisplayChangedEventFunction wxDisplayChangedFunction;
2643 #endif // WXWIN_COMPATIBILITY_2_4
2644
2645
2646 #define wxCommandEventHandler(func) \
2647     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxCommandEventFunction, &func)
2648 #define wxScrollEventHandler(func) \
2649     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxScrollEventFunction, &func)
2650 #define wxScrollWinEventHandler(func) \
2651     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxScrollWinEventFunction, &func)
2652 #define wxSizeEventHandler(func) \
2653     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxSizeEventFunction, &func)
2654 #define wxMoveEventHandler(func) \
2655     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMoveEventFunction, &func)
2656 #define wxPaintEventHandler(func) \
2657     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxPaintEventFunction, &func)
2658 #define wxNcPaintEventHandler(func) \
2659     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNcPaintEventFunction, &func)
2660 #define wxEraseEventHandler(func) \
2661     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxEraseEventFunction, &func)
2662 #define wxMouseEventHandler(func) \
2663     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMouseEventFunction, &func)
2664 #define wxCharEventHandler(func) \
2665     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxCharEventFunction, &func)
2666 #define wxKeyEventHandler(func) wxCharEventHandler(func)
2667 #define wxFocusEventHandler(func) \
2668     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxFocusEventFunction, &func)
2669 #define wxChildFocusEventHandler(func) \
2670     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxChildFocusEventFunction, &func)
2671 #define wxActivateEventHandler(func) \
2672     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxActivateEventFunction, &func)
2673 #define wxMenuEventHandler(func) \
2674     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMenuEventFunction, &func)
2675 #define wxJoystickEventHandler(func) \
2676     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxJoystickEventFunction, &func)
2677 #define wxDropFilesEventHandler(func) \
2678     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxDropFilesEventFunction, &func)
2679 #define wxInitDialogEventHandler(func) \
2680     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxInitDialogEventFunction, &func)
2681 #define wxSysColourChangedEventHandler(func) \
2682     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxSysColourChangedEventFunction, &func)
2683 #define wxDisplayChangedEventHandler(func) \
2684     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxDisplayChangedEventFunction, &func)
2685 #define wxUpdateUIEventHandler(func) \
2686     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxUpdateUIEventFunction, &func)
2687 #define wxIdleEventHandler(func) \
2688     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxIdleEventFunction, &func)
2689 #define wxCloseEventHandler(func) \
2690     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxCloseEventFunction, &func)
2691 #define wxShowEventHandler(func) \
2692     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxShowEventFunction, &func)
2693 #define wxIconizeEventHandler(func) \
2694     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxIconizeEventFunction, &func)
2695 #define wxMaximizeEventHandler(func) \
2696     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMaximizeEventFunction, &func)
2697 #define wxNavigationKeyEventHandler(func) \
2698     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNavigationKeyEventFunction, &func)
2699 #define wxPaletteChangedEventHandler(func) \
2700     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxPaletteChangedEventFunction, &func)
2701 #define wxQueryNewPaletteEventHandler(func) \
2702     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxQueryNewPaletteEventFunction, &func)
2703 #define wxWindowCreateEventHandler(func) \
2704     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxWindowCreateEventFunction, &func)
2705 #define wxWindowDestroyEventHandler(func) \
2706     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxWindowDestroyEventFunction, &func)
2707 #define wxSetCursorEventHandler(func) \
2708     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxSetCursorEventFunction, &func)
2709 #define wxNotifyEventHandler(func) \
2710     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNotifyEventFunction, &func)
2711 #define wxHelpEventHandler(func) \
2712     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxHelpEventFunction, &func)
2713 #define wxContextMenuEventHandler(func) \
2714     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxContextMenuEventFunction, &func)
2715 #define wxMouseCaptureChangedEventHandler(func) \
2716     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMouseCaptureChangedEventFunction, &func)
2717 #define wxMouseCaptureLostEventHandler(func) \
2718     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMouseCaptureLostEventFunction, &func)
2719 #define wxClipboardTextEventHandler(func) \
2720     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxClipboardTextEventFunction, &func)
2721
2722 #endif // wxUSE_GUI
2723
2724 // N.B. In GNU-WIN32, you *have* to take the address of a member function
2725 // (use &) or the compiler crashes...
2726
2727 #define DECLARE_EVENT_TABLE() \
2728     private: \
2729         static const wxEventTableEntry sm_eventTableEntries[]; \
2730     protected: \
2731         static const wxEventTable        sm_eventTable; \
2732         virtual const wxEventTable*      GetEventTable() const; \
2733         static wxEventHashTable          sm_eventHashTable; \
2734         virtual wxEventHashTable&        GetEventHashTable() const;
2735
2736 // N.B.: when building DLL with Borland C++ 5.5 compiler, you must initialize
2737 //       sm_eventTable before using it in GetEventTable() or the compiler gives
2738 //       E2233 (see http://groups.google.com/groups?selm=397dcc8a%241_2%40dnews)
2739
2740 #define BEGIN_EVENT_TABLE(theClass, baseClass) \
2741     const wxEventTable theClass::sm_eventTable = \
2742         { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] }; \
2743     const wxEventTable *theClass::GetEventTable() const \
2744         { return &theClass::sm_eventTable; } \
2745     wxEventHashTable theClass::sm_eventHashTable(theClass::sm_eventTable); \
2746     wxEventHashTable &theClass::GetEventHashTable() const \
2747         { return theClass::sm_eventHashTable; } \
2748     const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
2749
2750 #define BEGIN_EVENT_TABLE_TEMPLATE1(theClass, baseClass, T1) \
2751     template<typename T1> \
2752     const wxEventTable theClass<T1>::sm_eventTable = \
2753         { &baseClass::sm_eventTable, &theClass<T1>::sm_eventTableEntries[0] }; \
2754     template<typename T1> \
2755     const wxEventTable *theClass<T1>::GetEventTable() const \
2756         { return &theClass<T1>::sm_eventTable; } \
2757     template<typename T1> \
2758     wxEventHashTable theClass<T1>::sm_eventHashTable(theClass<T1>::sm_eventTable); \
2759     template<typename T1> \
2760     wxEventHashTable &theClass<T1>::GetEventHashTable() const \
2761         { return theClass<T1>::sm_eventHashTable; } \
2762     template<typename T1> \
2763     const wxEventTableEntry theClass<T1>::sm_eventTableEntries[] = { \
2764
2765 #define BEGIN_EVENT_TABLE_TEMPLATE2(theClass, baseClass, T1, T2) \
2766     template<typename T1, typename T2> \
2767     const wxEventTable theClass<T1, T2>::sm_eventTable = \
2768         { &baseClass::sm_eventTable, &theClass<T1, T2>::sm_eventTableEntries[0] }; \
2769     template<typename T1, typename T2> \
2770     const wxEventTable *theClass<T1, T2>::GetEventTable() const \
2771         { return &theClass<T1, T2>::sm_eventTable; } \
2772     template<typename T1, typename T2> \
2773     wxEventHashTable theClass<T1, T2>::sm_eventHashTable(theClass<T1, T2>::sm_eventTable); \
2774     template<typename T1, typename T2> \
2775     wxEventHashTable &theClass<T1, T2>::GetEventHashTable() const \
2776         { return theClass<T1, T2>::sm_eventHashTable; } \
2777     template<typename T1, typename T2> \
2778     const wxEventTableEntry theClass<T1, T2>::sm_eventTableEntries[] = { \
2779
2780 #define BEGIN_EVENT_TABLE_TEMPLATE3(theClass, baseClass, T1, T2, T3) \
2781     template<typename T1, typename T2, typename T3> \
2782     const wxEventTable theClass<T1, T2, T3>::sm_eventTable = \
2783         { &baseClass::sm_eventTable, &theClass<T1, T2, T3>::sm_eventTableEntries[0] }; \
2784     template<typename T1, typename T2, typename T3> \
2785     const wxEventTable *theClass<T1, T2, T3>::GetEventTable() const \
2786         { return &theClass<T1, T2, T3>::sm_eventTable; } \
2787     template<typename T1, typename T2, typename T3> \
2788     wxEventHashTable theClass<T1, T2, T3>::sm_eventHashTable(theClass<T1, T2, T3>::sm_eventTable); \
2789     template<typename T1, typename T2, typename T3> \
2790     wxEventHashTable &theClass<T1, T2, T3>::GetEventHashTable() const \
2791         { return theClass<T1, T2, T3>::sm_eventHashTable; } \
2792     template<typename T1, typename T2, typename T3> \
2793     const wxEventTableEntry theClass<T1, T2, T3>::sm_eventTableEntries[] = { \
2794
2795 #define BEGIN_EVENT_TABLE_TEMPLATE4(theClass, baseClass, T1, T2, T3, T4) \
2796     template<typename T1, typename T2, typename T3, typename T4> \
2797     const wxEventTable theClass<T1, T2, T3, T4>::sm_eventTable = \
2798         { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4>::sm_eventTableEntries[0] }; \
2799     template<typename T1, typename T2, typename T3, typename T4> \
2800     const wxEventTable *theClass<T1, T2, T3, T4>::GetEventTable() const \
2801         { return &theClass<T1, T2, T3, T4>::sm_eventTable; } \
2802     template<typename T1, typename T2, typename T3, typename T4> \
2803     wxEventHashTable theClass<T1, T2, T3, T4>::sm_eventHashTable(theClass<T1, T2, T3, T4>::sm_eventTable); \
2804     template<typename T1, typename T2, typename T3, typename T4> \
2805     wxEventHashTable &theClass<T1, T2, T3, T4>::GetEventHashTable() const \
2806         { return theClass<T1, T2, T3, T4>::sm_eventHashTable; } \
2807     template<typename T1, typename T2, typename T3, typename T4> \
2808     const wxEventTableEntry theClass<T1, T2, T3, T4>::sm_eventTableEntries[] = { \
2809
2810 #define BEGIN_EVENT_TABLE_TEMPLATE5(theClass, baseClass, T1, T2, T3, T4, T5) \
2811     template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2812     const wxEventTable theClass<T1, T2, T3, T4, T5>::sm_eventTable = \
2813         { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[0] }; \
2814     template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2815     const wxEventTable *theClass<T1, T2, T3, T4, T5>::GetEventTable() const \
2816         { return &theClass<T1, T2, T3, T4, T5>::sm_eventTable; } \
2817     template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2818     wxEventHashTable theClass<T1, T2, T3, T4, T5>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5>::sm_eventTable); \
2819     template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2820     wxEventHashTable &theClass<T1, T2, T3, T4, T5>::GetEventHashTable() const \
2821         { return theClass<T1, T2, T3, T4, T5>::sm_eventHashTable; } \
2822     template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2823     const wxEventTableEntry theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[] = { \
2824
2825 #define BEGIN_EVENT_TABLE_TEMPLATE7(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7) \
2826     template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2827     const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable = \
2828         { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[0] }; \
2829     template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2830     const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventTable() const \
2831         { return &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable; } \
2832     template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2833     wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable); \
2834     template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2835     wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventHashTable() const \
2836         { return theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable; } \
2837     template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2838     const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[] = { \
2839
2840 #define BEGIN_EVENT_TABLE_TEMPLATE8(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7, T8) \
2841     template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2842     const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable = \
2843         { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[0] }; \
2844     template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2845     const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventTable() const \
2846         { return &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable; } \
2847     template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2848     wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable); \
2849     template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2850     wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventHashTable() const \
2851         { return theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable; } \
2852     template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2853     const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[] = { \
2854
2855 #define END_EVENT_TABLE() DECLARE_EVENT_TABLE_ENTRY( wxEVT_NULL, 0, 0, 0, 0 ) };
2856
2857 /*
2858  * Event table macros
2859  */
2860
2861 // helpers for writing shorter code below: declare an event macro taking 2, 1
2862 // or none ids (the missing ids default to wxID_ANY)
2863 //
2864 // macro arguments:
2865 //  - evt one of wxEVT_XXX constants
2866 //  - id1, id2 ids of the first/last id
2867 //  - fn the function (should be cast to the right type)
2868 #define wx__DECLARE_EVT2(evt, id1, id2, fn) \
2869     DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
2870 #define wx__DECLARE_EVT1(evt, id, fn) \
2871     wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
2872 #define wx__DECLARE_EVT0(evt, fn) \
2873     wx__DECLARE_EVT1(evt, wxID_ANY, fn)
2874
2875
2876 // Generic events
2877 #define EVT_CUSTOM(event, winid, func) \
2878     wx__DECLARE_EVT1(event, winid, wxEventHandler(func))
2879 #define EVT_CUSTOM_RANGE(event, id1, id2, func) \
2880     wx__DECLARE_EVT2(event, id1, id2, wxEventHandler(func))
2881
2882 // EVT_COMMAND
2883 #define EVT_COMMAND(winid, event, func) \
2884     wx__DECLARE_EVT1(event, winid, wxCommandEventHandler(func))
2885 #define EVT_COMMAND_RANGE(id1, id2, event, func) \
2886     wx__DECLARE_EVT2(event, id1, id2, wxCommandEventHandler(func))
2887
2888 #define EVT_NOTIFY(event, winid, func) \
2889     wx__DECLARE_EVT1(event, winid, wxNotifyEventHandler(func))
2890 #define EVT_NOTIFY_RANGE(event, id1, id2, func) \
2891     wx__DECLARE_EVT2(event, id1, id2, wxNotifyEventHandler(func))
2892
2893 // Miscellaneous
2894 #define EVT_SIZE(func)  wx__DECLARE_EVT0(wxEVT_SIZE, wxSizeEventHandler(func))
2895 #define EVT_SIZING(func)  wx__DECLARE_EVT0(wxEVT_SIZING, wxSizeEventHandler(func))
2896 #define EVT_MOVE(func)  wx__DECLARE_EVT0(wxEVT_MOVE, wxMoveEventHandler(func))
2897 #define EVT_MOVING(func)  wx__DECLARE_EVT0(wxEVT_MOVING, wxMoveEventHandler(func))
2898 #define EVT_CLOSE(func)  wx__DECLARE_EVT0(wxEVT_CLOSE_WINDOW, wxCloseEventHandler(func))
2899 #define EVT_END_SESSION(func)  wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
2900 #define EVT_QUERY_END_SESSION(func)  wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
2901 #define EVT_PAINT(func)  wx__DECLARE_EVT0(wxEVT_PAINT, wxPaintEventHandler(func))
2902 #define EVT_NC_PAINT(func)  wx__DECLARE_EVT0(wxEVT_NC_PAINT, wxNcPaintEventHandler(func))
2903 #define EVT_ERASE_BACKGROUND(func)  wx__DECLARE_EVT0(wxEVT_ERASE_BACKGROUND, wxEraseEventHandler(func))
2904 #define EVT_CHAR(func)  wx__DECLARE_EVT0(wxEVT_CHAR, wxCharEventHandler(func))
2905 #define EVT_KEY_DOWN(func)  wx__DECLARE_EVT0(wxEVT_KEY_DOWN, wxKeyEventHandler(func))
2906 #define EVT_KEY_UP(func)  wx__DECLARE_EVT0(wxEVT_KEY_UP, wxKeyEventHandler(func))
2907 #if wxUSE_HOTKEY
2908 #define EVT_HOTKEY(winid, func)  wx__DECLARE_EVT1(wxEVT_HOTKEY, winid, wxCharEventHandler(func))
2909 #endif
2910 #define EVT_CHAR_HOOK(func)  wx__DECLARE_EVT0(wxEVT_CHAR_HOOK, wxCharEventHandler(func))
2911 #define EVT_MENU_OPEN(func)  wx__DECLARE_EVT0(wxEVT_MENU_OPEN, wxMenuEventHandler(func))
2912 #define EVT_MENU_CLOSE(func)  wx__DECLARE_EVT0(wxEVT_MENU_CLOSE, wxMenuEventHandler(func))
2913 #define EVT_MENU_HIGHLIGHT(winid, func)  wx__DECLARE_EVT1(wxEVT_MENU_HIGHLIGHT, winid, wxMenuEventHandler(func))
2914 #define EVT_MENU_HIGHLIGHT_ALL(func)  wx__DECLARE_EVT0(wxEVT_MENU_HIGHLIGHT, wxMenuEventHandler(func))
2915 #define EVT_SET_FOCUS(func)  wx__DECLARE_EVT0(wxEVT_SET_FOCUS, wxFocusEventHandler(func))
2916 #define EVT_KILL_FOCUS(func)  wx__DECLARE_EVT0(wxEVT_KILL_FOCUS, wxFocusEventHandler(func))
2917 #define EVT_CHILD_FOCUS(func)  wx__DECLARE_EVT0(wxEVT_CHILD_FOCUS, wxChildFocusEventHandler(func))
2918 #define EVT_ACTIVATE(func)  wx__DECLARE_EVT0(wxEVT_ACTIVATE, wxActivateEventHandler(func))
2919 #define EVT_ACTIVATE_APP(func)  wx__DECLARE_EVT0(wxEVT_ACTIVATE_APP, wxActivateEventHandler(func))
2920 #define EVT_HIBERNATE(func)  wx__DECLARE_EVT0(wxEVT_HIBERNATE, wxActivateEventHandler(func))
2921 #define EVT_END_SESSION(func)  wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
2922 #define EVT_QUERY_END_SESSION(func)  wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
2923 #define EVT_DROP_FILES(func)  wx__DECLARE_EVT0(wxEVT_DROP_FILES, wxDropFilesEventHandler(func))
2924 #define EVT_INIT_DIALOG(func)  wx__DECLARE_EVT0(wxEVT_INIT_DIALOG, wxInitDialogEventHandler(func))
2925 #define EVT_SYS_COLOUR_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEventHandler(func))
2926 #define EVT_DISPLAY_CHANGED(func)  wx__DECLARE_EVT0(wxEVT_DISPLAY_CHANGED, wxDisplayChangedEventHandler(func))
2927 #define EVT_SHOW(func) wx__DECLARE_EVT0(wxEVT_SHOW, wxShowEventHandler(func))
2928 #define EVT_MAXIMIZE(func) wx__DECLARE_EVT0(wxEVT_MAXIMIZE, wxMaximizeEventHandler(func))
2929 #define EVT_ICONIZE(func) wx__DECLARE_EVT0(wxEVT_ICONIZE, wxIconizeEventHandler(func))
2930 #define EVT_NAVIGATION_KEY(func) wx__DECLARE_EVT0(wxEVT_NAVIGATION_KEY, wxNavigationKeyEventHandler(func))
2931 #define EVT_PALETTE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_PALETTE_CHANGED, wxPaletteChangedEventHandler(func))
2932 #define EVT_QUERY_NEW_PALETTE(func) wx__DECLARE_EVT0(wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEventHandler(func))
2933 #define EVT_WINDOW_CREATE(func) wx__DECLARE_EVT0(wxEVT_CREATE, wxWindowCreateEventHandler(func))
2934 #define EVT_WINDOW_DESTROY(func) wx__DECLARE_EVT0(wxEVT_DESTROY, wxWindowDestroyEventHandler(func))
2935 #define EVT_SET_CURSOR(func) wx__DECLARE_EVT0(wxEVT_SET_CURSOR, wxSetCursorEventHandler(func))
2936 #define EVT_MOUSE_CAPTURE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEventHandler(func))
2937 #define EVT_MOUSE_CAPTURE_LOST(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEventHandler(func))
2938
2939 // Mouse events
2940 #define EVT_LEFT_DOWN(func) wx__DECLARE_EVT0(wxEVT_LEFT_DOWN, wxMouseEventHandler(func))
2941 #define EVT_LEFT_UP(func) wx__DECLARE_EVT0(wxEVT_LEFT_UP, wxMouseEventHandler(func))
2942 #define EVT_MIDDLE_DOWN(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DOWN, wxMouseEventHandler(func))
2943 #define EVT_MIDDLE_UP(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_UP, wxMouseEventHandler(func))
2944 #define EVT_RIGHT_DOWN(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DOWN, wxMouseEventHandler(func))
2945 #define EVT_RIGHT_UP(func) wx__DECLARE_EVT0(wxEVT_RIGHT_UP, wxMouseEventHandler(func))
2946 #define EVT_MOTION(func) wx__DECLARE_EVT0(wxEVT_MOTION, wxMouseEventHandler(func))
2947 #define EVT_LEFT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_LEFT_DCLICK, wxMouseEventHandler(func))
2948 #define EVT_MIDDLE_DCLICK(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DCLICK, wxMouseEventHandler(func))
2949 #define EVT_RIGHT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DCLICK, wxMouseEventHandler(func))
2950 #define EVT_LEAVE_WINDOW(func) wx__DECLARE_EVT0(wxEVT_LEAVE_WINDOW, wxMouseEventHandler(func))
2951 #define EVT_ENTER_WINDOW(func) wx__DECLARE_EVT0(wxEVT_ENTER_WINDOW, wxMouseEventHandler(func))
2952 #define EVT_MOUSEWHEEL(func) wx__DECLARE_EVT0(wxEVT_MOUSEWHEEL, wxMouseEventHandler(func))
2953
2954 // All mouse events
2955 #define EVT_MOUSE_EVENTS(func) \
2956     EVT_LEFT_DOWN(func) \
2957     EVT_LEFT_UP(func) \
2958     EVT_MIDDLE_DOWN(func) \
2959     EVT_MIDDLE_UP(func) \
2960     EVT_RIGHT_DOWN(func) \
2961     EVT_RIGHT_UP(func) \
2962     EVT_MOTION(func) \
2963     EVT_LEFT_DCLICK(func) \
2964     EVT_MIDDLE_DCLICK(func) \
2965     EVT_RIGHT_DCLICK(func) \
2966     EVT_LEAVE_WINDOW(func) \
2967     EVT_ENTER_WINDOW(func) \
2968     EVT_MOUSEWHEEL(func)
2969
2970 // Scrolling from wxWindow (sent to wxScrolledWindow)
2971 #define EVT_SCROLLWIN_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_TOP, wxScrollWinEventHandler(func))
2972 #define EVT_SCROLLWIN_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEventHandler(func))
2973 #define EVT_SCROLLWIN_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEUP, wxScrollWinEventHandler(func))
2974 #define EVT_SCROLLWIN_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEventHandler(func))
2975 #define EVT_SCROLLWIN_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEventHandler(func))
2976 #define EVT_SCROLLWIN_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEventHandler(func))
2977 #define EVT_SCROLLWIN_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEventHandler(func))
2978 #define EVT_SCROLLWIN_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEventHandler(func))
2979
2980 #define EVT_SCROLLWIN(func) \
2981     EVT_SCROLLWIN_TOP(func) \
2982     EVT_SCROLLWIN_BOTTOM(func) \
2983     EVT_SCROLLWIN_LINEUP(func) \
2984     EVT_SCROLLWIN_LINEDOWN(func) \
2985     EVT_SCROLLWIN_PAGEUP(func) \
2986     EVT_SCROLLWIN_PAGEDOWN(func) \
2987     EVT_SCROLLWIN_THUMBTRACK(func) \
2988     EVT_SCROLLWIN_THUMBRELEASE(func)
2989
2990 // Scrolling from wxSlider and wxScrollBar
2991 #define EVT_SCROLL_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_TOP, wxScrollEventHandler(func))
2992 #define EVT_SCROLL_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLL_BOTTOM, wxScrollEventHandler(func))
2993 #define EVT_SCROLL_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEUP, wxScrollEventHandler(func))
2994 #define EVT_SCROLL_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEDOWN, wxScrollEventHandler(func))
2995 #define EVT_SCROLL_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEUP, wxScrollEventHandler(func))
2996 #define EVT_SCROLL_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler(func))
2997 #define EVT_SCROLL_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler(func))
2998 #define EVT_SCROLL_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBRELEASE, wxScrollEventHandler(func))
2999 #define EVT_SCROLL_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SCROLL_CHANGED, wxScrollEventHandler(func))
3000
3001 #define EVT_SCROLL(func) \
3002     EVT_SCROLL_TOP(func) \
3003     EVT_SCROLL_BOTTOM(func) \
3004     EVT_SCROLL_LINEUP(func) \
3005     EVT_SCROLL_LINEDOWN(func) \
3006     EVT_SCROLL_PAGEUP(func) \
3007     EVT_SCROLL_PAGEDOWN(func) \
3008     EVT_SCROLL_THUMBTRACK(func) \
3009     EVT_SCROLL_THUMBRELEASE(func) \
3010     EVT_SCROLL_CHANGED(func)
3011
3012 // Scrolling from wxSlider and wxScrollBar, with an id
3013 #define EVT_COMMAND_SCROLL_TOP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_TOP, winid, wxScrollEventHandler(func))
3014 #define EVT_COMMAND_SCROLL_BOTTOM(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_BOTTOM, winid, wxScrollEventHandler(func))
3015 #define EVT_COMMAND_SCROLL_LINEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEUP, winid, wxScrollEventHandler(func))
3016 #define EVT_COMMAND_SCROLL_LINEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEDOWN, winid, wxScrollEventHandler(func))
3017 #define EVT_COMMAND_SCROLL_PAGEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEUP, winid, wxScrollEventHandler(func))
3018 #define EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEDOWN, winid, wxScrollEventHandler(func))
3019 #define EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBTRACK, winid, wxScrollEventHandler(func))
3020 #define EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBRELEASE, winid, wxScrollEventHandler(func))
3021 #define EVT_COMMAND_SCROLL_CHANGED(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_CHANGED, winid, wxScrollEventHandler(func))
3022
3023 #define EVT_COMMAND_SCROLL(winid, func) \
3024     EVT_COMMAND_SCROLL_TOP(winid, func) \
3025     EVT_COMMAND_SCROLL_BOTTOM(winid, func) \
3026     EVT_COMMAND_SCROLL_LINEUP(winid, func) \
3027     EVT_COMMAND_SCROLL_LINEDOWN(winid, func) \
3028     EVT_COMMAND_SCROLL_PAGEUP(winid, func) \
3029     EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) \
3030     EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) \
3031     EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) \
3032     EVT_COMMAND_SCROLL_CHANGED(winid, func)
3033
3034 #if WXWIN_COMPATIBILITY_2_6
3035     // compatibility macros for the old name, deprecated in 2.8
3036     #define wxEVT_SCROLL_ENDSCROLL wxEVT_SCROLL_CHANGED
3037     #define EVT_COMMAND_SCROLL_ENDSCROLL EVT_COMMAND_SCROLL_CHANGED
3038     #define EVT_SCROLL_ENDSCROLL EVT_SCROLL_CHANGED
3039 #endif // WXWIN_COMPATIBILITY_2_6
3040
3041 // Convenience macros for commonly-used commands
3042 #define EVT_CHECKBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKBOX_CLICKED, winid, wxCommandEventHandler(func))
3043 #define EVT_CHOICE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHOICE_SELECTED, winid, wxCommandEventHandler(func))
3044 #define EVT_LISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_SELECTED, winid, wxCommandEventHandler(func))
3045 #define EVT_LISTBOX_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, winid, wxCommandEventHandler(func))
3046 #define EVT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_MENU_SELECTED, winid, wxCommandEventHandler(func))
3047 #define EVT_MENU_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_MENU_SELECTED, id1, id2, wxCommandEventHandler(func))
3048 #if defined(__SMARTPHONE__)
3049 #  define EVT_BUTTON(winid, func) EVT_MENU(winid, func)
3050 #else
3051 #  define EVT_BUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_BUTTON_CLICKED, winid, wxCommandEventHandler(func))
3052 #endif
3053 #define EVT_SLIDER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SLIDER_UPDATED, winid, wxCommandEventHandler(func))
3054 #define EVT_RADIOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBOX_SELECTED, winid, wxCommandEventHandler(func))
3055 #define EVT_RADIOBUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBUTTON_SELECTED, winid, wxCommandEventHandler(func))
3056 // EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events
3057 #define EVT_SCROLLBAR(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SCROLLBAR_UPDATED, winid, wxCommandEventHandler(func))
3058 #define EVT_VLBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_VLBOX_SELECTED, winid, wxCommandEventHandler(func))
3059 #define EVT_COMBOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_SELECTED, winid, wxCommandEventHandler(func))
3060 #define EVT_TOOL(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_CLICKED, winid, wxCommandEventHandler(func))
3061 #define EVT_TOOL_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_CLICKED, id1, id2, wxCommandEventHandler(func))
3062 #define EVT_TOOL_RCLICKED(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_RCLICKED, winid, wxCommandEventHandler(func))
3063 #define EVT_TOOL_RCLICKED_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, wxCommandEventHandler(func))
3064 #define EVT_TOOL_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_ENTER, winid, wxCommandEventHandler(func))
3065 #define EVT_CHECKLISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, winid, wxCommandEventHandler(func))
3066
3067 // Generic command events
3068 #define EVT_COMMAND_LEFT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_CLICK, winid, wxCommandEventHandler(func))
3069 #define EVT_COMMAND_LEFT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_DCLICK, winid, wxCommandEventHandler(func))
3070 #define EVT_COMMAND_RIGHT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_CLICK, winid, wxCommandEventHandler(func))
3071 #define EVT_COMMAND_RIGHT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_DCLICK, winid, wxCommandEventHandler(func))
3072 #define EVT_COMMAND_SET_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SET_FOCUS, winid, wxCommandEventHandler(func))
3073 #define EVT_COMMAND_KILL_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_KILL_FOCUS, winid, wxCommandEventHandler(func))
3074 #define EVT_COMMAND_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_ENTER, winid, wxCommandEventHandler(func))
3075
3076 // Joystick events
3077
3078 #define EVT_JOY_BUTTON_DOWN(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_DOWN, wxJoystickEventHandler(func))
3079 #define EVT_JOY_BUTTON_UP(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_UP, wxJoystickEventHandler(func))
3080 #define EVT_JOY_MOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_MOVE, wxJoystickEventHandler(func))
3081 #define EVT_JOY_ZMOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_ZMOVE, wxJoystickEventHandler(func))
3082
3083 // These are obsolete, see _BUTTON_ events
3084 #if WXWIN_COMPATIBILITY_2_4
3085     #define EVT_JOY_DOWN(func) EVT_JOY_BUTTON_DOWN(func)
3086     #define EVT_JOY_UP(func) EVT_JOY_BUTTON_UP(func)
3087 #endif // WXWIN_COMPATIBILITY_2_4
3088
3089 // All joystick events
3090 #define EVT_JOYSTICK_EVENTS(func) \
3091     EVT_JOY_BUTTON_DOWN(func) \
3092     EVT_JOY_BUTTON_UP(func) \
3093     EVT_JOY_MOVE(func) \
3094     EVT_JOY_ZMOVE(func)
3095
3096 // Idle event
3097 #define EVT_IDLE(func) wx__DECLARE_EVT0(wxEVT_IDLE, wxIdleEventHandler(func))
3098
3099 // Update UI event
3100 #define EVT_UPDATE_UI(winid, func) wx__DECLARE_EVT1(wxEVT_UPDATE_UI, winid, wxUpdateUIEventHandler(func))
3101 #define EVT_UPDATE_UI_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_UPDATE_UI, id1, id2, wxUpdateUIEventHandler(func))
3102
3103 // Help events
3104 #define EVT_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_HELP, winid, wxHelpEventHandler(func))
3105 #define EVT_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_HELP, id1, id2, wxHelpEventHandler(func))
3106 #define EVT_DETAILED_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_DETAILED_HELP, winid, wxHelpEventHandler(func))
3107 #define EVT_DETAILED_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_DETAILED_HELP, id1, id2, wxHelpEventHandler(func))
3108
3109 // Context Menu Events
3110 #define EVT_CONTEXT_MENU(func) wx__DECLARE_EVT0(wxEVT_CONTEXT_MENU, wxContextMenuEventHandler(func))
3111 #define EVT_COMMAND_CONTEXT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_CONTEXT_MENU, winid, wxContextMenuEventHandler(func))
3112
3113 // Clipboard text Events
3114 #define EVT_TEXT_CUT(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_CUT, winid, wxClipboardTextEventHandler(func))
3115 #define EVT_TEXT_COPY(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_COPY, winid, wxClipboardTextEventHandler(func))
3116 #define EVT_TEXT_PASTE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_PASTE, winid, wxClipboardTextEventHandler(func))
3117
3118 // ----------------------------------------------------------------------------
3119 // Global data
3120 // ----------------------------------------------------------------------------
3121
3122 // for pending event processing - notice that there is intentionally no
3123 // WXDLLEXPORT here
3124 extern WXDLLIMPEXP_BASE wxList *wxPendingEvents;
3125 #if wxUSE_THREADS
3126     extern WXDLLIMPEXP_BASE wxCriticalSection *wxPendingEventsLocker;
3127 #endif
3128
3129 // ----------------------------------------------------------------------------
3130 // Helper functions
3131 // ----------------------------------------------------------------------------
3132
3133 #if wxUSE_GUI
3134
3135 // Find a window with the focus, that is also a descendant of the given window.
3136 // This is used to determine the window to initially send commands to.
3137 WXDLLIMPEXP_CORE wxWindow* wxFindFocusDescendant(wxWindow* ancestor);
3138
3139 #endif // wxUSE_GUI
3140
3141 #endif // _WX_EVENT_H__