Rework the wxCusor ctor taking wx stock number to provide as many cursors as

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

diff --git a/src/common/containr.cpp b/src/common/containr.cpp
index 67823965b2bb82d5a93ea283aa7233d59a5359fd..f2d237a36d8f2766b9e9a965eda2876b4f0aba1b 100644 (file)
--- a/src/common/containr.cpp
+++ b/src/common/containr.cpp
@@ -17,10 +17,6 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #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"
 


@@ -28,78 +24,69 @@
     #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")

 
 // ============================================================================
 // 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 )
-            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
+        if ( !m_winParent->IsClientAreaChild(child) )
+            continue;

 
 

-        while ( node )
-        {
-            wxWindow *child = node->GetData();
+        if ( child->CanAcceptFocus() )
+            return true;
+    }

 
 

-            if ( child->AcceptsFocus() )
-            {
-                return true;
-            }
+    return false;
+}

 
 

-#ifdef __WXMAC__
-            wxScrollBar *sb = wxDynamicCast( child , wxScrollBar ) ;
-            if ( sb == NULL || !m_winParent->MacIsWindowScrollbar( sb ) )
-                hasRealChildren = true ;
-#endif
-            node = node->GetNext();
-        }
+#ifndef wxHAS_NATIVE_TAB_TRAVERSAL

 
 

-#ifdef __WXMAC__
-        if ( !hasRealChildren )
-            return true ;
-#endif
-    }
+// ----------------------------------------------------------------------------
+// generic wxControlContainer
+// ----------------------------------------------------------------------------

 
 

-    return false;
+wxControlContainer::wxControlContainer()
+{
+    m_winLastFocused = NULL;
+    m_inSetFocus = false;

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


@@ -133,28 +120,32 @@ 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"));

         }
     }
 
     // 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);
+        }

     }
 }
 
 // --------------------------------------------------------------------
     }
 }
 
 // --------------------------------------------------------------------

-// The following four functions are used to find other radio buttons 
+// The following four functions are used to find other radio buttons

 // within the same group. Used by wxSetFocusToChild on wxMSW
 // --------------------------------------------------------------------
 
 // within the same group. Used by wxSetFocusToChild on wxMSW
 // --------------------------------------------------------------------
 


@@ -180,14 +171,14 @@ wxRadioButton* wxGetPreviousButtonInGroup(wxRadioButton *btn)
 
         nodeBefore = nodeBefore->GetPrevious();
     }
 
         nodeBefore = nodeBefore->GetPrevious();
     }

-    
+

     if (!prevBtn || prevBtn->HasFlag(wxRB_SINGLE))
     {
         // no more buttons in group
         return NULL;
     }
     if (!prevBtn || prevBtn->HasFlag(wxRB_SINGLE))
     {
         // no more buttons in group
         return NULL;
     }

-    else
-        return prevBtn;
+
+    return prevBtn;

 }
 
 wxRadioButton* wxGetNextButtonInGroup(wxRadioButton *btn)
 }
 
 wxRadioButton* wxGetNextButtonInGroup(wxRadioButton *btn)


@@ -216,8 +207,8 @@ wxRadioButton* wxGetNextButtonInGroup(wxRadioButton *btn)
         // no more buttons or the first button of the next group
         return NULL;
     }
         // no more buttons or the first button of the next group
         return NULL;
     }

-    else
-        return nextBtn;
+
+    return nextBtn;

 }
 
 wxRadioButton* wxGetFirstButtonInGroup(wxRadioButton *btn)
 }
 
 wxRadioButton* wxGetFirstButtonInGroup(wxRadioButton *btn)


@@ -227,11 +218,23 @@ wxRadioButton* wxGetFirstButtonInGroup(wxRadioButton *btn)
         wxRadioButton* prevBtn = wxGetPreviousButtonInGroup(btn);
         if (!prevBtn)
             return btn;
         wxRadioButton* prevBtn = wxGetPreviousButtonInGroup(btn);
         if (!prevBtn)
             return btn;

-        
+

         btn = prevBtn;
     }
 }
 
         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
 wxRadioButton* wxGetSelectedButtonInGroup(wxRadioButton *btn)
 {
     // Find currently selected button


@@ -256,7 +259,7 @@ wxRadioButton* wxGetSelectedButtonInGroup(wxRadioButton *btn)
     return NULL;
 }
 
     return NULL;
 }
 

-#endif __WXMSW__
+#endif // __WXMSW__

 
 // ----------------------------------------------------------------------------
 // Keyboard handling - this is the place where the TAB traversal logic is
 
 // ----------------------------------------------------------------------------
 // Keyboard handling - this is the place where the TAB traversal logic is


@@ -275,6 +278,49 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event )
 
     const wxWindowList& children = m_winParent->GetChildren();
 
 
     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() )


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


@@ -308,11 +354,8 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event )
 
         // 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();

-
-        // we want to cycle over all nodes
-        start_node = wxWindowList::compatibility_iterator();

     }
     }

-    else
+    else // going up

     {
         // try to find the child which has the focus currently
 
     {
         // try to find the child which has the focus currently
 


@@ -330,7 +373,7 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event )
         if ( winFocus )
         {
 #ifdef __WXMSW__
         if ( winFocus )
         {
 #ifdef __WXMSW__

-            // If we are in a radio button group, start from the first item in the 
+            // 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);
             // group
             if ( event.IsFromTab() && wxIsKindOf(winFocus, wxRadioButton ) )
                 winFocus = wxGetFirstButtonInGroup((wxRadioButton*)winFocus);


@@ -338,10 +381,6 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event )
             // 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 );
         }

-        else
-        {
-            start_node = wxWindowList::compatibility_iterator();
-        }

 
         if ( !start_node && m_winLastFocused )
         {
 
         if ( !start_node && m_winLastFocused )
         {


@@ -362,14 +401,24 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event )
     }
 
     // we want to cycle over all elements passing by NULL
     }
 
     // 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 )
         {
         // 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 )
             {
             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
                 // 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


@@ -403,39 +452,62 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event )
         wxWindow *child = node->GetData();
 
 #ifdef __WXMSW__
         wxWindow *child = node->GetData();
 
 #ifdef __WXMSW__

-        bool canSelectRadioButton = true;
-        if (!event.IsFromTab())
+        if ( event.IsFromTab() )

         {
         {

-            // If navigating using cursor keys, make sure not to navigate out of a radio button group.
-            if (m_winLastFocused && wxIsKindOf(m_winLastFocused, wxRadioButton))
+            if ( wxIsKindOf(child, wxRadioButton) )

             {
             {

-                if (!wxIsKindOf(child, wxRadioButton))
+                // only radio buttons with either wxRB_GROUP or wxRB_SINGLE
+                // can be tabbed to
+                if ( child->HasFlag(wxRB_GROUP) )

                 {
                 {

-                    child = forward ? 
-                                wxGetNextButtonInGroup((wxRadioButton*)m_winLastFocused) : 
-                                wxGetPreviousButtonInGroup((wxRadioButton*)m_winLastFocused);
-                    if (!child)
-                    {
-                        event.Skip(false);
-                        return;
-                    }
+                    // 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
+        else if ( m_winLastFocused &&
+                  wxIsKindOf(m_winLastFocused, wxRadioButton) &&
+                  !m_winLastFocused->HasFlag(wxRB_SINGLE) )

         {
         {

-            // If navigating using tabs, skip all but the first radio button in a group.
-            if (wxIsKindOf(child, wxRadioButton))
+            // 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 )

             {
             {

-                if (wxGetPreviousButtonInGroup((wxRadioButton*)child))
-                    canSelectRadioButton = false;
+                // must be a group consisting of only one button therefore
+                // no need to send a navigation event
+                event.Skip(false);
+                return;

             }
         }
             }
         }

-#else
-        static bool canSelectRadioButton = true;
-#endif
+#endif // __WXMSW__

 
 

-        if ( child->AcceptsFocusFromKeyboard() && canSelectRadioButton )
+        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


@@ -443,18 +515,6 @@ void wxControlContainer::HandleOnNavigationKey( wxNavigationKeyEvent& event )
             // direction we're coming
             event.SetEventObject(m_winParent);
 
             // direction we're coming
             event.SetEventObject(m_winParent);
 

-#if defined(__WXMSW__)
-            // we need to hop to the next activated
-            // radio button, not just the next radio
-            // button under MSW
-            if (wxIsKindOf(child, wxRadioButton) && event.IsFromTab())
-            {
-                wxRadioButton *rb = wxGetSelectedButtonInGroup((wxRadioButton*)child);
-                if (rb)
-                    child = rb;
-            }
-#endif // __WXMSW__
-

             // disable propagation for this call as otherwise the event might
             // bounce back to us.
             wxPropagationDisabler disableProp(event);
             // disable propagation for this call as otherwise the event might
             // bounce back to us.
             wxPropagationDisabler disableProp(event);


@@ -486,12 +546,6 @@ 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;

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -500,8 +554,8 @@ 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;
 
     if (m_inSetFocus)
         return true;


@@ -541,8 +595,8 @@ bool wxControlContainer::DoSetFocus()
 
 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();


@@ -571,9 +625,9 @@ 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
 
             // not SetFocusFromKbd(): we're restoring focus back to the old
             // window and not setting it as the result of a kbd action


@@ -592,11 +646,16 @@ 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__
         {
 #ifdef __WXMSW__

-            // If a radiobutton is the first focusable child, search for the 
+            // If a radiobutton is the first focusable child, search for the

             // selected radiobutton in the same group
             wxRadioButton* btn = wxDynamicCast(child, wxRadioButton);
             if (btn)
             // selected radiobutton in the same group
             wxRadioButton* btn = wxDynamicCast(child, wxRadioButton);
             if (btn)


@@ -607,18 +666,17 @@ bool wxSetFocusToChild(wxWindow *win, wxWindow **childLastFocused)
             }
 #endif
 
             }
 #endif
 

-            wxLogTrace(_T("focus"),
-                       _T("SetFocusToChild() => first child (0x%08lx)."),
-                       (unsigned long)child->GetHandle());
+            wxLogTrace(TRACE_FOCUS,
+                       _T("SetFocusToChild() => first child (0x%p)."),
+                       child->GetHandle());

 
             *childLastFocused = child;
             child->SetFocusFromKbd();
             return true;
         }
 
             *childLastFocused = child;
             child->SetFocusFromKbd();
             return true;
         }

-
-        node = node->GetNext();

     }
 
     return false;
 }
 
     }
 
     return false;
 }
 

+#endif // !wxHAS_NATIVE_TAB_TRAVERSAL