- Rewrite wxHeaderCtrl to be virtual-like: even if we don't need an infinite

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

diff --git a/src/common/containr.cpp b/src/common/containr.cpp
index 55b6109a9b29e768fc260c092c7c319338b2b124..06ada8e7a298b42c4d224ad8b48cb1052c7dd19f 100644 (file)
--- a/src/common/containr.cpp
+++ b/src/common/containr.cpp
@@ -24,21 +24,17 @@
     #pragma hdrstop
 #endif
 
     #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"
 #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"
     #include "wx/scrolbar.h"

-#endif
-
-#ifdef __WXMSW__

     #include "wx/radiobut.h"
     #include "wx/radiobut.h"

-#endif
+#endif //WX_PRECOMP

 
 // trace mask for focus messages
 #define TRACE_FOCUS _T("focus")
 
 // trace mask for focus messages
 #define TRACE_FOCUS _T("focus")


@@ -47,58 +43,95 @@
 // implementation
 // ============================================================================
 
 // implementation
 // ============================================================================
 

-wxControlContainer::wxControlContainer(wxWindow *winParent)
+// ----------------------------------------------------------------------------
+// wxControlContainerBase
+// ----------------------------------------------------------------------------
+
+void wxControlContainerBase::SetCanFocus(bool acceptsFocus)

 {
 {

-    m_winParent = winParent;
+    if ( acceptsFocus == m_acceptsFocus )
+        return;

 
 

-    m_winLastFocused =
-    m_winTmpDefault =
-    m_winDefault = NULL;
-    m_inSetFocus = false;
+    m_acceptsFocus = acceptsFocus;
+
+    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::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;
             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, _T("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)
 }
 
 void wxControlContainer::SetLastFocus(wxWindow *win)


@@ -143,12 +176,16 @@ void wxControlContainer::SetLastFocus(wxWindow *win)
     }
 
     // propagate the last focus upwards so that our parent can set focus back
     }
 
     // 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() )

     {
     {

-        wxChildFocusEvent eventFocus(m_winParent);
-        parent->GetEventHandler()->ProcessEvent(eventFocus);
+        wxWindow *parent = m_winParent->GetParent();
+        if ( parent )
+        {
+            wxChildFocusEvent eventFocus(m_winParent);
+            parent->GetEventHandler()->ProcessEvent(eventFocus);
+        }

     }
 }
 
     }
 }
 


@@ -157,7 +194,7 @@ void wxControlContainer::SetLastFocus(wxWindow *win)
 // within the same group. Used by wxSetFocusToChild on wxMSW
 // --------------------------------------------------------------------
 
 // within the same group. Used by wxSetFocusToChild on wxMSW
 // --------------------------------------------------------------------
 

-#ifdef __WXMSW__
+#if defined(__WXMSW__) && wxUSE_RADIOBTN

 
 wxRadioButton* wxGetPreviousButtonInGroup(wxRadioButton *btn)
 {
 
 wxRadioButton* wxGetPreviousButtonInGroup(wxRadioButton *btn)
 {


@@ -279,13 +316,59 @@ wxRadioButton* wxGetSelectedButtonInGroup(wxRadioButton *btn)
 
 void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event )
 {
 
 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();
 
 
     // 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() )
     // 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() )


@@ -337,12 +420,12 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event )
 
         if ( winFocus )
         {
 
         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);
             // 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 );
         }
             // ok, we found the focus - now is it our child?
             start_node = children.Find( winFocus );
         }


@@ -369,12 +452,18 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event )
     for ( ;; )
     {
         // don't go into infinite loop
     for ( ;; )
     {
         // don't go into infinite loop

-        if ( start_node && node == start_node )
+        if ( start_node && node && node == start_node )

             break;
 
         // Have we come to the last or first item on the panel?
         if ( !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 (maybe grand) parent is another panel: if this
             if ( !goingDown )
             {
                 // Check if our (maybe grand) parent is another panel: if this


@@ -410,7 +499,15 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event )
 
         wxWindow *child = node->GetData();
 
 
         wxWindow *child = node->GetData();
 

-#ifdef __WXMSW__
+        // 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) )
         if ( event.IsFromTab() )
         {
             if ( wxIsKindOf(child, wxRadioButton) )


@@ -435,24 +532,27 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event )
                   wxIsKindOf(m_winLastFocused, wxRadioButton) &&
                   !m_winLastFocused->HasFlag(wxRB_SINGLE) )
         {
                   wxIsKindOf(m_winLastFocused, wxRadioButton) &&
                   !m_winLastFocused->HasFlag(wxRB_SINGLE) )
         {

+            wxRadioButton * const
+                lastBtn = 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 )
             {
             // 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);
+                child = wxGetNextButtonInGroup(lastBtn);

                 if ( !child )
                 {
                     // no next button in group, set it to the first button
                 if ( !child )
                 {
                     // no next button in group, set it to the first button

-                    child = wxGetFirstButtonInGroup((wxRadioButton*)m_winLastFocused);
+                    child = wxGetFirstButtonInGroup(lastBtn);

                 }
             }
             else
             {
                 }
             }
             else
             {

-                child = wxGetPreviousButtonInGroup((wxRadioButton*)m_winLastFocused);
+                child = wxGetPreviousButtonInGroup(lastBtn);

                 if ( !child )
                 {
                     // no previous button in group, set it to the last button
                 if ( !child )
                 {
                     // no previous button in group, set it to the last button

-                    child = wxGetLastButtonInGroup((wxRadioButton*)m_winLastFocused);
+                    child = wxGetLastButtonInGroup(lastBtn);

                 }
             }
 
                 }
             }
 


@@ -466,7 +566,7 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event )
         }
 #endif // __WXMSW__
 
         }
 #endif // __WXMSW__
 

-        if ( child->AcceptsFocusFromKeyboard() )
+        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
         {
             // 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


@@ -505,59 +605,12 @@ void wxControlContainer::HandleOnWindowDestroy(wxWindowBase *child)
 {
     if ( child == m_winLastFocused )
         m_winLastFocused = NULL;
 {
     if ( child == m_winLastFocused )
         m_winLastFocused = NULL;

-
-    if ( child == m_winDefault )
-        m_winDefault = NULL;
-
-    if ( child == m_winTmpDefault )
-        m_winTmpDefault = NULL;

 }
 
 // ----------------------------------------------------------------------------
 // focus handling
 // ----------------------------------------------------------------------------
 
 }
 
 // ----------------------------------------------------------------------------
 // focus handling
 // ----------------------------------------------------------------------------
 

-bool wxControlContainer::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;
-        }
-
-        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(TRACE_FOCUS, _T("OnFocus on wxPanel 0x%p, name: %s"),
 void wxControlContainer::HandleOnFocus(wxFocusEvent& event)
 {
     wxLogTrace(TRACE_FOCUS, _T("OnFocus on wxPanel 0x%p, name: %s"),


@@ -569,11 +622,18 @@ void wxControlContainer::HandleOnFocus(wxFocusEvent& event)
     event.Skip();
 }
 
     event.Skip();
 }
 

+
+#else
+  // wxHAS_NATIVE_TAB_TRAVERSAL
+

 bool wxControlContainer::SetFocusToChild()
 {
 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
 // ----------------------------------------------------------------------------
 // SetFocusToChild(): this function is used by wxPanel but also by wxFrame in
 // wxMSW, this is why it is outside of wxControlContainer class


@@ -582,10 +642,10 @@ bool wxControlContainer::SetFocusToChild()
 bool wxSetFocusToChild(wxWindow *win, wxWindow **childLastFocused)
 {
     wxCHECK_MSG( win, false, _T("wxSetFocusToChild(): invalid window") );
 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( childLastFocused, false,
+    //             _T("wxSetFocusToChild(): NULL child poonter") );

 
 

-    if ( *childLastFocused )
+    if ( childLastFocused && *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 )


@@ -611,10 +671,15 @@ bool wxSetFocusToChild(wxWindow *win, wxWindow **childLastFocused)
     while ( node )
     {
         wxWindow *child = node->GetData();
     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() )

         {
         {

-#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);
             // If a radiobutton is the first focusable child, search for the
             // selected radiobutton in the same group
             wxRadioButton* btn = wxDynamicCast(child, wxRadioButton);


@@ -624,18 +689,17 @@ bool wxSetFocusToChild(wxWindow *win, wxWindow **childLastFocused)
                 if (selected)
                     child = selected;
             }
                 if (selected)
                     child = selected;
             }

-#endif
+#endif // __WXMSW__

 
             wxLogTrace(TRACE_FOCUS,
                        _T("SetFocusToChild() => first child (0x%p)."),
                        child->GetHandle());
 
 
             wxLogTrace(TRACE_FOCUS,
                        _T("SetFocusToChild() => first child (0x%p)."),
                        child->GetHandle());
 

-            *childLastFocused = child;
+            if (childLastFocused)
+                *childLastFocused = child;

             child->SetFocusFromKbd();
             return true;
         }
             child->SetFocusFromKbd();
             return true;
         }

-
-        node = node->GetNext();

     }
 
     return false;
     }
 
     return false;