Updating with Vadim's API changes.

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

diff --git a/src/msw/statbox.cpp b/src/msw/statbox.cpp
index 85ed4a9ade4a67af9c5cd23ef1cdd32768f1069a..010c6d822c0543364580078fcb4d112c1b88ce63 100644 (file)
--- a/src/msw/statbox.cpp
+++ b/src/msw/statbox.cpp
@@ -1,12 +1,12 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        msw/statbox.cpp
+// Name:        src/msw/statbox.cpp

 // Purpose:     wxStaticBox
 // Author:      Julian Smart
 // Modified by:
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Purpose:     wxStaticBox
 // Author:      Julian Smart
 // Modified by:
 // Created:     04/01/98
 // RCS-ID:      $Id$

-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:     wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 /////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================


@@ -17,10 +17,6 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#ifdef __GNUG__
-    #pragma implementation "statbox.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -30,20 +26,77 @@
 
 #if wxUSE_STATBOX
 
 
 #if wxUSE_STATBOX
 

+#include "wx/statbox.h"
+

 #ifndef WX_PRECOMP
     #include "wx/app.h"
     #include "wx/dcclient.h"
 #ifndef WX_PRECOMP
     #include "wx/app.h"
     #include "wx/dcclient.h"

+    #include "wx/dcmemory.h"
+    #include "wx/image.h"

 #endif
 
 #endif
 

-#include "wx/statbox.h"
+#include "wx/notebook.h"
+#include "wx/sysopt.h"

 
 

+#include "wx/msw/uxtheme.h"

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

+#include "wx/msw/missing.h"

 
 // ----------------------------------------------------------------------------
 // wxWin macros
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // wxWin macros
 // ----------------------------------------------------------------------------
 

+#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()
+
+wxBEGIN_HANDLERS_TABLE(wxStaticBox)
+wxEND_HANDLERS_TABLE()
+
+wxCONSTRUCTOR_6( wxStaticBox , wxWindow* , Parent , wxWindowID , Id , wxString , Label , wxPoint , Position , wxSize , Size , long , WindowStyle )
+#else

 IMPLEMENT_DYNAMIC_CLASS(wxStaticBox, wxControl)
 IMPLEMENT_DYNAMIC_CLASS(wxStaticBox, wxControl)

+#endif

 
 // ============================================================================
 // implementation
 
 // ============================================================================
 // implementation


@@ -62,59 +115,410 @@ bool wxStaticBox::Create(wxWindow *parent,
                          const wxString& name)
 {
     if ( !CreateControl(parent, id, pos, size, style, wxDefaultValidator, name) )
                          const wxString& name)
 {
     if ( !CreateControl(parent, id, pos, size, style, wxDefaultValidator, name) )

-        return FALSE;
+        return false;
+
+    if ( !MSWCreateControl(wxT("BUTTON"), label, pos, size) )
+        return false;

 
 

-    if ( !MSWCreateControl(wxT("BUTTON"), BS_GROUPBOX, pos, size, label, 0) )
-        return FALSE;
+    // Always use LTR layout. Otherwise, the label would be mirrored.
+    SetLayoutDirection(wxLayout_LeftToRight);

 
 

-    return TRUE;
+#ifndef __WXWINCE__
+    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);
+
+    // no need for it anymore, must be removed for wxRadioBox child
+    // buttons to be able to repaint themselves
+    styleWin &= ~WS_CLIPCHILDREN;
+
+    if ( exstyle )
+    {
+#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;

 }
 
 wxSize wxStaticBox::DoGetBestSize() const
 {
     int cx, cy;
 }
 
 wxSize wxStaticBox::DoGetBestSize() const
 {
     int cx, cy;

-    wxGetCharSize(GetHWND(), &cx, &cy, &GetFont());
+    wxGetCharSize(GetHWND(), &cx, &cy, GetFont());

 
     int wBox;
 
     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);
 
 
     wBox += 3*cx;
     int hBox = EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy);
 

-    return wxSize(wBox, hBox);
+    wxSize best(wBox, hBox);
+    CacheBestSize(best);
+    return best;
+}
+
+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
+        // so it's off by default.
+
+        static int s_useHTClient = -1;
+        if (s_useHTClient == -1)
+            s_useHTClient = wxSystemOptions::GetOptionInt(wxT("msw.staticbox.htclient"));
+        if (s_useHTClient == 1)
+        {
+            int xPos = GET_X_LPARAM(lParam);
+            int yPos = GET_Y_LPARAM(lParam);
+
+            ScreenToClient(&xPos, &yPos);
+
+            // Make sure you can drag by the top of the groupbox, but let
+            // other (enclosed) controls get mouse events also
+            if ( yPos < 10 )
+                return (long)HTCLIENT;
+        }
+    }
+
+    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);

 }
 
 }
 

-long wxStaticBox::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
+// ----------------------------------------------------------------------------
+// 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)

 {
 {

-    switch ( nMsg )
+    AutoHRGN hrgnRect(::CreateRectRgn(left, top, right, bottom));
+    if ( !hrgnRect )

     {
     {

-        case WM_NCHITTEST:
-            // FIXME: this hack is specific to dialog ed, shouldn't it be
-            //        somehow disabled during normal operation?
+        wxLogLastError(_T("CreateRectRgn()"));
+        return;
+    }
+
+    ::CombineRgn(hrgn, hrgn, hrgnRect, RGN_DIFF);
+}
+
+void wxStaticBox::MSWGetRegionWithoutSelf(WXHRGN hRgn, int w, int h)
+{
+    HRGN hrgn = (HRGN)hRgn;
+
+    // remove the area occupied by the static box borders from the region
+    int borderTop, border;
+    GetBordersForSizer(&borderTop, &border);
+
+    // top
+    SubtractRectFromRgn(hrgn, 0, 0, w, borderTop);
+
+    // bottom
+    SubtractRectFromRgn(hrgn, 0, h - border, w, h);
+
+    // left
+    SubtractRectFromRgn(hrgn, 0, 0, border, h);
+
+    // right
+    SubtractRectFromRgn(hrgn, w - border, 0, w, h);
+}
+
+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) )
+    {
+        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;
+        }
+
+        ::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 )

             {
             {

-                int xPos = LOWORD(lParam);  // horizontal position of cursor
-                int yPos = HIWORD(lParam);  // vertical position of cursor
+                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();
+    HBRUSH hbr = (HBRUSH)parent->MSWGetBgBrush(dc.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);
+    }

 
 

-                ScreenToClient(&xPos, &yPos);
+    ::FillRect(GetHdcOf(dc), &rc, hbr);
+}
+
+void wxStaticBox::PaintForeground(wxDC& dc, const RECT& rc)
+{
+    MSWDefWindowProc(WM_PAINT, (WPARAM)GetHdcOf(dc), 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 ( wxUxThemeEngine::GetIfActive() )
+    {
+        // draw over the text in default colour in our colour
+        dc.SetFont(GetFont());
+
+        HDC hdc = GetHdcOf(dc);
+        if ( m_hasFgCol )
+        {
+            ::SetTextColor(hdc, GetForegroundColour().GetPixel());
+        }
+        else
+        {
+            wxUxThemeHandle hTheme(this, L"BUTTON");
+            if (hTheme)
+            {
+                COLORREF col;
+                wxUxThemeEngine::Get()->GetThemeColor(
+                                            hTheme,
+                                            4 /* BP_GROUPBOX */,
+                                            1 /* GBS_NORMAL */,
+                                            3803 /* TMT_TEXTCOLOR */,
+                                            &col);

 
 

-                // Make sure you can drag by the top of the groupbox, but let
-                // other (enclosed) controls get mouse events also
-                if ( yPos < 10 )
-                    return (long)HTCLIENT;
+                ::SetTextColor(hdc, col);

             }
             }

-            break;
-
-        case WM_ERASEBKGND:
-            // prevent wxControl from processing this message because it will
-            // erase the background incorrectly and there is no way for us to
-            // override this at wxWin event level (if we do process the event,
-            // we don't know how to do it properly - paint the background
-            // without painting over other controls - and if we don't,
-            // wxControl still gets it)
-            return MSWDefWindowProc(nMsg, wParam, lParam);
+            else
+            {
+                // can't open the theme - default to blue
+                ::SetTextColor(hdc, 0x00D54600);
+            }
+        }
+
+        // FIXME: value of x is hardcoded as this is what it is on my system,
+        //        no idea if it's true everywhere
+
+        const bool rtl = wxTheApp->GetLayoutDirection() == wxLayout_RightToLeft;
+        if ( rtl )
+            ::SetTextAlign(hdc, TA_RTLREADING | TA_RIGHT);
+
+        // Get dimensions of the label
+        const wxString label = GetLabel();
+        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
+        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;
+        PaintBackground(dc, dimensions);
+
+        // now draw the text
+        if ( !rtl )
+        {
+            RECT rc2 = { x, 0, x + width, y };
+            ::DrawText(hdc, label, label.length(), &rc2,
+                       DT_SINGLELINE | DT_VCENTER);
+        }
+        else // RTL
+        {
+            RECT rc2 = { x, 0, x - width, y };
+            ::DrawText(hdc, label, label.length(), &rc2,
+                       DT_SINGLELINE | DT_VCENTER | DT_RTLREADING);
+        }

     }
     }

+}

 
 

-    return wxControl::MSWWindowProc(nMsg, wParam, lParam);
+void wxStaticBox::OnPaint(wxPaintEvent& WXUNUSED(event))
+{
+    RECT rc;
+    ::GetClientRect(GetHwnd(), &rc);
+
+    // draw the entire box in a memory DC
+    wxMemoryDC memdc;
+    wxBitmap bitmap(rc.right, rc.bottom);
+    memdc.SelectObject(bitmap);
+
+    PaintBackground(memdc, rc);
+    PaintForeground(memdc, rc);
+
+    // 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(border, 0, rc.right - border, borderTop,
+            &memdc, border, 0);
+    // bottom
+    dc.Blit(border, rc.bottom - border, rc.right - border, rc.bottom,
+            &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);
+
+
+    // 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);
+    HDCClipper clipToBg(GetHdcOf(dc), hrgn);
+
+    // paint the inside of the box (excluding box itself and child controls)
+    PaintBackground(dc, rc);

 }
 
 }
 

+#endif // !__WXWINCE__
+

 #endif // wxUSE_STATBOX
 #endif // wxUSE_STATBOX