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
  44 #include "wx/msw/private.h"
  45
  46 // ----------------------------------------------------------------------------
  47 // wxWin macros
  48 // ----------------------------------------------------------------------------
  49
  50 #if wxUSE_EXTENDED_RTTI
  51 WX_DEFINE_FLAGS( wxStaticBoxStyle )
  52
  53 wxBEGIN_FLAGS( wxStaticBoxStyle )
  54     // new style border flags, we put them first to
  55     // use them for streaming out
  56     wxFLAGS_MEMBER(wxBORDER_SIMPLE)
  57     wxFLAGS_MEMBER(wxBORDER_SUNKEN)
  58     wxFLAGS_MEMBER(wxBORDER_DOUBLE)
  59     wxFLAGS_MEMBER(wxBORDER_RAISED)
  60     wxFLAGS_MEMBER(wxBORDER_STATIC)
  61     wxFLAGS_MEMBER(wxBORDER_NONE)
  62
  63     // old style border flags
  64     wxFLAGS_MEMBER(wxSIMPLE_BORDER)
  65     wxFLAGS_MEMBER(wxSUNKEN_BORDER)
  66     wxFLAGS_MEMBER(wxDOUBLE_BORDER)
  67     wxFLAGS_MEMBER(wxRAISED_BORDER)
  68     wxFLAGS_MEMBER(wxSTATIC_BORDER)
  69     wxFLAGS_MEMBER(wxBORDER)
  70
  71     // standard window styles
  72     wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
  73     wxFLAGS_MEMBER(wxCLIP_CHILDREN)
  74     wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
  75     wxFLAGS_MEMBER(wxWANTS_CHARS)
  76     wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
  77     wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
  78     wxFLAGS_MEMBER(wxVSCROLL)
  79     wxFLAGS_MEMBER(wxHSCROLL)
  80
  81 wxEND_FLAGS( wxStaticBoxStyle )
  82
  83 IMPLEMENT_DYNAMIC_CLASS_XTI(wxStaticBox, wxControl,"wx/statbox.h")
  84
  85 wxBEGIN_PROPERTIES_TABLE(wxStaticBox)
  86     wxPROPERTY( Label,wxString, SetLabel, GetLabel, wxString() , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
  87     wxPROPERTY_FLAGS( WindowStyle , wxStaticBoxStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
  88 /*
  89     TODO PROPERTIES :
  90         label
  91 */
  92 wxEND_PROPERTIES_TABLE()
  93
  94 wxBEGIN_HANDLERS_TABLE(wxStaticBox)
  95 wxEND_HANDLERS_TABLE()
  96
  97 wxCONSTRUCTOR_6( wxStaticBox , wxWindow* , Parent , wxWindowID , Id , wxString , Label , wxPoint , Position , wxSize , Size , long , WindowStyle )
  98 #else
  99 IMPLEMENT_DYNAMIC_CLASS(wxStaticBox, wxControl)
 100 #endif
 101
 102 // ============================================================================
 103 // implementation
 104 // ============================================================================
 105
 106 // ----------------------------------------------------------------------------
 107 // wxStaticBox
 108 // ----------------------------------------------------------------------------
 109
 110 bool wxStaticBox::Create(wxWindow *parent,
 111                          wxWindowID id,
 112                          const wxString& label,
 113                          const wxPoint& pos,
 114                          const wxSize& size,
 115                          long style,
 116                          const wxString& name)
 117 {
 118     if ( !CreateControl(parent, id, pos, size, style, wxDefaultValidator, name) )
 119         return false;
 120
 121     if ( !MSWCreateControl(wxT("BUTTON"), label, pos, size) )
 122         return false;
 123
 124     Connect(wxEVT_PAINT, wxPaintEventHandler(wxStaticBox::OnPaint));
 125
 126     return true;
 127 }
 128
 129 WXDWORD wxStaticBox::MSWGetStyle(long style, WXDWORD *exstyle) const
 130 {
 131     long styleWin = wxStaticBoxBase::MSWGetStyle(style, exstyle);
 132
 133     // no need for it anymore, must be removed for wxRadioBox child
 134     // buttons to be able to repaint themselves
 135     styleWin &= ~WS_CLIPCHILDREN;
 136
 137     if ( exstyle )
 138         *exstyle = 0;
 139
 140     return styleWin | BS_GROUPBOX;
 141 }
 142
 143 wxSize wxStaticBox::DoGetBestSize() const
 144 {
 145     int cx, cy;
 146     wxGetCharSize(GetHWND(), &cx, &cy, GetFont());
 147
 148     int wBox;
 149     GetTextExtent(wxGetWindowText(m_hWnd), &wBox, &cy);
 150
 151     wBox += 3*cx;
 152     int hBox = EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy);
 153
 154     return wxSize(wBox, hBox);
 155 }
 156
 157 WXLRESULT wxStaticBox::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
 158 {
 159 #ifndef __WXWINCE__
 160     if ( nMsg == WM_NCHITTEST )
 161     {
 162         // This code breaks some other processing such as enter/leave tracking
 163         // so it's off by default.
 164
 165         static int s_useHTClient = -1;
 166         if (s_useHTClient == -1)
 167             s_useHTClient = wxSystemOptions::GetOptionInt(wxT("msw.staticbox.htclient"));
 168         if (s_useHTClient == 1)
 169         {
 170             int xPos = LOWORD(lParam);  // horizontal position of cursor
 171             int yPos = HIWORD(lParam);  // vertical position of cursor
 172
 173             ScreenToClient(&xPos, &yPos);
 174
 175             // Make sure you can drag by the top of the groupbox, but let
 176             // other (enclosed) controls get mouse events also
 177             if ( yPos < 10 )
 178                 return (long)HTCLIENT;
 179         }
 180     }
 181 #endif // !__WXWINCE__
 182
 183     return wxControl::MSWWindowProc(nMsg, wParam, lParam);
 184 }
 185
 186 void wxStaticBox::GetBordersForSizer(int *borderTop, int *borderOther) const
 187 {
 188     wxStaticBoxBase::GetBordersForSizer(borderTop, borderOther);
 189
 190     // if not using correct (but backwards cojmpatible) text metrics
 191     // calculations, we need to add some extra margin or otherwise static box
 192     // title is clipped
 193 #if !wxDIALOG_UNIT_COMPATIBILITY
 194     if ( !GetLabel().empty() )
 195         *borderTop += GetCharHeight()/3;
 196 #endif // !wxDIALOG_UNIT_COMPATIBILITY
 197 }
 198
 199 // MSWGetRegionWithoutSelf helper: removes the given rectangle from region
 200 static inline void
 201 SubtractRectFromRgn(HRGN hrgn, int left, int top, int right, int bottom)
 202 {
 203     AutoHRGN hrgnRect(::CreateRectRgn(left, top, right, bottom));
 204     if ( !hrgnRect )
 205     {
 206         wxLogLastError(_T("CreateRectRgn()"));
 207         return;
 208     }
 209
 210     ::CombineRgn(hrgn, hrgn, hrgnRect, RGN_DIFF);
 211 }
 212
 213 void wxStaticBox::MSWGetRegionWithoutSelf(WXHRGN hRgn, int w, int h)
 214 {
 215     HRGN hrgn = (HRGN)hRgn;
 216
 217     // remove the area occupied by the static box borders from the region
 218     int borderTop, border;
 219     GetBordersForSizer(&borderTop, &border);
 220
 221     // top
 222     SubtractRectFromRgn(hrgn, 0, 0, w, borderTop);
 223
 224     // bottom
 225     SubtractRectFromRgn(hrgn, 0, h - border, w, h);
 226
 227     // left
 228     SubtractRectFromRgn(hrgn, 0, 0, border, h);
 229
 230     // right
 231     SubtractRectFromRgn(hrgn, w - border, 0, w, h);
 232 }
 233
 234 WXHRGN wxStaticBox::MSWGetRegionWithoutChildren()
 235 {
 236     RECT rc;
 237     ::GetWindowRect(GetHwnd(), &rc);
 238     HRGN hrgn = ::CreateRectRgn(rc.left, rc.top, rc.right + 1, rc.bottom + 1);
 239
 240     // iterate over all child windows (not just wxWindows but all windows)
 241     for ( HWND child = ::GetWindow(GetHwndOf(GetParent()), GW_CHILD);
 242           child;
 243           child = ::GetWindow(child, GW_HWNDNEXT) )
 244     {
 245         wxWindow *childWindow = wxGetWindowFromHWND((WXHWND) child);
 246
 247         // can't just test for (this != child) here since if a wxStaticBox
 248         // overlaps another wxStaticBox then neither are drawn. The overlapping
 249         // region will flicker but we shouldn't have overlapping windows anyway.
 250         if ( !childWindow || !wxDynamicCast(childWindow, wxStaticBox) )
 251         {
 252             ::GetWindowRect(child, &rc);
 253             if ( ::RectInRegion(hrgn, &rc) )
 254             {
 255                 // need to remove WS_CLIPSIBLINGS from all sibling windows
 256                 // that are within this staticbox if set
 257                 LONG style = ::GetWindowLong(child, GWL_STYLE);
 258                 if ( style & WS_CLIPSIBLINGS )
 259                 {
 260                     style &= ~WS_CLIPSIBLINGS;
 261                     ::SetWindowLong(child, GWL_STYLE, style);
 262
 263                     // MSDN: "If you have changed certain window data using
 264                     // SetWindowLong, you must call SetWindowPos to have the
 265                     // changes take effect."
 266                     ::SetWindowPos(child, NULL, 0, 0, 0, 0,
 267                                    SWP_NOMOVE | SWP_NOSIZE | SWP_NOZORDER |
 268                                    SWP_FRAMECHANGED);
 269                 }
 270
 271                 AutoHRGN hrgnChild(::CreateRectRgnIndirect(&rc));
 272                 ::CombineRgn(hrgn, hrgn, hrgnChild, RGN_DIFF);
 273             }
 274         }
 275     }
 276
 277     return (WXHRGN)hrgn;
 278 }
 279
 280 // helper for OnPaint()
 281 void wxStaticBox::PaintBackground(wxDC& dc, const RECT& rc)
 282 {
 283     HBRUSH hbr = (HBRUSH)DoMSWControlColor(GetHdcOf(dc), wxNullColour);
 284     if ( !hbr )
 285     {
 286         wxBrush *
 287             brush = wxTheBrushList->FindOrCreateBrush(GetBackgroundColour());
 288         if ( brush )
 289             hbr = GetHbrushOf(*brush);
 290     }
 291
 292     if ( hbr )
 293         ::FillRect(GetHdcOf(dc), &rc, hbr);
 294 }
 295
 296 void wxStaticBox::OnPaint(wxPaintEvent& WXUNUSED(event))
 297 {
 298     wxPaintDC dc(this);
 299     RECT rc;
 300     ::GetClientRect(GetHwnd(), &rc);
 301
 302     // draw the entire box in a memory DC, but only blit the bits not redrawn
 303     // either by our children windows nor by FillRect() painting the background
 304     // below
 305     wxMemoryDC memdc;
 306     wxBitmap bitmap(rc.right, rc.bottom);
 307     memdc.SelectObject(bitmap);
 308
 309     PaintBackground(memdc, rc);
 310     MSWDefWindowProc(WM_PAINT, (WPARAM)GetHdcOf(memdc), 0);
 311
 312     int borderTop, border;
 313     GetBordersForSizer(&borderTop, &border);
 314
 315     // top
 316     dc.Blit(border, 0, rc.right - border, borderTop,
 317             &memdc, border, 0);
 318     // bottom
 319     dc.Blit(border, rc.bottom - border, rc.right - border, rc.bottom,
 320             &memdc, border, rc.bottom - border);
 321     // left
 322     dc.Blit(0, 0, border, rc.bottom,
 323             &memdc, 0, 0);
 324     // right
 325     dc.Blit(rc.right - border, 0, rc.right, rc.bottom,
 326             &memdc, rc.right - border, 0);
 327
 328     AutoHRGN hrgn((HRGN)MSWGetRegionWithoutChildren());
 329     RECT rcWin;
 330     ::GetWindowRect(GetHwnd(), &rcWin);
 331     ::OffsetRgn(hrgn, -rcWin.left, -rcWin.top);
 332
 333
 334     // now remove the box itself
 335     MSWGetRegionWithoutSelf((WXHRGN) hrgn, rc.right, rc.bottom);
 336
 337     // and paint the inside of the box (excluding child controls)
 338     ::SelectClipRgn(GetHdcOf(dc), hrgn);
 339     PaintBackground(dc, rc);
 340     ::SelectClipRgn(GetHdcOf(dc), NULL);
 341 }
 342
 343 #endif // wxUSE_STATBOX
 344