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