X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0c589ad076cb531a3ef7808aaedadc03c8286942..eea4d01c65f9b29baa1193db762b4c6b8144af24:/src/msw/statbox.cpp?ds=sidebyside diff --git a/src/msw/statbox.cpp b/src/msw/statbox.cpp index 15d87f01bc..75306978e0 100644 --- a/src/msw/statbox.cpp +++ b/src/msw/statbox.cpp @@ -1,233 +1,531 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: statbox.cpp +// Name: src/msw/statbox.cpp // 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 ///////////////////////////////////////////////////////////////////////////// -#ifdef __GNUG__ -#pragma implementation "statbox.h" -#endif +// ============================================================================ +// declarations +// ============================================================================ + +// ---------------------------------------------------------------------------- +// headers +// ---------------------------------------------------------------------------- // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" #ifdef __BORLANDC__ -#pragma hdrstop + #pragma hdrstop #endif -#include "wx/window.h" -#include "wx/msw/private.h" +#if wxUSE_STATBOX + +#include "wx/statbox.h" #ifndef WX_PRECOMP -#include "wx/app.h" -#include "wx/dcclient.h" + #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" -#if !USE_SHARED_LIBRARY -IMPLEMENT_DYNAMIC_CLASS(wxStaticBox, wxControl) +#include "wx/msw/uxtheme.h" +#include "wx/msw/private.h" +#include "wx/msw/missing.h" +#include "wx/msw/dc.h" -BEGIN_EVENT_TABLE(wxStaticBox, wxControl) - EVT_ERASE_BACKGROUND(wxStaticBox::OnEraseBackground) -END_EVENT_TABLE() +// the values coincide with those in tmschema.h +#define BP_GROUPBOX 4 -#endif +#define GBS_NORMAL 1 -/* - * Group box - */ - -bool wxStaticBox::Create(wxWindow *parent, wxWindowID id, - const wxString& label, - const wxPoint& pos, - const wxSize& size, - long style, - const wxString& name) -{ - SetName(name); +#define TMT_FONT 210 - if (parent) parent->AddChild(this); +// ---------------------------------------------------------------------------- +// wxWin macros +// ---------------------------------------------------------------------------- - SetBackgroundColour(parent->GetBackgroundColour()) ; - SetForegroundColour(parent->GetForegroundColour()) ; +// ============================================================================ +// implementation +// ============================================================================ - if ( id == -1 ) - m_windowId = (int)NewControlId(); - else - m_windowId = id; +// ---------------------------------------------------------------------------- +// wxStaticBox +// ---------------------------------------------------------------------------- - int x = pos.x; - int y = pos.y; - int width = size.x; - int height = size.y; +bool wxStaticBox::Create(wxWindow *parent, + wxWindowID id, + const wxString& label, + const wxPoint& pos, + const wxSize& size, + long style, + const wxString& name) +{ + if ( !CreateControl(parent, id, pos, size, style, wxDefaultValidator, name) ) + return false; - m_windowStyle = style; + if ( !MSWCreateControl(wxT("BUTTON"), label, pos, size) ) + return false; - long msStyle = BS_GROUPBOX | WS_CHILD | WS_VISIBLE ; // GROUP_FLAGS; + // Always use LTR layout. Otherwise, the label would be mirrored. + SetLayoutDirection(wxLayout_LeftToRight); - bool want3D; - WXDWORD exStyle = Determine3DEffects(0, &want3D) ; +#ifndef __WXWINCE__ + if (!wxSystemOptions::IsFalse(wxT("msw.staticbox.optimized-paint"))) + Connect(wxEVT_PAINT, wxPaintEventHandler(wxStaticBox::OnPaint)); +#endif // !__WXWINCE__ - HWND wx_button = - CreateWindowEx(exStyle, "BUTTON", (const char *)label, msStyle, - 0, 0, 0, 0, (HWND) parent->GetHWND(), (HMENU)m_windowId, - wxGetInstance(), NULL); -#if wxUSE_CTL3D - if (want3D) - { - Ctl3dSubclassCtl(wx_button); - m_useCtl3D = TRUE; - } -#endif + return true; +} - m_hWnd = (WXHWND)wx_button; +WXDWORD wxStaticBox::MSWGetStyle(long style, WXDWORD *exstyle) const +{ + long styleWin = wxStaticBoxBase::MSWGetStyle(style, exstyle); - // Subclass again for purposes of dialog editing mode - SubclassWin(GetHWND()); + // no need for it anymore, must be removed for wxRadioBox child + // buttons to be able to repaint themselves + styleWin &= ~WS_CLIPCHILDREN; - SetFont(parent->GetFont()); + if ( exstyle ) + { +#ifndef __WXWINCE__ + if (wxSystemOptions::IsFalse(wxT("msw.staticbox.optimized-paint"))) + *exstyle = WS_EX_TRANSPARENT; + else +#endif + *exstyle = 0; + } - SetSize(x, y, width, height); - ShowWindow(wx_button, SW_SHOW); + styleWin |= BS_GROUPBOX; + + if ( wxTheApp->GetLayoutDirection() == wxLayout_RightToLeft ) + { + // Make sure label is on the right + styleWin |= BS_RIGHT; + } - return TRUE; + return styleWin; } -void wxStaticBox::SetLabel(const wxString& label) +wxSize wxStaticBox::DoGetBestSize() const { - SetWindowText((HWND)m_hWnd, (const char *)label); + int cx, cy; + wxGetCharSize(GetHWND(), &cx, &cy, GetFont()); + + int wBox; + GetTextExtent(GetLabelText(wxGetWindowText(m_hWnd)), &wBox, &cy); + + wBox += 3*cx; + int hBox = EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy); + + wxSize best(wBox, hBox); + CacheBestSize(best); + return best; } -void wxStaticBox::DoSetSize(int x, int y, int width, int height, int sizeFlags) +void wxStaticBox::GetBordersForSizer(int *borderTop, int *borderOther) const { - int currentX, currentY; - GetPosition(¤tX, ¤tY); + wxStaticBoxBase::GetBordersForSizer(borderTop, borderOther); - int x1 = x; - int y1 = y; - int w1 = width; - int h1 = height; + // need extra space, don't know how much but this seems to be enough + *borderTop += GetCharHeight()/3; +} - if (x == -1 || (sizeFlags & wxSIZE_ALLOW_MINUS_ONE)) - x1 = currentX; - if (y == -1 || (sizeFlags & wxSIZE_ALLOW_MINUS_ONE)) - y1 = currentY; +// all the hacks below are not necessary for WinCE +#ifndef __WXWINCE__ - AdjustForParentClientOrigin(x1, y1, sizeFlags); +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 we're prepared to use the existing size, then... - if (width == -1 && height == -1 && ((sizeFlags & wxSIZE_AUTO) != wxSIZE_AUTO)) - { - GetSize(&w1, &h1); - } + 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; + } - int current_width; + 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(); + } - int cx; - int cy; - int cyf; + return wxControl::MSWWindowProc(nMsg, wParam, lParam); +} - wxGetCharSize(GetHWND(), &cx, &cy, & this->GetFont()); +// ---------------------------------------------------------------------------- +// static box drawing +// ---------------------------------------------------------------------------- - GetTextExtent(wxGetWindowText(m_hWnd), ¤t_width, &cyf, - NULL,NULL, & this->GetFont()); - if ( w1 < 0 ) - w1 = current_width + 3*cx; - if ( h1 < 0 ) - h1 = EDIT_HEIGHT_FROM_CHAR_HEIGHT(cyf); +/* + 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; + } - MoveWindow((HWND)m_hWnd, x1, y1, w1, h1, TRUE); + ::CombineRgn(hrgn, hrgn, hrgnRect, RGN_DIFF); } -WXHBRUSH wxStaticBox::OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor, - WXUINT message, WXWPARAM wParam, WXLPARAM lParam) +void wxStaticBox::MSWGetRegionWithoutSelf(WXHRGN hRgn, int w, int h) { -#if wxUSE_CTL3D - if ( m_useCtl3D ) - { - HBRUSH hbrush = Ctl3dCtlColorEx(message, wParam, lParam); - return (WXHBRUSH) hbrush; - } -#endif + HRGN hrgn = (HRGN)hRgn; + + // remove the area occupied by the static box borders from the region + int borderTop, border; + GetBordersForSizer(&borderTop, &border); - if (GetParent()->GetTransparentBackground()) - SetBkMode((HDC) pDC, TRANSPARENT); - else - SetBkMode((HDC) pDC, OPAQUE); + // top + SubtractRectFromRgn(hrgn, 0, 0, w, borderTop); - ::SetBkColor((HDC) pDC, RGB(GetBackgroundColour().Red(), GetBackgroundColour().Green(), GetBackgroundColour().Blue())); - ::SetTextColor((HDC) pDC, RGB(GetForegroundColour().Red(), GetForegroundColour().Green(), GetForegroundColour().Blue())); + // bottom + SubtractRectFromRgn(hrgn, 0, h - border, w, h); - wxBrush *backgroundBrush = wxTheBrushList->FindOrCreateBrush(GetBackgroundColour(), wxSOLID); + // left + SubtractRectFromRgn(hrgn, 0, 0, border, h); - // Note that this will be cleaned up in wxApp::OnIdle, if backgroundBrush - // has a zero usage count. -// backgroundBrush->RealizeResource(); - return (WXHBRUSH) backgroundBrush->GetResourceHandle(); + // right + SubtractRectFromRgn(hrgn, w - border, 0, w, h); } -// Shouldn't erase the whole window, since the static box must only paint its -// outline. -void wxStaticBox::OnEraseBackground(wxEraseEvent& event) +WXHRGN wxStaticBox::MSWGetRegionWithoutChildren() { - // If we don't have this (call Default()), we don't paint the background properly. - // If we do have this, we seem to overwrite enclosed controls. - // Is it the WS_CLIPCHILDREN style that's causing the problems? - // Probably - without this style, the background of the window will show through, - // so the control doesn't have to paint it. The window background will always be - // painted before all other controls, therefore there are no problems with - // controls being hidden by the static box. - // So, if we could specify wxCLIP_CHILDREN in window, or not, we could optimise painting better. - // We would assume wxCLIP_CHILDREN in a frame and a scrolled window, but not in a panel. - // Is this too platform-specific?? What else can we do? Not a lot, since we have to pass - // this information from arbitrary wxWindow derivatives, and it depends on what you wish to - // do with the windows. - // Alternatively, just make sure that wxStaticBox is always at the back! There are probably - // few other circumstances where it matters about child clipping. But what about painting onto - // to panel, inside a groupbox? Doesn't appear, because the box wipes it out. - wxWindow *parent = GetParent(); - if ( parent && parent->GetHWND() && (::GetWindowLong((HWND) parent->GetHWND(), GWL_STYLE) & WS_CLIPCHILDREN) ) - { - // TODO: May in fact need to generate a paint event for inside this - // control's rectangle, otherwise all controls are going to be clipped - - // ugh. - HBRUSH hBrush = ::CreateSolidBrush(PALETTERGB(GetBackgroundColour().Red(), GetBackgroundColour().Green(), GetBackgroundColour().Blue())); - int mode = ::SetMapMode((HDC) event.GetDC()->GetHDC(), MM_TEXT); - - RECT rect; - - ::GetClientRect((HWND) GetHWND(), &rect); - ::FillRect ((HDC) event.GetDC()->GetHDC(), &rect, hBrush); - ::DeleteObject(hBrush); - ::SetMapMode((HDC) event.GetDC()->GetHDC(), mode); - } - else - { - event.Skip(); - } + 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; } -long wxStaticBox::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam) +// 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) { - if (nMsg == WM_NCHITTEST) + // 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 ) { - int xPos = LOWORD(lParam); // horizontal position of cursor - int yPos = HIWORD(lParam); // vertical position of cursor + brush = wxBrush(GetParent()->GetBackgroundColour()); + hbr = GetHbrushOf(brush); + } - ScreenToClient(&xPos, &yPos); + ::FillRect(GetHdcOf(*impl), &rc, hbr); +} - // 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; +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 ) + { + 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.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