]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/containr.cpp
made wxCharTypeBuffer<T>::release() const again, for compatibility
[wxWidgets.git] / src / common / containr.cpp
index ea61df47e39e24e7437d80c7769129fd1995f89d..43de0255b06a98d0b881e65a8649f950c7ec4a82 100644 (file)
 // headers
 // ----------------------------------------------------------------------------
 
-#ifdef __GNUG__
-    #pragma implementation "containr.h"
-#endif
-
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
     #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 _T("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_winTmpDefault =
-    m_winDefault = NULL;
+    m_winParent->SetCanFocus(m_acceptsFocus);
 }
 
-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::Node *node = m_winParent->GetChildren().GetFirst();
-        if ( !node )
-            return TRUE;
+        const wxWindow * const child = *i;
 
-#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 ( !m_winParent->IsClientAreaChild(child) )
+            continue;
 
-            if ( child->AcceptsFocus() )
-            {
-                return TRUE;
-            }
+        if ( child->CanAcceptFocus() )
+            return true;
+    }
 
-#ifdef __WXMAC__
-            wxScrollBar *sb = wxDynamicCast( child , wxScrollBar ) ;
-            if ( sb == NULL || !m_winParent->MacIsWindowScrollbar( sb ) )
-                hasRealChildren = true ;
-#endif
-            node = node->GetNext();
+    return false;
+}
+
+bool wxControlContainerBase::DoSetFocus()
+{
+    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 )
+        {
+            // 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)
@@ -124,26 +165,147 @@ void wxControlContainer::SetLastFocus(wxWindow *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
         {
-            wxLogTrace(_T("focus"), _T("No more last focus"));
+            wxLogTrace(TRACE_FOCUS, _T("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 )
+    // 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, _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)
     {
-        wxChildFocusEvent eventFocus(m_winParent);
-        parent->GetEventHandler()->ProcessEvent(eventFocus);
+        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
@@ -154,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() )
@@ -177,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
@@ -194,11 +402,8 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event )
 
         // 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
 
@@ -215,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 )
         {
@@ -242,14 +449,24 @@ 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
@@ -282,13 +499,84 @@ 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 = wx_static_cast(wxRadioButton *, 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) )
             {
                 // set it first in case SetFocusFromKbd() results in focus
@@ -300,7 +588,7 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event )
             }
             //else: the child manages its focus itself
 
-            event.Skip( FALSE );
+            event.Skip( false );
 
             return;
         }
@@ -317,53 +605,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());
-
-    // 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();
-    }
-
-    return SetFocusToChild();
-}
-
 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();
@@ -371,11 +622,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
@@ -383,23 +641,23 @@ 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, _T("wxSetFocusToChild(): invalid window") );
+    //    wxCHECK_MSG( childLastFocused, false,
+    //             _T("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());
+            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();
-            return TRUE;
+            return true;
         }
         else
         {
@@ -409,25 +667,41 @@ bool wxSetFocusToChild(wxWindow *win, wxWindow **childLastFocused)
     }
 
     // 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%08lx)."),
-                       (unsigned long)child->GetHandle());
+#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__
 
-            *childLastFocused = child;
+            wxLogTrace(TRACE_FOCUS,
+                       _T("SetFocusToChild() => first child (0x%p)."),
+                       child->GetHandle());
+
+            if (childLastFocused)
+                *childLastFocused = child;
             child->SetFocusFromKbd();
-            return TRUE;
+            return true;
         }
-
-        node = node->GetNext();
     }
 
-    return FALSE;
+    return false;
 }