src/msw/statbox.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/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 // For compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24     #pragma hdrstop
  25 #endif
  26
  27 #if wxUSE_STATBOX
  28
  29 #include "wx/statbox.h"
  30
  31 #ifndef WX_PRECOMP
  32     #include "wx/app.h"
  33     #include "wx/dcclient.h"
  34     #include "wx/dcmemory.h"
  35     #include "wx/image.h"
  36 #endif
  37
  38 #include "wx/notebook.h"
  39 #include "wx/sysopt.h"
  40
  41 #include "wx/msw/uxtheme.h"
  42 #include "wx/msw/private.h"
  43 #include "wx/msw/missing.h"
  44 #include "wx/msw/dc.h"
  45
  46 // the values coincide with those in tmschema.h
  47 #define BP_GROUPBOX 4
  48
  49 #define GBS_NORMAL 1
  50
  51 #define TMT_FONT 210
  52
  53 // ----------------------------------------------------------------------------
  54 // wxWin macros
  55 // ----------------------------------------------------------------------------
  56
  57 #if wxUSE_EXTENDED_RTTI
  58 WX_DEFINE_FLAGS( wxStaticBoxStyle )
  59
  60 wxBEGIN_FLAGS( wxStaticBoxStyle )
  61     // new style border flags, we put them first to
  62     // use them for streaming out
  63     wxFLAGS_MEMBER(wxBORDER_SIMPLE)
  64     wxFLAGS_MEMBER(wxBORDER_SUNKEN)
  65     wxFLAGS_MEMBER(wxBORDER_DOUBLE)
  66     wxFLAGS_MEMBER(wxBORDER_RAISED)
  67     wxFLAGS_MEMBER(wxBORDER_STATIC)
  68     wxFLAGS_MEMBER(wxBORDER_NONE)
  69
  70     // old style border flags
  71     wxFLAGS_MEMBER(wxSIMPLE_BORDER)
  72     wxFLAGS_MEMBER(wxSUNKEN_BORDER)
  73     wxFLAGS_MEMBER(wxDOUBLE_BORDER)
  74     wxFLAGS_MEMBER(wxRAISED_BORDER)
  75     wxFLAGS_MEMBER(wxSTATIC_BORDER)
  76     wxFLAGS_MEMBER(wxBORDER)
  77
  78     // standard window styles
  79     wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
  80     wxFLAGS_MEMBER(wxCLIP_CHILDREN)
  81     wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
  82     wxFLAGS_MEMBER(wxWANTS_CHARS)
  83     wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
  84     wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
  85     wxFLAGS_MEMBER(wxVSCROLL)
  86     wxFLAGS_MEMBER(wxHSCROLL)
  87
  88 wxEND_FLAGS( wxStaticBoxStyle )
  89
  90 IMPLEMENT_DYNAMIC_CLASS_XTI(wxStaticBox, wxControl,"wx/statbox.h")
  91
  92 wxBEGIN_PROPERTIES_TABLE(wxStaticBox)
  93     wxPROPERTY( Label,wxString, SetLabel, GetLabel, wxString() , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
  94     wxPROPERTY_FLAGS( WindowStyle , wxStaticBoxStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
  95 /*
  96     TODO PROPERTIES :
  97         label
  98 */
  99 wxEND_PROPERTIES_TABLE()
 100
 101 wxBEGIN_HANDLERS_TABLE(wxStaticBox)
 102 wxEND_HANDLERS_TABLE()
 103
 104 wxCONSTRUCTOR_6( wxStaticBox , wxWindow* , Parent , wxWindowID , Id , wxString , Label , wxPoint , Position , wxSize , Size , long , WindowStyle )
 105 #else
 106 IMPLEMENT_DYNAMIC_CLASS(wxStaticBox, wxControl)
 107 #endif
 108
 109 // ============================================================================
 110 // implementation
 111 // ============================================================================
 112
 113 // ----------------------------------------------------------------------------
 114 // wxStaticBox
 115 // ----------------------------------------------------------------------------
 116
 117 bool wxStaticBox::Create(wxWindow *parent,
 118                          wxWindowID id,
 119                          const wxString& label,
 120                          const wxPoint& pos,
 121                          const wxSize& size,
 122                          long style,
 123                          const wxString& name)
 124 {
 125     if ( !CreateControl(parent, id, pos, size, style, wxDefaultValidator, name) )
 126         return false;
 127
 128     if ( !MSWCreateControl(wxT("BUTTON"), label, pos, size) )
 129         return false;
 130
 131     // Always use LTR layout. Otherwise, the label would be mirrored.
 132     SetLayoutDirection(wxLayout_LeftToRight);
 133
 134 #ifndef __WXWINCE__
 135     if (!wxSystemOptions::IsFalse(wxT("msw.staticbox.optimized-paint")))
 136         Connect(wxEVT_PAINT, wxPaintEventHandler(wxStaticBox::OnPaint));
 137 #endif // !__WXWINCE__
 138
 139     return true;
 140 }
 141
 142 WXDWORD wxStaticBox::MSWGetStyle(long style, WXDWORD *exstyle) const
 143 {
 144     long styleWin = wxStaticBoxBase::MSWGetStyle(style, exstyle);
 145
 146     // no need for it anymore, must be removed for wxRadioBox child
 147     // buttons to be able to repaint themselves
 148     styleWin &= ~WS_CLIPCHILDREN;
 149
 150     if ( exstyle )
 151     {
 152 #ifndef __WXWINCE__
 153         if (wxSystemOptions::IsFalse(wxT("msw.staticbox.optimized-paint")))
 154             *exstyle = WS_EX_TRANSPARENT;
 155         else
 156 #endif
 157             *exstyle = 0;
 158     }
 159
 160     styleWin |= BS_GROUPBOX;
 161
 162     if ( wxTheApp->GetLayoutDirection() == wxLayout_RightToLeft )
 163     {
 164         // Make sure label is on the right
 165         styleWin |= BS_RIGHT;
 166     }
 167
 168     return styleWin;
 169 }
 170
 171 wxSize wxStaticBox::DoGetBestSize() const
 172 {
 173     int cx, cy;
 174     wxGetCharSize(GetHWND(), &cx, &cy, GetFont());
 175
 176     int wBox;
 177     GetTextExtent(GetLabelText(wxGetWindowText(m_hWnd)), &wBox, &cy);
 178
 179     wBox += 3*cx;
 180     int hBox = EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy);
 181
 182     wxSize best(wBox, hBox);
 183     CacheBestSize(best);
 184     return best;
 185 }
 186
 187 void wxStaticBox::GetBordersForSizer(int *borderTop, int *borderOther) const
 188 {
 189     wxStaticBoxBase::GetBordersForSizer(borderTop, borderOther);
 190
 191     // need extra space, don't know how much but this seems to be enough
 192     *borderTop += GetCharHeight()/3;
 193 }
 194
 195 // all the hacks below are not necessary for WinCE
 196 #ifndef __WXWINCE__
 197
 198 WXLRESULT wxStaticBox::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
 199 {
 200     if ( nMsg == WM_NCHITTEST )
 201     {
 202         // This code breaks some other processing such as enter/leave tracking
 203         // so it's off by default.
 204
 205         static int s_useHTClient = -1;
 206         if (s_useHTClient == -1)
 207             s_useHTClient = wxSystemOptions::GetOptionInt(wxT("msw.staticbox.htclient"));
 208         if (s_useHTClient == 1)
 209         {
 210             int xPos = GET_X_LPARAM(lParam);
 211             int yPos = GET_Y_LPARAM(lParam);
 212
 213             ScreenToClient(&xPos, &yPos);
 214
 215             // Make sure you can drag by the top of the groupbox, but let
 216             // other (enclosed) controls get mouse events also
 217             if ( yPos < 10 )
 218                 return (long)HTCLIENT;
 219         }
 220     }
 221
 222     if ( nMsg == WM_PRINTCLIENT )
 223     {
 224         // we have to process WM_PRINTCLIENT ourselves as otherwise child
 225         // windows' background (eg buttons in radio box) would never be drawn
 226         // unless we have a parent with non default background
 227
 228         // so check first if we have one
 229         if ( !HandlePrintClient((WXHDC)wParam) )
 230         {
 231             // no, we don't, erase the background ourselves
 232             // (don't use our own) - see PaintBackground for explanation
 233             wxBrush brush(GetParent()->GetBackgroundColour());
 234             wxFillRect(GetHwnd(), (HDC)wParam, GetHbrushOf(brush));
 235         }
 236
 237         return 0;
 238     }
 239
 240     if ( nMsg == WM_UPDATEUISTATE )
 241     {
 242         // DefWindowProc() redraws just the static box text when it gets this
 243         // message and it does it using the standard (blue in standard theme)
 244         // colour and not our own label colour that we use in PaintForeground()
 245         // resulting in the label mysteriously changing the colour when e.g.
 246         // "Alt" is pressed anywhere in the window, see #12497.
 247         //
 248         // To avoid this we simply refresh the window forcing our own code
 249         // redrawing the label in the correct colour to be called. This is
 250         // inefficient but there doesn't seem to be anything else we can do.
 251         //
 252         // Notice that the problem is XP-specific and doesn't arise under later
 253         // systems.
 254         if ( m_hasFgCol && wxGetWinVersion() == wxWinVersion_XP )
 255             Refresh();
 256     }
 257
 258     return wxControl::MSWWindowProc(nMsg, wParam, lParam);
 259 }
 260
 261 // ----------------------------------------------------------------------------
 262 // static box drawing
 263 // ----------------------------------------------------------------------------
 264
 265 /*
 266    We draw the static box ourselves because it's the only way to prevent it
 267    from flickering horribly on resize (because everything inside the box is
 268    erased twice: once when the box itself is repainted and second time when
 269    the control inside it is repainted) without using WS_EX_TRANSPARENT style as
 270    we used to do and which resulted in other problems.
 271  */
 272
 273 // MSWGetRegionWithoutSelf helper: removes the given rectangle from region
 274 static inline void
 275 SubtractRectFromRgn(HRGN hrgn, int left, int top, int right, int bottom)
 276 {
 277     AutoHRGN hrgnRect(::CreateRectRgn(left, top, right, bottom));
 278     if ( !hrgnRect )
 279     {
 280         wxLogLastError(wxT("CreateRectRgn()"));
 281         return;
 282     }
 283
 284     ::CombineRgn(hrgn, hrgn, hrgnRect, RGN_DIFF);
 285 }
 286
 287 void wxStaticBox::MSWGetRegionWithoutSelf(WXHRGN hRgn, int w, int h)
 288 {
 289     HRGN hrgn = (HRGN)hRgn;
 290
 291     // remove the area occupied by the static box borders from the region
 292     int borderTop, border;
 293     GetBordersForSizer(&borderTop, &border);
 294
 295     // top
 296     SubtractRectFromRgn(hrgn, 0, 0, w, borderTop);
 297
 298     // bottom
 299     SubtractRectFromRgn(hrgn, 0, h - border, w, h);
 300
 301     // left
 302     SubtractRectFromRgn(hrgn, 0, 0, border, h);
 303
 304     // right
 305     SubtractRectFromRgn(hrgn, w - border, 0, w, h);
 306 }
 307
 308 WXHRGN wxStaticBox::MSWGetRegionWithoutChildren()
 309 {
 310     RECT rc;
 311     ::GetWindowRect(GetHwnd(), &rc);
 312     HRGN hrgn = ::CreateRectRgn(rc.left, rc.top, rc.right + 1, rc.bottom + 1);
 313     bool foundThis = false;
 314
 315     // iterate over all child windows (not just wxWindows but all windows)
 316     for ( HWND child = ::GetWindow(GetHwndOf(GetParent()), GW_CHILD);
 317           child;
 318           child = ::GetWindow(child, GW_HWNDNEXT) )
 319     {
 320         if ( ! ::IsWindowVisible(child) )
 321         {
 322             // if the window isn't visible then it doesn't need clipped
 323             continue;
 324         }
 325
 326         LONG style = ::GetWindowLong(child, GWL_STYLE);
 327         wxString str(wxGetWindowClass(child));
 328         str.UpperCase();
 329         if ( str == wxT("BUTTON") && (style & BS_GROUPBOX) == BS_GROUPBOX )
 330         {
 331             if ( child == GetHwnd() )
 332                 foundThis = true;
 333
 334             // Any static boxes below this one in the Z-order can't be clipped
 335             // since if we have the case where a static box with a low Z-order
 336             // is nested inside another static box with a high Z-order then the
 337             // nested static box would be painted over. Doing it this way
 338             // unfortunately results in flicker if the Z-order of nested static
 339             // boxes is not inside (lowest) to outside (highest) but at least
 340             // they are still shown.
 341             if ( foundThis )
 342                 continue;
 343         }
 344
 345         ::GetWindowRect(child, &rc);
 346         if ( ::RectInRegion(hrgn, &rc) )
 347         {
 348             // need to remove WS_CLIPSIBLINGS from all sibling windows
 349             // that are within this staticbox if set
 350             if ( style & WS_CLIPSIBLINGS )
 351             {
 352                 style &= ~WS_CLIPSIBLINGS;
 353                 ::SetWindowLong(child, GWL_STYLE, style);
 354
 355                 // MSDN: "If you have changed certain window data using
 356                 // SetWindowLong, you must call SetWindowPos to have the
 357                 // changes take effect."
 358                 ::SetWindowPos(child, NULL, 0, 0, 0, 0,
 359                                SWP_NOMOVE | SWP_NOSIZE | SWP_NOZORDER |
 360                                SWP_FRAMECHANGED);
 361             }
 362
 363             AutoHRGN hrgnChild(::CreateRectRgnIndirect(&rc));
 364             ::CombineRgn(hrgn, hrgn, hrgnChild, RGN_DIFF);
 365         }
 366     }
 367
 368     return (WXHRGN)hrgn;
 369 }
 370
 371 // helper for OnPaint(): really erase the background, i.e. do it even if we
 372 // don't have any non default brush for doing it (DoEraseBackground() doesn't
 373 // do anything in such case)
 374 void wxStaticBox::PaintBackground(wxDC& dc, const RECT& rc)
 375 {
 376     // note that we do not use the box background colour here, it shouldn't
 377     // apply to its interior for several reasons:
 378     //  1. wxGTK doesn't do it
 379     //  2. controls inside the box don't get correct bg colour because they
 380     //     are not our children so we'd have some really ugly colour mix if
 381     //     we did it
 382     //  3. this is backwards compatible behaviour and some people rely on it,
 383     //     see http://groups.google.com/groups?selm=4252E932.3080801%40able.es
 384     wxMSWDCImpl *impl = (wxMSWDCImpl*) dc.GetImpl();
 385     HBRUSH hbr = MSWGetBgBrush(impl->GetHDC());
 386
 387     // if there is no special brush for painting this control, just use the
 388     // solid background colour
 389     wxBrush brush;
 390     if ( !hbr )
 391     {
 392         brush = wxBrush(GetParent()->GetBackgroundColour());
 393         hbr = GetHbrushOf(brush);
 394     }
 395
 396     ::FillRect(GetHdcOf(*impl), &rc, hbr);
 397 }
 398
 399 void wxStaticBox::PaintForeground(wxDC& dc, const RECT& rc)
 400 {
 401     wxMSWDCImpl *impl = (wxMSWDCImpl*) dc.GetImpl();
 402     MSWDefWindowProc(WM_PAINT, (WPARAM)GetHdcOf(*impl), 0);
 403
 404     // when using XP themes, neither setting the text colour nor transparent
 405     // background mode doesn't change anything: the static box def window proc
 406     // still draws the label in its own colours, so we need to redraw the text
 407     // ourselves if we have a non default fg colour
 408     if ( m_hasFgCol && wxUxThemeEngine::GetIfActive() )
 409     {
 410         // draw over the text in default colour in our colour
 411         HDC hdc = GetHdcOf(*impl);
 412         ::SetTextColor(hdc, GetForegroundColour().GetPixel());
 413
 414         const bool rtl = wxTheApp->GetLayoutDirection() == wxLayout_RightToLeft;
 415         if ( rtl )
 416             ::SetTextAlign(hdc, TA_RTLREADING | TA_RIGHT);
 417
 418         // Get dimensions of the label
 419         const wxString label = GetLabel();
 420
 421         // choose the correct font
 422         AutoHFONT font;
 423         SelectInHDC selFont;
 424         if ( m_hasFont )
 425         {
 426             selFont.Init(hdc, GetHfontOf(GetFont()));
 427         }
 428         else // no font set, use the one set by the theme
 429         {
 430             wxUxThemeHandle hTheme(this, L"BUTTON");
 431             if ( hTheme )
 432             {
 433                 wxUxThemeFont themeFont;
 434                 if ( wxUxThemeEngine::Get()->GetThemeFont
 435                                              (
 436                                                 hTheme,
 437                                                 hdc,
 438                                                 BP_GROUPBOX,
 439                                                 GBS_NORMAL,
 440                                                 TMT_FONT,
 441                                                 themeFont.GetPtr()
 442                                              ) == S_OK )
 443                 {
 444                     font.Init(themeFont.GetLOGFONT());
 445                     if ( font )
 446                         selFont.Init(hdc, font);
 447                 }
 448             }
 449         }
 450
 451         // Get the font extent
 452         int width, height;
 453         dc.GetTextExtent(wxStripMenuCodes(label, wxStrip_Mnemonics),
 454                          &width, &height);
 455
 456         int x;
 457         int y = height;
 458
 459         // first we need to correctly paint the background of the label
 460         // as Windows ignores the brush offset when doing it
 461         //
 462         // FIXME: value of x is hardcoded as this is what it is on my system,
 463         //        no idea if it's true everywhere
 464         RECT dimensions = {0, 0, 0, y};
 465         if ( !rtl )
 466         {
 467             x = 9;
 468             dimensions.left = x;
 469             dimensions.right = x + width;
 470         }
 471         else
 472         {
 473             x = rc.right - 7;
 474             dimensions.left = x - width;
 475             dimensions.right = x;
 476         }
 477
 478         // need to adjust the rectangle to cover all the label background
 479         dimensions.left -= 2;
 480         dimensions.right += 2;
 481         dimensions.bottom += 2;
 482
 483         if ( UseBgCol() )
 484         {
 485             // our own background colour should be used for the background of
 486             // the label: this is consistent with the behaviour under pre-XP
 487             // systems (i.e. without visual themes) and generally makes sense
 488             wxBrush brush = wxBrush(GetBackgroundColour());
 489             wxMSWDCImpl *impl = (wxMSWDCImpl*) dc.GetImpl();
 490             ::FillRect(GetHdcOf(*impl), &dimensions, GetHbrushOf(brush));
 491         }
 492         else // paint parent background
 493         {
 494             PaintBackground(dc, dimensions);
 495         }
 496
 497         UINT drawTextFlags = DT_SINGLELINE | DT_VCENTER;
 498
 499         // determine the state of UI queues to draw the text correctly under XP
 500         // and later systems
 501         static const bool isXPorLater = wxGetWinVersion() >= wxWinVersion_XP;
 502         if ( isXPorLater )
 503         {
 504             if ( ::SendMessage(GetHwnd(), WM_QUERYUISTATE, 0, 0) &
 505                     UISF_HIDEACCEL )
 506             {
 507                 drawTextFlags |= DT_HIDEPREFIX;
 508             }
 509         }
 510
 511         // now draw the text
 512         if ( !rtl )
 513         {
 514             RECT rc2 = { x, 0, x + width, y };
 515             ::DrawText(hdc, label.wx_str(), label.length(), &rc2,
 516                        drawTextFlags);
 517         }
 518         else // RTL
 519         {
 520             RECT rc2 = { x, 0, x - width, y };
 521             ::DrawText(hdc, label.wx_str(), label.length(), &rc2,
 522                        drawTextFlags | DT_RTLREADING);
 523         }
 524     }
 525 }
 526
 527 void wxStaticBox::OnPaint(wxPaintEvent& WXUNUSED(event))
 528 {
 529     RECT rc;
 530     ::GetClientRect(GetHwnd(), &rc);
 531
 532     // draw the entire box in a memory DC
 533     wxMemoryDC memdc;
 534     wxBitmap bitmap(rc.right, rc.bottom);
 535     memdc.SelectObject(bitmap);
 536
 537     PaintBackground(memdc, rc);
 538     PaintForeground(memdc, rc);
 539
 540     // now only blit the static box border itself, not the interior, to avoid
 541     // flicker when background is drawn below
 542     //
 543     // note that it seems to be faster to do 4 small blits here and then paint
 544     // directly into wxPaintDC than painting background in wxMemoryDC and then
 545     // blitting everything at once to wxPaintDC, this is why we do it like this
 546     wxPaintDC dc(this);
 547     int borderTop, border;
 548     GetBordersForSizer(&borderTop, &border);
 549
 550     // top
 551     dc.Blit(border, 0, rc.right - border, borderTop,
 552             &memdc, border, 0);
 553     // bottom
 554     dc.Blit(border, rc.bottom - border, rc.right - border, border,
 555             &memdc, border, rc.bottom - border);
 556     // left
 557     dc.Blit(0, 0, border, rc.bottom,
 558             &memdc, 0, 0);
 559     // right (note that upper and bottom right corners were already part of the
 560     // first two blits so we shouldn't overwrite them here to avoi flicker)
 561     dc.Blit(rc.right - border, borderTop,
 562             border, rc.bottom - borderTop - border,
 563             &memdc, rc.right - border, borderTop);
 564
 565
 566     // create the region excluding box children
 567     AutoHRGN hrgn((HRGN)MSWGetRegionWithoutChildren());
 568     RECT rcWin;
 569     ::GetWindowRect(GetHwnd(), &rcWin);
 570     ::OffsetRgn(hrgn, -rcWin.left, -rcWin.top);
 571
 572     // and also the box itself
 573     MSWGetRegionWithoutSelf((WXHRGN) hrgn, rc.right, rc.bottom);
 574     wxMSWDCImpl *impl = (wxMSWDCImpl*) dc.GetImpl();
 575     HDCClipper clipToBg(GetHdcOf(*impl), hrgn);
 576
 577     // paint the inside of the box (excluding box itself and child controls)
 578     PaintBackground(dc, rc);
 579 }
 580
 581 #endif // !__WXWINCE__
 582
 583 #endif // wxUSE_STATBOX