X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/24a7a1980f309763c349541daffa46f1a5fd16b2..eea4d01c65f9b29baa1193db762b4c6b8144af24:/src/common/containr.cpp?ds=sidebyside diff --git a/src/common/containr.cpp b/src/common/containr.cpp index 04a7794bfe..2fda844c96 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 license +// Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// // ============================================================================ @@ -17,10 +17,6 @@ // headers // ---------------------------------------------------------------------------- -#ifdef __GNUG__ - #pragma implementation "containr.h" -#endif - // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" @@ -28,39 +24,288 @@ #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" + #include "wx/scrolbar.h" + #include "wx/radiobut.h" #endif //WX_PRECOMP -#include "wx/containr.h" +// trace mask for focus messages +#define TRACE_FOCUS wxT("focus") // ============================================================================ // implementation // ============================================================================ -wxControlContainer::wxControlContainer(wxWindow *winParent) +// ---------------------------------------------------------------------------- +// wxControlContainerBase +// ---------------------------------------------------------------------------- + +void wxControlContainerBase::SetCanFocus(bool acceptsFocus) { - m_winParent = winParent; + if ( acceptsFocus == m_acceptsFocus ) + return; + + m_acceptsFocus = acceptsFocus; - m_winLastFocused = - m_winDefault = NULL; + m_winParent->SetCanFocus(m_acceptsFocus); } -void wxControlContainer::SetLastFocus(wxWindow *win) +bool wxControlContainerBase::HasAnyFocusableChildren() const { - // find the last _immediate_ child which got focus - while ( win && win != m_winParent ) + const wxWindowList& children = m_winParent->GetChildren(); + for ( wxWindowList::const_iterator i = children.begin(), + end = children.end(); + i != end; + ++i ) + { + const wxWindow * const child = *i; + + if ( !m_winParent->IsClientAreaChild(child) ) + continue; + + if ( child->CanAcceptFocus() ) + return true; + } + + return false; +} + +bool wxControlContainerBase::DoSetFocus() +{ + wxLogTrace(TRACE_FOCUS, wxT("SetFocus on wxPanel 0x%p."), + 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(); } - wxASSERT_MSG( win, _T("attempt to set last focus to not a child?") ); + // 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) +{ + // the panel itself should never get the focus at all but if it does happen + // temporarily (as it seems to do under wxGTK), at the very least don't + // forget our previous m_winLastFocused + if ( win != m_winParent ) + { + // if we're setting the focus + if ( win ) + { + // find the last _immediate_ child which got focus + wxWindow *winParent = win; + while ( winParent != m_winParent ) + { + win = winParent; + winParent = win->GetParent(); + + // Yes, this can happen, though in a totally pathological case. + // like when detaching a menubar from a frame with a child + // which has pushed itself as an event handler for the menubar. + // (under wxGTK) + + wxASSERT_MSG( winParent, + wxT("Setting last focus for a window that is not our child?") ); + } + } + + m_winLastFocused = win; + + if ( win ) + { + wxLogTrace(TRACE_FOCUS, wxT("Set last focus to %s(%s)"), + win->GetClassInfo()->GetClassName(), + win->GetLabel().c_str()); + } + else + { + 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; do *not* do this if we are + // a toplevel window (e.g. wxDialog) that has another frame as its parent + if ( !m_winParent->IsTopLevel() ) + { + wxWindow *parent = m_winParent->GetParent(); + if ( parent ) + { + wxChildFocusEvent eventFocus(m_winParent); + parent->GetEventHandler()->ProcessEvent(eventFocus); + } + } +} + +// -------------------------------------------------------------------- +// The following four functions are used to find other radio buttons +// within the same group. Used by wxSetFocusToChild on wxMSW +// -------------------------------------------------------------------- + +#if defined(__WXMSW__) && wxUSE_RADIOBTN + +wxRadioButton* wxGetPreviousButtonInGroup(wxRadioButton *btn) +{ + if ( btn->HasFlag(wxRB_GROUP) || btn->HasFlag(wxRB_SINGLE) ) + return NULL; + + const wxWindowList& siblings = btn->GetParent()->GetChildren(); + wxWindowList::compatibility_iterator nodeThis = siblings.Find(btn); + 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(); + wxRadioButton *prevBtn = 0; + while (nodeBefore) + { + prevBtn = wxDynamicCast(nodeBefore->GetData(), wxRadioButton); + if (prevBtn) + break; + + nodeBefore = nodeBefore->GetPrevious(); + } + + if (!prevBtn || prevBtn->HasFlag(wxRB_SINGLE)) + { + // no more buttons in group + return NULL; + } + + return prevBtn; +} + +wxRadioButton* wxGetNextButtonInGroup(wxRadioButton *btn) +{ + if (btn->HasFlag(wxRB_SINGLE)) + return NULL; + + const wxWindowList& siblings = btn->GetParent()->GetChildren(); + wxWindowList::compatibility_iterator nodeThis = siblings.Find(btn); + 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(); + wxRadioButton *nextBtn = 0; + while (nodeNext) + { + nextBtn = wxDynamicCast(nodeNext->GetData(), wxRadioButton); + if (nextBtn) + break; + + nodeNext = nodeNext->GetNext(); + } + + if ( !nextBtn || nextBtn->HasFlag(wxRB_GROUP) || nextBtn->HasFlag(wxRB_SINGLE) ) + { + // no more buttons or the first button of the next group + return NULL; + } + + return nextBtn; +} + +wxRadioButton* wxGetFirstButtonInGroup(wxRadioButton *btn) +{ + while (true) + { + wxRadioButton* prevBtn = wxGetPreviousButtonInGroup(btn); + if (!prevBtn) + return btn; + + btn = prevBtn; + } +} + +wxRadioButton* wxGetLastButtonInGroup(wxRadioButton *btn) +{ + while (true) + { + wxRadioButton* nextBtn = wxGetNextButtonInGroup(btn); + if (!nextBtn) + return btn; - m_winLastFocused = win; + btn = nextBtn; + } } +wxRadioButton* wxGetSelectedButtonInGroup(wxRadioButton *btn) +{ + // Find currently selected button + if (btn->GetValue()) + return btn; + + if (btn->HasFlag(wxRB_SINGLE)) + return NULL; + + wxRadioButton *selBtn; + + // First check all previous buttons + for (selBtn = wxGetPreviousButtonInGroup(btn); selBtn; selBtn = wxGetPreviousButtonInGroup(selBtn)) + if (selBtn->GetValue()) + return selBtn; + + // Now all following buttons + for (selBtn = wxGetNextButtonInGroup(btn); selBtn; selBtn = wxGetNextButtonInGroup(selBtn)) + if (selBtn->GetValue()) + return selBtn; + + return NULL; +} + +#endif // __WXMSW__ + // ---------------------------------------------------------------------------- // Keyboard handling - this is the place where the TAB traversal logic is // implemented. As this code is common to all ports, this ensures consistent @@ -71,13 +316,59 @@ void wxControlContainer::SetLastFocus(wxWindow *win) 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() ) @@ -94,11 +385,11 @@ 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 - wxWindowList::Node *node, *start_node; + wxWindowList::compatibility_iterator node, start_node; // we should start from the first/last control and not from the one which // had focus the last time if we're propagating the event downwards because @@ -107,15 +398,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::Node *)NULL; } - else + else // going up { // try to find the child which has the focus currently @@ -132,13 +420,15 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event ) if ( winFocus ) { +#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 // __WXMSW__ // ok, we found the focus - now is it our child? start_node = children.Find( winFocus ); } - else - { - start_node = (wxWindowList::Node *)NULL; - } if ( !start_node && m_winLastFocused ) { @@ -159,31 +449,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(); } @@ -199,23 +502,96 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event ) wxWindow *child = node->GetData(); - if ( child->AcceptsFocusFromKeyboard() ) + // 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 ( wxIsKindOf(child, wxRadioButton) ) + { + // only radio buttons with either wxRB_GROUP or wxRB_SINGLE + // can be tabbed to + if ( child->HasFlag(wxRB_GROUP) ) + { + // 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 if ( m_winLastFocused && + wxIsKindOf(m_winLastFocused, wxRadioButton) && + !m_winLastFocused->HasFlag(wxRB_SINGLE) ) + { + 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 + { + 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; + } + } +#endif // __WXMSW__ + + 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 // and instead give it to the first/last child depending from which // direction we're coming event.SetEventObject(m_winParent); + + // disable propagation for this call as otherwise the event might + // bounce back to us. + wxPropagationDisabler disableProp(event); if ( !child->GetEventHandler()->ProcessEvent(event) ) { - // everything is simple: just give focus to it - child->SetFocus(); - + // set it first in case SetFocusFromKbd() results in focus + // change too m_winLastFocused = child; + + // everything is simple: just give focus to it + child->SetFocusFromKbd(); } //else: the child manages its focus itself - event.Skip( FALSE ); + event.Skip( false ); return; } @@ -232,69 +608,35 @@ void wxControlContainer::HandleOnWindowDestroy(wxWindowBase *child) { if ( child == m_winLastFocused ) m_winLastFocused = NULL; - - if ( child == m_winDefault ) - m_winDefault = NULL; } // ---------------------------------------------------------------------------- // focus handling // ---------------------------------------------------------------------------- -bool wxControlContainer::DoSetFocus() -{ - wxLogTrace(_T("focus"), _T("SetFocus on wxPanel 0x%08x."), - m_winParent->GetHandle()); - - // If the panel gets the focus *by way of getting it set directly* - // we move the focus to the first window that can get it. - - // VZ: no, we set the focus to the last window too. I don't understand why - // should we make this distinction: if an app wants to set focus to - // some precise control, it may always do it directly, but if we don't - // use m_winLastFocused here, the focus won't be set correctly after a - // notebook page change nor after frame activation under MSW (it calls - // SetFocus too) - // - // RR: yes, when I the tab key to navigate in a panel with some controls and - // a notebook and the focus jumps to the notebook (typically coming from - // a button at the top) the notebook should focus the first child in the - // current notebook page, not the last one which would otherwise get the - // focus if you used the tab key to navigate from the current notebook - // page to button at the bottom. See every page in the controls sample. - // - // VZ: ok, but this still doesn't (at least I don't see how it can) take - // care of first/last child problem: i.e. if Shift-TAB is pressed in a - // situation like above, the focus should be given to the last child, - // not the first one (and not to the last focused one neither) - I - // think my addition to OnNavigationKey() above takes care of it. - // Keeping #ifdef __WXGTK__ for now, but please try removing it and see - // what happens. - // - // RR: Removed for now. Let's see what happens.. - - return SetFocusToChild(); -} - void wxControlContainer::HandleOnFocus(wxFocusEvent& event) { - wxLogTrace(_T("focus"), _T("OnFocus on wxPanel 0x%08x, name: %s"), + wxLogTrace(TRACE_FOCUS, wxT("OnFocus on wxPanel 0x%p, name: %s"), m_winParent->GetHandle(), m_winParent->GetName().c_str() ); - // If we panel got the focus *by way of getting clicked on* - // we move the focus to either the last window that had the - // focus or the first one that can get it. - (void)SetFocusToChild(); + DoSetFocus(); 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 @@ -302,48 +644,79 @@ bool wxControlContainer::SetFocusToChild() bool wxSetFocusToChild(wxWindow *win, wxWindow **childLastFocused) { - wxCHECK_MSG( win, FALSE, _T("wxSetFocusToChild(): invalid window") ); + 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 or no longer accepts - // the focus. - if ( (*childLastFocused)->GetParent() == win && - (*childLastFocused)->AcceptsFocusFromKeyboard() ) + // It might happen that the window got reparented + if ( (*childLastFocused)->GetParent() == win ) { - wxLogTrace(_T("focus"), - _T("SetFocusToChild() => last child (0x%08x)."), - (*childLastFocused)->GetHandle()); + // And it also could have become hidden in the meanwhile, in this + // case focus its parent instead. + while ( !(*childLastFocused)->IsShown() ) + { + *childLastFocused = (*childLastFocused)->GetParent(); + if ( !*childLastFocused ) + break; + } - (*childLastFocused)->SetFocus(); - return TRUE; + if ( *childLastFocused ) + { + 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; } } // set the focus to the first child who wants it - wxWindowList::Node *node = win->GetChildren().GetFirst(); + wxWindowList::compatibility_iterator node = win->GetChildren().GetFirst(); while ( node ) { wxWindow *child = node->GetData(); + node = node->GetNext(); + + // skip special windows: + if ( !win->IsClientAreaChild(child) ) + continue; - if ( child->AcceptsFocusFromKeyboard() && !child->IsTopLevel() ) + if ( child->CanAcceptFocusFromKeyboard() && !child->IsTopLevel() ) { - wxLogTrace(_T("focus"), - _T("SetFocusToChild() => first child (0x%08x)."), +#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); + if (btn) + { + wxRadioButton* selected = wxGetSelectedButtonInGroup(btn); + if (selected) + child = selected; + } +#endif // __WXMSW__ + + wxLogTrace(TRACE_FOCUS, + wxT("SetFocusToChild() => first child (0x%p)."), child->GetHandle()); - *childLastFocused = child; // should be redundant, but it is not - child->SetFocus(); - return TRUE; + if (childLastFocused) + *childLastFocused = child; + child->SetFocusFromKbd(); + return true; } - - node = node->GetNext(); } - return FALSE; + return false; } +