applied patch 890642: wxRE_ADVANCED flag and docs

[wxWidgets.git] / src / msw / notebook.cpp

diff --git a/src/msw/notebook.cpp b/src/msw/notebook.cpp
index 79031889e27c48b1b1bfe5d69876089c2407b6fd..432bcdda679aae0a4ed05cdbd5328253ed3415a1 100644 (file)
--- a/src/msw/notebook.cpp
+++ b/src/msw/notebook.cpp
@@ -111,8 +111,6 @@ BEGIN_EVENT_TABLE(wxNotebook, wxControl)
 
     EVT_SIZE(wxNotebook::OnSize)
 
 
     EVT_SIZE(wxNotebook::OnSize)
 

-    EVT_SET_FOCUS(wxNotebook::OnSetFocus)
-

     EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey)
 END_EVENT_TABLE()
 
     EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey)
 END_EVENT_TABLE()
 


@@ -267,14 +265,14 @@ bool wxNotebook::Create(wxWindow *parent,
     
     if ( !CreateControl(parent, id, pos, size, style | wxTAB_TRAVERSAL,
                         wxDefaultValidator, name) )
     
     if ( !CreateControl(parent, id, pos, size, style | wxTAB_TRAVERSAL,
                         wxDefaultValidator, name) )

-        return FALSE;
+        return false;

 
     if ( !MSWCreateControl(WC_TABCONTROL, wxEmptyString, pos, size) )
 
     if ( !MSWCreateControl(WC_TABCONTROL, wxEmptyString, pos, size) )

-        return FALSE;
+        return false;

 
     SetBackgroundColour(wxColour(::GetSysColor(COLOR_BTNFACE)));
 
 
     SetBackgroundColour(wxColour(::GetSysColor(COLOR_BTNFACE)));
 

-    return TRUE;
+    return true;

 }
 
 WXDWORD wxNotebook::MSWGetStyle(long style, WXDWORD *exstyle) const
 }
 
 WXDWORD wxNotebook::MSWGetStyle(long style, WXDWORD *exstyle) const


@@ -348,7 +346,7 @@ int wxNotebook::SetSelection(size_t nPage)
 
 bool wxNotebook::SetPageText(size_t nPage, const wxString& strText)
 {
 
 bool wxNotebook::SetPageText(size_t nPage, const wxString& strText)
 {

-  wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, wxT("notebook page out of range") );
+  wxCHECK_MSG( IS_VALID_PAGE(nPage), false, wxT("notebook page out of range") );

 
   TC_ITEM tcItem;
   tcItem.mask = TCIF_TEXT;
 
   TC_ITEM tcItem;
   tcItem.mask = TCIF_TEXT;


@@ -386,7 +384,7 @@ int wxNotebook::GetPageImage(size_t nPage) const
 
 bool wxNotebook::SetPageImage(size_t nPage, int nImage)
 {
 
 bool wxNotebook::SetPageImage(size_t nPage, int nImage)
 {

-  wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, wxT("notebook page out of range") );
+  wxCHECK_MSG( IS_VALID_PAGE(nPage), false, wxT("notebook page out of range") );

 
   TC_ITEM tcItem;
   tcItem.mask = TCIF_IMAGE;
 
   TC_ITEM tcItem;
   tcItem.mask = TCIF_IMAGE;


@@ -418,7 +416,7 @@ void wxNotebook::SetPageSize(const wxSize& size)
     rc.right = size.x;
     rc.bottom = size.y;
 
     rc.right = size.x;
     rc.bottom = size.y;
 

-    TabCtrl_AdjustRect(GetHwnd(), TRUE, &rc);
+    TabCtrl_AdjustRect(GetHwnd(), true, &rc);

 
     // and now set it
     SetSize(rc.right - rc.left, rc.bottom - rc.top);
 
     // and now set it
     SetSize(rc.right - rc.left, rc.bottom - rc.top);


@@ -473,7 +471,7 @@ void wxNotebook::AdjustPageSize(wxNotebookPage *page)
 
     // get the page size from the notebook size
     GetSize((int *)&rc.right, (int *)&rc.bottom);
 
     // get the page size from the notebook size
     GetSize((int *)&rc.right, (int *)&rc.bottom);

-    TabCtrl_AdjustRect(m_hwnd, FALSE, &rc);
+    TabCtrl_AdjustRect(m_hwnd, false, &rc);

 
     page->SetSize(rc.left, rc.top, rc.right - rc.left, rc.bottom - rc.top);
 }
 
     page->SetSize(rc.left, rc.top, rc.right - rc.left, rc.bottom - rc.top);
 }


@@ -498,37 +496,35 @@ wxNotebookPage *wxNotebook::DoRemovePage(size_t nPage)
     }
     else // notebook still not empty
     {
     }
     else // notebook still not empty
     {

-        // change the selected page if it was deleted or became invalid
-        int selNew;
-        if ( m_nSelection == int(GetPageCount()) )
-        {
-            // last page deleted, make the new last page the new selection
-            selNew = m_nSelection - 1;
-        }
-        else if ( int(nPage) <= m_nSelection )
+        int selNew = TabCtrl_GetCurSel(m_hwnd);
+        if (selNew != -1)

         {
         {

-            // we must show another page, even if it has the same index
-            selNew = m_nSelection;
+            // No selection change, just refresh the current selection.
+            // Because it could be that the slection index changed 
+            // we need to update it. 
+            // Note: this does not mean the selection it self changed.
+            m_nSelection = selNew;
+            m_pages[m_nSelection]->Refresh();

         }
         }

-        else // nothing changes for the currently selected page
-        {
-            selNew = -1;
-
-            // we still must refresh the current page: this needs to be done
-            // for some unknown reason if the tab control shows the up-down
-            // control (i.e. when there are too many pages) -- otherwise after
-            // deleting a page nothing at all is shown
-            if (m_nSelection >= 0)
-                m_pages[m_nSelection]->Refresh();
-        }
-
-        if ( selNew != -1 )
+        else if (int(nPage) == m_nSelection)

         {
         {

+            // The selection was deleted.
+            
+            // Determine new selection.
+            if (m_nSelection == int(GetPageCount()))
+                selNew = m_nSelection - 1;
+            else
+                selNew = m_nSelection;
+            

             // m_nSelection must be always valid so reset it before calling
             // SetSelection()
             m_nSelection = -1;
             SetSelection(selNew);
         }
             // m_nSelection must be always valid so reset it before calling
             // SetSelection()
             m_nSelection = -1;
             SetSelection(selNew);
         }

+        else
+        {
+            wxFAIL; // Windows did not behave ok.
+        }

     }
 
     return pageRemoved;
     }
 
     return pageRemoved;


@@ -548,7 +544,7 @@ bool wxNotebook::DeleteAllPages()
 
   m_nSelection = -1;
 
 
   m_nSelection = -1;
 

-  return TRUE;
+  return true;

 }
 
 // same as AddPage() but does it at given position
 }
 
 // same as AddPage() but does it at given position


@@ -558,22 +554,22 @@ bool wxNotebook::InsertPage(size_t nPage,
                             bool bSelect,
                             int imageId)
 {
                             bool bSelect,
                             int imageId)
 {

-    wxCHECK_MSG( pPage != NULL, FALSE, _T("NULL page in wxNotebook::InsertPage") );
-    wxCHECK_MSG( IS_VALID_PAGE(nPage) || nPage == GetPageCount(), FALSE,
+    wxCHECK_MSG( pPage != NULL, false, _T("NULL page in wxNotebook::InsertPage") );
+    wxCHECK_MSG( IS_VALID_PAGE(nPage) || nPage == GetPageCount(), false,

                  _T("invalid index in wxNotebook::InsertPage") );
 
     wxASSERT_MSG( pPage->GetParent() == this,
                     _T("notebook pages must have notebook as parent") );
 
 #if wxUSE_UXTHEME && wxUSE_UXTHEME_AUTO
                  _T("invalid index in wxNotebook::InsertPage") );
 
     wxASSERT_MSG( pPage->GetParent() == this,
                     _T("notebook pages must have notebook as parent") );
 
 #if wxUSE_UXTHEME && wxUSE_UXTHEME_AUTO

-    static bool g_TestedForTheme = FALSE;
-    static bool g_UseTheme = FALSE;
+    static bool g_TestedForTheme = false;
+    static bool g_UseTheme = false;

     if (!g_TestedForTheme)
     {
         int commCtrlVersion = wxTheApp->GetComCtl32Version() ;
         
         g_UseTheme = (commCtrlVersion >= 600);
     if (!g_TestedForTheme)
     {
         int commCtrlVersion = wxTheApp->GetComCtl32Version() ;
         
         g_UseTheme = (commCtrlVersion >= 600);

-        g_TestedForTheme = TRUE;
+        g_TestedForTheme = true;

     }
     
     // Automatically apply the theme background,
     }
     
     // Automatically apply the theme background,


@@ -617,16 +613,17 @@ bool wxNotebook::InsertPage(size_t nPage,
     {
         wxLogError(wxT("Can't create the notebook page '%s'."), strText.c_str());
 
     {
         wxLogError(wxT("Can't create the notebook page '%s'."), strText.c_str());
 

-        return FALSE;
+        return false;

     }
 
     // succeeded: save the pointer to the page
     m_pages.Insert(pPage, nPage);
 
     }
 
     // succeeded: save the pointer to the page
     m_pages.Insert(pPage, nPage);
 

-    // for the first page (only) we need to adjust the size again because the
-    // notebook size changed: the tabs which hadn't been there before are now
-    // shown
-    if ( m_pages.GetCount() == 1 )
+    // we may need to adjust the size again if the notebook size changed:
+    // normally this only happens for the first page we add (the tabs which
+    // hadn't been there before are now shown) but for a multiline notebook it
+    // can happen for any page at all as a new row could have been started
+    if ( m_pages.GetCount() == 1 || HasFlag(wxNB_MULTILINE) )

     {
         AdjustPageSize(pPage);
     }
     {
         AdjustPageSize(pPage);
     }


@@ -638,7 +635,7 @@ bool wxNotebook::InsertPage(size_t nPage,
 
     // this updates internal flag too -- otherwise it would get out of sync
     // with the real state
 
     // this updates internal flag too -- otherwise it would get out of sync
     // with the real state

-    pPage->Show(FALSE);
+    pPage->Show(false);

 
 
     // now deal with the selection
 
 
     // now deal with the selection


@@ -663,7 +660,7 @@ bool wxNotebook::InsertPage(size_t nPage,
     if ( selNew != -1 )
         SetSelection(selNew);
 
     if ( selNew != -1 )
         SetSelection(selNew);
 

-    return TRUE;
+    return true;

 }
 
 int wxNotebook::HitTest(const wxPoint& pt, long *flags) const
 }
 
 int wxNotebook::HitTest(const wxPoint& pt, long *flags) const


@@ -702,7 +699,30 @@ void wxNotebook::OnSize(wxSizeEvent& event)
   rc.left = rc.top = 0;
   GetSize((int *)&rc.right, (int *)&rc.bottom);
 
   rc.left = rc.top = 0;
   GetSize((int *)&rc.right, (int *)&rc.bottom);
 

-  TabCtrl_AdjustRect(m_hwnd, FALSE, &rc);
+  // there seems to be a bug in the implementation of TabCtrl_AdjustRect(): it
+  // returns completely false values for multiline tab controls after the tabs
+  // are added but before getting the first WM_SIZE (off by ~50 pixels, see
+  //
+  // http://sf.net/tracker/index.php?func=detail&aid=645323&group_id=9863&atid=109863
+  //
+  // and the only work around I could find was this ugly hack... without it
+  // simply toggling the "multiline" checkbox in the notebook sample resulted
+  // in a noticeable page displacement
+  if ( HasFlag(wxNB_MULTILINE) )
+  {
+      // avoid an infinite recursion: we get another notification too!
+      static bool s_isInOnSize = false;
+
+      if ( !s_isInOnSize )
+      {
+          s_isInOnSize = true;
+          SendMessage(GetHwnd(), WM_SIZE, SIZE_RESTORED,
+                      MAKELPARAM(rc.right, rc.bottom));
+          s_isInOnSize = false;
+      }
+  }
+
+  TabCtrl_AdjustRect(m_hwnd, false, &rc);

 
   int width = rc.right - rc.left,
       height = rc.bottom - rc.top;
 
   int width = rc.right - rc.left,
       height = rc.bottom - rc.top;


@@ -722,14 +742,30 @@ void wxNotebook::OnSelChange(wxNotebookEvent& event)
   {
       int sel = event.GetOldSelection();
       if ( sel != -1 )
   {
       int sel = event.GetOldSelection();
       if ( sel != -1 )

-        m_pages[sel]->Show(FALSE);
+        m_pages[sel]->Show(false);

 
       sel = event.GetSelection();
       if ( sel != -1 )
       {
         wxNotebookPage *pPage = m_pages[sel];
 
       sel = event.GetSelection();
       if ( sel != -1 )
       {
         wxNotebookPage *pPage = m_pages[sel];

-        pPage->Show(TRUE);
+        pPage->Show(true);

         pPage->SetFocus();
         pPage->SetFocus();

+
+        // If the newly focused window is not a child of the new page,
+        // SetFocus was not successful and the notebook itself should be
+        // focused
+        wxWindow *currentFocus = FindFocus();
+        wxWindow *startFocus = currentFocus;
+        while ( currentFocus && currentFocus != pPage && currentFocus != this )
+            currentFocus = currentFocus->GetParent();
+
+        if ( startFocus == pPage || currentFocus != pPage )
+            SetFocus();
+
+      }
+      else // no pages in the notebook, give the focus to itself
+      {
+          SetFocus();

       }
 
       m_nSelection = sel;
       }
 
       m_nSelection = sel;


@@ -739,18 +775,23 @@ void wxNotebook::OnSelChange(wxNotebookEvent& event)
   event.Skip();
 }
 
   event.Skip();
 }
 

-void wxNotebook::OnSetFocus(wxFocusEvent& event)
+bool wxNotebook::MSWTranslateMessage(WXMSG *wxmsg)

 {
 {

-    // this function is only called when the focus is explicitly set (i.e. from
-    // the program) to the notebook - in this case we don't need the
-    // complicated OnNavigationKey() logic because the programmer knows better
-    // what [s]he wants
-
-    // set focus to the currently selected page if any
-    if ( m_nSelection != -1 )
-        m_pages[m_nSelection]->SetFocus();
+    const MSG * const msg = (MSG *)wxmsg;
+
+    // intercept TAB, CTRL+TAB and CTRL+SHIFT+TAB for processing by wxNotebook.
+    // TAB will be passed to the currently selected page, CTRL+TAB and
+    // CTRL+SHIFT+TAB will be processed by the notebook itself. do not
+    // intercept SHIFT+TAB. This goes to the parent of the notebook which will
+    // process it.
+    if ( msg->message == WM_KEYDOWN && msg->wParam == VK_TAB &&
+            msg->hwnd == m_hwnd &&
+                (wxIsCtrlDown() || !wxIsShiftDown()) )
+    {
+        return MSWProcessMessage(wxmsg);
+    }

 
 

-    event.Skip();
+    return false;

 }
 
 void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event)
 }
 
 void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event)


@@ -760,7 +801,7 @@ void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event)
         AdvanceSelection(event.GetDirection());
     }
     else {
         AdvanceSelection(event.GetDirection());
     }
     else {

-        // we get this event in 2 cases
+        // we get this event in 3 cases

         //
         // a) one of our pages might have generated it because the user TABbed
         // out from it in which case we should propagate the event upwards and
         //
         // a) one of our pages might have generated it because the user TABbed
         // out from it in which case we should propagate the event upwards and


@@ -773,12 +814,22 @@ void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event)
         // OnSetFocus() because we don't know which direction the focus came
         // from in this case and so can't choose between setting the focus to
         // first or last panel child
         // OnSetFocus() because we don't know which direction the focus came
         // from in this case and so can't choose between setting the focus to
         // first or last panel child

-        wxWindow *parent = GetParent();
-        // the cast is here to fic a GCC ICE
-        if ( ((wxWindow*)event.GetEventObject()) == parent )
+        //
+        // or
+        //
+        // c) we ourselves (see MSWTranslateMessage) generated the event
+        //
+        wxWindow * const parent = GetParent();
+
+        const bool isFromParent = event.GetEventObject() == parent;
+        const bool isFromSelf = event.GetEventObject() == this;
+
+        if ( isFromParent || isFromSelf )

         {
         {

-            // no, it doesn't come from child, case (b): forward to a page
-            if ( m_nSelection != -1 )
+            // no, it doesn't come from child, case (b) or (c): forward to a
+            // page but only if direction is backwards (TAB) or from ourselves,
+            if ( m_nSelection != -1 &&
+                    (!event.GetDirection() || isFromSelf) )

             {
                 // so that the page knows that the event comes from it's parent
                 // and is being propagated downwards
             {
                 // so that the page knows that the event comes from it's parent
                 // and is being propagated downwards


@@ -791,16 +842,23 @@ void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event)
                 }
                 //else: page manages focus inside it itself
             }
                 }
                 //else: page manages focus inside it itself
             }

-            else
+            else // otherwise set the focus to the notebook itself

             {
             {

-                // we have no pages - still have to give focus to _something_

                 SetFocus();
             }
         }
         else
         {
                 SetFocus();
             }
         }
         else
         {

-            // it comes from our child, case (a), pass to the parent
-            if ( parent ) {
+            // it comes from our child, case (a), pass to the parent, but only
+            // if the direction is forwards. Otherwise set the focus to the
+            // notebook itself. The notebook is always the 'first' control of a
+            // page.
+            if ( !event.GetDirection() )
+            {
+                SetFocus();
+            }
+            else if ( parent )
+            {

                 event.SetCurrentFocus(this);
                 parent->GetEventHandler()->ProcessEvent(event);
             }
                 event.SetCurrentFocus(this);
                 parent->GetEventHandler()->ProcessEvent(event);
             }


@@ -819,12 +877,12 @@ void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event)
 void wxNotebook::SetConstraintSizes(bool WXUNUSED(recurse))
 {
   // don't set the sizes of the pages - their correct size is not yet known
 void wxNotebook::SetConstraintSizes(bool WXUNUSED(recurse))
 {
   // don't set the sizes of the pages - their correct size is not yet known

-  wxControl::SetConstraintSizes(FALSE);
+  wxControl::SetConstraintSizes(false);

 }
 
 bool wxNotebook::DoPhase(int WXUNUSED(nPhase))
 {
 }
 
 bool wxNotebook::DoPhase(int WXUNUSED(nPhase))
 {

-  return TRUE;
+  return true;

 }
 
 #endif // wxUSE_CONSTRAINTS
 }
 
 #endif // wxUSE_CONSTRAINTS


@@ -839,7 +897,7 @@ bool wxNotebook::MSWOnScroll(int orientation, WXWORD nSBCode,
     // don't generate EVT_SCROLLWIN events for the WM_SCROLLs coming from the
     // up-down control
     if ( control )
     // don't generate EVT_SCROLLWIN events for the WM_SCROLLs coming from the
     // up-down control
     if ( control )

-        return FALSE;
+        return false;

 
     return wxNotebookBase::MSWOnScroll(orientation, nSBCode, pos, control);
 }
 
     return wxNotebookBase::MSWOnScroll(orientation, nSBCode, pos, control);
 }


@@ -884,14 +942,12 @@ wxColour wxNotebook::GetThemeBackgroundColour()
             // This is total guesswork.
             // See PlatformSDK\Include\Tmschema.h for values
             COLORREF themeColor;
             // This is total guesswork.
             // See PlatformSDK\Include\Tmschema.h for values
             COLORREF themeColor;

-            wxUxThemeEngine::Get()->GetThemeColor
-                                    (
+            wxUxThemeEngine::Get()->GetThemeColor(

                                         hTheme,
                                         10 /* TABP_BODY */,
                                         1 /* NORMAL */,
                                         hTheme,
                                         10 /* TABP_BODY */,
                                         1 /* NORMAL */,

-                                        3821, /* FILLCOLORHINT */
-                                        & themeColor
-                                    );
+                                        3802 /* color of bg fill */,
+                                        &themeColor);

             
             wxColour colour(GetRValue(themeColor), GetGValue(themeColor), GetBValue(themeColor));
             return colour;
             
             wxColour colour(GetRValue(themeColor), GetGValue(themeColor), GetBValue(themeColor));
             return colour;


@@ -940,10 +996,11 @@ void wxNotebook::ApplyThemeBackground(wxWindow*, const wxColour&)
 #endif
 }
 
 #endif
 }
 

+#if wxUSE_UXTHEME

 long wxNotebook::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
 {
 long wxNotebook::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
 {

-    static bool g_TestedForTheme = FALSE;
-    static bool g_UseTheme = FALSE;
+    static bool g_TestedForTheme = false;
+    static bool g_supportsThemes = false;

     switch ( nMsg )
     {
         case WM_ERASEBKGND:
     switch ( nMsg )
     {
         case WM_ERASEBKGND:


@@ -952,19 +1009,25 @@ long wxNotebook::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
             {
                 int commCtrlVersion = wxTheApp->GetComCtl32Version() ;
 
             {
                 int commCtrlVersion = wxTheApp->GetComCtl32Version() ;
 

-                g_UseTheme = (commCtrlVersion >= 600);
-                g_TestedForTheme = TRUE;
+                g_supportsThemes = (commCtrlVersion >= 600);
+                g_TestedForTheme = true;

             }
 
             }
 

-            // If using XP themes, it seems we can get away
+            // If currently an XP theme is active, it seems we can get away

             // with not drawing a background, which reduces flicker.
             // with not drawing a background, which reduces flicker.

-            if (g_UseTheme)            
-                return TRUE;
+            if (g_supportsThemes)
+            {
+                wxUxThemeEngine *p = wxUxThemeEngine::Get();
+                if (p && p->IsThemeActive() )
+                {
+                    return true;
+                }
+            }

         }
     }
 
     return wxControl::MSWWindowProc(nMsg, wParam, lParam);
 }
         }
     }
 
     return wxControl::MSWWindowProc(nMsg, wParam, lParam);
 }

-
+#endif // #if wxUSE_UXTHEME

 
 #endif // wxUSE_NOTEBOOK
 
 #endif // wxUSE_NOTEBOOK