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