Patch from Joe "shmengie" Brown joebrown@podiatryfl.com

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

diff --git a/src/msw/notebook.cpp b/src/msw/notebook.cpp
index ccbbbfc62e80550549aaaf24f11deeb4a4759351..1f97d497b83f509404e2e37d0286a548d4ac97cb 100644 (file)
--- a/src/msw/notebook.cpp
+++ b/src/msw/notebook.cpp
@@ -34,6 +34,7 @@
 #include  "wx/control.h"
 #include  "wx/notebook.h"
 #include  "wx/app.h"
 #include  "wx/control.h"
 #include  "wx/notebook.h"
 #include  "wx/app.h"

+#include  "wx/sysopt.h"

 
 #include  "wx/msw/private.h"
 
 
 #include  "wx/msw/private.h"
 


@@ -93,9 +94,7 @@ DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING)
 
 BEGIN_EVENT_TABLE(wxNotebook, wxControl)
     EVT_NOTEBOOK_PAGE_CHANGED(-1, wxNotebook::OnSelChange)
 
 BEGIN_EVENT_TABLE(wxNotebook, wxControl)
     EVT_NOTEBOOK_PAGE_CHANGED(-1, wxNotebook::OnSelChange)

-

     EVT_SIZE(wxNotebook::OnSize)
     EVT_SIZE(wxNotebook::OnSize)

-

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


@@ -134,6 +133,8 @@ wxBEGIN_FLAGS( wxNotebookStyle )
     wxFLAGS_MEMBER(wxNB_LEFT)
     wxFLAGS_MEMBER(wxNB_RIGHT)
     wxFLAGS_MEMBER(wxNB_BOTTOM)
     wxFLAGS_MEMBER(wxNB_LEFT)
     wxFLAGS_MEMBER(wxNB_RIGHT)
     wxFLAGS_MEMBER(wxNB_BOTTOM)

+    wxFLAGS_MEMBER(wxNB_NOPAGETHEME)
+    wxFLAGS_MEMBER(wxNB_FLAT)

 
 wxEND_FLAGS( wxNotebookStyle )
 
 
 wxEND_FLAGS( wxNotebookStyle )
 


@@ -238,6 +239,13 @@ bool wxNotebook::Create(wxWindow *parent,
                         long style,
                         const wxString& name)
 {
                         long style,
                         const wxString& name)
 {

+#ifdef __WXWINCE__
+    // Not sure why, but without this style, there is no border
+    // around the notebook tabs.
+    if (style & wxNB_FLAT)
+        style |= wxBORDER_SUNKEN;
+#endif
+

     // comctl32.dll 6.0 doesn't support non-top tabs with visual styles (the
     // control is simply not rendered correctly), so disable them in this case
     const int verComCtl32 = wxApp::GetComCtl32Version();
     // comctl32.dll 6.0 doesn't support non-top tabs with visual styles (the
     // control is simply not rendered correctly), so disable them in this case
     const int verComCtl32 = wxApp::GetComCtl32Version();


@@ -252,13 +260,69 @@ bool wxNotebook::Create(wxWindow *parent,
         }
     }
 
         }
     }
 

+    LPCTSTR className = WC_TABCONTROL;
+
+    // SysTabCtl32 class has natively CS_HREDRAW and CS_VREDRAW enabled and it
+    // causes horrible flicker when resizing notebook, so get rid of it by
+    // using a class without these styles (but otherwise identical to it)
+    if ( !HasFlag(wxFULL_REPAINT_ON_RESIZE) )
+    {
+        static ClassRegistrar s_clsNotebook;
+        if ( !s_clsNotebook.IsInitialized() )
+        {
+            // get a copy of standard class and modify it
+            WNDCLASS wc;
+
+            if ( ::GetClassInfo(::GetModuleHandle(NULL), WC_TABCONTROL, &wc) )
+            {
+                wc.lpszClassName = wxT("_wx_SysTabCtl32");
+                wc.style &= ~(CS_HREDRAW | CS_VREDRAW);
+
+                s_clsNotebook.Register(wc);
+            }
+            else
+            {
+                wxLogLastError(_T("GetClassInfoEx(SysTabCtl32)"));
+            }
+        }
+
+        // use our custom class if available but fall back to the standard
+        // notebook if we failed to register it
+        if ( s_clsNotebook.IsRegistered() )
+        {
+            // it's ok to use c_str() here as the static s_clsNotebook object
+            // has sufficiently long lifetime
+            className = s_clsNotebook.GetName().c_str();
+        }
+    }
+

     if ( !CreateControl(parent, id, pos, size, style | wxTAB_TRAVERSAL,
                         wxDefaultValidator, name) )
         return false;
 
     if ( !CreateControl(parent, id, pos, size, style | wxTAB_TRAVERSAL,
                         wxDefaultValidator, name) )
         return false;
 

-    if ( !MSWCreateControl(WC_TABCONTROL, wxEmptyString, pos, size) )
+    if ( !MSWCreateControl(className, wxEmptyString, pos, size) )

         return false;
 
         return false;
 

+#if wxUSE_UXTHEME
+    if ( HasFlag(wxNB_NOPAGETHEME) ||
+            wxSystemOptions::IsFalse(wxT("msw.notebook.themed-background")) )
+    {
+        SetBackgroundColour(GetThemeBackgroundColour());
+    }
+#endif // wxUSE_UXTHEME
+
+    // Undocumented hack to get flat notebook style
+    // In fact, we should probably only do this in some
+    // curcumstances, i.e. if we know we will have a border
+    // at the bottom (the tab control doesn't draw it itself)
+#if defined(__POCKETPC__) || defined(__SMARTPHONE__)
+    if (HasFlag(wxNB_FLAT))
+    {
+        SendMessage(m_hwnd, CCM_SETVERSION, COMCTL32_VERSION, 0);
+        if (!m_hasBgCol)
+            SetBackgroundColour(*wxWHITE);
+    }
+#endif

     return true;
 }
 
     return true;
 }
 


@@ -402,6 +466,29 @@ void wxNotebook::SetImageList(wxImageList* imageList)
 // wxNotebook size settings
 // ----------------------------------------------------------------------------
 
 // wxNotebook size settings
 // ----------------------------------------------------------------------------
 

+wxRect wxNotebook::GetPageSize() const
+{
+    wxRect r;
+
+    RECT rc;
+    ::GetClientRect(GetHwnd(), &rc);
+
+    // This check is to work around a bug in TabCtrl_AdjustRect which will
+    // cause a crash on win2k, or on XP with themes disabled, if the
+    // wxNB_MULTILINE style is used and the rectangle is very small, (such as
+    // when the notebook is first created.)  The value of 20 is just
+    // arbitrarily chosen, if there is a better way to determine this value
+    // then please do so.  --RD
+    if ( !HasFlag(wxNB_MULTILINE) || (rc.right > 20 && rc.bottom > 20) )
+    {
+        TabCtrl_AdjustRect(m_hwnd, false, &rc);
+
+        wxCopyRECTToRect(rc, r);
+    }
+
+    return r;
+}
+

 void wxNotebook::SetPageSize(const wxSize& size)
 {
     // transform the page size into the notebook size
 void wxNotebook::SetPageSize(const wxSize& size)
 {
     // transform the page size into the notebook size


@@ -434,7 +521,7 @@ wxSize wxNotebook::CalcSizeFromPage(const wxSize& sizePage) const
     wxSize sizeTotal = sizePage;
 
     // We need to make getting tab size part of the wxWidgets API.
     wxSize sizeTotal = sizePage;
 
     // We need to make getting tab size part of the wxWidgets API.

-    wxSize tabSize(0, 0);
+    wxSize tabSize;

     if (GetPageCount() > 0)
     {
         RECT rect;
     if (GetPageCount() > 0)
     {
         RECT rect;


@@ -460,23 +547,10 @@ void wxNotebook::AdjustPageSize(wxNotebookPage *page)
 {
     wxCHECK_RET( page, _T("NULL page in wxNotebook::AdjustPageSize") );
 
 {
     wxCHECK_RET( page, _T("NULL page in wxNotebook::AdjustPageSize") );
 

-    RECT rc;
-    rc.left =
-    rc.top = 0;
-
-    // get the page size from the notebook size
-    GetSize((int *)&rc.right, (int *)&rc.bottom);
-
-    // This check is to work around a bug in TabCtrl_AdjustRect which will
-    // cause a crash on win2k, or on XP with themes disabled, if the
-    // wxNB_MULTILINE style is used and the rectangle is very small, (such as
-    // when the notebook is first created.)  The value of 20 is just
-    // arbitrarily chosen, if there is a better way to determine this value
-    // then please do so.  --RD
-    if (rc.right > 20 && rc.bottom > 20)
+    const wxRect r = GetPageSize();
+    if ( !r.IsEmpty() )

     {
     {

-        TabCtrl_AdjustRect(m_hwnd, false, &rc);
-        page->SetSize(rc.left, rc.top, rc.right - rc.left, rc.bottom - rc.top);
+        page->SetSize(r);

     }
 }
 
     }
 }
 


@@ -581,7 +655,7 @@ bool wxNotebook::InsertPage(size_t nPage,
     }
 
     // and the text
     }
 
     // and the text

-    if ( !strText.IsEmpty() )
+    if ( !strText.empty() )

     {
         tcItem.mask |= TCIF_TEXT;
         tcItem.pszText = (wxChar *)strText.c_str(); // const_cast
     {
         tcItem.mask |= TCIF_TEXT;
         tcItem.pszText = (wxChar *)strText.c_str(); // const_cast


@@ -645,6 +719,7 @@ bool wxNotebook::InsertPage(size_t nPage,
         SetSelection(selNew);
 
     InvalidateBestSize();
         SetSelection(selNew);
 
     InvalidateBestSize();

+

     return true;
 }
 
     return true;
 }
 


@@ -679,49 +754,77 @@ int wxNotebook::HitTest(const wxPoint& pt, long *flags) const
 
 void wxNotebook::OnSize(wxSizeEvent& event)
 {
 
 void wxNotebook::OnSize(wxSizeEvent& event)
 {

+    if ( GetPageCount() == 0 )
+    {
+        // Prevents droppings on resize, but does cause some flicker
+        // when there are no pages.
+        Refresh();
+        event.Skip();
+        return;
+    }
+
+    // fit all the notebook pages to the tab control's display area
+
+    RECT rc;
+    rc.left = rc.top = 0;
+    GetSize((int *)&rc.right, (int *)&rc.bottom);
+
+    // save the total size, we'll use it below
+    int widthNbook = rc.right - rc.left,
+        heightNbook = rc.bottom - rc.top;
+
+    // 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;
+        }
+    }
+

 #if wxUSE_UXTHEME
 #if wxUSE_UXTHEME

-  UpdateBgBrush();
+    // background bitmap size has changed, update the brush using it too
+    UpdateBgBrush();

 #endif // wxUSE_UXTHEME
 
 #endif // wxUSE_UXTHEME
 

-  // fit the notebook page to the tab control's display area
-  RECT rc;
-  rc.left = rc.top = 0;
-  GetSize((int *)&rc.right, (int *)&rc.bottom);
-
-  // 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;
+    TabCtrl_AdjustRect(m_hwnd, false, &rc);

 
 

-      if ( !s_isInOnSize )
-      {
-          s_isInOnSize = true;
-          SendMessage(GetHwnd(), WM_SIZE, SIZE_RESTORED,
-                      MAKELPARAM(rc.right, rc.bottom));
-          s_isInOnSize = false;
-      }
-  }
+    int width = rc.right - rc.left,
+        height = rc.bottom - rc.top;
+    size_t nCount = m_pages.Count();
+    for ( size_t nPage = 0; nPage < nCount; nPage++ ) {
+        wxNotebookPage *pPage = m_pages[nPage];
+        pPage->SetSize(rc.left, rc.top, width, height);
+    }

 
 

-  TabCtrl_AdjustRect(m_hwnd, false, &rc);

 
 

-  int width = rc.right - rc.left,
-      height = rc.bottom - rc.top;
-  size_t nCount = m_pages.Count();
-  for ( size_t nPage = 0; nPage < nCount; nPage++ ) {
-    wxNotebookPage *pPage = m_pages[nPage];
-    pPage->SetSize(rc.left, rc.top, width, height);
-  }
+    // unless we had already repainted everything, we now need to refresh
+    if ( !HasFlag(wxFULL_REPAINT_ON_RESIZE) )
+    {
+        // invalidate areas not covered by pages
+        RefreshRect(wxRect(0, 0, widthNbook, rc.top), false);
+        RefreshRect(wxRect(0, rc.top, rc.left, height), false);
+        RefreshRect(wxRect(0, rc.bottom, widthNbook, heightNbook - rc.bottom),
+                    false);
+        RefreshRect(wxRect(rc.right, rc.top, widthNbook - rc.bottom, height),
+                    false);
+    }

 
 

-  event.Skip();
+    event.Skip();

 }
 
 void wxNotebook::OnSelChange(wxNotebookEvent& event)
 }
 
 void wxNotebook::OnSelChange(wxNotebookEvent& event)


@@ -857,34 +960,65 @@ void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event)
 
 #if wxUSE_UXTHEME
 
 
 #if wxUSE_UXTHEME
 

-WXHANDLE wxNotebook::QueryBgBitmap(wxWindow *win)
+bool wxNotebook::DoDrawBackground(WXHDC hDC, wxWindow *child)

 {
 {

+    wxUxThemeHandle theme(child ? child : this, L"TAB");
+    if ( !theme )
+        return false;
+
+    // get the notebook client rect (we're not interested in drawing tabs
+    // themselves)
+    wxRect r = GetPageSize();
+    if ( r.IsEmpty() )
+        return false;
+

     RECT rc;
     RECT rc;

-    GetWindowRect(GetHwnd(), &rc);
+    wxCopyRectToRECT(r, rc);
+
+    // map rect to the coords of the window we're drawing in
+    if ( child )
+        ::MapWindowPoints(GetHwnd(), GetHwndOf(child), (POINT *)&rc, 2);
+
+
+    // apparently DrawThemeBackground() modifies the rect passed to it and if we
+    // don't do these adjustments, there are some drawing artifacts which are
+    // only visible with some non default themes; so modify the rect here using
+    // the magic numbers below so that it still paints the correct area
+    rc.left   -= 2;
+    rc.top    -= 2;
+    rc.right  += 4;
+    rc.bottom += 5;
+
+
+    wxUxThemeEngine::Get()->DrawThemeBackground
+                            (
+                                theme,
+                                hDC,
+                                9 /* TABP_PANE */,
+                                0,
+                                &rc,
+                                NULL
+                            );
+
+    return true;
+}
+
+WXHBRUSH wxNotebook::QueryBgBitmap()
+{
+    wxRect r = GetPageSize();
+    if ( r.IsEmpty() )
+        return 0;

 
     WindowHDC hDC(GetHwnd());
     MemoryHDC hDCMem(hDC);
 
     WindowHDC hDC(GetHwnd());
     MemoryHDC hDCMem(hDC);

-    CompatibleBitmap hBmp(hDC, rc.right - rc.left, rc.bottom - rc.top);
+    CompatibleBitmap hBmp(hDC, r.x + r.width, r.y + r.height);

 
     SelectInHDC selectBmp(hDCMem, hBmp);
 
 
     SelectInHDC selectBmp(hDCMem, hBmp);
 

-    ::SendMessage(GetHwnd(), WM_PRINTCLIENT,
-                  (WPARAM)(HDC)hDCMem, 
-                  PRF_ERASEBKGND | PRF_CLIENT | PRF_NONCLIENT);
-
-    if ( win )
-    {
-        RECT rc2;
-        ::GetWindowRect(GetHwndOf(win), &rc2);
+    if ( !DoDrawBackground((WXHDC)(HDC)hDCMem) )
+        return 0;

 
 

-        COLORREF c = ::GetPixel(hDCMem, rc2.left - rc.left, rc2.top - rc.top);
-
-        return (WXHANDLE)c;
-    }
-    else // we are asked to create the brush
-    {
-        return (WXHANDLE)::CreatePatternBrush(hBmp);
-    }
+    return (WXHBRUSH)::CreatePatternBrush(hBmp);

 }
 
 void wxNotebook::UpdateBgBrush()
 }
 
 void wxNotebook::UpdateBgBrush()


@@ -894,22 +1028,22 @@ void wxNotebook::UpdateBgBrush()
 
     if ( !m_hasBgCol && wxUxThemeEngine::GetIfActive() )
     {
 
     if ( !m_hasBgCol && wxUxThemeEngine::GetIfActive() )
     {

-        m_hbrBackground = (WXHBRUSH)QueryBgBitmap();
+        m_hbrBackground = QueryBgBitmap();

     }
     }

-    else // no themes
+    else // no themes or we've got user-defined solid colour

     {
         m_hbrBackground = NULL;
     }
 }
 
     {
         m_hbrBackground = NULL;
     }
 }
 

-WXHBRUSH wxNotebook::MSWGetBgBrushForChild(WXHDC hDC, wxWindow *win)
+WXHBRUSH wxNotebook::MSWGetBgBrushForChild(WXHDC hDC, WXHWND hWnd)

 {
     if ( m_hbrBackground )
     {
         // before drawing with the background brush, we need to position it
         // correctly
         RECT rc;
 {
     if ( m_hbrBackground )
     {
         // before drawing with the background brush, we need to position it
         // correctly
         RECT rc;

-        ::GetWindowRect(GetHwndOf(win), &rc);
+        ::GetWindowRect((HWND)hWnd, &rc);

 
         ::MapWindowPoints(NULL, GetHwnd(), (POINT *)&rc, 1);
 
 
         ::MapWindowPoints(NULL, GetHwnd(), (POINT *)&rc, 1);
 


@@ -921,24 +1055,66 @@ WXHBRUSH wxNotebook::MSWGetBgBrushForChild(WXHDC hDC, wxWindow *win)
         return m_hbrBackground;
     }
 
         return m_hbrBackground;
     }
 

-    return wxNotebookBase::MSWGetBgBrushForChild(hDC, win);
+    return wxNotebookBase::MSWGetBgBrushForChild(hDC, hWnd);

 }
 
 }
 

-wxColour wxNotebook::MSWGetBgColourForChild(wxWindow *win)
+bool wxNotebook::MSWPrintChild(WXHDC hDC, wxWindow *child)

 {
 {

-    if ( m_hasBgCol )
-        return GetBackgroundColour();
+    // solid background colour overrides themed background drawing
+    if ( !UseBgCol() && DoDrawBackground(hDC, child) )
+        return true;

 
 

-    if ( !wxUxThemeEngine::GetIfActive() )
-        return wxNullColour;
+    return wxNotebookBase::MSWPrintChild(hDC, child);
+}

 
 

-    COLORREF c = (COLORREF)QueryBgBitmap(win);
+#endif // wxUSE_UXTHEME

 
 

-    return c == CLR_INVALID ? wxNullColour : wxRGBToColour(c);
-}
+// Windows only: attempts to get colour for UX theme page background
+wxColour wxNotebook::GetThemeBackgroundColour() const
+{
+#if wxUSE_UXTHEME
+    if (wxUxThemeEngine::Get())
+    {
+        wxUxThemeHandle hTheme((wxNotebook*) this, L"TAB");
+        if (hTheme)
+        {
+            // This is total guesswork.
+            // See PlatformSDK\Include\Tmschema.h for values
+            COLORREF themeColor;
+            wxUxThemeEngine::Get()->GetThemeColor(
+                                        hTheme,
+                                        10 /* TABP_BODY */,
+                                        1 /* NORMAL */,
+                                        3821 /* FILLCOLORHINT */,
+                                        &themeColor);
+
+            /*
+            [DS] Workaround for WindowBlinds:
+            Some themes return a near black theme color using FILLCOLORHINT,
+            this makes notebook pages have an ugly black background and makes
+            text (usually black) unreadable. Retry again with FILLCOLOR.
+
+            This workaround potentially breaks appearance of some themes,
+            but in practice it already fixes some themes.
+            */
+            if (themeColor == 1)
+            {
+                wxUxThemeEngine::Get()->GetThemeColor(
+                                            hTheme,
+                                            10 /* TABP_BODY */,
+                                            1 /* NORMAL */,
+                                            3802 /* FILLCOLOR */,
+                                            &themeColor);
+            }

 
 

+            return wxRGBToColour(themeColor);
+        }
+    }

 #endif // wxUSE_UXTHEME
 
 #endif // wxUSE_UXTHEME
 

+    return GetBackgroundColour();
+}
+

 // ----------------------------------------------------------------------------
 // wxNotebook base class virtuals
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxNotebook base class virtuals
 // ----------------------------------------------------------------------------