1. derive wxGTK wxRadioBox from wxRadioBoxBase now, as in all other ports

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

diff --git a/src/common/containr.cpp b/src/common/containr.cpp
index f695be633494eb9a769677886b1d77683b100be3..b4b63b63afa1cb859b87de144eeb7b81072df14b 100644 (file)
--- a/src/common/containr.cpp
+++ b/src/common/containr.cpp
@@ -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"
 


@@ -40,6 +36,13 @@
     #include "wx/scrolbar.h"
 #endif
 
     #include "wx/scrolbar.h"
 #endif
 

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

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


@@ -51,6 +54,7 @@ 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
 }
 
 bool wxControlContainer::AcceptsFocus() const


@@ -63,21 +67,21 @@ bool wxControlContainer::AcceptsFocus() const
         // at least one child will accept focus
         wxWindowList::compatibility_iterator node = m_winParent->GetChildren().GetFirst();
         if ( !node )
         // at least one child will accept focus
         wxWindowList::compatibility_iterator node = m_winParent->GetChildren().GetFirst();
         if ( !node )

-            return TRUE;
+            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
 
 #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() )
             {
         while ( node )
         {
             wxWindow *child = node->GetData();
 
             if ( child->AcceptsFocus() )
             {

-                return TRUE;
+                return true;

             }
 
 #ifdef __WXMAC__
             }
 
 #ifdef __WXMAC__


@@ -87,14 +91,14 @@ bool wxControlContainer::AcceptsFocus() const
 #endif
             node = node->GetNext();
         }
 #endif
             node = node->GetNext();
         }

-        
+

 #ifdef __WXMAC__
         if ( !hasRealChildren )
 #ifdef __WXMAC__
         if ( !hasRealChildren )

-            return TRUE ;
+            return true ;

 #endif
     }
 
 #endif
     }
 

-    return FALSE;
+    return false;

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


@@ -128,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"));

         }
     }
 
         }
     }
 


@@ -148,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


@@ -219,6 +340,12 @@ 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 );
         }
             // ok, we found the focus - now is it our child?
             start_node = children.Find( winFocus );
         }


@@ -286,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


@@ -293,6 +476,10 @@ 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) )
             {
                 // set it first in case SetFocusFromKbd() results in focus
             if ( !child->GetEventHandler()->ProcessEvent(event) )
             {
                 // set it first in case SetFocusFromKbd() results in focus


@@ -304,7 +491,7 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event )
             }
             //else: the child manages its focus itself
 
             }
             //else: the child manages its focus itself
 

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

 
             return;
         }
 
             return;
         }


@@ -335,8 +522,11 @@ 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());
+    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
 
     // 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


@@ -348,7 +538,7 @@ bool wxControlContainer::DoSetFocus()
         if ( win == m_winParent )
         {
             // our child already has focus, don't take it away from it
         if ( win == m_winParent )
         {
             // our child already has focus, don't take it away from it

-            return TRUE;
+            return true;

         }
 
         if ( win->IsTopLevel() )
         }
 
         if ( win->IsTopLevel() )


@@ -361,13 +551,20 @@ 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() );
 
     DoSetFocus();
                m_winParent->GetName().c_str() );
 
     DoSetFocus();


@@ -387,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 )


@@ -396,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
         {


@@ -420,18 +617,30 @@ bool wxSetFocusToChild(wxWindow *win, wxWindow **childLastFocused)
 
         if ( child->AcceptsFocusFromKeyboard() && !child->IsTopLevel() )
         {
 
         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;
             child->SetFocusFromKbd();
 
             *childLastFocused = child;
             child->SetFocusFromKbd();

-            return TRUE;
+            return true;

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

-    return FALSE;
+    return false;

 }
 
 }