src/msw/statbox.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        msw/statbox.cpp
   3 // Purpose:     wxStaticBox
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     04/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  21     #pragma implementation "statbox.h"
  22 #endif
  23
  24 // For compilers that support precompilation, includes "wx.h".
  25 #include "wx/wxprec.h"
  26
  27 #ifdef __BORLANDC__
  28     #pragma hdrstop
  29 #endif
  30
  31 #if wxUSE_STATBOX
  32
  33 #ifndef WX_PRECOMP
  34     #include "wx/app.h"
  35     #include "wx/dcclient.h"
  36 #endif
  37
  38 #include "wx/statbox.h"
  39 #include "wx/notebook.h"
  40 #include "wx/sysopt.h"
  41 #include "wx/image.h"
  42 #include "wx/dcmemory.h"
  43 #include "wx/sysopt.h"
  44
  45 #include "wx/msw/uxtheme.h"
  46 #include "wx/msw/private.h"
  47 #include "wx/msw/missing.h"
  48
  49 // ----------------------------------------------------------------------------
  50 // wxWin macros
  51 // ----------------------------------------------------------------------------
  52
  53 #if wxUSE_EXTENDED_RTTI
  54 WX_DEFINE_FLAGS( wxStaticBoxStyle )
  55
  56 wxBEGIN_FLAGS( wxStaticBoxStyle )
  57     // new style border flags, we put them first to
  58     // use them for streaming out
  59     wxFLAGS_MEMBER(wxBORDER_SIMPLE)
  60     wxFLAGS_MEMBER(wxBORDER_SUNKEN)
  61     wxFLAGS_MEMBER(wxBORDER_DOUBLE)
  62     wxFLAGS_MEMBER(wxBORDER_RAISED)
  63     wxFLAGS_MEMBER(wxBORDER_STATIC)
  64     wxFLAGS_MEMBER(wxBORDER_NONE)
  65
  66     // old style border flags
  67     wxFLAGS_MEMBER(wxSIMPLE_BORDER)
  68     wxFLAGS_MEMBER(wxSUNKEN_BORDER)
  69     wxFLAGS_MEMBER(wxDOUBLE_BORDER)
  70     wxFLAGS_MEMBER(wxRAISED_BORDER)
  71     wxFLAGS_MEMBER(wxSTATIC_BORDER)
  72     wxFLAGS_MEMBER(wxBORDER)
  73
  74     // standard window styles
  75     wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
  76     wxFLAGS_MEMBER(wxCLIP_CHILDREN)
  77     wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
  78     wxFLAGS_MEMBER(wxWANTS_CHARS)
  79     wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
  80     wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
  81     wxFLAGS_MEMBER(wxVSCROLL)
  82     wxFLAGS_MEMBER(wxHSCROLL)
  83
  84 wxEND_FLAGS( wxStaticBoxStyle )
  85
  86 IMPLEMENT_DYNAMIC_CLASS_XTI(wxStaticBox, wxControl,"wx/statbox.h")
  87
  88 wxBEGIN_PROPERTIES_TABLE(wxStaticBox)
  89     wxPROPERTY( Label,wxString, SetLabel, GetLabel, wxString() , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
  90     wxPROPERTY_FLAGS( WindowStyle , wxStaticBoxStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
  91 /*
  92     TODO PROPERTIES :
  93         label
  94 */
  95 wxEND_PROPERTIES_TABLE()
  96
  97 wxBEGIN_HANDLERS_TABLE(wxStaticBox)
  98 wxEND_HANDLERS_TABLE()
  99
 100 wxCONSTRUCTOR_6( wxStaticBox , wxWindow* , Parent , wxWindowID , Id , wxString , Label , wxPoint , Position , wxSize , Size , long , WindowStyle )
 101 #else
 102 IMPLEMENT_DYNAMIC_CLASS(wxStaticBox, wxControl)
 103 #endif
 104
 105 // ============================================================================
 106 // implementation
 107 // ============================================================================
 108
 109 // ----------------------------------------------------------------------------
 110 // wxStaticBox
 111 // ----------------------------------------------------------------------------
 112
 113 bool wxStaticBox::Create(wxWindow *parent,
 114                          wxWindowID id,
 115                          const wxString& label,
 116                          const wxPoint& pos,
 117                          const wxSize& size,
 118                          long style,
 119                          const wxString& name)
 120 {
 121     if ( !CreateControl(parent, id, pos, size, style, wxDefaultValidator, name) )
 122         return false;
 123
 124     if ( !MSWCreateControl(wxT("BUTTON"), label, pos, size) )
 125         return false;
 126
 127 #ifndef __WXWINCE__
 128     if (!wxSystemOptions::IsFalse(wxT("msw.staticbox.optimized-paint")))
 129         Connect(wxEVT_PAINT, wxPaintEventHandler(wxStaticBox::OnPaint));
 130 #endif // !__WXWINCE__
 131
 132     return true;
 133 }
 134
 135 wxBorder wxStaticBox::GetDefaultBorder() const
 136 {
 137     return wxBORDER_NONE;
 138 }
 139
 140 WXDWORD wxStaticBox::MSWGetStyle(long style, WXDWORD *exstyle) const
 141 {
 142     long styleWin = wxStaticBoxBase::MSWGetStyle(style, exstyle);
 143
 144     // no need for it anymore, must be removed for wxRadioBox child
 145     // buttons to be able to repaint themselves
 146     styleWin &= ~WS_CLIPCHILDREN;
 147
 148     if ( exstyle )
 149     {
 150 #ifndef __WXWINCE__
 151         if (wxSystemOptions::IsFalse(wxT("msw.staticbox.optimized-paint")))
 152             *exstyle = WS_EX_TRANSPARENT;
 153         else
 154 #endif
 155             *exstyle = 0;
 156     }
 157
 158     return styleWin | BS_GROUPBOX;
 159 }
 160
 161 wxSize wxStaticBox::DoGetBestSize() const
 162 {
 163     int cx, cy;
 164     wxGetCharSize(GetHWND(), &cx, &cy, GetFont());
 165
 166     int wBox;
 167     GetTextExtent(wxGetWindowText(m_hWnd), &wBox, &cy);
 168
 169     wBox += 3*cx;
 170     int hBox = EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy);
 171
 172     wxSize best(wBox, hBox);
 173     CacheBestSize(best);
 174     return best;
 175 }
 176
 177 void wxStaticBox::GetBordersForSizer(int *borderTop, int *borderOther) const
 178 {
 179     wxStaticBoxBase::GetBordersForSizer(borderTop, borderOther);
 180
 181     // need extra space, don't know how much but this seems to be enough
 182     *borderTop += GetCharHeight()/3;
 183 }
 184
 185 // all the hacks below are not necessary for WinCE
 186 #ifndef __WXWINCE__
 187
 188 WXLRESULT wxStaticBox::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
 189 {
 190     if ( nMsg == WM_NCHITTEST )
 191     {
 192         // This code breaks some other processing such as enter/leave tracking
 193         // so it's off by default.
 194
 195         static int s_useHTClient = -1;
 196         if (s_useHTClient == -1)
 197             s_useHTClient = wxSystemOptions::GetOptionInt(wxT("msw.staticbox.htclient"));
 198         if (s_useHTClient == 1)
 199         {
 200             int xPos = GET_X_LPARAM(lParam);
 201             int yPos = GET_Y_LPARAM(lParam);
 202
 203             ScreenToClient(&xPos, &yPos);
 204
 205             // Make sure you can drag by the top of the groupbox, but let
 206             // other (enclosed) controls get mouse events also
 207             if ( yPos < 10 )
 208                 return (long)HTCLIENT;
 209         }
 210     }
 211
 212     return wxControl::MSWWindowProc(nMsg, wParam, lParam);
 213 }
 214
 215 // ----------------------------------------------------------------------------
 216 // static box drawing
 217 // ----------------------------------------------------------------------------
 218
 219 /*
 220    We draw the static box ourselves because it's the only way to prevent it
 221    from flickering horribly on resize (because everything inside the box is
 222    erased twice: once when the box itself is repainted and second time when
 223    the control inside it is repainted) without using WS_EX_TRANSPARENT style as
 224    we used to do and which resulted in other problems.
 225  */
 226
 227 // MSWGetRegionWithoutSelf helper: removes the given rectangle from region
 228 static inline void
 229 SubtractRectFromRgn(HRGN hrgn, int left, int top, int right, int bottom)
 230 {
 231     AutoHRGN hrgnRect(::CreateRectRgn(left, top, right, bottom));
 232     if ( !hrgnRect )
 233     {
 234         wxLogLastError(_T("CreateRectRgn()"));
 235         return;
 236     }
 237
 238     ::CombineRgn(hrgn, hrgn, hrgnRect, RGN_DIFF);
 239 }
 240
 241 void wxStaticBox::MSWGetRegionWithoutSelf(WXHRGN hRgn, int w, int h)
 242 {
 243     HRGN hrgn = (HRGN)hRgn;
 244
 245     // remove the area occupied by the static box borders from the region
 246     int borderTop, border;
 247     GetBordersForSizer(&borderTop, &border);
 248
 249     // top
 250     SubtractRectFromRgn(hrgn, 0, 0, w, borderTop);
 251
 252     // bottom
 253     SubtractRectFromRgn(hrgn, 0, h - border, w, h);
 254
 255     // left
 256     SubtractRectFromRgn(hrgn, 0, 0, border, h);
 257
 258     // right
 259     SubtractRectFromRgn(hrgn, w - border, 0, w, h);
 260 }
 261
 262 WXHRGN wxStaticBox::MSWGetRegionWithoutChildren()
 263 {
 264     RECT rc;
 265     ::GetWindowRect(GetHwnd(), &rc);
 266     HRGN hrgn = ::CreateRectRgn(rc.left, rc.top, rc.right + 1, rc.bottom + 1);
 267
 268     // iterate over all child windows (not just wxWindows but all windows)
 269     for ( HWND child = ::GetWindow(GetHwndOf(GetParent()), GW_CHILD);
 270           child;
 271           child = ::GetWindow(child, GW_HWNDNEXT) )
 272     {
 273         if ( ! ::IsWindowVisible(child) )
 274         {
 275             // if the window isn't visible then it doesn't need clipped
 276             continue;
 277         }
 278
 279         LONG style = ::GetWindowLong(child, GWL_STYLE);
 280         wxString str(wxGetWindowClass(child));
 281         str.UpperCase();
 282         if ( str == wxT("BUTTON") && (style & BS_GROUPBOX) == BS_GROUPBOX )
 283         {
 284             // Don't clip any static boxes, not just this one.  This will
 285             // result in flicker in overlapping static boxes, but at least
 286             // they will all be drawn correctly and we shouldn't have
 287             // overlapping windows anyway.
 288             continue;
 289         }
 290
 291         ::GetWindowRect(child, &rc);
 292         if ( ::RectInRegion(hrgn, &rc) )
 293         {
 294             // need to remove WS_CLIPSIBLINGS from all sibling windows
 295             // that are within this staticbox if set
 296             if ( style & WS_CLIPSIBLINGS )
 297             {
 298                 style &= ~WS_CLIPSIBLINGS;
 299                 ::SetWindowLong(child, GWL_STYLE, style);
 300
 301                 // MSDN: "If you have changed certain window data using
 302                 // SetWindowLong, you must call SetWindowPos to have the
 303                 // changes take effect."
 304                 ::SetWindowPos(child, NULL, 0, 0, 0, 0,
 305                                SWP_NOMOVE | SWP_NOSIZE | SWP_NOZORDER |
 306                                SWP_FRAMECHANGED);
 307             }
 308
 309             AutoHRGN hrgnChild(::CreateRectRgnIndirect(&rc));
 310             ::CombineRgn(hrgn, hrgn, hrgnChild, RGN_DIFF);
 311         }
 312     }
 313
 314     return (WXHRGN)hrgn;
 315 }
 316
 317 // helper for OnPaint(): really erase the background, i.e. do it even if we
 318 // don't have any non default brush for doing it (DoEraseBackground() doesn't
 319 // do anything in such case)
 320 void wxStaticBox::PaintBackground(wxDC& dc, const RECT& rc)
 321 {
 322     // note that we do not use the box background colour here, it shouldn't
 323     // apply to its interior for several reasons:
 324     //  1. wxGTK doesn't do it
 325     //  2. controls inside the box don't get correct bg colour because they
 326     //     are not our children so we'd have some really ugly colour mix if
 327     //     we did it
 328     //  3. this is backwards compatible behaviour and some people rely on it,
 329     //     see http://groups.google.com/groups?selm=4252E932.3080801%40able.es
 330     wxWindow *parent = GetParent();
 331     HBRUSH hbr = (HBRUSH)parent->MSWGetBgBrush(dc.GetHDC(), GetHWND());
 332
 333     // if there is no special brush for painting this control, just use the
 334     // solid background colour
 335     wxBrush brush;
 336     if ( !hbr )
 337     {
 338         brush = wxBrush(parent->GetBackgroundColour());
 339         hbr = GetHbrushOf(brush);
 340     }
 341
 342     ::FillRect(GetHdcOf(dc), &rc, hbr);
 343 }
 344
 345 void wxStaticBox::PaintForeground(wxDC& dc, const RECT& WXUNUSED(rc))
 346 {
 347     MSWDefWindowProc(WM_PAINT, (WPARAM)GetHdcOf(dc), 0);
 348
 349     // when using XP themes, neither setting the text colour nor transparent
 350     // background mode doesn't change anything: the static box def window proc
 351     // still draws the label in its own colours, so we need to redraw the text
 352     // ourselves if we have a non default fg colour
 353     if ( m_hasFgCol && wxUxThemeEngine::GetIfActive() )
 354     {
 355         // draw over the text in default colour in our colour
 356         dc.SetFont(GetFont());
 357
 358         HDC hdc = GetHdcOf(dc);
 359         ::SetTextColor(hdc, GetForegroundColour().GetPixel());
 360
 361         // FIXME: value of x is hardcoded as this is what it is on my system,
 362         //        no idea if it's true everywhere
 363         const int y = dc.GetCharHeight();
 364         const int x = 9;
 365
 366         // TODO: RTL?
 367         RECT rc = { x, 0, GetSize().x - x, y };
 368
 369         const wxString label = GetLabel();
 370         ::DrawText(hdc, label, label.length(), &rc, DT_SINGLELINE | DT_VCENTER);
 371     }
 372 }
 373
 374 void wxStaticBox::OnPaint(wxPaintEvent& WXUNUSED(event))
 375 {
 376     RECT rc;
 377     ::GetClientRect(GetHwnd(), &rc);
 378
 379     // draw the entire box in a memory DC
 380     wxMemoryDC memdc;
 381     wxBitmap bitmap(rc.right, rc.bottom);
 382     memdc.SelectObject(bitmap);
 383
 384     PaintBackground(memdc, rc);
 385     PaintForeground(memdc, rc);
 386
 387     // now only blit the static box border itself, not the interior, to avoid
 388     // flicker when background is drawn below
 389     //
 390     // note that it seems to be faster to do 4 small blits here and then paint
 391     // directly into wxPaintDC than painting background in wxMemoryDC and then
 392     // blitting everything at once to wxPaintDC, this is why we do it like this
 393     wxPaintDC dc(this);
 394     int borderTop, border;
 395     GetBordersForSizer(&borderTop, &border);
 396
 397     // top
 398     dc.Blit(border, 0, rc.right - border, borderTop,
 399             &memdc, border, 0);
 400     // bottom
 401     dc.Blit(border, rc.bottom - border, rc.right - border, rc.bottom,
 402             &memdc, border, rc.bottom - border);
 403     // left
 404     dc.Blit(0, 0, border, rc.bottom,
 405             &memdc, 0, 0);
 406     // right
 407     dc.Blit(rc.right - border, 0, rc.right, rc.bottom,
 408             &memdc, rc.right - border, 0);
 409
 410
 411     // create the region excluding box children
 412     AutoHRGN hrgn((HRGN)MSWGetRegionWithoutChildren());
 413     RECT rcWin;
 414     ::GetWindowRect(GetHwnd(), &rcWin);
 415     ::OffsetRgn(hrgn, -rcWin.left, -rcWin.top);
 416
 417     // and also the box itself
 418     MSWGetRegionWithoutSelf((WXHRGN) hrgn, rc.right, rc.bottom);
 419     HDCClipper clipToBg(GetHdcOf(dc), hrgn);
 420
 421     // paint the inside of the box (excluding box itself and child controls)
 422     PaintBackground(dc, rc);
 423 }
 424
 425 #endif // !__WXWINCE__
 426
 427 #endif // wxUSE_STATBOX
 428