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