X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4f742042b85eabf8509d00eaa9393ade37396310..11bf9fea53d75b460aaa4028a591917b6dd6fe54:/src/common/event.cpp diff --git a/src/common/event.cpp b/src/common/event.cpp index 4dd9eaeaa4..c9e8f11bca 100644 --- a/src/common/event.cpp +++ b/src/common/event.cpp @@ -25,6 +25,7 @@ #endif #include "wx/event.h" +#include "wx/eventfilter.h" #include "wx/evtloop.h" #ifndef WX_PRECOMP @@ -62,11 +63,11 @@ IMPLEMENT_DYNAMIC_CLASS(wxEvtHandler, wxObject) IMPLEMENT_ABSTRACT_CLASS(wxEvent, wxObject) IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent, wxEvent) + IMPLEMENT_DYNAMIC_CLASS(wxThreadEvent, wxEvent) #endif // wxUSE_BASE #if wxUSE_GUI IMPLEMENT_DYNAMIC_CLASS(wxCommandEvent, wxEvent) - IMPLEMENT_DYNAMIC_CLASS(wxThreadEvent, wxCommandEvent) IMPLEMENT_DYNAMIC_CLASS(wxNotifyEvent, wxCommandEvent) IMPLEMENT_DYNAMIC_CLASS(wxScrollEvent, wxCommandEvent) IMPLEMENT_DYNAMIC_CLASS(wxScrollWinEvent, wxEvent) @@ -118,7 +119,7 @@ wxEventHashTable &wxEvtHandler::GetEventHashTable() const wxEventHashTable wxEvtHandler::sm_eventHashTable(wxEvtHandler::sm_eventTable); const wxEventTableEntry wxEvtHandler::sm_eventTableEntries[] = - { DECLARE_EVENT_TABLE_TERMINATOR() }; + { wxDECLARE_EVENT_TABLE_TERMINATOR() }; // wxUSE_MEMORY_TRACING considers memory freed from the static objects dtors @@ -151,34 +152,38 @@ IMPLEMENT_DYNAMIC_CLASS(wxEventTableEntryModule, wxModule) const wxEventType wxEVT_FIRST = 10000; const wxEventType wxEVT_USER_FIRST = wxEVT_FIRST + 2000; +const wxEventType wxEVT_NULL = wxNewEventType(); -DEFINE_EVENT_TYPE(wxEVT_NULL) wxDEFINE_EVENT( wxEVT_IDLE, wxIdleEvent ); +// Thread and asynchronous call events +wxDEFINE_EVENT( wxEVT_THREAD, wxThreadEvent ); +wxDEFINE_EVENT( wxEVT_ASYNC_METHOD_CALL, wxAsyncMethodCallEvent ); + #endif // wxUSE_BASE #if wxUSE_GUI -wxDEFINE_EVENT( wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEvent ); -wxDEFINE_EVENT( wxEVT_COMMAND_CHECKBOX_CLICKED, wxCommandEvent ); -wxDEFINE_EVENT( wxEVT_COMMAND_CHOICE_SELECTED, wxCommandEvent ); -wxDEFINE_EVENT( wxEVT_COMMAND_LISTBOX_SELECTED, wxCommandEvent ); -wxDEFINE_EVENT( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, wxCommandEvent ); -wxDEFINE_EVENT( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, wxCommandEvent ); -wxDEFINE_EVENT( wxEVT_COMMAND_MENU_SELECTED, wxCommandEvent ); -wxDEFINE_EVENT( wxEVT_COMMAND_SLIDER_UPDATED, wxCommandEvent ); -wxDEFINE_EVENT( wxEVT_COMMAND_RADIOBOX_SELECTED, wxCommandEvent ); -wxDEFINE_EVENT( wxEVT_COMMAND_RADIOBUTTON_SELECTED, wxCommandEvent ); -wxDEFINE_EVENT( wxEVT_COMMAND_SCROLLBAR_UPDATED, wxCommandEvent ); -wxDEFINE_EVENT( wxEVT_COMMAND_VLBOX_SELECTED, wxCommandEvent ); -wxDEFINE_EVENT( wxEVT_COMMAND_COMBOBOX_SELECTED, wxCommandEvent ); -wxDEFINE_EVENT( wxEVT_COMMAND_TOOL_RCLICKED, wxCommandEvent ); -wxDEFINE_EVENT( wxEVT_COMMAND_TOOL_ENTER, wxCommandEvent ); -wxDEFINE_EVENT( wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEvent ); -wxDEFINE_EVENT( wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED, wxCommandEvent ); -wxDEFINE_EVENT( wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, wxCommandEvent ); -wxDEFINE_EVENT( wxEVT_COMMAND_COMBOBOX_DROPDOWN, wxCommandEvent); -wxDEFINE_EVENT( wxEVT_COMMAND_COMBOBOX_CLOSEUP, wxCommandEvent); +wxDEFINE_EVENT( wxEVT_BUTTON, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_CHECKBOX, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_CHOICE, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_LISTBOX, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_LISTBOX_DCLICK, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_CHECKLISTBOX, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_MENU, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_SLIDER, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_RADIOBOX, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_RADIOBUTTON, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_SCROLLBAR, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_VLBOX, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_COMBOBOX, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_TOOL_RCLICKED, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_TOOL_ENTER, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_SPINCTRL, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_SPINCTRLDOUBLE, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_TOOL_DROPDOWN, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_COMBOBOX_DROPDOWN, wxCommandEvent); +wxDEFINE_EVENT( wxEVT_COMBOBOX_CLOSEUP, wxCommandEvent); // Mouse event types wxDEFINE_EVENT( wxEVT_LEFT_DOWN, wxMouseEvent ); @@ -206,6 +211,7 @@ wxDEFINE_EVENT( wxEVT_AUX2_DCLICK, wxMouseEvent ); // Character input event type wxDEFINE_EVENT( wxEVT_CHAR, wxKeyEvent ); +wxDEFINE_EVENT( wxEVT_AFTER_CHAR, wxKeyEvent ); wxDEFINE_EVENT( wxEVT_CHAR_HOOK, wxKeyEvent ); wxDEFINE_EVENT( wxEVT_NAVIGATION_KEY, wxNavigationKeyEvent ); wxDEFINE_EVENT( wxEVT_KEY_DOWN, wxKeyEvent ); @@ -293,9 +299,9 @@ wxDEFINE_EVENT( wxEVT_INIT_DIALOG, wxInitDialogEvent ); wxDEFINE_EVENT( wxEVT_UPDATE_UI, wxUpdateUIEvent ); // Clipboard events -wxDEFINE_EVENT( wxEVT_COMMAND_TEXT_COPY, wxClipboardTextEvent ); -wxDEFINE_EVENT( wxEVT_COMMAND_TEXT_CUT, wxClipboardTextEvent ); -wxDEFINE_EVENT( wxEVT_COMMAND_TEXT_PASTE, wxClipboardTextEvent ); +wxDEFINE_EVENT( wxEVT_TEXT_COPY, wxClipboardTextEvent ); +wxDEFINE_EVENT( wxEVT_TEXT_CUT, wxClipboardTextEvent ); +wxDEFINE_EVENT( wxEVT_TEXT_PASTE, wxClipboardTextEvent ); // Generic command events // Note: a click is a higher-level event than button down/up @@ -311,9 +317,6 @@ wxDEFINE_EVENT( wxEVT_COMMAND_ENTER, wxCommandEvent ); wxDEFINE_EVENT( wxEVT_HELP, wxHelpEvent ); wxDEFINE_EVENT( wxEVT_DETAILED_HELP, wxHelpEvent ); -// Thread event -wxDEFINE_EVENT( wxEVT_COMMAND_THREAD, wxThreadEvent ); - #endif // wxUSE_GUI #if wxUSE_BASE @@ -363,9 +366,12 @@ wxEvent::wxEvent(int theId, wxEventType commandType) m_id = theId; m_skipped = false; m_callbackUserData = NULL; + m_handlerToProcessOnlyIn = NULL; m_isCommandEvent = false; m_propagationLevel = wxEVENT_PROPAGATE_NONE; + m_propagatedFrom = NULL; m_wasProcessed = false; + m_willBeProcessedAgain = false; } wxEvent::wxEvent(const wxEvent& src) @@ -375,10 +381,13 @@ wxEvent::wxEvent(const wxEvent& src) , m_timeStamp(src.m_timeStamp) , m_id(src.m_id) , m_callbackUserData(src.m_callbackUserData) + , m_handlerToProcessOnlyIn(NULL) , m_propagationLevel(src.m_propagationLevel) + , m_propagatedFrom(NULL) , m_skipped(src.m_skipped) , m_isCommandEvent(src.m_isCommandEvent) , m_wasProcessed(false) + , m_willBeProcessedAgain(false) { } @@ -391,12 +400,18 @@ wxEvent& wxEvent::operator=(const wxEvent& src) m_timeStamp = src.m_timeStamp; m_id = src.m_id; m_callbackUserData = src.m_callbackUserData; + m_handlerToProcessOnlyIn = NULL; m_propagationLevel = src.m_propagationLevel; + m_propagatedFrom = NULL; m_skipped = src.m_skipped; m_isCommandEvent = src.m_isCommandEvent; // don't change m_wasProcessed + // While the original again could be passed to another handler, this one + // isn't going to be processed anywhere else by default. + m_willBeProcessedAgain = false; + return *this; } @@ -408,31 +423,20 @@ wxEvent& wxEvent::operator=(const wxEvent& src) // wxCommandEvent // ---------------------------------------------------------------------------- -#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_clientData = NULL; m_clientObject = NULL; - m_extraLong = 0; - m_commandInt = 0; 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) + if (m_eventType != wxEVT_TEXT || !m_eventObject) { return m_cmdString; } @@ -470,6 +474,13 @@ bool wxUpdateUIEvent::CanUpdate(wxWindowBase *win) ((win->GetExtraStyle() & wxWS_EX_PROCESS_UI_UPDATES) == 0))) return false; + // Don't update children of the hidden windows: this is useless as any + // change to their state won't be seen by the user anyhow. Notice that this + // argument doesn't apply to the hidden windows (with visible parent) + // themselves as they could be shown by their EVT_UPDATE_UI handler. + if ( win->GetParent() && !win->GetParent()->IsShownOnScreen() ) + return false; + if (sm_updateInterval == -1) return false; @@ -553,10 +564,11 @@ wxMouseEvent::wxMouseEvent(wxEventType commandType) m_clickCount = -1; + m_wheelAxis = wxMOUSE_WHEEL_VERTICAL; m_wheelRotation = 0; m_wheelDelta = 0; m_linesPerAction = 0; - m_wheelAxis = 0; + m_columnsPerAction = 0; } void wxMouseEvent::Assign(const wxMouseEvent& event) @@ -579,6 +591,7 @@ void wxMouseEvent::Assign(const wxMouseEvent& event) m_wheelRotation = event.m_wheelRotation; m_wheelDelta = event.m_wheelDelta; m_linesPerAction = event.m_linesPerAction; + m_columnsPerAction = event.m_columnsPerAction; m_wheelAxis = event.m_wheelAxis; } @@ -730,26 +743,72 @@ wxPoint wxMouseEvent::GetLogicalPosition(const wxDC& dc) const wxKeyEvent::wxKeyEvent(wxEventType type) { m_eventType = type; - m_keyCode = 0; + m_keyCode = WXK_NONE; #if wxUSE_UNICODE - m_uniChar = 0; + m_uniChar = WXK_NONE; #endif + + m_x = + m_y = wxDefaultCoord; + m_hasPosition = false; + + InitPropagation(); } wxKeyEvent::wxKeyEvent(const wxKeyEvent& evt) : wxEvent(evt), wxKeyboardState(evt) { - m_x = evt.m_x; - m_y = evt.m_y; + DoAssignMembers(evt); - m_keyCode = evt.m_keyCode; - m_rawCode = evt.m_rawCode; - m_rawFlags = evt.m_rawFlags; + InitPropagation(); +} -#if wxUSE_UNICODE - m_uniChar = evt.m_uniChar; -#endif +wxKeyEvent::wxKeyEvent(wxEventType eventType, const wxKeyEvent& evt) + : wxEvent(evt), + wxKeyboardState(evt) +{ + DoAssignMembers(evt); + + m_eventType = eventType; + + InitPropagation(); +} + +void wxKeyEvent::InitPositionIfNecessary() const +{ + if ( m_hasPosition ) + return; + + // We're const because we're called from const Get[XY]() methods but we + // need to update the "cached" values. + wxKeyEvent& self = const_cast(*this); + self.m_hasPosition = true; + + // The only position we can possibly associate with the keyboard event on + // the platforms where it doesn't carry it already is the mouse position. + wxGetMousePosition(&self.m_x, &self.m_y); + + // If this event is associated with a window, the position should be in its + // client coordinates, but otherwise leave it in screen coordinates as what + // else can we use? + wxWindow* const win = wxDynamicCast(GetEventObject(), wxWindow); + if ( win ) + win->ScreenToClient(&self.m_x, &self.m_y); +} + +wxCoord wxKeyEvent::GetX() const +{ + InitPositionIfNecessary(); + + return m_x; +} + +wxCoord wxKeyEvent::GetY() const +{ + InitPositionIfNecessary(); + + return m_y; } bool wxKeyEvent::IsKeyInCategory(int category) const @@ -884,8 +943,7 @@ void wxEventHashTable::Clear() delete eTTnode; } - delete[] m_eventTypeTable; - m_eventTypeTable = NULL; + wxDELETEA(m_eventTypeTable); m_size = 0; } @@ -957,7 +1015,7 @@ void wxEventHashTable::InitHashTable() table = table->baseTable; } - // Lets free some memory. + // Let's free some memory. size_t i; for(i = 0; i < m_size; i++) { @@ -1124,6 +1182,45 @@ bool wxEvtHandler::IsUnlinked() const m_nextHandler == NULL; } +wxEventFilter* wxEvtHandler::ms_filterList = NULL; + +/* static */ void wxEvtHandler::AddFilter(wxEventFilter* filter) +{ + wxCHECK_RET( filter, "NULL filter" ); + + filter->m_next = ms_filterList; + ms_filterList = filter; +} + +/* static */ void wxEvtHandler::RemoveFilter(wxEventFilter* filter) +{ + wxEventFilter* prev = NULL; + for ( wxEventFilter* f = ms_filterList; f; f = f->m_next ) + { + if ( f == filter ) + { + // Set the previous list element or the list head to the next + // element. + if ( prev ) + prev->m_next = f->m_next; + else + ms_filterList = f->m_next; + + // Also reset the next pointer in the filter itself just to avoid + // having possibly dangling pointers, even though it's not strictly + // necessary. + f->m_next = NULL; + + // Skip the assert below. + return; + } + + prev = f; + } + + wxFAIL_MSG( "Filter not found" ); +} + #if wxUSE_THREADS bool wxEvtHandler::ProcessThreadEvent(const wxEvent& event) @@ -1330,6 +1427,24 @@ bool wxEvtHandler::TryBefore(wxEvent& event) bool wxEvtHandler::TryAfter(wxEvent& event) { + // We only want to pass the window to the application object once even if + // there are several chained handlers. Ensure that this is what happens by + // only calling DoTryApp() if there is no next handler (which would do it). + // + // Notice that, unlike simply calling TryAfter() on the last handler in the + // chain only from ProcessEvent(), this also works with wxWindow object in + // the middle of the chain: its overridden TryAfter() will still be called + // and propagate the event upwards the window hierarchy even if it's not + // the last one in the chain (which, admittedly, shouldn't happen often). + if ( GetNextHandler() ) + return GetNextHandler()->TryAfter(event); + + // If this event is going to be processed in another handler next, don't + // pass it to wxTheApp now, it will be done from TryAfter() of this other + // handler. + if ( event.WillBeProcessedAgain() ) + return false; + #if WXWIN_COMPATIBILITY_2_8 // as above, call the old virtual function for compatibility return TryParent(event); @@ -1340,51 +1455,125 @@ bool wxEvtHandler::TryAfter(wxEvent& event) bool wxEvtHandler::ProcessEvent(wxEvent& event) { - // allow the application to hook into event processing + // The very first thing we do is to allow any registered filters to hook + // into event processing in order to globally pre-process all events. // - // note that we should only do it if we're the first event handler called + // Note that we should only do it if we're the first event handler called // to avoid calling FilterEvent() multiple times as the event goes through - // the event handler chain and possibly upwards the window hierarchy + // the event handler chain and possibly upwards the window hierarchy. if ( !event.WasProcessed() ) { - if ( wxTheApp ) + for ( wxEventFilter* f = ms_filterList; f; f = f->m_next ) { - int rc = wxTheApp->FilterEvent(event); - if ( rc != -1 ) + int rc = f->FilterEvent(event); + if ( rc != wxEventFilter::Event_Skip ) { - wxASSERT_MSG( rc == 1 || rc == 0, - "unexpected wxApp::FilterEvent return value" ); + wxASSERT_MSG( rc == wxEventFilter::Event_Ignore || + rc == wxEventFilter::Event_Processed, + "unexpected FilterEvent() return value" ); - return rc != 0; + return rc != wxEventFilter::Event_Ignore; } //else: proceed normally } } - if ( ProcessEventHere(event) ) + // Short circuit the event processing logic if we're requested to process + // this event in this handler only, see DoTryChain() for more details. + if ( event.ShouldProcessOnlyIn(this) ) + return TryBeforeAndHere(event); + + + // Try to process the event in this handler itself. + if ( ProcessEventLocally(event) ) + { + // It is possible that DoTryChain() called from ProcessEventLocally() + // returned true but the event was not really processed: this happens + // if a custom handler ignores the request to process the event in this + // handler only and in this case we should skip the post processing + // done in TryAfter() but still return the correct value ourselves to + // indicate whether we did or did not find a handler for this event. + return !event.GetSkipped(); + } + + // If we still didn't find a handler, propagate the event upwards the + // window chain and/or to the application object. + if ( TryAfter(event) ) return true; - // pass the event to the next handler, notice that we shouldn't call - // TryAfter() even if it doesn't handle the event as the last handler in - // the chain will do it - if ( GetNextHandler() ) - return GetNextHandler()->ProcessEvent(event); - // propagate the event upwards the window chain and/or to the application - // object if it wasn't processed at this level - return TryAfter(event); + // No handler found anywhere, bail out. + return false; +} + +bool wxEvtHandler::ProcessEventLocally(wxEvent& event) +{ + // Try the hooks which should be called before our own handlers and this + // handler itself first. Notice that we should not call ProcessEvent() on + // this one as we're already called from it, which explains why we do it + // here and not in DoTryChain() + return TryBeforeAndHere(event) || DoTryChain(event); +} + +bool wxEvtHandler::DoTryChain(wxEvent& event) +{ + for ( wxEvtHandler *h = GetNextHandler(); h; h = h->GetNextHandler() ) + { + // We need to process this event at the level of this handler only + // right now, the pre-/post-processing was either already done by + // ProcessEvent() from which we were called or will be done by it when + // we return. + // + // However we must call ProcessEvent() and not TryHereOnly() because the + // existing code (including some in wxWidgets itself) expects the + // overridden ProcessEvent() in its custom event handlers pushed on a + // window to be called. + // + // So we must call ProcessEvent() but it must not do what it usually + // does. To resolve this paradox we set up a special flag inside the + // object itself to let ProcessEvent() know that it shouldn't do any + // pre/post-processing for this event if it gets it. Note that this + // only applies to this handler, if the event is passed to another one + // by explicitly calling its ProcessEvent(), pre/post-processing should + // be done as usual. + // + // Final complication is that if the implementation of ProcessEvent() + // called wxEvent::DidntHonourProcessOnlyIn() (as the gross hack that + // is wxScrollHelperEvtHandler::ProcessEvent() does) and ignored our + // request to process event in this handler only, we have to compensate + // for it by not processing the event further because this was already + // done by that rogue event handler. + wxEventProcessInHandlerOnly processInHandlerOnly(event, h); + if ( h->ProcessEvent(event) ) + { + // Make sure "skipped" flag is not set as the event was really + // processed in this case. Normally it shouldn't be set anyhow but + // make sure just in case the user code does something strange. + event.Skip(false); + + return true; + } + + if ( !event.ShouldProcessOnlyIn(h) ) + { + // Still return true to indicate that no further processing should + // be undertaken but ensure that "skipped" flag is set so that the + // caller knows that the event was not really processed. + event.Skip(); + + return true; + } + } + + return false; } -bool wxEvtHandler::ProcessEventHere(wxEvent& event) +bool wxEvtHandler::TryHereOnly(wxEvent& event) { // If the event handler is disabled it doesn't process any events if ( !GetEvtHandlerEnabled() ) return false; - // Try the hooks which should be called before our own handlers - if ( TryBefore(event) ) - return true; - // Handle per-instance dynamic event tables first if ( m_dynamicEvents && SearchDynamicEventTable(event) ) return true; @@ -1393,6 +1582,17 @@ bool wxEvtHandler::ProcessEventHere(wxEvent& event) if ( GetEventHashTable().HandleEvent(event, this) ) return true; +#ifdef wxHAS_CALL_AFTER + // There is an implicit entry for async method calls processing in every + // event handler: + if ( event.GetEventType() == wxEVT_ASYNC_METHOD_CALL && + event.GetEventObject() == this ) + { + static_cast(event).Execute(); + return true; + } +#endif // wxHAS_CALL_AFTER + // We don't have a handler for this event. return false; } @@ -1492,15 +1692,6 @@ wxEvtHandler::DoUnbind(int id, if (!m_dynamicEvents) return false; - // Remove connection from tracker node (wxEventConnectionRef) - wxEvtHandler *eventSink = func.GetEvtHandler(); - if ( eventSink && eventSink != this ) - { - wxEventConnectionRef *evtConnRef = FindRefInTrackerList(eventSink); - if ( evtConnRef ) - evtConnRef->DecRef(); - } - wxList::compatibility_iterator node = m_dynamicEvents->GetFirst(); while (node) { @@ -1512,6 +1703,15 @@ wxEvtHandler::DoUnbind(int id, entry->m_fn->IsMatching(func) && ((entry->m_callbackUserData == userData) || !userData)) { + // Remove connection from tracker node (wxEventConnectionRef) + wxEvtHandler *eventSink = entry->m_fn->GetEvtHandler(); + if ( eventSink && eventSink != this ) + { + wxEventConnectionRef *evtConnRef = FindRefInTrackerList(eventSink); + if ( evtConnRef ) + evtConnRef->DecRef(); + } + delete entry->m_callbackUserData; m_dynamicEvents->Erase( node ); delete entry;