/////////////////////////////////////////////////////////////////////////////
-// 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/msw/uxtheme.h"
#include "wx/msw/private.h"
+#include "wx/msw/missing.h"
+#include "wx/msw/dc.h"
+
+// the values coincide with those in tmschema.h
+#define BP_GROUPBOX 4
+
+#define GBS_NORMAL 1
+
+#define TMT_FONT 210
// ----------------------------------------------------------------------------
// 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")
-WX_BEGIN_PROPERTIES_TABLE(wxStaticBox)
- WX_PROPERTY_SET_BY_REF( Label,wxString, SetLabel, GetLabel, wxT("") )
+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
+ TODO PROPERTIES :
+ label
*/
-WX_END_PROPERTIES_TABLE()
+wxEND_PROPERTIES_TABLE()
-WX_BEGIN_HANDLERS_TABLE(wxStaticBox)
-WX_END_HANDLERS_TABLE()
+wxBEGIN_HANDLERS_TABLE(wxStaticBox)
+wxEND_HANDLERS_TABLE()
-WX_CONSTRUCTOR_6( wxStaticBox , wxWindow* , Parent , wxWindowID , Id , wxString , Label , wxPoint , Position , wxSize , Size , long , WindowStyle )
+wxCONSTRUCTOR_6( wxStaticBox , wxWindow* , Parent , wxWindowID , Id , wxString , Label , wxPoint , Position , wxSize , Size , long , WindowStyle )
#else
IMPLEMENT_DYNAMIC_CLASS(wxStaticBox, wxControl)
#endif
const wxString& name)
{
if ( !CreateControl(parent, id, pos, size, style, wxDefaultValidator, name) )
- return FALSE;
+ return false;
- // as wxStaticBox doesn't draw its own background, we make it transparent
- // to force redrawing its background which could have been overwritten by
- // the other controls inside it
- //
- // FIXME: I still think that it isn't the right solution because the static
- // boxes shouldn't have to be transparent if the redrawing was done
- // right elsewhere - who ever had to make them transparent in non
- // wxWindows programs, after all? But for now it does fix a serious
- // problem (try resizing the sizers test screen in the layout sample
- // after removing WS_EX_TRANSPARENT bit) and so let's use it until
- // we fix the real underlying problem
- if ( !MSWCreateControl(wxT("BUTTON"), BS_GROUPBOX, pos, size, label,
-#ifdef __WXWINCE__
- 0
-#else
- WS_EX_TRANSPARENT
+ 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;
+}
+
+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
- ) )
- return FALSE;
+ *exstyle = 0;
+ }
- // to be transparent we should have the same colour as the parent as well
- SetBackgroundColour(GetParent()->GetBackgroundColour());
+ styleWin |= BS_GROUPBOX;
- return TRUE;
+ if ( wxTheApp->GetLayoutDirection() == wxLayout_RightToLeft )
+ {
+ // Make sure label is on the right
+ styleWin |= BS_RIGHT;
+ }
+
+ return styleWin;
}
wxSize wxStaticBox::DoGetBestSize() const
{
int cx, cy;
- wxGetCharSize(GetHWND(), &cx, &cy, &GetFont());
+ 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;
}
-long wxStaticBox::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
+void wxStaticBox::GetBordersForSizer(int *borderTop, int *borderOther) const
{
- switch ( nMsg )
- {
+ 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__
- case WM_NCHITTEST:
- // FIXME: this hack is specific to dialog ed, shouldn't it be
- // somehow disabled during normal operation?
+
+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;
+ }
+
+ 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);
+}
+
+// ----------------------------------------------------------------------------
+// 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)
+{
+ AutoHRGN hrgnRect(::CreateRectRgn(left, top, right, bottom));
+ if ( !hrgnRect )
+ {
+ wxLogLastError(wxT("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 )
+ {
+ 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
+ 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(GetParent()->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 )
{
- int xPos = LOWORD(lParam); // horizontal position of cursor
- int yPos = HIWORD(lParam); // vertical position of cursor
+ 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;
+ }
- ScreenToClient(&xPos, &yPos);
+ // need to adjust the rectangle to cover all the label background
+ dimensions.left -= 2;
+ dimensions.right += 2;
+ dimensions.bottom += 2;
- // 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 ( 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;
}
- break;
-#endif
- 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);
+ }
+
+ // now draw the text
+ 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);
+ }
}
+}
- 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, border,
+ &memdc, border, rc.bottom - border);
+ // left
+ dc.Blit(0, 0, border, rc.bottom,
+ &memdc, 0, 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
+ 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);
+
+ // paint the inside of the box (excluding box itself and child controls)
+ PaintBackground(dc, rc);
}
+#endif // !__WXWINCE__
+
#endif // wxUSE_STATBOX