X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4ce81a75efb34de9f01fe3c7b9ffecb03293b1c3..2c41c4404c0d4ec0a0095bc31ab6cc732f2126c1:/include/wx/event.h diff --git a/include/wx/event.h b/include/wx/event.h index 8defe804d3..1e9f2df629 100644 --- a/include/wx/event.h +++ b/include/wx/event.h @@ -6,24 +6,41 @@ // Created: 01/02/97 // RCS-ID: $Id$ // Copyright: (c) -// Licence: wxWindows licence +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifndef _WX_EVENTH__ #define _WX_EVENTH__ #ifdef __GNUG__ -#pragma interface "event.h" + #pragma interface "event.h" #endif #include "wx/defs.h" #include "wx/object.h" -#include "wx/gdicmn.h" -/* - * Event types - * - */ +#if wxUSE_GUI + #include "wx/gdicmn.h" +#endif + +#include "wx/thread.h" + +// ---------------------------------------------------------------------------- +// forward declarations +// ---------------------------------------------------------------------------- + +class WXDLLEXPORT wxList; + +#if wxUSE_GUI + class WXDLLEXPORT wxClientData; + class WXDLLEXPORT wxDC; + class WXDLLEXPORT wxMenu; + class WXDLLEXPORT wxWindow; +#endif // wxUSE_GUI + +// ---------------------------------------------------------------------------- +// Event types +// ---------------------------------------------------------------------------- typedef int wxEventType; @@ -91,7 +108,7 @@ const wxEventType wxEVT_KEY_DOWN = wxEVT_FIRST + 215; const wxEventType wxEVT_KEY_UP = wxEVT_FIRST + 216; /* - * Scrollbar event identifiers + * wxScrollbar and wxSlider event identifiers */ const wxEventType wxEVT_SCROLL_TOP = wxEVT_FIRST + 300; const wxEventType wxEVT_SCROLL_BOTTOM = wxEVT_FIRST + 301; @@ -101,6 +118,20 @@ const wxEventType wxEVT_SCROLL_PAGEUP = wxEVT_FIRST + 304; const wxEventType wxEVT_SCROLL_PAGEDOWN = wxEVT_FIRST + 305; const wxEventType wxEVT_SCROLL_THUMBTRACK = wxEVT_FIRST + 306; + /* + * Scroll events from wxWindow + */ +const wxEventType wxEVT_SCROLLWIN_TOP = wxEVT_FIRST + 320; +const wxEventType wxEVT_SCROLLWIN_BOTTOM = wxEVT_FIRST + 321; +const wxEventType wxEVT_SCROLLWIN_LINEUP = wxEVT_FIRST + 322; +const wxEventType wxEVT_SCROLLWIN_LINEDOWN = wxEVT_FIRST + 323; +const wxEventType wxEVT_SCROLLWIN_PAGEUP = wxEVT_FIRST + 324; +const wxEventType wxEVT_SCROLLWIN_PAGEDOWN = wxEVT_FIRST + 325; +const wxEventType wxEVT_SCROLLWIN_THUMBTRACK = wxEVT_FIRST + 326; + + /* + * System events + */ const wxEventType wxEVT_SIZE = wxEVT_FIRST + 400; const wxEventType wxEVT_MOVE = wxEVT_FIRST + 401; const wxEventType wxEVT_CLOSE_WINDOW = wxEVT_FIRST + 402; @@ -139,9 +170,14 @@ const wxEventType wxEVT_COMPARE_ITEM = wxEVT_FIRST + 436; const wxEventType wxEVT_INIT_DIALOG = wxEVT_FIRST + 437; const wxEventType wxEVT_IDLE = wxEVT_FIRST + 438; const wxEventType wxEVT_UPDATE_UI = wxEVT_FIRST + 439; + /* System misc. */ const wxEventType wxEVT_END_PROCESS = wxEVT_FIRST + 440; + /* Dial up events */ +const wxEventType wxEVT_DIALUP_CONNECTED = wxEVT_FIRST + 450; +const wxEventType wxEVT_DIALUP_DISCONNECTED = wxEVT_FIRST + 451; + /* Generic command events */ /* Note: a click is a higher-level event than button down/up */ const wxEventType wxEVT_COMMAND_LEFT_CLICK = wxEVT_FIRST + 500; @@ -168,6 +204,8 @@ const wxEventType wxEVT_COMMAND_TREE_SEL_CHANGED = wxEVT_FIRST + 611; const wxEventType wxEVT_COMMAND_TREE_SEL_CHANGING = wxEVT_FIRST + 612; const wxEventType wxEVT_COMMAND_TREE_KEY_DOWN = wxEVT_FIRST + 613; const wxEventType wxEVT_COMMAND_TREE_ITEM_ACTIVATED = wxEVT_FIRST + 614; +const wxEventType wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK = wxEVT_FIRST + 615; +const wxEventType wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK = wxEVT_FIRST + 616; /* List control event types */ const wxEventType wxEVT_COMMAND_LIST_BEGIN_DRAG = wxEVT_FIRST + 700; @@ -200,6 +238,17 @@ const wxEventType wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED = wxEVT_FIRST + 802; const wxEventType wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING = wxEVT_FIRST + 803; #endif +/* Splitter events */ +const wxEventType wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED = wxEVT_FIRST + 850; +const wxEventType wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING = wxEVT_FIRST + 851; +const wxEventType wxEVT_COMMAND_SPLITTER_DOUBLECLICKED = wxEVT_FIRST + 852; +const wxEventType wxEVT_COMMAND_SPLITTER_UNSPLIT = wxEVT_FIRST + 853; + +/* Wizard events */ +const wxEventType wxEVT_WIZARD_PAGE_CHANGED = wxEVT_FIRST + 900; +const wxEventType wxEVT_WIZARD_PAGE_CHANGING = wxEVT_FIRST + 901; +const wxEventType wxEVT_WIZARD_CANCEL = wxEVT_FIRST + 902; + const wxEventType wxEVT_USER_FIRST = wxEVT_FIRST + 2000; /* Compatibility */ @@ -245,7 +294,7 @@ const wxEventType wxEVT_USER_FIRST = wxEVT_FIRST + 2000; #define wxEVENT_TYPE_SCROLL_PAGEDOWN wxEVT_SCROLL_PAGEDOWN #define wxEVENT_TYPE_SCROLL_THUMBTRACK wxEVT_SCROLL_THUMBTRACK -#endif +#endif // WXWIN_COMPATIBILITY /* * wxWindows events, covering all interesting things that might happen @@ -259,39 +308,51 @@ const wxEventType wxEVT_USER_FIRST = wxEVT_FIRST + 2000; * */ -class WXDLLEXPORT wxEvent: public wxObject +class WXDLLEXPORT wxEvent : public wxObject { - DECLARE_ABSTRACT_CLASS(wxEvent) + DECLARE_ABSTRACT_CLASS(wxEvent) public: - wxEvent(int id = 0); - inline ~wxEvent(void) {} - - inline void SetEventType(wxEventType typ) { m_eventType = typ; } - inline wxEventType GetEventType(void) const { return m_eventType; } - inline wxObject *GetEventObject(void) const { return m_eventObject; } - inline void SetEventObject(wxObject *obj) { m_eventObject = obj; } - inline long GetTimestamp(void) const { return m_timeStamp; } - inline void SetTimestamp(long ts = 0) { m_timeStamp = ts; } - inline int GetId() const { return m_id; } - inline 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) - inline void Skip(bool skip = TRUE) { m_skipped = skip; } - inline bool GetSkipped(void) const { return m_skipped; }; + wxEvent(int id = 0); + ~wxEvent() {} + + 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 verstion of a virtual function) + void Skip(bool skip = TRUE) { m_skipped = skip; } + bool GetSkipped() const { return m_skipped; }; + + // implementation only: this test is explicitlty anti OO and this functions + // exists only for optimization purposes + bool IsCommandEvent() const { return m_isCommandEvent; } + + void CopyObject(wxObject& object_dest) const; public: - bool m_skipped; - wxObject* m_eventObject; - char* m_eventHandle; // Handle of an underlying windowing system event - wxEventType m_eventType; - long m_timeStamp; - int m_id; - wxObject* m_callbackUserData; - + wxObject* m_eventObject; + wxEventType m_eventType; + long m_timeStamp; + int m_id; + wxObject* m_callbackUserData; + bool m_skipped; + + // optimization: instead of using costly IsKindOf() we keep a flag telling + // whether we're a command event (by far the most common case) + bool m_isCommandEvent; }; +#if wxUSE_GUI + // Item or menu event class /* wxEVT_COMMAND_BUTTON_CLICKED @@ -310,58 +371,59 @@ public: wxEVT_COMMAND_COMBOBOX_SELECTED */ -class WXDLLEXPORT wxClientData; - -class WXDLLEXPORT wxCommandEvent: public wxEvent +class WXDLLEXPORT wxCommandEvent : public wxEvent { - DECLARE_DYNAMIC_CLASS(wxCommandEvent) + DECLARE_DYNAMIC_CLASS(wxCommandEvent) - wxCommandEvent(wxEventType commandType = wxEVT_NULL, int id = 0); - inline ~wxCommandEvent(void) {} +public: + wxCommandEvent(wxEventType commandType = wxEVT_NULL, int id = 0); + ~wxCommandEvent() {} + + /* + * Accessors dependent on context + * + */ - /* - * Accessors dependent on context - * - */ + // Set/Get client data from controls + void SetClientData(void* clientData) { m_clientData = clientData; } + void *GetClientData() const { return m_clientData; } - // Set/Get client data from controls - inline void SetClientData(void* clientData) { m_clientData = clientData; } - inline void *GetClientData() const { return m_clientData; } + // Set/Get client object from controls + void SetClientObject(wxClientData* clientObject) { m_clientObject = clientObject; } + void *GetClientObject() const { return m_clientObject; } - // Set/Get client object from controls - inline void SetClientObject(wxClientData* clientObject) { m_clientObject = clientObject; } - inline void *GetClientObject() const { return m_clientObject; } + // Get listbox selection if single-choice + int GetSelection() const { return m_commandInt; } - // Get listbox selection if single-choice - inline int GetSelection() const { return m_commandInt; } + // Set/Get listbox/choice selection string + void SetString(const wxString& s) { m_commandString = s; } + wxString GetString() const { return m_commandString; } - // Set/Get listbox/choice selection string - inline void SetString(char* s) { m_commandString = s; } - inline char *GetString() const { return m_commandString; } + // Get checkbox value + bool Checked() const { return (m_commandInt != 0); } - // Get checkbox value - inline bool Checked() const { return (m_commandInt != 0); } + // TRUE if the listbox event was a selection. + bool IsSelection() const { return (m_extraLong != 0); } - // TRUE if the listbox event was a selection. - inline bool IsSelection() const { return (m_extraLong != 0); } + void SetExtraLong(long extraLong) { m_extraLong = extraLong; } + long GetExtraLong() const { return m_extraLong ; } - inline void SetExtraLong(long extraLong) { m_extraLong = extraLong; } - inline long GetExtraLong(void) const { return m_extraLong ; } + void SetInt(int i) { m_commandInt = i; } + long GetInt() const { return m_commandInt ; } - inline void SetInt(int i) { m_commandInt = i; } - inline long GetInt(void) const { return m_commandInt ; } + void CopyObject(wxObject& obj) const; - public: - char* m_commandString; // 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 +public: + wxString m_commandString; // 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 }; // this class adds a possibility to react (from the user) code to a control // notification: allow or veto the operation being reported. -class WXDLLEXPORT wxNotifyEvent : public wxCommandEvent +class WXDLLEXPORT wxNotifyEvent : public wxCommandEvent { public: wxNotifyEvent(wxEventType commandType = wxEVT_NULL, int id = 0) @@ -379,7 +441,8 @@ private: DECLARE_DYNAMIC_CLASS(wxNotifyEvent) }; -// Scroll event class +// Scroll event class, derived form wxCommandEvent. wxScrollEvents are +// sent by wxSlider and wxScrollbar. /* wxEVT_SCROLL_TOP wxEVT_SCROLL_BOTTOM @@ -390,23 +453,60 @@ private: wxEVT_SCROLL_THUMBTRACK */ -class WXDLLEXPORT wxScrollEvent: public wxCommandEvent +class WXDLLEXPORT wxScrollEvent : public wxCommandEvent { - DECLARE_DYNAMIC_CLASS(wxScrollEvent) + DECLARE_DYNAMIC_CLASS(wxScrollEvent) - public: - wxScrollEvent(wxEventType commandType = wxEVT_NULL, int id = 0, int pos = 0, int orient = 0); - inline ~wxScrollEvent(void) {} +public: + wxScrollEvent(wxEventType commandType = wxEVT_NULL, + int id = 0, int pos = 0, int orient = 0); + ~wxScrollEvent() {} + + /* + * Accessors + * + */ + + 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; } +}; - /* - * Accessors - * - */ +// 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 +*/ + +class WXDLLEXPORT wxScrollWinEvent : public wxEvent +{ + DECLARE_DYNAMIC_CLASS(wxScrollWinEvent) + +public: + wxScrollWinEvent(wxEventType commandType = wxEVT_NULL, + int pos = 0, int orient = 0); + ~wxScrollWinEvent() {} - inline int GetOrientation(void) const { return (int) m_extraLong ; } - inline int GetPosition(void) const { return m_commandInt ; } - inline void SetOrientation(int orient) { m_extraLong = (long) orient; } - inline void SetPosition(int pos) { m_commandInt = pos; } + /* + * Accessors + */ + + 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; } + + void CopyObject(wxObject& object_dest) const; +public: + int m_commandInt; // Additional information + long m_extraLong; }; // Mouse event class @@ -438,99 +538,116 @@ class WXDLLEXPORT wxScrollEvent: public wxCommandEvent wxEVT_NC_RIGHT_DCLICK, */ -class WXDLLEXPORT wxDC; -class WXDLLEXPORT wxMouseEvent: public wxEvent +class WXDLLEXPORT wxMouseEvent : public wxEvent { - DECLARE_DYNAMIC_CLASS(wxMouseEvent) + DECLARE_DYNAMIC_CLASS(wxMouseEvent) - public: - wxMouseEvent(wxEventType mouseType = wxEVT_NULL); - - // Was it a button event? (*doesn't* mean: is any button *down*?) - inline bool IsButton(void) const { return Button(-1); } +public: + wxMouseEvent(wxEventType mouseType = wxEVT_NULL); - // Was it a down event from button 1, 2 or 3 or any? - bool ButtonDown(int but = -1) const; + // Was it a button event? (*doesn't* mean: is any button *down*?) + bool IsButton() const { return Button(-1); } - // Was it a dclick event from button 1, 2 or 3 or any? - bool ButtonDClick(int but = -1) const; + // Was it a down event from button 1, 2 or 3 or any? + bool ButtonDown(int but = -1) const; - // Was it a up event from button 1, 2 or 3 or any? - bool ButtonUp(int but = -1) const; + // Was it a dclick event from button 1, 2 or 3 or any? + bool ButtonDClick(int but = -1) const; - // Was the given button 1,2,3 or any changing state? - bool Button(int but) const; + // Was it a up event from button 1, 2 or 3 or any? + bool ButtonUp(int but = -1) const; - // Was the given button 1,2,3 or any in Down state? - bool ButtonIsDown(int but) const; + // Was the given button 1,2,3 or any changing state? + bool Button(int but) const; - // Find state of shift/control keys - inline bool ControlDown(void) const { return m_controlDown; } - inline bool MetaDown(void) const { return m_metaDown; } - inline bool AltDown(void) const { return m_altDown; } - inline bool ShiftDown(void) const { return m_shiftDown; } + // Was the given button 1,2,3 or any in Down state? + bool ButtonIsDown(int but) const; - // Find which event was just generated - inline bool LeftDown(void) const { return (m_eventType == wxEVT_LEFT_DOWN); } - inline bool MiddleDown(void) const { return (m_eventType == wxEVT_MIDDLE_DOWN); } - inline bool RightDown(void) const { return (m_eventType == wxEVT_RIGHT_DOWN); } + // 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; } - inline bool LeftUp(void) const { return (m_eventType == wxEVT_LEFT_UP); } - inline bool MiddleUp(void) const { return (m_eventType == wxEVT_MIDDLE_UP); } - inline bool RightUp(void) const { return (m_eventType == wxEVT_RIGHT_UP); } + // 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); } - inline bool LeftDClick(void) const { return (m_eventType == wxEVT_LEFT_DCLICK); } - inline bool MiddleDClick(void) const { return (m_eventType == wxEVT_MIDDLE_DCLICK); } - inline bool RightDClick(void) const { return (m_eventType == wxEVT_RIGHT_DCLICK); } + 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); } - // Find the current state of the mouse buttons (regardless - // of current event type) - inline bool LeftIsDown(void) const { return m_leftDown; } - inline bool MiddleIsDown(void) const { return m_middleDown; } - inline bool RightIsDown(void) const { return m_rightDown; } + 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); } - // True if a button is down and the mouse is moving - inline bool Dragging(void) const { return ((m_eventType == wxEVT_MOTION) && (LeftIsDown() || MiddleIsDown() || RightIsDown())); } + // 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 the mouse is moving, and no button is down - inline bool Moving(void) const { return (m_eventType == wxEVT_MOTION); } + // True if a button is down and the mouse is moving + bool Dragging() const + { + return ((m_eventType == wxEVT_MOTION) && + (LeftIsDown() || MiddleIsDown() || RightIsDown())); + } - // True if the mouse is just entering the window - inline bool Entering(void) const { return (m_eventType == wxEVT_ENTER_WINDOW); } + // True if the mouse is moving, and no button is down + bool Moving() const { return (m_eventType == wxEVT_MOTION); } - // True if the mouse is just leaving the window - inline bool Leaving(void) const { return (m_eventType == wxEVT_LEAVE_WINDOW); } + // True if the mouse is just entering the window + bool Entering() const { return (m_eventType == wxEVT_ENTER_WINDOW); } - // Find the position of the event - inline void Position(long *xpos, long *ypos) const { *xpos = m_x; *ypos = m_y; } + // True if the mouse is just leaving the window + bool Leaving() const { return (m_eventType == wxEVT_LEAVE_WINDOW); } - // Find the position of the event - inline wxPoint GetPosition() const { return wxPoint(m_x, m_y); } + // Find the position of the event + void GetPosition(long *xpos, long *ypos) const + { if (xpos) *xpos = m_x; + if (ypos) *ypos = m_y; } + void GetPosition(int *xpos, int *ypos) const + { if (xpos) *xpos = m_x; + if (ypos) *ypos = m_y; } + void Position(long *xpos, long *ypos) const + { if (xpos) *xpos = m_x; + if (ypos) *ypos = m_y; } - // Find the logical position of the event given the DC - wxPoint GetLogicalPosition(const wxDC& dc) const ; + // Find the position of the event + wxPoint GetPosition() const { return wxPoint(m_x, m_y); } - // Compatibility - inline void Position(float *xpos, float *ypos) const { *xpos = (float) m_x; *ypos = (float) m_y; } + // Find the logical position of the event given the DC + wxPoint GetLogicalPosition(const wxDC& dc) const ; - // Get X position - inline long GetX(void) const { return m_x; } + // Compatibility +#if WXWIN_COMPATIBILITY + void Position(float *xpos, float *ypos) const + { + *xpos = (float) m_x; *ypos = (float) m_y; + } +#endif // WXWIN_COMPATIBILITY - // Get Y position - inline long GetY(void) const { return m_y; } + // Get X position + long GetX() const { return m_x; } -public: - long m_x; - long m_y; - bool m_leftDown; - bool m_middleDown; - bool m_rightDown; + // Get Y position + long GetY() const { return m_y; } - bool m_controlDown; - bool m_shiftDown; - bool m_altDown; - bool m_metaDown; + void CopyObject(wxObject& obj) const; +public: + long m_x; + long m_y; + bool m_leftDown; + bool m_middleDown; + bool m_rightDown; + + bool m_controlDown; + bool m_shiftDown; + bool m_altDown; + bool m_metaDown; }; // Keyboard input event class @@ -542,38 +659,48 @@ public: wxEVT_KEY_UP */ -class WXDLLEXPORT wxKeyEvent: public wxEvent +class WXDLLEXPORT wxKeyEvent : public wxEvent { - DECLARE_DYNAMIC_CLASS(wxKeyEvent) + DECLARE_DYNAMIC_CLASS(wxKeyEvent) public: - wxKeyEvent(wxEventType keyType = wxEVT_NULL); + wxKeyEvent(wxEventType keyType = wxEVT_NULL); - // Find state of shift/control keys - inline bool ControlDown(void) const { return m_controlDown; } - inline bool MetaDown(void) const { return m_metaDown; } - inline bool AltDown(void) const { return m_altDown; } - inline bool ShiftDown(void) const { return m_shiftDown; } - inline long KeyCode(void) const { return m_keyCode; } + // 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; } + long KeyCode() const { return m_keyCode; } - // Find the position of the event - inline void Position(float *xpos, float *ypos) const { *xpos = m_x; *ypos = m_y; } + // Find the position of the event + void GetPosition(long *xpos, long *ypos) const + { if (xpos) *xpos = m_x; + if (ypos) *ypos = m_y; } + void GetPosition(int *xpos, int *ypos) const + { if (xpos) *xpos = m_x; + if (ypos) *ypos = m_y; } - // Get X position - inline float GetX(void) const { return m_x; } + wxPoint GetPosition() const + { return wxPoint(m_x, m_y); } - // Get Y position - inline float GetY(void) const { return m_y; } + // Get X position + long GetX() const { return m_x; } -public: - float m_x ; - float m_y ; - long m_keyCode; - bool m_controlDown; - bool m_shiftDown; - bool m_altDown; - bool m_metaDown; + // Get Y position + long GetY() const { return m_y; } + + void CopyObject(wxObject& obj) const; +public: + long m_x; + long m_y; + long m_keyCode; + bool m_controlDown; + bool m_shiftDown; + bool m_altDown; + bool m_metaDown; + bool m_scanCode; }; // Size event class @@ -581,18 +708,21 @@ public: wxEVT_SIZE */ -class WXDLLEXPORT wxSizeEvent: public wxEvent +class WXDLLEXPORT wxSizeEvent : public wxEvent { - DECLARE_DYNAMIC_CLASS(wxSizeEvent) + DECLARE_DYNAMIC_CLASS(wxSizeEvent) + +public: + wxSize m_size; - public: - wxSize m_size; + wxSizeEvent() { m_eventType = wxEVT_SIZE; } + wxSizeEvent(const wxSize& sz, int id = 0) + : m_size(sz) + { m_eventType = wxEVT_SIZE; m_id = id; } - inline wxSizeEvent(void) { m_eventType = wxEVT_SIZE; } - inline wxSizeEvent(const wxSize& sz, int id = 0) - { m_eventType = wxEVT_SIZE; m_size.x = sz.x; m_size.y = sz.y; m_id = id; } + wxSize GetSize() const { return m_size; } - inline wxSize GetSize(void) const { return m_size; } + void CopyObject(wxObject& obj) const; }; // Move event class @@ -601,18 +731,21 @@ class WXDLLEXPORT wxSizeEvent: public wxEvent wxEVT_MOVE */ -class WXDLLEXPORT wxMoveEvent: public wxEvent +class WXDLLEXPORT wxMoveEvent : public wxEvent { - DECLARE_DYNAMIC_CLASS(wxMoveEvent) + DECLARE_DYNAMIC_CLASS(wxMoveEvent) - public: - wxPoint m_pos; +public: + wxPoint m_pos; + + wxMoveEvent() { m_eventType = wxEVT_MOVE; } + wxMoveEvent(const wxPoint& pos, int id = 0) + : m_pos(pos) + { m_eventType = wxEVT_MOVE; m_id = id; } - inline wxMoveEvent(void) { m_eventType = wxEVT_MOVE; } - inline wxMoveEvent(const wxPoint& pos, int id = 0) - { m_eventType = wxEVT_MOVE; m_pos.x = pos.x; m_pos.y = pos.y; m_id = id; } + wxPoint GetPosition() const { return m_pos; } - inline wxPoint GetPosition(void) const { return m_pos; } + void CopyObject(wxObject& obj) const; }; // Paint event class @@ -622,12 +755,33 @@ class WXDLLEXPORT wxMoveEvent: public wxEvent wxEVT_PAINT_ICON */ -class WXDLLEXPORT wxPaintEvent: public wxEvent +#if defined(__WXDEBUG__) && defined(__WXMSW__) + // see comments in src/msw/dcclient.cpp where g_isPainting is defined + extern int g_isPainting; +#endif // debug + +class WXDLLEXPORT wxPaintEvent : public wxEvent { - DECLARE_DYNAMIC_CLASS(wxPaintEvent) + DECLARE_DYNAMIC_CLASS(wxPaintEvent) - public: - inline wxPaintEvent(int Id = 0) { m_eventType = wxEVT_PAINT; m_id = Id; } +public: + wxPaintEvent(int Id = 0) + { + m_eventType = wxEVT_PAINT; + m_id = Id; + +#if defined(__WXDEBUG__) && defined(__WXMSW__) + // set the internal flag for the duration of processing of WM_PAINT + g_isPainting++; +#endif // debug + } + +#if defined(__WXDEBUG__) && defined(__WXMSW__) + ~wxPaintEvent() + { + g_isPainting--; + } +#endif // debug }; // Erase background event class @@ -635,14 +789,18 @@ class WXDLLEXPORT wxPaintEvent: public wxEvent wxEVT_ERASE_BACKGROUND */ -class WXDLLEXPORT wxDC; -class WXDLLEXPORT wxEraseEvent: public wxEvent +class WXDLLEXPORT wxEraseEvent : public wxEvent { - DECLARE_DYNAMIC_CLASS(wxEraseEvent) - public: - wxDC *m_dc ; - inline wxEraseEvent(int Id = 0, wxDC *dc = (wxDC *) NULL) { m_eventType = wxEVT_ERASE_BACKGROUND; m_id = Id; m_dc = dc; } - inline wxDC *GetDC() const { return m_dc; } + DECLARE_DYNAMIC_CLASS(wxEraseEvent) + +public: + wxDC *m_dc; + + wxEraseEvent(int Id = 0, wxDC *dc = (wxDC *) NULL) + { m_eventType = wxEVT_ERASE_BACKGROUND; m_id = Id; m_dc = dc; } + wxDC *GetDC() const { return m_dc; } + + void CopyObject(wxObject& obj) const; }; // Focus event class @@ -651,12 +809,13 @@ class WXDLLEXPORT wxEraseEvent: public wxEvent wxEVT_KILL_FOCUS */ -class WXDLLEXPORT wxFocusEvent: public wxEvent +class WXDLLEXPORT wxFocusEvent : public wxEvent { - DECLARE_DYNAMIC_CLASS(wxFocusEvent) + DECLARE_DYNAMIC_CLASS(wxFocusEvent) - public: - inline wxFocusEvent(wxEventType type = wxEVT_NULL, int Id = 0) { m_eventType = type; m_id = Id; } +public: + wxFocusEvent(wxEventType type = wxEVT_NULL, int Id = 0) + { m_eventType = type; m_id = Id; } }; // Activate event class @@ -665,14 +824,19 @@ class WXDLLEXPORT wxFocusEvent: public wxEvent wxEVT_ACTIVATE_APP */ -class WXDLLEXPORT wxActivateEvent: public wxEvent +class WXDLLEXPORT wxActivateEvent : public wxEvent { - DECLARE_DYNAMIC_CLASS(wxActivateEvent) + DECLARE_DYNAMIC_CLASS(wxActivateEvent) + +public: + wxActivateEvent(wxEventType type = wxEVT_NULL, bool active = TRUE, int Id = 0) + { m_eventType = type; m_active = active; m_id = Id; } + bool GetActive() const { return m_active; } - public: - bool m_active; - inline wxActivateEvent(wxEventType type = wxEVT_NULL, bool active = TRUE, int Id = 0) { m_eventType = type; m_active = active; m_id = Id; } - inline bool GetActive(void) const { return m_active; } + void CopyObject(wxObject& obj) const; + +private: + bool m_active; }; // InitDialog event class @@ -680,12 +844,13 @@ class WXDLLEXPORT wxActivateEvent: public wxEvent wxEVT_INIT_DIALOG */ -class WXDLLEXPORT wxInitDialogEvent: public wxEvent +class WXDLLEXPORT wxInitDialogEvent : public wxEvent { - DECLARE_DYNAMIC_CLASS(wxInitDialogEvent) + DECLARE_DYNAMIC_CLASS(wxInitDialogEvent) - public: - inline wxInitDialogEvent(int Id = 0) { m_eventType = wxEVT_INIT_DIALOG; m_id = Id; } +public: + wxInitDialogEvent(int Id = 0) + { m_eventType = wxEVT_INIT_DIALOG; m_id = Id; } }; // Miscellaneous menu event class @@ -697,16 +862,19 @@ class WXDLLEXPORT wxInitDialogEvent: public wxEvent wxEVT_CONTEXT_MENU, */ -class WXDLLEXPORT wxMenuEvent: public wxEvent +class WXDLLEXPORT wxMenuEvent : public wxEvent { - DECLARE_DYNAMIC_CLASS(wxMenuEvent) + DECLARE_DYNAMIC_CLASS(wxMenuEvent) public: - int m_menuId; + wxMenuEvent(wxEventType type = wxEVT_NULL, int id = 0) + { m_eventType = type; m_menuId = id; } - inline wxMenuEvent(wxEventType type = wxEVT_NULL, int id = 0) { m_eventType = type; m_menuId = id; } + int GetMenuId() const { return m_menuId; } - inline int GetMenuId(void) const { return m_menuId; } + void CopyObject(wxObject& obj) const; +private: + int m_menuId; }; // Window close or session close event class @@ -716,78 +884,104 @@ public: wxEVT_QUERY_END_SESSION */ -class WXDLLEXPORT wxCloseEvent: public wxEvent +class WXDLLEXPORT wxCloseEvent : public wxEvent { - DECLARE_DYNAMIC_CLASS(wxCloseEvent) + DECLARE_DYNAMIC_CLASS(wxCloseEvent) + public: + wxCloseEvent(wxEventType type = wxEVT_NULL, int id = 0) + { + m_eventType = type; + m_loggingOff = TRUE; + m_veto = FALSE; // should be FALSE by default + m_id = id; +#if WXWIN_COMPATIBILITY + m_force = FALSE; +#endif // WXWIN_COMPATIBILITY + m_canVeto = TRUE; + } + + void SetLoggingOff(bool logOff) { m_loggingOff = logOff; } + bool GetLoggingOff() const { 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; } + // No more asserts here please, the one you put here was wrong. + bool CanVeto() const { return m_canVeto; } + bool GetVeto() const { return m_canVeto && m_veto; } + +#if WXWIN_COMPATIBILITY + // This is probably obsolete now, since we use CanVeto instead, in + // both OnCloseWindow and OnQueryEndSession. + // m_force == ! m_canVeto i.e., can't veto means we must force it to close. + void SetForce(bool force) { m_force = force; } + bool GetForce() const { return m_force; } +#endif + + void CopyObject(wxObject& obj) const; - inline wxCloseEvent(wxEventType type = wxEVT_NULL, int id = 0) - { m_eventType = type; m_loggingOff = TRUE; m_veto = FALSE; - m_id = id; m_force = FALSE; m_canVeto = FALSE; } - - inline void SetLoggingOff(bool logOff) { m_loggingOff = logOff; } - inline bool GetLoggingOff(void) const { return m_loggingOff; } - inline void Veto(bool veto = TRUE) { m_veto = veto; } - inline void SetCanVeto(bool canVeto) { m_canVeto = canVeto; } - inline bool CanVeto() const { return m_canVeto; } - inline bool GetVeto(void) const { return m_veto; } - - // This is probably obsolete now, since we use CanVeto instead, in - // both OnCloseWindow and OnQueryEndSession. - // m_force == ! m_canVeto i.e., can't veto means we must force it to close. - inline void SetForce(bool force) { m_force = force; } - inline bool GetForce(void) const { return m_force; } - - protected: - bool m_loggingOff; - bool m_veto; - bool m_force; - bool m_canVeto; +protected: + bool m_loggingOff; + bool m_veto, m_canVeto; + +#if WXWIN_COMPATIBILITY + bool m_force; +#endif }; /* wxEVT_SHOW */ -class WXDLLEXPORT wxShowEvent: public wxEvent +class WXDLLEXPORT wxShowEvent : public wxEvent { - DECLARE_DYNAMIC_CLASS(wxShowEvent) + DECLARE_DYNAMIC_CLASS(wxShowEvent) + public: - inline wxShowEvent(int id = 0, bool show = FALSE) - { m_eventType = wxEVT_SHOW; m_id = id; m_show = show; } + wxShowEvent(int id = 0, bool show = FALSE) + { m_eventType = wxEVT_SHOW; m_id = id; m_show = show; } + + void SetShow(bool show) { m_show = show; } + bool GetShow() const { return m_show; } - inline void SetShow(bool show) { m_show = show; } - inline bool GetShow(void) const { return m_show; } + void CopyObject(wxObject& obj) const; protected: - bool m_show; + bool m_show; }; /* wxEVT_ICONIZE */ -class WXDLLEXPORT wxIconizeEvent: public wxEvent +class WXDLLEXPORT wxIconizeEvent : public wxEvent { - DECLARE_DYNAMIC_CLASS(wxIconizeEvent) -public: + DECLARE_DYNAMIC_CLASS(wxIconizeEvent) - inline wxIconizeEvent(int id = 0) - { m_eventType = wxEVT_ICONIZE; m_id = id; } +public: + wxIconizeEvent(int id = 0) + { m_eventType = wxEVT_ICONIZE; m_id = id; } }; /* wxEVT_MAXIMIZE */ -class WXDLLEXPORT wxMaximizeEvent: public wxEvent +class WXDLLEXPORT wxMaximizeEvent : public wxEvent { - DECLARE_DYNAMIC_CLASS(wxMaximizeEvent) -public: + DECLARE_DYNAMIC_CLASS(wxMaximizeEvent) - inline wxMaximizeEvent(int id = 0) - { m_eventType = wxEVT_MAXIMIZE; m_id = id; } +public: + wxMaximizeEvent(int id = 0) + { m_eventType = wxEVT_MAXIMIZE; m_id = id; } }; // Joystick event class @@ -809,57 +1003,68 @@ public: #define wxJOY_BUTTON4 8 #define wxJOY_BUTTON_ANY -1 -class WXDLLEXPORT wxJoystickEvent: public wxEvent +class WXDLLEXPORT wxJoystickEvent : public wxEvent { - DECLARE_DYNAMIC_CLASS(wxJoystickEvent) - - public: - wxPoint m_pos; - int m_zPosition; - int m_buttonChange; // Which button changed? - int m_buttonState; // Which buttons are down? - int m_joyStick; // Which joystick? - - inline wxJoystickEvent(wxEventType type = wxEVT_NULL, int state = 0, int joystick = wxJOYSTICK1, int change = 0) - { m_eventType = type; m_buttonState = state; m_pos = wxPoint(0,0); m_zPosition = 0; - m_joyStick = joystick; m_buttonChange = change; } - - inline wxPoint GetPosition(void) const { return m_pos; } - inline int GetZPosition(void) const { return m_zPosition; } - inline int GetButtonState(void) const { return m_buttonState; } - inline int GetButtonChange(void) const { return m_buttonChange; } - inline int GetJoystick(void) const { return m_joyStick; } - - inline void SetJoystick(int stick) { m_joyStick = stick; } - inline void SetButtonState(int state) { m_buttonState = state; } - inline void SetButtonChange(int change) { m_buttonChange = change; } - inline void SetPosition(const wxPoint& pos) { m_pos = pos; } - inline void SetZPosition(int zPos) { m_zPosition = zPos; } - - // Was it a button event? (*doesn't* mean: is any button *down*?) - inline bool IsButton(void) const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) || - (GetEventType() == wxEVT_JOY_BUTTON_DOWN)); } - - // Was it a move event? - inline bool IsMove(void) const { return (GetEventType() == wxEVT_JOY_MOVE) ; } - - // Was it a zmove event? - inline bool IsZMove(void) const { return (GetEventType() == wxEVT_JOY_ZMOVE) ; } - - // Was it a down event from button 1, 2, 3, 4 or any? - inline bool ButtonDown(int but = wxJOY_BUTTON_ANY) const + DECLARE_DYNAMIC_CLASS(wxJoystickEvent) + +public: + wxPoint m_pos; + int m_zPosition; + int m_buttonChange; // Which button changed? + int m_buttonState; // Which buttons are down? + int m_joyStick; // Which joystick? + + wxJoystickEvent(wxEventType type = wxEVT_NULL, + int state = 0, + int joystick = wxJOYSTICK1, + int change = 0) + { + m_eventType = type; + m_buttonState = state; + m_pos = wxPoint(0,0); + m_zPosition = 0; + m_joyStick = joystick; + m_buttonChange = change; + } + + 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))); } + ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); } - // Was it a up event from button 1, 2, 3 or any? - inline bool ButtonUp(int but = wxJOY_BUTTON_ANY) const + // 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))); } + ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); } - // Was the given button 1,2,3,4 or any in Down state? - inline bool ButtonIsDown(int but = wxJOY_BUTTON_ANY) const + // 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)); } + ((m_buttonState & but) == but)); } + + void CopyObject(wxObject& obj) const; }; // Drop files event class @@ -867,41 +1072,25 @@ class WXDLLEXPORT wxJoystickEvent: public wxEvent wxEVT_DROP_FILES */ -class WXDLLEXPORT wxDropFilesEvent: public wxEvent +class WXDLLEXPORT wxDropFilesEvent : public wxEvent { - DECLARE_DYNAMIC_CLASS(wxDropFilesEvent) - - public: - int m_noFiles; - wxPoint m_pos; - wxString* m_files; // Memory (de)allocated by code calling ProcessEvent - - inline wxDropFilesEvent(wxEventType type = wxEVT_NULL, int noFiles = 0, wxString *files = (wxString *) NULL) - { m_eventType = type; m_noFiles = noFiles; m_files = files; } - - inline wxPoint GetPosition(void) const { return m_pos; } - inline int GetNumberOfFiles(void) const { return m_noFiles; } - inline wxString *GetFiles(void) const { return m_files; } -}; - -// Idle event -/* - wxEVT_IDLE - */ - -class WXDLLEXPORT wxIdleEvent: public wxEvent -{ - DECLARE_DYNAMIC_CLASS(wxIdleEvent) + DECLARE_DYNAMIC_CLASS(wxDropFilesEvent) public: - inline wxIdleEvent(void) - { m_eventType = wxEVT_IDLE; m_requestMore = FALSE; } + int m_noFiles; + wxPoint m_pos; + wxString* m_files; // Memory (de)allocated by code calling ProcessEvent - inline void RequestMore(bool needMore = TRUE) { m_requestMore = needMore; } - inline bool MoreRequested(void) const { return m_requestMore; } + wxDropFilesEvent(wxEventType type = wxEVT_NULL, + int noFiles = 0, + wxString *files = (wxString *) NULL) + { m_eventType = type; m_noFiles = noFiles; m_files = files; } -protected: - bool m_requestMore; + wxPoint GetPosition() const { return m_pos; } + int GetNumberOfFiles() const { return m_noFiles; } + wxString *GetFiles() const { return m_files; } + + void CopyObject(wxObject& obj) const; }; // Update UI event @@ -909,38 +1098,43 @@ protected: wxEVT_UPDATE_UI */ -class WXDLLEXPORT wxMenu; -class WXDLLEXPORT wxWindow; - -class WXDLLEXPORT wxUpdateUIEvent: public wxCommandEvent +class WXDLLEXPORT wxUpdateUIEvent : public wxCommandEvent { - DECLARE_DYNAMIC_CLASS(wxUpdateUIEvent) - - inline wxUpdateUIEvent(wxWindowID commandId = 0) - { m_eventType = wxEVT_UPDATE_UI; m_id = commandId; - m_checked = FALSE; m_setChecked = FALSE; m_enabled = FALSE; m_setEnabled = FALSE; - m_setText = FALSE; m_text = ""; } - - inline bool GetChecked(void) const { return m_checked; } - inline bool GetEnabled(void) const { return m_enabled; } - inline wxString GetText(void) const { return m_text; } - inline bool GetSetText(void) const { return m_setText; } - inline bool GetSetChecked(void) const { return m_setChecked; } - inline bool GetSetEnabled(void) const { return m_setEnabled; } + DECLARE_DYNAMIC_CLASS(wxUpdateUIEvent) - inline void Check(bool check) { m_checked = check; m_setChecked = TRUE; } - inline void Enable(bool enable) { m_enabled = enable; m_setEnabled = TRUE; } - inline void SetText(const wxString& text) { m_text = text; m_setText = TRUE; } - - protected: - - bool m_checked; - bool m_enabled; - bool m_setEnabled; - bool m_setText; - bool m_setChecked; - wxString m_text; +public: + wxUpdateUIEvent(wxWindowID commandId = 0) + { + m_eventType = wxEVT_UPDATE_UI; + m_id = commandId; + m_checked = FALSE; + m_setChecked = FALSE; + m_enabled = FALSE; + m_setEnabled = FALSE; + m_setText = FALSE; + 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; } + + void CopyObject(wxObject& obj) const; +protected: + bool m_checked; + bool m_enabled; + bool m_setEnabled; + bool m_setText; + bool m_setChecked; + wxString m_text; }; /* @@ -948,32 +1142,37 @@ class WXDLLEXPORT wxUpdateUIEvent: public wxCommandEvent */ // TODO: shouldn't all events record the window ID? -class WXDLLEXPORT wxSysColourChangedEvent: public wxEvent +class WXDLLEXPORT wxSysColourChangedEvent : public wxEvent { - DECLARE_DYNAMIC_CLASS(wxSysColourChangedEvent) + DECLARE_DYNAMIC_CLASS(wxSysColourChangedEvent) - public: - inline wxSysColourChangedEvent(void) - { m_eventType = wxEVT_SYS_COLOUR_CHANGED; } +public: + wxSysColourChangedEvent() + { m_eventType = wxEVT_SYS_COLOUR_CHANGED; } }; /* wxEVT_PALETTE_CHANGED */ -class WXDLLEXPORT wxPaletteChangedEvent: public wxEvent +class WXDLLEXPORT wxPaletteChangedEvent : public wxEvent { - DECLARE_DYNAMIC_CLASS(wxPaletteChangedEvent) + DECLARE_DYNAMIC_CLASS(wxPaletteChangedEvent) public: - inline wxPaletteChangedEvent(wxWindowID id = 0): wxEvent(id) - { m_eventType = wxEVT_PALETTE_CHANGED; m_changedWindow = (wxWindow *) NULL; } + wxPaletteChangedEvent(wxWindowID id = 0) : wxEvent(id) + { + m_eventType = wxEVT_PALETTE_CHANGED; + m_changedWindow = (wxWindow *) NULL; + } - inline void SetChangedWindow(wxWindow* win) { m_changedWindow = win; } - inline wxWindow* GetChangedWindow() const { return m_changedWindow; } + void SetChangedWindow(wxWindow* win) { m_changedWindow = win; } + wxWindow* GetChangedWindow() const { return m_changedWindow; } + + void CopyObject(wxObject& obj) const; protected: - wxWindow* m_changedWindow; + wxWindow* m_changedWindow; }; /* @@ -981,20 +1180,22 @@ protected: Indicates the window is getting keyboard focus and should re-do its palette. */ -class WXDLLEXPORT wxQueryNewPaletteEvent: public wxEvent +class WXDLLEXPORT wxQueryNewPaletteEvent : public wxEvent { - DECLARE_DYNAMIC_CLASS(wxQueryNewPaletteEvent) + DECLARE_DYNAMIC_CLASS(wxQueryNewPaletteEvent) public: - inline wxQueryNewPaletteEvent(wxWindowID id = 0): wxEvent(id) - { m_eventType = wxEVT_QUERY_NEW_PALETTE; m_paletteRealized = FALSE; } + wxQueryNewPaletteEvent(wxWindowID id = 0): wxEvent(id) + { m_eventType = wxEVT_QUERY_NEW_PALETTE; m_paletteRealized = FALSE; } + + // App sets this if it changes the palette. + void SetPaletteRealized(bool realized) { m_paletteRealized = realized; } + bool GetPaletteRealized() const { return m_paletteRealized; } - // App sets this if it changes the palette. - inline void SetPaletteRealized(bool realized) { m_paletteRealized = realized; } - inline bool GetPaletteRealized() const { return m_paletteRealized; } + void CopyObject(wxObject& obj) const; protected: - bool m_paletteRealized; + bool m_paletteRealized; }; /* @@ -1004,30 +1205,82 @@ protected: // must derive from command event to be propagated to the parent class WXDLLEXPORT wxNavigationKeyEvent : public wxCommandEvent { - DECLARE_DYNAMIC_CLASS(wxNavigationKeyEvent) + DECLARE_DYNAMIC_CLASS(wxNavigationKeyEvent) + +public: + wxNavigationKeyEvent() : wxCommandEvent(wxEVT_NAVIGATION_KEY) { } + + // direction: forward (true) or backward (false) + bool GetDirection() const { return m_commandInt == 1; } + void SetDirection(bool bForward) { m_commandInt = bForward; } + + // it may be a window change event (MDI, notebook pages...) or a control + // change event + bool IsWindowChange() const { return m_extraLong == 1; } + void SetWindowChange(bool bIs) { m_extraLong = bIs; } + + // the child which has the focus currently (may be NULL - use + // wxWindow::FindFocus then) + wxWindow* GetCurrentFocus() const { return (wxWindow *)m_clientData; } + void SetCurrentFocus(wxWindow *win) { m_clientData = (void *)win; } +}; + +// 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 WXDLLEXPORT wxWindowCreateEvent : public wxEvent +{ + DECLARE_DYNAMIC_CLASS(wxWindowCreateEvent) + +public: + wxWindowCreateEvent(wxWindow *win = NULL); + + wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); } +}; + +class WXDLLEXPORT wxWindowDestroyEvent : public wxEvent +{ + DECLARE_DYNAMIC_CLASS(wxWindowDestroyEvent) + +public: + wxWindowDestroyEvent(wxWindow *win = NULL); + + wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); } +}; + +#endif // wxUSE_GUI + +// Idle event +/* + wxEVT_IDLE + */ + +class WXDLLEXPORT wxIdleEvent : public wxEvent +{ + DECLARE_DYNAMIC_CLASS(wxIdleEvent) public: - wxNavigationKeyEvent() : wxCommandEvent(wxEVT_NAVIGATION_KEY) { } + wxIdleEvent() + { m_eventType = wxEVT_IDLE; m_requestMore = FALSE; } - // direction: forward (true) or backward (false) - bool GetDirection() const { return m_commandInt == 1; } - void SetDirection(bool bForward) { m_commandInt = bForward; } + void RequestMore(bool needMore = TRUE) { m_requestMore = needMore; } + bool MoreRequested() const { return m_requestMore; } - // it may be a window change event (MDI, notebook pages...) or a control - // change event - bool IsWindowChange() const { return m_extraLong == 1; } - void SetWindowChange(bool bIs) { m_extraLong = bIs; } + void CopyObject(wxObject& obj) const; - // the child which has the focus currently (may be NULL - use - // wxWindow::FindFocus then) - wxWindow* GetCurrentFocus() const { return (wxWindow *)m_clientData; } - void SetCurrentFocus(wxWindow *win) { m_clientData = (void *)win; } +protected: + bool m_requestMore; }; /* TODO wxEVT_POWER, - wxEVT_CREATE, - wxEVT_DESTROY, 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 @@ -1037,84 +1290,128 @@ public: wxEVT_COMPARE_ITEM */ -class WXDLLEXPORT wxWindow; -class WXDLLEXPORT wxControl; - -// struct WXDLLEXPORT wxEventTableEntry; +// ============================================================================ +// event handler and related classes +// ============================================================================ typedef void (wxObject::*wxObjectEventFunction)(wxEvent&); struct WXDLLEXPORT 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; + 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; }; struct WXDLLEXPORT wxEventTable { - const wxEventTable *baseTable; // Points to base event table (next in chain) - const wxEventTableEntry *entries; // Points to bottom of entry array + const wxEventTable *baseTable; // Points to base event table (next in chain) + const wxEventTableEntry *entries; // Points to bottom of entry array }; -class WXDLLEXPORT wxEvtHandler: public wxObject +class WXDLLEXPORT wxEvtHandler : public wxObject { - DECLARE_DYNAMIC_CLASS(wxEvtHandler) - public: - wxEvtHandler(void); - ~wxEvtHandler(void); - - inline wxEvtHandler *GetNextHandler(void) const { return m_nextHandler; } - inline wxEvtHandler *GetPreviousHandler(void) const { return m_previousHandler; } - inline void SetNextHandler(wxEvtHandler *handler) { m_nextHandler = handler; } - inline void SetPreviousHandler(wxEvtHandler *handler) { m_previousHandler = handler; } - - inline void SetEvtHandlerEnabled(bool en) { m_enabled = en; } - inline bool GetEvtHandlerEnabled(void) const { return m_enabled; } - - inline virtual void OnCommand(wxWindow& WXUNUSED(win), wxCommandEvent& WXUNUSED(event)) {}; - // Called if child control has no - // callback function - // Default behaviour - virtual long Default(void) { if (GetNextHandler()) return GetNextHandler()->Default(); else return 0; }; - - virtual bool OnClose(void); - - virtual bool ProcessEvent(wxEvent& event); - virtual bool SearchEventTable(wxEventTable& table, wxEvent& event); - - // Dynamic association of a member function handler with the event handler, id and event type - void Connect( int id, int lastId, wxEventType eventType, - wxObjectEventFunction func, - wxObject *userData = (wxObject *) NULL ); - - // Convenience function: take just one id - inline void Connect( int id, wxEventType eventType, - wxObjectEventFunction func, - wxObject *userData = (wxObject *) NULL ) { Connect(id, -1, eventType, func, userData); } - - bool SearchDynamicEventTable( wxEvent& event ); + DECLARE_DYNAMIC_CLASS(wxEvtHandler) + +public: + wxEvtHandler(); + ~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(); + + // add a +#if wxUSE_THREADS + bool ProcessThreadEvent(wxEvent& event); +#endif + + // Dynamic association of a member function handler with the event handler, + // id and event type + void Connect( int id, int lastId, wxEventType eventType, + wxObjectEventFunction func, + wxObject *userData = (wxObject *) NULL ); + + // Convenience function: take just one id + void Connect( int id, wxEventType eventType, + wxObjectEventFunction func, + wxObject *userData = (wxObject *) NULL ) + { Connect(id, -1, eventType, func, userData); } + + // implementation from now on + virtual bool SearchEventTable(wxEventTable& table, wxEvent& event); + bool SearchDynamicEventTable( wxEvent& event ); + +#if wxUSE_THREADS + void ClearEventLocker() { delete m_eventsLocker; m_eventsLocker = NULL; }; +#endif + + // old stuff + +#if WXWIN_COMPATIBILITY_2 + virtual void OnCommand(wxWindow& WXUNUSED(win), + wxCommandEvent& WXUNUSED(event)) + { + wxFAIL_MSG(wxT("shouldn't be called any more")); + } + + // Called if child control has no callback function + virtual long Default() + { return GetNextHandler() ? GetNextHandler()->Default() : 0; }; +#endif // WXWIN_COMPATIBILITY_2 + +#if WXWIN_COMPATIBILITY + virtual bool OnClose(); +#endif private: - static const wxEventTableEntry sm_eventTableEntries[]; + static const wxEventTableEntry sm_eventTableEntries[]; + protected: - static const wxEventTable sm_eventTable; - virtual const wxEventTable* GetEventTable() const; + static const wxEventTable sm_eventTable; + + virtual const wxEventTable *GetEventTable() const; + protected: - wxEvtHandler* m_nextHandler; - wxEvtHandler* m_previousHandler; - bool m_enabled; // Is event handler enabled? - wxList* m_dynamicEvents; + wxEvtHandler* m_nextHandler; + wxEvtHandler* m_previousHandler; + wxList* m_dynamicEvents; + wxList* m_pendingEvents; +#if wxUSE_THREADS + wxCriticalSection* m_eventsLocker; +#endif + // optimization: instead of using costly IsKindOf() to decide whether we're + // a window (which is true in 99% of cases), use this flag + bool m_isWindow; + + // Is event handler enabled? + bool m_enabled; }; typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&); +#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&); @@ -1137,26 +1434,27 @@ typedef void (wxEvtHandler::*wxMaximizeEventFunction)(wxShowEvent&); typedef void (wxEvtHandler::*wxNavigationKeyEventFunction)(wxNavigationKeyEvent&); typedef void (wxEvtHandler::*wxPaletteChangedEventFunction)(wxPaletteChangedEvent&); typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction)(wxQueryNewPaletteEvent&); +#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[];\ + static const wxEventTableEntry sm_eventTableEntries[];\ protected:\ - static const wxEventTable sm_eventTable;\ - virtual const wxEventTable* GetEventTable() const; + static const wxEventTable sm_eventTable;\ + virtual const wxEventTable* GetEventTable() const; #define BEGIN_EVENT_TABLE(theClass, baseClass) \ const wxEventTable *theClass::GetEventTable() const { return &theClass::sm_eventTable; }\ const wxEventTable theClass::sm_eventTable =\ - { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] };\ + { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] };\ const wxEventTableEntry theClass::sm_eventTableEntries[] = { \ #define END_EVENT_TABLE() \ { 0, 0, 0, 0, 0 } }; - + /* * Event table macros */ @@ -1194,6 +1492,8 @@ const wxEventTableEntry theClass::sm_eventTableEntries[] = { \ #define EVT_NAVIGATION_KEY(func) { wxEVT_NAVIGATION_KEY, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxNavigationKeyEventFunction) & func, (wxObject *) NULL }, #define EVT_PALETTE_CHANGED(func) { wxEVT_PALETTE_CHANGED, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxPaletteChangedEventFunction) & func, (wxObject *) NULL }, #define EVT_QUERY_NEW_PALETTE(func) { wxEVT_QUERY_NEW_PALETTE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxQueryNewPaletteEventFunction) & func, (wxObject *) NULL }, +#define EVT_WINDOW_CREATE(func) { wxEVT_CREATE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxQueryNewPaletteEventFunction) & func, (wxObject *) NULL }, +#define EVT_WINDOW_DESTROY(func) { wxEVT_DESTROY, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxQueryNewPaletteEventFunction) & func, (wxObject *) NULL }, // Mouse events #define EVT_LEFT_DOWN(func) { wxEVT_LEFT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL }, @@ -1225,10 +1525,28 @@ const wxEventTableEntry theClass::sm_eventTableEntries[] = { \ { wxEVT_LEAVE_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL }, // EVT_COMMAND -#define EVT_COMMAND(id, cmd, fn) { cmd, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL }, -#define EVT_COMMAND_RANGE(id1, id2, cmd, fn) { cmd, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL }, - -// Scrolling +#define EVT_COMMAND(id, event, fn) { event, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL }, +#define EVT_COMMAND_RANGE(id1, id2, event, fn) { event, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL }, + +// Scrolling from wxWindow (sent to wxScrolledWindow) +#define EVT_SCROLLWIN(func) \ + { wxEVT_SCROLLWIN_TOP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },\ + { wxEVT_SCROLLWIN_BOTTOM, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },\ + { wxEVT_SCROLLWIN_LINEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },\ + { wxEVT_SCROLLWIN_LINEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },\ + { wxEVT_SCROLLWIN_PAGEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },\ + { wxEVT_SCROLLWIN_PAGEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },\ + { wxEVT_SCROLLWIN_THUMBTRACK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL }, + +#define EVT_SCROLLWIN_TOP(func) { wxEVT_SCROLLWIN_TOP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL }, +#define EVT_SCROLLWIN_BOTTOM(func) { wxEVT_SCROLLWIN_BOTTOM, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL }, +#define EVT_SCROLLWIN_LINEUP(func) { wxEVT_SCROLLWIN_LINEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL }, +#define EVT_SCROLLWIN_LINEDOWN(func) { wxEVT_SCROLLWIN_LINEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL }, +#define EVT_SCROLLWIN_PAGEUP(func) { wxEVT_SCROLLWIN_PAGEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL }, +#define EVT_SCROLLWIN_PAGEDOWN(func) { wxEVT_SCROLLWIN_PAGEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL }, +#define EVT_SCROLLWIN_THUMBTRACK(func) { wxEVT_SCROLLWIN_THUMBTRACK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL }, + +// Scrolling from wxSlider and wxScrollBar #define EVT_SCROLL(func) \ { wxEVT_SCROLL_TOP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\ { wxEVT_SCROLL_BOTTOM, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\ @@ -1246,7 +1564,7 @@ const wxEventTableEntry theClass::sm_eventTableEntries[] = { \ #define EVT_SCROLL_PAGEDOWN(func) { wxEVT_SCROLL_PAGEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL }, #define EVT_SCROLL_THUMBTRACK(func) { wxEVT_SCROLL_THUMBTRACK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL }, -// Scrolling, with an id +// Scrolling from wxSlider and wxScrollBar, with an id #define EVT_COMMAND_SCROLL(id, func) \ { wxEVT_SCROLL_TOP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\ { wxEVT_SCROLL_BOTTOM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\ @@ -1322,5 +1640,28 @@ const wxEventTableEntry theClass::sm_eventTableEntries[] = { \ #define EVT_UPDATE_UI(id, func) \ { wxEVT_UPDATE_UI, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxUpdateUIEventFunction) & func, (wxObject *) NULL },\ +// ---------------------------------------------------------------------------- +// Global data +// ---------------------------------------------------------------------------- + +// for pending event processing - notice that there is intentionally no +// WXDLLEXPORT here +extern wxList *wxPendingEvents; +#if wxUSE_THREADS + extern 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_EVENTH__ + // _WX_EVENTH__