/////////////////////////////////////////////////////////////////////////////
-// Name: statbox.cpp
+// Name: 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
+#if wxUSE_STATBOX
+
#ifndef WX_PRECOMP
-#include "wx/dcclient.h"
-#include "wx/app.h"
+ #include "wx/app.h"
+ #include "wx/dcclient.h"
#endif
#include "wx/statbox.h"
-#include "wx/msw/private.h"
+#include "wx/notebook.h"
+#include "wx/sysopt.h"
+#include "wx/image.h"
+#include "wx/dcmemory.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"
+
+// ----------------------------------------------------------------------------
+// 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()
-BEGIN_EVENT_TABLE(wxStaticBox, wxControl)
- EVT_ERASE_BACKGROUND(wxStaticBox::OnEraseBackground)
-END_EVENT_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)
#endif
-/*
- * Group box
- */
-
-bool wxStaticBox::Create(wxWindow *parent, wxWindowID id,
- const wxString& label,
- const wxPoint& pos,
- const wxSize& size,
- long style,
- const wxString& name)
+// ============================================================================
+// implementation
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// wxStaticBox
+// ----------------------------------------------------------------------------
+
+bool wxStaticBox::Create(wxWindow *parent,
+ wxWindowID id,
+ const wxString& label,
+ const wxPoint& pos,
+ const wxSize& size,
+ long style,
+ const wxString& name)
{
- SetName(name);
+ if ( !CreateControl(parent, id, pos, size, style, wxDefaultValidator, name) )
+ return false;
- if (parent) parent->AddChild(this);
+ if ( !MSWCreateControl(wxT("BUTTON"), label, pos, size) )
+ return false;
- SetBackgroundColour(parent->GetDefaultBackgroundColour()) ;
- SetForegroundColour(parent->GetDefaultForegroundColour()) ;
+#ifndef __WXWINCE__
+ if (!wxSystemOptions::IsFalse(wxT("msw.staticbox.optimized-paint")))
+ Connect(wxEVT_PAINT, wxPaintEventHandler(wxStaticBox::OnPaint));
+#endif // !__WXWINCE__
- if ( id == -1 )
- m_windowId = (int)NewControlId();
- else
- m_windowId = id;
-
- int x = pos.x;
- int y = pos.y;
- int width = size.x;
- int height = size.y;
+ return true;
+}
- m_windowStyle = style;
+wxBorder wxStaticBox::GetDefaultBorder() const
+{
+ return wxBORDER_NONE;
+}
- long msStyle = BS_GROUPBOX | WS_CHILD | WS_VISIBLE ; // GROUP_FLAGS;
+WXDWORD wxStaticBox::MSWGetStyle(long style, WXDWORD *exstyle) const
+{
+ long styleWin = wxStaticBoxBase::MSWGetStyle(style, exstyle);
- bool want3D;
- WXDWORD exStyle = Determine3DEffects(0, &want3D) ;
+ // no need for it anymore, must be removed for wxRadioBox child
+ // buttons to be able to repaint themselves
+ styleWin &= ~WS_CLIPCHILDREN;
- HWND wx_button =
- CreateWindowEx(exStyle, "BUTTON", (const char *)label, msStyle,
- 0, 0, 0, 0, (HWND) parent->GetHWND(), (HMENU)m_windowId,
- wxGetInstance(), NULL);
-#if CTL3D
- if (want3D)
- {
- Ctl3dSubclassCtl(wx_button);
- m_useCtl3D = TRUE;
- }
+ if ( exstyle )
+ {
+#ifndef __WXWINCE__
+ if (wxSystemOptions::IsFalse(wxT("msw.staticbox.optimized-paint")))
+ *exstyle = WS_EX_TRANSPARENT;
+ else
#endif
+ *exstyle = 0;
+ }
- m_hWnd = (WXHWND)wx_button;
+ return styleWin | BS_GROUPBOX;
+}
- // Subclass again for purposes of dialog editing mode
- SubclassWin(GetHWND());
+wxSize wxStaticBox::DoGetBestSize() const
+{
+ int cx, cy;
+ wxGetCharSize(GetHWND(), &cx, &cy, GetFont());
- SetFont(* parent->GetFont());
+ int wBox;
+ GetTextExtent(wxStripMenuCodes(wxGetWindowText(m_hWnd)), &wBox, &cy);
- SetSize(x, y, width, height);
- ShowWindow(wx_button, SW_SHOW);
+ wBox += 3*cx;
+ int hBox = EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy);
- return TRUE;
+ wxSize best(wBox, hBox);
+ CacheBestSize(best);
+ return best;
}
-void wxStaticBox::SetLabel(const wxString& label)
+void wxStaticBox::GetBordersForSizer(int *borderTop, int *borderOther) const
{
- SetWindowText((HWND)m_hWnd, (const char *)label);
+ wxStaticBoxBase::GetBordersForSizer(borderTop, borderOther);
+
+ // need extra space, don't know how much but this seems to be enough
+ *borderTop += GetCharHeight()/3;
}
-void wxStaticBox::SetSize(int x, int y, int width, int height, int sizeFlags)
+// all the hacks below are not necessary for WinCE
+#ifndef __WXWINCE__
+
+WXLRESULT wxStaticBox::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
{
- int currentX, currentY;
- GetPosition(¤tX, ¤tY);
+ 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;
+ }
+ }
- int x1 = x;
- int y1 = y;
- int w1 = width;
- int h1 = height;
+ 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 (x == -1 || (sizeFlags & wxSIZE_ALLOW_MINUS_ONE))
- x1 = currentX;
- if (y == -1 || (sizeFlags & wxSIZE_ALLOW_MINUS_ONE))
- y1 = currentY;
+ return wxControl::MSWWindowProc(nMsg, wParam, lParam);
+}
- AdjustForParentClientOrigin(x1, y1, sizeFlags);
+// ----------------------------------------------------------------------------
+// static box drawing
+// ----------------------------------------------------------------------------
- // If we're prepared to use the existing size, then...
- if (width == -1 && height == -1 && ((sizeFlags & wxSIZE_AUTO) != wxSIZE_AUTO))
- {
- GetSize(&w1, &h1);
- }
+/*
+ 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.
+ */
- int current_width;
+// 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(_T("CreateRectRgn()"));
+ return;
+ }
- int cx;
- int cy;
- int cyf;
+ ::CombineRgn(hrgn, hrgn, hrgnRect, RGN_DIFF);
+}
- wxGetCharSize(GetHWND(), &cx, &cy,GetFont());
+void wxStaticBox::MSWGetRegionWithoutSelf(WXHRGN hRgn, int w, int h)
+{
+ HRGN hrgn = (HRGN)hRgn;
- GetTextExtent(wxGetWindowText(m_hWnd), ¤t_width, &cyf,
- NULL,NULL,GetFont());
- if ( w1 < 0 )
- w1 = current_width + 3*cx;
- if ( h1 < 0 )
- h1 = EDIT_HEIGHT_FROM_CHAR_HEIGHT(cyf);
+ // remove the area occupied by the static box borders from the region
+ int borderTop, border;
+ GetBordersForSizer(&borderTop, &border);
- MoveWindow((HWND)m_hWnd, x1, y1, w1, h1, TRUE);
-}
+ // top
+ SubtractRectFromRgn(hrgn, 0, 0, w, borderTop);
-WXHBRUSH wxStaticBox::OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor,
- WXUINT message, WXWPARAM wParam, WXLPARAM lParam)
-{
-#if CTL3D
- if ( m_useCtl3D )
- {
- HBRUSH hbrush = Ctl3dCtlColorEx(message, wParam, lParam);
- return (WXHBRUSH) hbrush;
- }
-#endif
+ // bottom
+ SubtractRectFromRgn(hrgn, 0, h - border, w, h);
- if (GetParent()->GetTransparentBackground())
- SetBkMode((HDC) pDC, TRANSPARENT);
- else
- SetBkMode((HDC) pDC, OPAQUE);
+ // left
+ SubtractRectFromRgn(hrgn, 0, 0, border, h);
- ::SetBkColor((HDC) pDC, RGB(GetBackgroundColour().Red(), GetBackgroundColour().Green(), GetBackgroundColour().Blue()));
- ::SetTextColor((HDC) pDC, RGB(GetForegroundColour().Red(), GetForegroundColour().Green(), GetForegroundColour().Blue()));
+ // right
+ SubtractRectFromRgn(hrgn, w - border, 0, w, h);
+}
- wxBrush *backgroundBrush = wxTheBrushList->FindOrCreateBrush(GetBackgroundColour(), wxSOLID);
+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);
+ }
+ }
- // Note that this will be cleaned up in wxApp::OnIdle, if backgroundBrush
- // has a zero usage count.
-// backgroundBrush->RealizeResource();
- return (WXHBRUSH) backgroundBrush->GetResourceHandle();
+ return (WXHRGN)hrgn;
}
-// Shouldn't erase the whole window, since the static box must only paint its
-// outline.
-void wxStaticBox::OnEraseBackground(wxEraseEvent& event)
+// 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 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
- Default();
+ // 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);
+ }
+
+ ::FillRect(GetHdcOf(dc), &rc, hbr);
}
-long wxStaticBox::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
+void wxStaticBox::PaintForeground(wxDC& dc, const RECT& WXUNUSED(rc))
{
- if (nMsg == WM_NCHITTEST)
+ 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 ( m_hasFgCol && wxUxThemeEngine::GetIfActive() )
{
- int xPos = LOWORD(lParam); // horizontal position of cursor
- int yPos = HIWORD(lParam); // vertical position of cursor
+ // draw over the text in default colour in our colour
+ dc.SetFont(GetFont());
- ScreenToClient(&xPos, &yPos);
+ HDC hdc = GetHdcOf(dc);
+ ::SetTextColor(hdc, GetForegroundColour().GetPixel());
- // 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;
+ // FIXME: value of x is hardcoded as this is what it is on my system,
+ // no idea if it's true everywhere
+ const int y = dc.GetCharHeight();
+ const int x = 9;
+
+ // TODO: RTL?
+ RECT rc = { x, 0, GetSize().x, y };
+
+ const wxString label = GetLabel();
+ ::DrawText(hdc, label, label.length(), &rc, DT_SINGLELINE | DT_VCENTER);
}
+}
- 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
+