]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/statbox.cpp
Ensure there is valid context for DrawRectangle
[wxWidgets.git] / src / msw / statbox.cpp
index 2fbd1acfebde47272524e56f2c5312cb0ab89100..3a2d88de4c1f630dad43b6e5d5c8aeba46537713 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"
+    #include "wx/sizer.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"
+#include "wx/msw/dc.h"
 
-// ----------------------------------------------------------------------------
-// wxWin macros
-// ----------------------------------------------------------------------------
+// the values coincide with those in tmschema.h
+#define BP_GROUPBOX 4
 
-#if wxUSE_EXTENDED_RTTI
-WX_DEFINE_FLAGS( wxStaticBoxStyle )
-
-wxBEGIN_FLAGS( wxStaticBoxStyle )
-    // new style border flags, we put them first to
-    // use them for streaming out
-    wxFLAGS_MEMBER(wxBORDER_SIMPLE)
-    wxFLAGS_MEMBER(wxBORDER_SUNKEN)
-    wxFLAGS_MEMBER(wxBORDER_DOUBLE)
-    wxFLAGS_MEMBER(wxBORDER_RAISED)
-    wxFLAGS_MEMBER(wxBORDER_STATIC)
-    wxFLAGS_MEMBER(wxBORDER_NONE)
-
-    // old style border flags
-    wxFLAGS_MEMBER(wxSIMPLE_BORDER)
-    wxFLAGS_MEMBER(wxSUNKEN_BORDER)
-    wxFLAGS_MEMBER(wxDOUBLE_BORDER)
-    wxFLAGS_MEMBER(wxRAISED_BORDER)
-    wxFLAGS_MEMBER(wxSTATIC_BORDER)
-    wxFLAGS_MEMBER(wxBORDER)
-
-    // standard window styles
-    wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
-    wxFLAGS_MEMBER(wxCLIP_CHILDREN)
-    wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
-    wxFLAGS_MEMBER(wxWANTS_CHARS)
-    wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
-    wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
-    wxFLAGS_MEMBER(wxVSCROLL)
-    wxFLAGS_MEMBER(wxHSCROLL)
-
-wxEND_FLAGS( wxStaticBoxStyle )
-
-IMPLEMENT_DYNAMIC_CLASS_XTI(wxStaticBox, wxControl,"wx/statbox.h")
-
-wxBEGIN_PROPERTIES_TABLE(wxStaticBox)
-    wxPROPERTY( Label,wxString, SetLabel, GetLabel, wxString() , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
-    wxPROPERTY_FLAGS( WindowStyle , wxStaticBoxStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
-/*
-    TODO PROPERTIES :
-        label
-*/
-wxEND_PROPERTIES_TABLE()
+#define GBS_NORMAL 1
 
-wxBEGIN_HANDLERS_TABLE(wxStaticBox)
-wxEND_HANDLERS_TABLE()
+#define TMT_FONT 210
 
-wxCONSTRUCTOR_6( wxStaticBox , wxWindow* , Parent , wxWindowID , Id , wxString , Label , wxPoint , Position , wxSize , Size , long , WindowStyle )
-#else
-IMPLEMENT_DYNAMIC_CLASS(wxStaticBox, wxControl)
-#endif
+// ----------------------------------------------------------------------------
+// wxWin macros
+// ----------------------------------------------------------------------------
 
 // ============================================================================
 // implementation
@@ -121,18 +77,17 @@ 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__
-    Connect(wxEVT_PAINT, wxPaintEventHandler(wxStaticBox::OnPaint));
+    if (!wxSystemOptions::IsFalse(wxT("msw.staticbox.optimized-paint")))
+        Connect(wxEVT_PAINT, wxPaintEventHandler(wxStaticBox::OnPaint));
 #endif // !__WXWINCE__
 
     return true;
 }
 
-wxBorder wxStaticBox::GetDefaultBorder() const
-{
-    return wxBORDER_NONE;
-}
-
 WXDWORD wxStaticBox::MSWGetStyle(long style, WXDWORD *exstyle) const
 {
     long styleWin = wxStaticBoxBase::MSWGetStyle(style, exstyle);
@@ -143,40 +98,57 @@ WXDWORD wxStaticBox::MSWGetStyle(long style, WXDWORD *exstyle) const
 
     if ( exstyle )
     {
-        *exstyle = 0;
+#ifndef __WXWINCE__
+        // We may have children inside this static box, so use this style for
+        // TAB navigation to work if we ever use IsDialogMessage() to implement
+        // it (currently we don't because it's too buggy and implement TAB
+        // navigation ourselves, but this could change in the future).
+        *exstyle |= WS_EX_CONTROLPARENT;
+
+        if (wxSystemOptions::IsFalse(wxT("msw.staticbox.optimized-paint")))
+            *exstyle |= WS_EX_TRANSPARENT;
+#endif
+    }
 
-        // If any of the ancestors are scrolling windows, style has to be
-        // WS_EX_TRANSPARENT or the static box won't be painted when the window
-        // is scrolled. We try not to do this normally, because we get a lot of
-        // flicker.
-        for ( wxWindow *win = GetParent(); win; win = win->GetParent() )
-        {
-            if ( win->HasFlag(wxVSCROLL) || win->HasFlag(wxHSCROLL) )
-            {
-                *exstyle = WS_EX_TRANSPARENT;
-                break;
-            }
+    styleWin |= BS_GROUPBOX;
 
-            if ( win->IsTopLevel() )
-                break;
-        }
+    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
 {
+    wxSize best;
+
+    // Calculate the size needed by the label
     int cx, cy;
     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);
+    // If there is a sizer then the base best size is the sizer's minimum
+    if (GetSizer() != NULL)
+    {
+        wxSize cm(GetSizer()->CalcMin());
+        best = ClientToWindowSize(cm);
+        // adjust for a long label if needed
+        best.x = wxMax(best.x, wBox);
+    }
+    // otherwise the best size falls back to the label size
+    else
+    {
+        best = wxSize(wBox, hBox);
+    }
+    return best;
 }
 
 void wxStaticBox::GetBordersForSizer(int *borderTop, int *borderOther) const
@@ -214,6 +186,42 @@ WXLRESULT wxStaticBox::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lPar
         }
     }
 
+    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;
+    }
+
+    if ( nMsg == WM_UPDATEUISTATE )
+    {
+        // DefWindowProc() redraws just the static box text when it gets this
+        // message and it does it using the standard (blue in standard theme)
+        // colour and not our own label colour that we use in PaintForeground()
+        // resulting in the label mysteriously changing the colour when e.g.
+        // "Alt" is pressed anywhere in the window, see #12497.
+        //
+        // To avoid this we simply refresh the window forcing our own code
+        // redrawing the label in the correct colour to be called. This is
+        // inefficient but there doesn't seem to be anything else we can do.
+        //
+        // Notice that the problem is XP-specific and doesn't arise under later
+        // systems.
+        if ( m_hasFgCol && wxGetWinVersion() == wxWinVersion_XP )
+            Refresh();
+    }
+
     return wxControl::MSWWindowProc(nMsg, wParam, lParam);
 }
 
@@ -236,7 +244,7 @@ SubtractRectFromRgn(HRGN hrgn, int left, int top, int right, int bottom)
     AutoHRGN hrgnRect(::CreateRectRgn(left, top, right, bottom));
     if ( !hrgnRect )
     {
-        wxLogLastError(_T("CreateRectRgn()"));
+        wxLogLastError(wxT("CreateRectRgn()"));
         return;
     }
 
@@ -269,41 +277,58 @@ WXHRGN wxStaticBox::MSWGetRegionWithoutChildren()
     RECT rc;
     ::GetWindowRect(GetHwnd(), &rc);
     HRGN hrgn = ::CreateRectRgn(rc.left, rc.top, rc.right + 1, rc.bottom + 1);
+    bool foundThis = false;
 
     // 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 *childWindow = wxGetWindowFromHWND((WXHWND) child);
+        if ( ! ::IsWindowVisible(child) )
+        {
+            // if the window isn't visible then it doesn't need clipped
+            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 ( !childWindow || !wxDynamicCast(childWindow, wxStaticBox) )
+        LONG style = ::GetWindowLong(child, GWL_STYLE);
+        wxString str(wxGetWindowClass(child));
+        str.UpperCase();
+        if ( str == wxT("BUTTON") && (style & BS_GROUPBOX) == BS_GROUPBOX )
         {
-            ::GetWindowRect(child, &rc);
-            if ( ::RectInRegion(hrgn, &rc) )
-            {
-                // need to remove WS_CLIPSIBLINGS from all sibling windows
-                // that are within this staticbox if set
-                LONG style = ::GetWindowLong(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);
-                }
+            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;
+        }
 
-                AutoHRGN hrgnChild(::CreateRectRgnIndirect(&rc));
-                ::CombineRgn(hrgn, hrgn, hrgnChild, RGN_DIFF);
+        ::GetWindowRect(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 )
+            {
+                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);
         }
     }
 
@@ -323,19 +348,149 @@ void wxStaticBox::PaintBackground(wxDC& dc, const RECT& rc)
     //     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();
-    HBRUSH hbr = (HBRUSH)parent->MSWGetBgBrush(dc.GetHDC(), GetHWND());
+    wxMSWDCImpl *impl = (wxMSWDCImpl*) dc.GetImpl();
+    HBRUSH hbr = MSWGetBgBrush(impl->GetHDC());
 
     // if there is no special brush for painting this control, just use the
     // solid background colour
     wxBrush brush;
     if ( !hbr )
     {
-        brush = wxBrush(parent->GetBackgroundColour());
+        brush = wxBrush(GetParent()->GetBackgroundColour());
         hbr = GetHbrushOf(brush);
     }
 
-    ::FillRect(GetHdcOf(dc), &rc, hbr);
+    ::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);
+
+#if wxUSE_UXTHEME
+    // 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 )
+            {
+                wxUxThemeFont themeFont;
+                if ( wxUxThemeEngine::Get()->GetThemeFont
+                                             (
+                                                hTheme,
+                                                hdc,
+                                                BP_GROUPBOX,
+                                                GBS_NORMAL,
+                                                TMT_FONT,
+                                                themeFont.GetPtr()
+                                             ) == S_OK )
+                {
+                    font.Init(themeFont.GetLOGFONT());
+                    if ( font )
+                        selFont.Init(hdc, font);
+                }
+            }
+        }
+
+        // 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;
+
+        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);
+        }
+
+        UINT drawTextFlags = DT_SINGLELINE | DT_VCENTER;
+
+        // determine the state of UI queues to draw the text correctly under XP
+        // and later systems
+        static const bool isXPorLater = wxGetWinVersion() >= wxWinVersion_XP;
+        if ( isXPorLater )
+        {
+            if ( ::SendMessage(GetHwnd(), WM_QUERYUISTATE, 0, 0) &
+                    UISF_HIDEACCEL )
+            {
+                drawTextFlags |= DT_HIDEPREFIX;
+            }
+        }
+
+        // now draw the text
+        if ( !rtl )
+        {
+            RECT rc2 = { x, 0, x + width, y };
+            ::DrawText(hdc, label.t_str(), label.length(), &rc2,
+                       drawTextFlags);
+        }
+        else // RTL
+        {
+            RECT rc2 = { x, 0, x - width, y };
+            ::DrawText(hdc, label.t_str(), label.length(), &rc2,
+                       drawTextFlags | DT_RTLREADING);
+        }
+    }
+#endif // wxUSE_UXTHEME
 }
 
 void wxStaticBox::OnPaint(wxPaintEvent& WXUNUSED(event))
@@ -349,13 +504,7 @@ void wxStaticBox::OnPaint(wxPaintEvent& WXUNUSED(event))
     memdc.SelectObject(bitmap);
 
     PaintBackground(memdc, rc);
-
-    // NB: 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 if we want to have control
-    //     over this we really have to draw everything ourselves
-    MSWDefWindowProc(WM_PAINT, (WPARAM)GetHdcOf(memdc), 0);
-
+    PaintForeground(memdc, rc);
 
     // now only blit the static box border itself, not the interior, to avoid
     // flicker when background is drawn below
@@ -371,14 +520,16 @@ void wxStaticBox::OnPaint(wxPaintEvent& WXUNUSED(event))
     dc.Blit(border, 0, rc.right - border, borderTop,
             &memdc, border, 0);
     // bottom
-    dc.Blit(border, rc.bottom - border, rc.right - border, rc.bottom,
+    dc.Blit(border, rc.bottom - border, rc.right - border, border,
             &memdc, border, rc.bottom - border);
     // left
     dc.Blit(0, 0, border, rc.bottom,
             &memdc, 0, 0);
-    // right
-    dc.Blit(rc.right - border, 0, rc.right, rc.bottom,
-            &memdc, rc.right - border, 0);
+    // right (note that upper and bottom right corners were already part of the
+    // first two blits so we shouldn't overwrite them here to avoi flicker)
+    dc.Blit(rc.right - border, borderTop,
+            border, rc.bottom - borderTop - border,
+            &memdc, rc.right - border, borderTop);
 
 
     // create the region excluding box children
@@ -389,7 +540,8 @@ void wxStaticBox::OnPaint(wxPaintEvent& WXUNUSED(event))
 
     // and also the box itself
     MSWGetRegionWithoutSelf((WXHRGN) hrgn, rc.right, rc.bottom);
-    HDCClipper clipToBg(GetHdcOf(dc), hrgn);
+    wxMSWDCImpl *impl = (wxMSWDCImpl*) dc.GetImpl();
+    HDCClipper clipToBg(GetHdcOf(*impl), hrgn);
 
     // paint the inside of the box (excluding box itself and child controls)
     PaintBackground(dc, rc);
@@ -398,4 +550,3 @@ void wxStaticBox::OnPaint(wxPaintEvent& WXUNUSED(event))
 #endif // !__WXWINCE__
 
 #endif // wxUSE_STATBOX
-