Several corrections to wxDocManager fields documentation.

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

diff --git a/src/msw/statbox.cpp b/src/msw/statbox.cpp
index b426f923e4cbdad63e91e95d9ac804651fa4ac43..75306978e01fd8d987e3245d23ded74ed416cda0 100644 (file)
--- a/src/msw/statbox.cpp
+++ b/src/msw/statbox.cpp
@@ -41,62 +41,18 @@
 #include "wx/msw/uxtheme.h"
 #include "wx/msw/private.h"
 #include "wx/msw/missing.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
 
 // ============================================================================
 // implementation


@@ -120,6 +76,9 @@ bool wxStaticBox::Create(wxWindow *parent,
     if ( !MSWCreateControl(wxT("BUTTON"), label, pos, size) )
         return false;
 
     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));
 #ifndef __WXWINCE__
     if (!wxSystemOptions::IsFalse(wxT("msw.staticbox.optimized-paint")))
         Connect(wxEVT_PAINT, wxPaintEventHandler(wxStaticBox::OnPaint));


@@ -128,11 +87,6 @@ bool wxStaticBox::Create(wxWindow *parent,
     return true;
 }
 
     return true;
 }
 

-wxBorder wxStaticBox::GetDefaultBorder() const
-{
-    return wxBORDER_NONE;
-}
-

 WXDWORD wxStaticBox::MSWGetStyle(long style, WXDWORD *exstyle) const
 {
     long styleWin = wxStaticBoxBase::MSWGetStyle(style, exstyle);
 WXDWORD wxStaticBox::MSWGetStyle(long style, WXDWORD *exstyle) const
 {
     long styleWin = wxStaticBoxBase::MSWGetStyle(style, exstyle);


@@ -151,7 +105,15 @@ WXDWORD wxStaticBox::MSWGetStyle(long style, WXDWORD *exstyle) const
             *exstyle = 0;
     }
 
             *exstyle = 0;
     }
 

-    return styleWin | BS_GROUPBOX;
+    styleWin |= BS_GROUPBOX;
+
+    if ( wxTheApp->GetLayoutDirection() == wxLayout_RightToLeft )
+    {
+        // Make sure label is on the right
+        styleWin |= BS_RIGHT;
+    }
+
+    return styleWin;

 }
 
 wxSize wxStaticBox::DoGetBestSize() const
 }
 
 wxSize wxStaticBox::DoGetBestSize() const


@@ -223,6 +185,24 @@ WXLRESULT wxStaticBox::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lPar
         return 0;
     }
 
         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);
 }
 
     return wxControl::MSWWindowProc(nMsg, wParam, lParam);
 }
 


@@ -245,7 +225,7 @@ SubtractRectFromRgn(HRGN hrgn, int left, int top, int right, int bottom)
     AutoHRGN hrgnRect(::CreateRectRgn(left, top, right, bottom));
     if ( !hrgnRect )
     {
     AutoHRGN hrgnRect(::CreateRectRgn(left, top, right, bottom));
     if ( !hrgnRect )
     {

-        wxLogLastError(_T("CreateRectRgn()"));
+        wxLogLastError(wxT("CreateRectRgn()"));

         return;
     }
 
         return;
     }
 


@@ -349,84 +329,146 @@ 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
     //     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 )
     {
 
     // 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);
     }
 
         hbr = GetHbrushOf(brush);
     }
 

-    ::FillRect(GetHdcOf(dc), &rc, hbr);
+    ::FillRect(GetHdcOf(*impl), &rc, hbr);

 }
 
 }
 

-void wxStaticBox::PaintForeground(wxDC& dc, const RECT& WXUNUSED(rc))
+void wxStaticBox::PaintForeground(wxDC& dc, const RECT& rc)

 {
 {

-    MSWDefWindowProc(WM_PAINT, (WPARAM)GetHdcOf(dc), 0);
+    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
 
     // 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 ( wxUxThemeEngine::GetIfActive() )
+    if ( m_hasFgCol && wxUxThemeEngine::GetIfActive() )

     {
         // draw over the text in default colour in our colour
     {
         // draw over the text in default colour in our colour

-        dc.SetFont(GetFont());
+        HDC hdc = GetHdcOf(*impl);
+        ::SetTextColor(hdc, GetForegroundColour().GetPixel());
+
+        const bool rtl = wxTheApp->GetLayoutDirection() == wxLayout_RightToLeft;
+        if ( rtl )
+            ::SetTextAlign(hdc, TA_RTLREADING | TA_RIGHT);

 
 

-        HDC hdc = GetHdcOf(dc);
-        if ( m_hasFgCol )
+        // Get dimensions of the label
+        const wxString label = GetLabel();
+
+        // choose the correct font
+        AutoHFONT font;
+        SelectInHDC selFont;
+        if ( m_hasFont )

         {
         {

-            ::SetTextColor(hdc, GetForegroundColour().GetPixel());
+            selFont.Init(hdc, GetHfontOf(GetFont()));

         }
         }

-        else
+        else // no font set, use the one set by the theme

         {
             wxUxThemeHandle hTheme(this, L"BUTTON");
         {
             wxUxThemeHandle hTheme(this, L"BUTTON");

-            if (hTheme)
+            if ( hTheme )

             {
             {

-                COLORREF col;
-                wxUxThemeEngine::Get()->GetThemeColor(
-                                            hTheme,
-                                            4 /* BP_GROUPBOX */,
-                                            1 /* GBS_NORMAL */,
-                                            3803 /* TMT_TEXTCOLOR */,
-                                            &col);
-
-                ::SetTextColor(hdc, col);
-            }
-            else
-            {
-                // can't open the theme - default to blue
-                ::SetTextColor(hdc, 0x00D54600);
+                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);
+                }

             }
         }
 
             }
         }
 

-        // FIXME: value of x is hardcoded as this is what it is on my system,
-        //        no idea if it's true everywhere
-        // TODO: RTL?
-        const int x = 9;
-        const int y = dc.GetCharHeight();
-        const wxString label = GetLabel();
+        // 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
 
         // first we need to correctly paint the background of the label
         // as Windows ignores the brush offset when doing it

-        RECT rc = { x, 0, GetSize().x, y };
-        ::DrawText(hdc, label, label.length(), &rc,
-                   DT_SINGLELINE | DT_VCENTER | DT_CALCRECT);
+        //
+        // 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
 
         // need to adjust the rectangle to cover all the label background

-        rc.left -= 2;
-        rc.right += 2;
-        rc.bottom += 2;
-        PaintBackground(dc, rc);
+        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
 
         // now draw the text

-        RECT rc2 = { x, 0, GetSize().x, y };
-        ::DrawText(hdc, label, label.length(), &rc2,
-                   DT_SINGLELINE | DT_VCENTER);
+        if ( !rtl )
+        {
+            RECT rc2 = { x, 0, x + width, y };
+            ::DrawText(hdc, label.wx_str(), label.length(), &rc2,
+                       drawTextFlags);
+        }
+        else // RTL
+        {
+            RECT rc2 = { x, 0, x - width, y };
+            ::DrawText(hdc, label.wx_str(), label.length(), &rc2,
+                       drawTextFlags | DT_RTLREADING);
+        }

     }
 }
 
     }
 }
 


@@ -457,14 +499,16 @@ void wxStaticBox::OnPaint(wxPaintEvent& WXUNUSED(event))
     dc.Blit(border, 0, rc.right - border, borderTop,
             &memdc, border, 0);
     // bottom
     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);
             &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
 
 
     // create the region excluding box children


@@ -475,7 +519,8 @@ void wxStaticBox::OnPaint(wxPaintEvent& WXUNUSED(event))
 
     // and also the box itself
     MSWGetRegionWithoutSelf((WXHRGN) hrgn, rc.right, rc.bottom);
 
     // 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);
 
     // paint the inside of the box (excluding box itself and child controls)
     PaintBackground(dc, rc);