]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/statbox.cpp
added wxDebugContext::SetShutdownNotifyFunction() (patch 1887210)
[wxWidgets.git] / src / msw / statbox.cpp
index ea27a85d600d583b748cbed4f0525034b77155f7..ca3066741505fe22cb4c45cb4bd03dd71b4d9ab7 100644 (file)
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        msw/statbox.cpp
+// Name:        src/msw/statbox.cpp
 // Purpose:     wxStaticBox
 // Author:      Julian Smart
 // Modified by:
 // headers
 // ----------------------------------------------------------------------------
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma implementation "statbox.h"
-#endif
-
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 
 #if wxUSE_STATBOX
 
+#include "wx/statbox.h"
+
 #ifndef WX_PRECOMP
     #include "wx/app.h"
     #include "wx/dcclient.h"
+    #include "wx/dcmemory.h"
+    #include "wx/image.h"
 #endif
 
-#include "wx/statbox.h"
 #include "wx/notebook.h"
 #include "wx/sysopt.h"
-#include "wx/image.h"
-#include "wx/dcmemory.h"
 
+#include "wx/msw/uxtheme.h"
 #include "wx/msw/private.h"
+#include "wx/msw/missing.h"
+
+// the values coincide with those in tmschema.h
+#define BP_GROUPBOX 4
+
+#define GBS_NORMAL 1
+
+#define TMT_FONT 210
 
 // ----------------------------------------------------------------------------
 // wxWin macros
@@ -99,10 +105,6 @@ wxCONSTRUCTOR_6( wxStaticBox , wxWindow* , Parent , wxWindowID , Id , wxString ,
 IMPLEMENT_DYNAMIC_CLASS(wxStaticBox, wxControl)
 #endif
 
-BEGIN_EVENT_TABLE(wxStaticBox, wxControl)
-    EVT_PAINT(wxStaticBox::OnPaint)
-END_EVENT_TABLE()
-
 // ============================================================================
 // implementation
 // ============================================================================
@@ -125,6 +127,14 @@ bool wxStaticBox::Create(wxWindow *parent,
     if ( !MSWCreateControl(wxT("BUTTON"), label, pos, size) )
         return false;
 
+    // Always use LTR layout. Otherwise, the label would be mirrored.
+    SetLayoutDirection(wxLayout_LeftToRight);
+
+#ifndef __WXWINCE__
+    if (!wxSystemOptions::IsFalse(wxT("msw.staticbox.optimized-paint")))
+        Connect(wxEVT_PAINT, wxPaintEventHandler(wxStaticBox::OnPaint));
+#endif // !__WXWINCE__
+
     return true;
 }
 
@@ -137,9 +147,24 @@ WXDWORD wxStaticBox::MSWGetStyle(long style, WXDWORD *exstyle) const
     styleWin &= ~WS_CLIPCHILDREN;
 
     if ( exstyle )
-        *exstyle = 0;
+    {
+#ifndef __WXWINCE__
+        if (wxSystemOptions::IsFalse(wxT("msw.staticbox.optimized-paint")))
+            *exstyle = WS_EX_TRANSPARENT;
+        else
+#endif
+            *exstyle = 0;
+    }
+
+    styleWin |= BS_GROUPBOX;
+
+    if ( wxTheApp->GetLayoutDirection() == wxLayout_RightToLeft )
+    {
+        // Make sure label is on the right
+        styleWin |= BS_RIGHT;
+    }
 
-    return styleWin | BS_GROUPBOX;
+    return styleWin;
 }
 
 wxSize wxStaticBox::DoGetBestSize() const
@@ -148,17 +173,29 @@ wxSize wxStaticBox::DoGetBestSize() const
     wxGetCharSize(GetHWND(), &cx, &cy, GetFont());
 
     int wBox;
-    GetTextExtent(wxGetWindowText(m_hWnd), &wBox, &cy);
+    GetTextExtent(GetLabelText(wxGetWindowText(m_hWnd)), &wBox, &cy);
 
     wBox += 3*cx;
     int hBox = EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy);
 
-    return wxSize(wBox, hBox);
+    wxSize best(wBox, hBox);
+    CacheBestSize(best);
+    return best;
 }
 
-WXLRESULT wxStaticBox::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
+void wxStaticBox::GetBordersForSizer(int *borderTop, int *borderOther) const
 {
+    wxStaticBoxBase::GetBordersForSizer(borderTop, borderOther);
+
+    // need extra space, don't know how much but this seems to be enough
+    *borderTop += GetCharHeight()/3;
+}
+
+// all the hacks below are not necessary for WinCE
 #ifndef __WXWINCE__
+
+WXLRESULT wxStaticBox::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
+{
     if ( nMsg == WM_NCHITTEST )
     {
         // This code breaks some other processing such as enter/leave tracking
@@ -169,8 +206,8 @@ WXLRESULT wxStaticBox::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lPar
             s_useHTClient = wxSystemOptions::GetOptionInt(wxT("msw.staticbox.htclient"));
         if (s_useHTClient == 1)
         {
-            int xPos = LOWORD(lParam);  // horizontal position of cursor
-            int yPos = HIWORD(lParam);  // vertical position of cursor
+            int xPos = GET_X_LPARAM(lParam);
+            int yPos = GET_Y_LPARAM(lParam);
 
             ScreenToClient(&xPos, &yPos);
 
@@ -180,148 +217,351 @@ WXLRESULT wxStaticBox::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lPar
                 return (long)HTCLIENT;
         }
     }
-#endif // !__WXWINCE__
+
+    if ( nMsg == WM_PRINTCLIENT )
+    {
+        // we have to process WM_PRINTCLIENT ourselves as otherwise child
+        // windows' background (eg buttons in radio box) would never be drawn
+        // unless we have a parent with non default background
+
+        // so check first if we have one
+        if ( !HandlePrintClient((WXHDC)wParam) )
+        {
+            // no, we don't, erase the background ourselves
+            // (don't use our own) - see PaintBackground for explanation
+            wxBrush brush(GetParent()->GetBackgroundColour());
+            wxFillRect(GetHwnd(), (HDC)wParam, GetHbrushOf(brush));
+        }
+
+        return 0;
+    }
 
     return wxControl::MSWWindowProc(nMsg, wParam, lParam);
 }
 
-void wxStaticBox::GetBordersForSizer(int *borderTop, int *borderOther) const
+// ----------------------------------------------------------------------------
+// static box drawing
+// ----------------------------------------------------------------------------
+
+/*
+   We draw the static box ourselves because it's the only way to prevent it
+   from flickering horribly on resize (because everything inside the box is
+   erased twice: once when the box itself is repainted and second time when
+   the control inside it is repainted) without using WS_EX_TRANSPARENT style as
+   we used to do and which resulted in other problems.
+ */
+
+// MSWGetRegionWithoutSelf helper: removes the given rectangle from region
+static inline void
+SubtractRectFromRgn(HRGN hrgn, int left, int top, int right, int bottom)
 {
-    wxStaticBoxBase::GetBordersForSizer(borderTop, borderOther);
+    AutoHRGN hrgnRect(::CreateRectRgn(left, top, right, bottom));
+    if ( !hrgnRect )
+    {
+        wxLogLastError(_T("CreateRectRgn()"));
+        return;
+    }
 
-    // if not using correct (but backwards cojmpatible) text metrics
-    // calculations, we need to add some extra margin or otherwise static box
-    // title is clipped
-#if !wxDIALOG_UNIT_COMPATIBILITY
-    if ( !GetLabel().empty() )
-        *borderTop += GetCharHeight()/3;
-#endif // !wxDIALOG_UNIT_COMPATIBILITY
+    ::CombineRgn(hrgn, hrgn, hrgnRect, RGN_DIFF);
 }
 
-// rc must be in client coords!
-void wxStaticBox::MSWClipBoxRegion(WXHRGN hrgn, const WXRECTPTR rc)
+void wxStaticBox::MSWGetRegionWithoutSelf(WXHRGN hRgn, int w, int h)
 {
-    HRGN hrgnchild;
+    HRGN hrgn = (HRGN)hRgn;
+
+    // remove the area occupied by the static box borders from the region
+    int borderTop, border;
+    GetBordersForSizer(&borderTop, &border);
 
     // top
-    hrgnchild = ::CreateRectRgn(0, 0, ((const RECT*) rc)->right, 14);
-    ::CombineRgn((HRGN) hrgn, (HRGN) hrgn, hrgnchild, RGN_DIFF);
-    ::DeleteObject(hrgnchild);
+    SubtractRectFromRgn(hrgn, 0, 0, w, borderTop);
 
     // bottom
-    hrgnchild = ::CreateRectRgn(0, ((const RECT*) rc)->bottom - 7, ((const RECT*) rc)->right, ((const RECT*) rc)->bottom);
-    ::CombineRgn((HRGN) hrgn, (HRGN) hrgn, hrgnchild, RGN_DIFF);
-    ::DeleteObject(hrgnchild);
+    SubtractRectFromRgn(hrgn, 0, h - border, w, h);
 
     // left
-    hrgnchild = ::CreateRectRgn(0, 0, 7, ((const RECT*) rc)->bottom);
-    ::CombineRgn((HRGN) hrgn, (HRGN) hrgn, hrgnchild, RGN_DIFF);
-    ::DeleteObject(hrgnchild);
+    SubtractRectFromRgn(hrgn, 0, 0, border, h);
 
     // right
-    hrgnchild = ::CreateRectRgn(((const RECT*) rc)->right - 7, 0, ((const RECT*) rc)->right, ((const RECT*) rc)->bottom);
-    ::CombineRgn((HRGN) hrgn, (HRGN) hrgn, hrgnchild, RGN_DIFF);
-    ::DeleteObject(hrgnchild);
+    SubtractRectFromRgn(hrgn, w - border, 0, w, h);
 }
 
-WXHRGN wxStaticBox::MSWCalculateClippingRegion()
+WXHRGN wxStaticBox::MSWGetRegionWithoutChildren()
 {
     RECT rc;
     ::GetWindowRect(GetHwnd(), &rc);
     HRGN hrgn = ::CreateRectRgn(rc.left, rc.top, rc.right + 1, rc.bottom + 1);
+    bool foundThis = false;
 
-    wxWindowList::compatibility_iterator node = GetParent()->GetChildren().GetFirst();
-    while ( node )
+    // iterate over all child windows (not just wxWindows but all windows)
+    for ( HWND child = ::GetWindow(GetHwndOf(GetParent()), GW_CHILD);
+          child;
+          child = ::GetWindow(child, GW_HWNDNEXT) )
     {
-        wxWindow *child = node->GetData();
+        if ( ! ::IsWindowVisible(child) )
+        {
+            // if the window isn't visible then it doesn't need clipped
+            continue;
+        }
+
+        LONG style = ::GetWindowLong(child, GWL_STYLE);
+        wxString str(wxGetWindowClass(child));
+        str.UpperCase();
+        if ( str == wxT("BUTTON") && (style & BS_GROUPBOX) == BS_GROUPBOX )
+        {
+            if ( child == GetHwnd() )
+                foundThis = true;
+
+            // Any static boxes below this one in the Z-order can't be clipped
+            // since if we have the case where a static box with a low Z-order
+            // is nested inside another static box with a high Z-order then the
+            // nested static box would be painted over. Doing it this way
+            // unfortunately results in flicker if the Z-order of nested static
+            // boxes is not inside (lowest) to outside (highest) but at least
+            // they are still shown.
+            if ( foundThis )
+                continue;
+        }
 
-        // can't just test for (this != child) here since if a wxStaticBox
-        // overlaps another wxStaticBox then neither are drawn. The overlapping
-        // region will flicker but we shouldn't have overlapping windows anyway.
-        if ( !child->IsKindOf(CLASSINFO(wxStaticBox)) )
+        ::GetWindowRect(child, &rc);
+        if ( ::RectInRegion(hrgn, &rc) )
         {
-            ::GetWindowRect(GetHwndOf(child), &rc);
-            if ( RectInRegion(hrgn, &rc) )
+            // need to remove WS_CLIPSIBLINGS from all sibling windows
+            // that are within this staticbox if set
+            if ( style & WS_CLIPSIBLINGS )
             {
-                // need to remove WS_CLIPSIBLINGS from all sibling windows
-                // that are within this staticbox if set
-                LONG style = ::GetWindowLong(GetHwndOf(child), GWL_STYLE);
-                if ( style & WS_CLIPSIBLINGS )
+                style &= ~WS_CLIPSIBLINGS;
+                ::SetWindowLong(child, GWL_STYLE, style);
+
+                // MSDN: "If you have changed certain window data using
+                // SetWindowLong, you must call SetWindowPos to have the
+                // changes take effect."
+                ::SetWindowPos(child, NULL, 0, 0, 0, 0,
+                               SWP_NOMOVE | SWP_NOSIZE | SWP_NOZORDER |
+                               SWP_FRAMECHANGED);
+            }
+
+            AutoHRGN hrgnChild(::CreateRectRgnIndirect(&rc));
+            ::CombineRgn(hrgn, hrgn, hrgnChild, RGN_DIFF);
+        }
+    }
+
+    return (WXHRGN)hrgn;
+}
+
+// helper for OnPaint(): really erase the background, i.e. do it even if we
+// don't have any non default brush for doing it (DoEraseBackground() doesn't
+// do anything in such case)
+void wxStaticBox::PaintBackground(wxDC& dc, const RECT& rc)
+{
+    // note that we do not use the box background colour here, it shouldn't
+    // apply to its interior for several reasons:
+    //  1. wxGTK doesn't do it
+    //  2. controls inside the box don't get correct bg colour because they
+    //     are not our children so we'd have some really ugly colour mix if
+    //     we did it
+    //  3. this is backwards compatible behaviour and some people rely on it,
+    //     see http://groups.google.com/groups?selm=4252E932.3080801%40able.es
+    wxWindow *parent = GetParent();
+    wxMSWDCImpl *impl = (wxMSWDCImpl*) dc.GetImpl();
+    HBRUSH hbr = (HBRUSH)parent->MSWGetBgBrush(impl->GetHDC(), GetHWND());
+
+    // if there is no special brush for painting this control, just use the
+    // solid background colour
+    wxBrush brush;
+    if ( !hbr )
+    {
+        brush = wxBrush(parent->GetBackgroundColour());
+        hbr = GetHbrushOf(brush);
+    }
+
+    ::FillRect(GetHdcOf(*impl), &rc, hbr);
+}
+
+void wxStaticBox::PaintForeground(wxDC& dc, const RECT& rc)
+{
+    wxMSWDCImpl *impl = (wxMSWDCImpl*) dc.GetImpl();
+    MSWDefWindowProc(WM_PAINT, (WPARAM)GetHdcOf(*impl), 0);
+
+    // when using XP themes, neither setting the text colour nor transparent
+    // background mode doesn't change anything: the static box def window proc
+    // still draws the label in its own colours, so we need to redraw the text
+    // ourselves if we have a non default fg colour
+    if ( m_hasFgCol && wxUxThemeEngine::GetIfActive() )
+    {
+        // draw over the text in default colour in our colour
+        HDC hdc = GetHdcOf(*impl);
+        ::SetTextColor(hdc, GetForegroundColour().GetPixel());
+
+        const bool rtl = wxTheApp->GetLayoutDirection() == wxLayout_RightToLeft;
+        if ( rtl )
+            ::SetTextAlign(hdc, TA_RTLREADING | TA_RIGHT);
+
+        // Get dimensions of the label
+        const wxString label = GetLabel();
+
+        // choose the correct font
+        AutoHFONT font;
+        SelectInHDC selFont;
+        if ( m_hasFont )
+        {
+            selFont.Init(hdc, GetHfontOf(GetFont()));
+        }
+        else // no font set, use the one set by the theme
+        {
+            wxUxThemeHandle hTheme(this, L"BUTTON");
+            if ( hTheme )
+            {
+                // GetThemeFont() expects its parameter to be LOGFONTW and not
+                // LOGFONTA even in ANSI programs and will happily corrupt
+                // memory after the struct end if we pass a LOGFONTA (which is
+                // smaller) to it!
+                LOGFONTW lfw;
+                if ( wxUxThemeEngine::Get()->GetThemeFont
+                                             (
+                                                hTheme,
+                                                hdc,
+                                                BP_GROUPBOX,
+                                                GBS_NORMAL,
+                                                TMT_FONT,
+                                                (LOGFONT *)&lfw
+                                             ) == S_OK )
                 {
-                    style &= ~WS_CLIPSIBLINGS;
-                    ::SetWindowLong(GetHwndOf(child), GWL_STYLE, style);
-
-                    // MSDN: "If you have changed certain window data using
-                    // SetWindowLong, you must call SetWindowPos to have the
-                    // changes take effect."
-                    ::SetWindowPos(GetHwndOf(child), NULL, 0, 0, 0, 0,
-                                   SWP_NOMOVE | SWP_NOSIZE | SWP_NOZORDER |
-                                   SWP_FRAMECHANGED);
+#if wxUSE_UNICODE
+                    // ok, no conversion necessary
+                    const LOGFONT& lf = lfw;
+#else // !wxUSE_UNICODE
+                    // most of the fields are the same in LOGFONTA and LOGFONTW
+                    LOGFONT lf;
+                    memcpy(&lf, &lfw, sizeof(lf));
+
+                    // but the face name must be converted
+                    WideCharToMultiByte(CP_ACP, 0, lfw.lfFaceName, -1,
+                                        lf.lfFaceName, sizeof(lf.lfFaceName),
+                                        NULL, NULL);
+#endif // wxUSE_UNICODE/!wxUSE_UNICODE
+
+                    font.Init(lf);
+                    if ( font )
+                        selFont.Init(hdc, font);
                 }
-
-                HRGN hrgnchild = ::CreateRectRgnIndirect(&rc);
-                ::CombineRgn(hrgn, hrgn, hrgnchild, RGN_DIFF);
-                ::DeleteObject(hrgnchild);
             }
         }
 
-        node = node->GetNext();
-    }
-    ::GetWindowRect(GetHwnd(), &rc);
-    ::OffsetRgn(hrgn, -rc.left, -rc.top);
+        // Get the font extent
+        int width, height;
+        dc.GetTextExtent(wxStripMenuCodes(label, wxStrip_Mnemonics),
+                         &width, &height);
+
+        int x;
+        int y = height;
+
+        // first we need to correctly paint the background of the label
+        // as Windows ignores the brush offset when doing it
+        //
+        // FIXME: value of x is hardcoded as this is what it is on my system,
+        //        no idea if it's true everywhere
+        RECT dimensions = {0, 0, 0, y};
+        if ( !rtl )
+        {
+            x = 9;
+            dimensions.left = x;
+            dimensions.right = x + width;
+        }
+        else
+        {
+            x = rc.right - 7;
+            dimensions.left = x - width;
+            dimensions.right = x;
+        }
+
+        // need to adjust the rectangle to cover all the label background
+        dimensions.left -= 2;
+        dimensions.right += 2;
+        dimensions.bottom += 2;
 
-    return hrgn;
+        if ( UseBgCol() )
+        {
+            // our own background colour should be used for the background of
+            // the label: this is consistent with the behaviour under pre-XP
+            // systems (i.e. without visual themes) and generally makes sense
+            wxBrush brush = wxBrush(GetBackgroundColour());
+            wxMSWDCImpl *impl = (wxMSWDCImpl*) dc.GetImpl();
+            ::FillRect(GetHdcOf(*impl), &dimensions, GetHbrushOf(brush));
+        }
+        else // paint parent background
+        {
+            PaintBackground(dc, dimensions);
+        }
+
+        // now draw the text
+        if ( !rtl )
+        {
+            RECT rc2 = { x, 0, x + width, y };
+            ::DrawText(hdc, label.wx_str(), label.length(), &rc2,
+                       DT_SINGLELINE | DT_VCENTER);
+        }
+        else // RTL
+        {
+            RECT rc2 = { x, 0, x - width, y };
+            ::DrawText(hdc, label.wx_str(), label.length(), &rc2,
+                       DT_SINGLELINE | DT_VCENTER | DT_RTLREADING);
+        }
+    }
 }
 
 void wxStaticBox::OnPaint(wxPaintEvent& WXUNUSED(event))
 {
-    wxPaintDC dc(this);
     RECT rc;
     ::GetClientRect(GetHwnd(), &rc);
 
-    // paint the actual box
+    // draw the entire box in a memory DC
     wxMemoryDC memdc;
     wxBitmap bitmap(rc.right, rc.bottom);
     memdc.SelectObject(bitmap);
 
-    // get bg brush
-    WXHBRUSH hbr = DoMSWControlColor(GetHdcOf(memdc), wxNullColour);
-    if ( !hbr )
-    {
-        wxBrush *brush = wxTheBrushList->FindOrCreateBrush(GetBackgroundColour(), wxSOLID);
-        hbr = (WXHBRUSH)brush->GetResourceHandle();
-    }
+    PaintBackground(memdc, rc);
+    PaintForeground(memdc, rc);
 
-    // draw solid box, but only blit the good bits
-    ::FillRect(GetHdcOf(memdc), &rc, (HBRUSH)hbr);
-    MSWDefWindowProc(WM_PAINT, (WPARAM)GetHdcOf(memdc), 0);
+    // now only blit the static box border itself, not the interior, to avoid
+    // flicker when background is drawn below
+    //
+    // note that it seems to be faster to do 4 small blits here and then paint
+    // directly into wxPaintDC than painting background in wxMemoryDC and then
+    // blitting everything at once to wxPaintDC, this is why we do it like this
+    wxPaintDC dc(this);
+    int borderTop, border;
+    GetBordersForSizer(&borderTop, &border);
 
     // top
-    dc.Blit(7, 0, rc.right - 7, 14, &memdc, 7, 0);
+    dc.Blit(border, 0, rc.right - border, borderTop,
+            &memdc, border, 0);
     // bottom
-    dc.Blit(7, rc.bottom - 7, rc.right - 7, rc.bottom, &memdc, 7, rc.bottom - 7);
+    dc.Blit(border, rc.bottom - border, rc.right - border, rc.bottom,
+            &memdc, border, rc.bottom - border);
     // left
-    dc.Blit(0, 0, 7, rc.bottom, &memdc, 0, 0);
+    dc.Blit(0, 0, border, rc.bottom,
+            &memdc, 0, 0);
     // right
-    dc.Blit(rc.right - 7, 0, rc.right, rc.bottom, &memdc, rc.right - 7, 0);
+    dc.Blit(rc.right - border, 0, rc.right, rc.bottom,
+            &memdc, rc.right - border, 0);
 
-    // paint the inner
-    HRGN hrgn = (HRGN)MSWCalculateClippingRegion();
-    // now remove the box itself
-    MSWClipBoxRegion((WXHRGN) hrgn, (const WXRECTPTR) &rc);
 
-    hbr = DoMSWControlColor(GetHdcOf(dc), wxNullColour);
-    if ( !hbr )
-    {
-        wxBrush *brush = wxTheBrushList->FindOrCreateBrush(GetBackgroundColour(), wxSOLID);
-        hbr = (WXHBRUSH)brush->GetResourceHandle();
-    }
+    // create the region excluding box children
+    AutoHRGN hrgn((HRGN)MSWGetRegionWithoutChildren());
+    RECT rcWin;
+    ::GetWindowRect(GetHwnd(), &rcWin);
+    ::OffsetRgn(hrgn, -rcWin.left, -rcWin.top);
+
+    // and also the box itself
+    MSWGetRegionWithoutSelf((WXHRGN) hrgn, rc.right, rc.bottom);
+    wxMSWDCImpl *impl = (wxMSWDCImpl*) dc.GetImpl();
+    HDCClipper clipToBg(GetHdcOf(*impl), hrgn);
 
-    ::SelectClipRgn(GetHdcOf(dc), hrgn);
-    ::FillRect(GetHdcOf(dc), &rc, (HBRUSH)hbr);
-    ::SelectClipRgn(GetHdcOf(dc), NULL);
-    ::DeleteObject(hrgn);
+    // paint the inside of the box (excluding box itself and child controls)
+    PaintBackground(dc, rc);
 }
 
-#endif // wxUSE_STATBOX
+#endif // !__WXWINCE__
 
+#endif // wxUSE_STATBOX