///////////////////////////////////////////////////////////////////////////// // Name: wx/event.h // Purpose: Event classes // Author: Julian Smart // Modified by: // Created: 01/02/97 // RCS-ID: $Id$ // Copyright: (c) wxWidgets team // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifndef _WX_EVENT_H__ #define _WX_EVENT_H__ #include "wx/defs.h" #include "wx/object.h" #include "wx/clntdata.h" #if wxUSE_GUI #include "wx/gdicmn.h" #include "wx/cursor.h" #endif #include "wx/thread.h" #include "wx/dynarray.h" // ---------------------------------------------------------------------------- // forward declarations // ---------------------------------------------------------------------------- class WXDLLIMPEXP_BASE wxList; #if wxUSE_GUI class WXDLLIMPEXP_CORE wxDC; class WXDLLIMPEXP_CORE wxMenu; class WXDLLIMPEXP_CORE wxWindow; class WXDLLIMPEXP_CORE wxWindowBase; #endif // wxUSE_GUI class WXDLLIMPEXP_BASE wxEvtHandler; // ---------------------------------------------------------------------------- // Event types // ---------------------------------------------------------------------------- typedef int wxEventType; // this is used to make the event table entry type safe, so that for an event // handler only a function with proper parameter list can be given. #define wxStaticCastEvent(type, val) wx_static_cast(type, val) // in previous versions of wxWidgets the event types used to be constants // which created difficulties with custom/user event types definition // // starting from wxWidgets 2.4 the event types are now dynamically assigned // using wxNewEventType() which solves this problem, however at price of // several incompatibilities: // // a) event table macros declaration changed, it now uses wxEventTableEntry // ctor instead of initialisation from an agregate - the macro // DECLARE_EVENT_TABLE_ENTRY may be used to write code which can compile // with all versions of wxWidgets // // b) event types can't be used as switch() cases as they're not really // constant any more - there is no magic solution here, you just have to // change the switch()es to if()s // // if these are real problems for you, define WXWIN_COMPATIBILITY_EVENT_TYPES // as 1 to get 100% old behaviour, however you won't be able to use the // libraries using the new dynamic event type allocation in such case, so avoid // it if possible. #ifndef WXWIN_COMPATIBILITY_EVENT_TYPES #define WXWIN_COMPATIBILITY_EVENT_TYPES 0 #endif #if WXWIN_COMPATIBILITY_EVENT_TYPES #define DECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj) \ { type, winid, idLast, fn, obj } #define BEGIN_DECLARE_EVENT_TYPES() enum { #define END_DECLARE_EVENT_TYPES() }; #define DECLARE_EVENT_TYPE(name, value) name = wxEVT_FIRST + value, #define DECLARE_LOCAL_EVENT_TYPE(name, value) name = wxEVT_USER_FIRST + value, #define DECLARE_EXPORTED_EVENT_TYPE(expdecl, name, value) \ DECLARE_LOCAL_EVENT_TYPE(name, value) #define DEFINE_EVENT_TYPE(name) #define DEFINE_LOCAL_EVENT_TYPE(name) #else // !WXWIN_COMPATIBILITY_EVENT_TYPES #define DECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj) \ wxEventTableEntry(type, winid, idLast, fn, obj) #define EMPTY_PARAMETER_VALUE /* Fake macro parameter value */ #define BEGIN_DECLARE_EVENT_TYPES() #define END_DECLARE_EVENT_TYPES() #define DECLARE_EXPORTED_EVENT_TYPE(expdecl, name, value) \ extern expdecl const wxEventType name; #define DECLARE_EVENT_TYPE(name, value) \ DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_CORE, name, value) #define DECLARE_LOCAL_EVENT_TYPE(name, value) \ DECLARE_EXPORTED_EVENT_TYPE(EMPTY_PARAMETER_VALUE, name, value) #define DEFINE_EVENT_TYPE(name) const wxEventType name = wxNewEventType(); #define DEFINE_LOCAL_EVENT_TYPE(name) DEFINE_EVENT_TYPE(name) // generate a new unique event type extern WXDLLIMPEXP_BASE wxEventType wxNewEventType(); #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES BEGIN_DECLARE_EVENT_TYPES() #if WXWIN_COMPATIBILITY_EVENT_TYPES wxEVT_NULL = 0, wxEVT_FIRST = 10000, wxEVT_USER_FIRST = wxEVT_FIRST + 2000, #else // !WXWIN_COMPATIBILITY_EVENT_TYPES // it is important to still have these as constants to avoid // initialization order related problems DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_NULL, 0) DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_FIRST, 10000) DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_USER_FIRST, wxEVT_FIRST + 2000) #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES DECLARE_EVENT_TYPE(wxEVT_COMMAND_BUTTON_CLICKED, 1) DECLARE_EVENT_TYPE(wxEVT_COMMAND_CHECKBOX_CLICKED, 2) DECLARE_EVENT_TYPE(wxEVT_COMMAND_CHOICE_SELECTED, 3) DECLARE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_SELECTED, 4) DECLARE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 5) DECLARE_EVENT_TYPE(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 6) // now they are in wx/textctrl.h #if WXWIN_COMPATIBILITY_EVENT_TYPES DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_UPDATED, 7) DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_ENTER, 8) DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_URL, 13) DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_MAXLEN, 14) #endif // WXWIN_COMPATIBILITY_EVENT_TYPES DECLARE_EVENT_TYPE(wxEVT_COMMAND_MENU_SELECTED, 9) DECLARE_EVENT_TYPE(wxEVT_COMMAND_SLIDER_UPDATED, 10) DECLARE_EVENT_TYPE(wxEVT_COMMAND_RADIOBOX_SELECTED, 11) DECLARE_EVENT_TYPE(wxEVT_COMMAND_RADIOBUTTON_SELECTED, 12) // wxEVT_COMMAND_SCROLLBAR_UPDATED is now obsolete since we use // wxEVT_SCROLL... events DECLARE_EVENT_TYPE(wxEVT_COMMAND_SCROLLBAR_UPDATED, 13) DECLARE_EVENT_TYPE(wxEVT_COMMAND_VLBOX_SELECTED, 14) DECLARE_EVENT_TYPE(wxEVT_COMMAND_COMBOBOX_SELECTED, 15) DECLARE_EVENT_TYPE(wxEVT_COMMAND_TOOL_RCLICKED, 16) DECLARE_EVENT_TYPE(wxEVT_COMMAND_TOOL_ENTER, 17) DECLARE_EVENT_TYPE(wxEVT_COMMAND_SPINCTRL_UPDATED, 18) // Sockets and timers send events, too DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_SOCKET, 50) DECLARE_EVENT_TYPE(wxEVT_TIMER , 80) // Mouse event types DECLARE_EVENT_TYPE(wxEVT_LEFT_DOWN, 100) DECLARE_EVENT_TYPE(wxEVT_LEFT_UP, 101) DECLARE_EVENT_TYPE(wxEVT_MIDDLE_DOWN, 102) DECLARE_EVENT_TYPE(wxEVT_MIDDLE_UP, 103) DECLARE_EVENT_TYPE(wxEVT_RIGHT_DOWN, 104) DECLARE_EVENT_TYPE(wxEVT_RIGHT_UP, 105) DECLARE_EVENT_TYPE(wxEVT_MOTION, 106) DECLARE_EVENT_TYPE(wxEVT_ENTER_WINDOW, 107) DECLARE_EVENT_TYPE(wxEVT_LEAVE_WINDOW, 108) DECLARE_EVENT_TYPE(wxEVT_LEFT_DCLICK, 109) DECLARE_EVENT_TYPE(wxEVT_MIDDLE_DCLICK, 110) DECLARE_EVENT_TYPE(wxEVT_RIGHT_DCLICK, 111) DECLARE_EVENT_TYPE(wxEVT_SET_FOCUS, 112) DECLARE_EVENT_TYPE(wxEVT_KILL_FOCUS, 113) DECLARE_EVENT_TYPE(wxEVT_CHILD_FOCUS, 114) DECLARE_EVENT_TYPE(wxEVT_MOUSEWHEEL, 115) // Non-client mouse events DECLARE_EVENT_TYPE(wxEVT_NC_LEFT_DOWN, 200) DECLARE_EVENT_TYPE(wxEVT_NC_LEFT_UP, 201) DECLARE_EVENT_TYPE(wxEVT_NC_MIDDLE_DOWN, 202) DECLARE_EVENT_TYPE(wxEVT_NC_MIDDLE_UP, 203) DECLARE_EVENT_TYPE(wxEVT_NC_RIGHT_DOWN, 204) DECLARE_EVENT_TYPE(wxEVT_NC_RIGHT_UP, 205) DECLARE_EVENT_TYPE(wxEVT_NC_MOTION, 206) DECLARE_EVENT_TYPE(wxEVT_NC_ENTER_WINDOW, 207) DECLARE_EVENT_TYPE(wxEVT_NC_LEAVE_WINDOW, 208) DECLARE_EVENT_TYPE(wxEVT_NC_LEFT_DCLICK, 209) DECLARE_EVENT_TYPE(wxEVT_NC_MIDDLE_DCLICK, 210) DECLARE_EVENT_TYPE(wxEVT_NC_RIGHT_DCLICK, 211) // Character input event type DECLARE_EVENT_TYPE(wxEVT_CHAR, 212) DECLARE_EVENT_TYPE(wxEVT_CHAR_HOOK, 213) DECLARE_EVENT_TYPE(wxEVT_NAVIGATION_KEY, 214) DECLARE_EVENT_TYPE(wxEVT_KEY_DOWN, 215) DECLARE_EVENT_TYPE(wxEVT_KEY_UP, 216) #if wxUSE_HOTKEY DECLARE_EVENT_TYPE(wxEVT_HOTKEY, 217) #endif // Set cursor event DECLARE_EVENT_TYPE(wxEVT_SET_CURSOR, 230) // wxScrollBar and wxSlider event identifiers DECLARE_EVENT_TYPE(wxEVT_SCROLL_TOP, 300) DECLARE_EVENT_TYPE(wxEVT_SCROLL_BOTTOM, 301) DECLARE_EVENT_TYPE(wxEVT_SCROLL_LINEUP, 302) DECLARE_EVENT_TYPE(wxEVT_SCROLL_LINEDOWN, 303) DECLARE_EVENT_TYPE(wxEVT_SCROLL_PAGEUP, 304) DECLARE_EVENT_TYPE(wxEVT_SCROLL_PAGEDOWN, 305) DECLARE_EVENT_TYPE(wxEVT_SCROLL_THUMBTRACK, 306) DECLARE_EVENT_TYPE(wxEVT_SCROLL_THUMBRELEASE, 307) DECLARE_EVENT_TYPE(wxEVT_SCROLL_CHANGED, 308) // Scroll events from wxWindow DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_TOP, 320) DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_BOTTOM, 321) DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEUP, 322) DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEDOWN, 323) DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEUP, 324) DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEDOWN, 325) DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBTRACK, 326) DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBRELEASE, 327) // System events DECLARE_EVENT_TYPE(wxEVT_SIZE, 400) DECLARE_EVENT_TYPE(wxEVT_MOVE, 401) DECLARE_EVENT_TYPE(wxEVT_CLOSE_WINDOW, 402) DECLARE_EVENT_TYPE(wxEVT_END_SESSION, 403) DECLARE_EVENT_TYPE(wxEVT_QUERY_END_SESSION, 404) DECLARE_EVENT_TYPE(wxEVT_ACTIVATE_APP, 405) DECLARE_EVENT_TYPE(wxEVT_POWER, 406) DECLARE_EVENT_TYPE(wxEVT_ACTIVATE, 409) DECLARE_EVENT_TYPE(wxEVT_CREATE, 410) DECLARE_EVENT_TYPE(wxEVT_DESTROY, 411) DECLARE_EVENT_TYPE(wxEVT_SHOW, 412) DECLARE_EVENT_TYPE(wxEVT_ICONIZE, 413) DECLARE_EVENT_TYPE(wxEVT_MAXIMIZE, 414) DECLARE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_CHANGED, 415) DECLARE_EVENT_TYPE(wxEVT_PAINT, 416) DECLARE_EVENT_TYPE(wxEVT_ERASE_BACKGROUND, 417) DECLARE_EVENT_TYPE(wxEVT_NC_PAINT, 418) DECLARE_EVENT_TYPE(wxEVT_PAINT_ICON, 419) DECLARE_EVENT_TYPE(wxEVT_MENU_OPEN, 420) DECLARE_EVENT_TYPE(wxEVT_MENU_CLOSE, 421) DECLARE_EVENT_TYPE(wxEVT_MENU_HIGHLIGHT, 422) // DECLARE_EVENT_TYPE(wxEVT_POPUP_MENU_INIT, 423) -- free slot DECLARE_EVENT_TYPE(wxEVT_CONTEXT_MENU, 424) DECLARE_EVENT_TYPE(wxEVT_SYS_COLOUR_CHANGED, 425) DECLARE_EVENT_TYPE(wxEVT_DISPLAY_CHANGED, 426) DECLARE_EVENT_TYPE(wxEVT_SETTING_CHANGED, 427) DECLARE_EVENT_TYPE(wxEVT_QUERY_NEW_PALETTE, 428) DECLARE_EVENT_TYPE(wxEVT_PALETTE_CHANGED, 429) DECLARE_EVENT_TYPE(wxEVT_JOY_BUTTON_DOWN, 430) DECLARE_EVENT_TYPE(wxEVT_JOY_BUTTON_UP, 431) DECLARE_EVENT_TYPE(wxEVT_JOY_MOVE, 432) DECLARE_EVENT_TYPE(wxEVT_JOY_ZMOVE, 433) DECLARE_EVENT_TYPE(wxEVT_DROP_FILES, 434) DECLARE_EVENT_TYPE(wxEVT_DRAW_ITEM, 435) DECLARE_EVENT_TYPE(wxEVT_MEASURE_ITEM, 436) DECLARE_EVENT_TYPE(wxEVT_COMPARE_ITEM, 437) DECLARE_EVENT_TYPE(wxEVT_INIT_DIALOG, 438) DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_IDLE, 439) DECLARE_EVENT_TYPE(wxEVT_UPDATE_UI, 440) DECLARE_EVENT_TYPE(wxEVT_SIZING, 441) DECLARE_EVENT_TYPE(wxEVT_MOVING, 442) DECLARE_EVENT_TYPE(wxEVT_HIBERNATE, 443) // Generic command events // Note: a click is a higher-level event than button down/up DECLARE_EVENT_TYPE(wxEVT_COMMAND_LEFT_CLICK, 500) DECLARE_EVENT_TYPE(wxEVT_COMMAND_LEFT_DCLICK, 501) DECLARE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_CLICK, 502) DECLARE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_DCLICK, 503) DECLARE_EVENT_TYPE(wxEVT_COMMAND_SET_FOCUS, 504) DECLARE_EVENT_TYPE(wxEVT_COMMAND_KILL_FOCUS, 505) DECLARE_EVENT_TYPE(wxEVT_COMMAND_ENTER, 506) // Help events DECLARE_EVENT_TYPE(wxEVT_HELP, 1050) DECLARE_EVENT_TYPE(wxEVT_DETAILED_HELP, 1051) END_DECLARE_EVENT_TYPES() // these 2 events are the same #define wxEVT_COMMAND_TOOL_CLICKED wxEVT_COMMAND_MENU_SELECTED // ---------------------------------------------------------------------------- // Compatibility // ---------------------------------------------------------------------------- // this event is also used by wxComboBox and wxSpinCtrl which don't include // wx/textctrl.h in all ports [yet], so declare it here as well // // still, any new code using it should include wx/textctrl.h explicitly #if !WXWIN_COMPATIBILITY_EVENT_TYPES extern const wxEventType WXDLLIMPEXP_CORE wxEVT_COMMAND_TEXT_UPDATED; #endif // the predefined constants for the number of times we propagate event // upwards window child-parent chain enum Propagation_state { // don't propagate it at all wxEVENT_PROPAGATE_NONE = 0, // propagate it until it is processed wxEVENT_PROPAGATE_MAX = INT_MAX }; /* * wxWidgets events, covering all interesting things that might happen * (button clicking, resizing, setting text in widgets, etc.). * * For each completely new event type, derive a new event class. * An event CLASS represents a C++ class defining a range of similar event TYPES; * examples are canvas events, panel item command events. * An event TYPE is a unique identifier for a particular system event, * such as a button press or a listbox deselection. * */ class WXDLLIMPEXP_BASE wxEvent : public wxObject { private: wxEvent& operator=(const wxEvent&); protected: wxEvent(const wxEvent&); // for implementing Clone() public: wxEvent(int winid = 0, wxEventType commandType = wxEVT_NULL ); void SetEventType(wxEventType typ) { m_eventType = typ; } wxEventType GetEventType() const { return m_eventType; } wxObject *GetEventObject() const { return m_eventObject; } void SetEventObject(wxObject *obj) { m_eventObject = obj; } long GetTimestamp() const { return m_timeStamp; } void SetTimestamp(long ts = 0) { m_timeStamp = ts; } int GetId() const { return m_id; } void SetId(int Id) { m_id = Id; } // Can instruct event processor that we wish to ignore this event // (treat as if the event table entry had not been found): this must be done // to allow the event processing by the base classes (calling event.Skip() // is the analog of calling the base class version of a virtual function) void Skip(bool skip = true) { m_skipped = skip; } bool GetSkipped() const { return m_skipped; }; // this function is used to create a copy of the event polymorphically and // all derived classes must implement it because otherwise wxPostEvent() // for them wouldn't work (it needs to do a copy of the event) virtual wxEvent *Clone() const = 0; // Implementation only: this test is explicitly anti OO and this function // exists only for optimization purposes. bool IsCommandEvent() const { return m_isCommandEvent; } // Determine if this event should be propagating to the parent window. bool ShouldPropagate() const { return m_propagationLevel != wxEVENT_PROPAGATE_NONE; } // Stop an event from propagating to its parent window, returns the old // propagation level value int StopPropagation() { int propagationLevel = m_propagationLevel; m_propagationLevel = wxEVENT_PROPAGATE_NONE; return propagationLevel; } // Resume the event propagation by restoring the propagation level // (returned by StopPropagation()) void ResumePropagation(int propagationLevel) { m_propagationLevel = propagationLevel; } #if WXWIN_COMPATIBILITY_2_4 public: #else protected: #endif wxObject* m_eventObject; wxEventType m_eventType; long m_timeStamp; int m_id; public: // m_callbackUserData is for internal usage only wxObject* m_callbackUserData; protected: // the propagation level: while it is positive, we propagate the event to // the parent window (if any) // // this one doesn't have to be public, we don't have to worry about // backwards compatibility as it is new int m_propagationLevel; #if WXWIN_COMPATIBILITY_2_4 public: #else protected: #endif bool m_skipped; bool m_isCommandEvent; private: // it needs to access our m_propagationLevel friend class WXDLLIMPEXP_BASE wxPropagateOnce; DECLARE_ABSTRACT_CLASS(wxEvent) }; /* * Helper class to temporarily change an event not to propagate. */ class WXDLLIMPEXP_BASE wxPropagationDisabler { public: wxPropagationDisabler(wxEvent& event) : m_event(event) { m_propagationLevelOld = m_event.StopPropagation(); } ~wxPropagationDisabler() { m_event.ResumePropagation(m_propagationLevelOld); } private: wxEvent& m_event; int m_propagationLevelOld; DECLARE_NO_COPY_CLASS(wxPropagationDisabler) }; /* * Another one to temporarily lower propagation level. */ class WXDLLIMPEXP_BASE wxPropagateOnce { public: wxPropagateOnce(wxEvent& event) : m_event(event) { wxASSERT_MSG( m_event.m_propagationLevel > 0, _T("shouldn't be used unless ShouldPropagate()!") ); m_event.m_propagationLevel--; } ~wxPropagateOnce() { m_event.m_propagationLevel++; } private: wxEvent& m_event; DECLARE_NO_COPY_CLASS(wxPropagateOnce) }; #if wxUSE_GUI // Item or menu event class /* wxEVT_COMMAND_BUTTON_CLICKED wxEVT_COMMAND_CHECKBOX_CLICKED wxEVT_COMMAND_CHOICE_SELECTED wxEVT_COMMAND_LISTBOX_SELECTED wxEVT_COMMAND_LISTBOX_DOUBLECLICKED wxEVT_COMMAND_TEXT_UPDATED wxEVT_COMMAND_TEXT_ENTER wxEVT_COMMAND_MENU_SELECTED wxEVT_COMMAND_SLIDER_UPDATED wxEVT_COMMAND_RADIOBOX_SELECTED wxEVT_COMMAND_RADIOBUTTON_SELECTED wxEVT_COMMAND_SCROLLBAR_UPDATED wxEVT_COMMAND_VLBOX_SELECTED wxEVT_COMMAND_COMBOBOX_SELECTED wxEVT_COMMAND_TOGGLEBUTTON_CLICKED */ #if WXWIN_COMPATIBILITY_2_4 // Backwards compatibility for wxCommandEvent::m_commandString, will lead to compilation errors in some cases of usage class WXDLLIMPEXP_CORE wxCommandEvent; class WXDLLIMPEXP_CORE wxCommandEventStringHelper { public: wxCommandEventStringHelper(wxCommandEvent * evt) : m_evt(evt) { } void operator=(const wxString &str); operator wxString(); const wxChar* c_str() const; private: wxCommandEvent* m_evt; }; #endif class WXDLLIMPEXP_CORE wxCommandEvent : public wxEvent { public: wxCommandEvent(wxEventType commandType = wxEVT_NULL, int winid = 0); wxCommandEvent(const wxCommandEvent& event) : wxEvent(event), #if WXWIN_COMPATIBILITY_2_4 m_commandString(this), #endif m_cmdString(event.m_cmdString), m_commandInt(event.m_commandInt), m_extraLong(event.m_extraLong), m_clientData(event.m_clientData), m_clientObject(event.m_clientObject) { } // Set/Get client data from controls void SetClientData(void* clientData) { m_clientData = clientData; } void *GetClientData() const { return m_clientData; } // Set/Get client object from controls void SetClientObject(wxClientData* clientObject) { m_clientObject = clientObject; } wxClientData *GetClientObject() const { return m_clientObject; } // Get listbox selection if single-choice int GetSelection() const { return m_commandInt; } // Set/Get listbox/choice selection string void SetString(const wxString& s) { m_cmdString = s; } wxString GetString() const; // Get checkbox value bool IsChecked() const { return m_commandInt != 0; } // true if the listbox event was a selection. bool IsSelection() const { return (m_extraLong != 0); } void SetExtraLong(long extraLong) { m_extraLong = extraLong; } long GetExtraLong() const { return m_extraLong; } void SetInt(int i) { m_commandInt = i; } long GetInt() const { return m_commandInt; } virtual wxEvent *Clone() const { return new wxCommandEvent(*this); } #if WXWIN_COMPATIBILITY_2_4 public: wxCommandEventStringHelper m_commandString; #else protected: #endif wxString m_cmdString; // String event argument int m_commandInt; long m_extraLong; // Additional information (e.g. select/deselect) void* m_clientData; // Arbitrary client data wxClientData* m_clientObject; // Arbitrary client object private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCommandEvent) }; #if WXWIN_COMPATIBILITY_2_4 inline void wxCommandEventStringHelper::operator=(const wxString &str) { m_evt->SetString(str); } inline wxCommandEventStringHelper::operator wxString() { return m_evt->GetString(); } inline const wxChar* wxCommandEventStringHelper::c_str() const { return m_evt->GetString().c_str(); } #endif // this class adds a possibility to react (from the user) code to a control // notification: allow or veto the operation being reported. class WXDLLIMPEXP_CORE wxNotifyEvent : public wxCommandEvent { public: wxNotifyEvent(wxEventType commandType = wxEVT_NULL, int winid = 0) : wxCommandEvent(commandType, winid) { m_bAllow = true; } wxNotifyEvent(const wxNotifyEvent& event) : wxCommandEvent(event) { m_bAllow = event.m_bAllow; } // veto the operation (usually it's allowed by default) void Veto() { m_bAllow = false; } // allow the operation if it was disabled by default void Allow() { m_bAllow = true; } // for implementation code only: is the operation allowed? bool IsAllowed() const { return m_bAllow; } virtual wxEvent *Clone() const { return new wxNotifyEvent(*this); } private: bool m_bAllow; private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNotifyEvent) }; // Scroll event class, derived form wxCommandEvent. wxScrollEvents are // sent by wxSlider and wxScrollBar. /* wxEVT_SCROLL_TOP wxEVT_SCROLL_BOTTOM wxEVT_SCROLL_LINEUP wxEVT_SCROLL_LINEDOWN wxEVT_SCROLL_PAGEUP wxEVT_SCROLL_PAGEDOWN wxEVT_SCROLL_THUMBTRACK wxEVT_SCROLL_THUMBRELEASE wxEVT_SCROLL_CHANGED */ class WXDLLIMPEXP_CORE wxScrollEvent : public wxCommandEvent { public: wxScrollEvent(wxEventType commandType = wxEVT_NULL, int winid = 0, int pos = 0, int orient = 0); int GetOrientation() const { return (int) m_extraLong; } int GetPosition() const { return m_commandInt; } void SetOrientation(int orient) { m_extraLong = (long) orient; } void SetPosition(int pos) { m_commandInt = pos; } virtual wxEvent *Clone() const { return new wxScrollEvent(*this); } private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollEvent) }; // ScrollWin event class, derived fom wxEvent. wxScrollWinEvents // are sent by wxWindow. /* wxEVT_SCROLLWIN_TOP wxEVT_SCROLLWIN_BOTTOM wxEVT_SCROLLWIN_LINEUP wxEVT_SCROLLWIN_LINEDOWN wxEVT_SCROLLWIN_PAGEUP wxEVT_SCROLLWIN_PAGEDOWN wxEVT_SCROLLWIN_THUMBTRACK wxEVT_SCROLLWIN_THUMBRELEASE */ class WXDLLIMPEXP_CORE wxScrollWinEvent : public wxEvent { public: wxScrollWinEvent(wxEventType commandType = wxEVT_NULL, int pos = 0, int orient = 0); wxScrollWinEvent(const wxScrollWinEvent & event) : wxEvent(event) { m_commandInt = event.m_commandInt; m_extraLong = event.m_extraLong; } int GetOrientation() const { return (int) m_extraLong; } int GetPosition() const { return m_commandInt; } void SetOrientation(int orient) { m_extraLong = (long) orient; } void SetPosition(int pos) { m_commandInt = pos; } virtual wxEvent *Clone() const { return new wxScrollWinEvent(*this); } #if WXWIN_COMPATIBILITY_2_4 public: #else protected: #endif int m_commandInt; long m_extraLong; private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollWinEvent) }; // Mouse event class /* wxEVT_LEFT_DOWN wxEVT_LEFT_UP wxEVT_MIDDLE_DOWN wxEVT_MIDDLE_UP wxEVT_RIGHT_DOWN wxEVT_RIGHT_UP wxEVT_MOTION wxEVT_ENTER_WINDOW wxEVT_LEAVE_WINDOW wxEVT_LEFT_DCLICK wxEVT_MIDDLE_DCLICK wxEVT_RIGHT_DCLICK wxEVT_NC_LEFT_DOWN wxEVT_NC_LEFT_UP, wxEVT_NC_MIDDLE_DOWN, wxEVT_NC_MIDDLE_UP, wxEVT_NC_RIGHT_DOWN, wxEVT_NC_RIGHT_UP, wxEVT_NC_MOTION, wxEVT_NC_ENTER_WINDOW, wxEVT_NC_LEAVE_WINDOW, wxEVT_NC_LEFT_DCLICK, wxEVT_NC_MIDDLE_DCLICK, wxEVT_NC_RIGHT_DCLICK, */ // the symbolic names for the mouse buttons enum { wxMOUSE_BTN_ANY = -1, wxMOUSE_BTN_NONE = 0, wxMOUSE_BTN_LEFT = 1, wxMOUSE_BTN_MIDDLE = 2, wxMOUSE_BTN_RIGHT = 3 }; class WXDLLIMPEXP_CORE wxMouseEvent : public wxEvent { public: wxMouseEvent(wxEventType mouseType = wxEVT_NULL); wxMouseEvent(const wxMouseEvent& event) : wxEvent(event) { Assign(event); } // Was it a button event? (*doesn't* mean: is any button *down*?) bool IsButton() const { return Button(wxMOUSE_BTN_ANY); } // Was it a down event from this (or any) button? bool ButtonDown(int but = wxMOUSE_BTN_ANY) const; // Was it a dclick event from this (or any) button? bool ButtonDClick(int but = wxMOUSE_BTN_ANY) const; // Was it a up event from this (or any) button? bool ButtonUp(int but = wxMOUSE_BTN_ANY) const; // Was the given button? bool Button(int but) const; // Was the given button in Down state? bool ButtonIsDown(int but) const; // Get the button which is changing state (wxMOUSE_BTN_NONE if none) int GetButton() const; // Find state of shift/control keys bool ControlDown() const { return m_controlDown; } bool MetaDown() const { return m_metaDown; } bool AltDown() const { return m_altDown; } bool ShiftDown() const { return m_shiftDown; } bool CmdDown() const { #if defined(__WXMAC__) || defined(__WXCOCOA__) return MetaDown(); #else return ControlDown(); #endif } // Find which event was just generated bool LeftDown() const { return (m_eventType == wxEVT_LEFT_DOWN); } bool MiddleDown() const { return (m_eventType == wxEVT_MIDDLE_DOWN); } bool RightDown() const { return (m_eventType == wxEVT_RIGHT_DOWN); } bool LeftUp() const { return (m_eventType == wxEVT_LEFT_UP); } bool MiddleUp() const { return (m_eventType == wxEVT_MIDDLE_UP); } bool RightUp() const { return (m_eventType == wxEVT_RIGHT_UP); } bool LeftDClick() const { return (m_eventType == wxEVT_LEFT_DCLICK); } bool MiddleDClick() const { return (m_eventType == wxEVT_MIDDLE_DCLICK); } bool RightDClick() const { return (m_eventType == wxEVT_RIGHT_DCLICK); } // Find the current state of the mouse buttons (regardless // of current event type) bool LeftIsDown() const { return m_leftDown; } bool MiddleIsDown() const { return m_middleDown; } bool RightIsDown() const { return m_rightDown; } // True if a button is down and the mouse is moving bool Dragging() const { return (m_eventType == wxEVT_MOTION) && ButtonIsDown(wxMOUSE_BTN_ANY); } // True if the mouse is moving, and no button is down bool Moving() const { return (m_eventType == wxEVT_MOTION) && !ButtonIsDown(wxMOUSE_BTN_ANY); } // True if the mouse is just entering the window bool Entering() const { return (m_eventType == wxEVT_ENTER_WINDOW); } // True if the mouse is just leaving the window bool Leaving() const { return (m_eventType == wxEVT_LEAVE_WINDOW); } // Find the position of the event void GetPosition(wxCoord *xpos, wxCoord *ypos) const { if (xpos) *xpos = m_x; if (ypos) *ypos = m_y; } void GetPosition(long *xpos, long *ypos) const { if (xpos) *xpos = (long)m_x; if (ypos) *ypos = (long)m_y; } // Find the position of the event wxPoint GetPosition() const { return wxPoint(m_x, m_y); } // Find the logical position of the event given the DC wxPoint GetLogicalPosition(const wxDC& dc) const; // Get X position wxCoord GetX() const { return m_x; } // Get Y position wxCoord GetY() const { return m_y; } // Get wheel rotation, positive or negative indicates direction of // rotation. Current devices all send an event when rotation is equal to // +/-WheelDelta, but this allows for finer resolution devices to be // created in the future. Because of this you shouldn't assume that one // event is equal to 1 line or whatever, but you should be able to either // do partial line scrolling or wait until +/-WheelDelta rotation values // have been accumulated before scrolling. int GetWheelRotation() const { return m_wheelRotation; } // Get wheel delta, normally 120. This is the threshold for action to be // taken, and one such action (for example, scrolling one increment) // should occur for each delta. int GetWheelDelta() const { return m_wheelDelta; } // Returns the configured number of lines (or whatever) to be scrolled per // wheel action. Defaults to one. int GetLinesPerAction() const { return m_linesPerAction; } // Is the system set to do page scrolling? bool IsPageScroll() const { return ((unsigned int)m_linesPerAction == UINT_MAX); } virtual wxEvent *Clone() const { return new wxMouseEvent(*this); } wxMouseEvent& operator=(const wxMouseEvent& event) { Assign(event); return *this; } public: wxCoord m_x, m_y; bool m_leftDown; bool m_middleDown; bool m_rightDown; bool m_controlDown; bool m_shiftDown; bool m_altDown; bool m_metaDown; int m_wheelRotation; int m_wheelDelta; int m_linesPerAction; protected: void Assign(const wxMouseEvent& evt); private: DECLARE_DYNAMIC_CLASS(wxMouseEvent) }; // Cursor set event /* wxEVT_SET_CURSOR */ class WXDLLIMPEXP_CORE wxSetCursorEvent : public wxEvent { public: wxSetCursorEvent(wxCoord x = 0, wxCoord y = 0) : wxEvent(0, wxEVT_SET_CURSOR), m_x(x), m_y(y), m_cursor() { } wxSetCursorEvent(const wxSetCursorEvent & event) : wxEvent(event), m_x(event.m_x), m_y(event.m_y), m_cursor(event.m_cursor) { } wxCoord GetX() const { return m_x; } wxCoord GetY() const { return m_y; } void SetCursor(const wxCursor& cursor) { m_cursor = cursor; } const wxCursor& GetCursor() const { return m_cursor; } bool HasCursor() const { return m_cursor.Ok(); } virtual wxEvent *Clone() const { return new wxSetCursorEvent(*this); } private: wxCoord m_x, m_y; wxCursor m_cursor; private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSetCursorEvent) }; // Keyboard input event class /* wxEVT_CHAR wxEVT_CHAR_HOOK wxEVT_KEY_DOWN wxEVT_KEY_UP wxEVT_HOTKEY */ class WXDLLIMPEXP_CORE wxKeyEvent : public wxEvent { public: wxKeyEvent(wxEventType keyType = wxEVT_NULL); wxKeyEvent(const wxKeyEvent& evt); // Find state of shift/control keys bool ControlDown() const { return m_controlDown; } bool MetaDown() const { return m_metaDown; } bool AltDown() const { return m_altDown; } bool ShiftDown() const { return m_shiftDown; } // "Cmd" is a pseudo key which is Control for PC and Unix platforms but // Apple ("Command") key under Macs: it makes often sense to use it instead // of, say, ControlDown() because Cmd key is used for the same thing under // Mac as Ctrl elsewhere (but Ctrl still exists, just not used for this // purpose under Mac) bool CmdDown() const { #if defined(__WXMAC__) || defined(__WXCOCOA__) return MetaDown(); #else return ControlDown(); #endif } // exclude MetaDown() from HasModifiers() because NumLock under X is often // configured as mod2 modifier, yet the key events even when it is pressed // should be processed normally, not like Ctrl- or Alt-key bool HasModifiers() const { return ControlDown() || AltDown(); } // get the key code: an ASCII7 char or an element of wxKeyCode enum int GetKeyCode() const { return (int)m_keyCode; } #if wxUSE_UNICODE // get the Unicode character corresponding to this key wxChar GetUnicodeKey() const { return m_uniChar; } #endif // wxUSE_UNICODE // get the raw key code (platform-dependent) wxUint32 GetRawKeyCode() const { return m_rawCode; } // get the raw key flags (platform-dependent) wxUint32 GetRawKeyFlags() const { return m_rawFlags; } // Find the position of the event void GetPosition(wxCoord *xpos, wxCoord *ypos) const { if (xpos) *xpos = m_x; if (ypos) *ypos = m_y; } void GetPosition(long *xpos, long *ypos) const { if (xpos) *xpos = (long)m_x; if (ypos) *ypos = (long)m_y; } wxPoint GetPosition() const { return wxPoint(m_x, m_y); } // Get X position wxCoord GetX() const { return m_x; } // Get Y position wxCoord GetY() const { return m_y; } // deprecated, Use GetKeyCode instead. wxDEPRECATED( long KeyCode() const ); virtual wxEvent *Clone() const { return new wxKeyEvent(*this); } // we do need to copy wxKeyEvent sometimes (in wxTreeCtrl code, for // example) wxKeyEvent& operator=(const wxKeyEvent& evt) { m_x = evt.m_x; m_y = evt.m_y; m_keyCode = evt.m_keyCode; m_controlDown = evt.m_controlDown; m_shiftDown = evt.m_shiftDown; m_altDown = evt.m_altDown; m_metaDown = evt.m_metaDown; m_scanCode = evt.m_scanCode; m_rawCode = evt.m_rawCode; m_rawFlags = evt.m_rawFlags; #if wxUSE_UNICODE m_uniChar = evt.m_uniChar; #endif return *this; } public: wxCoord m_x, m_y; long m_keyCode; bool m_controlDown; bool m_shiftDown; bool m_altDown; bool m_metaDown; bool m_scanCode; #if wxUSE_UNICODE // This contains the full Unicode character // in a character events in Unicode mode wxChar m_uniChar; #endif // these fields contain the platform-specific information about // key that was pressed wxUint32 m_rawCode; wxUint32 m_rawFlags; private: DECLARE_DYNAMIC_CLASS(wxKeyEvent) }; // Size event class /* wxEVT_SIZE */ class WXDLLIMPEXP_CORE wxSizeEvent : public wxEvent { public: wxSizeEvent() : wxEvent(0, wxEVT_SIZE) { } wxSizeEvent(const wxSize& sz, int winid = 0) : wxEvent(winid, wxEVT_SIZE), m_size(sz) { } wxSizeEvent(const wxSizeEvent & event) : wxEvent(event), m_size(event.m_size), m_rect(event.m_rect) { } wxSizeEvent(const wxRect& rect, int id = 0) : m_size(rect.GetSize()), m_rect(rect) { m_eventType = wxEVT_SIZING; m_id = id; } wxSize GetSize() const { return m_size; } wxRect GetRect() const { return m_rect; } void SetRect(const wxRect& rect) { m_rect = rect; } virtual wxEvent *Clone() const { return new wxSizeEvent(*this); } public: // For internal usage only. Will be converted to protected members. wxSize m_size; wxRect m_rect; // Used for wxEVT_SIZING private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSizeEvent) }; // Move event class /* wxEVT_MOVE */ class WXDLLIMPEXP_CORE wxMoveEvent : public wxEvent { public: wxMoveEvent() : wxEvent(0, wxEVT_MOVE) { } wxMoveEvent(const wxPoint& pos, int winid = 0) : wxEvent(winid, wxEVT_MOVE), m_pos(pos) { } wxMoveEvent(const wxMoveEvent& event) : wxEvent(event), m_pos(event.m_pos) { } wxMoveEvent(const wxRect& rect, int id = 0) : m_pos(rect.GetPosition()), m_rect(rect) { m_eventType = wxEVT_MOVING; m_id = id; } wxPoint GetPosition() const { return m_pos; } void SetPosition(const wxPoint& pos) { m_pos = pos; } wxRect GetRect() const { return m_rect; } void SetRect(const wxRect& rect) { m_rect = rect; } virtual wxEvent *Clone() const { return new wxMoveEvent(*this); } #if WXWIN_COMPATIBILITY_2_4 public: #else protected: #endif wxPoint m_pos; wxRect m_rect; private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMoveEvent) }; // Paint event class /* wxEVT_PAINT wxEVT_NC_PAINT wxEVT_PAINT_ICON */ #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__)) // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined extern WXDLLIMPEXP_CORE int g_isPainting; #endif // debug class WXDLLIMPEXP_CORE wxPaintEvent : public wxEvent { public: wxPaintEvent(int Id = 0) : wxEvent(Id, wxEVT_PAINT) { #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__)) // set the internal flag for the duration of processing of WM_PAINT g_isPainting++; #endif // debug } // default copy ctor and dtor are normally fine, we only need them to keep // g_isPainting updated in debug build #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__)) wxPaintEvent(const wxPaintEvent& event) : wxEvent(event) { g_isPainting++; } ~wxPaintEvent() { g_isPainting--; } #endif // debug virtual wxEvent *Clone() const { return new wxPaintEvent(*this); } private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaintEvent) }; class WXDLLIMPEXP_CORE wxNcPaintEvent : public wxEvent { public: wxNcPaintEvent(int winid = 0) : wxEvent(winid, wxEVT_NC_PAINT) { } virtual wxEvent *Clone() const { return new wxNcPaintEvent(*this); } private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNcPaintEvent) }; // Erase background event class /* wxEVT_ERASE_BACKGROUND */ class WXDLLIMPEXP_CORE wxEraseEvent : public wxEvent { public: wxEraseEvent(int Id = 0, wxDC *dc = (wxDC *) NULL) : wxEvent(Id, wxEVT_ERASE_BACKGROUND), m_dc(dc) { } wxEraseEvent(const wxEraseEvent& event) : wxEvent(event), m_dc(event.m_dc) { } wxDC *GetDC() const { return m_dc; } virtual wxEvent *Clone() const { return new wxEraseEvent(*this); } #if WXWIN_COMPATIBILITY_2_4 public: #else protected: #endif wxDC *m_dc; private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxEraseEvent) }; // Focus event class /* wxEVT_SET_FOCUS wxEVT_KILL_FOCUS */ class WXDLLIMPEXP_CORE wxFocusEvent : public wxEvent { public: wxFocusEvent(wxEventType type = wxEVT_NULL, int winid = 0) : wxEvent(winid, type) { m_win = NULL; } wxFocusEvent(const wxFocusEvent& event) : wxEvent(event) { m_win = event.m_win; } // The window associated with this event is the window which had focus // before for SET event and the window which will have focus for the KILL // one. NB: it may be NULL in both cases! wxWindow *GetWindow() const { return m_win; } void SetWindow(wxWindow *win) { m_win = win; } virtual wxEvent *Clone() const { return new wxFocusEvent(*this); } private: wxWindow *m_win; private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFocusEvent) }; // wxChildFocusEvent notifies the parent that a child has got the focus: unlike // wxFocusEvent it is propagated upwards the window chain class WXDLLIMPEXP_CORE wxChildFocusEvent : public wxCommandEvent { public: wxChildFocusEvent(wxWindow *win = NULL); wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); } virtual wxEvent *Clone() const { return new wxChildFocusEvent(*this); } private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxChildFocusEvent) }; // Activate event class /* wxEVT_ACTIVATE wxEVT_ACTIVATE_APP wxEVT_HIBERNATE */ class WXDLLIMPEXP_CORE wxActivateEvent : public wxEvent { public: wxActivateEvent(wxEventType type = wxEVT_NULL, bool active = true, int Id = 0) : wxEvent(Id, type) { m_active = active; } wxActivateEvent(const wxActivateEvent& event) : wxEvent(event) { m_active = event.m_active; } bool GetActive() const { return m_active; } virtual wxEvent *Clone() const { return new wxActivateEvent(*this); } private: bool m_active; private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxActivateEvent) }; // InitDialog event class /* wxEVT_INIT_DIALOG */ class WXDLLIMPEXP_CORE wxInitDialogEvent : public wxEvent { public: wxInitDialogEvent(int Id = 0) : wxEvent(Id, wxEVT_INIT_DIALOG) { } virtual wxEvent *Clone() const { return new wxInitDialogEvent(*this); } private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxInitDialogEvent) }; // Miscellaneous menu event class /* wxEVT_MENU_OPEN, wxEVT_MENU_CLOSE, wxEVT_MENU_HIGHLIGHT, */ class WXDLLIMPEXP_CORE wxMenuEvent : public wxEvent { public: wxMenuEvent(wxEventType type = wxEVT_NULL, int winid = 0, wxMenu* menu = NULL) : wxEvent(winid, type) { m_menuId = winid; m_menu = menu; } wxMenuEvent(const wxMenuEvent & event) : wxEvent(event) { m_menuId = event.m_menuId; m_menu = event.m_menu; } // only for wxEVT_MENU_HIGHLIGHT int GetMenuId() const { return m_menuId; } // only for wxEVT_MENU_OPEN/CLOSE bool IsPopup() const { return m_menuId == wxID_ANY; } // only for wxEVT_MENU_OPEN/CLOSE wxMenu* GetMenu() const { return m_menu; } virtual wxEvent *Clone() const { return new wxMenuEvent(*this); } private: int m_menuId; wxMenu* m_menu; DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMenuEvent) }; // Window close or session close event class /* wxEVT_CLOSE_WINDOW, wxEVT_END_SESSION, wxEVT_QUERY_END_SESSION */ class WXDLLIMPEXP_CORE wxCloseEvent : public wxEvent { public: wxCloseEvent(wxEventType type = wxEVT_NULL, int winid = 0) : wxEvent(winid, type), m_loggingOff(true), m_veto(false), // should be false by default m_canVeto(true) {} wxCloseEvent(const wxCloseEvent & event) : wxEvent(event), m_loggingOff(event.m_loggingOff), m_veto(event.m_veto), m_canVeto(event.m_canVeto) {} void SetLoggingOff(bool logOff) { m_loggingOff = logOff; } bool GetLoggingOff() const { // m_loggingOff flag is only used by wxEVT_[QUERY_]END_SESSION, it // doesn't make sense for wxEVT_CLOSE_WINDOW wxASSERT_MSG( m_eventType != wxEVT_CLOSE_WINDOW, _T("this flag is for end session events only") ); return m_loggingOff; } void Veto(bool veto = true) { // GetVeto() will return false anyhow... wxCHECK_RET( m_canVeto, wxT("call to Veto() ignored (can't veto this event)") ); m_veto = veto; } void SetCanVeto(bool canVeto) { m_canVeto = canVeto; } bool CanVeto() const { return m_canVeto; } bool GetVeto() const { return m_canVeto && m_veto; } virtual wxEvent *Clone() const { return new wxCloseEvent(*this); } protected: bool m_loggingOff, m_veto, m_canVeto; private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCloseEvent) }; /* wxEVT_SHOW */ class WXDLLIMPEXP_CORE wxShowEvent : public wxEvent { public: wxShowEvent(int winid = 0, bool show = false) : wxEvent(winid, wxEVT_SHOW) { m_show = show; } wxShowEvent(const wxShowEvent & event) : wxEvent(event) { m_show = event.m_show; } void SetShow(bool show) { m_show = show; } bool GetShow() const { return m_show; } virtual wxEvent *Clone() const { return new wxShowEvent(*this); } protected: bool m_show; private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxShowEvent) }; /* wxEVT_ICONIZE */ class WXDLLIMPEXP_CORE wxIconizeEvent : public wxEvent { public: wxIconizeEvent(int winid = 0, bool iconized = true) : wxEvent(winid, wxEVT_ICONIZE) { m_iconized = iconized; } wxIconizeEvent(const wxIconizeEvent & event) : wxEvent(event) { m_iconized = event.m_iconized; } // return true if the frame was iconized, false if restored bool Iconized() const { return m_iconized; } virtual wxEvent *Clone() const { return new wxIconizeEvent(*this); } protected: bool m_iconized; private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIconizeEvent) }; /* wxEVT_MAXIMIZE */ class WXDLLIMPEXP_CORE wxMaximizeEvent : public wxEvent { public: wxMaximizeEvent(int winid = 0) : wxEvent(winid, wxEVT_MAXIMIZE) { } virtual wxEvent *Clone() const { return new wxMaximizeEvent(*this); } private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMaximizeEvent) }; // Joystick event class /* wxEVT_JOY_BUTTON_DOWN, wxEVT_JOY_BUTTON_UP, wxEVT_JOY_MOVE, wxEVT_JOY_ZMOVE */ // Which joystick? Same as Windows ids so no conversion necessary. enum { wxJOYSTICK1, wxJOYSTICK2 }; // Which button is down? enum { wxJOY_BUTTON_ANY = -1, wxJOY_BUTTON1 = 1, wxJOY_BUTTON2 = 2, wxJOY_BUTTON3 = 4, wxJOY_BUTTON4 = 8 }; class WXDLLIMPEXP_CORE wxJoystickEvent : public wxEvent { #if WXWIN_COMPATIBILITY_2_4 public: #else protected: #endif wxPoint m_pos; int m_zPosition; int m_buttonChange; // Which button changed? int m_buttonState; // Which buttons are down? int m_joyStick; // Which joystick? public: wxJoystickEvent(wxEventType type = wxEVT_NULL, int state = 0, int joystick = wxJOYSTICK1, int change = 0) : wxEvent(0, type), m_pos(), m_zPosition(0), m_buttonChange(change), m_buttonState(state), m_joyStick(joystick) { } wxJoystickEvent(const wxJoystickEvent & event) : wxEvent(event), m_pos(event.m_pos), m_zPosition(event.m_zPosition), m_buttonChange(event.m_buttonChange), m_buttonState(event.m_buttonState), m_joyStick(event.m_joyStick) { } wxPoint GetPosition() const { return m_pos; } int GetZPosition() const { return m_zPosition; } int GetButtonState() const { return m_buttonState; } int GetButtonChange() const { return m_buttonChange; } int GetJoystick() const { return m_joyStick; } void SetJoystick(int stick) { m_joyStick = stick; } void SetButtonState(int state) { m_buttonState = state; } void SetButtonChange(int change) { m_buttonChange = change; } void SetPosition(const wxPoint& pos) { m_pos = pos; } void SetZPosition(int zPos) { m_zPosition = zPos; } // Was it a button event? (*doesn't* mean: is any button *down*?) bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) || (GetEventType() == wxEVT_JOY_BUTTON_UP)); } // Was it a move event? bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE); } // Was it a zmove event? bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE); } // Was it a down event from button 1, 2, 3, 4 or any? bool ButtonDown(int but = wxJOY_BUTTON_ANY) const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) && ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); } // Was it a up event from button 1, 2, 3 or any? bool ButtonUp(int but = wxJOY_BUTTON_ANY) const { return ((GetEventType() == wxEVT_JOY_BUTTON_UP) && ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); } // Was the given button 1,2,3,4 or any in Down state? bool ButtonIsDown(int but = wxJOY_BUTTON_ANY) const { return (((but == wxJOY_BUTTON_ANY) && (m_buttonState != 0)) || ((m_buttonState & but) == but)); } virtual wxEvent *Clone() const { return new wxJoystickEvent(*this); } private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxJoystickEvent) }; // Drop files event class /* wxEVT_DROP_FILES */ class WXDLLIMPEXP_CORE wxDropFilesEvent : public wxEvent { public: int m_noFiles; wxPoint m_pos; wxString* m_files; wxDropFilesEvent(wxEventType type = wxEVT_NULL, int noFiles = 0, wxString *files = (wxString *) NULL) : wxEvent(0, type), m_noFiles(noFiles), m_pos(), m_files(files) { } // we need a copy ctor to avoid deleting m_files pointer twice wxDropFilesEvent(const wxDropFilesEvent& other) : wxEvent(other), m_noFiles(other.m_noFiles), m_pos(other.m_pos), m_files(NULL) { m_files = new wxString[m_noFiles]; for ( int n = 0; n < m_noFiles; n++ ) { m_files[n] = other.m_files[n]; } } virtual ~wxDropFilesEvent() { delete [] m_files; } wxPoint GetPosition() const { return m_pos; } int GetNumberOfFiles() const { return m_noFiles; } wxString *GetFiles() const { return m_files; } virtual wxEvent *Clone() const { return new wxDropFilesEvent(*this); } private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDropFilesEvent) }; // Update UI event /* wxEVT_UPDATE_UI */ // Whether to always send update events to windows, or // to only send update events to those with the // wxWS_EX_PROCESS_UI_UPDATES style. enum wxUpdateUIMode { // Send UI update events to all windows wxUPDATE_UI_PROCESS_ALL, // Send UI update events to windows that have // the wxWS_EX_PROCESS_UI_UPDATES flag specified wxUPDATE_UI_PROCESS_SPECIFIED }; class WXDLLIMPEXP_CORE wxUpdateUIEvent : public wxCommandEvent { public: wxUpdateUIEvent(wxWindowID commandId = 0) : wxCommandEvent(wxEVT_UPDATE_UI, commandId) { m_checked = m_enabled = m_setEnabled = m_setText = m_setChecked = false; } wxUpdateUIEvent(const wxUpdateUIEvent & event) : wxCommandEvent(event), m_checked(event.m_checked), m_enabled(event.m_enabled), m_setEnabled(event.m_setEnabled), m_setText(event.m_setText), m_setChecked(event.m_setChecked), m_text(event.m_text) { } bool GetChecked() const { return m_checked; } bool GetEnabled() const { return m_enabled; } wxString GetText() const { return m_text; } bool GetSetText() const { return m_setText; } bool GetSetChecked() const { return m_setChecked; } bool GetSetEnabled() const { return m_setEnabled; } void Check(bool check) { m_checked = check; m_setChecked = true; } void Enable(bool enable) { m_enabled = enable; m_setEnabled = true; } void SetText(const wxString& text) { m_text = text; m_setText = true; } // Sets the interval between updates in milliseconds. // Set to -1 to disable updates, or to 0 to update as frequently as possible. static void SetUpdateInterval(long updateInterval) { sm_updateInterval = updateInterval; } // Returns the current interval between updates in milliseconds static long GetUpdateInterval() { return sm_updateInterval; } // Can we update this window? static bool CanUpdate(wxWindowBase *win); // Reset the update time to provide a delay until the next // time we should update static void ResetUpdateTime(); // Specify how wxWidgets will send update events: to // all windows, or only to those which specify that they // will process the events. static void SetMode(wxUpdateUIMode mode) { sm_updateMode = mode; } // Returns the UI update mode static wxUpdateUIMode GetMode() { return sm_updateMode; } virtual wxEvent *Clone() const { return new wxUpdateUIEvent(*this); } protected: bool m_checked; bool m_enabled; bool m_setEnabled; bool m_setText; bool m_setChecked; wxString m_text; #if wxUSE_LONGLONG static wxLongLong sm_lastUpdate; #endif static long sm_updateInterval; static wxUpdateUIMode sm_updateMode; private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxUpdateUIEvent) }; /* wxEVT_SYS_COLOUR_CHANGED */ // TODO: shouldn't all events record the window ID? class WXDLLIMPEXP_CORE wxSysColourChangedEvent : public wxEvent { public: wxSysColourChangedEvent() : wxEvent(0, wxEVT_SYS_COLOUR_CHANGED) { } virtual wxEvent *Clone() const { return new wxSysColourChangedEvent(*this); } private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSysColourChangedEvent) }; /* wxEVT_MOUSE_CAPTURE_CHANGED The window losing the capture receives this message (even if it released the capture itself). */ class WXDLLIMPEXP_CORE wxMouseCaptureChangedEvent : public wxEvent { public: wxMouseCaptureChangedEvent(wxWindowID winid = 0, wxWindow* gainedCapture = NULL) : wxEvent(winid, wxEVT_MOUSE_CAPTURE_CHANGED), m_gainedCapture(gainedCapture) { } wxMouseCaptureChangedEvent(const wxMouseCaptureChangedEvent& event) : wxEvent(event), m_gainedCapture(event.m_gainedCapture) { } virtual wxEvent *Clone() const { return new wxMouseCaptureChangedEvent(*this); } wxWindow* GetCapturedWindow() const { return m_gainedCapture; }; private: wxWindow* m_gainedCapture; DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureChangedEvent) }; /* wxEVT_DISPLAY_CHANGED */ class WXDLLIMPEXP_CORE wxDisplayChangedEvent : public wxEvent { private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDisplayChangedEvent) public: wxDisplayChangedEvent() : wxEvent(0, wxEVT_DISPLAY_CHANGED) { } virtual wxEvent *Clone() const { return new wxDisplayChangedEvent(*this); } }; /* wxEVT_PALETTE_CHANGED */ class WXDLLIMPEXP_CORE wxPaletteChangedEvent : public wxEvent { public: wxPaletteChangedEvent(wxWindowID winid = 0) : wxEvent(winid, wxEVT_PALETTE_CHANGED), m_changedWindow((wxWindow *) NULL) { } wxPaletteChangedEvent(const wxPaletteChangedEvent& event) : wxEvent(event), m_changedWindow(event.m_changedWindow) { } void SetChangedWindow(wxWindow* win) { m_changedWindow = win; } wxWindow* GetChangedWindow() const { return m_changedWindow; } virtual wxEvent *Clone() const { return new wxPaletteChangedEvent(*this); } protected: wxWindow* m_changedWindow; private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaletteChangedEvent) }; /* wxEVT_QUERY_NEW_PALETTE Indicates the window is getting keyboard focus and should re-do its palette. */ class WXDLLIMPEXP_CORE wxQueryNewPaletteEvent : public wxEvent { public: wxQueryNewPaletteEvent(wxWindowID winid = 0) : wxEvent(winid, wxEVT_QUERY_NEW_PALETTE), m_paletteRealized(false) { } wxQueryNewPaletteEvent(const wxQueryNewPaletteEvent & event) : wxEvent(event), m_paletteRealized(event.m_paletteRealized) { } // App sets this if it changes the palette. void SetPaletteRealized(bool realized) { m_paletteRealized = realized; } bool GetPaletteRealized() const { return m_paletteRealized; } virtual wxEvent *Clone() const { return new wxQueryNewPaletteEvent(*this); } protected: bool m_paletteRealized; private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxQueryNewPaletteEvent) }; /* Event generated by dialog navigation keys wxEVT_NAVIGATION_KEY */ // NB: don't derive from command event to avoid being propagated to the parent class WXDLLIMPEXP_CORE wxNavigationKeyEvent : public wxEvent { public: wxNavigationKeyEvent() : wxEvent(0, wxEVT_NAVIGATION_KEY), m_flags(IsForward | FromTab), // defaults are for TAB m_focus((wxWindow *)NULL) { m_propagationLevel = wxEVENT_PROPAGATE_NONE; } wxNavigationKeyEvent(const wxNavigationKeyEvent& event) : wxEvent(event), m_flags(event.m_flags), m_focus(event.m_focus) { } // direction: forward (true) or backward (false) bool GetDirection() const { return (m_flags & IsForward) != 0; } void SetDirection(bool bForward) { if ( bForward ) m_flags |= IsForward; else m_flags &= ~IsForward; } // it may be a window change event (MDI, notebook pages...) or a control // change event bool IsWindowChange() const { return (m_flags & WinChange) != 0; } void SetWindowChange(bool bIs) { if ( bIs ) m_flags |= WinChange; else m_flags &= ~WinChange; } // Set to true under MSW if the event was generated using the tab key. // This is required for proper navogation over radio buttons bool IsFromTab() const { return (m_flags & FromTab) != 0; } void SetFromTab(bool bIs) { if ( bIs ) m_flags |= FromTab; else m_flags &= ~FromTab; } // the child which has the focus currently (may be NULL - use // wxWindow::FindFocus then) wxWindow* GetCurrentFocus() const { return m_focus; } void SetCurrentFocus(wxWindow *win) { m_focus = win; } // Set flags void SetFlags(long flags) { m_flags = flags; } virtual wxEvent *Clone() const { return new wxNavigationKeyEvent(*this); } enum { IsBackward = 0x0000, IsForward = 0x0001, WinChange = 0x0002, FromTab = 0x0004 }; long m_flags; wxWindow *m_focus; private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNavigationKeyEvent) }; // Window creation/destruction events: the first is sent as soon as window is // created (i.e. the underlying GUI object exists), but when the C++ object is // fully initialized (so virtual functions may be called). The second, // wxEVT_DESTROY, is sent right before the window is destroyed - again, it's // still safe to call virtual functions at this moment /* wxEVT_CREATE wxEVT_DESTROY */ class WXDLLIMPEXP_CORE wxWindowCreateEvent : public wxCommandEvent { public: wxWindowCreateEvent(wxWindow *win = NULL); wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); } virtual wxEvent *Clone() const { return new wxWindowCreateEvent(*this); } private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowCreateEvent) }; class WXDLLIMPEXP_CORE wxWindowDestroyEvent : public wxCommandEvent { public: wxWindowDestroyEvent(wxWindow *win = NULL); wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); } virtual wxEvent *Clone() const { return new wxWindowDestroyEvent(*this); } private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowDestroyEvent) }; // A help event is sent when the user clicks on a window in context-help mode. /* wxEVT_HELP wxEVT_DETAILED_HELP */ class WXDLLIMPEXP_CORE wxHelpEvent : public wxCommandEvent { public: wxHelpEvent(wxEventType type = wxEVT_NULL, wxWindowID winid = 0, const wxPoint& pt = wxDefaultPosition) : wxCommandEvent(type, winid), m_pos(pt), m_target(), m_link() { } wxHelpEvent(const wxHelpEvent & event) : wxCommandEvent(event), m_pos(event.m_pos), m_target(event.m_target), m_link(event.m_link) { } // Position of event (in screen coordinates) const wxPoint& GetPosition() const { return m_pos; } void SetPosition(const wxPoint& pos) { m_pos = pos; } // Optional link to further help const wxString& GetLink() const { return m_link; } void SetLink(const wxString& link) { m_link = link; } // Optional target to display help in. E.g. a window specification const wxString& GetTarget() const { return m_target; } void SetTarget(const wxString& target) { m_target = target; } virtual wxEvent *Clone() const { return new wxHelpEvent(*this); } protected: wxPoint m_pos; wxString m_target; wxString m_link; private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHelpEvent) }; // A Context event is sent when the user right clicks on a window or // presses Shift-F10 // NOTE : Under windows this is a repackaged WM_CONTETXMENU message // Under other systems it may have to be generated from a right click event /* wxEVT_CONTEXT_MENU */ class WXDLLIMPEXP_CORE wxContextMenuEvent : public wxCommandEvent { public: wxContextMenuEvent(wxEventType type = wxEVT_NULL, wxWindowID winid = 0, const wxPoint& pt = wxDefaultPosition) : wxCommandEvent(type, winid), m_pos(pt) { } wxContextMenuEvent(const wxContextMenuEvent & event) : wxCommandEvent(event), m_pos(event.m_pos) { } // Position of event (in screen coordinates) const wxPoint& GetPosition() const { return m_pos; } void SetPosition(const wxPoint& pos) { m_pos = pos; } virtual wxEvent *Clone() const { return new wxContextMenuEvent(*this); } protected: wxPoint m_pos; private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxContextMenuEvent) }; // Idle event /* wxEVT_IDLE */ // Whether to always send idle events to windows, or // to only send update events to those with the // wxWS_EX_PROCESS_IDLE style. enum wxIdleMode { // Send idle events to all windows wxIDLE_PROCESS_ALL, // Send idle events to windows that have // the wxWS_EX_PROCESS_IDLE flag specified wxIDLE_PROCESS_SPECIFIED }; class WXDLLIMPEXP_CORE wxIdleEvent : public wxEvent { public: wxIdleEvent() : wxEvent(0, wxEVT_IDLE), m_requestMore(false) { } wxIdleEvent(const wxIdleEvent & event) : wxEvent(event), m_requestMore(event.m_requestMore) { } void RequestMore(bool needMore = true) { m_requestMore = needMore; } bool MoreRequested() const { return m_requestMore; } virtual wxEvent *Clone() const { return new wxIdleEvent(*this); } // Specify how wxWidgets will send idle events: to // all windows, or only to those which specify that they // will process the events. static void SetMode(wxIdleMode mode) { sm_idleMode = mode; } // Returns the idle event mode static wxIdleMode GetMode() { return sm_idleMode; } // Can we send an idle event? static bool CanSend(wxWindow* win); protected: bool m_requestMore; static wxIdleMode sm_idleMode; private: DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIdleEvent) }; #endif // wxUSE_GUI /* TODO wxEVT_POWER, wxEVT_MOUSE_CAPTURE_CHANGED, wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95) // wxEVT_FONT_CHANGED, // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate // wxEVT_FONT_CHANGED to all other windows (maybe). wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific. wxEVT_MEASURE_ITEM, wxEVT_COMPARE_ITEM */ // ============================================================================ // event handler and related classes // ============================================================================ // for backwards compatibility and to prevent eVC 4 for ARM from crashing with // internal compiler error when compiling wx, we define wxObjectEventFunction // as a wxObject method even though it can only be a wxEvtHandler one typedef void (wxObject::*wxObjectEventFunction)(wxEvent&); // we can't have ctors nor base struct in backwards compatibility mode or // otherwise we won't be able to initialize the objects with an agregate, so // we have to keep both versions #if WXWIN_COMPATIBILITY_EVENT_TYPES struct WXDLLIMPEXP_BASE wxEventTableEntry { // For some reason, this can't be wxEventType, or VC++ complains. int m_eventType; // main event type int m_id; // control/menu/toolbar id int m_lastId; // used for ranges of ids wxObjectEventFunction m_fn; // function to call: not wxEventFunction, // because of dependency problems wxObject* m_callbackUserData; }; #else // !WXWIN_COMPATIBILITY_EVENT_TYPES // struct containing the members common to static and dynamic event tables // entries struct WXDLLIMPEXP_BASE wxEventTableEntryBase { private: wxEventTableEntryBase& operator=(const wxEventTableEntryBase& event); public: wxEventTableEntryBase(int winid, int idLast, wxObjectEventFunction fn, wxObject *data) : m_id(winid), m_lastId(idLast), m_fn(fn), m_callbackUserData(data) { } wxEventTableEntryBase(const wxEventTableEntryBase& event) : m_id(event.m_id), m_lastId(event.m_lastId), m_fn(event.m_fn), m_callbackUserData(event.m_callbackUserData) { } // the range of ids for this entry: if m_lastId == wxID_ANY, the range // consists only of m_id, otherwise it is m_id..m_lastId inclusive int m_id, m_lastId; // function to call: not wxEventFunction, because of dependency problems wxObjectEventFunction m_fn; // arbitrary user data asosciated with the callback wxObject* m_callbackUserData; }; // an entry from a static event table struct WXDLLIMPEXP_BASE wxEventTableEntry : public wxEventTableEntryBase { wxEventTableEntry(const int& evType, int winid, int idLast, wxObjectEventFunction fn, wxObject *data) : wxEventTableEntryBase(winid, idLast, fn, data), m_eventType(evType) { } // the reference to event type: this allows us to not care about the // (undefined) order in which the event table entries and the event types // are initialized: initially the value of this reference might be // invalid, but by the time it is used for the first time, all global // objects will have been initialized (including the event type constants) // and so it will have the correct value when it is needed const int& m_eventType; private: wxEventTableEntry& operator=(const wxEventTableEntry&); }; // an entry used in dynamic event table managed by wxEvtHandler::Connect() struct WXDLLIMPEXP_BASE wxDynamicEventTableEntry : public wxEventTableEntryBase { wxDynamicEventTableEntry(int evType, int winid, int idLast, wxObjectEventFunction fn, wxObject *data, wxEvtHandler* eventSink) : wxEventTableEntryBase(winid, idLast, fn, data), m_eventType(evType), m_eventSink(eventSink) { } // not a reference here as we can't keep a reference to a temporary int // created to wrap the constant value typically passed to Connect() - nor // do we need it int m_eventType; // Pointer to object whose function is fn - so we don't assume the // EventFunction is always a member of the EventHandler receiving the // message wxEvtHandler* m_eventSink; DECLARE_NO_COPY_CLASS(wxDynamicEventTableEntry) }; #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES // ---------------------------------------------------------------------------- // wxEventTable: an array of event entries terminated with {0, 0, 0, 0, 0} // ---------------------------------------------------------------------------- struct WXDLLIMPEXP_BASE wxEventTable { const wxEventTable *baseTable; // base event table (next in chain) const wxEventTableEntry *entries; // bottom of entry array }; // ---------------------------------------------------------------------------- // wxEventHashTable: a helper of wxEvtHandler to speed up wxEventTable lookups. // ---------------------------------------------------------------------------- WX_DEFINE_ARRAY_PTR(const wxEventTableEntry*, wxEventTableEntryPointerArray); class WXDLLIMPEXP_BASE wxEventHashTable { private: // Internal data structs struct EventTypeTable { wxEventType eventType; wxEventTableEntryPointerArray eventEntryTable; }; typedef EventTypeTable* EventTypeTablePointer; public: // Constructor, needs the event table it needs to hash later on. // Note: hashing of the event table is not done in the constructor as it // can be that the event table is not yet full initialize, the hash // will gets initialized when handling the first event look-up request. wxEventHashTable(const wxEventTable &table); // Destructor. ~wxEventHashTable(); // Handle the given event, in other words search the event table hash // and call self->ProcessEvent() if a match was found. bool HandleEvent(wxEvent &event, wxEvtHandler *self); // Clear table void Clear(); // Clear all tables static void ClearAll(); protected: // Init the hash table with the entries of the static event table. void InitHashTable(); // Helper funtion of InitHashTable() to insert 1 entry into the hash table. void AddEntry(const wxEventTableEntry &entry); // Allocate and init with null pointers the base hash table. void AllocEventTypeTable(size_t size); // Grow the hash table in size and transfer all items currently // in the table to the correct location in the new table. void GrowEventTypeTable(); protected: const wxEventTable &m_table; bool m_rebuildHash; size_t m_size; EventTypeTablePointer *m_eventTypeTable; static wxEventHashTable* sm_first; wxEventHashTable* m_previous; wxEventHashTable* m_next; DECLARE_NO_COPY_CLASS(wxEventHashTable) }; // ---------------------------------------------------------------------------- // wxEvtHandler: the base class for all objects handling wxWidgets events // ---------------------------------------------------------------------------- class WXDLLIMPEXP_BASE wxEvtHandler : public wxObject { public: wxEvtHandler(); virtual ~wxEvtHandler(); wxEvtHandler *GetNextHandler() const { return m_nextHandler; } wxEvtHandler *GetPreviousHandler() const { return m_previousHandler; } void SetNextHandler(wxEvtHandler *handler) { m_nextHandler = handler; } void SetPreviousHandler(wxEvtHandler *handler) { m_previousHandler = handler; } void SetEvtHandlerEnabled(bool enabled) { m_enabled = enabled; } bool GetEvtHandlerEnabled() const { return m_enabled; } // process an event right now virtual bool ProcessEvent(wxEvent& event); // add an event to be processed later void AddPendingEvent(wxEvent& event); // process all pending events void ProcessPendingEvents(); #if wxUSE_THREADS bool ProcessThreadEvent(wxEvent& event); #endif // Dynamic association of a member function handler with the event handler, // winid and event type void Connect(int winid, int lastId, int eventType, wxObjectEventFunction func, wxObject *userData = (wxObject *) NULL, wxEvtHandler *eventSink = (wxEvtHandler *) NULL); // Convenience function: take just one id void Connect(int winid, int eventType, wxObjectEventFunction func, wxObject *userData = (wxObject *) NULL, wxEvtHandler *eventSink = (wxEvtHandler *) NULL) { Connect(winid, wxID_ANY, eventType, func, userData, eventSink); } // Even more convenient: without id (same as using id of wxID_ANY) void Connect(int eventType, wxObjectEventFunction func, wxObject *userData = (wxObject *) NULL, wxEvtHandler *eventSink = (wxEvtHandler *) NULL) { Connect(wxID_ANY, wxID_ANY, eventType, func, userData, eventSink); } bool Disconnect(int winid, int lastId, wxEventType eventType, wxObjectEventFunction func = NULL, wxObject *userData = (wxObject *) NULL, wxEvtHandler *eventSink = (wxEvtHandler *) NULL); bool Disconnect(int winid = wxID_ANY, wxEventType eventType = wxEVT_NULL, wxObjectEventFunction func = NULL, wxObject *userData = (wxObject *) NULL, wxEvtHandler *eventSink = (wxEvtHandler *) NULL) { return Disconnect(winid, wxID_ANY, eventType, func, userData, eventSink); } bool Disconnect(wxEventType eventType, wxObjectEventFunction func, wxObject *userData = (wxObject *) NULL, wxEvtHandler *eventSink = (wxEvtHandler *) NULL) { return Disconnect(wxID_ANY, eventType, func, userData, eventSink); } wxList* GetDynamicEventTable() const { return m_dynamicEvents ; } // User data can be associated with each wxEvtHandler void SetClientObject( wxClientData *data ) { DoSetClientObject(data); } wxClientData *GetClientObject() const { return DoGetClientObject(); } void SetClientData( void *data ) { DoSetClientData(data); } void *GetClientData() const { return DoGetClientData(); } // check if the given event table entry matches this event and call the // handler if it does // // return true if the event was processed, false otherwise (no match or the // handler decided to skip the event) static bool ProcessEventIfMatches(const wxEventTableEntryBase& tableEntry, wxEvtHandler *handler, wxEvent& event); // implementation from now on virtual bool SearchEventTable(wxEventTable& table, wxEvent& event); bool SearchDynamicEventTable( wxEvent& event ); #if wxUSE_THREADS void ClearEventLocker(); #endif // wxUSE_THREADS // Avoid problems at exit by cleaning up static hash table gracefully void ClearEventHashTable() { GetEventHashTable().Clear(); } private: static const wxEventTableEntry sm_eventTableEntries[]; protected: // hooks for wxWindow used by ProcessEvent() // ----------------------------------------- // This one is called before trying our own event table to allow plugging // in the validators. // // NB: This method is intentionally *not* inside wxUSE_VALIDATORS! // It is part of wxBase which doesn't use validators and the code // is compiled out when building wxBase w/o GUI classes, which affects // binary compatibility and wxBase library can't be used by GUI // ports. virtual bool TryValidator(wxEvent& WXUNUSED(event)) { return false; } // this one is called after failing to find the event handle in our own // table to give a chance to the other windows to process it // // base class implementation passes the event to wxTheApp virtual bool TryParent(wxEvent& event); static const wxEventTable sm_eventTable; virtual const wxEventTable *GetEventTable() const; static wxEventHashTable sm_eventHashTable; virtual wxEventHashTable& GetEventHashTable() const; wxEvtHandler* m_nextHandler; wxEvtHandler* m_previousHandler; wxList* m_dynamicEvents; wxList* m_pendingEvents; #if wxUSE_THREADS #if defined (__VISAGECPP__) const wxCriticalSection& Lock() const { return m_eventsLocker; } wxCriticalSection& Lock() { return m_eventsLocker; } wxCriticalSection m_eventsLocker; # else const wxCriticalSection& Lock() const { return *m_eventsLocker; } wxCriticalSection& Lock() { return *m_eventsLocker; } wxCriticalSection* m_eventsLocker; # endif #endif // Is event handler enabled? bool m_enabled; // The user data: either an object which will be deleted by the container // when it's deleted or some raw pointer which we do nothing with - only // one type of data can be used with the given window (i.e. you cannot set // the void data and then associate the container with wxClientData or vice // versa) union { wxClientData *m_clientObject; void *m_clientData; }; // what kind of data do we have? wxClientDataType m_clientDataType; // client data accessors virtual void DoSetClientObject( wxClientData *data ); virtual wxClientData *DoGetClientObject() const; virtual void DoSetClientData( void *data ); virtual void *DoGetClientData() const; private: DECLARE_DYNAMIC_CLASS_NO_COPY(wxEvtHandler) }; // Post a message to the given eventhandler which will be processed during the // next event loop iteration inline void wxPostEvent(wxEvtHandler *dest, wxEvent& event) { wxCHECK_RET( dest, wxT("need an object to post event to in wxPostEvent") ); dest->AddPendingEvent(event); } typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&); #define wxEventHandler(func) \ (wxObjectEventFunction)wxStaticCastEvent(wxEventFunction, &func) #if wxUSE_GUI typedef void (wxEvtHandler::*wxCommandEventFunction)(wxCommandEvent&); typedef void (wxEvtHandler::*wxScrollEventFunction)(wxScrollEvent&); typedef void (wxEvtHandler::*wxScrollWinEventFunction)(wxScrollWinEvent&); typedef void (wxEvtHandler::*wxSizeEventFunction)(wxSizeEvent&); typedef void (wxEvtHandler::*wxMoveEventFunction)(wxMoveEvent&); typedef void (wxEvtHandler::*wxPaintEventFunction)(wxPaintEvent&); typedef void (wxEvtHandler::*wxNcPaintEventFunction)(wxNcPaintEvent&); typedef void (wxEvtHandler::*wxEraseEventFunction)(wxEraseEvent&); typedef void (wxEvtHandler::*wxMouseEventFunction)(wxMouseEvent&); typedef void (wxEvtHandler::*wxCharEventFunction)(wxKeyEvent&); typedef void (wxEvtHandler::*wxFocusEventFunction)(wxFocusEvent&); typedef void (wxEvtHandler::*wxChildFocusEventFunction)(wxChildFocusEvent&); typedef void (wxEvtHandler::*wxActivateEventFunction)(wxActivateEvent&); typedef void (wxEvtHandler::*wxMenuEventFunction)(wxMenuEvent&); typedef void (wxEvtHandler::*wxJoystickEventFunction)(wxJoystickEvent&); typedef void (wxEvtHandler::*wxDropFilesEventFunction)(wxDropFilesEvent&); typedef void (wxEvtHandler::*wxInitDialogEventFunction)(wxInitDialogEvent&); typedef void (wxEvtHandler::*wxSysColourChangedEventFunction)(wxSysColourChangedEvent&); typedef void (wxEvtHandler::*wxDisplayChangedEventFunction)(wxDisplayChangedEvent&); typedef void (wxEvtHandler::*wxUpdateUIEventFunction)(wxUpdateUIEvent&); typedef void (wxEvtHandler::*wxIdleEventFunction)(wxIdleEvent&); typedef void (wxEvtHandler::*wxCloseEventFunction)(wxCloseEvent&); typedef void (wxEvtHandler::*wxShowEventFunction)(wxShowEvent&); typedef void (wxEvtHandler::*wxIconizeEventFunction)(wxIconizeEvent&); typedef void (wxEvtHandler::*wxMaximizeEventFunction)(wxMaximizeEvent&); typedef void (wxEvtHandler::*wxNavigationKeyEventFunction)(wxNavigationKeyEvent&); typedef void (wxEvtHandler::*wxPaletteChangedEventFunction)(wxPaletteChangedEvent&); typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction)(wxQueryNewPaletteEvent&); typedef void (wxEvtHandler::*wxWindowCreateEventFunction)(wxWindowCreateEvent&); typedef void (wxEvtHandler::*wxWindowDestroyEventFunction)(wxWindowDestroyEvent&); typedef void (wxEvtHandler::*wxSetCursorEventFunction)(wxSetCursorEvent&); typedef void (wxEvtHandler::*wxNotifyEventFunction)(wxNotifyEvent&); typedef void (wxEvtHandler::*wxHelpEventFunction)(wxHelpEvent&); typedef void (wxEvtHandler::*wxContextMenuEventFunction)(wxContextMenuEvent&); typedef void (wxEvtHandler::*wxMouseCaptureChangedEventFunction)(wxMouseCaptureChangedEvent&); // these typedefs don't have the same name structure as the others, keep for // backwards compatibility only #if WXWIN_COMPATIBILITY_2_4 typedef wxSysColourChangedEventFunction wxSysColourChangedFunction; typedef wxDisplayChangedEventFunction wxDisplayChangedFunction; #endif // WXWIN_COMPATIBILITY_2_4 #define wxCommandEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxCommandEventFunction, &func) #define wxScrollEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxScrollEventFunction, &func) #define wxScrollWinEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxScrollWinEventFunction, &func) #define wxSizeEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxSizeEventFunction, &func) #define wxMoveEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMoveEventFunction, &func) #define wxPaintEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxPaintEventFunction, &func) #define wxNcPaintEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNcPaintEventFunction, &func) #define wxEraseEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxEraseEventFunction, &func) #define wxMouseEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMouseEventFunction, &func) #define wxCharEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxCharEventFunction, &func) #define wxKeyEventHandler(func) wxCharEventHandler(func) #define wxFocusEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxFocusEventFunction, &func) #define wxChildFocusEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxChildFocusEventFunction, &func) #define wxActivateEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxActivateEventFunction, &func) #define wxMenuEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMenuEventFunction, &func) #define wxJoystickEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxJoystickEventFunction, &func) #define wxDropFilesEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxDropFilesEventFunction, &func) #define wxInitDialogEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxInitDialogEventFunction, &func) #define wxSysColourChangedEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxSysColourChangedEventFunction, &func) #define wxDisplayChangedEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxDisplayChangedEventFunction, &func) #define wxUpdateUIEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxUpdateUIEventFunction, &func) #define wxIdleEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxIdleEventFunction, &func) #define wxCloseEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxCloseEventFunction, &func) #define wxShowEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxShowEventFunction, &func) #define wxIconizeEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxIconizeEventFunction, &func) #define wxMaximizeEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMaximizeEventFunction, &func) #define wxNavigationKeyEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNavigationKeyEventFunction, &func) #define wxPaletteChangedEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxPaletteChangedEventFunction, &func) #define wxQueryNewPaletteEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxQueryNewPaletteEventFunction, &func) #define wxWindowCreateEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxWindowCreateEventFunction, &func) #define wxWindowDestroyEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxWindowDestroyEventFunction, &func) #define wxSetCursorEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxSetCursorEventFunction, &func) #define wxNotifyEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNotifyEventFunction, &func) #define wxHelpEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxHelpEventFunction, &func) #define wxContextMenuEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxContextMenuEventFunction, &func) #define wxMouseCaptureChangedEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMouseCaptureChangedEventFunction, &func) #endif // wxUSE_GUI // N.B. In GNU-WIN32, you *have* to take the address of a member function // (use &) or the compiler crashes... #define DECLARE_EVENT_TABLE() \ private: \ static const wxEventTableEntry sm_eventTableEntries[]; \ protected: \ static const wxEventTable sm_eventTable; \ virtual const wxEventTable* GetEventTable() const; \ static wxEventHashTable sm_eventHashTable; \ virtual wxEventHashTable& GetEventHashTable() const; // N.B.: when building DLL with Borland C++ 5.5 compiler, you must initialize // sm_eventTable before using it in GetEventTable() or the compiler gives // E2233 (see http://groups.google.com/groups?selm=397dcc8a%241_2%40dnews) #define BEGIN_EVENT_TABLE(theClass, baseClass) \ const wxEventTable theClass::sm_eventTable = \ { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] }; \ const wxEventTable *theClass::GetEventTable() const \ { return &theClass::sm_eventTable; } \ wxEventHashTable theClass::sm_eventHashTable(theClass::sm_eventTable); \ wxEventHashTable &theClass::GetEventHashTable() const \ { return theClass::sm_eventHashTable; } \ const wxEventTableEntry theClass::sm_eventTableEntries[] = { \ #define END_EVENT_TABLE() DECLARE_EVENT_TABLE_ENTRY( wxEVT_NULL, 0, 0, 0, 0 ) }; /* * Event table macros */ // helpers for writing shorter code below: declare an event macro taking 2, 1 // or none ids (the missing ids default to wxID_ANY) // // macro arguments: // - evt one of wxEVT_XXX constants // - id1, id2 ids of the first/last id // - fn the function (should be cast to the right type) #define wx__DECLARE_EVT2(evt, id1, id2, fn) \ DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL), #define wx__DECLARE_EVT1(evt, id, fn) \ wx__DECLARE_EVT2(evt, id, wxID_ANY, fn) #define wx__DECLARE_EVT0(evt, fn) \ wx__DECLARE_EVT1(evt, wxID_ANY, fn) // Generic events #define EVT_CUSTOM(event, winid, func) \ wx__DECLARE_EVT1(event, winid, wxEventHandler(func)) #define EVT_CUSTOM_RANGE(event, id1, id2, func) \ wx__DECLARE_EVT2(event, id1, id2, wxEventHandler(func)) // EVT_COMMAND #define EVT_COMMAND(winid, event, func) \ wx__DECLARE_EVT1(event, winid, wxCommandEventHandler(func)) #define EVT_COMMAND_RANGE(id1, id2, event, func) \ wx__DECLARE_EVT2(event, id1, id2, wxCommandEventHandler(func)) #define EVT_NOTIFY(event, winid, func) \ wx__DECLARE_EVT1(event, winid, wxNotifyEventHandler(func)) #define EVT_NOTIFY_RANGE(event, id1, id2, func) \ wx__DECLARE_EVT2(event, id1, id2, wxNotifyEventHandler(func)) // Miscellaneous #define EVT_SIZE(func) wx__DECLARE_EVT0(wxEVT_SIZE, wxSizeEventHandler(func)) #define EVT_SIZING(func) wx__DECLARE_EVT0(wxEVT_SIZING, wxSizeEventHandler(func)) #define EVT_MOVE(func) wx__DECLARE_EVT0(wxEVT_MOVE, wxMoveEventHandler(func)) #define EVT_MOVING(func) wx__DECLARE_EVT0(wxEVT_MOVING, wxMoveEventHandler(func)) #define EVT_CLOSE(func) wx__DECLARE_EVT0(wxEVT_CLOSE_WINDOW, wxCloseEventHandler(func)) #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func)) #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func)) #define EVT_PAINT(func) wx__DECLARE_EVT0(wxEVT_PAINT, wxPaintEventHandler(func)) #define EVT_NC_PAINT(func) wx__DECLARE_EVT0(wxEVT_NC_PAINT, wxNcPaintEventHandler(func)) #define EVT_ERASE_BACKGROUND(func) wx__DECLARE_EVT0(wxEVT_ERASE_BACKGROUND, wxEraseEventHandler(func)) #define EVT_CHAR(func) wx__DECLARE_EVT0(wxEVT_CHAR, wxCharEventHandler(func)) #define EVT_KEY_DOWN(func) wx__DECLARE_EVT0(wxEVT_KEY_DOWN, wxKeyEventHandler(func)) #define EVT_KEY_UP(func) wx__DECLARE_EVT0(wxEVT_KEY_UP, wxKeyEventHandler(func)) #if wxUSE_HOTKEY #define EVT_HOTKEY(winid, func) wx__DECLARE_EVT1(wxEVT_HOTKEY, winid, wxCharEventHandler(func)) #endif #define EVT_CHAR_HOOK(func) wx__DECLARE_EVT0(wxEVT_CHAR_HOOK, wxCharEventHandler(func)) #define EVT_MENU_OPEN(func) wx__DECLARE_EVT0(wxEVT_MENU_OPEN, wxMenuEventHandler(func)) #define EVT_MENU_CLOSE(func) wx__DECLARE_EVT0(wxEVT_MENU_CLOSE, wxMenuEventHandler(func)) #define EVT_MENU_HIGHLIGHT(winid, func) wx__DECLARE_EVT1(wxEVT_MENU_HIGHLIGHT, winid, wxMenuEventHandler(func)) #define EVT_MENU_HIGHLIGHT_ALL(func) wx__DECLARE_EVT0(wxEVT_MENU_HIGHLIGHT, wxMenuEventHandler(func)) #define EVT_SET_FOCUS(func) wx__DECLARE_EVT0(wxEVT_SET_FOCUS, wxFocusEventHandler(func)) #define EVT_KILL_FOCUS(func) wx__DECLARE_EVT0(wxEVT_KILL_FOCUS, wxFocusEventHandler(func)) #define EVT_CHILD_FOCUS(func) wx__DECLARE_EVT0(wxEVT_CHILD_FOCUS, wxChildFocusEventHandler(func)) #define EVT_ACTIVATE(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE, wxActivateEventHandler(func)) #define EVT_ACTIVATE_APP(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE_APP, wxActivateEventHandler(func)) #define EVT_HIBERNATE(func) wx__DECLARE_EVT0(wxEVT_HIBERNATE, wxActivateEventHandler(func)) #define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func)) #define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func)) #define EVT_DROP_FILES(func) wx__DECLARE_EVT0(wxEVT_DROP_FILES, wxDropFilesEventHandler(func)) #define EVT_INIT_DIALOG(func) wx__DECLARE_EVT0(wxEVT_INIT_DIALOG, wxInitDialogEventHandler(func)) #define EVT_SYS_COLOUR_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEventHandler(func)) #define EVT_DISPLAY_CHANGED(func) wx__DECLARE_EVT0(wxEVT_DISPLAY_CHANGED, wxDisplayChangedEventHandler(func)) #define EVT_SHOW(func) wx__DECLARE_EVT0(wxEVT_SHOW, wxShowEventHandler(func)) #define EVT_MAXIMIZE(func) wx__DECLARE_EVT0(wxEVT_MAXIMIZE, wxMaximizeEventHandler(func)) #define EVT_ICONIZE(func) wx__DECLARE_EVT0(wxEVT_ICONIZE, wxIconizeEventHandler(func)) #define EVT_NAVIGATION_KEY(func) wx__DECLARE_EVT0(wxEVT_NAVIGATION_KEY, wxNavigationKeyEventHandler(func)) #define EVT_PALETTE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_PALETTE_CHANGED, wxPaletteChangedEventHandler(func)) #define EVT_QUERY_NEW_PALETTE(func) wx__DECLARE_EVT0(wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEventHandler(func)) #define EVT_WINDOW_CREATE(func) wx__DECLARE_EVT0(wxEVT_CREATE, wxWindowCreateEventHandler(func)) #define EVT_WINDOW_DESTROY(func) wx__DECLARE_EVT0(wxEVT_DESTROY, wxWindowDestroyEventHandler(func)) #define EVT_SET_CURSOR(func) wx__DECLARE_EVT0(wxEVT_SET_CURSOR, wxSetCursorEventHandler(func)) #define EVT_MOUSE_CAPTURE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEventHandler(func)) // Mouse events #define EVT_LEFT_DOWN(func) wx__DECLARE_EVT0(wxEVT_LEFT_DOWN, wxMouseEventHandler(func)) #define EVT_LEFT_UP(func) wx__DECLARE_EVT0(wxEVT_LEFT_UP, wxMouseEventHandler(func)) #define EVT_MIDDLE_DOWN(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DOWN, wxMouseEventHandler(func)) #define EVT_MIDDLE_UP(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_UP, wxMouseEventHandler(func)) #define EVT_RIGHT_DOWN(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DOWN, wxMouseEventHandler(func)) #define EVT_RIGHT_UP(func) wx__DECLARE_EVT0(wxEVT_RIGHT_UP, wxMouseEventHandler(func)) #define EVT_MOTION(func) wx__DECLARE_EVT0(wxEVT_MOTION, wxMouseEventHandler(func)) #define EVT_LEFT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_LEFT_DCLICK, wxMouseEventHandler(func)) #define EVT_MIDDLE_DCLICK(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DCLICK, wxMouseEventHandler(func)) #define EVT_RIGHT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DCLICK, wxMouseEventHandler(func)) #define EVT_LEAVE_WINDOW(func) wx__DECLARE_EVT0(wxEVT_LEAVE_WINDOW, wxMouseEventHandler(func)) #define EVT_ENTER_WINDOW(func) wx__DECLARE_EVT0(wxEVT_ENTER_WINDOW, wxMouseEventHandler(func)) #define EVT_MOUSEWHEEL(func) wx__DECLARE_EVT0(wxEVT_MOUSEWHEEL, wxMouseEventHandler(func)) // All mouse events #define EVT_MOUSE_EVENTS(func) \ EVT_LEFT_DOWN(func) \ EVT_LEFT_UP(func) \ EVT_MIDDLE_DOWN(func) \ EVT_MIDDLE_UP(func) \ EVT_RIGHT_DOWN(func) \ EVT_RIGHT_UP(func) \ EVT_MOTION(func) \ EVT_LEFT_DCLICK(func) \ EVT_MIDDLE_DCLICK(func) \ EVT_RIGHT_DCLICK(func) \ EVT_LEAVE_WINDOW(func) \ EVT_ENTER_WINDOW(func) \ EVT_MOUSEWHEEL(func) // Scrolling from wxWindow (sent to wxScrolledWindow) #define EVT_SCROLLWIN_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_TOP, wxScrollWinEventHandler(func)) #define EVT_SCROLLWIN_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEventHandler(func)) #define EVT_SCROLLWIN_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEUP, wxScrollWinEventHandler(func)) #define EVT_SCROLLWIN_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEventHandler(func)) #define EVT_SCROLLWIN_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEventHandler(func)) #define EVT_SCROLLWIN_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEventHandler(func)) #define EVT_SCROLLWIN_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEventHandler(func)) #define EVT_SCROLLWIN_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEventHandler(func)) #define EVT_SCROLLWIN(func) \ EVT_SCROLLWIN_TOP(func) \ EVT_SCROLLWIN_BOTTOM(func) \ EVT_SCROLLWIN_LINEUP(func) \ EVT_SCROLLWIN_LINEDOWN(func) \ EVT_SCROLLWIN_PAGEUP(func) \ EVT_SCROLLWIN_PAGEDOWN(func) \ EVT_SCROLLWIN_THUMBTRACK(func) \ EVT_SCROLLWIN_THUMBRELEASE(func) // Scrolling from wxSlider and wxScrollBar #define EVT_SCROLL_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_TOP, wxScrollEventHandler(func)) #define EVT_SCROLL_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLL_BOTTOM, wxScrollEventHandler(func)) #define EVT_SCROLL_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEUP, wxScrollEventHandler(func)) #define EVT_SCROLL_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEDOWN, wxScrollEventHandler(func)) #define EVT_SCROLL_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEUP, wxScrollEventHandler(func)) #define EVT_SCROLL_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler(func)) #define EVT_SCROLL_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler(func)) #define EVT_SCROLL_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBRELEASE, wxScrollEventHandler(func)) #define EVT_SCROLL_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SCROLL_CHANGED, wxScrollEventHandler(func)) #define EVT_SCROLL(func) \ EVT_SCROLL_TOP(func) \ EVT_SCROLL_BOTTOM(func) \ EVT_SCROLL_LINEUP(func) \ EVT_SCROLL_LINEDOWN(func) \ EVT_SCROLL_PAGEUP(func) \ EVT_SCROLL_PAGEDOWN(func) \ EVT_SCROLL_THUMBTRACK(func) \ EVT_SCROLL_THUMBRELEASE(func) \ EVT_SCROLL_CHANGED(func) // Scrolling from wxSlider and wxScrollBar, with an id #define EVT_COMMAND_SCROLL_TOP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_TOP, winid, wxScrollEventHandler(func)) #define EVT_COMMAND_SCROLL_BOTTOM(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_BOTTOM, winid, wxScrollEventHandler(func)) #define EVT_COMMAND_SCROLL_LINEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEUP, winid, wxScrollEventHandler(func)) #define EVT_COMMAND_SCROLL_LINEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEDOWN, winid, wxScrollEventHandler(func)) #define EVT_COMMAND_SCROLL_PAGEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEUP, winid, wxScrollEventHandler(func)) #define EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEDOWN, winid, wxScrollEventHandler(func)) #define EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBTRACK, winid, wxScrollEventHandler(func)) #define EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBRELEASE, winid, wxScrollEventHandler(func)) #define EVT_COMMAND_SCROLL_CHANGED(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_CHANGED, winid, wxScrollEventHandler(func)) #define EVT_COMMAND_SCROLL(winid, func) \ EVT_COMMAND_SCROLL_TOP(winid, func) \ EVT_COMMAND_SCROLL_BOTTOM(winid, func) \ EVT_COMMAND_SCROLL_LINEUP(winid, func) \ EVT_COMMAND_SCROLL_LINEDOWN(winid, func) \ EVT_COMMAND_SCROLL_PAGEUP(winid, func) \ EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) \ EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) \ EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) \ EVT_COMMAND_SCROLL_CHANGED(winid, func) // compatibility macros for the old name, to be deprecated in 2.8 #define wxEVT_SCROLL_ENDSCROLL wxEVT_SCROLL_CHANGED #define EVT_COMMAND_SCROLL_ENDSCROLL EVT_COMMAND_SCROLL_CHANGED #define EVT_SCROLL_ENDSCROLL EVT_SCROLL_CHANGED // Convenience macros for commonly-used commands #define EVT_CHECKBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKBOX_CLICKED, winid, wxCommandEventHandler(func)) #define EVT_CHOICE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHOICE_SELECTED, winid, wxCommandEventHandler(func)) #define EVT_LISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_SELECTED, winid, wxCommandEventHandler(func)) #define EVT_LISTBOX_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, winid, wxCommandEventHandler(func)) #define EVT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_MENU_SELECTED, winid, wxCommandEventHandler(func)) #define EVT_MENU_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_MENU_SELECTED, id1, id2, wxCommandEventHandler(func)) #if defined(__SMARTPHONE__) # define EVT_BUTTON(winid, func) EVT_MENU(winid, func) #else # define EVT_BUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_BUTTON_CLICKED, winid, wxCommandEventHandler(func)) #endif #define EVT_SLIDER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SLIDER_UPDATED, winid, wxCommandEventHandler(func)) #define EVT_RADIOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBOX_SELECTED, winid, wxCommandEventHandler(func)) #define EVT_RADIOBUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBUTTON_SELECTED, winid, wxCommandEventHandler(func)) // EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events #define EVT_SCROLLBAR(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SCROLLBAR_UPDATED, winid, wxCommandEventHandler(func)) #define EVT_VLBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_VLBOX_SELECTED, winid, wxCommandEventHandler(func)) #define EVT_COMBOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_SELECTED, winid, wxCommandEventHandler(func)) #define EVT_TOOL(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_CLICKED, winid, wxCommandEventHandler(func)) #define EVT_TOOL_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_CLICKED, id1, id2, wxCommandEventHandler(func)) #define EVT_TOOL_RCLICKED(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_RCLICKED, winid, wxCommandEventHandler(func)) #define EVT_TOOL_RCLICKED_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, wxCommandEventHandler(func)) #define EVT_TOOL_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_ENTER, winid, wxCommandEventHandler(func)) #define EVT_CHECKLISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, winid, wxCommandEventHandler(func)) // Generic command events #define EVT_COMMAND_LEFT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_CLICK, winid, wxCommandEventHandler(func)) #define EVT_COMMAND_LEFT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_DCLICK, winid, wxCommandEventHandler(func)) #define EVT_COMMAND_RIGHT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_CLICK, winid, wxCommandEventHandler(func)) #define EVT_COMMAND_RIGHT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_DCLICK, winid, wxCommandEventHandler(func)) #define EVT_COMMAND_SET_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SET_FOCUS, winid, wxCommandEventHandler(func)) #define EVT_COMMAND_KILL_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_KILL_FOCUS, winid, wxCommandEventHandler(func)) #define EVT_COMMAND_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_ENTER, winid, wxCommandEventHandler(func)) // Joystick events #define EVT_JOY_BUTTON_DOWN(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_DOWN, wxJoystickEventHandler(func)) #define EVT_JOY_BUTTON_UP(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_UP, wxJoystickEventHandler(func)) #define EVT_JOY_MOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_MOVE, wxJoystickEventHandler(func)) #define EVT_JOY_ZMOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_ZMOVE, wxJoystickEventHandler(func)) // These are obsolete, see _BUTTON_ events #if WXWIN_COMPATIBILITY_2_4 #define EVT_JOY_DOWN(func) EVT_JOY_BUTTON_DOWN(func) #define EVT_JOY_UP(func) EVT_JOY_BUTTON_UP(func) #endif // WXWIN_COMPATIBILITY_2_4 // All joystick events #define EVT_JOYSTICK_EVENTS(func) \ EVT_JOY_BUTTON_DOWN(func) \ EVT_JOY_BUTTON_UP(func) \ EVT_JOY_MOVE(func) \ EVT_JOY_ZMOVE(func) // Idle event #define EVT_IDLE(func) wx__DECLARE_EVT0(wxEVT_IDLE, wxIdleEventHandler(func)) // Update UI event #define EVT_UPDATE_UI(winid, func) wx__DECLARE_EVT1(wxEVT_UPDATE_UI, winid, wxUpdateUIEventHandler(func)) #define EVT_UPDATE_UI_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_UPDATE_UI, id1, id2, wxUpdateUIEventHandler(func)) // Help events #define EVT_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_HELP, winid, wxHelpEventHandler(func)) #define EVT_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_HELP, id1, id2, wxHelpEventHandler(func)) #define EVT_DETAILED_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_DETAILED_HELP, winid, wxHelpEventHandler(func)) #define EVT_DETAILED_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_DETAILED_HELP, id1, id2, wxHelpEventHandler(func)) // Context Menu Events #define EVT_CONTEXT_MENU(func) wx__DECLARE_EVT0(wxEVT_CONTEXT_MENU, wxContextMenuEventHandler(func)) #define EVT_COMMAND_CONTEXT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_CONTEXT_MENU, winid, wxContextMenuEventHandler(func)) // ---------------------------------------------------------------------------- // Global data // ---------------------------------------------------------------------------- // for pending event processing - notice that there is intentionally no // WXDLLEXPORT here extern WXDLLIMPEXP_BASE wxList *wxPendingEvents; #if wxUSE_THREADS extern WXDLLIMPEXP_BASE wxCriticalSection *wxPendingEventsLocker; #endif // ---------------------------------------------------------------------------- // Helper functions // ---------------------------------------------------------------------------- #if wxUSE_GUI // Find a window with the focus, that is also a descendant of the given window. // This is used to determine the window to initially send commands to. wxWindow* wxFindFocusDescendant(wxWindow* ancestor); #endif // wxUSE_GUI #endif // _WX_EVENT_H__