Recognize VC12 (a.k.a. MSVS 2013) and define __VISUALC12__ for it.

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

diff --git a/src/msw/statusbar.cpp b/src/msw/statusbar.cpp
index 8b588197574f18527fe5ed0010067913014b13f5..c2767b34df438d6d4fa29989c2e166ce00470152 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,
-                wxT(""),
-                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 DoUpdateStatusText:
 
     // cache the DC instance used by DoUpdateStatusText:

-    // NOTE: create the DC before calling InheritAttributes() since
-    //       it may result in a call to our SetFont()

     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,15 +153,13 @@ wxStatusBar::~wxStatusBar()
     // occupy
     PostSizeEventToParent();
 
     // occupy
     PostSizeEventToParent();
 

+#if wxUSE_TOOLTIPS

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

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

     }
     }

+#endif // wxUSE_TOOLTIPS

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


@@ -180,24 +178,22 @@ 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);
-
-    MSWUpdateFieldsWidths();
-

     // keep in synch also our m_tooltips array
 
     // keep in synch also our m_tooltips array
 

+#if wxUSE_TOOLTIPS

     // reset all current tooltips
     for (size_t i=0; i<m_tooltips.size(); i++)
     {
     // reset all current tooltips
     for (size_t i=0; i<m_tooltips.size(); i++)
     {

-        if (m_tooltips[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);
+#endif // wxUSE_TOOLTIPS
+
+    wxStatusBarBase::SetFieldsCount(nFields, widths);
+
+    MSWUpdateFieldsWidths();

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


@@ -212,38 +208,55 @@ 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) )
+    // 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;
+
+    if ( !StatusBar_SetParts(GetHwnd(), count, pWidths) )

     {
         wxLogLastError("StatusBar_SetParts");
     }
 
     {
         wxLogLastError("StatusBar_SetParts");
     }
 

-    delete [] pWidths;
-
+    // Now that all parts have been created, set their text.
+    for ( i = 0; i < count; i++ )
+    {
+        DoUpdateStatusText(i);
+    }

 
 

-    // FIXME: we may want to call DoUpdateStatusText() here since we may need to (de)ellipsize status texts
+    delete [] pWidths;

 }
 
 void wxStatusBar::DoUpdateStatusText(int nField)
 }
 
 void wxStatusBar::DoUpdateStatusText(int nField)


@@ -262,6 +275,7 @@ void wxStatusBar::DoUpdateStatusText(int nField)
         style = SBT_NOBORDERS;
         break;
 
         style = SBT_NOBORDERS;
         break;
 

+    case wxSB_SUNKEN:

     case wxSB_NORMAL:
     default:
         style = 0;
     case wxSB_NORMAL:
     default:
         style = 0;


@@ -271,13 +285,8 @@ void wxStatusBar::DoUpdateStatusText(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?


@@ -299,7 +308,7 @@ void wxStatusBar::DoUpdateStatusText(int nField)
                                      *m_pDC,
                                      ellmode,
                                      maxWidth,
                                      *m_pDC,
                                      ellmode,
                                      maxWidth,

-                                     wxELLIPSIZE_EXPAND_TAB);
+                                     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
 
         // update the ellipsization status for this pane; this is used later to
         // decide whether a tooltip should be shown or not for this pane


@@ -309,11 +318,12 @@ void wxStatusBar::DoUpdateStatusText(int nField)
 
     // 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'
 
     // 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()) )
+    if ( !StatusBar_SetText(GetHwnd(), nField | style, text.t_str()) )

     {
         wxLogLastError("StatusBar_SetText");
     }
 
     {
         wxLogLastError("StatusBar_SetText");
     }
 

+#if wxUSE_TOOLTIPS

     if (HasFlag(wxSTB_SHOW_TIPS))
     {
         wxASSERT(m_tooltips.size() == m_panes.GetCount());
     if (HasFlag(wxSTB_SHOW_TIPS))
     {
         wxASSERT(m_tooltips.size() == m_panes.GetCount());


@@ -331,8 +341,7 @@ void wxStatusBar::DoUpdateStatusText(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


@@ -343,27 +352,80 @@ void wxStatusBar::DoUpdateStatusText(int nField)
             //else: leave m_tooltips[nField]==NULL
         }
     }
             //else: leave m_tooltips[nField]==NULL
         }
     }

+#endif // wxUSE_TOOLTIPS

 }
 
 }
 

-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;
+}
+
+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 wxUSE_UXTHEME
+        if ( wxUxThemeEngine::GetIfActive() )
+        {
+            s_metrics.gripWidth = 20;
+            s_metrics.textMargin = 8;
+        }
+        else // classic/unthemed look
+#endif // wxUSE_UXTHEME
+        {
+            s_metrics.gripWidth = 18;
+            s_metrics.textMargin = 4;
+        }
+    }

 
 

-    return aBorders[1];
+    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);


@@ -404,8 +466,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;


@@ -425,7 +486,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 )


@@ -434,11 +495,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);


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

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

     // 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


@@ -497,6 +554,7 @@ void wxStatusBar::SetStatusStyles(int n, const int styles[])
         case wxSB_FLAT:
             style = SBT_NOBORDERS;
             break;
         case wxSB_FLAT:
             style = SBT_NOBORDERS;
             break;

+        case wxSB_SUNKEN:

         case wxSB_NORMAL:
         default:
             style = 0;
         case wxSB_NORMAL:
         default:
             style = 0;


@@ -507,7 +565,7 @@ void wxStatusBar::SetStatusStyles(int n, const int styles[])
         // the fields' styles.
         // NOTE: MSDN library doesn't mention that nField and style have to be 'ORed'
         wxString text = GetStatusText(i);
         // 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()))
+        if (!StatusBar_SetText(GetHwnd(), style | i, text.t_str()))

         {
             wxLogLastError("StatusBar_SetText");
         }
         {
             wxLogLastError("StatusBar_SetText");
         }


@@ -558,15 +616,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++)
-            DoUpdateStatusText(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);