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) wxWindows team
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_EVENTH__
  13 #define _WX_EVENTH__
  14
  15 #ifdef __GNUG__
  16     #pragma interface "event.h"
  17 #endif
  18
  19 #include "wx/defs.h"
  20 #include "wx/object.h"
  21
  22 #if wxUSE_GUI
  23     #include "wx/gdicmn.h"
  24     #include "wx/cursor.h"
  25 #endif
  26
  27 #include "wx/thread.h"
  28
  29 // ----------------------------------------------------------------------------
  30 // forward declarations
  31 // ----------------------------------------------------------------------------
  32
  33 class WXDLLEXPORT wxList;
  34
  35 #if wxUSE_GUI
  36     class WXDLLEXPORT wxClientData;
  37     class WXDLLEXPORT wxDC;
  38     class WXDLLEXPORT wxMenu;
  39     class WXDLLEXPORT wxWindow;
  40 #endif // wxUSE_GUI
  41
  42 // ----------------------------------------------------------------------------
  43 // Event types
  44 // ----------------------------------------------------------------------------
  45
  46 typedef int wxEventType;
  47
  48 // in previous versions of wxWindows the event types used to be constants
  49 // which created difficulties with custom/user event types definition
  50 //
  51 // starting from wxWindows 2.4 the event types are now dynamically assigned
  52 // using wxNewEventType() which solves this problem, however at price of
  53 // several incompatibilities:
  54 //
  55 //  a) event table macros declaration changed, it now uses wxEventTableEntry
  56 //     ctor instead of initialisation from an agregate - the macro
  57 //     DECLARE_EVENT_TABLE_ENTRY may be used to write code which can compile
  58 //     with all versions of wxWindows
  59 //
  60 //  b) event types can't be used as switch() cases as they're not really
  61 //     constant any more - there is no magic solution here, you just have to
  62 //     change the switch()es to if()s
  63 //
  64 // if these are real problems for you, define WXWIN_COMPATIBILITY_EVENT_TYPES
  65 // to get 100% old behaviour, however you won't be able to use the libraries
  66 // using the new dynamic event type allocation in such case, so avoid it if
  67 // possible.
  68
  69 #if WXWIN_COMPATIBILITY_EVENT_TYPES
  70
  71 #define DECLARE_EVENT_TABLE_ENTRY(type, id, idLast, fn, obj) \
  72     { type, id, idLast, fn, obj }
  73
  74 #define BEGIN_DECLARE_EVENT_TYPES() enum {
  75 #define END_DECLARE_EVENT_TYPES() };
  76 #define DECLARE_EVENT_TYPE(name, value) name = wxEVT_FIRST + value,
  77 #define DEFINE_EVENT_TYPE(name)
  78
  79 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
  80
  81 #define DECLARE_EVENT_TABLE_ENTRY(type, id, idLast, fn, obj) \
  82     wxEventTableEntry(type, id, idLast, fn, obj)
  83
  84 #define BEGIN_DECLARE_EVENT_TYPES()
  85 #define END_DECLARE_EVENT_TYPES()
  86 #define DECLARE_EVENT_TYPE(name, value) \
  87     extern const wxEventType WXDLLEXPORT name;
  88 #define DEFINE_EVENT_TYPE(name) const wxEventType name = wxNewEventType();
  89
  90 // generate a new unique event type
  91 extern WXDLLEXPORT wxEventType wxNewEventType();
  92
  93 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
  94
  95 BEGIN_DECLARE_EVENT_TYPES()
  96
  97 #if WXWIN_COMPATIBILITY_EVENT_TYPES
  98     wxEVT_NULL = 0,
  99     wxEVT_FIRST = 10000,
 100     wxEVT_USER_FIRST = wxEVT_FIRST + 2000,
 101 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
 102     // it is important to still have these as constants to avoid
 103     // initialization order related problems
 104     const wxEventType wxEVT_NULL = 0;
 105     const wxEventType wxEVT_FIRST = 10000;
 106     const wxEventType wxEVT_USER_FIRST = wxEVT_FIRST + 2000;
 107 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
 108
 109     DECLARE_EVENT_TYPE(wxEVT_COMMAND_BUTTON_CLICKED, 1)
 110     DECLARE_EVENT_TYPE(wxEVT_COMMAND_CHECKBOX_CLICKED, 2)
 111     DECLARE_EVENT_TYPE(wxEVT_COMMAND_CHOICE_SELECTED, 3)
 112     DECLARE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_SELECTED, 4)
 113     DECLARE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 5)
 114     DECLARE_EVENT_TYPE(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 6)
 115     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_UPDATED, 7)
 116     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_ENTER, 8)
 117     DECLARE_EVENT_TYPE(wxEVT_COMMAND_MENU_SELECTED, 9)
 118     DECLARE_EVENT_TYPE(wxEVT_COMMAND_SLIDER_UPDATED, 10)
 119     DECLARE_EVENT_TYPE(wxEVT_COMMAND_RADIOBOX_SELECTED, 11)
 120     DECLARE_EVENT_TYPE(wxEVT_COMMAND_RADIOBUTTON_SELECTED, 12)
 121
 122     // wxEVT_COMMAND_SCROLLBAR_UPDATED is now obsolete since we use
 123     // wxEVT_SCROLL... events
 124
 125     DECLARE_EVENT_TYPE(wxEVT_COMMAND_SCROLLBAR_UPDATED, 13)
 126     DECLARE_EVENT_TYPE(wxEVT_COMMAND_VLBOX_SELECTED, 14)
 127     DECLARE_EVENT_TYPE(wxEVT_COMMAND_COMBOBOX_SELECTED, 15)
 128     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TOOL_RCLICKED, 16)
 129     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TOOL_ENTER, 17)
 130     DECLARE_EVENT_TYPE(wxEVT_COMMAND_SPINCTRL_UPDATED, 18)
 131
 132         // Sockets and timers send events, too
 133     DECLARE_EVENT_TYPE(wxEVT_SOCKET, 50)
 134     DECLARE_EVENT_TYPE(wxEVT_TIMER , 80)
 135
 136         // Mouse event types
 137     DECLARE_EVENT_TYPE(wxEVT_LEFT_DOWN, 100)
 138     DECLARE_EVENT_TYPE(wxEVT_LEFT_UP, 101)
 139     DECLARE_EVENT_TYPE(wxEVT_MIDDLE_DOWN, 102)
 140     DECLARE_EVENT_TYPE(wxEVT_MIDDLE_UP, 103)
 141     DECLARE_EVENT_TYPE(wxEVT_RIGHT_DOWN, 104)
 142     DECLARE_EVENT_TYPE(wxEVT_RIGHT_UP, 105)
 143     DECLARE_EVENT_TYPE(wxEVT_MOTION, 106)
 144     DECLARE_EVENT_TYPE(wxEVT_ENTER_WINDOW, 107)
 145     DECLARE_EVENT_TYPE(wxEVT_LEAVE_WINDOW, 108)
 146     DECLARE_EVENT_TYPE(wxEVT_LEFT_DCLICK, 109)
 147     DECLARE_EVENT_TYPE(wxEVT_MIDDLE_DCLICK, 110)
 148     DECLARE_EVENT_TYPE(wxEVT_RIGHT_DCLICK, 111)
 149     DECLARE_EVENT_TYPE(wxEVT_SET_FOCUS, 112)
 150     DECLARE_EVENT_TYPE(wxEVT_KILL_FOCUS, 113)
 151
 152         // Non-client mouse events
 153     DECLARE_EVENT_TYPE(wxEVT_NC_LEFT_DOWN, 200)
 154     DECLARE_EVENT_TYPE(wxEVT_NC_LEFT_UP, 201)
 155     DECLARE_EVENT_TYPE(wxEVT_NC_MIDDLE_DOWN, 202)
 156     DECLARE_EVENT_TYPE(wxEVT_NC_MIDDLE_UP, 203)
 157     DECLARE_EVENT_TYPE(wxEVT_NC_RIGHT_DOWN, 204)
 158     DECLARE_EVENT_TYPE(wxEVT_NC_RIGHT_UP, 205)
 159     DECLARE_EVENT_TYPE(wxEVT_NC_MOTION, 206)
 160     DECLARE_EVENT_TYPE(wxEVT_NC_ENTER_WINDOW, 207)
 161     DECLARE_EVENT_TYPE(wxEVT_NC_LEAVE_WINDOW, 208)
 162     DECLARE_EVENT_TYPE(wxEVT_NC_LEFT_DCLICK, 209)
 163     DECLARE_EVENT_TYPE(wxEVT_NC_MIDDLE_DCLICK, 210)
 164     DECLARE_EVENT_TYPE(wxEVT_NC_RIGHT_DCLICK, 211)
 165
 166         // Character input event type
 167     DECLARE_EVENT_TYPE(wxEVT_CHAR, 212)
 168     DECLARE_EVENT_TYPE(wxEVT_CHAR_HOOK, 213)
 169     DECLARE_EVENT_TYPE(wxEVT_NAVIGATION_KEY, 214)
 170     DECLARE_EVENT_TYPE(wxEVT_KEY_DOWN, 215)
 171     DECLARE_EVENT_TYPE(wxEVT_KEY_UP, 216)
 172
 173         // Set cursor event
 174     DECLARE_EVENT_TYPE(wxEVT_SET_CURSOR, 230)
 175
 176         // wxScrollbar and wxSlider event identifiers
 177     DECLARE_EVENT_TYPE(wxEVT_SCROLL_TOP, 300)
 178     DECLARE_EVENT_TYPE(wxEVT_SCROLL_BOTTOM, 301)
 179     DECLARE_EVENT_TYPE(wxEVT_SCROLL_LINEUP, 302)
 180     DECLARE_EVENT_TYPE(wxEVT_SCROLL_LINEDOWN, 303)
 181     DECLARE_EVENT_TYPE(wxEVT_SCROLL_PAGEUP, 304)
 182     DECLARE_EVENT_TYPE(wxEVT_SCROLL_PAGEDOWN, 305)
 183     DECLARE_EVENT_TYPE(wxEVT_SCROLL_THUMBTRACK, 306)
 184     DECLARE_EVENT_TYPE(wxEVT_SCROLL_THUMBRELEASE, 307)
 185
 186         // Scroll events from wxWindow
 187     DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_TOP, 320)
 188     DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_BOTTOM, 321)
 189     DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEUP, 322)
 190     DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEDOWN, 323)
 191     DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEUP, 324)
 192     DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEDOWN, 325)
 193     DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBTRACK, 326)
 194     DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBRELEASE, 327)
 195
 196         // System events
 197     DECLARE_EVENT_TYPE(wxEVT_SIZE, 400)
 198     DECLARE_EVENT_TYPE(wxEVT_MOVE, 401)
 199     DECLARE_EVENT_TYPE(wxEVT_CLOSE_WINDOW, 402)
 200     DECLARE_EVENT_TYPE(wxEVT_END_SESSION, 403)
 201     DECLARE_EVENT_TYPE(wxEVT_QUERY_END_SESSION, 404)
 202     DECLARE_EVENT_TYPE(wxEVT_ACTIVATE_APP, 405)
 203     DECLARE_EVENT_TYPE(wxEVT_POWER, 406)
 204     DECLARE_EVENT_TYPE(wxEVT_ACTIVATE, 409)
 205     DECLARE_EVENT_TYPE(wxEVT_CREATE, 410)
 206     DECLARE_EVENT_TYPE(wxEVT_DESTROY, 411)
 207     DECLARE_EVENT_TYPE(wxEVT_SHOW, 412)
 208     DECLARE_EVENT_TYPE(wxEVT_ICONIZE, 413)
 209     DECLARE_EVENT_TYPE(wxEVT_MAXIMIZE, 414)
 210     DECLARE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_CHANGED, 415)
 211     DECLARE_EVENT_TYPE(wxEVT_PAINT, 416)
 212     DECLARE_EVENT_TYPE(wxEVT_ERASE_BACKGROUND, 417)
 213     DECLARE_EVENT_TYPE(wxEVT_NC_PAINT, 418)
 214     DECLARE_EVENT_TYPE(wxEVT_PAINT_ICON, 419)
 215     DECLARE_EVENT_TYPE(wxEVT_MENU_CHAR, 420)
 216     DECLARE_EVENT_TYPE(wxEVT_MENU_INIT, 421)
 217     DECLARE_EVENT_TYPE(wxEVT_MENU_HIGHLIGHT, 422)
 218     DECLARE_EVENT_TYPE(wxEVT_POPUP_MENU_INIT, 423)
 219     DECLARE_EVENT_TYPE(wxEVT_CONTEXT_MENU, 424)
 220     DECLARE_EVENT_TYPE(wxEVT_SYS_COLOUR_CHANGED, 425)
 221     DECLARE_EVENT_TYPE(wxEVT_SETTING_CHANGED, 426)
 222     DECLARE_EVENT_TYPE(wxEVT_QUERY_NEW_PALETTE, 427)
 223     DECLARE_EVENT_TYPE(wxEVT_PALETTE_CHANGED, 428)
 224     DECLARE_EVENT_TYPE(wxEVT_JOY_BUTTON_DOWN, 429)
 225     DECLARE_EVENT_TYPE(wxEVT_JOY_BUTTON_UP, 430)
 226     DECLARE_EVENT_TYPE(wxEVT_JOY_MOVE, 431)
 227     DECLARE_EVENT_TYPE(wxEVT_JOY_ZMOVE, 432)
 228     DECLARE_EVENT_TYPE(wxEVT_DROP_FILES, 433)
 229     DECLARE_EVENT_TYPE(wxEVT_DRAW_ITEM, 434)
 230     DECLARE_EVENT_TYPE(wxEVT_MEASURE_ITEM, 435)
 231     DECLARE_EVENT_TYPE(wxEVT_COMPARE_ITEM, 436)
 232     DECLARE_EVENT_TYPE(wxEVT_INIT_DIALOG, 437)
 233     DECLARE_EVENT_TYPE(wxEVT_IDLE, 438)
 234     DECLARE_EVENT_TYPE(wxEVT_UPDATE_UI, 439)
 235
 236         // Generic command events
 237         // Note: a click is a higher-level event than button down/up
 238     DECLARE_EVENT_TYPE(wxEVT_COMMAND_LEFT_CLICK, 500)
 239     DECLARE_EVENT_TYPE(wxEVT_COMMAND_LEFT_DCLICK, 501)
 240     DECLARE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_CLICK, 502)
 241     DECLARE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_DCLICK, 503)
 242     DECLARE_EVENT_TYPE(wxEVT_COMMAND_SET_FOCUS, 504)
 243     DECLARE_EVENT_TYPE(wxEVT_COMMAND_KILL_FOCUS, 505)
 244     DECLARE_EVENT_TYPE(wxEVT_COMMAND_ENTER, 506)
 245
 246         // Help events
 247     DECLARE_EVENT_TYPE(wxEVT_HELP, 1050)
 248     DECLARE_EVENT_TYPE(wxEVT_DETAILED_HELP, 1051)
 249
 250 END_DECLARE_EVENT_TYPES()
 251
 252 // these 2 events are the same
 253 #define wxEVT_COMMAND_TOOL_CLICKED wxEVT_COMMAND_MENU_SELECTED
 254
 255 // Compatibility
 256
 257 #if WXWIN_COMPATIBILITY
 258
 259 #define wxEVENT_TYPE_BUTTON_COMMAND             wxEVT_COMMAND_BUTTON_CLICKED
 260 #define wxEVENT_TYPE_CHECKBOX_COMMAND           wxEVT_COMMAND_CHECKBOX_CLICKED
 261 #define wxEVENT_TYPE_CHOICE_COMMAND             wxEVT_COMMAND_CHOICE_SELECTED
 262 #define wxEVENT_TYPE_LISTBOX_COMMAND            wxEVT_COMMAND_LISTBOX_SELECTED
 263 #define wxEVENT_TYPE_LISTBOX_DCLICK_COMMAND     wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
 264 #define wxEVENT_TYPE_TEXT_COMMAND               wxEVT_COMMAND_TEXT_UPDATED
 265 #define wxEVENT_TYPE_MULTITEXT_COMMAND          wxEVT_COMMAND_TEXT_UPDATED
 266 #define wxEVENT_TYPE_MENU_COMMAND               wxEVT_COMMAND_MENU_SELECTED
 267 #define wxEVENT_TYPE_SLIDER_COMMAND             wxEVT_COMMAND_SLIDER_UPDATED
 268 #define wxEVENT_TYPE_RADIOBOX_COMMAND           wxEVT_COMMAND_RADIOBOX_SELECTED
 269 #define wxEVENT_TYPE_RADIOBUTTON_COMMAND        wxEVT_COMMAND_RADIOBUTTON_SELECTED
 270 #define wxEVENT_TYPE_TEXT_ENTER_COMMAND         wxEVT_COMMAND_TEXT_ENTER
 271 #define wxEVENT_TYPE_SET_FOCUS                  wxEVT_SET_FOCUS
 272 #define wxEVENT_TYPE_KILL_FOCUS                 wxEVT_KILL_FOCUS
 273 #define wxEVENT_TYPE_SCROLLBAR_COMMAND          wxEVT_COMMAND_SCROLLBAR_UPDATED
 274 #define wxEVENT_TYPE_VIRT_LISTBOX_COMMAND       wxEVT_COMMAND_VLBOX_SELECTED
 275 #define wxEVENT_TYPE_COMBOBOX_COMMAND           wxEVT_COMMAND_COMBOBOX_SELECTED
 276
 277 #define wxEVENT_TYPE_LEFT_DOWN                  wxEVT_LEFT_DOWN
 278 #define wxEVENT_TYPE_LEFT_UP                    wxEVT_LEFT_UP
 279 #define wxEVENT_TYPE_MIDDLE_DOWN                wxEVT_MIDDLE_DOWN
 280 #define wxEVENT_TYPE_MIDDLE_UP                  wxEVT_MIDDLE_UP
 281 #define wxEVENT_TYPE_RIGHT_DOWN                 wxEVT_RIGHT_DOWN
 282 #define wxEVENT_TYPE_RIGHT_UP                   wxEVT_RIGHT_UP
 283 #define wxEVENT_TYPE_MOTION                     wxEVT_MOTION
 284 #define wxEVENT_TYPE_ENTER_WINDOW               wxEVT_ENTER_WINDOW
 285 #define wxEVENT_TYPE_LEAVE_WINDOW               wxEVT_LEAVE_WINDOW
 286 #define wxEVENT_TYPE_LEFT_DCLICK                wxEVT_LEFT_DCLICK
 287 #define wxEVENT_TYPE_MIDDLE_DCLICK              wxEVT_MIDDLE_DCLICK
 288 #define wxEVENT_TYPE_RIGHT_DCLICK               wxEVT_RIGHT_DCLICK
 289 #define wxEVENT_TYPE_CHAR                       wxEVT_CHAR
 290 #define wxEVENT_TYPE_SCROLL_TOP                 wxEVT_SCROLL_TOP
 291 #define wxEVENT_TYPE_SCROLL_BOTTOM              wxEVT_SCROLL_BOTTOM
 292 #define wxEVENT_TYPE_SCROLL_LINEUP              wxEVT_SCROLL_LINEUP
 293 #define wxEVENT_TYPE_SCROLL_LINEDOWN            wxEVT_SCROLL_LINEDOWN
 294 #define wxEVENT_TYPE_SCROLL_PAGEUP              wxEVT_SCROLL_PAGEUP
 295 #define wxEVENT_TYPE_SCROLL_PAGEDOWN            wxEVT_SCROLL_PAGEDOWN
 296 #define wxEVENT_TYPE_SCROLL_THUMBTRACK          wxEVT_SCROLL_THUMBTRACK
 297
 298 #endif // WXWIN_COMPATIBILITY
 299
 300 /*
 301  * wxWindows events, covering all interesting things that might happen
 302  * (button clicking, resizing, setting text in widgets, etc.).
 303  *
 304  * For each completely new event type, derive a new event class.
 305  * An event CLASS represents a C++ class defining a range of similar event TYPES;
 306  * examples are canvas events, panel item command events.
 307  * An event TYPE is a unique identifier for a particular system event,
 308  * such as a button press or a listbox deselection.
 309  *
 310  */
 311
 312 class WXDLLEXPORT wxEvent : public wxObject
 313 {
 314     DECLARE_ABSTRACT_CLASS(wxEvent)
 315
 316 public:
 317     wxEvent(int id = 0);
 318     ~wxEvent() {}
 319
 320     void SetEventType(wxEventType typ) { m_eventType = typ; }
 321     wxEventType GetEventType() const { return m_eventType; }
 322     wxObject *GetEventObject() const { return m_eventObject; }
 323     void SetEventObject(wxObject *obj) { m_eventObject = obj; }
 324     long GetTimestamp() const { return m_timeStamp; }
 325     void SetTimestamp(long ts = 0) { m_timeStamp = ts; }
 326     int GetId() const { return m_id; }
 327     void SetId(int Id) { m_id = Id; }
 328
 329     // Can instruct event processor that we wish to ignore this event
 330     // (treat as if the event table entry had not been found): this must be done
 331     // to allow the event processing by the base classes (calling event.Skip()
 332     // is the analog of calling the base class verstion of a virtual function)
 333     void Skip(bool skip = TRUE) { m_skipped = skip; }
 334     bool GetSkipped() const { return m_skipped; };
 335
 336     // implementation only: this test is explicitlty anti OO and this functions
 337     // exists only for optimization purposes
 338     bool IsCommandEvent() const { return m_isCommandEvent; }
 339
 340     void CopyObject(wxObject& object_dest) const;
 341
 342 public:
 343     wxObject*         m_eventObject;
 344     wxEventType       m_eventType;
 345     long              m_timeStamp;
 346     int               m_id;
 347     wxObject*         m_callbackUserData;
 348     bool              m_skipped;
 349
 350     // optimization: instead of using costly IsKindOf() we keep a flag telling
 351     // whether we're a command event (by far the most common case)
 352     bool              m_isCommandEvent;
 353 };
 354
 355 #if wxUSE_GUI
 356
 357 // Item or menu event class
 358 /*
 359  wxEVT_COMMAND_BUTTON_CLICKED
 360  wxEVT_COMMAND_CHECKBOX_CLICKED
 361  wxEVT_COMMAND_CHOICE_SELECTED
 362  wxEVT_COMMAND_LISTBOX_SELECTED
 363  wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
 364  wxEVT_COMMAND_TEXT_UPDATED
 365  wxEVT_COMMAND_TEXT_ENTER
 366  wxEVT_COMMAND_MENU_SELECTED
 367  wxEVT_COMMAND_SLIDER_UPDATED
 368  wxEVT_COMMAND_RADIOBOX_SELECTED
 369  wxEVT_COMMAND_RADIOBUTTON_SELECTED
 370  wxEVT_COMMAND_SCROLLBAR_UPDATED
 371  wxEVT_COMMAND_VLBOX_SELECTED
 372  wxEVT_COMMAND_COMBOBOX_SELECTED
 373 */
 374
 375 class WXDLLEXPORT wxCommandEvent : public wxEvent
 376 {
 377     DECLARE_DYNAMIC_CLASS(wxCommandEvent)
 378
 379 public:
 380     wxCommandEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
 381     ~wxCommandEvent() {}
 382
 383     /*
 384      * Accessors dependent on context
 385      *
 386      */
 387
 388     // Set/Get client data from controls
 389     void SetClientData(void* clientData) { m_clientData = clientData; }
 390     void *GetClientData() const { return m_clientData; }
 391
 392     // Set/Get client object from controls
 393     void SetClientObject(wxClientData* clientObject) { m_clientObject = clientObject; }
 394     void *GetClientObject() const { return m_clientObject; }
 395
 396     // Get listbox selection if single-choice
 397     int GetSelection() const { return m_commandInt; }
 398
 399     // Set/Get listbox/choice selection string
 400     void SetString(const wxString& s) { m_commandString = s; }
 401     wxString GetString() const { return m_commandString; }
 402
 403     // Get checkbox value
 404     bool IsChecked() const { return m_commandInt != 0; }
 405
 406     // TRUE if the listbox event was a selection.
 407     bool IsSelection() const { return (m_extraLong != 0); }
 408
 409     void SetExtraLong(long extraLong) { m_extraLong = extraLong; }
 410     long GetExtraLong() const { return m_extraLong ; }
 411
 412     void SetInt(int i) { m_commandInt = i; }
 413     long GetInt() const { return m_commandInt ; }
 414
 415     void CopyObject(wxObject& obj) const;
 416
 417 #ifdef WXWIN_COMPATIBILITY_2
 418     bool Checked() const { return IsChecked(); }
 419 #endif // WXWIN_COMPATIBILITY_2
 420
 421 public:
 422     wxString          m_commandString; // String event argument
 423     int               m_commandInt;
 424     long              m_extraLong;     // Additional information (e.g. select/deselect)
 425     void*             m_clientData;    // Arbitrary client data
 426     wxClientData*     m_clientObject;  // Arbitrary client object
 427 };
 428
 429 // this class adds a possibility to react (from the user) code to a control
 430 // notification: allow or veto the operation being reported.
 431 class WXDLLEXPORT wxNotifyEvent  : public wxCommandEvent
 432 {
 433 public:
 434     wxNotifyEvent(wxEventType commandType = wxEVT_NULL, int id = 0)
 435                 : wxCommandEvent(commandType, id) { m_bAllow = TRUE; }
 436
 437     // veto the operation (usually it's allowed by default)
 438     void Veto() { m_bAllow = FALSE; }
 439
 440     // allow the operation if it was disabled by default
 441     void Allow() { m_bAllow = TRUE; }
 442
 443     // for implementation code only: is the operation allowed?
 444     bool IsAllowed() const { return m_bAllow; }
 445
 446     // probably useless: CopyObject() is used for deferred event
 447     // handling but wxNotifyEvent must be processed immediately
 448     void CopyObject(wxObject& obj) const;
 449
 450 private:
 451     bool m_bAllow;
 452
 453     DECLARE_DYNAMIC_CLASS(wxNotifyEvent)
 454 };
 455
 456 // Scroll event class, derived form wxCommandEvent. wxScrollEvents are
 457 // sent by wxSlider and wxScrollbar.
 458 /*
 459  wxEVT_SCROLL_TOP
 460  wxEVT_SCROLL_BOTTOM
 461  wxEVT_SCROLL_LINEUP
 462  wxEVT_SCROLL_LINEDOWN
 463  wxEVT_SCROLL_PAGEUP
 464  wxEVT_SCROLL_PAGEDOWN
 465  wxEVT_SCROLL_THUMBTRACK
 466  wxEVT_SCROLL_THUMBRELEASE
 467 */
 468
 469 class WXDLLEXPORT wxScrollEvent : public wxCommandEvent
 470 {
 471     DECLARE_DYNAMIC_CLASS(wxScrollEvent)
 472
 473 public:
 474     wxScrollEvent(wxEventType commandType = wxEVT_NULL,
 475                   int id = 0, int pos = 0, int orient = 0);
 476     ~wxScrollEvent() {}
 477
 478     /*
 479      * Accessors
 480      *
 481      */
 482
 483     int GetOrientation() const { return (int) m_extraLong ; }
 484     int GetPosition() const { return m_commandInt ; }
 485     void SetOrientation(int orient) { m_extraLong = (long) orient; }
 486     void SetPosition(int pos) { m_commandInt = pos; }
 487 };
 488
 489 // ScrollWin event class, derived fom wxEvent. wxScrollWinEvents
 490 // are sent by wxWindow.
 491 /*
 492  wxEVT_SCROLLWIN_TOP
 493  wxEVT_SCROLLWIN_BOTTOM
 494  wxEVT_SCROLLWIN_LINEUP
 495  wxEVT_SCROLLWIN_LINEDOWN
 496  wxEVT_SCROLLWIN_PAGEUP
 497  wxEVT_SCROLLWIN_PAGEDOWN
 498  wxEVT_SCROLLWIN_THUMBTRACK
 499  wxEVT_SCROLLWIN_THUMBRELEASE
 500 */
 501
 502 class WXDLLEXPORT wxScrollWinEvent : public wxEvent
 503 {
 504     DECLARE_DYNAMIC_CLASS(wxScrollWinEvent)
 505
 506 public:
 507     wxScrollWinEvent(wxEventType commandType = wxEVT_NULL,
 508                      int pos = 0, int orient = 0);
 509     ~wxScrollWinEvent() {}
 510
 511     /*
 512      * Accessors
 513      */
 514
 515     int GetOrientation() const { return (int) m_extraLong ; }
 516     int GetPosition() const { return m_commandInt ; }
 517     void SetOrientation(int orient) { m_extraLong = (long) orient; }
 518     void SetPosition(int pos) { m_commandInt = pos; }
 519
 520     void CopyObject(wxObject& object_dest) const;
 521 public:
 522     int               m_commandInt;    // Additional information
 523     long              m_extraLong;
 524 };
 525
 526 // Mouse event class
 527
 528 /*
 529  wxEVT_LEFT_DOWN
 530  wxEVT_LEFT_UP
 531  wxEVT_MIDDLE_DOWN
 532  wxEVT_MIDDLE_UP
 533  wxEVT_RIGHT_DOWN
 534  wxEVT_RIGHT_UP
 535  wxEVT_MOTION
 536  wxEVT_ENTER_WINDOW
 537  wxEVT_LEAVE_WINDOW
 538  wxEVT_LEFT_DCLICK
 539  wxEVT_MIDDLE_DCLICK
 540  wxEVT_RIGHT_DCLICK
 541  wxEVT_NC_LEFT_DOWN
 542  wxEVT_NC_LEFT_UP,
 543  wxEVT_NC_MIDDLE_DOWN,
 544  wxEVT_NC_MIDDLE_UP,
 545  wxEVT_NC_RIGHT_DOWN,
 546  wxEVT_NC_RIGHT_UP,
 547  wxEVT_NC_MOTION,
 548  wxEVT_NC_ENTER_WINDOW,
 549  wxEVT_NC_LEAVE_WINDOW,
 550  wxEVT_NC_LEFT_DCLICK,
 551  wxEVT_NC_MIDDLE_DCLICK,
 552  wxEVT_NC_RIGHT_DCLICK,
 553 */
 554
 555 class WXDLLEXPORT wxMouseEvent : public wxEvent
 556 {
 557     DECLARE_DYNAMIC_CLASS(wxMouseEvent)
 558
 559 public:
 560     wxMouseEvent(wxEventType mouseType = wxEVT_NULL);
 561
 562     // Was it a button event? (*doesn't* mean: is any button *down*?)
 563     bool IsButton() const { return Button(-1); }
 564
 565     // Was it a down event from button 1, 2 or 3 or any?
 566     bool ButtonDown(int but = -1) const;
 567
 568     // Was it a dclick event from button 1, 2 or 3 or any?
 569     bool ButtonDClick(int but = -1) const;
 570
 571     // Was it a up event from button 1, 2 or 3 or any?
 572     bool ButtonUp(int but = -1) const;
 573
 574     // Was the given button 1,2,3 or any changing state?
 575     bool Button(int but) const;
 576
 577     // Was the given button 1,2,3 or any in Down state?
 578     bool ButtonIsDown(int but) const;
 579
 580     // Find state of shift/control keys
 581     bool ControlDown() const { return m_controlDown; }
 582     bool MetaDown() const { return m_metaDown; }
 583     bool AltDown() const { return m_altDown; }
 584     bool ShiftDown() const { return m_shiftDown; }
 585
 586     // Find which event was just generated
 587     bool LeftDown() const { return (m_eventType == wxEVT_LEFT_DOWN); }
 588     bool MiddleDown() const { return (m_eventType == wxEVT_MIDDLE_DOWN); }
 589     bool RightDown() const { return (m_eventType == wxEVT_RIGHT_DOWN); }
 590
 591     bool LeftUp() const { return (m_eventType == wxEVT_LEFT_UP); }
 592     bool MiddleUp() const { return (m_eventType == wxEVT_MIDDLE_UP); }
 593     bool RightUp() const { return (m_eventType == wxEVT_RIGHT_UP); }
 594
 595     bool LeftDClick() const { return (m_eventType == wxEVT_LEFT_DCLICK); }
 596     bool MiddleDClick() const { return (m_eventType == wxEVT_MIDDLE_DCLICK); }
 597     bool RightDClick() const { return (m_eventType == wxEVT_RIGHT_DCLICK); }
 598
 599     // Find the current state of the mouse buttons (regardless
 600     // of current event type)
 601     bool LeftIsDown() const { return m_leftDown; }
 602     bool MiddleIsDown() const { return m_middleDown; }
 603     bool RightIsDown() const { return m_rightDown; }
 604
 605     // True if a button is down and the mouse is moving
 606     bool Dragging() const
 607     {
 608         return ((m_eventType == wxEVT_MOTION) &&
 609                 (LeftIsDown() || MiddleIsDown() || RightIsDown()));
 610     }
 611
 612     // True if the mouse is moving, and no button is down
 613     bool Moving() const { return (m_eventType == wxEVT_MOTION); }
 614
 615     // True if the mouse is just entering the window
 616     bool Entering() const { return (m_eventType == wxEVT_ENTER_WINDOW); }
 617
 618     // True if the mouse is just leaving the window
 619     bool Leaving() const { return (m_eventType == wxEVT_LEAVE_WINDOW); }
 620
 621     // Find the position of the event
 622     void GetPosition(wxCoord *xpos, wxCoord *ypos) const
 623     {
 624         if (xpos)
 625             *xpos = m_x;
 626         if (ypos)
 627             *ypos = m_y;
 628     }
 629
 630 #ifndef __WIN16__
 631     void GetPosition(long *xpos, long *ypos) const
 632     {
 633         if (xpos)
 634             *xpos = (long)m_x;
 635         if (ypos)
 636             *ypos = (long)m_y;
 637     }
 638 #endif
 639
 640     // Find the position of the event
 641     wxPoint GetPosition() const { return wxPoint(m_x, m_y); }
 642
 643     // Find the logical position of the event given the DC
 644     wxPoint GetLogicalPosition(const wxDC& dc) const ;
 645
 646     // Compatibility
 647 #if WXWIN_COMPATIBILITY
 648     void Position(long *xpos, long *ypos) const
 649     {
 650         if (xpos)
 651             *xpos = (long)m_x;
 652         if (ypos)
 653             *ypos = (long)m_y;
 654     }
 655
 656     void Position(float *xpos, float *ypos) const
 657     {
 658         *xpos = (float) m_x; *ypos = (float) m_y;
 659     }
 660 #endif // WXWIN_COMPATIBILITY
 661
 662     // Get X position
 663     wxCoord GetX() const { return m_x; }
 664
 665     // Get Y position
 666     wxCoord GetY() const { return m_y; }
 667
 668     void CopyObject(wxObject& obj) const;
 669
 670 public:
 671     wxCoord m_x, m_y;
 672
 673     bool          m_leftDown;
 674     bool          m_middleDown;
 675     bool          m_rightDown;
 676
 677     bool          m_controlDown;
 678     bool          m_shiftDown;
 679     bool          m_altDown;
 680     bool          m_metaDown;
 681 };
 682
 683 // Cursor set event
 684
 685 /*
 686    wxEVT_SET_CURSOR
 687  */
 688
 689 class WXDLLEXPORT wxSetCursorEvent : public wxEvent
 690 {
 691 public:
 692     wxSetCursorEvent(wxCoord x, wxCoord y)
 693     {
 694         m_eventType = wxEVT_SET_CURSOR;
 695
 696         m_x = x;
 697         m_y = y;
 698     }
 699
 700     wxCoord GetX() const { return m_x; }
 701     wxCoord GetY() const { return m_y; }
 702
 703     void SetCursor(const wxCursor& cursor) { m_cursor = cursor; }
 704     const wxCursor& GetCursor() const { return m_cursor; }
 705     bool HasCursor() const { return m_cursor.Ok(); }
 706
 707 private:
 708     wxCoord  m_x, m_y;
 709     wxCursor m_cursor;
 710 };
 711
 712 // Keyboard input event class
 713
 714 /*
 715  wxEVT_CHAR
 716  wxEVT_CHAR_HOOK
 717  wxEVT_KEY_DOWN
 718  wxEVT_KEY_UP
 719  */
 720
 721 class WXDLLEXPORT wxKeyEvent : public wxEvent
 722 {
 723     DECLARE_DYNAMIC_CLASS(wxKeyEvent)
 724
 725 public:
 726     wxKeyEvent(wxEventType keyType = wxEVT_NULL);
 727
 728     // Find state of shift/control keys
 729     bool ControlDown() const { return m_controlDown; }
 730     bool MetaDown() const { return m_metaDown; }
 731     bool AltDown() const { return m_altDown; }
 732     bool ShiftDown() const { return m_shiftDown; }
 733
 734     bool HasModifiers() const { return ControlDown() || AltDown() || MetaDown(); }
 735
 736     // get the key code: an ASCII7 char or an element of wxKeyCode enum
 737     int GetKeyCode() const { return (int)m_keyCode; }
 738
 739     // Find the position of the event
 740     void GetPosition(wxCoord *xpos, wxCoord *ypos) const
 741     {
 742         if (xpos) *xpos = m_x;
 743         if (ypos) *ypos = m_y;
 744     }
 745
 746 #ifndef __WIN16__
 747     void GetPosition(long *xpos, long *ypos) const
 748     {
 749         if (xpos) *xpos = (long)m_x;
 750         if (ypos) *ypos = (long)m_y;
 751     }
 752 #endif
 753
 754     wxPoint GetPosition() const
 755         { return wxPoint(m_x, m_y); }
 756
 757     // Get X position
 758     wxCoord GetX() const { return m_x; }
 759
 760     // Get Y position
 761     wxCoord GetY() const { return m_y; }
 762
 763     void CopyObject(wxObject& obj) const;
 764
 765     // deprecated
 766     long KeyCode() const { return m_keyCode; }
 767
 768 public:
 769     wxCoord       m_x, m_y;
 770
 771     long          m_keyCode;
 772
 773     bool          m_controlDown;
 774     bool          m_shiftDown;
 775     bool          m_altDown;
 776     bool          m_metaDown;
 777     bool          m_scanCode;
 778 };
 779
 780 // Size event class
 781 /*
 782  wxEVT_SIZE
 783  */
 784
 785 class WXDLLEXPORT wxSizeEvent : public wxEvent
 786 {
 787     DECLARE_DYNAMIC_CLASS(wxSizeEvent)
 788
 789 public:
 790     wxSize m_size;
 791
 792     wxSizeEvent() { m_eventType = wxEVT_SIZE; }
 793     wxSizeEvent(const wxSize& sz, int id = 0)
 794         : m_size(sz)
 795         { m_eventType = wxEVT_SIZE; m_id = id; }
 796
 797     wxSize GetSize() const { return m_size; }
 798
 799     void CopyObject(wxObject& obj) const;
 800 };
 801
 802 // Move event class
 803
 804 /*
 805  wxEVT_MOVE
 806  */
 807
 808 class WXDLLEXPORT wxMoveEvent : public wxEvent
 809 {
 810     DECLARE_DYNAMIC_CLASS(wxMoveEvent)
 811
 812 public:
 813     wxPoint m_pos;
 814
 815     wxMoveEvent() { m_eventType = wxEVT_MOVE; }
 816     wxMoveEvent(const wxPoint& pos, int id = 0)
 817         : m_pos(pos)
 818         { m_eventType = wxEVT_MOVE; m_id = id; }
 819
 820     wxPoint GetPosition() const { return m_pos; }
 821
 822     void CopyObject(wxObject& obj) const;
 823 };
 824
 825 // Paint event class
 826 /*
 827  wxEVT_PAINT
 828  wxEVT_NC_PAINT
 829  wxEVT_PAINT_ICON
 830  */
 831
 832 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
 833     // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined
 834     extern WXDLLEXPORT int g_isPainting;
 835 #endif // debug
 836
 837 class WXDLLEXPORT wxPaintEvent : public wxEvent
 838 {
 839     DECLARE_DYNAMIC_CLASS(wxPaintEvent)
 840
 841 public:
 842     wxPaintEvent(int Id = 0)
 843     {
 844         m_eventType = wxEVT_PAINT;
 845         m_id = Id;
 846
 847 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
 848         // set the internal flag for the duration of processing of WM_PAINT
 849         g_isPainting++;
 850 #endif // debug
 851     }
 852
 853 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
 854     ~wxPaintEvent()
 855     {
 856         g_isPainting--;
 857     }
 858 #endif // debug
 859 };
 860
 861 // Erase background event class
 862 /*
 863  wxEVT_ERASE_BACKGROUND
 864  */
 865
 866 class WXDLLEXPORT wxEraseEvent : public wxEvent
 867 {
 868     DECLARE_DYNAMIC_CLASS(wxEraseEvent)
 869
 870 public:
 871     wxDC *m_dc;
 872
 873     wxEraseEvent(int Id = 0, wxDC *dc = (wxDC *) NULL)
 874         { m_eventType = wxEVT_ERASE_BACKGROUND; m_id = Id; m_dc = dc; }
 875     wxDC *GetDC() const { return m_dc; }
 876
 877     void CopyObject(wxObject& obj) const;
 878 };
 879
 880 // Focus event class
 881 /*
 882  wxEVT_SET_FOCUS
 883  wxEVT_KILL_FOCUS
 884  */
 885
 886 class WXDLLEXPORT wxFocusEvent : public wxEvent
 887 {
 888     DECLARE_DYNAMIC_CLASS(wxFocusEvent)
 889
 890 public:
 891     wxFocusEvent(wxEventType type = wxEVT_NULL, int Id = 0)
 892         { m_eventType = type; m_id = Id; }
 893 };
 894
 895 // Activate event class
 896 /*
 897  wxEVT_ACTIVATE
 898  wxEVT_ACTIVATE_APP
 899  */
 900
 901 class WXDLLEXPORT wxActivateEvent : public wxEvent
 902 {
 903     DECLARE_DYNAMIC_CLASS(wxActivateEvent)
 904
 905 public:
 906     wxActivateEvent(wxEventType type = wxEVT_NULL, bool active = TRUE, int Id = 0)
 907         { m_eventType = type; m_active = active; m_id = Id; }
 908     bool GetActive() const { return m_active; }
 909
 910     void CopyObject(wxObject& obj) const;
 911
 912 private:
 913     bool m_active;
 914 };
 915
 916 // InitDialog event class
 917 /*
 918  wxEVT_INIT_DIALOG
 919  */
 920
 921 class WXDLLEXPORT wxInitDialogEvent : public wxEvent
 922 {
 923     DECLARE_DYNAMIC_CLASS(wxInitDialogEvent)
 924
 925 public:
 926     wxInitDialogEvent(int Id = 0)
 927         { m_eventType = wxEVT_INIT_DIALOG; m_id = Id; }
 928 };
 929
 930 // Miscellaneous menu event class
 931 /*
 932  wxEVT_MENU_CHAR,
 933  wxEVT_MENU_INIT,
 934  wxEVT_MENU_HIGHLIGHT,
 935  wxEVT_POPUP_MENU_INIT,
 936  wxEVT_CONTEXT_MENU,
 937 */
 938
 939 class WXDLLEXPORT wxMenuEvent : public wxEvent
 940 {
 941     DECLARE_DYNAMIC_CLASS(wxMenuEvent)
 942
 943 public:
 944     wxMenuEvent(wxEventType type = wxEVT_NULL, int id = 0)
 945       { m_eventType = type; m_menuId = id; }
 946
 947     int GetMenuId() const { return m_menuId; }
 948
 949     void CopyObject(wxObject& obj) const;
 950 private:
 951     int m_menuId;
 952 };
 953
 954 // Window close or session close event class
 955 /*
 956  wxEVT_CLOSE_WINDOW,
 957  wxEVT_END_SESSION,
 958  wxEVT_QUERY_END_SESSION
 959  */
 960
 961 class WXDLLEXPORT wxCloseEvent : public wxEvent
 962 {
 963     DECLARE_DYNAMIC_CLASS(wxCloseEvent)
 964
 965 public:
 966     wxCloseEvent(wxEventType type = wxEVT_NULL, int id = 0)
 967     {
 968         m_eventType = type;
 969         m_loggingOff = TRUE;
 970         m_veto = FALSE;         // should be FALSE by default
 971         m_id = id;
 972 #if WXWIN_COMPATIBILITY
 973         m_force = FALSE;
 974 #endif // WXWIN_COMPATIBILITY
 975         m_canVeto = TRUE;
 976     }
 977
 978     void SetLoggingOff(bool logOff) { m_loggingOff = logOff; }
 979     bool GetLoggingOff() const { return m_loggingOff; }
 980
 981     void Veto(bool veto = TRUE)
 982     {
 983         // GetVeto() will return FALSE anyhow...
 984         wxCHECK_RET( m_canVeto,
 985                      wxT("call to Veto() ignored (can't veto this event)") );
 986
 987         m_veto = veto;
 988     }
 989     void SetCanVeto(bool canVeto) { m_canVeto = canVeto; }
 990     // No more asserts here please, the one you put here was wrong.
 991     bool CanVeto() const { return m_canVeto; }
 992     bool GetVeto() const { return m_canVeto && m_veto; }
 993
 994 #if WXWIN_COMPATIBILITY
 995     // This is probably obsolete now, since we use CanVeto instead, in
 996     // both OnCloseWindow and OnQueryEndSession.
 997     // m_force == ! m_canVeto i.e., can't veto means we must force it to close.
 998     void SetForce(bool force) { m_force = force; }
 999     bool GetForce() const { return m_force; }
1000 #endif
1001
1002     void CopyObject(wxObject& obj) const;
1003
1004 protected:
1005     bool m_loggingOff;
1006     bool m_veto, m_canVeto;
1007
1008 #if WXWIN_COMPATIBILITY
1009     bool m_force;
1010 #endif
1011 };
1012
1013 /*
1014  wxEVT_SHOW
1015  */
1016
1017 class WXDLLEXPORT wxShowEvent : public wxEvent
1018 {
1019     DECLARE_DYNAMIC_CLASS(wxShowEvent)
1020
1021 public:
1022
1023     wxShowEvent(int id = 0, bool show = FALSE)
1024         { m_eventType = wxEVT_SHOW; m_id = id; m_show = show; }
1025
1026     void SetShow(bool show) { m_show = show; }
1027     bool GetShow() const { return m_show; }
1028
1029     void CopyObject(wxObject& obj) const;
1030
1031 protected:
1032     bool m_show;
1033 };
1034
1035 /*
1036  wxEVT_ICONIZE
1037  */
1038
1039 class WXDLLEXPORT wxIconizeEvent : public wxEvent
1040 {
1041     DECLARE_DYNAMIC_CLASS(wxIconizeEvent)
1042
1043 public:
1044     wxIconizeEvent(int id = 0)
1045         { m_eventType = wxEVT_ICONIZE; m_id = id; }
1046 };
1047
1048 /*
1049  wxEVT_MAXIMIZE
1050  */
1051
1052 class WXDLLEXPORT wxMaximizeEvent : public wxEvent
1053 {
1054     DECLARE_DYNAMIC_CLASS(wxMaximizeEvent)
1055
1056 public:
1057   wxMaximizeEvent(int id = 0)
1058       { m_eventType = wxEVT_MAXIMIZE; m_id = id; }
1059 };
1060
1061 // Joystick event class
1062 /*
1063  wxEVT_JOY_BUTTON_DOWN,
1064  wxEVT_JOY_BUTTON_UP,
1065  wxEVT_JOY_MOVE,
1066  wxEVT_JOY_ZMOVE
1067 */
1068
1069 // Which joystick? Same as Windows ids so no conversion necessary.
1070 #define wxJOYSTICK1     0
1071 #define wxJOYSTICK2     1
1072
1073 // Which button is down?
1074 #define wxJOY_BUTTON1   1
1075 #define wxJOY_BUTTON2   2
1076 #define wxJOY_BUTTON3   4
1077 #define wxJOY_BUTTON4   8
1078 #define wxJOY_BUTTON_ANY -1
1079
1080 class WXDLLEXPORT wxJoystickEvent : public wxEvent
1081 {
1082     DECLARE_DYNAMIC_CLASS(wxJoystickEvent)
1083
1084 public:
1085     wxPoint   m_pos;
1086     int       m_zPosition;
1087     int       m_buttonChange; // Which button changed?
1088     int       m_buttonState; // Which buttons are down?
1089     int       m_joyStick; // Which joystick?
1090
1091     wxJoystickEvent(wxEventType type = wxEVT_NULL,
1092                     int state = 0,
1093                     int joystick = wxJOYSTICK1,
1094                     int change = 0)
1095     {
1096         m_eventType = type;
1097         m_buttonState = state;
1098         m_pos = wxPoint(0,0);
1099         m_zPosition = 0;
1100         m_joyStick = joystick;
1101         m_buttonChange = change;
1102     }
1103
1104     wxPoint GetPosition() const { return m_pos; }
1105     int GetZPosition() const { return m_zPosition; }
1106     int GetButtonState() const { return m_buttonState; }
1107     int GetButtonChange() const { return m_buttonChange; }
1108     int GetJoystick() const { return m_joyStick; }
1109
1110     void SetJoystick(int stick) { m_joyStick = stick; }
1111     void SetButtonState(int state) { m_buttonState = state; }
1112     void SetButtonChange(int change) { m_buttonChange = change; }
1113     void SetPosition(const wxPoint& pos) { m_pos = pos; }
1114     void SetZPosition(int zPos) { m_zPosition = zPos; }
1115
1116     // Was it a button event? (*doesn't* mean: is any button *down*?)
1117     bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) ||
1118             (GetEventType() == wxEVT_JOY_BUTTON_UP)); }
1119
1120     // Was it a move event?
1121     bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE) ; }
1122
1123     // Was it a zmove event?
1124     bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE) ; }
1125
1126     // Was it a down event from button 1, 2, 3, 4 or any?
1127     bool ButtonDown(int but = wxJOY_BUTTON_ANY) const
1128     { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) &&
1129             ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
1130
1131     // Was it a up event from button 1, 2, 3 or any?
1132     bool ButtonUp(int but = wxJOY_BUTTON_ANY) const
1133     { return ((GetEventType() == wxEVT_JOY_BUTTON_UP) &&
1134             ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
1135
1136     // Was the given button 1,2,3,4 or any in Down state?
1137     bool ButtonIsDown(int but =  wxJOY_BUTTON_ANY) const
1138     { return (((but == wxJOY_BUTTON_ANY) && (m_buttonState != 0)) ||
1139             ((m_buttonState & but) == but)); }
1140
1141     void CopyObject(wxObject& obj) const;
1142 };
1143
1144 // Drop files event class
1145 /*
1146  wxEVT_DROP_FILES
1147  */
1148
1149 class WXDLLEXPORT wxDropFilesEvent : public wxEvent
1150 {
1151     DECLARE_DYNAMIC_CLASS(wxDropFilesEvent)
1152
1153 public:
1154     int       m_noFiles;
1155     wxPoint   m_pos;
1156     wxString* m_files;        // Memory (de)allocated by code calling ProcessEvent
1157
1158     wxDropFilesEvent(wxEventType type = wxEVT_NULL,
1159                      int noFiles = 0,
1160                      wxString *files = (wxString *) NULL)
1161         { m_eventType = type; m_noFiles = noFiles; m_files = files; }
1162
1163     wxPoint GetPosition() const { return m_pos; }
1164     int GetNumberOfFiles() const { return m_noFiles; }
1165     wxString *GetFiles() const { return m_files; }
1166
1167     void CopyObject(wxObject& obj) const;
1168 };
1169
1170 // Update UI event
1171 /*
1172  wxEVT_UPDATE_UI
1173  */
1174
1175 class WXDLLEXPORT wxUpdateUIEvent : public wxCommandEvent
1176 {
1177     DECLARE_DYNAMIC_CLASS(wxUpdateUIEvent)
1178
1179 public:
1180     wxUpdateUIEvent(wxWindowID commandId = 0)
1181     {
1182         m_eventType = wxEVT_UPDATE_UI;
1183         m_id = commandId;
1184         m_checked = FALSE;
1185         m_setChecked = FALSE;
1186         m_enabled = FALSE;
1187         m_setEnabled = FALSE;
1188         m_setText = FALSE;
1189         m_text = "";
1190     }
1191
1192     bool GetChecked() const { return m_checked; }
1193     bool GetEnabled() const { return m_enabled; }
1194     wxString GetText() const { return m_text; }
1195     bool GetSetText() const { return m_setText; }
1196     bool GetSetChecked() const { return m_setChecked; }
1197     bool GetSetEnabled() const { return m_setEnabled; }
1198
1199     void Check(bool check) { m_checked = check; m_setChecked = TRUE; }
1200     void Enable(bool enable) { m_enabled = enable; m_setEnabled = TRUE; }
1201     void SetText(const wxString& text) { m_text = text; m_setText = TRUE; }
1202
1203     void CopyObject(wxObject& obj) const;
1204
1205 protected:
1206     bool          m_checked;
1207     bool          m_enabled;
1208     bool          m_setEnabled;
1209     bool          m_setText;
1210     bool          m_setChecked;
1211     wxString      m_text;
1212 };
1213
1214 /*
1215  wxEVT_SYS_COLOUR_CHANGED
1216  */
1217
1218 // TODO: shouldn't all events record the window ID?
1219 class WXDLLEXPORT wxSysColourChangedEvent : public wxEvent
1220 {
1221     DECLARE_DYNAMIC_CLASS(wxSysColourChangedEvent)
1222
1223 public:
1224     wxSysColourChangedEvent()
1225         { m_eventType = wxEVT_SYS_COLOUR_CHANGED; }
1226 };
1227
1228 /*
1229  wxEVT_PALETTE_CHANGED
1230  */
1231
1232 class WXDLLEXPORT wxPaletteChangedEvent : public wxEvent
1233 {
1234     DECLARE_DYNAMIC_CLASS(wxPaletteChangedEvent)
1235
1236 public:
1237     wxPaletteChangedEvent(wxWindowID id = 0) : wxEvent(id)
1238     {
1239         m_eventType = wxEVT_PALETTE_CHANGED;
1240         m_changedWindow = (wxWindow *) NULL;
1241     }
1242
1243     void SetChangedWindow(wxWindow* win) { m_changedWindow = win; }
1244     wxWindow* GetChangedWindow() const { return m_changedWindow; }
1245
1246     void CopyObject(wxObject& obj) const;
1247
1248 protected:
1249     wxWindow*     m_changedWindow;
1250 };
1251
1252 /*
1253  wxEVT_QUERY_NEW_PALETTE
1254  Indicates the window is getting keyboard focus and should re-do its palette.
1255  */
1256
1257 class WXDLLEXPORT wxQueryNewPaletteEvent : public wxEvent
1258 {
1259     DECLARE_DYNAMIC_CLASS(wxQueryNewPaletteEvent)
1260
1261 public:
1262     wxQueryNewPaletteEvent(wxWindowID id = 0): wxEvent(id)
1263         { m_eventType = wxEVT_QUERY_NEW_PALETTE; m_paletteRealized = FALSE; }
1264
1265     // App sets this if it changes the palette.
1266     void SetPaletteRealized(bool realized) { m_paletteRealized = realized; }
1267     bool GetPaletteRealized() const { return m_paletteRealized; }
1268
1269     void CopyObject(wxObject& obj) const;
1270
1271 protected:
1272     bool m_paletteRealized;
1273 };
1274
1275 /*
1276  Event generated by dialog navigation keys
1277  wxEVT_NAVIGATION_KEY
1278  */
1279 // NB: don't derive from command event to avoid being propagated to the parent
1280 class WXDLLEXPORT wxNavigationKeyEvent : public wxEvent
1281 {
1282 public:
1283     wxNavigationKeyEvent()
1284     {
1285         SetEventType(wxEVT_NAVIGATION_KEY);
1286
1287         m_flags = IsForward | Propagate;    // defaults are for TAB
1288         m_focus = (wxWindow *)NULL;
1289     }
1290
1291     // direction: forward (true) or backward (false)
1292     bool GetDirection() const
1293         { return (m_flags & IsForward) != 0; }
1294     void SetDirection(bool bForward)
1295         { if ( bForward ) m_flags |= IsForward; else m_flags &= ~IsForward; }
1296
1297     // it may be a window change event (MDI, notebook pages...) or a control
1298     // change event
1299     bool IsWindowChange() const
1300         { return (m_flags & WinChange) != 0; }
1301     void SetWindowChange(bool bIs)
1302         { if ( bIs ) m_flags |= WinChange; else m_flags &= ~WinChange; }
1303
1304     // some navigation events are meant to be propagated upwards (Windows
1305     // convention is to do this for TAB events) while others should always
1306     // cycle inside the panel/radiobox/whatever we're current inside
1307     bool ShouldPropagate() const
1308         { return (m_flags & Propagate) != 0; }
1309     void SetPropagate(bool bDoIt)
1310         { if ( bDoIt ) m_flags |= Propagate; else m_flags &= ~Propagate; }
1311
1312     // the child which has the focus currently (may be NULL - use
1313     // wxWindow::FindFocus then)
1314     wxWindow* GetCurrentFocus() const { return m_focus; }
1315     void SetCurrentFocus(wxWindow *win) { m_focus = win; }
1316
1317 private:
1318     enum
1319     {
1320         IsForward = 0x0001,
1321         WinChange = 0x0002,
1322         Propagate = 0x0004
1323     };
1324
1325     long m_flags;
1326     wxWindow *m_focus;
1327
1328     DECLARE_DYNAMIC_CLASS(wxNavigationKeyEvent)
1329 };
1330
1331 // Window creation/destruction events: the first is sent as soon as window is
1332 // created (i.e. the underlying GUI object exists), but when the C++ object is
1333 // fully initialized (so virtual functions may be called). The second,
1334 // wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
1335 // still safe to call virtual functions at this moment
1336 /*
1337  wxEVT_CREATE
1338  wxEVT_DESTROY
1339  */
1340
1341 class WXDLLEXPORT wxWindowCreateEvent : public wxCommandEvent
1342 {
1343     DECLARE_DYNAMIC_CLASS(wxWindowCreateEvent)
1344
1345 public:
1346     wxWindowCreateEvent(wxWindow *win = NULL);
1347
1348     wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1349 };
1350
1351 class WXDLLEXPORT wxWindowDestroyEvent : public wxCommandEvent
1352 {
1353     DECLARE_DYNAMIC_CLASS(wxWindowDestroyEvent)
1354
1355 public:
1356     wxWindowDestroyEvent(wxWindow *win = NULL);
1357
1358     wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1359 };
1360
1361 // A help event is sent when the user clicks on a window in context-help mode.
1362 /*
1363  wxEVT_HELP
1364  wxEVT_DETAILED_HELP
1365 */
1366
1367 class WXDLLEXPORT wxHelpEvent : public wxCommandEvent
1368 {
1369 public:
1370     wxHelpEvent(wxEventType type = wxEVT_NULL,
1371                 wxWindowID id = 0,
1372                 const wxPoint& pt = wxDefaultPosition)
1373     {
1374         m_eventType = type;
1375         m_id = id;
1376         m_pos = pt;
1377     }
1378
1379     // Position of event (in screen coordinates)
1380     const wxPoint& GetPosition() const { return m_pos; }
1381     void SetPosition(const wxPoint& pos) { m_pos = pos; }
1382
1383     // Optional link to further help
1384     const wxString& GetLink() const { return m_link; }
1385     void SetLink(const wxString& link) { m_link = link; }
1386
1387     // Optional target to display help in. E.g. a window specification
1388     const wxString& GetTarget() const { return m_target; }
1389     void SetTarget(const wxString& target) { m_target = target; }
1390
1391 protected:
1392     wxPoint   m_pos;
1393     wxString  m_target;
1394     wxString  m_link;
1395
1396 private:
1397     DECLARE_DYNAMIC_CLASS(wxHelpEvent)
1398 };
1399
1400 #endif // wxUSE_GUI
1401
1402 // Idle event
1403 /*
1404  wxEVT_IDLE
1405  */
1406
1407 class WXDLLEXPORT wxIdleEvent : public wxEvent
1408 {
1409     DECLARE_DYNAMIC_CLASS(wxIdleEvent)
1410
1411 public:
1412     wxIdleEvent()
1413         { m_eventType = wxEVT_IDLE; m_requestMore = FALSE; }
1414
1415     void RequestMore(bool needMore = TRUE) { m_requestMore = needMore; }
1416     bool MoreRequested() const { return m_requestMore; }
1417
1418     void CopyObject(wxObject& obj) const;
1419
1420 protected:
1421     bool m_requestMore;
1422 };
1423
1424 /* TODO
1425  wxEVT_POWER,
1426  wxEVT_MOUSE_CAPTURE_CHANGED,
1427  wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
1428 // wxEVT_FONT_CHANGED,  // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
1429                         // wxEVT_FONT_CHANGED to all other windows (maybe).
1430  wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
1431  wxEVT_MEASURE_ITEM,
1432  wxEVT_COMPARE_ITEM
1433 */
1434
1435 // ============================================================================
1436 // event handler and related classes
1437 // ============================================================================
1438
1439 typedef void (wxObject::*wxObjectEventFunction)(wxEvent&);
1440
1441 // we can't have ctors nor base struct in backwards compatibility mode or
1442 // otherwise we won't be able to initialize the objects with an agregate, so
1443 // we have to keep both versions
1444 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1445
1446 struct WXDLLEXPORT wxEventTableEntry
1447 {
1448     // For some reason, this can't be wxEventType, or VC++ complains.
1449     int m_eventType;            // main event type
1450     int m_id;                   // control/menu/toolbar id
1451     int m_lastId;               // used for ranges of ids
1452     wxObjectEventFunction m_fn; // function to call: not wxEventFunction,
1453                                 // because of dependency problems
1454
1455     wxObject* m_callbackUserData;
1456 };
1457
1458 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1459
1460 // struct containing the members common to static and dynamic event tables
1461 // entries
1462 struct WXDLLEXPORT wxEventTableEntryBase
1463 {
1464     wxEventTableEntryBase(int id, int idLast,
1465                           wxObjectEventFunction fn, wxObject *data)
1466     {
1467         m_id = id;
1468         m_lastId = idLast;
1469         m_fn = fn;
1470         m_callbackUserData = data;
1471     }
1472
1473     // the range of ids for this entry: if m_lastId == -1, the range consists
1474     // only of m_id, otherwise it is m_id..m_lastId inclusive
1475     int m_id, m_lastId;
1476
1477     // function to call: not wxEventFunction, because of dependency problems
1478     wxObjectEventFunction m_fn;
1479
1480     // arbitrary user data asosciated with the callback
1481     wxObject* m_callbackUserData;
1482 };
1483
1484 // an entry from a static event table
1485 struct WXDLLEXPORT wxEventTableEntry : public wxEventTableEntryBase
1486 {
1487     wxEventTableEntry(const int& evType, int id, int idLast,
1488                       wxObjectEventFunction fn, wxObject *data)
1489                  : wxEventTableEntryBase(id, idLast, fn, data),
1490                    m_eventType(evType)
1491     {
1492     }
1493
1494     // the reference to event type: this allows us to not care about the
1495     // (undefined) order in which the event table entries and the event types
1496     // are initialized: initially the value of this reference might be
1497     // invalid, but by the time it is used for the first time, all global
1498     // objects will have been initialized (including the event type constants)
1499     // and so it will have the correct value when it is needed
1500     const int& m_eventType;
1501 };
1502
1503 // an entry used in dynamic event table managed by wxEvtHandler::Connect()
1504 struct WXDLLEXPORT wxDynamicEventTableEntry : public wxEventTableEntryBase
1505 {
1506     wxDynamicEventTableEntry(int evType, int id, int idLast,
1507                              wxObjectEventFunction fn, wxObject *data)
1508         : wxEventTableEntryBase(id, idLast, fn, data)
1509     {
1510         m_eventType = evType;
1511     }
1512
1513     // not a reference here as we can't keep a reference to a temporary int
1514     // created to wrap the constant value typically passed to Connect() - nor
1515     // do we need it
1516     int m_eventType;
1517 };
1518
1519 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
1520
1521 // ----------------------------------------------------------------------------
1522 // wxEventTable: an array of event entries terminated with {0, 0, 0, 0, 0}
1523 // ----------------------------------------------------------------------------
1524 struct WXDLLEXPORT wxEventTable
1525 {
1526     const wxEventTable *baseTable;    // base event table (next in chain)
1527     const wxEventTableEntry *entries; // bottom of entry array
1528 };
1529
1530 // ----------------------------------------------------------------------------
1531 // wxEvtHandler: the base class for all objects handling wxWindows events
1532 // ----------------------------------------------------------------------------
1533
1534 class WXDLLEXPORT wxEvtHandler : public wxObject
1535 {
1536 public:
1537     wxEvtHandler();
1538     virtual ~wxEvtHandler();
1539
1540     wxEvtHandler *GetNextHandler() const { return m_nextHandler; }
1541     wxEvtHandler *GetPreviousHandler() const { return m_previousHandler; }
1542     void SetNextHandler(wxEvtHandler *handler) { m_nextHandler = handler; }
1543     void SetPreviousHandler(wxEvtHandler *handler) { m_previousHandler = handler; }
1544
1545     void SetEvtHandlerEnabled(bool enabled) { m_enabled = enabled; }
1546     bool GetEvtHandlerEnabled() const { return m_enabled; }
1547
1548     // process an event right now
1549     virtual bool ProcessEvent(wxEvent& event);
1550
1551     // add an event to be processed later
1552     void AddPendingEvent(wxEvent& event);
1553
1554     // process all pending events
1555     void ProcessPendingEvents();
1556
1557     // add a
1558 #if wxUSE_THREADS
1559     bool ProcessThreadEvent(wxEvent& event);
1560 #endif
1561
1562     // Dynamic association of a member function handler with the event handler,
1563     // id and event type
1564     void Connect( int id, int lastId, int eventType,
1565                   wxObjectEventFunction func,
1566                   wxObject *userData = (wxObject *) NULL );
1567
1568     // Convenience function: take just one id
1569     void Connect( int id, int eventType,
1570                   wxObjectEventFunction func,
1571                   wxObject *userData = (wxObject *) NULL )
1572         { Connect(id, -1, eventType, func, userData); }
1573
1574     bool Disconnect( int id, int lastId = -1, wxEventType eventType = wxEVT_NULL,
1575                   wxObjectEventFunction func = NULL,
1576                   wxObject *userData = (wxObject *) NULL );
1577
1578     // Convenience function: take just one id
1579     bool Disconnect( int id, wxEventType eventType = wxEVT_NULL,
1580                   wxObjectEventFunction func = NULL,
1581                   wxObject *userData = (wxObject *) NULL )
1582         { return Disconnect(id, -1, eventType, func, userData); }
1583
1584     // implementation from now on
1585     virtual bool SearchEventTable(wxEventTable& table, wxEvent& event);
1586     bool SearchDynamicEventTable( wxEvent& event );
1587
1588 #if wxUSE_THREADS
1589     void ClearEventLocker()
1590    {
1591 #  if !defined(__VISAGECPP__)
1592       delete m_eventsLocker;
1593       m_eventsLocker = NULL;
1594 #endif
1595    };
1596 #endif
1597
1598     // old stuff
1599
1600 #if WXWIN_COMPATIBILITY_2
1601     virtual void OnCommand(wxWindow& WXUNUSED(win),
1602                            wxCommandEvent& WXUNUSED(event))
1603     {
1604         wxFAIL_MSG(wxT("shouldn't be called any more"));
1605     }
1606
1607     // Called if child control has no callback function
1608     virtual long Default()
1609         { return GetNextHandler() ? GetNextHandler()->Default() : 0; };
1610 #endif // WXWIN_COMPATIBILITY_2
1611
1612 #if WXWIN_COMPATIBILITY
1613     virtual bool OnClose();
1614 #endif
1615
1616 private:
1617     static const wxEventTableEntry sm_eventTableEntries[];
1618
1619 protected:
1620     static const wxEventTable sm_eventTable;
1621
1622     virtual const wxEventTable *GetEventTable() const;
1623
1624     wxEvtHandler*       m_nextHandler;
1625     wxEvtHandler*       m_previousHandler;
1626     wxList*             m_dynamicEvents;
1627     wxList*             m_pendingEvents;
1628
1629 #if wxUSE_THREADS
1630 #if defined (__VISAGECPP__)
1631     wxCriticalSection   m_eventsLocker;
1632 #  else
1633     wxCriticalSection*  m_eventsLocker;
1634 #  endif
1635 #endif
1636
1637     // optimization: instead of using costly IsKindOf() to decide whether we're
1638     // a window (which is true in 99% of cases), use this flag
1639     bool                m_isWindow;
1640
1641     // Is event handler enabled?
1642     bool                m_enabled;
1643
1644 private:
1645     DECLARE_DYNAMIC_CLASS(wxEvtHandler)
1646 };
1647
1648 typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&);
1649 #if wxUSE_GUI
1650 typedef void (wxEvtHandler::*wxCommandEventFunction)(wxCommandEvent&);
1651 typedef void (wxEvtHandler::*wxScrollEventFunction)(wxScrollEvent&);
1652 typedef void (wxEvtHandler::*wxScrollWinEventFunction)(wxScrollWinEvent&);
1653 typedef void (wxEvtHandler::*wxSizeEventFunction)(wxSizeEvent&);
1654 typedef void (wxEvtHandler::*wxMoveEventFunction)(wxMoveEvent&);
1655 typedef void (wxEvtHandler::*wxPaintEventFunction)(wxPaintEvent&);
1656 typedef void (wxEvtHandler::*wxEraseEventFunction)(wxEraseEvent&);
1657 typedef void (wxEvtHandler::*wxMouseEventFunction)(wxMouseEvent&);
1658 typedef void (wxEvtHandler::*wxCharEventFunction)(wxKeyEvent&);
1659 typedef void (wxEvtHandler::*wxFocusEventFunction)(wxFocusEvent&);
1660 typedef void (wxEvtHandler::*wxActivateEventFunction)(wxActivateEvent&);
1661 typedef void (wxEvtHandler::*wxMenuEventFunction)(wxMenuEvent&);
1662 typedef void (wxEvtHandler::*wxJoystickEventFunction)(wxJoystickEvent&);
1663 typedef void (wxEvtHandler::*wxDropFilesEventFunction)(wxDropFilesEvent&);
1664 typedef void (wxEvtHandler::*wxInitDialogEventFunction)(wxInitDialogEvent&);
1665 typedef void (wxEvtHandler::*wxSysColourChangedFunction)(wxSysColourChangedEvent&);
1666 typedef void (wxEvtHandler::*wxUpdateUIEventFunction)(wxUpdateUIEvent&);
1667 typedef void (wxEvtHandler::*wxIdleEventFunction)(wxIdleEvent&);
1668 typedef void (wxEvtHandler::*wxCloseEventFunction)(wxCloseEvent&);
1669 typedef void (wxEvtHandler::*wxShowEventFunction)(wxShowEvent&);
1670 typedef void (wxEvtHandler::*wxIconizeEventFunction)(wxShowEvent&);
1671 typedef void (wxEvtHandler::*wxMaximizeEventFunction)(wxShowEvent&);
1672 typedef void (wxEvtHandler::*wxNavigationKeyEventFunction)(wxNavigationKeyEvent&);
1673 typedef void (wxEvtHandler::*wxPaletteChangedEventFunction)(wxPaletteChangedEvent&);
1674 typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction)(wxQueryNewPaletteEvent&);
1675 typedef void (wxEvtHandler::*wxWindowCreateEventFunction)(wxWindowCreateEvent&);
1676 typedef void (wxEvtHandler::*wxWindowDestroyEventFunction)(wxWindowDestroyEvent&);
1677 typedef void (wxEvtHandler::*wxSetCursorEventFunction)(wxSetCursorEvent&);
1678 typedef void (wxEvtHandler::*wxNotifyEventFunction)(wxNotifyEvent&);
1679 typedef void (wxEvtHandler::*wxHelpEventFunction)(wxHelpEvent&);
1680 #endif // wxUSE_GUI
1681
1682 // N.B. In GNU-WIN32, you *have* to take the address of a member function
1683 // (use &) or the compiler crashes...
1684
1685 #define DECLARE_EVENT_TABLE() \
1686     private: \
1687         static const wxEventTableEntry sm_eventTableEntries[]; \
1688     protected: \
1689         static const wxEventTable        sm_eventTable; \
1690         virtual const wxEventTable*        GetEventTable() const;
1691
1692 #define BEGIN_EVENT_TABLE(theClass, baseClass) \
1693     const wxEventTable *theClass::GetEventTable() const \
1694         { return &theClass::sm_eventTable; } \
1695     const wxEventTable theClass::sm_eventTable = \
1696         { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] }; \
1697     const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
1698
1699 #define END_EVENT_TABLE() DECLARE_EVENT_TABLE_ENTRY( 0, 0, 0, 0, 0 ) };
1700
1701 /*
1702  * Event table macros
1703  */
1704
1705 // Generic events
1706 #define EVT_CUSTOM(event, id, func) DECLARE_EVENT_TABLE_ENTRY( event, id, -1, (wxObjectEventFunction) (wxEventFunction) & func, (wxObject *) NULL ),
1707 #define EVT_CUSTOM_RANGE(event, id1, id2, func) DECLARE_EVENT_TABLE_ENTRY( event, id1, id2, (wxObjectEventFunction) (wxEventFunction) & func, (wxObject *) NULL ),
1708
1709 // Miscellaneous
1710 #define EVT_SIZE(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_SIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxSizeEventFunction) & func, (wxObject *) NULL ),
1711 #define EVT_MOVE(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_MOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMoveEventFunction) & func, (wxObject *) NULL ),
1712 #define EVT_CLOSE(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_CLOSE_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL ),
1713 #define EVT_END_SESSION(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_END_SESSION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL ),
1714 #define EVT_QUERY_END_SESSION(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_QUERY_END_SESSION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL ),
1715 #define EVT_PAINT(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_PAINT, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxPaintEventFunction) & func, (wxObject *) NULL ),
1716 #define EVT_ERASE_BACKGROUND(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_ERASE_BACKGROUND, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxEraseEventFunction) & func, (wxObject *) NULL ),
1717 #define EVT_CHAR(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_CHAR, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCharEventFunction) & func, (wxObject *) NULL ),
1718 #define EVT_KEY_DOWN(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_KEY_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCharEventFunction) & func, (wxObject *) NULL ),
1719 #define EVT_KEY_UP(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_KEY_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCharEventFunction) & func, (wxObject *) NULL ),
1720 #define EVT_CHAR_HOOK(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_CHAR_HOOK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCharEventFunction) & func, NULL ),
1721 #define EVT_MENU_HIGHLIGHT(id, func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_MENU_HIGHLIGHT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxMenuEventFunction) & func, (wxObject *) NULL ),
1722 #define EVT_MENU_HIGHLIGHT_ALL(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_MENU_HIGHLIGHT, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMenuEventFunction) & func, (wxObject *) NULL ),
1723 #define EVT_SET_FOCUS(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_SET_FOCUS, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxFocusEventFunction) & func, (wxObject *) NULL ),
1724 #define EVT_KILL_FOCUS(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_KILL_FOCUS, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxFocusEventFunction) & func, (wxObject *) NULL ),
1725 #define EVT_ACTIVATE(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_ACTIVATE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxActivateEventFunction) & func, (wxObject *) NULL ),
1726 #define EVT_ACTIVATE_APP(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_ACTIVATE_APP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxActivateEventFunction) & func, (wxObject *) NULL ),
1727 #define EVT_END_SESSION(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_END_SESSION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL ),
1728 #define EVT_QUERY_END_SESSION(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_QUERY_END_SESSION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL ),
1729 #define EVT_DROP_FILES(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_DROP_FILES, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxDropFilesEventFunction) & func, (wxObject *) NULL ),
1730 #define EVT_INIT_DIALOG(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_INIT_DIALOG, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxInitDialogEventFunction) & func, (wxObject *) NULL ),
1731 #define EVT_SYS_COLOUR_CHANGED(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_SYS_COLOUR_CHANGED, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxSysColourChangedFunction) & func, (wxObject *) NULL ),
1732 #define EVT_SHOW(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SHOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxShowEventFunction) & func, (wxObject *) NULL ),
1733 #define EVT_MAXIMIZE(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MAXIMIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMaximizeEventFunction) & func, (wxObject *) NULL ),
1734 #define EVT_ICONIZE(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_ICONIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxIconizeEventFunction) & func, (wxObject *) NULL ),
1735 #define EVT_NAVIGATION_KEY(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_NAVIGATION_KEY, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxNavigationKeyEventFunction) & func, (wxObject *) NULL ),
1736 #define EVT_PALETTE_CHANGED(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PALETTE_CHANGED, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxPaletteChangedEventFunction) & func, (wxObject *) NULL ),
1737 #define EVT_QUERY_NEW_PALETTE(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_QUERY_NEW_PALETTE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxQueryNewPaletteEventFunction) & func, (wxObject *) NULL ),
1738 #define EVT_WINDOW_CREATE(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_CREATE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxWindowCreateEventFunction) & func, (wxObject *) NULL ),
1739 #define EVT_WINDOW_DESTROY(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_DESTROY, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxWindowDestroyEventFunction) & func, (wxObject *) NULL ),
1740 #define EVT_SET_CURSOR(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SET_CURSOR, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxSetCursorEventFunction) & func, (wxObject *) NULL ),
1741
1742 // Mouse events
1743 #define EVT_LEFT_DOWN(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_LEFT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),
1744 #define EVT_LEFT_UP(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_LEFT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),
1745 #define EVT_MIDDLE_DOWN(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MIDDLE_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),
1746 #define EVT_MIDDLE_UP(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MIDDLE_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),
1747 #define EVT_RIGHT_DOWN(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_RIGHT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),
1748 #define EVT_RIGHT_UP(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_RIGHT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),
1749 #define EVT_MOTION(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MOTION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),
1750 #define EVT_LEFT_DCLICK(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),
1751 #define EVT_MIDDLE_DCLICK(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MIDDLE_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),
1752 #define EVT_RIGHT_DCLICK(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),
1753 #define EVT_LEAVE_WINDOW(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_LEAVE_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),
1754 #define EVT_ENTER_WINDOW(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_ENTER_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),
1755
1756 // All mouse events
1757 #define EVT_MOUSE_EVENTS(func) \
1758  DECLARE_EVENT_TABLE_ENTRY( wxEVT_LEFT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),\
1759  DECLARE_EVENT_TABLE_ENTRY( wxEVT_LEFT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),\
1760  DECLARE_EVENT_TABLE_ENTRY( wxEVT_MIDDLE_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),\
1761  DECLARE_EVENT_TABLE_ENTRY( wxEVT_MIDDLE_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),\
1762  DECLARE_EVENT_TABLE_ENTRY( wxEVT_RIGHT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),\
1763  DECLARE_EVENT_TABLE_ENTRY( wxEVT_RIGHT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),\
1764  DECLARE_EVENT_TABLE_ENTRY( wxEVT_MOTION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),\
1765  DECLARE_EVENT_TABLE_ENTRY( wxEVT_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),\
1766  DECLARE_EVENT_TABLE_ENTRY( wxEVT_MIDDLE_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),\
1767  DECLARE_EVENT_TABLE_ENTRY( wxEVT_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),\
1768  DECLARE_EVENT_TABLE_ENTRY( wxEVT_ENTER_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),\
1769  DECLARE_EVENT_TABLE_ENTRY( wxEVT_LEAVE_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL ),
1770
1771 // EVT_COMMAND
1772 #define EVT_COMMAND(id, event, fn)  DECLARE_EVENT_TABLE_ENTRY( event, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1773 #define EVT_COMMAND_RANGE(id1, id2, event, fn)  DECLARE_EVENT_TABLE_ENTRY( event, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1774
1775 // Scrolling from wxWindow (sent to wxScrolledWindow)
1776 #define EVT_SCROLLWIN(func) \
1777   DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_TOP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),\
1778   DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_BOTTOM, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),\
1779   DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_LINEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),\
1780   DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_LINEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),\
1781   DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_PAGEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),\
1782   DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_PAGEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),\
1783   DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_THUMBTRACK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),\
1784   DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_THUMBRELEASE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),
1785
1786 #define EVT_SCROLLWIN_TOP(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_TOP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),
1787 #define EVT_SCROLLWIN_BOTTOM(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_BOTTOM, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),
1788 #define EVT_SCROLLWIN_LINEUP(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_LINEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),
1789 #define EVT_SCROLLWIN_LINEDOWN(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_LINEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),
1790 #define EVT_SCROLLWIN_PAGEUP(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_PAGEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),
1791 #define EVT_SCROLLWIN_PAGEDOWN(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_PAGEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),
1792 #define EVT_SCROLLWIN_THUMBTRACK(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_THUMBTRACK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),
1793 #define EVT_SCROLLWIN_THUMBRELEASE(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_THUMBRELEASE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL ),
1794
1795 // Scrolling from wxSlider and wxScrollBar
1796 #define EVT_SCROLL(func) \
1797   DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_TOP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),\
1798   DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_BOTTOM, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),\
1799   DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_LINEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),\
1800   DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_LINEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),\
1801   DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_PAGEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),\
1802   DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_PAGEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),\
1803   DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_THUMBTRACK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),\
1804   DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_THUMBRELEASE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
1805
1806 #define EVT_SCROLL_TOP(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_TOP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
1807 #define EVT_SCROLL_BOTTOM(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_BOTTOM, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
1808 #define EVT_SCROLL_LINEUP(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_LINEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
1809 #define EVT_SCROLL_LINEDOWN(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_LINEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
1810 #define EVT_SCROLL_PAGEUP(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_PAGEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
1811 #define EVT_SCROLL_PAGEDOWN(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_PAGEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
1812 #define EVT_SCROLL_THUMBTRACK(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_THUMBTRACK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
1813 #define EVT_SCROLL_THUMBRELEASE(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_THUMBRELEASE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
1814
1815 // Scrolling from wxSlider and wxScrollBar, with an id
1816 #define EVT_COMMAND_SCROLL(id, func) \
1817   DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_TOP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),\
1818   DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_BOTTOM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),\
1819   DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_LINEUP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),\
1820   DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_LINEDOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),\
1821   DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_PAGEUP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),\
1822   DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_PAGEDOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),\
1823   DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_THUMBTRACK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),\
1824   DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_THUMBRELEASE, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
1825
1826 #define EVT_COMMAND_SCROLL_TOP(id, func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_TOP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
1827 #define EVT_COMMAND_SCROLL_BOTTOM(id, func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_BOTTOM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
1828 #define EVT_COMMAND_SCROLL_LINEUP(id, func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_LINEUP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
1829 #define EVT_COMMAND_SCROLL_LINEDOWN(id, func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_LINEDOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
1830 #define EVT_COMMAND_SCROLL_PAGEUP(id, func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_PAGEUP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
1831 #define EVT_COMMAND_SCROLL_PAGEDOWN(id, func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_PAGEDOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
1832 #define EVT_COMMAND_SCROLL_THUMBTRACK(id, func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_THUMBTRACK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
1833 #define EVT_COMMAND_SCROLL_THUMBRELEASE(id, func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_THUMBRELEASE, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL ),
1834
1835 // Convenience macros for commonly-used commands
1836 #define EVT_BUTTON(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_BUTTON_CLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1837 #define EVT_CHECKBOX(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_CHECKBOX_CLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1838 #define EVT_CHOICE(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_CHOICE_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1839 #define EVT_LISTBOX(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LISTBOX_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1840 #define EVT_LISTBOX_DCLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1841 #define EVT_TEXT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1842 #define EVT_TEXT_ENTER(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1843 #define EVT_MENU(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_MENU_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1844 #define EVT_MENU_RANGE(id1, id2, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_MENU_SELECTED, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1845 #define EVT_SLIDER(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_SLIDER_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1846 #define EVT_RADIOBOX(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RADIOBOX_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1847 #define EVT_RADIOBUTTON(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RADIOBUTTON_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1848 // EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events
1849 #define EVT_SCROLLBAR(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_SCROLLBAR_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1850 #define EVT_VLBOX(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_VLBOX_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1851 #define EVT_COMBOBOX(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_COMBOBOX_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1852 #define EVT_TOOL(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TOOL_CLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1853 #define EVT_TOOL_RANGE(id1, id2, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TOOL_CLICKED, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1854 #define EVT_TOOL_RCLICKED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TOOL_RCLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1855 #define EVT_TOOL_RCLICKED_RANGE(id1, id2, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1856 #define EVT_TOOL_ENTER(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TOOL_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1857 #define EVT_CHECKLISTBOX(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1858
1859 // Generic command events
1860 #define EVT_COMMAND_LEFT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LEFT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1861 #define EVT_COMMAND_LEFT_DCLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LEFT_DCLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1862 #define EVT_COMMAND_RIGHT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RIGHT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1863 #define EVT_COMMAND_RIGHT_DCLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RIGHT_DCLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1864 #define EVT_COMMAND_SET_FOCUS(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_SET_FOCUS, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1865 #define EVT_COMMAND_KILL_FOCUS(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_KILL_FOCUS, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1866 #define EVT_COMMAND_ENTER(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
1867
1868 // Joystick events
1869 #define EVT_JOY_DOWN(func) \
1870  DECLARE_EVENT_TABLE_ENTRY( wxEVT_JOY_BUTTON_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL ),
1871 #define EVT_JOY_UP(func) \
1872  DECLARE_EVENT_TABLE_ENTRY( wxEVT_JOY_BUTTON_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL ),
1873 #define EVT_JOY_MOVE(func) \
1874  DECLARE_EVENT_TABLE_ENTRY( wxEVT_JOY_MOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL ),
1875 #define EVT_JOY_ZMOVE(func) \
1876  DECLARE_EVENT_TABLE_ENTRY( wxEVT_JOY_ZMOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL ),
1877
1878 // All joystick events
1879 #define EVT_JOYSTICK_EVENTS(func) \
1880  DECLARE_EVENT_TABLE_ENTRY( wxEVT_JOY_BUTTON_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL ),\
1881  DECLARE_EVENT_TABLE_ENTRY( wxEVT_JOY_BUTTON_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL ),\
1882  DECLARE_EVENT_TABLE_ENTRY( wxEVT_JOY_MOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL ),\
1883  DECLARE_EVENT_TABLE_ENTRY( wxEVT_JOY_ZMOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL ),
1884
1885 // Idle event
1886 #define EVT_IDLE(func) \
1887  DECLARE_EVENT_TABLE_ENTRY( wxEVT_IDLE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxIdleEventFunction) & func, (wxObject *) NULL ),
1888
1889 // Update UI event
1890 #define EVT_UPDATE_UI(id, func) \
1891  DECLARE_EVENT_TABLE_ENTRY( wxEVT_UPDATE_UI, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxUpdateUIEventFunction) & func, (wxObject *) NULL ),
1892 #define EVT_UPDATE_UI_RANGE(id1, id2, func) \
1893  DECLARE_EVENT_TABLE_ENTRY( wxEVT_UPDATE_UI, id1, id2, (wxObjectEventFunction)(wxEventFunction)(wxUpdateUIEventFunction)&func, (wxObject *) NULL ),
1894
1895 // Help events
1896 #define EVT_HELP(id, func) \
1897  DECLARE_EVENT_TABLE_ENTRY( wxEVT_HELP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxHelpEventFunction) & func, (wxObject *) NULL ),
1898
1899 #define EVT_HELP_RANGE(id1, id2, func) \
1900  DECLARE_EVENT_TABLE_ENTRY( wxEVT_HELP, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxHelpEventFunction) & func, (wxObject *) NULL ),
1901
1902 #define EVT_DETAILED_HELP(id, func) \
1903  DECLARE_EVENT_TABLE_ENTRY( wxEVT_DETAILED_HELP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxHelpEventFunction) & func, (wxObject *) NULL ),
1904
1905 #define EVT_DETAILED_HELP_RANGE(id1, id2, func) \
1906  DECLARE_EVENT_TABLE_ENTRY( wxEVT_DETAILED_HELP, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxHelpEventFunction) & func, (wxObject *) NULL ),
1907
1908 // ----------------------------------------------------------------------------
1909 // Global data
1910 // ----------------------------------------------------------------------------
1911
1912 // for pending event processing - notice that there is intentionally no
1913 // WXDLLEXPORT here
1914 extern wxList *wxPendingEvents;
1915 #if wxUSE_THREADS
1916     extern wxCriticalSection *wxPendingEventsLocker;
1917 #endif
1918
1919 // ----------------------------------------------------------------------------
1920 // Helper functions
1921 // ----------------------------------------------------------------------------
1922
1923 #if wxUSE_GUI
1924
1925 // Find a window with the focus, that is also a descendant of the given window.
1926 // This is used to determine the window to initially send commands to.
1927 wxWindow* wxFindFocusDescendant(wxWindow* ancestor);
1928
1929 #endif // wxUSE_GUI
1930
1931 #endif
1932         // _WX_EVENTH__