X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a737331db68b754c8bf31fa0a15f6d1f207b40bf..0f9b48d1e1535f8b92a73031be8cceff39123d27:/src/common/event.cpp diff --git a/src/common/event.cpp b/src/common/event.cpp index 2f4f8be170..9e8fbdf508 100644 --- a/src/common/event.cpp +++ b/src/common/event.cpp @@ -1,17 +1,21 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: event.cpp +// Name: src/common/event.cpp // Purpose: Event classes // Author: Julian Smart // Modified by: // Created: 01/02/97 // RCS-ID: $Id$ -// Copyright: (c) Julian Smart and Markus Holzem -// Licence: wxWindows licence +// Copyright: (c) Julian Smart +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -#ifdef __GNUG__ - #pragma implementation "event.h" -#endif +// ============================================================================ +// declarations +// ============================================================================ + +// ---------------------------------------------------------------------------- +// headers +// ---------------------------------------------------------------------------- // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" @@ -20,30 +24,58 @@ #pragma hdrstop #endif +#include "wx/event.h" +#include "wx/evtloop.h" + #ifndef WX_PRECOMP - #include "wx/defs.h" - #include "wx/control.h" - #include "wx/utils.h" + #include "wx/list.h" #include "wx/app.h" - #include "wx/dc.h" + #include "wx/utils.h" + #include "wx/stopwatch.h" + #include "wx/module.h" + + #if wxUSE_GUI + #include "wx/window.h" + #include "wx/control.h" + #include "wx/dc.h" + #include "wx/textctrl.h" + #include "wx/validate.h" + #endif // wxUSE_GUI #endif -#include "wx/event.h" -#include "wx/validate.h" +#include "wx/thread.h" + +#if wxUSE_BASE + #include "wx/ptr_scpd.h" -#if !USE_SHARED_LIBRARY + wxDECLARE_SCOPED_PTR(wxEvent, wxEventPtr) + wxDEFINE_SCOPED_PTR(wxEvent, wxEventPtr) +#endif // wxUSE_BASE + +// ---------------------------------------------------------------------------- +// wxWin macros +// ---------------------------------------------------------------------------- + +#if wxUSE_BASE IMPLEMENT_DYNAMIC_CLASS(wxEvtHandler, wxObject) IMPLEMENT_ABSTRACT_CLASS(wxEvent, wxObject) + IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent, wxEvent) +#endif // wxUSE_BASE + +#if wxUSE_GUI IMPLEMENT_DYNAMIC_CLASS(wxCommandEvent, wxEvent) IMPLEMENT_DYNAMIC_CLASS(wxNotifyEvent, wxCommandEvent) IMPLEMENT_DYNAMIC_CLASS(wxScrollEvent, wxCommandEvent) + IMPLEMENT_DYNAMIC_CLASS(wxScrollWinEvent, wxEvent) IMPLEMENT_DYNAMIC_CLASS(wxMouseEvent, wxEvent) IMPLEMENT_DYNAMIC_CLASS(wxKeyEvent, wxEvent) IMPLEMENT_DYNAMIC_CLASS(wxSizeEvent, wxEvent) IMPLEMENT_DYNAMIC_CLASS(wxPaintEvent, wxEvent) + IMPLEMENT_DYNAMIC_CLASS(wxNcPaintEvent, wxEvent) IMPLEMENT_DYNAMIC_CLASS(wxEraseEvent, wxEvent) IMPLEMENT_DYNAMIC_CLASS(wxMoveEvent, wxEvent) IMPLEMENT_DYNAMIC_CLASS(wxFocusEvent, wxEvent) + IMPLEMENT_DYNAMIC_CLASS(wxChildFocusEvent, wxCommandEvent) IMPLEMENT_DYNAMIC_CLASS(wxCloseEvent, wxEvent) IMPLEMENT_DYNAMIC_CLASS(wxShowEvent, wxEvent) IMPLEMENT_DYNAMIC_CLASS(wxMaximizeEvent, wxEvent) @@ -53,39 +85,270 @@ IMPLEMENT_DYNAMIC_CLASS(wxDropFilesEvent, wxEvent) IMPLEMENT_DYNAMIC_CLASS(wxActivateEvent, wxEvent) IMPLEMENT_DYNAMIC_CLASS(wxInitDialogEvent, wxEvent) + IMPLEMENT_DYNAMIC_CLASS(wxSetCursorEvent, wxEvent) IMPLEMENT_DYNAMIC_CLASS(wxSysColourChangedEvent, wxEvent) - IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent, wxEvent) + IMPLEMENT_DYNAMIC_CLASS(wxDisplayChangedEvent, wxEvent) IMPLEMENT_DYNAMIC_CLASS(wxUpdateUIEvent, wxCommandEvent) - IMPLEMENT_DYNAMIC_CLASS(wxNavigationKeyEvent, wxCommandEvent) + IMPLEMENT_DYNAMIC_CLASS(wxNavigationKeyEvent, wxEvent) IMPLEMENT_DYNAMIC_CLASS(wxPaletteChangedEvent, wxEvent) IMPLEMENT_DYNAMIC_CLASS(wxQueryNewPaletteEvent, wxEvent) + IMPLEMENT_DYNAMIC_CLASS(wxWindowCreateEvent, wxEvent) + IMPLEMENT_DYNAMIC_CLASS(wxWindowDestroyEvent, wxEvent) + IMPLEMENT_DYNAMIC_CLASS(wxHelpEvent, wxCommandEvent) + IMPLEMENT_DYNAMIC_CLASS(wxContextMenuEvent, wxCommandEvent) + IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureChangedEvent, wxEvent) + IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureLostEvent, wxEvent) + IMPLEMENT_DYNAMIC_CLASS(wxClipboardTextEvent, wxCommandEvent) +#endif // wxUSE_GUI + +#if wxUSE_BASE + +const wxEventTable *wxEvtHandler::GetEventTable() const + { return &wxEvtHandler::sm_eventTable; } - const wxEventTable *wxEvtHandler::GetEventTable() const - { return &wxEvtHandler::sm_eventTable; } +const wxEventTable wxEvtHandler::sm_eventTable = + { (const wxEventTable *)NULL, &wxEvtHandler::sm_eventTableEntries[0] }; - const wxEventTable wxEvtHandler::sm_eventTable = - { (const wxEventTable *)NULL, &wxEvtHandler::sm_eventTableEntries[0] }; +wxEventHashTable &wxEvtHandler::GetEventHashTable() const + { return wxEvtHandler::sm_eventHashTable; } - const wxEventTableEntry wxEvtHandler::sm_eventTableEntries[] = - { { 0, 0, 0, - #ifdef __SGI_CC__ - // stupid SGI compiler --- offer aug 98 - 0L } - #else // !SGI CC - NULL } - #endif // SGI/!SGI - }; +wxEventHashTable wxEvtHandler::sm_eventHashTable(wxEvtHandler::sm_eventTable); -#endif // !USE_SHARED_LIBRARY +const wxEventTableEntry wxEvtHandler::sm_eventTableEntries[] = + { DECLARE_EVENT_TABLE_ENTRY(wxEVT_NULL, 0, 0, (wxObjectEventFunction)NULL, NULL) }; + + +// wxUSE_MEMORY_TRACING considers memory freed from the static objects dtors +// leaked, so we need to manually clean up all event tables before checking for +// the memory leaks when using it, however this breaks re-initializing the +// library (i.e. repeated calls to wxInitialize/wxUninitialize) because the +// event tables won't be rebuilt the next time, so disable this by default +#if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING + +class wxEventTableEntryModule: public wxModule +{ +public: + wxEventTableEntryModule() { } + virtual bool OnInit() { return true; } + virtual void OnExit() { wxEventHashTable::ClearAll(); } + + DECLARE_DYNAMIC_CLASS(wxEventTableEntryModule) +}; + +IMPLEMENT_DYNAMIC_CLASS(wxEventTableEntryModule, wxModule) + +#endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING + +// ---------------------------------------------------------------------------- +// global variables +// ---------------------------------------------------------------------------- + +// List containing event handlers with pending events (each handler can occur +// at most once here) +wxList *wxPendingEvents = NULL; #if wxUSE_THREADS -/* To put pending event handlers */ -extern wxList *wxPendingEvents; -extern wxCriticalSection *wxPendingEventsLocker; + // protects wxPendingEvents list + wxCriticalSection *wxPendingEventsLocker = NULL; #endif +// common event types are defined here, other event types are defined by the +// components which use them + +const wxEventType wxEVT_FIRST = 10000; +const wxEventType wxEVT_USER_FIRST = wxEVT_FIRST + 2000; + +DEFINE_EVENT_TYPE(wxEVT_NULL) +DEFINE_EVENT_TYPE(wxEVT_IDLE) +DEFINE_EVENT_TYPE(wxEVT_SOCKET) +DEFINE_EVENT_TYPE(wxEVT_TIMER) + +#endif // wxUSE_BASE + +#if wxUSE_GUI + +DEFINE_EVENT_TYPE(wxEVT_COMMAND_BUTTON_CLICKED) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHECKBOX_CLICKED) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHOICE_SELECTED) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_SELECTED) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_MENU_SELECTED) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_SLIDER_UPDATED) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_RADIOBOX_SELECTED) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_RADIOBUTTON_SELECTED) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_SCROLLBAR_UPDATED) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_VLBOX_SELECTED) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_COMBOBOX_SELECTED) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_RCLICKED) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_ENTER) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPINCTRL_UPDATED) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED) + +// Mouse event types +DEFINE_EVENT_TYPE(wxEVT_LEFT_DOWN) +DEFINE_EVENT_TYPE(wxEVT_LEFT_UP) +DEFINE_EVENT_TYPE(wxEVT_MIDDLE_DOWN) +DEFINE_EVENT_TYPE(wxEVT_MIDDLE_UP) +DEFINE_EVENT_TYPE(wxEVT_RIGHT_DOWN) +DEFINE_EVENT_TYPE(wxEVT_RIGHT_UP) +DEFINE_EVENT_TYPE(wxEVT_MOTION) +DEFINE_EVENT_TYPE(wxEVT_ENTER_WINDOW) +DEFINE_EVENT_TYPE(wxEVT_LEAVE_WINDOW) +DEFINE_EVENT_TYPE(wxEVT_LEFT_DCLICK) +DEFINE_EVENT_TYPE(wxEVT_MIDDLE_DCLICK) +DEFINE_EVENT_TYPE(wxEVT_RIGHT_DCLICK) +DEFINE_EVENT_TYPE(wxEVT_SET_FOCUS) +DEFINE_EVENT_TYPE(wxEVT_KILL_FOCUS) +DEFINE_EVENT_TYPE(wxEVT_CHILD_FOCUS) +DEFINE_EVENT_TYPE(wxEVT_MOUSEWHEEL) +DEFINE_EVENT_TYPE(wxEVT_AUX1_DOWN) +DEFINE_EVENT_TYPE(wxEVT_AUX1_UP) +DEFINE_EVENT_TYPE(wxEVT_AUX1_DCLICK) +DEFINE_EVENT_TYPE(wxEVT_AUX2_DOWN) +DEFINE_EVENT_TYPE(wxEVT_AUX2_UP) +DEFINE_EVENT_TYPE(wxEVT_AUX2_DCLICK) + +// Non-client mouse events +DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_DOWN) +DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_UP) +DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_DOWN) +DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_UP) +DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_DOWN) +DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_UP) +DEFINE_EVENT_TYPE(wxEVT_NC_MOTION) +DEFINE_EVENT_TYPE(wxEVT_NC_ENTER_WINDOW) +DEFINE_EVENT_TYPE(wxEVT_NC_LEAVE_WINDOW) +DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_DCLICK) +DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_DCLICK) +DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_DCLICK) + +// Character input event type +DEFINE_EVENT_TYPE(wxEVT_CHAR) +DEFINE_EVENT_TYPE(wxEVT_CHAR_HOOK) +DEFINE_EVENT_TYPE(wxEVT_NAVIGATION_KEY) +DEFINE_EVENT_TYPE(wxEVT_KEY_DOWN) +DEFINE_EVENT_TYPE(wxEVT_KEY_UP) +#if wxUSE_HOTKEY +DEFINE_EVENT_TYPE(wxEVT_HOTKEY) +#endif + +// Set cursor event +DEFINE_EVENT_TYPE(wxEVT_SET_CURSOR) + +// wxScrollbar and wxSlider event identifiers +DEFINE_EVENT_TYPE(wxEVT_SCROLL_TOP) +DEFINE_EVENT_TYPE(wxEVT_SCROLL_BOTTOM) +DEFINE_EVENT_TYPE(wxEVT_SCROLL_LINEUP) +DEFINE_EVENT_TYPE(wxEVT_SCROLL_LINEDOWN) +DEFINE_EVENT_TYPE(wxEVT_SCROLL_PAGEUP) +DEFINE_EVENT_TYPE(wxEVT_SCROLL_PAGEDOWN) +DEFINE_EVENT_TYPE(wxEVT_SCROLL_THUMBTRACK) +DEFINE_EVENT_TYPE(wxEVT_SCROLL_THUMBRELEASE) +DEFINE_EVENT_TYPE(wxEVT_SCROLL_CHANGED) + +// Scroll events from wxWindow +DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_TOP) +DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_BOTTOM) +DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEUP) +DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEDOWN) +DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEUP) +DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEDOWN) +DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBTRACK) +DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBRELEASE) + +// System events +DEFINE_EVENT_TYPE(wxEVT_SIZE) +DEFINE_EVENT_TYPE(wxEVT_SIZING) +DEFINE_EVENT_TYPE(wxEVT_MOVE) +DEFINE_EVENT_TYPE(wxEVT_MOVING) +DEFINE_EVENT_TYPE(wxEVT_MOVE_START) +DEFINE_EVENT_TYPE(wxEVT_MOVE_END) +DEFINE_EVENT_TYPE(wxEVT_CLOSE_WINDOW) +DEFINE_EVENT_TYPE(wxEVT_END_SESSION) +DEFINE_EVENT_TYPE(wxEVT_QUERY_END_SESSION) +DEFINE_EVENT_TYPE(wxEVT_HIBERNATE) +DEFINE_EVENT_TYPE(wxEVT_ACTIVATE_APP) +DEFINE_EVENT_TYPE(wxEVT_ACTIVATE) +DEFINE_EVENT_TYPE(wxEVT_CREATE) +DEFINE_EVENT_TYPE(wxEVT_DESTROY) +DEFINE_EVENT_TYPE(wxEVT_SHOW) +DEFINE_EVENT_TYPE(wxEVT_ICONIZE) +DEFINE_EVENT_TYPE(wxEVT_MAXIMIZE) +DEFINE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_CHANGED) +DEFINE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_LOST) +DEFINE_EVENT_TYPE(wxEVT_PAINT) +DEFINE_EVENT_TYPE(wxEVT_ERASE_BACKGROUND) +DEFINE_EVENT_TYPE(wxEVT_NC_PAINT) +DEFINE_EVENT_TYPE(wxEVT_PAINT_ICON) +DEFINE_EVENT_TYPE(wxEVT_MENU_OPEN) +DEFINE_EVENT_TYPE(wxEVT_MENU_CLOSE) +DEFINE_EVENT_TYPE(wxEVT_MENU_HIGHLIGHT) +DEFINE_EVENT_TYPE(wxEVT_CONTEXT_MENU) +DEFINE_EVENT_TYPE(wxEVT_SYS_COLOUR_CHANGED) +DEFINE_EVENT_TYPE(wxEVT_DISPLAY_CHANGED) +DEFINE_EVENT_TYPE(wxEVT_SETTING_CHANGED) +DEFINE_EVENT_TYPE(wxEVT_QUERY_NEW_PALETTE) +DEFINE_EVENT_TYPE(wxEVT_PALETTE_CHANGED) +DEFINE_EVENT_TYPE(wxEVT_JOY_BUTTON_DOWN) +DEFINE_EVENT_TYPE(wxEVT_JOY_BUTTON_UP) +DEFINE_EVENT_TYPE(wxEVT_JOY_MOVE) +DEFINE_EVENT_TYPE(wxEVT_JOY_ZMOVE) +DEFINE_EVENT_TYPE(wxEVT_DROP_FILES) +DEFINE_EVENT_TYPE(wxEVT_DRAW_ITEM) +DEFINE_EVENT_TYPE(wxEVT_MEASURE_ITEM) +DEFINE_EVENT_TYPE(wxEVT_COMPARE_ITEM) +DEFINE_EVENT_TYPE(wxEVT_INIT_DIALOG) +DEFINE_EVENT_TYPE(wxEVT_UPDATE_UI) + +// Clipboard events +DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_COPY) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_CUT) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_PASTE) + +// Generic command events +// Note: a click is a higher-level event than button down/up +DEFINE_EVENT_TYPE(wxEVT_COMMAND_LEFT_CLICK) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_LEFT_DCLICK) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_CLICK) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_DCLICK) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_SET_FOCUS) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_KILL_FOCUS) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_ENTER) + +// Help events +DEFINE_EVENT_TYPE(wxEVT_HELP) +DEFINE_EVENT_TYPE(wxEVT_DETAILED_HELP) + +#endif // wxUSE_GUI + +#if wxUSE_BASE + +wxIdleMode wxIdleEvent::sm_idleMode = wxIDLE_PROCESS_ALL; + +// ============================================================================ +// implementation +// ============================================================================ + +// ---------------------------------------------------------------------------- +// event initialization +// ---------------------------------------------------------------------------- + +int wxNewEventType() +{ + // MT-FIXME + static int s_lastUsedEventType = wxEVT_FIRST; + + return s_lastUsedEventType++; +} + +// ---------------------------------------------------------------------------- +// wxEvent +// ---------------------------------------------------------------------------- + /* - * General wxWindows events, covering + * General wxWidgets events, covering * all interesting things that might happen (button clicking, resizing, * setting text in widgets, etc.). * @@ -93,49 +356,137 @@ extern wxCriticalSection *wxPendingEventsLocker; * */ -wxEvent::wxEvent(int theId) +wxEvent::wxEvent(int theId, wxEventType commandType ) { - m_eventType = wxEVT_NULL; + m_eventType = commandType; m_eventObject = (wxObject *) NULL; - m_eventHandle = (char *) NULL; m_timeStamp = 0; m_id = theId; - m_skipped = FALSE; + m_skipped = false; m_callbackUserData = (wxObject *) NULL; - m_isCommandEvent = FALSE; + m_isCommandEvent = false; + m_propagationLevel = wxEVENT_PROPAGATE_NONE; } -wxObject *wxEvent::Clone() const +wxEvent::wxEvent(const wxEvent &src) + : wxObject(src) + , m_eventObject(src.m_eventObject) + , m_eventType(src.m_eventType) + , m_timeStamp(src.m_timeStamp) + , m_id(src.m_id) + , m_callbackUserData(src.m_callbackUserData) + , m_propagationLevel(src.m_propagationLevel) + , m_skipped(src.m_skipped) + , m_isCommandEvent(src.m_isCommandEvent) { - wxEvent *event = (wxEvent *)wxObject::Clone(); +} - event->m_eventType = m_eventType; - event->m_eventObject = m_eventObject; - event->m_eventHandle = m_eventHandle; - event->m_timeStamp = m_timeStamp; - event->m_id = m_id; - event->m_skipped = m_skipped; - event->m_callbackUserData = m_callbackUserData; - event->m_isCommandEvent = m_isCommandEvent; +#endif // wxUSE_BASE - return event; -} +#if wxUSE_GUI /* * Command events * */ +#ifdef __VISUALC__ + // 'this' : used in base member initializer list (for m_commandString) + #pragma warning(disable:4355) +#endif + wxCommandEvent::wxCommandEvent(wxEventType commandType, int theId) + : wxEvent(theId, commandType) { - m_eventType = commandType; m_clientData = (char *) NULL; m_clientObject = (wxClientData *) NULL; m_extraLong = 0; m_commandInt = 0; - m_id = theId; - m_commandString = (wxChar *) NULL; - m_isCommandEvent = TRUE; + m_isCommandEvent = true; + + // the command events are propagated upwards by default + m_propagationLevel = wxEVENT_PROPAGATE_MAX; +} + +#ifdef __VISUALC__ + #pragma warning(default:4355) +#endif + +wxString wxCommandEvent::GetString() const +{ + if (m_eventType != wxEVT_COMMAND_TEXT_UPDATED || !m_eventObject) + { + return m_cmdString; + } + else + { +#if wxUSE_TEXTCTRL + wxTextCtrl *txt = wxDynamicCast(m_eventObject, wxTextCtrl); + if ( txt ) + return txt->GetValue(); + else +#endif // wxUSE_TEXTCTRL + return m_cmdString; + } +} + +/* + * UI update events + */ + +#if wxUSE_LONGLONG +wxLongLong wxUpdateUIEvent::sm_lastUpdate = 0; +#endif + +long wxUpdateUIEvent::sm_updateInterval = 0; + +wxUpdateUIMode wxUpdateUIEvent::sm_updateMode = wxUPDATE_UI_PROCESS_ALL; + +// Can we update? +bool wxUpdateUIEvent::CanUpdate(wxWindowBase *win) +{ + // Don't update if we've switched global updating off + // and this window doesn't support updates. + if (win && + (GetMode() == wxUPDATE_UI_PROCESS_SPECIFIED && + ((win->GetExtraStyle() & wxWS_EX_PROCESS_UI_UPDATES) == 0))) + return false; + + if (sm_updateInterval == -1) + return false; + + if (sm_updateInterval == 0) + return true; + +#if wxUSE_STOPWATCH && wxUSE_LONGLONG + wxLongLong now = wxGetLocalTimeMillis(); + if (now > (sm_lastUpdate + sm_updateInterval)) + { + return true; + } + + return false; +#else + // If we don't have wxStopWatch or wxLongLong, we + // should err on the safe side and update now anyway. + return true; +#endif +} + +// Reset the update time to provide a delay until the next +// time we should update +void wxUpdateUIEvent::ResetUpdateTime() +{ +#if wxUSE_STOPWATCH && wxUSE_LONGLONG + if (sm_updateInterval > 0) + { + wxLongLong now = wxGetLocalTimeMillis(); + if (now > (sm_lastUpdate + sm_updateInterval)) + { + sm_lastUpdate = now; + } + } +#endif } /* @@ -146,12 +497,24 @@ wxScrollEvent::wxScrollEvent(wxEventType commandType, int id, int pos, int orient) - : wxCommandEvent(commandType, id) + : wxCommandEvent(commandType, id) { m_extraLong = orient; m_commandInt = pos; } +/* + * ScrollWin events + */ + +wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType, + int pos, + int orient) +{ + m_eventType = commandType; + m_extraLong = orient; + m_commandInt = pos; +} /* * Mouse events @@ -161,114 +524,213 @@ wxScrollEvent::wxScrollEvent(wxEventType commandType, wxMouseEvent::wxMouseEvent(wxEventType commandType) { m_eventType = commandType; - m_metaDown = FALSE; - m_altDown = FALSE; - m_controlDown = FALSE; - m_shiftDown = FALSE; - m_leftDown = FALSE; - m_rightDown = FALSE; - m_middleDown = FALSE; + m_x = 0; m_y = 0; + + m_leftDown = false; + m_middleDown = false; + m_rightDown = false; + m_aux1Down = false; + m_aux2Down = false; + + m_controlDown = false; + m_shiftDown = false; + m_altDown = false; + m_metaDown = false; + + m_clickCount = -1; + + m_wheelRotation = 0; + m_wheelDelta = 0; + m_linesPerAction = 0; + m_wheelAxis = 0; +} + +void wxMouseEvent::Assign(const wxMouseEvent& event) +{ + m_eventType = event.m_eventType; + + m_x = event.m_x; + m_y = event.m_y; + + m_leftDown = event.m_leftDown; + m_middleDown = event.m_middleDown; + m_rightDown = event.m_rightDown; + m_aux1Down = event.m_aux1Down; + m_aux2Down = event.m_aux2Down; + + m_controlDown = event.m_controlDown; + m_shiftDown = event.m_shiftDown; + m_altDown = event.m_altDown; + m_metaDown = event.m_metaDown; + + m_wheelRotation = event.m_wheelRotation; + m_wheelDelta = event.m_wheelDelta; + m_linesPerAction = event.m_linesPerAction; + m_wheelAxis = event.m_wheelAxis; } -// True if was a button dclick event (1 = left, 2 = middle, 3 = right) -// or any button dclick event (but = -1) +// return true if was a button dclick event bool wxMouseEvent::ButtonDClick(int but) const { switch (but) { - case -1: - return (LeftDClick() || MiddleDClick() || RightDClick()); - case 1: + default: + wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDClick")); + // fall through + + case wxMOUSE_BTN_ANY: + return (LeftDClick() || MiddleDClick() || RightDClick() || + Aux1DClick() || Aux2DClick()); + + case wxMOUSE_BTN_LEFT: return LeftDClick(); - case 2: + + case wxMOUSE_BTN_MIDDLE: return MiddleDClick(); - case 3: + + case wxMOUSE_BTN_RIGHT: return RightDClick(); - default: - wxFAIL_MSG(_T("invalid parameter in wxMouseEvent::ButtonDClick")); - } - return FALSE; + case wxMOUSE_BTN_AUX1: + return Aux1DClick(); + + case wxMOUSE_BTN_AUX2: + return Aux2DClick(); + } } -// True if was a button down event (1 = left, 2 = middle, 3 = right) -// or any button down event (but = -1) +// return true if was a button down event bool wxMouseEvent::ButtonDown(int but) const { switch (but) { - case -1: - return (LeftDown() || MiddleDown() || RightDown()); - case 1: + default: + wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDown")); + // fall through + + case wxMOUSE_BTN_ANY: + return (LeftDown() || MiddleDown() || RightDown() || + Aux1Down() || Aux2Down()); + + case wxMOUSE_BTN_LEFT: return LeftDown(); - case 2: + + case wxMOUSE_BTN_MIDDLE: return MiddleDown(); - case 3: + + case wxMOUSE_BTN_RIGHT: return RightDown(); - default: - wxFAIL_MSG(_T("invalid parameter in wxMouseEvent::ButtonDown")); - } - return FALSE; + case wxMOUSE_BTN_AUX1: + return Aux1Down(); + + case wxMOUSE_BTN_AUX2: + return Aux2Down(); + } } -// True if was a button up event (1 = left, 2 = middle, 3 = right) -// or any button up event (but = -1) +// return true if was a button up event bool wxMouseEvent::ButtonUp(int but) const { - switch (but) { - case -1: - return (LeftUp() || MiddleUp() || RightUp()); - case 1: + switch (but) + { + default: + wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonUp")); + // fall through + + case wxMOUSE_BTN_ANY: + return (LeftUp() || MiddleUp() || RightUp() || + Aux1Up() || Aux2Up()); + + case wxMOUSE_BTN_LEFT: return LeftUp(); - case 2: + + case wxMOUSE_BTN_MIDDLE: return MiddleUp(); - case 3: + + case wxMOUSE_BTN_RIGHT: return RightUp(); - default: - wxFAIL_MSG(_T("invalid parameter in wxMouseEvent::ButtonUp")); - } - return FALSE; + case wxMOUSE_BTN_AUX1: + return Aux1Up(); + + case wxMOUSE_BTN_AUX2: + return Aux2Up(); + } } -// True if the given button is currently changing state +// return true if the given button is currently changing state bool wxMouseEvent::Button(int but) const { - switch (but) { - case -1: - return (ButtonUp(-1) || ButtonDown(-1) || ButtonDClick(-1)) ; - case 1: - return (LeftDown() || LeftUp() || LeftDClick()); - case 2: - return (MiddleDown() || MiddleUp() || MiddleDClick()); - case 3: - return (RightDown() || RightUp() || RightDClick()); + switch (but) + { default: - wxFAIL_MSG(_T("invalid parameter in wxMouseEvent::Button")); - } + wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::Button")); + // fall through - return FALSE; + case wxMOUSE_BTN_ANY: + return ButtonUp(wxMOUSE_BTN_ANY) || + ButtonDown(wxMOUSE_BTN_ANY) || + ButtonDClick(wxMOUSE_BTN_ANY); + + case wxMOUSE_BTN_LEFT: + return LeftDown() || LeftUp() || LeftDClick(); + + case wxMOUSE_BTN_MIDDLE: + return MiddleDown() || MiddleUp() || MiddleDClick(); + + case wxMOUSE_BTN_RIGHT: + return RightDown() || RightUp() || RightDClick(); + + case wxMOUSE_BTN_AUX1: + return Aux1Down() || Aux1Up() || Aux1DClick(); + + case wxMOUSE_BTN_AUX2: + return Aux2Down() || Aux2Up() || Aux2DClick(); + } } bool wxMouseEvent::ButtonIsDown(int but) const { - switch (but) { - case -1: - return (LeftIsDown() || MiddleIsDown() || RightIsDown()); - case 1: + switch (but) + { + default: + wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonIsDown")); + // fall through + + case wxMOUSE_BTN_ANY: + return LeftIsDown() || MiddleIsDown() || RightIsDown() || Aux1Down() || Aux2Down(); + + case wxMOUSE_BTN_LEFT: return LeftIsDown(); - case 2: + + case wxMOUSE_BTN_MIDDLE: return MiddleIsDown(); - case 3: + + case wxMOUSE_BTN_RIGHT: return RightIsDown(); - default: - wxFAIL_MSG(_T("invalid parameter in wxMouseEvent::ButtonIsDown")); + + case wxMOUSE_BTN_AUX1: + return Aux1IsDown(); + + case wxMOUSE_BTN_AUX2: + return Aux2IsDown(); } +} - return FALSE; +int wxMouseEvent::GetButton() const +{ + for ( int i = 1; i < wxMOUSE_BTN_MAX; i++ ) + { + if ( Button(i) ) + { + return i; + } + } + + return wxMOUSE_BTN_NONE; } // Find the logical position of the event given the DC @@ -280,39 +742,313 @@ wxPoint wxMouseEvent::GetLogicalPosition(const wxDC& dc) const /* - * Keyboard events + * Keyboard event * */ wxKeyEvent::wxKeyEvent(wxEventType type) { m_eventType = type; - m_shiftDown = FALSE; - m_controlDown = FALSE; - m_metaDown = FALSE; - m_altDown = FALSE; + m_shiftDown = false; + m_controlDown = false; + m_metaDown = false; + m_altDown = false; m_keyCode = 0; + m_scanCode = 0; +#if wxUSE_UNICODE + m_uniChar = 0; +#endif +} + +wxKeyEvent::wxKeyEvent(const wxKeyEvent& evt) + : wxEvent(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 +} + +wxWindowCreateEvent::wxWindowCreateEvent(wxWindow *win) +{ + SetEventType(wxEVT_CREATE); + SetEventObject(win); +} + +wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow *win) +{ + SetEventType(wxEVT_DESTROY); + SetEventObject(win); +} + +wxChildFocusEvent::wxChildFocusEvent(wxWindow *win) + : wxCommandEvent(wxEVT_CHILD_FOCUS) +{ + SetEventObject(win); +} + +// ---------------------------------------------------------------------------- +// wxHelpEvent +// ---------------------------------------------------------------------------- + +/* static */ +wxHelpEvent::Origin wxHelpEvent::GuessOrigin(Origin origin) +{ + if ( origin == Origin_Unknown ) + { + // assume that the event comes from the help button if it's not from + // keyboard and that pressing F1 always results in the help event + origin = wxGetKeyState(WXK_F1) ? Origin_Keyboard : Origin_HelpButton; + } + + return origin; } +#endif // wxUSE_GUI + + +#if wxUSE_BASE + +// ---------------------------------------------------------------------------- +// wxEventHashTable +// ---------------------------------------------------------------------------- + +static const int EVENT_TYPE_TABLE_INIT_SIZE = 31; // Not too big not too small... + +wxEventHashTable* wxEventHashTable::sm_first = NULL; + +wxEventHashTable::wxEventHashTable(const wxEventTable &table) + : m_table(table), + m_rebuildHash(true) +{ + AllocEventTypeTable(EVENT_TYPE_TABLE_INIT_SIZE); + + m_next = sm_first; + if (m_next) + m_next->m_previous = this; + sm_first = this; +} + +wxEventHashTable::~wxEventHashTable() +{ + if (m_next) + m_next->m_previous = m_previous; + if (m_previous) + m_previous->m_next = m_next; + if (sm_first == this) + sm_first = m_next; + + Clear(); +} + +void wxEventHashTable::Clear() +{ + for ( size_t i = 0; i < m_size; i++ ) + { + EventTypeTablePointer eTTnode = m_eventTypeTable[i]; + delete eTTnode; + } + + delete[] m_eventTypeTable; + m_eventTypeTable = NULL; + + m_size = 0; +} + +#if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING + +// Clear all tables +void wxEventHashTable::ClearAll() +{ + wxEventHashTable* table = sm_first; + while (table) + { + table->Clear(); + table = table->m_next; + } +} + +#endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING + +bool wxEventHashTable::HandleEvent(wxEvent &event, wxEvtHandler *self) +{ + if (m_rebuildHash) + { + InitHashTable(); + m_rebuildHash = false; + } + + if (!m_eventTypeTable) + return false; + + // Find all entries for the given event type. + wxEventType eventType = event.GetEventType(); + const EventTypeTablePointer eTTnode = m_eventTypeTable[eventType % m_size]; + if (eTTnode && eTTnode->eventType == eventType) + { + // Now start the search for an event handler + // that can handle an event with the given ID. + const wxEventTableEntryPointerArray& + eventEntryTable = eTTnode->eventEntryTable; + + const size_t count = eventEntryTable.GetCount(); + for (size_t n = 0; n < count; n++) + { + if ( wxEvtHandler:: + ProcessEventIfMatches(*eventEntryTable[n], self, event) ) + { + return true; + } + } + } + + return false; +} + +void wxEventHashTable::InitHashTable() +{ + // Loop over the event tables and all its base tables. + const wxEventTable *table = &m_table; + while (table) + { + // Retrieve all valid event handler entries + const wxEventTableEntry *entry = table->entries; + while (entry->m_fn != 0) + { + // Add the event entry in the Hash. + AddEntry(*entry); + + entry++; + } + + table = table->baseTable; + } + + // Lets free some memory. + size_t i; + for(i = 0; i < m_size; i++) + { + EventTypeTablePointer eTTnode = m_eventTypeTable[i]; + if (eTTnode) + { + eTTnode->eventEntryTable.Shrink(); + } + } +} + +void wxEventHashTable::AddEntry(const wxEventTableEntry &entry) +{ + // This might happen 'accidentally' as the app is exiting + if (!m_eventTypeTable) + return; + + EventTypeTablePointer *peTTnode = &m_eventTypeTable[entry.m_eventType % m_size]; + EventTypeTablePointer eTTnode = *peTTnode; + + if (eTTnode) + { + if (eTTnode->eventType != entry.m_eventType) + { + // Resize the table! + GrowEventTypeTable(); + // Try again to add it. + AddEntry(entry); + return; + } + } + else + { + eTTnode = new EventTypeTable; + eTTnode->eventType = entry.m_eventType; + *peTTnode = eTTnode; + } + + // Fill all hash entries between entry.m_id and entry.m_lastId... + eTTnode->eventEntryTable.Add(&entry); +} + +void wxEventHashTable::AllocEventTypeTable(size_t size) +{ + m_eventTypeTable = new EventTypeTablePointer[size]; + memset((void *)m_eventTypeTable, 0, sizeof(EventTypeTablePointer)*size); + m_size = size; +} + +void wxEventHashTable::GrowEventTypeTable() +{ + size_t oldSize = m_size; + EventTypeTablePointer *oldEventTypeTable = m_eventTypeTable; + + // TODO: Search the most optimal grow sequence + AllocEventTypeTable(/* GetNextPrime(oldSize) */oldSize*2+1); + + for ( size_t i = 0; i < oldSize; /* */ ) + { + EventTypeTablePointer eTToldNode = oldEventTypeTable[i]; + if (eTToldNode) + { + EventTypeTablePointer *peTTnode = &m_eventTypeTable[eTToldNode->eventType % m_size]; + EventTypeTablePointer eTTnode = *peTTnode; + + // Check for collision, we don't want any. + if (eTTnode) + { + GrowEventTypeTable(); + continue; // Don't increment the counter, + // as we still need to add this element. + } + else + { + // Get the old value and put it in the new table. + *peTTnode = oldEventTypeTable[i]; + } + } + + i++; + } + + delete[] oldEventTypeTable; +} + +// ---------------------------------------------------------------------------- +// wxEvtHandler +// ---------------------------------------------------------------------------- + /* * Event handler */ wxEvtHandler::wxEvtHandler() { + m_beingDeleted = false; + m_nextHandler = (wxEvtHandler *) NULL; m_previousHandler = (wxEvtHandler *) NULL; - m_enabled = TRUE; + m_enabled = true; m_dynamicEvents = (wxList *) NULL; - m_isWindow = FALSE; -#if wxUSE_THREADS - m_eventsLocker = new wxCriticalSection(); -#endif m_pendingEvents = (wxList *) NULL; + + // no client data (yet) + m_clientData = NULL; + m_clientDataType = wxClientData_None; } wxEvtHandler::~wxEvtHandler() { + m_beingDeleted = true; + // Takes itself out of the list of handlers if (m_previousHandler) m_previousHandler->m_nextHandler = m_nextHandler; @@ -322,141 +1058,221 @@ wxEvtHandler::~wxEvtHandler() if (m_dynamicEvents) { - wxNode *node = m_dynamicEvents->First(); - while (node) + for ( wxList::iterator it = m_dynamicEvents->begin(), + end = m_dynamicEvents->end(); + it != end; + ++it ) { - wxEventTableEntry *entry = (wxEventTableEntry*)node->Data(); - if (entry->m_callbackUserData) delete entry->m_callbackUserData; + wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)*it; + + // Remove ourselves from sink destructor notifications + wxEvtHandler *eventSink = entry->m_eventSink; + if ( eventSink ) + { + wxEventConnectionRef * const + evtConnRef = FindRefInTrackerList(eventSink); + if ( evtConnRef ) + { + eventSink->RemoveNode(evtConnRef); + delete evtConnRef; + } + } + + if (entry->m_callbackUserData) + delete entry->m_callbackUserData; delete entry; - node = node->Next(); } delete m_dynamicEvents; }; -#if wxUSE_THREADS if (m_pendingEvents) - delete m_pendingEvents; + { + // At this time, we could still be used from other threads. + // Continue to use sync objects. + wxENTER_CRIT_SECT( m_pendingEventsLock ); + + m_pendingEvents->DeleteContents(true); + delete m_pendingEvents; + m_pendingEvents = NULL; + + wxLEAVE_CRIT_SECT( m_pendingEventsLock ); + } + + // Remove us from wxPendingEvents if necessary. + if ( wxPendingEvents ) + { +#if wxUSE_THREADS + if (wxPendingEventsLocker) + wxENTER_CRIT_SECT(*wxPendingEventsLocker); +#endif + + if ( wxPendingEvents->DeleteObject(this) ) + { + // check that we were present only once in the list + wxASSERT_MSG( !wxPendingEvents->Find(this), + "Handler occurs twice in wxPendingEvents list" ); + } + //else: we weren't in this list at all, it's ok - delete m_eventsLocker; +#if wxUSE_THREADS + if (wxPendingEventsLocker) + wxLEAVE_CRIT_SECT(*wxPendingEventsLocker); #endif + } + + // we only delete object data, not untyped + if ( m_clientDataType == wxClientData_Object ) + delete m_clientObject; } #if wxUSE_THREADS -bool wxEvtHandler::ProcessThreadEvent(wxEvent& event) -{ - wxEvent *event_main; - wxCriticalSectionLocker locker(*m_eventsLocker); +bool wxEvtHandler::ProcessThreadEvent(const wxEvent& event) +{ // check that we are really in a child thread - wxASSERT( !wxThread::IsMain() ); + wxASSERT_MSG( !wxThread::IsMain(), + wxT("use ProcessEvent() in main thread") ); - if (m_pendingEvents == NULL) - m_pendingEvents = new wxList(); + AddPendingEvent(event); - event_main = (wxEvent *)event.Clone(); + return true; +} + +#endif // wxUSE_THREADS + +void wxEvtHandler::QueueEvent(wxEvent *event) +{ + wxCHECK_RET( event, "NULL event can't be posted" ); + + // Catch the situation where destructor is already invoked (in another thread) + if( m_beingDeleted ) return; + + // 1) Add this event to our list of pending events + wxENTER_CRIT_SECT( m_pendingEventsLock ); + + if ( !m_pendingEvents ) + m_pendingEvents = new wxList; - m_pendingEvents->Append(event_main); + m_pendingEvents->Append(event); - wxPendingEventsLocker->Enter(); - wxPendingEvents->Append(this); - wxPendingEventsLocker->Leave(); + wxLEAVE_CRIT_SECT( m_pendingEventsLock ); - return TRUE; + // 2) Add this event handler to list of event handlers that + // have pending events. + + wxENTER_CRIT_SECT(*wxPendingEventsLocker); + + if ( !wxPendingEvents ) + wxPendingEvents = new wxList; + if ( !wxPendingEvents->Find(this) ) + wxPendingEvents->Append(this); + + wxLEAVE_CRIT_SECT(*wxPendingEventsLocker); + + // 3) Inform the system that new pending events are somewhere, + // and that these should be processed in idle time. + wxWakeUpIdle(); } void wxEvtHandler::ProcessPendingEvents() { - wxCriticalSectionLocker locker(*m_eventsLocker); - wxNode *node = m_pendingEvents->First(); - wxEvent *event; + wxENTER_CRIT_SECT( m_pendingEventsLock ); - while (node != NULL) { - event = (wxEvent *)node->Data(); - ProcessEvent(*event); - delete node; - node = m_pendingEvents->First(); + // This method is only called by wxApp if this handler does have + // pending events, but it happens occasionally when using multi- + // threading and we don't want a crash due to that. + if( !m_pendingEvents ) + { + wxLEAVE_CRIT_SECT( m_pendingEventsLock ); + return; + } + + if( m_pendingEvents->IsEmpty() ) + { + wxPendingEvents->DeleteObject(this); + wxLEAVE_CRIT_SECT( m_pendingEventsLock ); + return; } -} -#endif -/* - * Event table stuff - */ + wxList::compatibility_iterator node = m_pendingEvents->GetFirst(); + wxEventPtr event(wx_static_cast(wxEvent *, node->GetData())); -bool wxEvtHandler::ProcessEvent(wxEvent& event) -{ - // check that our flag corresponds to reality - wxASSERT( m_isWindow == IsKindOf(CLASSINFO(wxWindow)) ); + // it's important we remove event from list before processing it, else a + // nested event loop, for example from a modal dialog, might process the + // same event again. + m_pendingEvents->Erase(node); - // An event handler can be enabled or disabled - if ( GetEvtHandlerEnabled() ) + // if there are no more pending events left, we don't need to stay in this + // list + if ( m_pendingEvents->IsEmpty() ) { #if wxUSE_THREADS - // Check whether we are in a child thread. - if (!wxThread::IsMain()) - return ProcessThreadEvent(event); + if (wxPendingEventsLocker) + wxENTER_CRIT_SECT(*wxPendingEventsLocker); #endif - // Handle per-instance dynamic event tables first + wxPendingEvents->DeleteObject(this); +#if wxUSE_THREADS + if (wxPendingEventsLocker) + wxLEAVE_CRIT_SECT(*wxPendingEventsLocker); +#endif + } - if ( m_dynamicEvents && SearchDynamicEventTable(event) ) - return TRUE; + wxLEAVE_CRIT_SECT( m_pendingEventsLock ); - // Then static per-class event tables + ProcessEvent(*event); - const wxEventTable *table = GetEventTable(); - - // Try the associated validator first, if this is a window. - // Problem: if the event handler of the window has been replaced, - // this wxEvtHandler may no longer be a window. - // Therefore validators won't be processed if the handler - // has been replaced with SetEventHandler. - // THIS CAN BE CURED if PushEventHandler is used instead of - // SetEventHandler, and then processing will be passed down the - // chain of event handlers. - if ( m_isWindow ) - { - wxWindow *win = (wxWindow *)this; + // careful: this object could have been deleted by the event handler + // executed by the above ProcessEvent() call, so we can't access any fields + // of this object any more +} - // Can only use the validator of the window which - // is receiving the event - if ( win == event.GetEventObject() ) - { - wxValidator *validator = win->GetValidator(); - if ( validator && validator->ProcessEvent(event) ) - { - return TRUE; - } - } - } +/* + * Event table stuff + */ +/* static */ bool +wxEvtHandler::ProcessEventIfMatches(const wxEventTableEntryBase& entry, + wxEvtHandler *handler, + wxEvent& event) +{ + int tableId1 = entry.m_id, + tableId2 = entry.m_lastId; + + // match only if the event type is the same and the id is either -1 in + // the event table (meaning "any") or the event id matches the id + // specified in the event table either exactly or by falling into + // range between first and last + if ((tableId1 == wxID_ANY) || + (tableId2 == wxID_ANY && tableId1 == event.GetId()) || + (tableId2 != wxID_ANY && + (event.GetId() >= tableId1 && event.GetId() <= tableId2))) + { + event.Skip(false); + event.m_callbackUserData = entry.m_callbackUserData; - // Search upwards through the inheritance hierarchy - while ( table ) +#if wxUSE_EXCEPTIONS + if ( wxTheApp ) { - if ( SearchEventTable((wxEventTable&)*table, event) ) - return TRUE; - table = table->baseTable; + // call the handler via wxApp method which allows the user to catch + // any exceptions which may be thrown by any handler in the program + // in one place + wxTheApp->HandleEvent(handler, (wxEventFunction)entry.m_fn, event); + } + else +#endif // wxUSE_EXCEPTIONS + { + // no need for an extra virtual function call + (handler->*((wxEventFunction) (entry.m_fn)))(event); } - } - // Try going down the event handler chain - if ( GetNextHandler() ) - { - if ( GetNextHandler()->ProcessEvent(event) ) - return TRUE; + if (!event.GetSkipped()) + return true; } - // Carry on up the parent-child hierarchy, - // but only if event is a command event: it wouldn't - // make sense for a parent to receive a child's size event, for example - if ( m_isWindow && event.IsCommandEvent() ) - { - wxWindow *win = (wxWindow *)this; - wxWindow *parent = win->GetParent(); - if (parent && !parent->IsBeingDeleted()) - return parent->GetEventHandler()->ProcessEvent(event); - } + return false; +} - // Last try - application object. +bool wxEvtHandler::TryParent(wxEvent& event) +{ if ( wxTheApp && (this != wxTheApp) ) { // Special case: don't pass wxEVT_IDLE to wxApp, since it'll always @@ -465,110 +1281,288 @@ bool wxEvtHandler::ProcessEvent(wxEvent& event) if ( event.GetEventType() != wxEVT_IDLE ) { if ( wxTheApp->ProcessEvent(event) ) - return TRUE; + return true; } } - return FALSE; + return false; } -bool wxEvtHandler::SearchEventTable(wxEventTable& table, wxEvent& event) +bool wxEvtHandler::ProcessEvent(wxEvent& event) { - int i = 0; - int commandId = event.GetId(); + // allow the application to hook into event processing + if ( wxTheApp ) + { + int rc = wxTheApp->FilterEvent(event); + if ( rc != -1 ) + { + wxASSERT_MSG( rc == 1 || rc == 0, + _T("unexpected wxApp::FilterEvent return value") ); - // BC++ doesn't like while (table.entries[i].m_fn) + return rc != 0; + } + //else: proceed normally + } -#ifdef __SC__ - while (table.entries[i].m_fn != 0) -#else - while (table.entries[i].m_fn != 0L) + // An event handler can be enabled or disabled + if ( GetEvtHandlerEnabled() ) + { + // if we have a validator, it has higher priority than our own event + // table + if ( TryValidator(event) ) + return true; + + // Handle per-instance dynamic event tables first + if ( m_dynamicEvents && SearchDynamicEventTable(event) ) + return true; + + // Then static per-class event tables + if ( GetEventHashTable().HandleEvent(event, this) ) + return true; + } + + // Try going down the event handler chain + if ( GetNextHandler() ) + { + // notice that we shouldn't let the parent have the event even if the + // next handler does not process it because it will have already passed + // it to the parent in this case + return GetNextHandler()->ProcessEvent(event); + } + + // Finally propagate the event upwards the window chain and/or to the + // application object as necessary + return TryParent(event); +} + +bool wxEvtHandler::SafelyProcessEvent(wxEvent& event) +{ +#if wxUSE_EXCEPTIONS + try + { #endif + return ProcessEvent(event); +#if wxUSE_EXCEPTIONS + } + catch ( ... ) { - if ((event.GetEventType() == table.entries[i].m_eventType) && - (table.entries[i].m_id == -1 || // Match, if event spec says any id will do (id == -1) - (table.entries[i].m_lastId == -1 && commandId == table.entries[i].m_id) || - (table.entries[i].m_lastId != -1 && - (commandId >= table.entries[i].m_id && commandId <= table.entries[i].m_lastId)))) + wxEventLoopBase *loop = wxEventLoopBase::GetActive(); + try { - event.Skip(FALSE); - event.m_callbackUserData = table.entries[i].m_callbackUserData; + if ( !wxTheApp || !wxTheApp->OnExceptionInMainLoop() ) + { + if ( loop ) + loop->Exit(); + } + //else: continue running current event loop - (this->*((wxEventFunction) (table.entries[i].m_fn)))(event); + return false; + } + catch ( ... ) + { + // OnExceptionInMainLoop() threw, possibly rethrowing the same + // exception again: very good, but we still need Exit() to + // be called + if ( loop ) + loop->Exit(); + throw; + } + } +#endif // wxUSE_EXCEPTIONS +} - if ( event.GetSkipped() ) - return FALSE; - else - return TRUE; + +bool wxEvtHandler::SearchEventTable(wxEventTable& table, wxEvent& event) +{ + const wxEventType eventType = event.GetEventType(); + for ( int i = 0; table.entries[i].m_fn != 0; i++ ) + { + const wxEventTableEntry& entry = table.entries[i]; + if ( eventType == entry.m_eventType ) + { + if ( ProcessEventIfMatches(entry, this, event) ) + return true; } - i++; } - return FALSE; + + return false; } + void wxEvtHandler::Connect( int id, int lastId, - wxEventType eventType, + int eventType, wxObjectEventFunction func, - wxObject *userData ) + wxObject *userData, + wxEvtHandler* eventSink ) { - wxEventTableEntry *entry = new wxEventTableEntry; - entry->m_id = id; - entry->m_lastId = lastId; - entry->m_eventType = eventType; - entry->m_fn = func; - entry->m_callbackUserData = userData; + wxDynamicEventTableEntry *entry = + new wxDynamicEventTableEntry(eventType, id, lastId, func, userData, eventSink); if (!m_dynamicEvents) m_dynamicEvents = new wxList; - m_dynamicEvents->Append( (wxObject*) entry ); + // Insert at the front of the list so most recent additions are found first + m_dynamicEvents->Insert( (wxObject*) entry ); + + // Make sure we get to know when a sink is destroyed + if ( eventSink && eventSink != this ) + { + wxEventConnectionRef *evtConnRef = FindRefInTrackerList(eventSink); + if ( evtConnRef ) + evtConnRef->IncRef( ); + else + evtConnRef = new wxEventConnectionRef(this, eventSink); + } } -bool wxEvtHandler::SearchDynamicEventTable( wxEvent& event ) +bool wxEvtHandler::Disconnect( int id, int lastId, wxEventType eventType, + wxObjectEventFunction func, + wxObject *userData, + wxEvtHandler* eventSink ) { - wxCHECK_MSG( m_dynamicEvents, FALSE, - _T("caller should check that we have dynamic events") ); + if (!m_dynamicEvents) + return false; - int commandId = event.GetId(); + // Remove connection from tracker node (wxEventConnectionRef) + if ( eventSink && eventSink != this ) + { + wxEventConnectionRef *evtConnRef = FindRefInTrackerList(eventSink); + if ( evtConnRef ) + evtConnRef->DecRef(); + } - wxNode *node = m_dynamicEvents->First(); + wxList::compatibility_iterator node = m_dynamicEvents->GetFirst(); while (node) { - wxEventTableEntry *entry = (wxEventTableEntry*)node->Data(); + wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData(); + + if ((entry->m_id == id) && + ((entry->m_lastId == lastId) || (lastId == wxID_ANY)) && + ((entry->m_eventType == eventType) || (eventType == wxEVT_NULL)) && + ((entry->m_fn == func) || (func == (wxObjectEventFunction)NULL)) && + ((entry->m_eventSink == eventSink) || (eventSink == (wxEvtHandler*)NULL)) && + ((entry->m_callbackUserData == userData) || (userData == (wxObject*)NULL))) + { + if (entry->m_callbackUserData) + delete entry->m_callbackUserData; + m_dynamicEvents->Erase( node ); + delete entry; + return true; + } + node = node->GetNext(); + } + return false; +} - if (entry->m_fn) +bool wxEvtHandler::SearchDynamicEventTable( wxEvent& event ) +{ + wxCHECK_MSG( m_dynamicEvents, false, + wxT("caller should check that we have dynamic events") ); + + wxList::compatibility_iterator node = m_dynamicEvents->GetFirst(); + while (node) + { + wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData(); + + // get next node before (maybe) calling the event handler as it could + // call Disconnect() invalidating the current node + node = node->GetNext(); + + if ((event.GetEventType() == entry->m_eventType) && (entry->m_fn != 0)) { - // Match, if event spec says any id will do (id == -1) - if ( (event.GetEventType() == entry->m_eventType) && - (entry->m_id == -1 || - (entry->m_lastId == -1 && commandId == entry->m_id) || - (entry->m_lastId != -1 && - (commandId >= entry->m_id && commandId <= entry->m_lastId))) ) - { - event.Skip(FALSE); - event.m_callbackUserData = entry->m_callbackUserData; + wxEvtHandler *handler = entry->m_eventSink ? entry->m_eventSink + : this; + if ( ProcessEventIfMatches(*entry, handler, event) ) + return true; + } + } - (this->*((wxEventFunction) (entry->m_fn)))(event); + return false; +} - if (event.GetSkipped()) - return FALSE; - else - return TRUE; - } +void wxEvtHandler::DoSetClientObject( wxClientData *data ) +{ + wxASSERT_MSG( m_clientDataType != wxClientData_Void, + wxT("can't have both object and void client data") ); + + if ( m_clientObject ) + delete m_clientObject; + + m_clientObject = data; + m_clientDataType = wxClientData_Object; +} + +wxClientData *wxEvtHandler::DoGetClientObject() const +{ + // it's not an error to call GetClientObject() on a window which doesn't + // have client data at all - NULL will be returned + wxASSERT_MSG( m_clientDataType != wxClientData_Void, + wxT("this window doesn't have object client data") ); + + return m_clientObject; +} + +void wxEvtHandler::DoSetClientData( void *data ) +{ + wxASSERT_MSG( m_clientDataType != wxClientData_Object, + wxT("can't have both object and void client data") ); + + m_clientData = data; + m_clientDataType = wxClientData_Void; +} + +void *wxEvtHandler::DoGetClientData() const +{ + // it's not an error to call GetClientData() on a window which doesn't have + // client data at all - NULL will be returned + wxASSERT_MSG( m_clientDataType != wxClientData_Object, + wxT("this window doesn't have void client data") ); + + return m_clientData; +} + +// A helper to find an wxEventConnectionRef object +wxEventConnectionRef * +wxEvtHandler::FindRefInTrackerList(wxEvtHandler *eventSink) +{ + for ( wxTrackerNode *node = eventSink->GetFirst(); node; node = node->m_nxt ) + { + // we only want wxEventConnectionRef nodes here + wxEventConnectionRef *evtConnRef = node->ToEventConnection(); + if ( evtConnRef && evtConnRef->m_src == this ) + { + wxASSERT( evtConnRef->m_sink==eventSink ); + return evtConnRef; } - node = node->Next(); } - return FALSE; -}; -#if WXWIN_COMPATIBILITY -bool wxEvtHandler::OnClose() + return NULL; +} + +void wxEvtHandler::OnSinkDestroyed( wxEvtHandler *sink ) { - if (GetNextHandler()) - return GetNextHandler()->OnClose(); - else - return FALSE; + wxASSERT(m_dynamicEvents); + + // remove all connections with this sink + wxList::compatibility_iterator node = m_dynamicEvents->GetFirst(), node_nxt; + while (node) + { + wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData(); + node_nxt = node->GetNext(); + + if ( entry->m_eventSink==sink ) + { + if (entry->m_callbackUserData) + delete entry->m_callbackUserData; + m_dynamicEvents->Erase( node ); + delete entry; + } + node = node_nxt; + } } -#endif // WXWIN_COMPATIBILITY + +#endif // wxUSE_BASE + +#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. @@ -593,3 +1587,38 @@ wxWindow* wxFindFocusDescendant(wxWindow* ancestor) return focusWin; } +// ---------------------------------------------------------------------------- +// wxEventBlocker +// ---------------------------------------------------------------------------- + +wxEventBlocker::wxEventBlocker(wxWindow *win, wxEventType type) +{ + wxCHECK_RET(win, wxT("Null window given to wxEventBlocker")); + + m_window = win; + + Block(type); + m_window->PushEventHandler(this); +} + +wxEventBlocker::~wxEventBlocker() +{ + wxEvtHandler *popped = m_window->PopEventHandler(false); + wxCHECK_RET(popped == this, + wxT("Don't push other event handlers into a window managed by wxEventBlocker!")); +} + +bool wxEventBlocker::ProcessEvent(wxEvent& event) +{ + // should this event be blocked? + for ( size_t i = 0; i < m_eventsToBlock.size(); i++ ) + { + wxEventType t = (wxEventType)m_eventsToBlock[i]; + if ( t == wxEVT_ANY || t == event.GetEventType() ) + return true; // yes, it should: mark this event as processed + } + + return false; +} + +#endif // wxUSE_GUI