Allow passing multi-line strings to wxDC::DrawText(), even under MSW.

[wxWidgets.git] / src / generic / statusbr.cpp

diff --git a/src/generic/statusbr.cpp b/src/generic/statusbr.cpp
index bd1f7f50a88c76747626995bbb8d7d94b0a388f6..4c24ee5c35eaadb261930f1d340cc1204d294e46 100644 (file)
--- a/src/generic/statusbr.cpp
+++ b/src/generic/statusbr.cpp
@@ -2,7 +2,7 @@
 // Name:        src/generic/statusbr.cpp
 // Purpose:     wxStatusBarGeneric class implementation
 // Author:      Julian Smart
 // Name:        src/generic/statusbr.cpp
 // Purpose:     wxStatusBarGeneric class implementation
 // Author:      Julian Smart

-// Modified by:
+// Modified by: Francesco Montorsi

 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart


@@ -24,10 +24,12 @@
     #include "wx/settings.h"
     #include "wx/dcclient.h"
     #include "wx/toplevel.h"
     #include "wx/settings.h"
     #include "wx/dcclient.h"
     #include "wx/toplevel.h"

+    #include "wx/control.h"

 #endif
 
 #ifdef __WXGTK20__
     #include <gtk/gtk.h>
 #endif
 
 #ifdef __WXGTK20__
     #include <gtk/gtk.h>

+    #include "wx/gtk/private.h"

 #endif
 
 // we only have to do it here when we use wxStatusBarGeneric in addition to the
 #endif
 
 // we only have to do it here when we use wxStatusBarGeneric in addition to the


@@ -44,6 +46,42 @@
 // Default status border dimensions
 #define wxTHICK_LINE_BORDER 2
 
 // Default status border dimensions
 #define wxTHICK_LINE_BORDER 2
 

+// Margin between the field text and the field rect
+#define wxFIELD_TEXT_MARGIN 2
+
+// ----------------------------------------------------------------------------
+// GTK+ signal handler
+// ----------------------------------------------------------------------------
+
+#if defined( __WXGTK20__ )
+#if GTK_CHECK_VERSION(2,12,0)
+extern "C" {
+static
+gboolean statusbar_query_tooltip(GtkWidget*   WXUNUSED(widget),
+                                 gint        x,
+                                 gint        y,
+                                 gboolean     WXUNUSED(keyboard_mode),
+                                 GtkTooltip *tooltip,
+                                 wxStatusBar* statbar)
+{
+    int n = statbar->GetFieldFromPoint(wxPoint(x,y));
+    if (n == wxNOT_FOUND)
+        return FALSE;
+
+    // should we show the tooltip for the n-th pane of the statusbar?
+    if (!statbar->GetField(n).IsEllipsized())
+        return FALSE;   // no, it's not useful
+
+    const wxString& str = statbar->GetStatusText(n);
+    if (str.empty())
+        return FALSE;
+
+    gtk_tooltip_set_text(tooltip, wxGTK_CONV_SYS(str));
+    return TRUE;
+}
+}
+#endif
+#endif

 
 // ----------------------------------------------------------------------------
 // wxStatusBarGeneric
 
 // ----------------------------------------------------------------------------
 // wxStatusBarGeneric


@@ -51,6 +89,7 @@
 
 BEGIN_EVENT_TABLE(wxStatusBarGeneric, wxWindow)
     EVT_PAINT(wxStatusBarGeneric::OnPaint)
 
 BEGIN_EVENT_TABLE(wxStatusBarGeneric, wxWindow)
     EVT_PAINT(wxStatusBarGeneric::OnPaint)

+    EVT_SIZE(wxStatusBarGeneric::OnSize)

     EVT_LEFT_DOWN(wxStatusBarGeneric::OnLeftDown)
     EVT_RIGHT_DOWN(wxStatusBarGeneric::OnRightDown)
     EVT_SYS_COLOUR_CHANGED(wxStatusBarGeneric::OnSysColourChanged)
     EVT_LEFT_DOWN(wxStatusBarGeneric::OnLeftDown)
     EVT_RIGHT_DOWN(wxStatusBarGeneric::OnRightDown)
     EVT_SYS_COLOUR_CHANGED(wxStatusBarGeneric::OnSysColourChanged)


@@ -86,105 +125,70 @@ bool wxStatusBarGeneric::Create(wxWindow *parent,
     SetFont(*wxSMALL_FONT);
 #endif
 
     SetFont(*wxSMALL_FONT);
 #endif
 

-    wxCoord y;
-    {
-        // Set the height according to the font and the border size
-        wxClientDC dc(this);
-        dc.SetFont(GetFont());
-
-        dc.GetTextExtent(_T("X"), NULL, &y );
-    }
-    int height = (int)( (11*y)/10 + 2*GetBorderY());
-
+    int height = (int)((11*GetCharHeight())/10 + 2*GetBorderY());

     SetSize(wxDefaultCoord, wxDefaultCoord, wxDefaultCoord, height);
 
     SetFieldsCount(1);
 
     SetSize(wxDefaultCoord, wxDefaultCoord, wxDefaultCoord, height);
 
     SetFieldsCount(1);
 

+#if defined( __WXGTK20__ )
+#if GTK_CHECK_VERSION(2,12,0)
+    if (HasFlag(wxSTB_SHOW_TIPS) && !gtk_check_version(2,12,0))
+    {
+        g_object_set(m_widget, "has-tooltip", TRUE, NULL);
+        g_signal_connect(m_widget, "query-tooltip",
+                         G_CALLBACK(statusbar_query_tooltip), this);
+    }
+#endif
+#endif
+

     return true;
 }
 
 wxSize wxStatusBarGeneric::DoGetBestSize() const
 {
     int width, height;
     return true;
 }
 
 wxSize wxStatusBarGeneric::DoGetBestSize() const
 {
     int width, height;

-    wxCoord y;

 
     // best width is the width of the parent
 
     // best width is the width of the parent

-    GetParent()->GetClientSize(&width, NULL);
+    if (GetParent())
+        GetParent()->GetClientSize(&width, NULL);
+    else
+        width = 80;     // a dummy value

 
     // best height is as calculated above in Create()
 
     // best height is as calculated above in Create()

-    wxClientDC dc((wxWindow*)this);
-    dc.SetFont(GetFont());
-    dc.GetTextExtent(_T("X"), NULL, &y);
-    height = (int)((11*y)/10 + 2*GetBorderY());
+    height = (int)((11*GetCharHeight())/10 + 2*GetBorderY());

 
     return wxSize(width, height);
 }
 
 
     return wxSize(width, height);
 }
 

-void wxStatusBarGeneric::SetFieldsCount(int number, const int *widths)
+void wxStatusBarGeneric::DoUpdateStatusText(int number)

 {
 {

-    wxASSERT_MSG( number >= 0, _T("negative number of fields in wxStatusBar?") );
-
-    // enlarge the m_statusStrings array if needed:
-    for (size_t i = m_panes.GetCount(); i < (size_t)number; ++i)
-        m_statusStrings.Add( wxEmptyString );
-
-    // shrink the m_statusStrings array if needed:
-    for (int j = (int)m_panes.GetCount() - 1; j >= number; --j)
-        m_statusStrings.RemoveAt(j);
-
-    // forget the old cached pixel widths
-    m_widthsAbs.Empty();
-
-    wxStatusBarBase::SetFieldsCount(number, widths);
-
-    wxASSERT_MSG( m_panes.GetCount() == m_statusStrings.GetCount(),
-                  _T("This really should never happen, can we do away with m_panes.GetCount() here?") );
-}
-
-void wxStatusBarGeneric::SetStatusText(const wxString& text, int number)
-{
-    wxCHECK_RET( (number >= 0) && ((size_t)number < m_panes.GetCount()),
-                 _T("invalid status bar field index") );
-
-    wxString oldText = m_statusStrings[number];
-    if (oldText != text)
-    {
-        m_statusStrings[number] = text;
-
-        wxRect rect;
-        GetFieldRect(number, rect);
-
-        Refresh(true, &rect);
+    wxRect rect;
+    GetFieldRect(number, rect);

 
 

-        // it's common to show some text in the status bar before starting a
-        // relatively lengthy operation, ensure that the text is shown to the
-        // user immediately and not after the lengthy operation end
-        Update();
-    }
-}
+    Refresh(true, &rect);

 
 

-wxString wxStatusBarGeneric::GetStatusText(int n) const
-{
-    wxCHECK_MSG( (n >= 0) && ((size_t)n < m_panes.GetCount()), wxEmptyString,
-                 _T("invalid status bar field index") );
-
-    return m_statusStrings[n];
+    // it's common to show some text in the status bar before starting a
+    // relatively lengthy operation, ensure that the text is shown to the
+    // user immediately and not after the lengthy operation end
+    Update();

 }
 
 void wxStatusBarGeneric::SetStatusWidths(int n, const int widths_field[])
 {
     // only set status widths when n == number of statuswindows
 }
 
 void wxStatusBarGeneric::SetStatusWidths(int n, const int widths_field[])
 {
     // only set status widths when n == number of statuswindows

-    wxCHECK_RET( (size_t)n == m_panes.GetCount(), _T("status bar field count mismatch") );
-
-    // forget the old cached pixel widths
-    m_widthsAbs.Empty();
+    wxCHECK_RET( (size_t)n == m_panes.GetCount(), wxT("status bar field count mismatch") );

 
     wxStatusBarBase::SetStatusWidths(n, widths_field);
 
     wxStatusBarBase::SetStatusWidths(n, widths_field);

+
+    // update cache
+    int width;
+    GetClientSize(&width, &m_lastClientHeight);
+    m_widthsAbs = CalculateAbsWidths(width);

 }
 
 bool wxStatusBarGeneric::ShowsSizeGrip() const
 {
 }
 
 bool wxStatusBarGeneric::ShowsSizeGrip() const
 {

-    if ( !HasFlag(wxST_SIZEGRIP) )
+    if ( !HasFlag(wxSTB_SIZEGRIP) )

         return false;
 
     wxTopLevelWindow * const
         return false;
 
     wxTopLevelWindow * const


@@ -192,47 +196,93 @@ bool wxStatusBarGeneric::ShowsSizeGrip() const
     return tlw && !tlw->IsMaximized() && tlw->HasFlag(wxRESIZE_BORDER);
 }
 
     return tlw && !tlw->IsMaximized() && tlw->HasFlag(wxRESIZE_BORDER);
 }
 

-void wxStatusBarGeneric::DrawFieldText(wxDC& dc, int i)
+void wxStatusBarGeneric::DrawFieldText(wxDC& dc, const wxRect& rect, int i, int textHeight)

 {
 {

-    int leftMargin = 2;
+    wxString text(GetStatusText(i));
+    if (text.empty())
+        return;     // optimization

 
 

-    wxRect rect;
-    GetFieldRect(i, rect);
+    int xpos = rect.x + wxFIELD_TEXT_MARGIN,
+        maxWidth = rect.width - 2*wxFIELD_TEXT_MARGIN,
+        ypos = (int) (((rect.height - textHeight) / 2) + rect.y + 0.5);

 
 

-    wxString text(GetStatusText(i));
+    if (ShowsSizeGrip())
+    {
+        // don't write text over the size grip:
+        // NOTE: overloading DoGetClientSize() and GetClientAreaOrigin() wouldn't
+        //       work because the adjustment needs to be done only when drawing
+        //       the field text and not also when drawing the background, the
+        //       size grip itself, etc
+        if ((GetLayoutDirection() == wxLayout_RightToLeft && i == 0) ||
+            (GetLayoutDirection() != wxLayout_RightToLeft &&
+                 i == (int)m_panes.GetCount()-1))
+        {
+            const wxRect& gripRc = GetSizeGripRect();
+
+            // NOTE: we don't need any special treatment wrt to the layout direction
+            //       since DrawText() will automatically adjust the origin of the
+            //       text accordingly to the layout in use

 
 

-    wxCoord x = 0, y = 0;
-    dc.GetTextExtent(text, &x, &y);
+            maxWidth -= gripRc.width;
+        }
+    }
+
+    // eventually ellipsize the text so that it fits the field width
+
+    wxEllipsizeMode ellmode = (wxEllipsizeMode)-1;
+    if (HasFlag(wxSTB_ELLIPSIZE_START)) ellmode = wxELLIPSIZE_START;
+    else if (HasFlag(wxSTB_ELLIPSIZE_MIDDLE)) ellmode = wxELLIPSIZE_MIDDLE;
+    else if (HasFlag(wxSTB_ELLIPSIZE_END)) ellmode = wxELLIPSIZE_END;
+
+    if (ellmode == (wxEllipsizeMode)-1)
+    {
+        // if we have the wxSTB_SHOW_TIPS we must set the ellipsized flag even if
+        // we don't ellipsize the text but just truncate it
+        if (HasFlag(wxSTB_SHOW_TIPS))
+            SetEllipsizedFlag(i, dc.GetTextExtent(text).GetWidth() > maxWidth);

 
 

-    int xpos = rect.x + leftMargin;
-    int ypos = (int) (((rect.height - y) / 2 ) + rect.y + 0.5);
+        dc.SetClippingRegion(rect);
+    }
+    else
+    {
+        text = wxControl::Ellipsize(text, dc,
+                                    ellmode,
+                                    maxWidth,
+                                    wxELLIPSIZE_FLAGS_EXPAND_TABS);
+            // Ellipsize() will do something only if necessary
+
+        // 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(i, text != GetStatusText(i));
+    }

 
 #if defined( __WXGTK__ ) || defined(__WXMAC__)
     xpos++;
     ypos++;
 #endif
 
 
 #if defined( __WXGTK__ ) || defined(__WXMAC__)
     xpos++;
     ypos++;
 #endif
 

-    dc.SetClippingRegion(rect.x, rect.y, rect.width, rect.height);
-
+    // draw the text

     dc.DrawText(text, xpos, ypos);
 
     dc.DrawText(text, xpos, ypos);
 

-    dc.DestroyClippingRegion();
+    if (ellmode == (wxEllipsizeMode)-1)
+        dc.DestroyClippingRegion();

 }
 
 }
 

-void wxStatusBarGeneric::DrawField(wxDC& dc, int i)
+void wxStatusBarGeneric::DrawField(wxDC& dc, int i, int textHeight)

 {
     wxRect rect;
     GetFieldRect(i, rect);
 
 {
     wxRect rect;
     GetFieldRect(i, rect);
 

-    int style = m_panes[i].nStyle;
+    if (rect.GetWidth() <= 0)
+        return;     // happens when the status bar is shrinked in a very small area!
+
+    int style = m_panes[i].GetStyle();

     if (style != wxSB_FLAT)
     {
         // Draw border
     if (style != wxSB_FLAT)
     {
         // Draw border

-        // For wxSB_NORMAL:
-        // Have grey background, plus 3-d border -
-        // One black rectangle.
-        // Inside this, left and top sides - dark grey. Bottom and right -
-        // white.
+        // For wxSB_NORMAL: paint a grey background, plus 3-d border (one black rectangle)
+        // Inside this, left and top sides (dark grey). Bottom and right (white).

         // Reverse it for wxSB_RAISED
 
         dc.SetPen((style == wxSB_RAISED) ? m_mediumShadowPen : m_hilightPen);
         // Reverse it for wxSB_RAISED
 
         dc.SetPen((style == wxSB_RAISED) ? m_mediumShadowPen : m_hilightPen);


@@ -263,56 +313,60 @@ void wxStatusBarGeneric::DrawField(wxDC& dc, int i)
         dc.DrawLine(rect.x, rect.y,
                     rect.x + rect.width, rect.y);
         dc.DrawLine(rect.x, rect.y + rect.height,
         dc.DrawLine(rect.x, rect.y,
                     rect.x + rect.width, rect.y);
         dc.DrawLine(rect.x, rect.y + rect.height,

-                   rect.x, rect.y);
-
+                    rect.x, rect.y);

 #endif
     }
 
 #endif
     }
 

-    DrawFieldText(dc, i);
+    DrawFieldText(dc, rect, i, textHeight);

 }
 
 }
 

-// Get the position and size of the field's internal bounding rectangle

 bool wxStatusBarGeneric::GetFieldRect(int n, wxRect& rect) const
 {
     wxCHECK_MSG( (n >= 0) && ((size_t)n < m_panes.GetCount()), false,
 bool wxStatusBarGeneric::GetFieldRect(int n, wxRect& rect) const
 {
     wxCHECK_MSG( (n >= 0) && ((size_t)n < m_panes.GetCount()), false,

-                 _T("invalid status bar field index") );
-
-    // FIXME: workarounds for OS/2 bugs have nothing to do here (VZ)
-    int width, height;
-#ifdef __WXPM__
-    GetSize(&width, &height);
-#else
-    GetClientSize(&width, &height);
-#endif
+                 wxT("invalid status bar field index") );

 
 

-    // we cache m_widthsAbs between calls and recompute it if client
-    // width has changed (or when it is initially empty)
-    if ( m_widthsAbs.IsEmpty() || m_lastClientWidth != width )
-    {
-        wxConstCast(this, wxStatusBarGeneric)->m_widthsAbs = CalculateAbsWidths(width);
-
-        // remember last width for which we have recomputed the widths in pixels
-        wxConstCast(this, wxStatusBarGeneric)->m_lastClientWidth = width;
-    }
+    if (m_widthsAbs.IsEmpty())
+        return false;

 
     rect.x = 0;
     for ( int i = 0; i < n; i++ )
         rect.x += m_widthsAbs[i];
 
     rect.x = 0;
     for ( int i = 0; i < n; i++ )
         rect.x += m_widthsAbs[i];

-

     rect.x += m_borderX;
     rect.x += m_borderX;

-    rect.y = m_borderY;

 
 

+    rect.y = m_borderY;

     rect.width = m_widthsAbs[n] - 2*m_borderX;
     rect.width = m_widthsAbs[n] - 2*m_borderX;

-    rect.height = height - 2*m_borderY;
+    rect.height = m_lastClientHeight - 2*m_borderY;

 
     return true;
 }
 
 
     return true;
 }
 

-// Initialize colours
+int wxStatusBarGeneric::GetFieldFromPoint(const wxPoint& pt) const
+{
+    if (m_widthsAbs.IsEmpty())
+        return wxNOT_FOUND;
+
+    // NOTE: we explicitely don't take in count the borders since they are only
+    //       useful when rendering the status text, not for hit-test computations
+
+    if (pt.y <= 0 || pt.y >= m_lastClientHeight)
+        return wxNOT_FOUND;
+
+    int x = 0;
+    for ( size_t i = 0; i < m_panes.GetCount(); i++ )
+    {
+        if (pt.x > x && pt.x < x+m_widthsAbs[i])
+            return i;
+
+        x += m_widthsAbs[i];
+    }
+
+    return wxNOT_FOUND;
+}
+

 void wxStatusBarGeneric::InitColours()
 {
 #if defined(__WXPM__)
 void wxStatusBarGeneric::InitColours()
 {
 #if defined(__WXPM__)

-    m_mediumShadowPen = wxPen(wxColour(127, 127, 127), 1, wxSOLID);
+    m_mediumShadowPen = wxPen(wxColour(127, 127, 127));

     m_hilightPen = *wxWHITE_PEN;
 
     SetBackgroundColour(*wxLIGHT_GREY);
     m_hilightPen = *wxWHITE_PEN;
 
     SetBackgroundColour(*wxLIGHT_GREY);


@@ -326,17 +380,23 @@ void wxStatusBarGeneric::InitColours()
 void wxStatusBarGeneric::SetMinHeight(int height)
 {
     // check that this min height is not less than minimal height for the
 void wxStatusBarGeneric::SetMinHeight(int height)
 {
     // check that this min height is not less than minimal height for the

-    // current font
-    wxClientDC dc(this);
-    wxCoord y;
-    dc.GetTextExtent( wxT("X"), NULL, &y );
+    // current font (min height is as calculated above in Create() except for border)
+    int minHeight = (int)((11*GetCharHeight())/10);

 
 

-    if ( height > (11*y)/10 )
-    {
+    if ( height > minHeight )

         SetSize(wxDefaultCoord, wxDefaultCoord, wxDefaultCoord, height + 2*m_borderY);
         SetSize(wxDefaultCoord, wxDefaultCoord, wxDefaultCoord, height + 2*m_borderY);

-    }

 }
 
 }
 

+wxRect wxStatusBarGeneric::GetSizeGripRect() const
+{
+    int width, height;
+    wxWindow::DoGetClientSize(&width, &height);
+
+    if (GetLayoutDirection() == wxLayout_RightToLeft)
+        return wxRect(2, 2, height-2, height-4);
+    else
+        return wxRect(width-height-2, 2, height-2, height-4);
+}

 
 // ----------------------------------------------------------------------------
 // wxStatusBarGeneric - event handlers
 
 // ----------------------------------------------------------------------------
 // wxStatusBarGeneric - event handlers


@@ -350,44 +410,32 @@ void wxStatusBarGeneric::OnPaint(wxPaintEvent& WXUNUSED(event) )
     // Draw grip first
     if ( ShowsSizeGrip() )
     {
     // Draw grip first
     if ( ShowsSizeGrip() )
     {

-        int width, height;
-        GetClientSize(&width, &height);
-
-        if (GetLayoutDirection() == wxLayout_RightToLeft)
-        {
-            gtk_paint_resize_grip( m_widget->style,
-                               GTKGetDrawingWindow(),
-                               (GtkStateType) GTK_WIDGET_STATE (m_widget),
-                               NULL,
-                               m_widget,
-                               "statusbar",
-                               GDK_WINDOW_EDGE_SOUTH_WEST,
-                               2, 2, height-2, height-4 );
-        }
-        else
-        {
-            gtk_paint_resize_grip( m_widget->style,
-                               GTKGetDrawingWindow(),
-                               (GtkStateType) GTK_WIDGET_STATE (m_widget),
-                               NULL,
-                               m_widget,
-                               "statusbar",
-                               GDK_WINDOW_EDGE_SOUTH_EAST,
-                               width-height-2, 2, height-2, height-4 );
-        }
+        const wxRect& rc = GetSizeGripRect();
+        GdkWindowEdge edge =
+            GetLayoutDirection() == wxLayout_RightToLeft ? GDK_WINDOW_EDGE_SOUTH_WEST :
+                                                           GDK_WINDOW_EDGE_SOUTH_EAST;
+        gtk_paint_resize_grip( m_widget->style,
+                            GTKGetDrawingWindow(),
+                            (GtkStateType) GTK_WIDGET_STATE (m_widget),
+                            NULL,
+                            m_widget,
+                            "statusbar",
+                            edge,
+                            rc.x, rc.y, rc.width, rc.height );

     }
 #endif // __WXGTK20__
 
     if (GetFont().IsOk())
         dc.SetFont(GetFont());
 
     }
 #endif // __WXGTK20__
 
     if (GetFont().IsOk())
         dc.SetFont(GetFont());
 

-    dc.SetBackgroundMode(wxBRUSHSTYLE_TRANSPARENT);
+    // compute char height only once for all panes:
+    int textHeight = dc.GetCharHeight();

 
 

+    dc.SetBackgroundMode(wxBRUSHSTYLE_TRANSPARENT);

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

-        DrawField(dc, i);
+        DrawField(dc, i, textHeight);

 }
 
 }
 

-// Responds to colour changes, and passes event on to children.

 void wxStatusBarGeneric::OnSysColourChanged(wxSysColourChangedEvent& event)
 {
     InitColours();
 void wxStatusBarGeneric::OnSysColourChanged(wxSysColourChangedEvent& event)
 {
     InitColours();


@@ -477,4 +525,18 @@ void wxStatusBarGeneric::OnRightDown(wxMouseEvent& event)
 #endif
 }
 
 #endif
 }
 

+void wxStatusBarGeneric::OnSize(wxSizeEvent& WXUNUSED(event))
+{
+    // FIXME: workarounds for OS/2 bugs have nothing to do here (VZ)
+    int width;
+#ifdef __WXPM__
+    GetSize(&width, &m_lastClientHeight);
+#else
+    GetClientSize(&width, &m_lastClientHeight);
+#endif
+
+    // recompute the cache of the field widths if the status bar width has changed
+    m_widthsAbs = CalculateAbsWidths(width);
+}
+

 #endif // wxUSE_STATUSBAR
 #endif // wxUSE_STATUSBAR