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