X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b49f58fe129273771cdad8a6ff1bd00daf74d25c..d485bda109d5ef0fef36a3f737549e9b9f54baab:/src/common/containr.cpp?ds=sidebyside diff --git a/src/common/containr.cpp b/src/common/containr.cpp index 535513d54d..fbd3ea33d2 100644 --- a/src/common/containr.cpp +++ b/src/common/containr.cpp @@ -6,7 +6,7 @@ // Created: 06.08.01 // RCS-ID: $Id$ // Copyright: (c) 2001 Vadim Zeitlin -// License: wxWindows licence +// Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// // ============================================================================ @@ -17,10 +17,6 @@ // headers // ---------------------------------------------------------------------------- -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) - #pragma implementation "containr.h" -#endif - // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" @@ -28,78 +24,120 @@ #pragma hdrstop #endif +#ifndef WX_PRECOMP + #include "wx/containr.h" +#endif + #ifndef WX_PRECOMP #include "wx/log.h" #include "wx/event.h" #include "wx/window.h" -#endif //WX_PRECOMP - -#include "wx/containr.h" - -#ifdef __WXMAC__ #include "wx/scrolbar.h" -#endif - -#ifdef __WXMSW__ #include "wx/radiobut.h" -#endif +#endif //WX_PRECOMP + +// trace mask for focus messages +#define TRACE_FOCUS wxT("focus") // ============================================================================ // implementation // ============================================================================ -wxControlContainer::wxControlContainer(wxWindow *winParent) +// ---------------------------------------------------------------------------- +// wxControlContainerBase +// ---------------------------------------------------------------------------- + +bool wxControlContainerBase::UpdateCanFocusChildren() { - m_winParent = winParent; + const bool acceptsFocusChildren = HasAnyFocusableChildren(); + if ( acceptsFocusChildren != m_acceptsFocusChildren ) + { + m_acceptsFocusChildren = acceptsFocusChildren; - m_winLastFocused = - m_winTmpDefault = - m_winDefault = NULL; - m_inSetFocus = false; + // In the ports where it does something non trivial, the parent window + // should only be focusable if it doesn't have any focusable children + // (e.g. native focus handling in wxGTK totally breaks down otherwise). + m_winParent->SetCanFocus(m_acceptsFocusSelf && !m_acceptsFocusChildren); + } + + return m_acceptsFocusChildren; } -bool wxControlContainer::AcceptsFocus() const +bool wxControlContainerBase::HasAnyFocusableChildren() const { - // if we're not shown or disabled, we can't accept focus - if ( m_winParent->IsShown() && m_winParent->IsEnabled() ) + const wxWindowList& children = m_winParent->GetChildren(); + for ( wxWindowList::const_iterator i = children.begin(), + end = children.end(); + i != end; + ++i ) { - // otherwise we can accept focus either if we have no children at all - // (in this case we're probably not used as a container) or only when - // at least one child will accept focus - wxWindowList::compatibility_iterator node = m_winParent->GetChildren().GetFirst(); - if ( !node ) + const wxWindow * const child = *i; + + if ( !m_winParent->IsClientAreaChild(child) ) + continue; + + if ( child->CanAcceptFocus() ) return true; + } -#ifdef __WXMAC__ - // wxMac has eventually the two scrollbars as children, they don't count - // as real children in the algorithm mentioned above - bool hasRealChildren = false ; -#endif + return false; +} - while ( node ) - { - wxWindow *child = node->GetData(); +bool wxControlContainerBase::DoSetFocus() +{ + wxLogTrace(TRACE_FOCUS, wxT("SetFocus on wxPanel 0x%p."), + m_winParent->GetHandle()); - if ( child->AcceptsFocus() ) - { - return true; - } + if (m_inSetFocus) + return true; -#ifdef __WXMAC__ - wxScrollBar *sb = wxDynamicCast( child , wxScrollBar ) ; - if ( sb == NULL || !m_winParent->MacIsWindowScrollbar( sb ) ) - hasRealChildren = true ; -#endif - node = node->GetNext(); + // when the panel gets the focus we move the focus to either the last + // window that had the focus or the first one that can get it unless the + // focus had been already set to some other child + + wxWindow *win = wxWindow::FindFocus(); + while ( win ) + { + if ( win == m_winParent ) + { + // our child already has focus, don't take it away from it + return true; } -#ifdef __WXMAC__ - if ( !hasRealChildren ) - return true ; -#endif + if ( win->IsTopLevel() ) + { + // don't look beyond the first top level parent - useless and + // unnecessary + break; + } + + win = win->GetParent(); } - return false; + // protect against infinite recursion: + m_inSetFocus = true; + + bool ret = SetFocusToChild(); + + m_inSetFocus = false; + + return ret; +} + +bool wxControlContainerBase::SetFocusToChild() +{ + return wxSetFocusToChild(m_winParent, &m_winLastFocused); +} + +#ifndef wxHAS_NATIVE_TAB_TRAVERSAL + +// ---------------------------------------------------------------------------- +// generic wxControlContainer +// ---------------------------------------------------------------------------- + +wxControlContainer::wxControlContainer() +{ + m_winLastFocused = NULL; } void wxControlContainer::SetLastFocus(wxWindow *win) @@ -125,7 +163,7 @@ void wxControlContainer::SetLastFocus(wxWindow *win) // (under wxGTK) wxASSERT_MSG( winParent, - _T("Setting last focus for a window that is not our child?") ); + wxT("Setting last focus for a window that is not our child?") ); } } @@ -133,24 +171,15 @@ void wxControlContainer::SetLastFocus(wxWindow *win) if ( win ) { - wxLogTrace(_T("focus"), _T("Set last focus to %s(%s)"), + wxLogTrace(TRACE_FOCUS, wxT("Set last focus to %s(%s)"), win->GetClassInfo()->GetClassName(), win->GetLabel().c_str()); } else { - wxLogTrace(_T("focus"), _T("No more last focus")); + wxLogTrace(TRACE_FOCUS, wxT("No more last focus")); } } - - // propagate the last focus upwards so that our parent can set focus back - // to us if it loses it now and regains later - wxWindow *parent = m_winParent->GetParent(); - if ( parent ) - { - wxChildFocusEvent eventFocus(m_winParent); - parent->GetEventHandler()->ProcessEvent(eventFocus); - } } // -------------------------------------------------------------------- @@ -158,7 +187,7 @@ void wxControlContainer::SetLastFocus(wxWindow *win) // within the same group. Used by wxSetFocusToChild on wxMSW // -------------------------------------------------------------------- -#ifdef __WXMSW__ +#if defined(__WXMSW__) && wxUSE_RADIOBTN wxRadioButton* wxGetPreviousButtonInGroup(wxRadioButton *btn) { @@ -167,7 +196,7 @@ wxRadioButton* wxGetPreviousButtonInGroup(wxRadioButton *btn) const wxWindowList& siblings = btn->GetParent()->GetChildren(); wxWindowList::compatibility_iterator nodeThis = siblings.Find(btn); - wxCHECK_MSG( nodeThis, NULL, _T("radio button not a child of its parent?") ); + wxCHECK_MSG( nodeThis, NULL, wxT("radio button not a child of its parent?") ); // Iterate over all previous siblings until we find the next radio button wxWindowList::compatibility_iterator nodeBefore = nodeThis->GetPrevious(); @@ -186,8 +215,8 @@ wxRadioButton* wxGetPreviousButtonInGroup(wxRadioButton *btn) // no more buttons in group return NULL; } - else - return prevBtn; + + return prevBtn; } wxRadioButton* wxGetNextButtonInGroup(wxRadioButton *btn) @@ -197,7 +226,7 @@ wxRadioButton* wxGetNextButtonInGroup(wxRadioButton *btn) const wxWindowList& siblings = btn->GetParent()->GetChildren(); wxWindowList::compatibility_iterator nodeThis = siblings.Find(btn); - wxCHECK_MSG( nodeThis, NULL, _T("radio button not a child of its parent?") ); + wxCHECK_MSG( nodeThis, NULL, wxT("radio button not a child of its parent?") ); // Iterate over all previous siblings until we find the next radio button wxWindowList::compatibility_iterator nodeNext = nodeThis->GetNext(); @@ -216,8 +245,8 @@ wxRadioButton* wxGetNextButtonInGroup(wxRadioButton *btn) // no more buttons or the first button of the next group return NULL; } - else - return nextBtn; + + return nextBtn; } wxRadioButton* wxGetFirstButtonInGroup(wxRadioButton *btn) @@ -232,6 +261,18 @@ wxRadioButton* wxGetFirstButtonInGroup(wxRadioButton *btn) } } +wxRadioButton* wxGetLastButtonInGroup(wxRadioButton *btn) +{ + while (true) + { + wxRadioButton* nextBtn = wxGetNextButtonInGroup(btn); + if (!nextBtn) + return btn; + + btn = nextBtn; + } +} + wxRadioButton* wxGetSelectedButtonInGroup(wxRadioButton *btn) { // Find currently selected button @@ -268,13 +309,59 @@ wxRadioButton* wxGetSelectedButtonInGroup(wxRadioButton *btn) void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event ) { - wxWindow *parent = m_winParent->GetParent(); + // for a TLW we shouldn't involve the parent window, it has nothing to do + // with keyboard navigation inside this TLW + wxWindow *parent = m_winParent->IsTopLevel() ? NULL + : m_winParent->GetParent(); // the event is propagated downwards if the event emitter was our parent bool goingDown = event.GetEventObject() == parent; const wxWindowList& children = m_winParent->GetChildren(); + // if we have exactly one notebook-like child window (actually it could be + // any window that returns true from its HasMultiplePages()), then + // [Shift-]Ctrl-Tab and Ctrl-PageUp/Down keys should iterate over its pages + // even if the focus is outside of the control because this is how the + // standard MSW properties dialogs behave and we do it under other platforms + // as well because it seems like a good idea -- but we can always put this + // block inside "#ifdef __WXMSW__" if it's not suitable there + if ( event.IsWindowChange() && !goingDown ) + { + // check if we have a unique notebook-like child + wxWindow *bookctrl = NULL; + for ( wxWindowList::const_iterator i = children.begin(), + end = children.end(); + i != end; + ++i ) + { + wxWindow * const window = *i; + if ( window->HasMultiplePages() ) + { + if ( bookctrl ) + { + // this is the second book-like control already so don't do + // anything as we don't know which one should have its page + // changed + bookctrl = NULL; + break; + } + + bookctrl = window; + } + } + + if ( bookctrl ) + { + // make sure that we don't bubble up the event again from the book + // control resulting in infinite recursion + wxNavigationKeyEvent eventCopy(event); + eventCopy.SetEventObject(m_winParent); + if ( bookctrl->GetEventHandler()->ProcessEvent(eventCopy) ) + return; + } + } + // there is not much to do if we don't have children and we're not // interested in "notebook page change" events here if ( !children.GetCount() || event.IsWindowChange() ) @@ -291,7 +378,7 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event ) } // where are we going? - bool forward = event.GetDirection(); + const bool forward = event.GetDirection(); // the node of the children list from which we should start looking for the // next acceptable child @@ -304,15 +391,12 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event ) { // just to be sure it's not used (normally this is not necessary, but // doesn't hurt neither) - m_winLastFocused = (wxWindow *)NULL; + m_winLastFocused = NULL; // start from first or last depending on where we're going node = forward ? children.GetFirst() : children.GetLast(); - - // we want to cycle over all nodes - start_node = wxWindowList::compatibility_iterator(); } - else + else // going up { // try to find the child which has the focus currently @@ -329,19 +413,15 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event ) if ( winFocus ) { -#ifdef __WXMSW__ +#if defined(__WXMSW__) && wxUSE_RADIOBTN // If we are in a radio button group, start from the first item in the // group if ( event.IsFromTab() && wxIsKindOf(winFocus, wxRadioButton ) ) winFocus = wxGetFirstButtonInGroup((wxRadioButton*)winFocus); -#endif +#endif // __WXMSW__ // ok, we found the focus - now is it our child? start_node = children.Find( winFocus ); } - else - { - start_node = wxWindowList::compatibility_iterator(); - } if ( !start_node && m_winLastFocused ) { @@ -362,31 +442,44 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event ) } // we want to cycle over all elements passing by NULL - while ( node != start_node ) + for ( ;; ) { + // don't go into infinite loop + if ( start_node && node && node == start_node ) + break; + // Have we come to the last or first item on the panel? if ( !node ) { + if ( !start_node ) + { + // exit now as otherwise we'd loop forever + break; + } + if ( !goingDown ) { - // Check if our (may be grand) parent is another panel: if this + // Check if our (maybe grand) parent is another panel: if this // is the case, they will know what to do with this navigation // key and so give them the chance to process it instead of // looping inside this panel (normally, the focus will go to // the next/previous item after this panel in the parent // panel). - wxWindow *focussed_child_of_parent = m_winParent; + wxWindow *focusedParent = m_winParent; while ( parent ) { - // we don't want to tab into a different dialog or frame - if ( focussed_child_of_parent->IsTopLevel() ) + // We don't want to tab into a different dialog or frame or + // even an MDI child frame, so test for this explicitly + // (and in particular don't just use IsTopLevel() which + // would return false in the latter case). + if ( focusedParent->IsTopNavigationDomain() ) break; - event.SetCurrentFocus( focussed_child_of_parent ); + event.SetCurrentFocus( focusedParent ); if ( parent->GetEventHandler()->ProcessEvent( event ) ) return; - focussed_child_of_parent = parent; + focusedParent = parent; parent = parent->GetParent(); } @@ -402,40 +495,74 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event ) wxWindow *child = node->GetData(); -#ifdef __WXMSW__ - bool canSelectRadioButton = true; - if (!event.IsFromTab()) + // don't TAB to another TLW + if ( child->IsTopLevel() ) + { + node = forward ? node->GetNext() : node->GetPrevious(); + + continue; + } + +#if defined(__WXMSW__) && wxUSE_RADIOBTN + if ( event.IsFromTab() ) { - // If navigating using cursor keys, make sure not to navigate out of a radio button group. - if (m_winLastFocused && wxIsKindOf(m_winLastFocused, wxRadioButton)) + if ( wxIsKindOf(child, wxRadioButton) ) { - if (!wxIsKindOf(child, wxRadioButton)) + // only radio buttons with either wxRB_GROUP or wxRB_SINGLE + // can be tabbed to + if ( child->HasFlag(wxRB_GROUP) ) { - child = forward ? - wxGetNextButtonInGroup((wxRadioButton*)m_winLastFocused) : - wxGetPreviousButtonInGroup((wxRadioButton*)m_winLastFocused); - if (!child) - { - event.Skip(false); - return; - } + // need to tab into the active button within a group + wxRadioButton *rb = wxGetSelectedButtonInGroup((wxRadioButton*)child); + if ( rb ) + child = rb; + } + else if ( !child->HasFlag(wxRB_SINGLE) ) + { + node = forward ? node->GetNext() : node->GetPrevious(); + continue; } } } - else + else if ( m_winLastFocused && + wxIsKindOf(m_winLastFocused, wxRadioButton) && + !m_winLastFocused->HasFlag(wxRB_SINGLE) ) { - // If navigating using tabs, skip all but the first radio button in a group. - if (wxIsKindOf(child, wxRadioButton)) + wxRadioButton * const + lastBtn = static_cast(m_winLastFocused); + + // cursor keys don't navigate out of a radio button group so + // find the correct radio button to focus + if ( forward ) + { + child = wxGetNextButtonInGroup(lastBtn); + if ( !child ) + { + // no next button in group, set it to the first button + child = wxGetFirstButtonInGroup(lastBtn); + } + } + else { - if (wxGetPreviousButtonInGroup((wxRadioButton*)child)) - canSelectRadioButton = false; + child = wxGetPreviousButtonInGroup(lastBtn); + if ( !child ) + { + // no previous button in group, set it to the last button + child = wxGetLastButtonInGroup(lastBtn); + } + } + + if ( child == m_winLastFocused ) + { + // must be a group consisting of only one button therefore + // no need to send a navigation event + event.Skip(false); + return; } } -#else - static bool canSelectRadioButton = true; -#endif +#endif // __WXMSW__ - if ( child->AcceptsFocusFromKeyboard() && canSelectRadioButton ) + if ( child->CanAcceptFocusFromKeyboard() ) { // if we're setting the focus to a child panel we should prevent it // from giving it to the child which had the focus the last time @@ -443,18 +570,6 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event ) // direction we're coming event.SetEventObject(m_winParent); -#if defined(__WXMSW__) - // we need to hop to the next activated - // radio button, not just the next radio - // button under MSW - if (wxIsKindOf(child, wxRadioButton) && event.IsFromTab()) - { - wxRadioButton *rb = wxGetSelectedButtonInGroup((wxRadioButton*)child); - if (rb) - child = rb; - } -#endif // __WXMSW__ - // disable propagation for this call as otherwise the event might // bounce back to us. wxPropagationDisabler disableProp(event); @@ -486,63 +601,16 @@ void wxControlContainer::HandleOnWindowDestroy(wxWindowBase *child) { if ( child == m_winLastFocused ) m_winLastFocused = NULL; - - if ( child == m_winDefault ) - m_winDefault = NULL; - - if ( child == m_winTmpDefault ) - m_winTmpDefault = NULL; } // ---------------------------------------------------------------------------- // focus handling // ---------------------------------------------------------------------------- -bool wxControlContainer::DoSetFocus() -{ - wxLogTrace(_T("focus"), _T("SetFocus on wxPanel 0x%08lx."), - (unsigned long)m_winParent->GetHandle()); - - if (m_inSetFocus) - return true; - - // when the panel gets the focus we move the focus to either the last - // window that had the focus or the first one that can get it unless the - // focus had been already set to some other child - - wxWindow *win = wxWindow::FindFocus(); - while ( win ) - { - if ( win == m_winParent ) - { - // our child already has focus, don't take it away from it - return true; - } - - if ( win->IsTopLevel() ) - { - // don't look beyond the first top level parent - useless and - // unnecessary - break; - } - - win = win->GetParent(); - } - - // protect against infinite recursion: - m_inSetFocus = true; - - bool ret = SetFocusToChild(); - - m_inSetFocus = false; - - return ret; -} - void wxControlContainer::HandleOnFocus(wxFocusEvent& event) { - wxLogTrace(_T("focus"), _T("OnFocus on wxPanel 0x%08lx, name: %s"), - (unsigned long)m_winParent->GetHandle(), + wxLogTrace(TRACE_FOCUS, wxT("OnFocus on wxPanel 0x%p, name: %s"), + m_winParent->GetHandle(), m_winParent->GetName().c_str() ); DoSetFocus(); @@ -550,11 +618,18 @@ void wxControlContainer::HandleOnFocus(wxFocusEvent& event) event.Skip(); } + +#else + // wxHAS_NATIVE_TAB_TRAVERSAL + bool wxControlContainer::SetFocusToChild() { - return wxSetFocusToChild(m_winParent, &m_winLastFocused); + return wxSetFocusToChild(m_winParent, NULL); } + +#endif // !wxHAS_NATIVE_TAB_TRAVERSAL + // ---------------------------------------------------------------------------- // SetFocusToChild(): this function is used by wxPanel but also by wxFrame in // wxMSW, this is why it is outside of wxControlContainer class @@ -562,28 +637,50 @@ bool wxControlContainer::SetFocusToChild() bool wxSetFocusToChild(wxWindow *win, wxWindow **childLastFocused) { - wxCHECK_MSG( win, false, _T("wxSetFocusToChild(): invalid window") ); - wxCHECK_MSG( childLastFocused, false, - _T("wxSetFocusToChild(): NULL child poonter") ); + wxCHECK_MSG( win, false, wxT("wxSetFocusToChild(): invalid window") ); + // wxCHECK_MSG( childLastFocused, false, + // wxT("wxSetFocusToChild(): NULL child poonter") ); - if ( *childLastFocused ) + if ( childLastFocused && *childLastFocused ) { // It might happen that the window got reparented if ( (*childLastFocused)->GetParent() == win ) { - wxLogTrace(_T("focus"), - _T("SetFocusToChild() => last child (0x%08lx)."), - (unsigned long)(*childLastFocused)->GetHandle()); + // And it also could have become hidden in the meanwhile + // We want to focus on the deepest widget visible + wxWindow *deepestVisibleWindow = NULL; - // not SetFocusFromKbd(): we're restoring focus back to the old - // window and not setting it as the result of a kbd action - (*childLastFocused)->SetFocus(); - return true; + while ( *childLastFocused ) + { + if ( (*childLastFocused)->IsShown() ) + { + if ( !deepestVisibleWindow ) + deepestVisibleWindow = *childLastFocused; + } + else + deepestVisibleWindow = NULL; + + *childLastFocused = (*childLastFocused)->GetParent(); + } + + if ( deepestVisibleWindow ) + { + *childLastFocused = deepestVisibleWindow; + + wxLogTrace(TRACE_FOCUS, + wxT("SetFocusToChild() => last child (0x%p)."), + (*childLastFocused)->GetHandle()); + + // not SetFocusFromKbd(): we're restoring focus back to the old + // window and not setting it as the result of a kbd action + (*childLastFocused)->SetFocus(); + return true; + } } else { // it doesn't count as such any more - *childLastFocused = (wxWindow *)NULL; + *childLastFocused = NULL; } } @@ -592,10 +689,15 @@ bool wxSetFocusToChild(wxWindow *win, wxWindow **childLastFocused) while ( node ) { wxWindow *child = node->GetData(); + node = node->GetNext(); - if ( child->AcceptsFocusFromKeyboard() && !child->IsTopLevel() ) + // skip special windows: + if ( !win->IsClientAreaChild(child) ) + continue; + + if ( child->CanAcceptFocusFromKeyboard() && !child->IsTopLevel() ) { -#ifdef __WXMSW__ +#if defined(__WXMSW__) && wxUSE_RADIOBTN // If a radiobutton is the first focusable child, search for the // selected radiobutton in the same group wxRadioButton* btn = wxDynamicCast(child, wxRadioButton); @@ -605,18 +707,17 @@ bool wxSetFocusToChild(wxWindow *win, wxWindow **childLastFocused) if (selected) child = selected; } -#endif +#endif // __WXMSW__ - wxLogTrace(_T("focus"), - _T("SetFocusToChild() => first child (0x%08lx)."), - (unsigned long)child->GetHandle()); + wxLogTrace(TRACE_FOCUS, + wxT("SetFocusToChild() => first child (0x%p)."), + child->GetHandle()); - *childLastFocused = child; + if (childLastFocused) + *childLastFocused = child; child->SetFocusFromKbd(); return true; } - - node = node->GetNext(); } return false;