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