Disable some wxWebView tests that fail on the buildbot but not locally.

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

diff --git a/src/msw/statusbar.cpp b/src/msw/statusbar.cpp
index b057c0e260c3a5e8e0befdba236017396293e1ad..48960afe2203a4a726539e1e94b9da83e8725687 100644 (file)
--- a/src/msw/statusbar.cpp
+++ b/src/msw/statusbar.cpp
@@ -9,6 +9,14 @@
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 

+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+

 // for compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // for compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -38,8 +46,17 @@
     #include "wx/msw/uxtheme.h"
 #endif
 
     #include "wx/msw/uxtheme.h"
 #endif
 

+// ----------------------------------------------------------------------------
+// constants
+// ----------------------------------------------------------------------------
+
+namespace
+{
+

 // no idea for a default width, just choose something
 // no idea for a default width, just choose something

-#define DEFAULT_FIELD_WIDTH 25
+static const int DEFAULT_FIELD_WIDTH = 25;
+
+} // anonymous namespace

 
 // ----------------------------------------------------------------------------
 // macros
 
 // ----------------------------------------------------------------------------
 // macros


@@ -67,25 +84,17 @@ wxStatusBar::wxStatusBar()
     m_pDC = NULL;
 }
 
     m_pDC = NULL;
 }
 

-bool wxStatusBar::Create(wxWindow *parent,
-                         wxWindowID id,
-                         long style,
-                         const wxString& name)
+WXDWORD wxStatusBar::MSWGetStyle(long style, WXDWORD *exstyle) const

 {
 {

-    wxCHECK_MSG( parent, false, "status bar must have a parent" );
-
-    SetName(name);
-    SetWindowStyleFlag(style);
-    SetParent(parent);
-
-    parent->AddChild(this);
+    WXDWORD msStyle = wxStatusBarBase::MSWGetStyle(style, exstyle);

 
 

-    m_windowId = id == wxID_ANY ? NewControlId() : id;
-
-    DWORD wstyle = WS_CHILD | WS_VISIBLE;
-
-    if ( style & wxCLIP_SIBLINGS )
-        wstyle |= WS_CLIPSIBLINGS;
+    // wxSTB_SIZEGRIP is part of our default style but it doesn't make sense to
+    // show size grip if this is the status bar of a non-resizable TLW so turn
+    // it off in such case
+    wxWindow * const parent = GetParent();
+    wxCHECK_MSG( parent, msStyle, wxS("Status bar must have a parent") );
+    if ( parent->IsTopLevel() && !parent->HasFlag(wxRESIZE_BORDER) )
+        style &= ~wxSTB_SIZEGRIP;

 
     // setting SBARS_SIZEGRIP is perfectly useless: it's always on by default
     // (at least in the version of comctl32.dll I'm using), and the only way to
 
     // setting SBARS_SIZEGRIP is perfectly useless: it's always on by default
     // (at least in the version of comctl32.dll I'm using), and the only way to


@@ -94,47 +103,38 @@ bool wxStatusBar::Create(wxWindow *parent,
     // is not given
     if ( !(style & wxSTB_SIZEGRIP) )
     {
     // is not given
     if ( !(style & wxSTB_SIZEGRIP) )
     {

-        wstyle |= CCS_TOP;
+        msStyle |= CCS_TOP;

     }
     else
     {
 #ifndef __WXWINCE__
         // may be some versions of comctl32.dll do need it - anyhow, it won't
         // do any harm
     }
     else
     {
 #ifndef __WXWINCE__
         // may be some versions of comctl32.dll do need it - anyhow, it won't
         // do any harm

-        wstyle |= SBARS_SIZEGRIP;
+       msStyle |= SBARS_SIZEGRIP;

 #endif
     }
 
 #endif
     }
 

-    m_hWnd = CreateWindow
-             (
-                STATUSCLASSNAME,
-                _T(""),
-                wstyle,
-                0, 0, 0, 0,
-                GetHwndOf(parent),
-                (HMENU)wxUIntToPtr(m_windowId.GetValue()),
-                wxGetInstance(),
-                NULL
-             );
-    if ( m_hWnd == 0 )
-    {
-        wxLogSysError(_("Failed to create a status bar."));
+    return msStyle;
+}

 
 

+bool wxStatusBar::Create(wxWindow *parent,
+                         wxWindowID id,
+                         long style,
+                         const wxString& name)
+{
+    if ( !CreateControl(parent, id, wxDefaultPosition, wxDefaultSize,
+                        style, wxDefaultValidator, name) )
+        return false;
+
+    if ( !MSWCreateControl(STATUSCLASSNAME, wxString(),
+                           wxDefaultPosition, wxDefaultSize) )

         return false;
         return false;

-    }

 
     SetFieldsCount(1);
 
     SetFieldsCount(1);

-    SubclassWin(m_hWnd);

 
 

-    // cache the DC instance used by UpdateFieldText:
-    // NOTE: create the DC before calling InheritAttributes() since
-    //       it may result in a call to our SetFont()
+    // cache the DC instance used by DoUpdateStatusText:

     m_pDC = new wxClientDC(this);
 
     m_pDC = new wxClientDC(this);
 

-    InheritAttributes();
-
-    SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_MENUBAR));
-

     // we must refresh the frame size when the statusbar is created, because
     // its client area might change
     //
     // we must refresh the frame size when the statusbar is created, because
     // its client area might change
     //


@@ -153,6 +153,12 @@ wxStatusBar::~wxStatusBar()
     // occupy
     PostSizeEventToParent();
 
     // occupy
     PostSizeEventToParent();
 

+    // delete existing tooltips
+    for (size_t i=0; i<m_tooltips.size(); i++)
+    {
+        wxDELETE(m_tooltips[i]);
+    }
+

     wxDELETE(m_pDC);
 }
 
     wxDELETE(m_pDC);
 }
 


@@ -170,84 +176,86 @@ void wxStatusBar::SetFieldsCount(int nFields, const int *widths)
     // this is a Windows limitation
     wxASSERT_MSG( (nFields > 0) && (nFields < 255), "too many fields" );
 
     // this is a Windows limitation
     wxASSERT_MSG( (nFields > 0) && (nFields < 255), "too many fields" );
 

-    wxStatusBarBase::SetFieldsCount(nFields, widths);
-
-    SetFieldsWidth();
-    

     // keep in synch also our m_tooltips array
 
     // reset all current tooltips
     for (size_t i=0; i<m_tooltips.size(); i++)
     {
     // keep in synch also our m_tooltips array
 
     // reset all current tooltips
     for (size_t i=0; i<m_tooltips.size(); i++)
     {

-        delete m_tooltips[i];
-        m_tooltips[i] = NULL;
+        wxDELETE(m_tooltips[i]);

     }
 
     // shrink/expand the array:
     }
 
     // shrink/expand the array:

-    m_tooltips.resize(m_panes.GetCount(), NULL);
+    m_tooltips.resize(nFields, NULL);
+
+    wxStatusBarBase::SetFieldsCount(nFields, widths);
+
+    MSWUpdateFieldsWidths();

 }
 
 void wxStatusBar::SetStatusWidths(int n, const int widths[])
 {
     wxStatusBarBase::SetStatusWidths(n, widths);
 
 }
 
 void wxStatusBar::SetStatusWidths(int n, const int widths[])
 {
     wxStatusBarBase::SetStatusWidths(n, widths);
 

-    SetFieldsWidth();
+    MSWUpdateFieldsWidths();

 }
 
 }
 

-void wxStatusBar::SetFieldsWidth()
+void wxStatusBar::MSWUpdateFieldsWidths()

 {
     if ( m_panes.IsEmpty() )
         return;
 
 {
     if ( m_panes.IsEmpty() )
         return;
 

-    int aBorders[3];
-    SendMessage(GetHwnd(), SB_GETBORDERS, 0, (LPARAM)aBorders);
+    const int count = m_panes.GetCount();
+
+    const int extraWidth = MSWGetBorderWidth() + MSWGetMetrics().textMargin;

 
 

-    int extraWidth = aBorders[2]; // space between fields
+    // compute the effectively available amount of space:
+    int widthAvailable = GetClientSize().x;     // start with the entire width
+    widthAvailable -= extraWidth*(count - 1);   // extra space between fields
+    widthAvailable -= MSWGetMetrics().textMargin;   // and for the last field

 
 

+    // Deal with the grip: we shouldn't overflow onto the space occupied by it
+    // so the effectively available space is smaller.
+    const int gripWidth = HasFlag(wxSTB_SIZEGRIP) ? MSWGetMetrics().gripWidth
+                                                  : 0;
+    widthAvailable -= gripWidth;

 
     // distribute the available space (client width) among the various fields:
 
 
     // distribute the available space (client width) among the various fields:
 

-    wxArrayInt widthsAbs =
-        CalculateAbsWidths(GetClientSize().x - extraWidth*(m_panes.GetCount() - 1));
+    wxArrayInt widthsAbs = CalculateAbsWidths(widthAvailable);

 
 
     // update the field widths in the native control:
 
 
 
     // update the field widths in the native control:
 

-    int *pWidths = new int[m_panes.GetCount()];
+    int *pWidths = new int[count];

 
     int nCurPos = 0;
 
     int nCurPos = 0;

-    for ( size_t i = 0; i < m_panes.GetCount(); i++ )
+    int i;
+    for ( i = 0; i < count; i++ )

     {
         nCurPos += widthsAbs[i] + extraWidth;
         pWidths[i] = nCurPos;
     }
 
     {
         nCurPos += widthsAbs[i] + extraWidth;
         pWidths[i] = nCurPos;
     }
 

-    if ( !StatusBar_SetParts(GetHwnd(), m_panes.GetCount(), pWidths) )
-        wxLogLastError("StatusBar_SetParts");
-
-    delete [] pWidths;
+    // The total width of the panes passed to Windows must be equal to the
+    // total width available, including the grip. Otherwise we get an extra
+    // separator line just before it.
+    pWidths[count - 1] += gripWidth;

 
 

-
-    // FIXME: we may want to call UpdateFieldText() here since we may need to (de)ellipsize status texts
-}
-
-void wxStatusBar::SetStatusText(const wxString& strText, int nField)
-{
-    wxCHECK_RET( (nField >= 0) && ((size_t)nField < m_panes.GetCount()),
-                 "invalid statusbar field index" );
-
-    if ( strText == GetStatusText(nField) )
+    if ( !StatusBar_SetParts(GetHwnd(), count, pWidths) )

     {
     {

-        // don't call StatusBar_SetText() to avoid flicker
-        return;
+        wxLogLastError("StatusBar_SetParts");

     }
 
     }
 

-    wxStatusBarBase::SetStatusText(strText, nField);
+    // Now that all parts have been created, set their text.
+    for ( i = 0; i < count; i++ )
+    {
+        DoUpdateStatusText(i);
+    }

 
 

-    UpdateFieldText(nField);
+    delete [] pWidths;

 }
 
 }
 

-void wxStatusBar::UpdateFieldText(int nField)
+void wxStatusBar::DoUpdateStatusText(int nField)

 {
     if (!m_pDC)
         return;
 {
     if (!m_pDC)
         return;


@@ -272,13 +280,8 @@ void wxStatusBar::UpdateFieldText(int nField)
     wxRect rc;
     GetFieldRect(nField, rc);
 
     wxRect rc;
     GetFieldRect(nField, rc);
 

-    int margin;
-    if (nField == GetFieldsCount()-1)
-        margin = -6;        // windows reports a smaller rect for the last field; enlarge it
-    else
-        margin = 4;
+    const int maxWidth = rc.GetWidth() - MSWGetMetrics().textMargin;

 
 

-    int maxWidth = rc.GetWidth() - margin;    // leave a small margin

     wxString text = GetStatusText(nField);
 
     // do we need to ellipsize this string?
     wxString text = GetStatusText(nField);
 
     // do we need to ellipsize this string?


@@ -296,22 +299,24 @@ void wxStatusBar::UpdateFieldText(int nField)
     }
     else
     {
     }
     else
     {

-        text = wxControl::Ellipsize(text, 
+        text = wxControl::Ellipsize(text,

                                      *m_pDC,
                                      ellmode,
                                      maxWidth,
                                      *m_pDC,
                                      ellmode,
                                      maxWidth,

-                                     wxELLIPSIZE_EXPAND_TAB);
-        
-        // update the ellipsization status for this pane; this is used later to 
-        // decide whether a tooltip should be shown or not for this pane 
+                                     wxELLIPSIZE_FLAGS_EXPAND_TABS);
+
+        // update the ellipsization status for this pane; this is used later to
+        // decide whether a tooltip should be shown or not for this pane

         // (if we have wxSTB_SHOW_TIPS)
         SetEllipsizedFlag(nField, text != GetStatusText(nField));
     }
 
         // (if we have wxSTB_SHOW_TIPS)
         SetEllipsizedFlag(nField, text != GetStatusText(nField));
     }
 

-    // Set the status text in the native control passing both field number and style. 
+    // Set the status text in the native control passing both field number and style.

     // NOTE: MSDN library doesn't mention that nField and style have to be 'ORed'
     if ( !StatusBar_SetText(GetHwnd(), nField | style, text.wx_str()) )
     // NOTE: MSDN library doesn't mention that nField and style have to be 'ORed'
     if ( !StatusBar_SetText(GetHwnd(), nField | style, text.wx_str()) )

+    {

         wxLogLastError("StatusBar_SetText");
         wxLogLastError("StatusBar_SetText");

+    }

 
     if (HasFlag(wxSTB_SHOW_TIPS))
     {
 
     if (HasFlag(wxSTB_SHOW_TIPS))
     {


@@ -330,8 +335,7 @@ void wxStatusBar::UpdateFieldText(int nField)
             else
             {
                 // delete the tooltip associated with this pane; it's not needed anymore
             else
             {
                 // delete the tooltip associated with this pane; it's not needed anymore

-                delete m_tooltips[nField];
-                m_tooltips[nField] = NULL;
+                wxDELETE(m_tooltips[nField]);

             }
         }
         else
             }
         }
         else


@@ -344,25 +348,75 @@ void wxStatusBar::UpdateFieldText(int nField)
     }
 }
 
     }
 }
 

-int wxStatusBar::GetBorderX() const
+wxStatusBar::MSWBorders wxStatusBar::MSWGetBorders() const

 {
     int aBorders[3];
     SendMessage(GetHwnd(), SB_GETBORDERS, 0, (LPARAM)aBorders);
 
 {
     int aBorders[3];
     SendMessage(GetHwnd(), SB_GETBORDERS, 0, (LPARAM)aBorders);
 

-    return aBorders[0];
+    MSWBorders borders;
+    borders.horz = aBorders[0];
+    borders.vert = aBorders[1];
+    borders.between = aBorders[2];
+    return borders;
+}
+
+int wxStatusBar::GetBorderX() const
+{
+    return MSWGetBorders().horz;

 }
 
 int wxStatusBar::GetBorderY() const
 {
 }
 
 int wxStatusBar::GetBorderY() const
 {

-    int aBorders[3];
-    SendMessage(GetHwnd(), SB_GETBORDERS, 0, (LPARAM)aBorders);
+    return MSWGetBorders().vert;
+}

 
 

-    return aBorders[1];
+int wxStatusBar::MSWGetBorderWidth() const
+{
+    return MSWGetBorders().between;
+}
+
+/* static */
+const wxStatusBar::MSWMetrics& wxStatusBar::MSWGetMetrics()
+{
+    static MSWMetrics s_metrics = { 0, 0 };
+    if ( !s_metrics.textMargin )
+    {
+        // Grip size should be self explanatory (the only problem with it is
+        // that it's hard coded as we don't know how to find its size using
+        // API) but the margin might merit an explanation: Windows offsets the
+        // text drawn in status bar panes so we need to take this extra margin
+        // into account to make sure the text drawn by user fits inside the
+        // pane. Notice that it's not the value returned by SB_GETBORDERS
+        // which, at least on this Windows 2003 system, returns {0, 2, 2}
+        if ( wxUxThemeEngine::GetIfActive() )
+        {
+            s_metrics.gripWidth = 20;
+            s_metrics.textMargin = 8;
+        }
+        else // classic/unthemed look
+        {
+            s_metrics.gripWidth = 18;
+            s_metrics.textMargin = 4;
+        }
+    }
+
+    return s_metrics;

 }
 
 void wxStatusBar::SetMinHeight(int height)
 {
 }
 
 void wxStatusBar::SetMinHeight(int height)
 {

-    SendMessage(GetHwnd(), SB_SETMINHEIGHT, height + 2*GetBorderY(), 0);
+    // It looks like we need to count the border twice to really make the
+    // controls taking exactly height pixels fully fit in the status bar:
+    // at least under Windows 7 the checkbox in the custom status bar of the
+    // statbar sample gets truncated otherwise.
+    height += 4*GetBorderY();
+
+    // We need to set the size and not the size to reflect the height because
+    // wxFrame uses our size and not the minimal size as it assumes that the
+    // size of a status bar never changes anyhow.
+    SetSize(-1, height);
+
+    SendMessage(GetHwnd(), SB_SETMINHEIGHT, height, 0);

 
     // we have to send a (dummy) WM_SIZE to redraw it now
     SendMessage(GetHwnd(), WM_SIZE, 0, 0);
 
     // we have to send a (dummy) WM_SIZE to redraw it now
     SendMessage(GetHwnd(), WM_SIZE, 0, 0);


@@ -375,7 +429,9 @@ bool wxStatusBar::GetFieldRect(int i, wxRect& rect) const
 
     RECT r;
     if ( !::SendMessage(GetHwnd(), SB_GETRECT, i, (LPARAM)&r) )
 
     RECT r;
     if ( !::SendMessage(GetHwnd(), SB_GETRECT, i, (LPARAM)&r) )

+    {

         wxLogLastError("SendMessage(SB_GETRECT)");
         wxLogLastError("SendMessage(SB_GETRECT)");

+    }

 
 #if wxUSE_UXTHEME
     wxUxThemeHandle theme(const_cast<wxStatusBar*>(this), L"Status");
 
 #if wxUSE_UXTHEME
     wxUxThemeHandle theme(const_cast<wxStatusBar*>(this), L"Status");


@@ -401,8 +457,7 @@ bool wxStatusBar::GetFieldRect(int i, wxRect& rect) const
 
 wxSize wxStatusBar::DoGetBestSize() const
 {
 
 wxSize wxStatusBar::DoGetBestSize() const
 {

-    int borders[3];
-    SendMessage(GetHwnd(), SB_GETBORDERS, 0, (LPARAM)borders);
+    const MSWBorders borders = MSWGetBorders();

 
     // calculate width
     int width = 0;
 
     // calculate width
     int width = 0;


@@ -422,7 +477,7 @@ wxSize wxStatusBar::DoGetBestSize() const
         }
 
         // add the space between fields
         }
 
         // add the space between fields

-        width += borders[2];
+        width += borders.between;

     }
 
     if ( !width )
     }
 
     if ( !width )


@@ -431,11 +486,10 @@ wxSize wxStatusBar::DoGetBestSize() const
         width = 2*DEFAULT_FIELD_WIDTH;
     }
 
         width = 2*DEFAULT_FIELD_WIDTH;
     }
 

-    // calculate height
-    int height;
-    wxGetCharSize(GetHWND(), NULL, &height, GetFont());
-    height = EDIT_HEIGHT_FROM_CHAR_HEIGHT(height);
-    height += borders[1];
+    // calculate height: by default it should be just big enough to show text
+    // (see SetMinHeight() for the explanation of 4 factor)
+    int height = GetCharHeight();
+    height += 4*borders.vert;

 
     wxSize best(width, height);
     CacheBestSize(best);
 
     wxSize best(width, height);
     CacheBestSize(best);


@@ -462,9 +516,6 @@ void wxStatusBar::DoMoveWindow(int x, int y, int width, int height)
                        );
     }
 
                        );
     }
 

-    // adjust fields widths to the new size
-    SetFieldsWidth();
-

     // we have to trigger wxSizeEvent if there are children window in status
     // bar because GetFieldRect returned incorrect (not updated) values up to
     // here, which almost certainly resulted in incorrectly redrawn statusbar
     // we have to trigger wxSizeEvent if there are children window in status
     // bar because GetFieldRect returned incorrect (not updated) values up to
     // here, which almost certainly resulted in incorrectly redrawn statusbar


@@ -501,11 +552,13 @@ void wxStatusBar::SetStatusStyles(int n, const int styles[])
         }
 
         // The SB_SETTEXT message is both used to set the field's text as well as
         }
 
         // The SB_SETTEXT message is both used to set the field's text as well as

-        // the fields' styles. 
+        // the fields' styles.

         // NOTE: MSDN library doesn't mention that nField and style have to be 'ORed'
         wxString text = GetStatusText(i);
         if (!StatusBar_SetText(GetHwnd(), style | i, text.wx_str()))
         // NOTE: MSDN library doesn't mention that nField and style have to be 'ORed'
         wxString text = GetStatusText(i);
         if (!StatusBar_SetText(GetHwnd(), style | i, text.wx_str()))

+        {

             wxLogLastError("StatusBar_SetText");
             wxLogLastError("StatusBar_SetText");

+        }

     }
 }
 
     }
 }
 


@@ -553,15 +606,21 @@ wxStatusBar::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
     }
 #endif
 
     }
 #endif
 

-    bool needsEllipsization = HasFlag(wxSTB_ELLIPSIZE_START) ||
-                              HasFlag(wxSTB_ELLIPSIZE_MIDDLE) ||
-                              HasFlag(wxSTB_ELLIPSIZE_END);
-    if ( nMsg == WM_SIZE && needsEllipsization )
+    if ( nMsg == WM_SIZE )

     {
     {

-        for (int i=0; i<GetFieldsCount(); i++)
-            UpdateFieldText(i);
-            // re-set the field text, in case we need to ellipsize
-            // (or de-ellipsize) some parts of it
+        MSWUpdateFieldsWidths();
+
+        if ( HasFlag(wxSTB_ELLIPSIZE_START) ||
+                HasFlag(wxSTB_ELLIPSIZE_MIDDLE) ||
+                    HasFlag(wxSTB_ELLIPSIZE_END) )
+        {
+            for (int i=0; i<GetFieldsCount(); i++)
+            {
+                // re-set the field text, in case we need to ellipsize
+                // (or de-ellipsize) some parts of it
+                DoUpdateStatusText(i);
+            }
+        }

     }
 
     return wxStatusBarBase::MSWWindowProc(nMsg, wParam, lParam);
     }
 
     return wxStatusBarBase::MSWWindowProc(nMsg, wParam, lParam);