fix for bug 1371386, with some minor mods and cleanup

[wxWidgets.git] / src / common / containr.cpp

diff --git a/src/common/containr.cpp b/src/common/containr.cpp
index daf414ce55a1ee02871d79b21615bc057ad35ecd..b4b63b63afa1cb859b87de144eeb7b81072df14b 100644 (file)
--- 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 <zeitlin@dptmaths.ens-cachan.fr>
 // Created:     06.08.01
 // RCS-ID:      $Id$
 // Copyright:   (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>

-// License:     wxWindows license
+// License:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 ///////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================


@@ -17,10 +17,6 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#ifdef __GNUG__
-    #pragma implementation "containr.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -36,6 +32,17 @@
 
 #include "wx/containr.h"
 
 
 #include "wx/containr.h"
 

+#ifdef __WXMAC__
+    #include "wx/scrolbar.h"
+#endif
+
+#ifdef __WXMSW__
+    #include "wx/radiobut.h"
+#endif
+
+// trace mask for focus messages
+#define TRACE_FOCUS _T("focus")
+

 // ============================================================================
 // implementation
 // ============================================================================
 // ============================================================================
 // implementation
 // ============================================================================


@@ -47,6 +54,51 @@ wxControlContainer::wxControlContainer(wxWindow *winParent)
     m_winLastFocused =
     m_winTmpDefault =
     m_winDefault = NULL;
     m_winLastFocused =
     m_winTmpDefault =
     m_winDefault = NULL;

+    m_inSetFocus = false;
+}
+
+bool wxControlContainer::AcceptsFocus() const
+{
+    // if we're not shown or disabled, we can't accept focus
+    if ( m_winParent->IsShown() && m_winParent->IsEnabled() )
+    {
+        // 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 )
+            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
+
+        while ( node )
+        {
+            wxWindow *child = node->GetData();
+
+            if ( child->AcceptsFocus() )
+            {
+                return true;
+            }
+
+#ifdef __WXMAC__
+            wxScrollBar *sb = wxDynamicCast( child , wxScrollBar ) ;
+            if ( sb == NULL || !m_winParent->MacIsWindowScrollbar( sb ) )
+                hasRealChildren = true ;
+#endif
+            node = node->GetNext();
+        }
+
+#ifdef __WXMAC__
+        if ( !hasRealChildren )
+            return true ;
+#endif
+    }
+
+    return false;

 }
 
 void wxControlContainer::SetLastFocus(wxWindow *win)
 }
 
 void wxControlContainer::SetLastFocus(wxWindow *win)


@@ -80,13 +132,13 @@ void wxControlContainer::SetLastFocus(wxWindow *win)
 
         if ( win )
         {
 
         if ( win )
         {

-            wxLogTrace(_T("focus"), _T("Set last focus to %s(%s)"),
+            wxLogTrace(TRACE_FOCUS, _T("Set last focus to %s(%s)"),

                        win->GetClassInfo()->GetClassName(),
                        win->GetLabel().c_str());
         }
         else
         {
                        win->GetClassInfo()->GetClassName(),
                        win->GetLabel().c_str());
         }
         else
         {

-            wxLogTrace(_T("focus"), _T("No more last focus"));
+            wxLogTrace(TRACE_FOCUS, _T("No more last focus"));

         }
     }
 
         }
     }
 


@@ -100,6 +152,123 @@ void wxControlContainer::SetLastFocus(wxWindow *win)
     }
 }
 
     }
 }
 

+// --------------------------------------------------------------------
+// The following four functions are used to find other radio buttons
+// within the same group. Used by wxSetFocusToChild on wxMSW
+// --------------------------------------------------------------------
+
+#ifdef __WXMSW__
+
+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, _T("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, _T("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;
+
+        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
 // ----------------------------------------------------------------------------
 // Keyboard handling - this is the place where the TAB traversal logic is
 // implemented. As this code is common to all ports, this ensures consistent


@@ -137,7 +306,7 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event )
 
     // the node of the children list from which we should start looking for the
     // next acceptable child
 
     // 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
 
     // 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


@@ -152,7 +321,7 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event )
         node = forward ? children.GetFirst() : children.GetLast();
 
         // we want to cycle over all nodes
         node = forward ? children.GetFirst() : children.GetLast();
 
         // we want to cycle over all nodes

-        start_node = (wxWindowList::Node *)NULL;
+        start_node = wxWindowList::compatibility_iterator();

     }
     else
     {
     }
     else
     {


@@ -171,12 +340,18 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event )
 
         if ( winFocus )
         {
 
         if ( winFocus )
         {

+#ifdef __WXMSW__
+            // 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

             // ok, we found the focus - now is it our child?
             start_node = children.Find( winFocus );
         }
         else
         {
             // ok, we found the focus - now is it our child?
             start_node = children.Find( winFocus );
         }
         else
         {

-            start_node = (wxWindowList::Node *)NULL;
+            start_node = wxWindowList::compatibility_iterator();

         }
 
         if ( !start_node && m_winLastFocused )
         }
 
         if ( !start_node && m_winLastFocused )


@@ -238,6 +413,62 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event )
 
         wxWindow *child = node->GetData();
 
 
         wxWindow *child = node->GetData();
 

+#ifdef __WXMSW__
+        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) )
+        {
+            // cursor keys don't navigate out of a radio button group so
+            // find the correct radio button to focus
+            if ( forward )
+            {
+                child = wxGetNextButtonInGroup((wxRadioButton*)m_winLastFocused);
+                if ( !child )
+                {
+                    // no next button in group, set it to the first button
+                    child = wxGetFirstButtonInGroup((wxRadioButton*)m_winLastFocused);
+                }
+            }
+            else
+            {
+                child = wxGetPreviousButtonInGroup((wxRadioButton*)m_winLastFocused);
+                if ( !child )
+                {
+                    // no previous button in group, set it to the last button
+                    child = wxGetLastButtonInGroup((wxRadioButton*)m_winLastFocused);
+                }
+            }
+
+            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->AcceptsFocusFromKeyboard() )
         {
             // if we're setting the focus to a child panel we should prevent it
         if ( child->AcceptsFocusFromKeyboard() )
         {
             // if we're setting the focus to a child panel we should prevent it


@@ -245,16 +476,22 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event )
             // and instead give it to the first/last child depending from which
             // direction we're coming
             event.SetEventObject(m_winParent);
             // 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) )
             {
             if ( !child->GetEventHandler()->ProcessEvent(event) )
             {

+                // set it first in case SetFocusFromKbd() results in focus
+                // change too
+                m_winLastFocused = child;
+

                 // everything is simple: just give focus to it
                 child->SetFocusFromKbd();
                 // everything is simple: just give focus to it
                 child->SetFocusFromKbd();

-
-                m_winLastFocused = child;

             }
             //else: the child manages its focus itself
 
             }
             //else: the child manages its focus itself
 

-            event.Skip( FALSE );
+            event.Skip( false );

 
             return;
         }
 
             return;
         }


@@ -285,42 +522,24 @@ void wxControlContainer::HandleOnWindowDestroy(wxWindowBase *child)
 
 bool wxControlContainer::DoSetFocus()
 {
 
 bool wxControlContainer::DoSetFocus()
 {

-    wxLogTrace(_T("focus"), _T("SetFocus on wxPanel 0x%08lx."),
-               (unsigned long)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..
-
-    // if our child already has focus, don't take it away from it
+    wxLogTrace(TRACE_FOCUS, _T("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 )
     wxWindow *win = wxWindow::FindFocus();
     while ( win )
     {
         if ( win == m_winParent )

-            return TRUE;
+        {
+            // our child already has focus, don't take it away from it
+            return true;
+        }

 
         if ( win->IsTopLevel() )
         {
 
         if ( win->IsTopLevel() )
         {


@@ -332,19 +551,23 @@ bool wxControlContainer::DoSetFocus()
         win = win->GetParent();
     }
 
         win = win->GetParent();
     }
 

-    return SetFocusToChild();
+    // protect against infinite recursion:
+    m_inSetFocus = true;
+
+    bool ret = SetFocusToChild();
+
+    m_inSetFocus = false;
+
+    return ret;

 }
 
 void wxControlContainer::HandleOnFocus(wxFocusEvent& event)
 {
 }
 
 void wxControlContainer::HandleOnFocus(wxFocusEvent& event)
 {

-    wxLogTrace(_T("focus"), _T("OnFocus on wxPanel 0x%08lx, name: %s"),
-               (unsigned long)m_winParent->GetHandle(),
+    wxLogTrace(TRACE_FOCUS, _T("OnFocus on wxPanel 0x%p, name: %s"),
+               m_winParent->GetHandle(),

                m_winParent->GetName().c_str() );
 
                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();
 }
 
     event.Skip();
 }


@@ -361,8 +584,8 @@ bool wxControlContainer::SetFocusToChild()
 
 bool wxSetFocusToChild(wxWindow *win, wxWindow **childLastFocused)
 {
 
 bool wxSetFocusToChild(wxWindow *win, wxWindow **childLastFocused)
 {

-    wxCHECK_MSG( win, FALSE, _T("wxSetFocusToChild(): invalid window") );
-    wxCHECK_MSG( childLastFocused, FALSE,
+    wxCHECK_MSG( win, false, _T("wxSetFocusToChild(): invalid window") );
+    wxCHECK_MSG( childLastFocused, false,

                  _T("wxSetFocusToChild(): NULL child poonter") );
 
     if ( *childLastFocused )
                  _T("wxSetFocusToChild(): NULL child poonter") );
 
     if ( *childLastFocused )


@@ -370,14 +593,14 @@ bool wxSetFocusToChild(wxWindow *win, wxWindow **childLastFocused)
         // It might happen that the window got reparented
         if ( (*childLastFocused)->GetParent() == win )
         {
         // 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());
+            wxLogTrace(TRACE_FOCUS,
+                       _T("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();
 
             // 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;
+            return true;

         }
         else
         {
         }
         else
         {


@@ -387,24 +610,37 @@ bool wxSetFocusToChild(wxWindow *win, wxWindow **childLastFocused)
     }
 
     // set the focus to the first child who wants it
     }
 
     // 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();
 
         if ( child->AcceptsFocusFromKeyboard() && !child->IsTopLevel() )
         {
     while ( node )
     {
         wxWindow *child = node->GetData();
 
         if ( child->AcceptsFocusFromKeyboard() && !child->IsTopLevel() )
         {

-            wxLogTrace(_T("focus"),
-                       _T("SetFocusToChild() => first child (0x%08lx)."),
-                       (unsigned long)child->GetHandle());
+#ifdef __WXMSW__
+            // 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
+
+            wxLogTrace(TRACE_FOCUS,
+                       _T("SetFocusToChild() => first child (0x%p)."),
+                       child->GetHandle());

 
 

-            *childLastFocused = child;  // should be redundant, but it is not
+            *childLastFocused = child;

             child->SetFocusFromKbd();
             child->SetFocusFromKbd();

-            return TRUE;
+            return true;

         }
 
         node = node->GetNext();
     }
 
         }
 
         node = node->GetNext();
     }
 

-    return FALSE;
+    return false;

 }
 }

+