include/wx/event.h

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