Add missing WXK constants for the control keys

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

diff --git a/src/common/containr.cpp b/src/common/containr.cpp
index a7de0bd423e71e1201923a408b818dd0f925ed8c..ecc7570e708ac2886a6183a6188ad59d2ec94c3a 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 licence
+// Licence:     wxWindows licence

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


@@ -37,7 +37,7 @@
 #endif //WX_PRECOMP
 
 // trace mask for focus messages
 #endif //WX_PRECOMP
 
 // trace mask for focus messages

-#define TRACE_FOCUS _T("focus")
+#define TRACE_FOCUS wxT("focus")

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


@@ -47,44 +47,83 @@
 // wxControlContainerBase
 // ----------------------------------------------------------------------------
 
 // wxControlContainerBase
 // ----------------------------------------------------------------------------
 

-void wxControlContainerBase::SetCanFocus(bool acceptsFocus)
+bool wxControlContainerBase::UpdateCanFocusChildren()

 {
 {

-    if ( acceptsFocus == m_acceptsFocus )
-        return;
+    const bool acceptsFocusChildren = HasAnyFocusableChildren();
+    if ( acceptsFocusChildren != m_acceptsFocusChildren )
+    {
+        m_acceptsFocusChildren = acceptsFocusChildren;

 
 

-    m_acceptsFocus = acceptsFocus;
+        m_winParent->SetCanFocus(AcceptsFocusRecursively());
+    }

 
 

-    m_winParent->SetCanFocus(m_acceptsFocus);
+    return m_acceptsFocusChildren;

 }
 
 }
 

-// if the window has a focusable child, it shouldn't be focusable itself (think
-// of wxPanel used for grouping different controls) but if it doesn't have any
-// (focusable) children, then it should be possible to give it focus (think of
-// wxGrid or generic wxListCtrl)
-bool wxControlContainerBase::ShouldAcceptFocus() const
+bool wxControlContainerBase::HasAnyFocusableChildren() const

 {
 {

-    // 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
-    // accepts focus
-    wxWindowList::compatibility_iterator node = m_winParent->GetChildren().GetFirst();
-    if ( !node )
-        return true;
-
-    while ( node )
+    const wxWindowList& children = m_winParent->GetChildren();
+    for ( wxWindowList::const_iterator i = children.begin(),
+                                     end = children.end();
+          i != end;
+          ++i )

     {
     {

-        wxWindow *child = node->GetData();
-        node = node->GetNext();
+        const wxWindow * const child = *i;

 
 

-#ifdef __WXMAC__
-        if ( m_winParent->MacIsWindowScrollbar( child ) )
+        if ( !m_winParent->IsClientAreaChild(child) )

             continue;
             continue;

-#endif

 
         if ( child->CanAcceptFocus() )
 
         if ( child->CanAcceptFocus() )

-            return false;
+            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();

     }
 
     }
 

-    return true;
+    // 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
 }
 
 #ifndef wxHAS_NATIVE_TAB_TRAVERSAL


@@ -96,7 +135,6 @@ bool wxControlContainerBase::ShouldAcceptFocus() const
 wxControlContainer::wxControlContainer()
 {
     m_winLastFocused = NULL;
 wxControlContainer::wxControlContainer()
 {
     m_winLastFocused = NULL;

-    m_inSetFocus = false;

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


@@ -122,7 +160,7 @@ void wxControlContainer::SetLastFocus(wxWindow *win)
                 // (under wxGTK)
 
                 wxASSERT_MSG( winParent,
                 // (under wxGTK)
 
                 wxASSERT_MSG( winParent,

-                              _T("Setting last focus for a window that is not our child?") );
+                              wxT("Setting last focus for a window that is not our child?") );

             }
         }
 
             }
         }
 


@@ -130,26 +168,13 @@ void wxControlContainer::SetLastFocus(wxWindow *win)
 
         if ( win )
         {
 
         if ( win )
         {

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

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

-            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; 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);
+            wxLogTrace(TRACE_FOCUS, wxT("No more last focus"));

         }
     }
 }
         }
     }
 }


@@ -159,7 +184,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)
 {


@@ -168,7 +193,7 @@ wxRadioButton* wxGetPreviousButtonInGroup(wxRadioButton *btn)
 
     const wxWindowList& siblings = btn->GetParent()->GetChildren();
     wxWindowList::compatibility_iterator nodeThis = siblings.Find(btn);
 
     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?") );
+    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();
 
     // Iterate over all previous siblings until we find the next radio button
     wxWindowList::compatibility_iterator nodeBefore = nodeThis->GetPrevious();


@@ -198,7 +223,7 @@ wxRadioButton* wxGetNextButtonInGroup(wxRadioButton *btn)
 
     const wxWindowList& siblings = btn->GetParent()->GetChildren();
     wxWindowList::compatibility_iterator nodeThis = siblings.Find(btn);
 
     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?") );
+    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();
 
     // Iterate over all previous siblings until we find the next radio button
     wxWindowList::compatibility_iterator nodeNext = nodeThis->GetNext();


@@ -281,7 +306,10 @@ 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;
 
     // the event is propagated downwards if the event emitter was our parent
     bool goingDown = event.GetEventObject() == parent;


@@ -360,7 +388,7 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event )
     {
         // just to be sure it's not used (normally this is not necessary, but
         // doesn't hurt neither)
     {
         // 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();
 
         // start from first or last depending on where we're going
         node = forward ? children.GetFirst() : children.GetLast();


@@ -382,12 +410,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 );
         }


@@ -434,18 +462,21 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event )
                 // looping inside this panel (normally, the focus will go to
                 // the next/previous item after this panel in the parent
                 // panel).
                 // 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 )
                 {
                 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;
 
                         break;
 

-                    event.SetCurrentFocus( focussed_child_of_parent );
+                    event.SetCurrentFocus( focusedParent );

                     if ( parent->GetEventHandler()->ProcessEvent( event ) )
                         return;
 
                     if ( parent->GetEventHandler()->ProcessEvent( event ) )
                         return;
 

-                    focussed_child_of_parent = parent;
+                    focusedParent = parent;

 
                     parent = parent->GetParent();
                 }
 
                     parent = parent->GetParent();
                 }


@@ -461,7 +492,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) )


@@ -486,24 +525,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);

                 }
             }
 
                 }
             }
 


@@ -562,50 +604,9 @@ void wxControlContainer::HandleOnWindowDestroy(wxWindowBase *child)
 // 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)
 {
 void wxControlContainer::HandleOnFocus(wxFocusEvent& event)
 {

-    wxLogTrace(TRACE_FOCUS, _T("OnFocus on wxPanel 0x%p, name: %s"),
+    wxLogTrace(TRACE_FOCUS, wxT("OnFocus on wxPanel 0x%p, name: %s"),

                m_winParent->GetHandle(),
                m_winParent->GetName().c_str() );
 
                m_winParent->GetHandle(),
                m_winParent->GetName().c_str() );
 


@@ -614,11 +615,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


@@ -626,28 +634,50 @@ 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,
-                 _T("wxSetFocusToChild(): NULL child poonter") );
+    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
         if ( (*childLastFocused)->GetParent() == win )
         {
     {
         // It might happen that the window got reparented
         if ( (*childLastFocused)->GetParent() == win )
         {

-            wxLogTrace(TRACE_FOCUS,
-                       _T("SetFocusToChild() => last child (0x%p)."),
-                       (*childLastFocused)->GetHandle());
+            // And it also could have become hidden in the meanwhile
+            // We want to focus on the deepest widget visible
+            wxWindow *deepestVisibleWindow = NULL;

 
 

-            // 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;
+            while ( *childLastFocused )
+            {
+                if ( (*childLastFocused)->IsShown() )
+                {
+                    if ( !deepestVisibleWindow )
+                        deepestVisibleWindow = *childLastFocused;
+                }
+                else
+                    deepestVisibleWindow = NULL;
+
+                *childLastFocused = (*childLastFocused)->GetParent();
+            }
+
+            if ( deepestVisibleWindow )
+            {
+                *childLastFocused = deepestVisibleWindow;
+
+                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
         }
         else
         {
             // it doesn't count as such any more

-            *childLastFocused = (wxWindow *)NULL;
+            *childLastFocused = NULL;

         }
     }
 
         }
     }
 


@@ -658,14 +688,13 @@ bool wxSetFocusToChild(wxWindow *win, wxWindow **childLastFocused)
         wxWindow *child = node->GetData();
         node = node->GetNext();
 
         wxWindow *child = node->GetData();
         node = node->GetNext();
 

-#ifdef __WXMAC__
-        if ( child->GetParent()->MacIsWindowScrollbar( child ) )
+        // skip special windows:
+        if ( !win->IsClientAreaChild(child) )

             continue;
             continue;

-#endif
-        
+

         if ( child->CanAcceptFocusFromKeyboard() && !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);


@@ -675,13 +704,14 @@ bool wxSetFocusToChild(wxWindow *win, wxWindow **childLastFocused)
                 if (selected)
                     child = selected;
             }
                 if (selected)
                     child = selected;
             }

-#endif
+#endif // __WXMSW__

 
             wxLogTrace(TRACE_FOCUS,
 
             wxLogTrace(TRACE_FOCUS,

-                       _T("SetFocusToChild() => first child (0x%p)."),
+                       wxT("SetFocusToChild() => first child (0x%p)."),

                        child->GetHandle());
 
                        child->GetHandle());
 

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

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


@@ -690,4 +720,3 @@ bool wxSetFocusToChild(wxWindow *win, wxWindow **childLastFocused)
     return false;
 }
 
     return false;
 }
 

-#endif // !wxHAS_NATIVE_TAB_TRAVERSAL