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