include/wx/event.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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)
   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 #include "wx/gdicmn.h"
  22 #if wxUSE_THREADS
  23 #include "wx/thread.h"
  24 #endif
  25
  26 /*
  27  * Event types
  28  *
  29  */
  30
  31 typedef int wxEventType;
  32
  33 const wxEventType wxEVT_NULL = 0;
  34 const wxEventType wxEVT_FIRST = 10000;
  35
  36 const wxEventType wxEVT_COMMAND_BUTTON_CLICKED =            wxEVT_FIRST + 1;
  37 const wxEventType wxEVT_COMMAND_CHECKBOX_CLICKED =          wxEVT_FIRST + 2;
  38 const wxEventType wxEVT_COMMAND_CHOICE_SELECTED =           wxEVT_FIRST + 3;
  39 const wxEventType wxEVT_COMMAND_LISTBOX_SELECTED =          wxEVT_FIRST + 4;
  40 const wxEventType wxEVT_COMMAND_LISTBOX_DOUBLECLICKED =     wxEVT_FIRST + 5;
  41 const wxEventType wxEVT_COMMAND_CHECKLISTBOX_TOGGLED =      wxEVT_FIRST + 6;
  42 const wxEventType wxEVT_COMMAND_TEXT_UPDATED =              wxEVT_FIRST + 7;
  43 const wxEventType wxEVT_COMMAND_TEXT_ENTER =                wxEVT_FIRST + 8;
  44 const wxEventType wxEVT_COMMAND_MENU_SELECTED =             wxEVT_FIRST + 9;
  45 const wxEventType wxEVT_COMMAND_TOOL_CLICKED =              wxEVT_COMMAND_MENU_SELECTED;
  46 const wxEventType wxEVT_COMMAND_SLIDER_UPDATED =            wxEVT_FIRST + 10;
  47 const wxEventType wxEVT_COMMAND_RADIOBOX_SELECTED =         wxEVT_FIRST + 11;
  48 const wxEventType wxEVT_COMMAND_RADIOBUTTON_SELECTED =      wxEVT_FIRST + 12;
  49 //const wxEventType wxEVT_COMMAND_SCROLLBAR_UPDATED is now obsolete since we use wxEVT_SCROLL... events
  50 const wxEventType wxEVT_COMMAND_SCROLLBAR_UPDATED =         wxEVT_FIRST + 13;
  51 const wxEventType wxEVT_COMMAND_VLBOX_SELECTED =            wxEVT_FIRST + 14;
  52 const wxEventType wxEVT_COMMAND_COMBOBOX_SELECTED =         wxEVT_FIRST + 15;
  53 const wxEventType wxEVT_COMMAND_TOOL_RCLICKED =             wxEVT_FIRST + 16;
  54 const wxEventType wxEVT_COMMAND_TOOL_ENTER =                wxEVT_FIRST + 17;
  55
  56 /* Sockets send events, too */
  57 const wxEventType wxEVT_SOCKET =                            wxEVT_FIRST + 50;
  58
  59 /* Mouse event types */
  60 const wxEventType wxEVT_LEFT_DOWN =                         wxEVT_FIRST + 100;
  61 const wxEventType wxEVT_LEFT_UP =                           wxEVT_FIRST + 101;
  62 const wxEventType wxEVT_MIDDLE_DOWN =                       wxEVT_FIRST + 102;
  63 const wxEventType wxEVT_MIDDLE_UP =                         wxEVT_FIRST + 103;
  64 const wxEventType wxEVT_RIGHT_DOWN =                        wxEVT_FIRST + 104;
  65 const wxEventType wxEVT_RIGHT_UP =                          wxEVT_FIRST + 105;
  66 const wxEventType wxEVT_MOTION =                            wxEVT_FIRST + 106;
  67 const wxEventType wxEVT_ENTER_WINDOW =                      wxEVT_FIRST + 107;
  68 const wxEventType wxEVT_LEAVE_WINDOW =                      wxEVT_FIRST + 108;
  69 const wxEventType wxEVT_LEFT_DCLICK =                       wxEVT_FIRST + 109;
  70 const wxEventType wxEVT_MIDDLE_DCLICK =                     wxEVT_FIRST + 110;
  71 const wxEventType wxEVT_RIGHT_DCLICK =                      wxEVT_FIRST + 111;
  72 const wxEventType wxEVT_SET_FOCUS =                         wxEVT_FIRST + 112;
  73 const wxEventType wxEVT_KILL_FOCUS =                        wxEVT_FIRST + 113;
  74
  75  /* Non-client mouse events */
  76 const wxEventType wxEVT_NC_LEFT_DOWN =                      wxEVT_FIRST + 200;
  77 const wxEventType wxEVT_NC_LEFT_UP =                        wxEVT_FIRST + 201;
  78 const wxEventType wxEVT_NC_MIDDLE_DOWN =                    wxEVT_FIRST + 202;
  79 const wxEventType wxEVT_NC_MIDDLE_UP =                      wxEVT_FIRST + 203;
  80 const wxEventType wxEVT_NC_RIGHT_DOWN =                     wxEVT_FIRST + 204;
  81 const wxEventType wxEVT_NC_RIGHT_UP =                       wxEVT_FIRST + 205;
  82 const wxEventType wxEVT_NC_MOTION =                         wxEVT_FIRST + 206;
  83 const wxEventType wxEVT_NC_ENTER_WINDOW =                   wxEVT_FIRST + 207;
  84 const wxEventType wxEVT_NC_LEAVE_WINDOW =                   wxEVT_FIRST + 208;
  85 const wxEventType wxEVT_NC_LEFT_DCLICK =                    wxEVT_FIRST + 209;
  86 const wxEventType wxEVT_NC_MIDDLE_DCLICK =                  wxEVT_FIRST + 210;
  87 const wxEventType wxEVT_NC_RIGHT_DCLICK =                   wxEVT_FIRST + 211;
  88
  89 /* Character input event type  */
  90 const wxEventType wxEVT_CHAR =                              wxEVT_FIRST + 212;
  91 const wxEventType wxEVT_CHAR_HOOK =                         wxEVT_FIRST + 213;
  92 const wxEventType wxEVT_NAVIGATION_KEY =                    wxEVT_FIRST + 214;
  93 const wxEventType wxEVT_KEY_DOWN =                          wxEVT_FIRST + 215;
  94 const wxEventType wxEVT_KEY_UP =                            wxEVT_FIRST + 216;
  95
  96  /*
  97   * wxScrollbar and wxSlider event identifiers
  98   */
  99 const wxEventType wxEVT_SCROLL_TOP =                        wxEVT_FIRST + 300;
 100 const wxEventType wxEVT_SCROLL_BOTTOM =                     wxEVT_FIRST + 301;
 101 const wxEventType wxEVT_SCROLL_LINEUP =                     wxEVT_FIRST + 302;
 102 const wxEventType wxEVT_SCROLL_LINEDOWN =                   wxEVT_FIRST + 303;
 103 const wxEventType wxEVT_SCROLL_PAGEUP =                     wxEVT_FIRST + 304;
 104 const wxEventType wxEVT_SCROLL_PAGEDOWN =                   wxEVT_FIRST + 305;
 105 const wxEventType wxEVT_SCROLL_THUMBTRACK =                 wxEVT_FIRST + 306;
 106
 107  /*
 108   * Scroll events from wxWindow
 109   */
 110 const wxEventType wxEVT_SCROLLWIN_TOP =                     wxEVT_FIRST + 320;
 111 const wxEventType wxEVT_SCROLLWIN_BOTTOM =                  wxEVT_FIRST + 321;
 112 const wxEventType wxEVT_SCROLLWIN_LINEUP =                  wxEVT_FIRST + 322;
 113 const wxEventType wxEVT_SCROLLWIN_LINEDOWN =                wxEVT_FIRST + 323;
 114 const wxEventType wxEVT_SCROLLWIN_PAGEUP =                  wxEVT_FIRST + 324;
 115 const wxEventType wxEVT_SCROLLWIN_PAGEDOWN =                wxEVT_FIRST + 325;
 116 const wxEventType wxEVT_SCROLLWIN_THUMBTRACK =              wxEVT_FIRST + 326;
 117
 118  /*
 119   * System events
 120   */
 121 const wxEventType wxEVT_SIZE =                              wxEVT_FIRST + 400;
 122 const wxEventType wxEVT_MOVE =                              wxEVT_FIRST + 401;
 123 const wxEventType wxEVT_CLOSE_WINDOW =                      wxEVT_FIRST + 402;
 124 const wxEventType wxEVT_END_SESSION =                       wxEVT_FIRST + 403;
 125 const wxEventType wxEVT_QUERY_END_SESSION =                 wxEVT_FIRST + 404;
 126 const wxEventType wxEVT_ACTIVATE_APP =                      wxEVT_FIRST + 405;
 127 const wxEventType wxEVT_POWER =                             wxEVT_FIRST + 406;
 128 const wxEventType wxEVT_ACTIVATE =                          wxEVT_FIRST + 409;
 129 const wxEventType wxEVT_CREATE =                            wxEVT_FIRST + 410;
 130 const wxEventType wxEVT_DESTROY =                           wxEVT_FIRST + 411;
 131 const wxEventType wxEVT_SHOW =                              wxEVT_FIRST + 412;
 132 const wxEventType wxEVT_ICONIZE =                           wxEVT_FIRST + 413;
 133 const wxEventType wxEVT_MAXIMIZE =                          wxEVT_FIRST + 414;
 134 const wxEventType wxEVT_MOUSE_CAPTURE_CHANGED =             wxEVT_FIRST + 415;
 135 const wxEventType wxEVT_PAINT =                             wxEVT_FIRST + 416;
 136 const wxEventType wxEVT_ERASE_BACKGROUND =                  wxEVT_FIRST + 417;
 137 const wxEventType wxEVT_NC_PAINT =                          wxEVT_FIRST + 418;
 138 const wxEventType wxEVT_PAINT_ICON =                        wxEVT_FIRST + 419;
 139 const wxEventType wxEVT_MENU_CHAR =                         wxEVT_FIRST + 420;
 140 const wxEventType wxEVT_MENU_INIT =                         wxEVT_FIRST + 421;
 141 const wxEventType wxEVT_MENU_HIGHLIGHT =                    wxEVT_FIRST + 422;
 142 const wxEventType wxEVT_POPUP_MENU_INIT =                   wxEVT_FIRST + 423;
 143 const wxEventType wxEVT_CONTEXT_MENU =                      wxEVT_FIRST + 424;
 144 const wxEventType wxEVT_SYS_COLOUR_CHANGED =                wxEVT_FIRST + 425;
 145 const wxEventType wxEVT_SETTING_CHANGED =                   wxEVT_FIRST + 426;
 146 const wxEventType wxEVT_QUERY_NEW_PALETTE =                 wxEVT_FIRST + 427;
 147 const wxEventType wxEVT_PALETTE_CHANGED =                   wxEVT_FIRST + 428;
 148 const wxEventType wxEVT_JOY_BUTTON_DOWN =                   wxEVT_FIRST + 429;
 149 const wxEventType wxEVT_JOY_BUTTON_UP =                     wxEVT_FIRST + 430;
 150 const wxEventType wxEVT_JOY_MOVE =                          wxEVT_FIRST + 431;
 151 const wxEventType wxEVT_JOY_ZMOVE =                         wxEVT_FIRST + 432;
 152 const wxEventType wxEVT_DROP_FILES =                        wxEVT_FIRST + 433;
 153 const wxEventType wxEVT_DRAW_ITEM =                         wxEVT_FIRST + 434;
 154 const wxEventType wxEVT_MEASURE_ITEM =                      wxEVT_FIRST + 435;
 155 const wxEventType wxEVT_COMPARE_ITEM =                      wxEVT_FIRST + 436;
 156 const wxEventType wxEVT_INIT_DIALOG =                       wxEVT_FIRST + 437;
 157 const wxEventType wxEVT_IDLE =                              wxEVT_FIRST + 438;
 158 const wxEventType wxEVT_UPDATE_UI =                         wxEVT_FIRST + 439;
 159  /* System misc. */
 160 const wxEventType wxEVT_END_PROCESS =                       wxEVT_FIRST + 440;
 161
 162  /* Generic command events */
 163  /* Note: a click is a higher-level event than button down/up */
 164 const wxEventType wxEVT_COMMAND_LEFT_CLICK =                wxEVT_FIRST + 500;
 165 const wxEventType wxEVT_COMMAND_LEFT_DCLICK =               wxEVT_FIRST + 501;
 166 const wxEventType wxEVT_COMMAND_RIGHT_CLICK =               wxEVT_FIRST + 502;
 167 const wxEventType wxEVT_COMMAND_RIGHT_DCLICK =              wxEVT_FIRST + 503;
 168 const wxEventType wxEVT_COMMAND_SET_FOCUS =                 wxEVT_FIRST + 504;
 169 const wxEventType wxEVT_COMMAND_KILL_FOCUS =                wxEVT_FIRST + 505;
 170 const wxEventType wxEVT_COMMAND_ENTER =                     wxEVT_FIRST + 506;
 171
 172  /* Tree control event types */
 173 const wxEventType wxEVT_COMMAND_TREE_BEGIN_DRAG =           wxEVT_FIRST + 600;
 174 const wxEventType wxEVT_COMMAND_TREE_BEGIN_RDRAG =          wxEVT_FIRST + 601;
 175 const wxEventType wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT =     wxEVT_FIRST + 602;
 176 const wxEventType wxEVT_COMMAND_TREE_END_LABEL_EDIT =       wxEVT_FIRST + 603;
 177 const wxEventType wxEVT_COMMAND_TREE_DELETE_ITEM =          wxEVT_FIRST + 604;
 178 const wxEventType wxEVT_COMMAND_TREE_GET_INFO =             wxEVT_FIRST + 605;
 179 const wxEventType wxEVT_COMMAND_TREE_SET_INFO =             wxEVT_FIRST + 606;
 180 const wxEventType wxEVT_COMMAND_TREE_ITEM_EXPANDED =        wxEVT_FIRST + 607;
 181 const wxEventType wxEVT_COMMAND_TREE_ITEM_EXPANDING =       wxEVT_FIRST + 608;
 182 const wxEventType wxEVT_COMMAND_TREE_ITEM_COLLAPSED =       wxEVT_FIRST + 609;
 183 const wxEventType wxEVT_COMMAND_TREE_ITEM_COLLAPSING =      wxEVT_FIRST + 610;
 184 const wxEventType wxEVT_COMMAND_TREE_SEL_CHANGED =          wxEVT_FIRST + 611;
 185 const wxEventType wxEVT_COMMAND_TREE_SEL_CHANGING =         wxEVT_FIRST + 612;
 186 const wxEventType wxEVT_COMMAND_TREE_KEY_DOWN =             wxEVT_FIRST + 613;
 187 const wxEventType wxEVT_COMMAND_TREE_ITEM_ACTIVATED =       wxEVT_FIRST + 614;
 188
 189  /* List control event types */
 190 const wxEventType wxEVT_COMMAND_LIST_BEGIN_DRAG =           wxEVT_FIRST + 700;
 191 const wxEventType wxEVT_COMMAND_LIST_BEGIN_RDRAG =          wxEVT_FIRST + 701;
 192 const wxEventType wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT =     wxEVT_FIRST + 702;
 193 const wxEventType wxEVT_COMMAND_LIST_END_LABEL_EDIT =       wxEVT_FIRST + 703;
 194 const wxEventType wxEVT_COMMAND_LIST_DELETE_ITEM =          wxEVT_FIRST + 704;
 195 const wxEventType wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS =     wxEVT_FIRST + 705;
 196 const wxEventType wxEVT_COMMAND_LIST_GET_INFO =             wxEVT_FIRST + 706;
 197 const wxEventType wxEVT_COMMAND_LIST_SET_INFO =             wxEVT_FIRST + 707;
 198 const wxEventType wxEVT_COMMAND_LIST_ITEM_SELECTED =        wxEVT_FIRST + 708;
 199 const wxEventType wxEVT_COMMAND_LIST_ITEM_DESELECTED =      wxEVT_FIRST + 709;
 200 const wxEventType wxEVT_COMMAND_LIST_KEY_DOWN =             wxEVT_FIRST + 710;
 201 const wxEventType wxEVT_COMMAND_LIST_INSERT_ITEM =          wxEVT_FIRST + 711;
 202 const wxEventType wxEVT_COMMAND_LIST_COL_CLICK =            wxEVT_FIRST + 712;
 203 const wxEventType wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK =     wxEVT_FIRST + 713;
 204 const wxEventType wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK =    wxEVT_FIRST + 714;
 205 const wxEventType wxEVT_COMMAND_LIST_ITEM_ACTIVATED =       wxEVT_FIRST + 715;
 206
 207  /* Tab and notebook control event types */
 208 const wxEventType wxEVT_COMMAND_TAB_SEL_CHANGED =           wxEVT_FIRST + 800;
 209 const wxEventType wxEVT_COMMAND_TAB_SEL_CHANGING =          wxEVT_FIRST + 801;
 210
 211 #if defined(__BORLANDC__) && defined(__WIN16__)
 212 /* For 16-bit BC++, these 2 are identical (truncated) */
 213 const wxEventType wxEVT_COMMAND_NB_PAGE_CHANGED =     wxEVT_FIRST + 802;
 214 const wxEventType wxEVT_COMMAND_NB_PAGE_CHANGING =    wxEVT_FIRST + 803;
 215 #else
 216 const wxEventType wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED =     wxEVT_FIRST + 802;
 217 const wxEventType wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING =    wxEVT_FIRST + 803;
 218 #endif
 219
 220 const wxEventType wxEVT_USER_FIRST =                        wxEVT_FIRST + 2000;
 221
 222 /* Compatibility */
 223
 224 #if WXWIN_COMPATIBILITY
 225
 226 #define wxEVENT_TYPE_BUTTON_COMMAND             wxEVT_COMMAND_BUTTON_CLICKED
 227 #define wxEVENT_TYPE_CHECKBOX_COMMAND           wxEVT_COMMAND_CHECKBOX_CLICKED
 228 #define wxEVENT_TYPE_CHOICE_COMMAND             wxEVT_COMMAND_CHOICE_SELECTED
 229 #define wxEVENT_TYPE_LISTBOX_COMMAND            wxEVT_COMMAND_LISTBOX_SELECTED
 230 #define wxEVENT_TYPE_LISTBOX_DCLICK_COMMAND     wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
 231 #define wxEVENT_TYPE_TEXT_COMMAND               wxEVT_COMMAND_TEXT_UPDATED
 232 #define wxEVENT_TYPE_MULTITEXT_COMMAND          wxEVT_COMMAND_TEXT_UPDATED
 233 #define wxEVENT_TYPE_MENU_COMMAND               wxEVT_COMMAND_MENU_SELECTED
 234 #define wxEVENT_TYPE_SLIDER_COMMAND             wxEVT_COMMAND_SLIDER_UPDATED
 235 #define wxEVENT_TYPE_RADIOBOX_COMMAND           wxEVT_COMMAND_RADIOBOX_SELECTED
 236 #define wxEVENT_TYPE_RADIOBUTTON_COMMAND        wxEVT_COMMAND_RADIOBUTTON_SELECTED
 237 #define wxEVENT_TYPE_TEXT_ENTER_COMMAND         wxEVT_COMMAND_TEXT_ENTER
 238 #define wxEVENT_TYPE_SET_FOCUS                  wxEVT_SET_FOCUS
 239 #define wxEVENT_TYPE_KILL_FOCUS                 wxEVT_KILL_FOCUS
 240 #define wxEVENT_TYPE_SCROLLBAR_COMMAND          wxEVT_COMMAND_SCROLLBAR_UPDATED
 241 #define wxEVENT_TYPE_VIRT_LISTBOX_COMMAND       wxEVT_COMMAND_VLBOX_SELECTED
 242 #define wxEVENT_TYPE_COMBOBOX_COMMAND           wxEVT_COMMAND_COMBOBOX_SELECTED
 243
 244 #define wxEVENT_TYPE_LEFT_DOWN                  wxEVT_LEFT_DOWN
 245 #define wxEVENT_TYPE_LEFT_UP                    wxEVT_LEFT_UP
 246 #define wxEVENT_TYPE_MIDDLE_DOWN                wxEVT_MIDDLE_DOWN
 247 #define wxEVENT_TYPE_MIDDLE_UP                  wxEVT_MIDDLE_UP
 248 #define wxEVENT_TYPE_RIGHT_DOWN                 wxEVT_RIGHT_DOWN
 249 #define wxEVENT_TYPE_RIGHT_UP                   wxEVT_RIGHT_UP
 250 #define wxEVENT_TYPE_MOTION                     wxEVT_MOTION
 251 #define wxEVENT_TYPE_ENTER_WINDOW               wxEVT_ENTER_WINDOW
 252 #define wxEVENT_TYPE_LEAVE_WINDOW               wxEVT_LEAVE_WINDOW
 253 #define wxEVENT_TYPE_LEFT_DCLICK                wxEVT_LEFT_DCLICK
 254 #define wxEVENT_TYPE_MIDDLE_DCLICK              wxEVT_MIDDLE_DCLICK
 255 #define wxEVENT_TYPE_RIGHT_DCLICK               wxEVT_RIGHT_DCLICK
 256 #define wxEVENT_TYPE_CHAR                       wxEVT_CHAR
 257 #define wxEVENT_TYPE_SCROLL_TOP                 wxEVT_SCROLL_TOP
 258 #define wxEVENT_TYPE_SCROLL_BOTTOM              wxEVT_SCROLL_BOTTOM
 259 #define wxEVENT_TYPE_SCROLL_LINEUP              wxEVT_SCROLL_LINEUP
 260 #define wxEVENT_TYPE_SCROLL_LINEDOWN            wxEVT_SCROLL_LINEDOWN
 261 #define wxEVENT_TYPE_SCROLL_PAGEUP              wxEVT_SCROLL_PAGEUP
 262 #define wxEVENT_TYPE_SCROLL_PAGEDOWN            wxEVT_SCROLL_PAGEDOWN
 263 #define wxEVENT_TYPE_SCROLL_THUMBTRACK          wxEVT_SCROLL_THUMBTRACK
 264
 265 #endif // WXWIN_COMPATIBILITY
 266
 267 /*
 268  * wxWindows events, covering all interesting things that might happen
 269  * (button clicking, resizing, setting text in widgets, etc.).
 270  *
 271  * For each completely new event type, derive a new event class.
 272  * An event CLASS represents a C++ class defining a range of similar event TYPES;
 273  * examples are canvas events, panel item command events.
 274  * An event TYPE is a unique identifier for a particular system event,
 275  * such as a button press or a listbox deselection.
 276  *
 277  */
 278
 279 class WXDLLEXPORT wxEvent : public wxObject
 280 {
 281     DECLARE_ABSTRACT_CLASS(wxEvent)
 282
 283 public:
 284     wxEvent(int id = 0);
 285     ~wxEvent() {}
 286
 287     void SetEventType(wxEventType typ) { m_eventType = typ; }
 288     wxEventType GetEventType() const { return m_eventType; }
 289     wxObject *GetEventObject() const { return m_eventObject; }
 290     void SetEventObject(wxObject *obj) { m_eventObject = obj; }
 291     long GetTimestamp() const { return m_timeStamp; }
 292     void SetTimestamp(long ts = 0) { m_timeStamp = ts; }
 293     int GetId() const { return m_id; }
 294     void SetId(int Id) { m_id = Id; }
 295
 296     // Can instruct event processor that we wish to ignore this event
 297     // (treat as if the event table entry had not been found): this must be done
 298     // to allow the event processing by the base classes (calling event.Skip()
 299     // is the analog of calling the base class verstion of a virtual function)
 300     void Skip(bool skip = TRUE) { m_skipped = skip; }
 301     bool GetSkipped() const { return m_skipped; };
 302
 303     // implementation only: this test is explicitlty anti OO and this functions
 304     // exists only for optimization purposes
 305     bool IsCommandEvent() const { return m_isCommandEvent; }
 306
 307     void CopyObject(wxObject& object_dest) const;
 308
 309 public:
 310     bool              m_skipped;
 311     wxObject*         m_eventObject;
 312     char*             m_eventHandle;         // Handle of an underlying windowing system event
 313     wxEventType       m_eventType;
 314     long              m_timeStamp;
 315     int               m_id;
 316     wxObject*         m_callbackUserData;
 317
 318     // optimization: instead of using costly IsKindOf() we keep a flag telling
 319     // whether we're a command event (by far the most common case)
 320     bool              m_isCommandEvent;
 321 };
 322
 323 // Item or menu event class
 324 /*
 325  wxEVT_COMMAND_BUTTON_CLICKED
 326  wxEVT_COMMAND_CHECKBOX_CLICKED
 327  wxEVT_COMMAND_CHOICE_SELECTED
 328  wxEVT_COMMAND_LISTBOX_SELECTED
 329  wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
 330  wxEVT_COMMAND_TEXT_UPDATED
 331  wxEVT_COMMAND_TEXT_ENTER
 332  wxEVT_COMMAND_MENU_SELECTED
 333  wxEVT_COMMAND_SLIDER_UPDATED
 334  wxEVT_COMMAND_RADIOBOX_SELECTED
 335  wxEVT_COMMAND_RADIOBUTTON_SELECTED
 336  wxEVT_COMMAND_SCROLLBAR_UPDATED
 337  wxEVT_COMMAND_VLBOX_SELECTED
 338  wxEVT_COMMAND_COMBOBOX_SELECTED
 339 */
 340
 341 class WXDLLEXPORT wxClientData;
 342
 343 class WXDLLEXPORT wxCommandEvent : public wxEvent
 344 {
 345     DECLARE_DYNAMIC_CLASS(wxCommandEvent)
 346
 347 public:
 348     wxCommandEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
 349     ~wxCommandEvent() {}
 350
 351     /*
 352      * Accessors dependent on context
 353      *
 354      */
 355
 356     // Set/Get client data from controls
 357     void SetClientData(void* clientData) { m_clientData = clientData; }
 358     void *GetClientData() const { return m_clientData; }
 359
 360     // Set/Get client object from controls
 361     void SetClientObject(wxClientData* clientObject) { m_clientObject = clientObject; }
 362     void *GetClientObject() const { return m_clientObject; }
 363
 364     // Get listbox selection if single-choice
 365     int GetSelection() const { return m_commandInt; }
 366
 367     // Set/Get listbox/choice selection string
 368     void SetString(const wxString& s) { m_commandString = s; }
 369     wxString GetString() const { return m_commandString; }
 370
 371     // Get checkbox value
 372     bool Checked() const { return (m_commandInt != 0); }
 373
 374     // TRUE if the listbox event was a selection.
 375     bool IsSelection() const { return (m_extraLong != 0); }
 376
 377     void SetExtraLong(long extraLong) { m_extraLong = extraLong; }
 378     long GetExtraLong() const { return m_extraLong ; }
 379
 380     void SetInt(int i) { m_commandInt = i; }
 381     long GetInt() const { return m_commandInt ; }
 382
 383     void CopyObject(wxObject& obj) const;
 384
 385 public:
 386     wxString          m_commandString; // String event argument
 387     int               m_commandInt;
 388     long              m_extraLong;     // Additional information (e.g. select/deselect)
 389     void*             m_clientData;    // Arbitrary client data
 390     wxClientData*     m_clientObject;  // Arbitrary client object
 391 };
 392
 393 // this class adds a possibility to react (from the user) code to a control
 394 // notification: allow or veto the operation being reported.
 395 class WXDLLEXPORT wxNotifyEvent  : public wxCommandEvent
 396 {
 397 public:
 398     wxNotifyEvent(wxEventType commandType = wxEVT_NULL, int id = 0)
 399                 : wxCommandEvent(commandType, id) { m_bAllow = TRUE; }
 400
 401     // veto the operation (by default it's allowed)
 402     void Veto() { m_bAllow = FALSE; }
 403
 404     // for implementation code only: is the operation allowed?
 405     bool IsAllowed() const { return m_bAllow; }
 406
 407 private:
 408     bool m_bAllow;
 409
 410     DECLARE_DYNAMIC_CLASS(wxNotifyEvent)
 411 };
 412
 413 // Scroll event class, derived form wxCommandEvent. wxScrollEvents are
 414 // sent by wxSlider and wxScrollbar.
 415 /*
 416  wxEVT_SCROLL_TOP
 417  wxEVT_SCROLL_BOTTOM
 418  wxEVT_SCROLL_LINEUP
 419  wxEVT_SCROLL_LINEDOWN
 420  wxEVT_SCROLL_PAGEUP
 421  wxEVT_SCROLL_PAGEDOWN
 422  wxEVT_SCROLL_THUMBTRACK
 423 */
 424
 425 class WXDLLEXPORT wxScrollEvent : public wxCommandEvent
 426 {
 427     DECLARE_DYNAMIC_CLASS(wxScrollEvent)
 428
 429 public:
 430     wxScrollEvent(wxEventType commandType = wxEVT_NULL,
 431                   int id = 0, int pos = 0, int orient = 0);
 432     ~wxScrollEvent() {}
 433
 434     /*
 435      * Accessors
 436      *
 437      */
 438
 439     int GetOrientation() const { return (int) m_extraLong ; }
 440     int GetPosition() const { return m_commandInt ; }
 441     void SetOrientation(int orient) { m_extraLong = (long) orient; }
 442     void SetPosition(int pos) { m_commandInt = pos; }
 443 };
 444
 445 // ScrollWin event class, derived fom wxEvent. wxScrollWinEvents
 446 // are sent by wxWindow.
 447 /*
 448  wxEVT_SCROLLWIN_TOP
 449  wxEVT_SCROLLWIN_BOTTOM
 450  wxEVT_SCROLLWIN_LINEUP
 451  wxEVT_SCROLLWIN_LINEDOWN
 452  wxEVT_SCROLLWIN_PAGEUP
 453  wxEVT_SCROLLWIN_PAGEDOWN
 454  wxEVT_SCROLLWIN_THUMBTRACK
 455 */
 456
 457 class WXDLLEXPORT wxScrollWinEvent : public wxEvent
 458 {
 459     DECLARE_DYNAMIC_CLASS(wxScrollWinEvent)
 460
 461 public:
 462     wxScrollWinEvent(wxEventType commandType = wxEVT_NULL,
 463                      int pos = 0, int orient = 0);
 464     ~wxScrollWinEvent() {}
 465
 466     /*
 467      * Accessors
 468      */
 469
 470     int GetOrientation() const { return (int) m_extraLong ; }
 471     int GetPosition() const { return m_commandInt ; }
 472     void SetOrientation(int orient) { m_extraLong = (long) orient; }
 473     void SetPosition(int pos) { m_commandInt = pos; }
 474
 475 public:
 476     int               m_commandInt;    // Additional information
 477     long              m_extraLong;
 478 };
 479
 480 // Mouse event class
 481
 482 /*
 483  wxEVT_LEFT_DOWN
 484  wxEVT_LEFT_UP
 485  wxEVT_MIDDLE_DOWN
 486  wxEVT_MIDDLE_UP
 487  wxEVT_RIGHT_DOWN
 488  wxEVT_RIGHT_UP
 489  wxEVT_MOTION
 490  wxEVT_ENTER_WINDOW
 491  wxEVT_LEAVE_WINDOW
 492  wxEVT_LEFT_DCLICK
 493  wxEVT_MIDDLE_DCLICK
 494  wxEVT_RIGHT_DCLICK
 495  wxEVT_NC_LEFT_DOWN
 496  wxEVT_NC_LEFT_UP,
 497  wxEVT_NC_MIDDLE_DOWN,
 498  wxEVT_NC_MIDDLE_UP,
 499  wxEVT_NC_RIGHT_DOWN,
 500  wxEVT_NC_RIGHT_UP,
 501  wxEVT_NC_MOTION,
 502  wxEVT_NC_ENTER_WINDOW,
 503  wxEVT_NC_LEAVE_WINDOW,
 504  wxEVT_NC_LEFT_DCLICK,
 505  wxEVT_NC_MIDDLE_DCLICK,
 506  wxEVT_NC_RIGHT_DCLICK,
 507 */
 508
 509 class WXDLLEXPORT wxDC;
 510 class WXDLLEXPORT wxMouseEvent : public wxEvent
 511 {
 512     DECLARE_DYNAMIC_CLASS(wxMouseEvent)
 513
 514 public:
 515     wxMouseEvent(wxEventType mouseType = wxEVT_NULL);
 516
 517     // Was it a button event? (*doesn't* mean: is any button *down*?)
 518     bool IsButton() const { return Button(-1); }
 519
 520     // Was it a down event from button 1, 2 or 3 or any?
 521     bool ButtonDown(int but = -1) const;
 522
 523     // Was it a dclick event from button 1, 2 or 3 or any?
 524     bool ButtonDClick(int but = -1) const;
 525
 526     // Was it a up event from button 1, 2 or 3 or any?
 527     bool ButtonUp(int but = -1) const;
 528
 529     // Was the given button 1,2,3 or any changing state?
 530     bool Button(int but) const;
 531
 532     // Was the given button 1,2,3 or any in Down state?
 533     bool ButtonIsDown(int but) const;
 534
 535     // Find state of shift/control keys
 536     bool ControlDown() const { return m_controlDown; }
 537     bool MetaDown() const { return m_metaDown; }
 538     bool AltDown() const { return m_altDown; }
 539     bool ShiftDown() const { return m_shiftDown; }
 540
 541     // Find which event was just generated
 542     bool LeftDown() const { return (m_eventType == wxEVT_LEFT_DOWN); }
 543     bool MiddleDown() const { return (m_eventType == wxEVT_MIDDLE_DOWN); }
 544     bool RightDown() const { return (m_eventType == wxEVT_RIGHT_DOWN); }
 545
 546     bool LeftUp() const { return (m_eventType == wxEVT_LEFT_UP); }
 547     bool MiddleUp() const { return (m_eventType == wxEVT_MIDDLE_UP); }
 548     bool RightUp() const { return (m_eventType == wxEVT_RIGHT_UP); }
 549
 550     bool LeftDClick() const { return (m_eventType == wxEVT_LEFT_DCLICK); }
 551     bool MiddleDClick() const { return (m_eventType == wxEVT_MIDDLE_DCLICK); }
 552     bool RightDClick() const { return (m_eventType == wxEVT_RIGHT_DCLICK); }
 553
 554     // Find the current state of the mouse buttons (regardless
 555     // of current event type)
 556     bool LeftIsDown() const { return m_leftDown; }
 557     bool MiddleIsDown() const { return m_middleDown; }
 558     bool RightIsDown() const { return m_rightDown; }
 559
 560     // True if a button is down and the mouse is moving
 561     bool Dragging() const
 562     {
 563         return ((m_eventType == wxEVT_MOTION) &&
 564                 (LeftIsDown() || MiddleIsDown() || RightIsDown()));
 565     }
 566
 567     // True if the mouse is moving, and no button is down
 568     bool Moving() const { return (m_eventType == wxEVT_MOTION); }
 569
 570     // True if the mouse is just entering the window
 571     bool Entering() const { return (m_eventType == wxEVT_ENTER_WINDOW); }
 572
 573     // True if the mouse is just leaving the window
 574     bool Leaving() const { return (m_eventType == wxEVT_LEAVE_WINDOW); }
 575
 576     // Find the position of the event
 577     void GetPosition(long *xpos, long *ypos) const { *xpos = m_x; *ypos = m_y; }
 578     void Position(long *xpos, long *ypos) const { *xpos = m_x; *ypos = m_y; }
 579
 580     // Find the position of the event
 581     wxPoint GetPosition() const { return wxPoint(m_x, m_y); }
 582
 583     // Find the logical position of the event given the DC
 584     wxPoint GetLogicalPosition(const wxDC& dc) const ;
 585
 586     // Compatibility
 587 #if WXWIN_COMPATIBILITY
 588     void Position(float *xpos, float *ypos) const
 589     {
 590         *xpos = (float) m_x; *ypos = (float) m_y;
 591     }
 592 #endif // WXWIN_COMPATIBILITY
 593
 594     // Get X position
 595     long GetX() const { return m_x; }
 596
 597     // Get Y position
 598     long GetY() const { return m_y; }
 599
 600     void CopyObject(wxObject& obj) const;
 601
 602 public:
 603     long          m_x;
 604     long          m_y;
 605     bool          m_leftDown;
 606     bool          m_middleDown;
 607     bool          m_rightDown;
 608
 609     bool          m_controlDown;
 610     bool          m_shiftDown;
 611     bool          m_altDown;
 612     bool          m_metaDown;
 613 };
 614
 615 // Keyboard input event class
 616
 617 /*
 618  wxEVT_CHAR
 619  wxEVT_CHAR_HOOK
 620  wxEVT_KEY_DOWN
 621  wxEVT_KEY_UP
 622  */
 623
 624 class WXDLLEXPORT wxKeyEvent : public wxEvent
 625 {
 626     DECLARE_DYNAMIC_CLASS(wxKeyEvent)
 627
 628 public:
 629     wxKeyEvent(wxEventType keyType = wxEVT_NULL);
 630
 631     // Find state of shift/control keys
 632     bool ControlDown() const { return m_controlDown; }
 633     bool MetaDown() const { return m_metaDown; }
 634     bool AltDown() const { return m_altDown; }
 635     bool ShiftDown() const { return m_shiftDown; }
 636     long KeyCode() const { return m_keyCode; }
 637
 638     // Find the position of the event
 639     void GetPosition(long *xpos, long *ypos) const
 640         { *xpos = m_x; *ypos = m_y; }
 641
 642     wxPoint GetPosition() const
 643         { return wxPoint(m_x, m_y); }
 644
 645     // Get X position
 646     long GetX() const { return m_x; }
 647
 648     // Get Y position
 649     long GetY() const { return m_y; }
 650
 651     void CopyObject(wxObject& obj) const;
 652
 653 public:
 654     long          m_x;
 655     long          m_y;
 656     long          m_keyCode;
 657     bool          m_controlDown;
 658     bool          m_shiftDown;
 659     bool          m_altDown;
 660     bool          m_metaDown;
 661 };
 662
 663 // Size event class
 664 /*
 665  wxEVT_SIZE
 666  */
 667
 668 class WXDLLEXPORT wxSizeEvent : public wxEvent
 669 {
 670     DECLARE_DYNAMIC_CLASS(wxSizeEvent)
 671
 672 public:
 673     wxSize m_size;
 674
 675     wxSizeEvent() { m_eventType = wxEVT_SIZE; }
 676     wxSizeEvent(const wxSize& sz, int id = 0)
 677         : m_size(sz)
 678         { m_eventType = wxEVT_SIZE; m_id = id; }
 679
 680     wxSize GetSize() const { return m_size; }
 681
 682     void CopyObject(wxObject& obj) const;
 683 };
 684
 685 // Move event class
 686
 687 /*
 688  wxEVT_MOVE
 689  */
 690
 691 class WXDLLEXPORT wxMoveEvent : public wxEvent
 692 {
 693     DECLARE_DYNAMIC_CLASS(wxMoveEvent)
 694
 695 public:
 696     wxPoint m_pos;
 697
 698     wxMoveEvent() { m_eventType = wxEVT_MOVE; }
 699     wxMoveEvent(const wxPoint& pos, int id = 0)
 700         : m_pos(pos)
 701         { m_eventType = wxEVT_MOVE; m_id = id; }
 702
 703     wxPoint GetPosition() const { return m_pos; }
 704
 705     void CopyObject(wxObject& obj) const;
 706 };
 707
 708 // Paint event class
 709 /*
 710  wxEVT_PAINT
 711  wxEVT_NC_PAINT
 712  wxEVT_PAINT_ICON
 713  */
 714
 715 class WXDLLEXPORT wxPaintEvent : public wxEvent
 716 {
 717     DECLARE_DYNAMIC_CLASS(wxPaintEvent)
 718
 719 public:
 720     wxPaintEvent(int Id = 0) { m_eventType = wxEVT_PAINT; m_id = Id; }
 721 };
 722
 723 // Erase background event class
 724 /*
 725  wxEVT_ERASE_BACKGROUND
 726  */
 727
 728 class WXDLLEXPORT wxDC;
 729 class WXDLLEXPORT wxEraseEvent : public wxEvent
 730 {
 731     DECLARE_DYNAMIC_CLASS(wxEraseEvent)
 732
 733 public:
 734     wxDC *m_dc;
 735
 736     wxEraseEvent(int Id = 0, wxDC *dc = (wxDC *) NULL)
 737         { m_eventType = wxEVT_ERASE_BACKGROUND; m_id = Id; m_dc = dc; }
 738     wxDC *GetDC() const { return m_dc; }
 739
 740     void CopyObject(wxObject& obj) const;
 741 };
 742
 743 // Focus event class
 744 /*
 745  wxEVT_SET_FOCUS
 746  wxEVT_KILL_FOCUS
 747  */
 748
 749 class WXDLLEXPORT wxFocusEvent : public wxEvent
 750 {
 751     DECLARE_DYNAMIC_CLASS(wxFocusEvent)
 752
 753 public:
 754     wxFocusEvent(wxEventType type = wxEVT_NULL, int Id = 0)
 755         { m_eventType = type; m_id = Id; }
 756 };
 757
 758 // Activate event class
 759 /*
 760  wxEVT_ACTIVATE
 761  wxEVT_ACTIVATE_APP
 762  */
 763
 764 class WXDLLEXPORT wxActivateEvent : public wxEvent
 765 {
 766     DECLARE_DYNAMIC_CLASS(wxActivateEvent)
 767
 768 public:
 769     wxActivateEvent(wxEventType type = wxEVT_NULL, bool active = TRUE, int Id = 0)
 770         { m_eventType = type; m_active = active; m_id = Id; }
 771     bool GetActive() const { return m_active; }
 772
 773     void CopyObject(wxObject& obj) const;
 774
 775 private:
 776     bool m_active;
 777 };
 778
 779 // InitDialog event class
 780 /*
 781  wxEVT_INIT_DIALOG
 782  */
 783
 784 class WXDLLEXPORT wxInitDialogEvent : public wxEvent
 785 {
 786     DECLARE_DYNAMIC_CLASS(wxInitDialogEvent)
 787
 788 public:
 789     wxInitDialogEvent(int Id = 0)
 790         { m_eventType = wxEVT_INIT_DIALOG; m_id = Id; }
 791 };
 792
 793 // Miscellaneous menu event class
 794 /*
 795  wxEVT_MENU_CHAR,
 796  wxEVT_MENU_INIT,
 797  wxEVT_MENU_HIGHLIGHT,
 798  wxEVT_POPUP_MENU_INIT,
 799  wxEVT_CONTEXT_MENU,
 800 */
 801
 802 class WXDLLEXPORT wxMenuEvent : public wxEvent
 803 {
 804     DECLARE_DYNAMIC_CLASS(wxMenuEvent)
 805
 806 public:
 807     wxMenuEvent(wxEventType type = wxEVT_NULL, int id = 0)
 808       { m_eventType = type; m_menuId = id; }
 809
 810     int GetMenuId() const { return m_menuId; }
 811
 812     void CopyObject(wxObject& obj) const;
 813 private:
 814     int m_menuId;
 815 };
 816
 817 // Window close or session close event class
 818 /*
 819  wxEVT_CLOSE_WINDOW,
 820  wxEVT_END_SESSION,
 821  wxEVT_QUERY_END_SESSION
 822  */
 823
 824 class WXDLLEXPORT wxCloseEvent : public wxEvent
 825 {
 826     DECLARE_DYNAMIC_CLASS(wxCloseEvent)
 827
 828 public:
 829     wxCloseEvent(wxEventType type = wxEVT_NULL, int id = 0)
 830     {
 831         m_eventType = type;
 832         m_loggingOff = TRUE;
 833         m_veto = FALSE;         // should be FALSE by default
 834         m_id = id;
 835 #if WXWIN_COMPATIBILITY
 836         m_force = FALSE;
 837 #endif // WXWIN_COMPATIBILITY
 838         m_canVeto = TRUE;
 839     }
 840
 841     void SetLoggingOff(bool logOff) { m_loggingOff = logOff; }
 842     bool GetLoggingOff() const { return m_loggingOff; }
 843
 844     void Veto(bool veto = TRUE)
 845     {
 846         // GetVeto() will return FALSE anyhow...
 847         wxCHECK_RET( m_canVeto,
 848                      _T("call to Veto() ignored (can't veto this event)") );
 849
 850         m_veto = veto;
 851     }
 852     void SetCanVeto(bool canVeto) { m_canVeto = canVeto; }
 853     // No more asserts here please, the one you put here was wrong.
 854     bool CanVeto() const { return m_canVeto; }
 855     bool GetVeto() const { return m_canVeto && m_veto; }
 856
 857 #if WXWIN_COMPATIBILITY
 858     // This is probably obsolete now, since we use CanVeto instead, in
 859     // both OnCloseWindow and OnQueryEndSession.
 860     // m_force == ! m_canVeto i.e., can't veto means we must force it to close.
 861     void SetForce(bool force) { m_force = force; }
 862     bool GetForce() const { return m_force; }
 863 #endif
 864
 865     void CopyObject(wxObject& obj) const;
 866
 867 protected:
 868     bool m_loggingOff;
 869     bool m_veto, m_canVeto;
 870
 871 #if WXWIN_COMPATIBILITY
 872     bool m_force;
 873 #endif
 874 };
 875
 876 /*
 877  wxEVT_SHOW
 878  */
 879
 880 class WXDLLEXPORT wxShowEvent : public wxEvent
 881 {
 882     DECLARE_DYNAMIC_CLASS(wxShowEvent)
 883
 884 public:
 885
 886     wxShowEvent(int id = 0, bool show = FALSE)
 887         { m_eventType = wxEVT_SHOW; m_id = id; m_show = show; }
 888
 889     void SetShow(bool show) { m_show = show; }
 890     bool GetShow() const { return m_show; }
 891
 892     void CopyObject(wxObject& obj) const;
 893
 894 protected:
 895     bool m_show;
 896 };
 897
 898 /*
 899  wxEVT_ICONIZE
 900  */
 901
 902 class WXDLLEXPORT wxIconizeEvent : public wxEvent
 903 {
 904     DECLARE_DYNAMIC_CLASS(wxIconizeEvent)
 905
 906 public:
 907     wxIconizeEvent(int id = 0)
 908         { m_eventType = wxEVT_ICONIZE; m_id = id; }
 909 };
 910
 911 /*
 912  wxEVT_MAXIMIZE
 913  */
 914
 915 class WXDLLEXPORT wxMaximizeEvent : public wxEvent
 916 {
 917     DECLARE_DYNAMIC_CLASS(wxMaximizeEvent)
 918
 919 public:
 920   wxMaximizeEvent(int id = 0)
 921       { m_eventType = wxEVT_MAXIMIZE; m_id = id; }
 922 };
 923
 924 // Joystick event class
 925 /*
 926  wxEVT_JOY_BUTTON_DOWN,
 927  wxEVT_JOY_BUTTON_UP,
 928  wxEVT_JOY_MOVE,
 929  wxEVT_JOY_ZMOVE
 930 */
 931
 932 // Which joystick? Same as Windows ids so no conversion necessary.
 933 #define wxJOYSTICK1     0
 934 #define wxJOYSTICK2     1
 935
 936 // Which button is down?
 937 #define wxJOY_BUTTON1   1
 938 #define wxJOY_BUTTON2   2
 939 #define wxJOY_BUTTON3   4
 940 #define wxJOY_BUTTON4   8
 941 #define wxJOY_BUTTON_ANY -1
 942
 943 class WXDLLEXPORT wxJoystickEvent : public wxEvent
 944 {
 945     DECLARE_DYNAMIC_CLASS(wxJoystickEvent)
 946
 947 public:
 948     wxPoint   m_pos;
 949     int       m_zPosition;
 950     int       m_buttonChange; // Which button changed?
 951     int       m_buttonState; // Which buttons are down?
 952     int       m_joyStick; // Which joystick?
 953
 954     wxJoystickEvent(wxEventType type = wxEVT_NULL,
 955                     int state = 0,
 956                     int joystick = wxJOYSTICK1,
 957                     int change = 0)
 958     {
 959         m_eventType = type;
 960         m_buttonState = state;
 961         m_pos = wxPoint(0,0);
 962         m_zPosition = 0;
 963         m_joyStick = joystick;
 964         m_buttonChange = change;
 965     }
 966
 967     wxPoint GetPosition() const { return m_pos; }
 968     int GetZPosition() const { return m_zPosition; }
 969     int GetButtonState() const { return m_buttonState; }
 970     int GetButtonChange() const { return m_buttonChange; }
 971     int GetJoystick() const { return m_joyStick; }
 972
 973     void SetJoystick(int stick) { m_joyStick = stick; }
 974     void SetButtonState(int state) { m_buttonState = state; }
 975     void SetButtonChange(int change) { m_buttonChange = change; }
 976     void SetPosition(const wxPoint& pos) { m_pos = pos; }
 977     void SetZPosition(int zPos) { m_zPosition = zPos; }
 978
 979     // Was it a button event? (*doesn't* mean: is any button *down*?)
 980     bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) ||
 981             (GetEventType() == wxEVT_JOY_BUTTON_DOWN)); }
 982
 983     // Was it a move event?
 984     bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE) ; }
 985
 986     // Was it a zmove event?
 987     bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE) ; }
 988
 989     // Was it a down event from button 1, 2, 3, 4 or any?
 990     bool ButtonDown(int but = wxJOY_BUTTON_ANY) const
 991     { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) &&
 992             ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
 993
 994     // Was it a up event from button 1, 2, 3 or any?
 995     bool ButtonUp(int but = wxJOY_BUTTON_ANY) const
 996     { return ((GetEventType() == wxEVT_JOY_BUTTON_UP) &&
 997             ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
 998
 999     // Was the given button 1,2,3,4 or any in Down state?
1000     bool ButtonIsDown(int but =  wxJOY_BUTTON_ANY) const
1001     { return (((but == wxJOY_BUTTON_ANY) && (m_buttonState != 0)) ||
1002             ((m_buttonState & but) == but)); }
1003 };
1004
1005 // Drop files event class
1006 /*
1007  wxEVT_DROP_FILES
1008  */
1009
1010 class WXDLLEXPORT wxDropFilesEvent : public wxEvent
1011 {
1012     DECLARE_DYNAMIC_CLASS(wxDropFilesEvent)
1013
1014 public:
1015     int       m_noFiles;
1016     wxPoint   m_pos;
1017     wxString* m_files;        // Memory (de)allocated by code calling ProcessEvent
1018
1019     wxDropFilesEvent(wxEventType type = wxEVT_NULL,
1020                      int noFiles = 0,
1021                      wxString *files = (wxString *) NULL)
1022         { m_eventType = type; m_noFiles = noFiles; m_files = files; }
1023
1024     wxPoint GetPosition() const { return m_pos; }
1025     int GetNumberOfFiles() const { return m_noFiles; }
1026     wxString *GetFiles() const { return m_files; }
1027 };
1028
1029 // Idle event
1030 /*
1031  wxEVT_IDLE
1032  */
1033
1034 class WXDLLEXPORT wxIdleEvent : public wxEvent
1035 {
1036     DECLARE_DYNAMIC_CLASS(wxIdleEvent)
1037
1038 public:
1039     wxIdleEvent()
1040         { m_eventType = wxEVT_IDLE; m_requestMore = FALSE; }
1041
1042     void RequestMore(bool needMore = TRUE) { m_requestMore = needMore; }
1043     bool MoreRequested() const { return m_requestMore; }
1044
1045 protected:
1046     bool m_requestMore;
1047 };
1048
1049 // Update UI event
1050 /*
1051  wxEVT_UPDATE_UI
1052  */
1053
1054 class WXDLLEXPORT wxMenu;
1055 class WXDLLEXPORT wxWindow;
1056
1057 class WXDLLEXPORT wxUpdateUIEvent : public wxCommandEvent
1058 {
1059     DECLARE_DYNAMIC_CLASS(wxUpdateUIEvent)
1060
1061 public:
1062     wxUpdateUIEvent(wxWindowID commandId = 0)
1063     {
1064         m_eventType = wxEVT_UPDATE_UI;
1065         m_id = commandId;
1066         m_checked = FALSE;
1067         m_setChecked = FALSE;
1068         m_enabled = FALSE;
1069         m_setEnabled = FALSE;
1070         m_setText = FALSE;
1071         m_text = "";
1072     }
1073
1074     bool GetChecked() const { return m_checked; }
1075     bool GetEnabled() const { return m_enabled; }
1076     wxString GetText() const { return m_text; }
1077     bool GetSetText() const { return m_setText; }
1078     bool GetSetChecked() const { return m_setChecked; }
1079     bool GetSetEnabled() const { return m_setEnabled; }
1080
1081     void Check(bool check) { m_checked = check; m_setChecked = TRUE; }
1082     void Enable(bool enable) { m_enabled = enable; m_setEnabled = TRUE; }
1083     void SetText(const wxString& text) { m_text = text; m_setText = TRUE; }
1084
1085 protected:
1086     bool          m_checked;
1087     bool          m_enabled;
1088     bool          m_setEnabled;
1089     bool          m_setText;
1090     bool          m_setChecked;
1091     wxString      m_text;
1092 };
1093
1094 /*
1095  wxEVT_SYS_COLOUR_CHANGED
1096  */
1097
1098 // TODO: shouldn't all events record the window ID?
1099 class WXDLLEXPORT wxSysColourChangedEvent : public wxEvent
1100 {
1101     DECLARE_DYNAMIC_CLASS(wxSysColourChangedEvent)
1102
1103 public:
1104     wxSysColourChangedEvent()
1105         { m_eventType = wxEVT_SYS_COLOUR_CHANGED; }
1106 };
1107
1108 /*
1109  wxEVT_PALETTE_CHANGED
1110  */
1111
1112 class WXDLLEXPORT wxPaletteChangedEvent : public wxEvent
1113 {
1114     DECLARE_DYNAMIC_CLASS(wxPaletteChangedEvent)
1115
1116 public:
1117     wxPaletteChangedEvent(wxWindowID id = 0) : wxEvent(id)
1118     {
1119         m_eventType = wxEVT_PALETTE_CHANGED;
1120         m_changedWindow = (wxWindow *) NULL;
1121     }
1122
1123     void SetChangedWindow(wxWindow* win) { m_changedWindow = win; }
1124     wxWindow* GetChangedWindow() const { return m_changedWindow; }
1125
1126 protected:
1127     wxWindow*     m_changedWindow;
1128 };
1129
1130 /*
1131  wxEVT_QUERY_NEW_PALETTE
1132  Indicates the window is getting keyboard focus and should re-do its palette.
1133  */
1134
1135 class WXDLLEXPORT wxQueryNewPaletteEvent : public wxEvent
1136 {
1137     DECLARE_DYNAMIC_CLASS(wxQueryNewPaletteEvent)
1138
1139 public:
1140     wxQueryNewPaletteEvent(wxWindowID id = 0): wxEvent(id)
1141         { m_eventType = wxEVT_QUERY_NEW_PALETTE; m_paletteRealized = FALSE; }
1142
1143     // App sets this if it changes the palette.
1144     void SetPaletteRealized(bool realized) { m_paletteRealized = realized; }
1145     bool GetPaletteRealized() const { return m_paletteRealized; }
1146
1147 protected:
1148     bool m_paletteRealized;
1149 };
1150
1151 /*
1152  Event generated by dialog navigation keys
1153  wxEVT_NAVIGATION_KEY
1154  */
1155 // must derive from command event to be propagated to the parent
1156 class WXDLLEXPORT wxNavigationKeyEvent  : public wxCommandEvent
1157 {
1158     DECLARE_DYNAMIC_CLASS(wxNavigationKeyEvent)
1159
1160 public:
1161     wxNavigationKeyEvent() : wxCommandEvent(wxEVT_NAVIGATION_KEY) { }
1162
1163     // direction: forward (true) or backward (false)
1164     bool GetDirection() const        { return m_commandInt == 1; }
1165     void SetDirection(bool bForward) { m_commandInt = bForward;  }
1166
1167     // it may be a window change event (MDI, notebook pages...) or a control
1168     // change event
1169     bool IsWindowChange() const    { return m_extraLong == 1; }
1170     void SetWindowChange(bool bIs) { m_extraLong = bIs; }
1171
1172     // the child which has the focus currently (may be NULL - use
1173     // wxWindow::FindFocus then)
1174     wxWindow* GetCurrentFocus() const { return (wxWindow *)m_clientData; }
1175     void SetCurrentFocus(wxWindow *win) { m_clientData = (void *)win; }
1176 };
1177
1178 /* TODO
1179  wxEVT_POWER,
1180  wxEVT_CREATE,
1181  wxEVT_DESTROY,
1182  wxEVT_MOUSE_CAPTURE_CHANGED,
1183  wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
1184 // wxEVT_FONT_CHANGED,  // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
1185                         // wxEVT_FONT_CHANGED to all other windows (maybe).
1186  wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
1187  wxEVT_MEASURE_ITEM,
1188  wxEVT_COMPARE_ITEM
1189 */
1190
1191 class WXDLLEXPORT wxWindow;
1192 class WXDLLEXPORT wxControl;
1193
1194 // struct WXDLLEXPORT wxEventTableEntry;
1195
1196 typedef void (wxObject::*wxObjectEventFunction)(wxEvent&);
1197
1198 struct WXDLLEXPORT wxEventTableEntry
1199 {
1200     // For some reason, this can't be wxEventType, or VC++ complains.
1201     int m_eventType;            // main event type
1202     int m_id;                   // control/menu/toolbar id
1203     int m_lastId;               // used for ranges of ids
1204     wxObjectEventFunction m_fn; // function to call: not wxEventFunction,
1205                                 // because of dependency problems
1206
1207     wxObject* m_callbackUserData;
1208 };
1209
1210 struct WXDLLEXPORT wxEventTable
1211 {
1212     const wxEventTable *baseTable;        // Points to base event table (next in chain)
1213     const wxEventTableEntry *entries;        // Points to bottom of entry array
1214 };
1215
1216 class WXDLLEXPORT wxEvtHandler : public wxObject
1217 {
1218     DECLARE_DYNAMIC_CLASS(wxEvtHandler)
1219
1220 public:
1221     wxEvtHandler();
1222     ~wxEvtHandler();
1223
1224     wxEvtHandler *GetNextHandler() const { return m_nextHandler; }
1225     wxEvtHandler *GetPreviousHandler() const { return m_previousHandler; }
1226     void SetNextHandler(wxEvtHandler *handler) { m_nextHandler = handler; }
1227     void SetPreviousHandler(wxEvtHandler *handler) { m_previousHandler = handler; }
1228
1229     void SetEvtHandlerEnabled(bool en) { m_enabled = en; }
1230     bool GetEvtHandlerEnabled() const { return m_enabled; }
1231
1232     virtual void OnCommand(wxWindow& WXUNUSED(win),
1233                            wxCommandEvent& WXUNUSED(event))
1234     {
1235     }
1236
1237     // Called if child control has no
1238     // callback function
1239     // Default behaviour
1240     virtual long Default()
1241         { return GetNextHandler() ? GetNextHandler()->Default() : 0; };
1242
1243 #if WXWIN_COMPATIBILITY
1244     virtual bool OnClose();
1245 #endif
1246
1247 #if wxUSE_THREADS
1248     bool ProcessThreadEvent(wxEvent& event);
1249     void ProcessPendingEvents();
1250 #endif
1251     virtual bool ProcessEvent(wxEvent& event);
1252     virtual bool SearchEventTable(wxEventTable& table, wxEvent& event);
1253
1254     // Dynamic association of a member function handler with the event handler,
1255     // id and event type
1256     void Connect( int id, int lastId, wxEventType eventType,
1257                   wxObjectEventFunction func,
1258                   wxObject *userData = (wxObject *) NULL );
1259
1260     // Convenience function: take just one id
1261     void Connect( int id, wxEventType eventType,
1262                   wxObjectEventFunction func,
1263                   wxObject *userData = (wxObject *) NULL )
1264         { Connect(id, -1, eventType, func, userData); }
1265
1266     bool SearchDynamicEventTable( wxEvent& event );
1267
1268 #if wxUSE_THREADS
1269     void ClearEventLocker() { delete m_eventsLocker; m_eventsLocker = NULL; };
1270 #endif
1271
1272 private:
1273     static const wxEventTableEntry         sm_eventTableEntries[];
1274
1275 protected:
1276     static const wxEventTable sm_eventTable;
1277
1278     virtual const wxEventTable *GetEventTable() const;
1279
1280 protected:
1281     wxEvtHandler*       m_nextHandler;
1282     wxEvtHandler*       m_previousHandler;
1283     bool                m_enabled;           // Is event handler enabled?
1284     wxList*             m_dynamicEvents;
1285     wxList*                 m_pendingEvents;
1286 #if wxUSE_THREADS
1287     wxCriticalSection*  m_eventsLocker;
1288 #endif
1289
1290     // optimization: instead of using costly IsKindOf() to decide whether we're
1291     // a window (which is true in 99% of cases), use this flag
1292     bool                m_isWindow;
1293 };
1294
1295 typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&);
1296 typedef void (wxEvtHandler::*wxCommandEventFunction)(wxCommandEvent&);
1297 typedef void (wxEvtHandler::*wxScrollEventFunction)(wxScrollEvent&);
1298 typedef void (wxEvtHandler::*wxSizeEventFunction)(wxSizeEvent&);
1299 typedef void (wxEvtHandler::*wxMoveEventFunction)(wxMoveEvent&);
1300 typedef void (wxEvtHandler::*wxPaintEventFunction)(wxPaintEvent&);
1301 typedef void (wxEvtHandler::*wxEraseEventFunction)(wxEraseEvent&);
1302 typedef void (wxEvtHandler::*wxMouseEventFunction)(wxMouseEvent&);
1303 typedef void (wxEvtHandler::*wxCharEventFunction)(wxKeyEvent&);
1304 typedef void (wxEvtHandler::*wxFocusEventFunction)(wxFocusEvent&);
1305 typedef void (wxEvtHandler::*wxActivateEventFunction)(wxActivateEvent&);
1306 typedef void (wxEvtHandler::*wxMenuEventFunction)(wxMenuEvent&);
1307 typedef void (wxEvtHandler::*wxJoystickEventFunction)(wxJoystickEvent&);
1308 typedef void (wxEvtHandler::*wxDropFilesEventFunction)(wxDropFilesEvent&);
1309 typedef void (wxEvtHandler::*wxInitDialogEventFunction)(wxInitDialogEvent&);
1310 typedef void (wxEvtHandler::*wxSysColourChangedFunction)(wxSysColourChangedEvent&);
1311 typedef void (wxEvtHandler::*wxUpdateUIEventFunction)(wxUpdateUIEvent&);
1312 typedef void (wxEvtHandler::*wxIdleEventFunction)(wxIdleEvent&);
1313 typedef void (wxEvtHandler::*wxCloseEventFunction)(wxCloseEvent&);
1314 typedef void (wxEvtHandler::*wxShowEventFunction)(wxShowEvent&);
1315 typedef void (wxEvtHandler::*wxIconizeEventFunction)(wxShowEvent&);
1316 typedef void (wxEvtHandler::*wxMaximizeEventFunction)(wxShowEvent&);
1317 typedef void (wxEvtHandler::*wxNavigationKeyEventFunction)(wxNavigationKeyEvent&);
1318 typedef void (wxEvtHandler::*wxPaletteChangedEventFunction)(wxPaletteChangedEvent&);
1319 typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction)(wxQueryNewPaletteEvent&);
1320
1321 // N.B. In GNU-WIN32, you *have* to take the address of a member function
1322 // (use &) or the compiler crashes...
1323
1324 #define DECLARE_EVENT_TABLE() \
1325 private:\
1326         static const wxEventTableEntry         sm_eventTableEntries[];\
1327 protected:\
1328         static const wxEventTable        sm_eventTable;\
1329         virtual const wxEventTable*        GetEventTable() const;
1330
1331 #define BEGIN_EVENT_TABLE(theClass, baseClass) \
1332 const wxEventTable *theClass::GetEventTable() const { return &theClass::sm_eventTable; }\
1333 const wxEventTable theClass::sm_eventTable =\
1334         { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] };\
1335 const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
1336
1337 #define END_EVENT_TABLE() \
1338  { 0, 0, 0, 0, 0 } };
1339
1340 /*
1341  * Event table macros
1342  */
1343
1344 // Generic events
1345 #define EVT_CUSTOM(event, id, func) { event, id, -1, (wxObjectEventFunction) (wxEventFunction) & func, (wxObject *) NULL },
1346 #define EVT_CUSTOM_RANGE(event, id1, id2, func) { event, id1, id2, (wxObjectEventFunction) (wxEventFunction) & func, (wxObject *) NULL },
1347
1348 // Miscellaneous
1349 #define EVT_SIZE(func)  { wxEVT_SIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxSizeEventFunction) & func, (wxObject *) NULL },
1350 #define EVT_MOVE(func)  { wxEVT_MOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMoveEventFunction) & func, (wxObject *) NULL },
1351 #define EVT_CLOSE(func)  { wxEVT_CLOSE_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL },
1352 #define EVT_END_SESSION(func)  { wxEVT_END_SESSION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL },
1353 #define EVT_QUERY_END_SESSION(func)  { wxEVT_QUERY_END_SESSION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL },
1354 #define EVT_PAINT(func)  { wxEVT_PAINT, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxPaintEventFunction) & func, (wxObject *) NULL },
1355 #define EVT_ERASE_BACKGROUND(func)  { wxEVT_ERASE_BACKGROUND, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxEraseEventFunction) & func, (wxObject *) NULL },
1356 #define EVT_CHAR(func)  { wxEVT_CHAR, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCharEventFunction) & func, (wxObject *) NULL },
1357 #define EVT_KEY_DOWN(func)  { wxEVT_KEY_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCharEventFunction) & func, (wxObject *) NULL },
1358 #define EVT_KEY_UP(func)  { wxEVT_KEY_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCharEventFunction) & func, (wxObject *) NULL },
1359 #define EVT_CHAR_HOOK(func)  { wxEVT_CHAR_HOOK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCharEventFunction) & func, NULL },
1360 #define EVT_MENU_HIGHLIGHT(id, func)  { wxEVT_MENU_HIGHLIGHT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxMenuEventFunction) & func, (wxObject *) NULL },
1361 #define EVT_MENU_HIGHLIGHT_ALL(func)  { wxEVT_MENU_HIGHLIGHT, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMenuEventFunction) & func, (wxObject *) NULL },
1362 #define EVT_SET_FOCUS(func)  { wxEVT_SET_FOCUS, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxFocusEventFunction) & func, (wxObject *) NULL },
1363 #define EVT_KILL_FOCUS(func)  { wxEVT_KILL_FOCUS, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxFocusEventFunction) & func, (wxObject *) NULL },
1364 #define EVT_ACTIVATE(func)  { wxEVT_ACTIVATE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxActivateEventFunction) & func, (wxObject *) NULL },
1365 #define EVT_ACTIVATE_APP(func)  { wxEVT_ACTIVATE_APP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxActivateEventFunction) & func, (wxObject *) NULL },
1366 #define EVT_END_SESSION(func)  { wxEVT_END_SESSION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL },
1367 #define EVT_QUERY_END_SESSION(func)  { wxEVT_QUERY_END_SESSION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL },
1368 #define EVT_DROP_FILES(func)  { wxEVT_DROP_FILES, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxDropFilesEventFunction) & func, (wxObject *) NULL },
1369 #define EVT_INIT_DIALOG(func)  { wxEVT_INIT_DIALOG, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxInitDialogEventFunction) & func, (wxObject *) NULL },
1370 #define EVT_SYS_COLOUR_CHANGED(func)  { wxEVT_SYS_COLOUR_CHANGED, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxSysColourChangedFunction) & func, (wxObject *) NULL },
1371 #define EVT_SHOW(func) { wxEVT_SHOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxShowEventFunction) & func, (wxObject *) NULL },
1372 #define EVT_MAXIMIZE(func) { wxEVT_MAXIMIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMaximizeEventFunction) & func, (wxObject *) NULL },
1373 #define EVT_ICONIZE(func) { wxEVT_ICONIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxIconizeEventFunction) & func, (wxObject *) NULL },
1374 #define EVT_NAVIGATION_KEY(func) { wxEVT_NAVIGATION_KEY, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxNavigationKeyEventFunction) & func, (wxObject *) NULL },
1375 #define EVT_PALETTE_CHANGED(func) { wxEVT_PALETTE_CHANGED, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxPaletteChangedEventFunction) & func, (wxObject *) NULL },
1376 #define EVT_QUERY_NEW_PALETTE(func) { wxEVT_QUERY_NEW_PALETTE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxQueryNewPaletteEventFunction) & func, (wxObject *) NULL },
1377
1378 // Mouse events
1379 #define EVT_LEFT_DOWN(func) { wxEVT_LEFT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1380 #define EVT_LEFT_UP(func) { wxEVT_LEFT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1381 #define EVT_MIDDLE_DOWN(func) { wxEVT_MIDDLE_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1382 #define EVT_MIDDLE_UP(func) { wxEVT_MIDDLE_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1383 #define EVT_RIGHT_DOWN(func) { wxEVT_RIGHT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1384 #define EVT_RIGHT_UP(func) { wxEVT_RIGHT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1385 #define EVT_MOTION(func) { wxEVT_MOTION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1386 #define EVT_LEFT_DCLICK(func) { wxEVT_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1387 #define EVT_MIDDLE_DCLICK(func) { wxEVT_MIDDLE_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1388 #define EVT_RIGHT_DCLICK(func) { wxEVT_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1389 #define EVT_LEAVE_WINDOW(func) { wxEVT_LEAVE_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1390 #define EVT_ENTER_WINDOW(func) { wxEVT_ENTER_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1391
1392 // All mouse events
1393 #define EVT_MOUSE_EVENTS(func) \
1394  { wxEVT_LEFT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1395  { wxEVT_LEFT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1396  { wxEVT_MIDDLE_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1397  { wxEVT_MIDDLE_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1398  { wxEVT_RIGHT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1399  { wxEVT_RIGHT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1400  { wxEVT_MOTION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1401  { wxEVT_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1402  { wxEVT_MIDDLE_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1403  { wxEVT_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1404  { wxEVT_ENTER_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1405  { wxEVT_LEAVE_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1406
1407 // EVT_COMMAND
1408 #define EVT_COMMAND(id, event, fn)  { event, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1409 #define EVT_COMMAND_RANGE(id1, id2, event, fn)  { event, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1410
1411 // Scrolling
1412 #define EVT_SCROLL(func) \
1413   { wxEVT_SCROLL_TOP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1414   { wxEVT_SCROLL_BOTTOM, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1415   { wxEVT_SCROLL_LINEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1416   { wxEVT_SCROLL_LINEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1417   { wxEVT_SCROLL_PAGEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1418   { wxEVT_SCROLL_PAGEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1419   { wxEVT_SCROLL_THUMBTRACK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1420
1421 #define EVT_SCROLL_TOP(func) { wxEVT_SCROLL_TOP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1422 #define EVT_SCROLL_BOTTOM(func) { wxEVT_SCROLL_BOTTOM, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1423 #define EVT_SCROLL_LINEUP(func) { wxEVT_SCROLL_LINEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1424 #define EVT_SCROLL_LINEDOWN(func) { wxEVT_SCROLL_LINEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1425 #define EVT_SCROLL_PAGEUP(func) { wxEVT_SCROLL_PAGEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1426 #define EVT_SCROLL_PAGEDOWN(func) { wxEVT_SCROLL_PAGEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1427 #define EVT_SCROLL_THUMBTRACK(func) { wxEVT_SCROLL_THUMBTRACK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1428
1429 // Scrolling, with an id
1430 #define EVT_COMMAND_SCROLL(id, func) \
1431   { wxEVT_SCROLL_TOP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1432   { wxEVT_SCROLL_BOTTOM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1433   { wxEVT_SCROLL_LINEUP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1434   { wxEVT_SCROLL_LINEDOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1435   { wxEVT_SCROLL_PAGEUP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1436   { wxEVT_SCROLL_PAGEDOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1437   { wxEVT_SCROLL_THUMBTRACK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1438
1439 #define EVT_COMMAND_SCROLL_TOP(id, func) { wxEVT_SCROLL_TOP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1440 #define EVT_COMMAND_SCROLL_BOTTOM(id, func) { wxEVT_SCROLL_BOTTOM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1441 #define EVT_COMMAND_SCROLL_LINEUP(id, func) { wxEVT_SCROLL_LINEUP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1442 #define EVT_COMMAND_SCROLL_LINEDOWN(id, func) { wxEVT_SCROLL_LINEDOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1443 #define EVT_COMMAND_SCROLL_PAGEUP(id, func) { wxEVT_SCROLL_PAGEUP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1444 #define EVT_COMMAND_SCROLL_PAGEDOWN(id, func) { wxEVT_SCROLL_PAGEDOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1445 #define EVT_COMMAND_SCROLL_THUMBTRACK(id, func) { wxEVT_SCROLL_THUMBTRACK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1446
1447 // Convenience macros for commonly-used commands
1448 #define EVT_BUTTON(id, fn) { wxEVT_COMMAND_BUTTON_CLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1449 #define EVT_CHECKBOX(id, fn) { wxEVT_COMMAND_CHECKBOX_CLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1450 #define EVT_CHOICE(id, fn) { wxEVT_COMMAND_CHOICE_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1451 #define EVT_LISTBOX(id, fn) { wxEVT_COMMAND_LISTBOX_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1452 #define EVT_LISTBOX_DCLICK(id, fn) { wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1453 #define EVT_TEXT(id, fn) { wxEVT_COMMAND_TEXT_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1454 #define EVT_TEXT_ENTER(id, fn) { wxEVT_COMMAND_TEXT_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1455 #define EVT_MENU(id, fn) { wxEVT_COMMAND_MENU_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1456 #define EVT_MENU_RANGE(id1, id2, fn) { wxEVT_COMMAND_MENU_SELECTED, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1457 #define EVT_SLIDER(id, fn) { wxEVT_COMMAND_SLIDER_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1458 #define EVT_RADIOBOX(id, fn) { wxEVT_COMMAND_RADIOBOX_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1459 #define EVT_RADIOBUTTON(id, fn) { wxEVT_COMMAND_RADIOBUTTON_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1460 // EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events
1461 #define EVT_SCROLLBAR(id, fn) { wxEVT_COMMAND_SCROLLBAR_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1462 #define EVT_VLBOX(id, fn) { wxEVT_COMMAND_VLBOX_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1463 #define EVT_COMBOBOX(id, fn) { wxEVT_COMMAND_COMBOBOX_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1464 #define EVT_TOOL(id, fn) { wxEVT_COMMAND_TOOL_CLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1465 #define EVT_TOOL_RANGE(id1, id2, fn) { wxEVT_COMMAND_TOOL_CLICKED, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1466 #define EVT_TOOL_RCLICKED(id, fn) { wxEVT_COMMAND_TOOL_RCLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1467 #define EVT_TOOL_RCLICKED_RANGE(id1, id2, fn) { wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1468 #define EVT_TOOL_ENTER(id, fn) { wxEVT_COMMAND_TOOL_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1469 #define EVT_CHECKLISTBOX(id, fn) { wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1470
1471 // Generic command events
1472 #define EVT_COMMAND_LEFT_CLICK(id, fn) { wxEVT_COMMAND_LEFT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1473 #define EVT_COMMAND_LEFT_DCLICK(id, fn) { wxEVT_COMMAND_LEFT_DCLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1474 #define EVT_COMMAND_RIGHT_CLICK(id, fn) { wxEVT_COMMAND_RIGHT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1475 #define EVT_COMMAND_RIGHT_DCLICK(id, fn) { wxEVT_COMMAND_RIGHT_DCLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1476 #define EVT_COMMAND_SET_FOCUS(id, fn) { wxEVT_COMMAND_SET_FOCUS, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1477 #define EVT_COMMAND_KILL_FOCUS(id, fn) { wxEVT_COMMAND_KILL_FOCUS, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1478 #define EVT_COMMAND_ENTER(id, fn) { wxEVT_COMMAND_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1479
1480 // Joystick events
1481 #define EVT_JOY_DOWN(func) \
1482  { wxEVT_JOY_BUTTON_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },
1483 #define EVT_JOY_UP(func) \
1484  { wxEVT_JOY_BUTTON_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },
1485 #define EVT_JOY_MOVE(func) \
1486  { wxEVT_JOY_MOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },
1487 #define EVT_JOY_ZMOVE(func) \
1488  { wxEVT_JOY_ZMOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },
1489
1490 // All joystick events
1491 #define EVT_JOYSTICK_EVENTS(func) \
1492  { wxEVT_JOY_BUTTON_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },\
1493  { wxEVT_JOY_BUTTON_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },\
1494  { wxEVT_JOY_MOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },\
1495  { wxEVT_JOY_ZMOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },\
1496
1497 // Idle event
1498 #define EVT_IDLE(func) \
1499  { wxEVT_IDLE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxIdleEventFunction) & func, (wxObject *) NULL },\
1500
1501 // Update UI event
1502 #define EVT_UPDATE_UI(id, func) \
1503  { wxEVT_UPDATE_UI, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxUpdateUIEventFunction) & func, (wxObject *) NULL },\
1504
1505 /*
1506  * Helper functions
1507  */
1508
1509 // Find a window with the focus, that is also a descendant of the given window.
1510 // This is used to determine the window to initially send commands to.
1511 wxWindow* wxFindFocusDescendant(wxWindow* ancestor);
1512
1513 #endif
1514         // _WX_EVENTH__