X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f8f7cff4368ee960f63f61d0dd32eacdd471800b..1d065710d3cf39e519f05fd02760006b9a929c38:/src/common/event.cpp diff --git a/src/common/event.cpp b/src/common/event.cpp index 7d98a3e6d0..4a9ade6ccf 100644 --- a/src/common/event.cpp +++ b/src/common/event.cpp @@ -118,7 +118,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 @@ -126,7 +126,7 @@ const wxEventTableEntry wxEvtHandler::sm_eventTableEntries[] = // 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 +#if wxUSE_MEMORY_TRACING class wxEventTableEntryModule: public wxModule { @@ -140,7 +140,7 @@ public: IMPLEMENT_DYNAMIC_CLASS(wxEventTableEntryModule, wxModule) -#endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING +#endif // wxUSE_MEMORY_TRACING // ---------------------------------------------------------------------------- // global variables @@ -151,8 +151,8 @@ 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 ); #endif // wxUSE_BASE @@ -177,6 +177,8 @@ 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); // Mouse event types wxDEFINE_EVENT( wxEVT_LEFT_DOWN, wxMouseEvent ); @@ -361,6 +363,7 @@ 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_wasProcessed = false; @@ -373,6 +376,7 @@ 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_skipped(src.m_skipped) , m_isCommandEvent(src.m_isCommandEvent) @@ -389,6 +393,7 @@ 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_skipped = src.m_skipped; m_isCommandEvent = src.m_isCommandEvent; @@ -402,10 +407,9 @@ wxEvent& wxEvent::operator=(const wxEvent& src) #if wxUSE_GUI -/* - * Command events - * - */ +// ---------------------------------------------------------------------------- +// wxCommandEvent +// ---------------------------------------------------------------------------- #ifdef __VISUALC__ // 'this' : used in base member initializer list (for m_commandString) @@ -447,9 +451,9 @@ wxString wxCommandEvent::GetString() const } } -/* - * UI update events - */ +// ---------------------------------------------------------------------------- +// wxUpdateUIEvent +// ---------------------------------------------------------------------------- #if wxUSE_LONGLONG wxLongLong wxUpdateUIEvent::sm_lastUpdate = 0; @@ -506,9 +510,9 @@ void wxUpdateUIEvent::ResetUpdateTime() #endif } -/* - * Scroll events - */ +// ---------------------------------------------------------------------------- +// wxScrollEvent +// ---------------------------------------------------------------------------- wxScrollEvent::wxScrollEvent(wxEventType commandType, int id, @@ -520,9 +524,9 @@ wxScrollEvent::wxScrollEvent(wxEventType commandType, m_commandInt = pos; } -/* - * ScrollWin events - */ +// ---------------------------------------------------------------------------- +// wxScrollWinEvent +// ---------------------------------------------------------------------------- wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType, int pos, @@ -533,10 +537,9 @@ wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType, m_commandInt = pos; } -/* - * Mouse events - * - */ +// ---------------------------------------------------------------------------- +// wxMouseEvent +// ---------------------------------------------------------------------------- wxMouseEvent::wxMouseEvent(wxEventType commandType) { @@ -703,34 +706,6 @@ bool wxMouseEvent::Button(int but) const } } -bool wxMouseEvent::ButtonIsDown(int but) const -{ - 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 wxMOUSE_BTN_MIDDLE: - return MiddleIsDown(); - - case wxMOUSE_BTN_RIGHT: - return RightIsDown(); - - case wxMOUSE_BTN_AUX1: - return Aux1IsDown(); - - case wxMOUSE_BTN_AUX2: - return Aux2IsDown(); - } -} - int wxMouseEvent::GetButton() const { for ( int i = 1; i < wxMOUSE_BTN_MAX; i++ ) @@ -751,18 +726,16 @@ wxPoint wxMouseEvent::GetLogicalPosition(const wxDC& dc) const return pt; } - -/* - * Keyboard event - * - */ +// ---------------------------------------------------------------------------- +// wxKeyEvent +// ---------------------------------------------------------------------------- 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 } @@ -782,18 +755,70 @@ wxKeyEvent::wxKeyEvent(const wxKeyEvent& evt) #endif } +bool wxKeyEvent::IsKeyInCategory(int category) const +{ + switch ( GetKeyCode() ) + { + case WXK_LEFT: + case WXK_RIGHT: + case WXK_UP: + case WXK_DOWN: + case WXK_NUMPAD_LEFT: + case WXK_NUMPAD_RIGHT: + case WXK_NUMPAD_UP: + case WXK_NUMPAD_DOWN: + return (category & WXK_CATEGORY_ARROW) != 0; + + case WXK_PAGEDOWN: + case WXK_END: + case WXK_NUMPAD_PAGEUP: + case WXK_NUMPAD_PAGEDOWN: + return (category & WXK_CATEGORY_PAGING) != 0; + + case WXK_HOME: + case WXK_PAGEUP: + case WXK_NUMPAD_HOME: + case WXK_NUMPAD_END: + return (category & WXK_CATEGORY_JUMP) != 0; + + case WXK_TAB: + case WXK_NUMPAD_TAB: + return (category & WXK_CATEGORY_TAB) != 0; + + case WXK_BACK: + case WXK_DELETE: + case WXK_NUMPAD_DELETE: + return (category & WXK_CATEGORY_CUT) != 0; + + default: + return false; + } +} + +// ---------------------------------------------------------------------------- +// wxWindowCreateEvent +// ---------------------------------------------------------------------------- + wxWindowCreateEvent::wxWindowCreateEvent(wxWindow *win) { SetEventType(wxEVT_CREATE); SetEventObject(win); } +// ---------------------------------------------------------------------------- +// wxWindowDestroyEvent +// ---------------------------------------------------------------------------- + wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow *win) { SetEventType(wxEVT_DESTROY); SetEventObject(win); } +// ---------------------------------------------------------------------------- +// wxChildFocusEvent +// ---------------------------------------------------------------------------- + wxChildFocusEvent::wxChildFocusEvent(wxWindow *win) : wxCommandEvent(wxEVT_CHILD_FOCUS) { @@ -862,13 +887,12 @@ void wxEventHashTable::Clear() delete eTTnode; } - delete[] m_eventTypeTable; - m_eventTypeTable = NULL; + wxDELETEA(m_eventTypeTable); m_size = 0; } -#if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING +#if wxUSE_MEMORY_TRACING // Clear all tables void wxEventHashTable::ClearAll() @@ -881,7 +905,7 @@ void wxEventHashTable::ClearAll() } } -#endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING +#endif // wxUSE_MEMORY_TRACING bool wxEventHashTable::HandleEvent(wxEvent &event, wxEvtHandler *self) { @@ -1071,14 +1095,11 @@ wxEvtHandler::~wxEvtHandler() delete m_dynamicEvents; } - if (m_pendingEvents) - m_pendingEvents->DeleteContents(true); - delete m_pendingEvents; - // Remove us from the list of the pending events if necessary. - wxEventLoopBase *loop = wxEventLoopBase::GetActive(); - if (loop) - loop->RemovePendingEventHandler(this); + if (wxTheApp) + wxTheApp->RemovePendingEventHandler(this); + + DeletePendingEvents(); // we only delete object data, not untyped if ( m_clientDataType == wxClientData_Object ) @@ -1124,12 +1145,15 @@ void wxEvtHandler::QueueEvent(wxEvent *event) { wxCHECK_RET( event, "NULL event can't be posted" ); - wxEventLoopBase* loop = wxEventLoopBase::GetActive(); - if (!loop) + if (!wxTheApp) { // we need an event loop which manages the list of event handlers with // pending events... cannot proceed without it! - wxLogDebug("No event loop is running!"); + wxLogDebug("No application object! Cannot queue this event!"); + + // anyway delete the given event to avoid memory leaks + delete event; + return; } @@ -1137,14 +1161,14 @@ void wxEvtHandler::QueueEvent(wxEvent *event) wxENTER_CRIT_SECT( m_pendingEventsLock ); if ( !m_pendingEvents ) - m_pendingEvents = new wxList; + m_pendingEvents = new wxList; m_pendingEvents->Append(event); // 2) Add this event handler to list of event handlers that // have pending events. - loop->AppendPendingEventHandler(this); + wxTheApp->AppendPendingEventHandler(this); // only release m_pendingEventsLock now because otherwise there is a race // condition as described in the ticket #9093: we could process the event @@ -1159,14 +1183,20 @@ void wxEvtHandler::QueueEvent(wxEvent *event) wxWakeUpIdle(); } +void wxEvtHandler::DeletePendingEvents() +{ + if (m_pendingEvents) + m_pendingEvents->DeleteContents(true); + wxDELETE(m_pendingEvents); +} + void wxEvtHandler::ProcessPendingEvents() { - wxEventLoopBase* loop = wxEventLoopBase::GetActive(); - if (!loop) + if (!wxTheApp) { // we need an event loop which manages the list of event handlers with // pending events... cannot proceed without it! - wxLogDebug("No event loop is running!"); + wxLogDebug("No application object! Cannot process pending events!"); return; } @@ -1197,7 +1227,7 @@ void wxEvtHandler::ProcessPendingEvents() if (!node) { // all our events are NOT processable now... signal this: - loop->DelayPendingEventHandler(this); + wxTheApp->DelayPendingEventHandler(this); // see the comment at the beginning of evtloop.h header for the // logic behind YieldFor() and behind DelayPendingEventHandler() @@ -1219,7 +1249,7 @@ void wxEvtHandler::ProcessPendingEvents() { // if there are no more pending events left, we don't need to // stay in this list - loop->RemovePendingEventHandler(this); + wxTheApp->RemovePendingEventHandler(this); } wxLEAVE_CRIT_SECT( m_pendingEventsLock ); @@ -1231,13 +1261,10 @@ void wxEvtHandler::ProcessPendingEvents() // of this object any more } -/* - * Event table stuff - */ -/* static */ bool -wxEvtHandler::ProcessEventIfMatchesId(const wxEventTableEntryBase& entry, - wxEvtHandler *handler, - wxEvent& event) +/* static */ +bool wxEvtHandler::ProcessEventIfMatchesId(const wxEventTableEntryBase& entry, + wxEvtHandler *handler, + wxEvent& event) { int tableId1 = entry.m_id, tableId2 = entry.m_lastId; @@ -1275,15 +1302,8 @@ wxEvtHandler::ProcessEventIfMatchesId(const wxEventTableEntryBase& entry, return false; } -bool wxEvtHandler::TryParent(wxEvent& event) +bool wxEvtHandler::DoTryApp(wxEvent& event) { - if ( GetNextHandler() ) - { - // the next handler will pass it to wxTheApp if it doesn't process it, - // so return from here to avoid doing it again - return GetNextHandler()->TryParent(event); - } - if ( wxTheApp && (this != wxTheApp) ) { // Special case: don't pass wxEVT_IDLE to wxApp, since it'll always @@ -1299,13 +1319,47 @@ bool wxEvtHandler::TryParent(wxEvent& event) return false; } +bool wxEvtHandler::TryBefore(wxEvent& event) +{ +#if WXWIN_COMPATIBILITY_2_8 + // call the old virtual function to keep the code overriding it working + return TryValidator(event); +#else + wxUnusedVar(event); + return false; +#endif +} + +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 WXWIN_COMPATIBILITY_2_8 + // as above, call the old virtual function for compatibility + return TryParent(event); +#else + return DoTryApp(event); +#endif +} + bool wxEvtHandler::ProcessEvent(wxEvent& event) { - // allow the application to hook into event processing + // The very first thing we do is to allow the application 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 ) @@ -1322,31 +1376,102 @@ bool wxEvtHandler::ProcessEvent(wxEvent& event) } } - 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 - // TryParent() 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 TryParent(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; - // If we have a validator, it has higher priority than our own event - // handlers - if ( TryValidator(event) ) - return true; - // Handle per-instance dynamic event tables first if ( m_dynamicEvents && SearchDynamicEventTable(event) ) return true; @@ -1370,9 +1495,15 @@ bool wxEvtHandler::SafelyProcessEvent(wxEvent& event) } catch ( ... ) { - wxEventLoopBase *loop = wxEventLoopBase::GetActive(); + // notice that we do it in 2 steps to avoid warnings about possibly + // uninitialized loop variable from some versions of g++ which are not + // smart enough to figure out that GetActive() doesn't throw and so + // that loop will always be initialized + wxEventLoopBase *loop = NULL; try { + loop = wxEventLoopBase::GetActive(); + if ( !wxTheApp || !wxTheApp->OnExceptionInMainLoop() ) { if ( loop ) @@ -1395,7 +1526,6 @@ bool wxEvtHandler::SafelyProcessEvent(wxEvent& event) #endif // wxUSE_EXCEPTIONS } - bool wxEvtHandler::SearchEventTable(wxEventTable& table, wxEvent& event) { const wxEventType eventType = event.GetEventType(); @@ -1412,11 +1542,11 @@ bool wxEvtHandler::SearchEventTable(wxEventTable& table, wxEvent& event) return false; } -void wxEvtHandler::DoConnect(int id, - int lastId, - wxEventType eventType, - wxEventFunctor *func, - wxObject *userData) +void wxEvtHandler::DoBind(int id, + int lastId, + wxEventType eventType, + wxEventFunctor *func, + wxObject *userData) { wxDynamicEventTableEntry *entry = new wxDynamicEventTableEntry(eventType, id, lastId, func, userData); @@ -1440,11 +1570,11 @@ void wxEvtHandler::DoConnect(int id, } bool -wxEvtHandler::DoDisconnect(int id, - int lastId, - wxEventType eventType, - const wxEventFunctor& func, - wxObject *userData) +wxEvtHandler::DoUnbind(int id, + int lastId, + wxEventType eventType, + const wxEventFunctor& func, + wxObject *userData) { if (!m_dynamicEvents) return false; @@ -1466,7 +1596,7 @@ wxEvtHandler::DoDisconnect(int id, if ((entry->m_id == id) && ((entry->m_lastId == lastId) || (lastId == wxID_ANY)) && ((entry->m_eventType == eventType) || (eventType == wxEVT_NULL)) && - entry->m_fn->Matches(func) && + entry->m_fn->IsMatching(func) && ((entry->m_callbackUserData == userData) || !userData)) { delete entry->m_callbackUserData;