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     return wxControl::MSWWindowProc(nMsg, wParam, lParam);
 241 }
 242
 243 // ----------------------------------------------------------------------------
 244 // static box drawing
 245 // ----------------------------------------------------------------------------
 246
 247 /*
 248    We draw the static box ourselves because it's the only way to prevent it
 249    from flickering horribly on resize (because everything inside the box is
 250    erased twice: once when the box itself is repainted and second time when
 251    the control inside it is repainted) without using WS_EX_TRANSPARENT style as
 252    we used to do and which resulted in other problems.
 253  */
 254
 255 // MSWGetRegionWithoutSelf helper: removes the given rectangle from region
 256 static inline void
 257 SubtractRectFromRgn(HRGN hrgn, int left, int top, int right, int bottom)
 258 {
 259     AutoHRGN hrgnRect(::CreateRectRgn(left, top, right, bottom));
 260     if ( !hrgnRect )
 261     {
 262         wxLogLastError(wxT("CreateRectRgn()"));
 263         return;
 264     }
 265
 266     ::CombineRgn(hrgn, hrgn, hrgnRect, RGN_DIFF);
 267 }
 268
 269 void wxStaticBox::MSWGetRegionWithoutSelf(WXHRGN hRgn, int w, int h)
 270 {
 271     HRGN hrgn = (HRGN)hRgn;
 272
 273     // remove the area occupied by the static box borders from the region
 274     int borderTop, border;
 275     GetBordersForSizer(&borderTop, &border);
 276
 277     // top
 278     SubtractRectFromRgn(hrgn, 0, 0, w, borderTop);
 279
 280     // bottom
 281     SubtractRectFromRgn(hrgn, 0, h - border, w, h);
 282
 283     // left
 284     SubtractRectFromRgn(hrgn, 0, 0, border, h);
 285
 286     // right
 287     SubtractRectFromRgn(hrgn, w - border, 0, w, h);
 288 }
 289
 290 WXHRGN wxStaticBox::MSWGetRegionWithoutChildren()
 291 {
 292     RECT rc;
 293     ::GetWindowRect(GetHwnd(), &rc);
 294     HRGN hrgn = ::CreateRectRgn(rc.left, rc.top, rc.right + 1, rc.bottom + 1);
 295     bool foundThis = false;
 296
 297     // iterate over all child windows (not just wxWindows but all windows)
 298     for ( HWND child = ::GetWindow(GetHwndOf(GetParent()), GW_CHILD);
 299           child;
 300           child = ::GetWindow(child, GW_HWNDNEXT) )
 301     {
 302         if ( ! ::IsWindowVisible(child) )
 303         {
 304             // if the window isn't visible then it doesn't need clipped
 305             continue;
 306         }
 307
 308         LONG style = ::GetWindowLong(child, GWL_STYLE);
 309         wxString str(wxGetWindowClass(child));
 310         str.UpperCase();
 311         if ( str == wxT("BUTTON") && (style & BS_GROUPBOX) == BS_GROUPBOX )
 312         {
 313             if ( child == GetHwnd() )
 314                 foundThis = true;
 315
 316             // Any static boxes below this one in the Z-order can't be clipped
 317             // since if we have the case where a static box with a low Z-order
 318             // is nested inside another static box with a high Z-order then the
 319             // nested static box would be painted over. Doing it this way
 320             // unfortunately results in flicker if the Z-order of nested static
 321             // boxes is not inside (lowest) to outside (highest) but at least
 322             // they are still shown.
 323             if ( foundThis )
 324                 continue;
 325         }
 326
 327         ::GetWindowRect(child, &rc);
 328         if ( ::RectInRegion(hrgn, &rc) )
 329         {
 330             // need to remove WS_CLIPSIBLINGS from all sibling windows
 331             // that are within this staticbox if set
 332             if ( style & WS_CLIPSIBLINGS )
 333             {
 334                 style &= ~WS_CLIPSIBLINGS;
 335                 ::SetWindowLong(child, GWL_STYLE, style);
 336
 337                 // MSDN: "If you have changed certain window data using
 338                 // SetWindowLong, you must call SetWindowPos to have the
 339                 // changes take effect."
 340                 ::SetWindowPos(child, NULL, 0, 0, 0, 0,
 341                                SWP_NOMOVE | SWP_NOSIZE | SWP_NOZORDER |
 342                                SWP_FRAMECHANGED);
 343             }
 344
 345             AutoHRGN hrgnChild(::CreateRectRgnIndirect(&rc));
 346             ::CombineRgn(hrgn, hrgn, hrgnChild, RGN_DIFF);
 347         }
 348     }
 349
 350     return (WXHRGN)hrgn;
 351 }
 352
 353 // helper for OnPaint(): really erase the background, i.e. do it even if we
 354 // don't have any non default brush for doing it (DoEraseBackground() doesn't
 355 // do anything in such case)
 356 void wxStaticBox::PaintBackground(wxDC& dc, const RECT& rc)
 357 {
 358     // note that we do not use the box background colour here, it shouldn't
 359     // apply to its interior for several reasons:
 360     //  1. wxGTK doesn't do it
 361     //  2. controls inside the box don't get correct bg colour because they
 362     //     are not our children so we'd have some really ugly colour mix if
 363     //     we did it
 364     //  3. this is backwards compatible behaviour and some people rely on it,
 365     //     see http://groups.google.com/groups?selm=4252E932.3080801%40able.es
 366     wxWindow *parent = GetParent();
 367     wxMSWDCImpl *impl = (wxMSWDCImpl*) dc.GetImpl();
 368     HBRUSH hbr = (HBRUSH)parent->MSWGetBgBrush(impl->GetHDC(), this);
 369
 370     // if there is no special brush for painting this control, just use the
 371     // solid background colour
 372     wxBrush brush;
 373     if ( !hbr )
 374     {
 375         brush = wxBrush(parent->GetBackgroundColour());
 376         hbr = GetHbrushOf(brush);
 377     }
 378
 379     ::FillRect(GetHdcOf(*impl), &rc, hbr);
 380 }
 381
 382 void wxStaticBox::PaintForeground(wxDC& dc, const RECT& rc)
 383 {
 384     wxMSWDCImpl *impl = (wxMSWDCImpl*) dc.GetImpl();
 385     MSWDefWindowProc(WM_PAINT, (WPARAM)GetHdcOf(*impl), 0);
 386
 387     // when using XP themes, neither setting the text colour nor transparent
 388     // background mode doesn't change anything: the static box def window proc
 389     // still draws the label in its own colours, so we need to redraw the text
 390     // ourselves if we have a non default fg colour
 391     if ( m_hasFgCol && wxUxThemeEngine::GetIfActive() )
 392     {
 393         // draw over the text in default colour in our colour
 394         HDC hdc = GetHdcOf(*impl);
 395         ::SetTextColor(hdc, GetForegroundColour().GetPixel());
 396
 397         const bool rtl = wxTheApp->GetLayoutDirection() == wxLayout_RightToLeft;
 398         if ( rtl )
 399             ::SetTextAlign(hdc, TA_RTLREADING | TA_RIGHT);
 400
 401         // Get dimensions of the label
 402         const wxString label = GetLabel();
 403
 404         // choose the correct font
 405         AutoHFONT font;
 406         SelectInHDC selFont;
 407         if ( m_hasFont )
 408         {
 409             selFont.Init(hdc, GetHfontOf(GetFont()));
 410         }
 411         else // no font set, use the one set by the theme
 412         {
 413             wxUxThemeHandle hTheme(this, L"BUTTON");
 414             if ( hTheme )
 415             {
 416                 // GetThemeFont() expects its parameter to be LOGFONTW and not
 417                 // LOGFONTA even in ANSI programs and will happily corrupt
 418                 // memory after the struct end if we pass a LOGFONTA (which is
 419                 // smaller) to it!
 420                 LOGFONTW lfw;
 421                 if ( wxUxThemeEngine::Get()->GetThemeFont
 422                                              (
 423                                                 hTheme,
 424                                                 hdc,
 425                                                 BP_GROUPBOX,
 426                                                 GBS_NORMAL,
 427                                                 TMT_FONT,
 428                                                 (LOGFONT *)&lfw
 429                                              ) == S_OK )
 430                 {
 431 #if wxUSE_UNICODE
 432                     // ok, no conversion necessary
 433                     const LOGFONT& lf = lfw;
 434 #else // !wxUSE_UNICODE
 435                     // most of the fields are the same in LOGFONTA and LOGFONTW
 436                     LOGFONT lf;
 437                     memcpy(&lf, &lfw, sizeof(lf));
 438
 439                     // but the face name must be converted
 440                     WideCharToMultiByte(CP_ACP, 0, lfw.lfFaceName, -1,
 441                                         lf.lfFaceName, sizeof(lf.lfFaceName),
 442                                         NULL, NULL);
 443 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
 444
 445                     font.Init(lf);
 446                     if ( font )
 447                         selFont.Init(hdc, font);
 448                 }
 449             }
 450         }
 451
 452         // Get the font extent
 453         int width, height;
 454         dc.GetTextExtent(wxStripMenuCodes(label, wxStrip_Mnemonics),
 455                          &width, &height);
 456
 457         int x;
 458         int y = height;
 459
 460         // first we need to correctly paint the background of the label
 461         // as Windows ignores the brush offset when doing it
 462         //
 463         // FIXME: value of x is hardcoded as this is what it is on my system,
 464         //        no idea if it's true everywhere
 465         RECT dimensions = {0, 0, 0, y};
 466         if ( !rtl )
 467         {
 468             x = 9;
 469             dimensions.left = x;
 470             dimensions.right = x + width;
 471         }
 472         else
 473         {
 474             x = rc.right - 7;
 475             dimensions.left = x - width;
 476             dimensions.right = x;
 477         }
 478
 479         // need to adjust the rectangle to cover all the label background
 480         dimensions.left -= 2;
 481         dimensions.right += 2;
 482         dimensions.bottom += 2;
 483
 484         if ( UseBgCol() )
 485         {
 486             // our own background colour should be used for the background of
 487             // the label: this is consistent with the behaviour under pre-XP
 488             // systems (i.e. without visual themes) and generally makes sense
 489             wxBrush brush = wxBrush(GetBackgroundColour());
 490             wxMSWDCImpl *impl = (wxMSWDCImpl*) dc.GetImpl();
 491             ::FillRect(GetHdcOf(*impl), &dimensions, GetHbrushOf(brush));
 492         }
 493         else // paint parent background
 494         {
 495             PaintBackground(dc, dimensions);
 496         }
 497
 498         // now draw the text
 499         if ( !rtl )
 500         {
 501             RECT rc2 = { x, 0, x + width, y };
 502             ::DrawText(hdc, label.wx_str(), label.length(), &rc2,
 503                        DT_SINGLELINE | DT_VCENTER);
 504         }
 505         else // RTL
 506         {
 507             RECT rc2 = { x, 0, x - width, y };
 508             ::DrawText(hdc, label.wx_str(), label.length(), &rc2,
 509                        DT_SINGLELINE | DT_VCENTER | DT_RTLREADING);
 510         }
 511     }
 512 }
 513
 514 void wxStaticBox::OnPaint(wxPaintEvent& WXUNUSED(event))
 515 {
 516     RECT rc;
 517     ::GetClientRect(GetHwnd(), &rc);
 518
 519     // draw the entire box in a memory DC
 520     wxMemoryDC memdc;
 521     wxBitmap bitmap(rc.right, rc.bottom);
 522     memdc.SelectObject(bitmap);
 523
 524     PaintBackground(memdc, rc);
 525     PaintForeground(memdc, rc);
 526
 527     // now only blit the static box border itself, not the interior, to avoid
 528     // flicker when background is drawn below
 529     //
 530     // note that it seems to be faster to do 4 small blits here and then paint
 531     // directly into wxPaintDC than painting background in wxMemoryDC and then
 532     // blitting everything at once to wxPaintDC, this is why we do it like this
 533     wxPaintDC dc(this);
 534     int borderTop, border;
 535     GetBordersForSizer(&borderTop, &border);
 536
 537     // top
 538     dc.Blit(border, 0, rc.right - border, borderTop,
 539             &memdc, border, 0);
 540     // bottom
 541     dc.Blit(border, rc.bottom - border, rc.right - border, border,
 542             &memdc, border, rc.bottom - border);
 543     // left
 544     dc.Blit(0, 0, border, rc.bottom,
 545             &memdc, 0, 0);
 546     // right (note that upper and bottom right corners were already part of the
 547     // first two blits so we shouldn't overwrite them here to avoi flicker)
 548     dc.Blit(rc.right - border, borderTop,
 549             border, rc.bottom - borderTop - border,
 550             &memdc, rc.right - border, borderTop);
 551
 552
 553     // create the region excluding box children
 554     AutoHRGN hrgn((HRGN)MSWGetRegionWithoutChildren());
 555     RECT rcWin;
 556     ::GetWindowRect(GetHwnd(), &rcWin);
 557     ::OffsetRgn(hrgn, -rcWin.left, -rcWin.top);
 558
 559     // and also the box itself
 560     MSWGetRegionWithoutSelf((WXHRGN) hrgn, rc.right, rc.bottom);
 561     wxMSWDCImpl *impl = (wxMSWDCImpl*) dc.GetImpl();
 562     HDCClipper clipToBg(GetHdcOf(*impl), hrgn);
 563
 564     // paint the inside of the box (excluding box itself and child controls)
 565     PaintBackground(dc, rc);
 566 }
 567
 568 #endif // !__WXWINCE__
 569
 570 #endif // wxUSE_STATBOX