Add room for the scrollbar

[wxWidgets.git] / src / msw / statbox.cpp

diff --git a/src/msw/statbox.cpp b/src/msw/statbox.cpp
index 6ca6074e54a9fdcdcc33e99a471fa941ec08b9e9..e23f78abe18a89c67d42a4879086d2a993467baf 100644 (file)
--- a/src/msw/statbox.cpp
+++ b/src/msw/statbox.cpp
@@ -1,233 +1,402 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        statbox.cpp
+// Name:        msw/statbox.cpp

 // Purpose:     wxStaticBox
 // Author:      Julian Smart
 // Modified by:
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // 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"
+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
+    #pragma implementation "statbox.h"

 #endif
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
 #endif
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__

-#pragma hdrstop
+    #pragma hdrstop

 #endif
 
 #endif
 

-#include "wx/window.h"
-#include "wx/msw/private.h"
+#if wxUSE_STATBOX

 
 #ifndef WX_PRECOMP
 
 #ifndef WX_PRECOMP

-#include "wx/app.h"
-#include "wx/dcclient.h"
+    #include "wx/app.h"
+    #include "wx/dcclient.h"

 #endif
 
 #include "wx/statbox.h"
 #endif
 
 #include "wx/statbox.h"

+#include "wx/notebook.h"
+#include "wx/sysopt.h"
+#include "wx/image.h"
+#include "wx/dcmemory.h"

 
 

-#if !USE_SHARED_LIBRARY
-IMPLEMENT_DYNAMIC_CLASS(wxStaticBox, wxControl)
+#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
 
 #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->GetBackgroundColour()) ;
-  SetForegroundColour(parent->GetForegroundColour()) ;
+#ifndef __WXWINCE__
+    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;
-
-  m_windowStyle = style;
+    return true;
+}

 
 

-  long msStyle = BS_GROUPBOX | WS_CHILD | WS_VISIBLE ; // GROUP_FLAGS;
+wxBorder wxStaticBox::GetDefaultBorder() const
+{
+    return wxBORDER_NONE;
+}

 
 

-  bool want3D;
-  WXDWORD exStyle = Determine3DEffects(0, &want3D) ;
+WXDWORD wxStaticBox::MSWGetStyle(long style, WXDWORD *exstyle) const
+{
+    long styleWin = wxStaticBoxBase::MSWGetStyle(style, exstyle);

 
 

-  HWND wx_button =
-    CreateWindowEx(exStyle, _T("BUTTON"), (const wxChar *)label, msStyle,
-                    0, 0, 0, 0, (HWND) parent->GetHWND(), (HMENU)m_windowId,
-                    wxGetInstance(), NULL);
-#if wxUSE_CTL3D
-  if (want3D)
-  {
-    Ctl3dSubclassCtl(wx_button);
-      m_useCtl3D = TRUE;
-  }
-#endif
+    // no need for it anymore, must be removed for wxRadioBox child
+    // buttons to be able to repaint themselves
+    styleWin &= ~WS_CLIPCHILDREN;

 
 

-  m_hWnd = (WXHWND)wx_button;
+    if ( exstyle )
+    {
+        *exstyle = 0;
+
+        // If any of the ancestors are scrolling windows, style has to be
+        // WS_EX_TRANSPARENT or the static box won't be painted when the window
+        // is scrolled. We try not to do this normally, because we get a lot of
+        // flicker.
+        for ( wxWindow *win = GetParent(); win; win = win->GetParent() )
+        {
+            if ( win->HasFlag(wxVSCROLL) || win->HasFlag(wxHSCROLL) )
+            {
+                *exstyle = WS_EX_TRANSPARENT;
+                break;
+            }
+
+            if ( win->IsTopLevel() )
+                break;
+        }
+    }

 
 

-  // Subclass again for purposes of dialog editing mode
-  SubclassWin(GetHWND());
+    return styleWin | BS_GROUPBOX;
+}

 
 

-  SetFont(parent->GetFont());
+wxSize wxStaticBox::DoGetBestSize() const
+{
+    int cx, cy;
+    wxGetCharSize(GetHWND(), &cx, &cy, GetFont());

 
 

-  SetSize(x, y, width, height);
-  ShowWindow(wx_button, SW_SHOW);
+    int wBox;
+    GetTextExtent(wxGetWindowText(m_hWnd), &wBox, &cy);

 
 

-  return TRUE;
-}
+    wBox += 3*cx;
+    int hBox = EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy);

 
 

-void wxStaticBox::SetLabel(const wxString& label)
-{
-  SetWindowText((HWND)m_hWnd, (const wxChar *)label);
+    return wxSize(wBox, hBox);

 }
 
 }
 

-void wxStaticBox::DoSetSize(int x, int y, int width, int height, int sizeFlags)
+void wxStaticBox::GetBordersForSizer(int *borderTop, int *borderOther) const

 {
 {

-  int currentX, currentY;
-  GetPosition(&currentX, &currentY);
-
-  int x1 = x;
-  int y1 = y;
-  int w1 = width;
-  int h1 = height;
+    wxStaticBoxBase::GetBordersForSizer(borderTop, borderOther);

 
 

-  if (x == -1 || (sizeFlags & wxSIZE_ALLOW_MINUS_ONE))
-    x1 = currentX;
-  if (y == -1 || (sizeFlags & wxSIZE_ALLOW_MINUS_ONE))
-    y1 = currentY;
+    // need extra space, don't know how much but this seems to be enough
+    *borderTop += GetCharHeight()/3;
+}

 
 

-  AdjustForParentClientOrigin(x1, y1, sizeFlags);
+// all the hacks below are not necessary for WinCE
+#ifndef __WXWINCE__

 
 

-  // If we're prepared to use the existing size, then...
-  if (width == -1 && height == -1 && ((sizeFlags & wxSIZE_AUTO) != wxSIZE_AUTO))
-  {
-    GetSize(&w1, &h1);
-  }
+WXLRESULT wxStaticBox::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
+{
+    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 current_width;
+    return wxControl::MSWWindowProc(nMsg, wParam, lParam);
+}

 
 

-  int cx;
-  int cy;
-  int cyf;
+// ----------------------------------------------------------------------------
+// static box drawing
+// ----------------------------------------------------------------------------

 
 

-  wxGetCharSize(GetHWND(), &cx, &cy, & this->GetFont());
+/*
+   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.
+ */

 
 

-  GetTextExtent(wxGetWindowText(m_hWnd), &current_width, &cyf,
-                NULL,NULL, & this->GetFont());
-  if ( w1 < 0 )
-   w1 = current_width + 3*cx;
-  if ( h1 < 0 )
-    h1 = EDIT_HEIGHT_FROM_CHAR_HEIGHT(cyf);
+// 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;
+    }

 
 

-  MoveWindow((HWND)m_hWnd, x1, y1, w1, h1, TRUE);
+    ::CombineRgn(hrgn, hrgn, hrgnRect, RGN_DIFF);

 }
 
 }
 

-WXHBRUSH wxStaticBox::OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor,
-            WXUINT message, WXWPARAM wParam, WXLPARAM lParam)
+void wxStaticBox::MSWGetRegionWithoutSelf(WXHRGN hRgn, int w, int h)

 {
 {

-#if wxUSE_CTL3D
-  if ( m_useCtl3D )
-  {
-    HBRUSH hbrush = Ctl3dCtlColorEx(message, wParam, lParam);
-    return (WXHBRUSH) hbrush;
-  }
-#endif
+    HRGN hrgn = (HRGN)hRgn;

 
 

-  if (GetParent()->GetTransparentBackground())
-    SetBkMode((HDC) pDC, TRANSPARENT);
-  else
-    SetBkMode((HDC) pDC, OPAQUE);
+    // remove the area occupied by the static box borders from the region
+    int borderTop, border;
+    GetBordersForSizer(&borderTop, &border);

 
 

-  ::SetBkColor((HDC) pDC, RGB(GetBackgroundColour().Red(), GetBackgroundColour().Green(), GetBackgroundColour().Blue()));
-  ::SetTextColor((HDC) pDC, RGB(GetForegroundColour().Red(), GetForegroundColour().Green(), GetForegroundColour().Blue()));
+    // top
+    SubtractRectFromRgn(hrgn, 0, 0, w, borderTop);

 
 

-  wxBrush *backgroundBrush = wxTheBrushList->FindOrCreateBrush(GetBackgroundColour(), wxSOLID);
+    // bottom
+    SubtractRectFromRgn(hrgn, 0, h - border, w, h);

 
 

-  // Note that this will be cleaned up in wxApp::OnIdle, if backgroundBrush
-  // has a zero usage count.
-//  backgroundBrush->RealizeResource();
-  return (WXHBRUSH) backgroundBrush->GetResourceHandle();
-}
+    // left
+    SubtractRectFromRgn(hrgn, 0, 0, border, h);

 
 

-// Shouldn't erase the whole window, since the static box must only paint its
-// outline.
-void wxStaticBox::OnEraseBackground(wxEraseEvent& event)
-{
-    // 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
-  {
-    event.Skip();
-  }
+    // right
+    SubtractRectFromRgn(hrgn, w - border, 0, w, h);

 }
 
 }
 

-long wxStaticBox::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
+WXHRGN wxStaticBox::MSWGetRegionWithoutChildren()

 {
 {

-    if (nMsg == WM_NCHITTEST)
+    RECT rc;
+    ::GetWindowRect(GetHwnd(), &rc);
+    HRGN hrgn = ::CreateRectRgn(rc.left, rc.top, rc.right + 1, rc.bottom + 1);
+
+    // 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) )

     {
     {

-        int xPos = LOWORD(lParam);  // horizontal position of cursor
-        int yPos = HIWORD(lParam);  // vertical position of cursor
+        wxWindow *childWindow = wxGetWindowFromHWND((WXHWND) child);
+
+        // can't just test for (this != child) here since if a wxStaticBox
+        // overlaps another wxStaticBox then neither are drawn. The overlapping
+        // region will flicker but we shouldn't have overlapping windows anyway.
+        if ( !childWindow || !wxDynamicCast(childWindow, wxStaticBox) )
+        {
+            ::GetWindowRect(child, &rc);
+            if ( ::RectInRegion(hrgn, &rc) )
+            {
+                // need to remove WS_CLIPSIBLINGS from all sibling windows
+                // that are within this staticbox if set
+                LONG style = ::GetWindowLong(child, GWL_STYLE);
+                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);
+            }
+        }
+    }

 
 

-        ScreenToClient(&xPos, &yPos);
+    return (WXHRGN)hrgn;
+}

 
 

-        // 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;
+// 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)
+{
+    // 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);

     }
 
     }
 

-    return wxControl::MSWWindowProc(nMsg, wParam, lParam);
+    ::FillRect(GetHdcOf(dc), &rc, hbr);

 }
 
 }
 

+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);
+
+    // NB: 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 if we want to have control
+    //     over this we really have to draw everything ourselves
+    MSWDefWindowProc(WM_PAINT, (WPARAM)GetHdcOf(memdc), 0);
+
+
+    // 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
+