Added help button

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

diff --git a/src/generic/statusbr.cpp b/src/generic/statusbr.cpp
index a0f4a88d340d2a0483e81ca343323ed9c9f00147..740df48eed026e533fefd1aa232566f25270ffd6 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


@@ -47,6 +49,39 @@
 // Margin between the field text and the field rect
 #define wxFIELD_TEXT_MARGIN 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


@@ -95,6 +130,17 @@ bool wxStatusBarGeneric::Create(wxWindow *parent,
 
     SetFieldsCount(1);
 
 
     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;
 }
 
     return true;
 }
 


@@ -114,71 +160,35 @@ wxSize wxStatusBarGeneric::DoGetBestSize() const
     return wxSize(width, height);
 }
 
     return wxSize(width, height);
 }
 

-void wxStatusBarGeneric::SetFieldsCount(int number, const int *widths)
-{
-    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)
+void wxStatusBarGeneric::DoUpdateStatusText(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);
-
-        // 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();
-    }
-}
+    wxRect rect;
+    GetFieldRect(number, rect);

 
 

-wxString wxStatusBarGeneric::GetStatusText(int n) const
-{
-    wxCHECK_MSG( (n >= 0) && ((size_t)n < m_panes.GetCount()), wxEmptyString,
-                 _T("invalid status bar field index") );
+    Refresh(true, &rect);

 
 

-    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


@@ -218,12 +228,34 @@ void wxStatusBarGeneric::DrawFieldText(wxDC& dc, const wxRect& rect, int i, int
     }
 
     // eventually ellipsize the text so that it fits the field width
     }
 
     // eventually ellipsize the text so that it fits the field width

-    text = wxControl::Ellipsize(
-        text, dc,
-        GetLayoutDirection() == wxLayout_RightToLeft ? wxELLIPSIZE_START : wxELLIPSIZE_END,
-        maxWidth,
-        wxELLIPSIZE_EXPAND_TAB);
-        // Ellipsize() will do something only if necessary
+
+    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);
+
+        dc.SetClippingRegion(rect);
+    }
+    else
+    {
+        text = wxControl::Ellipsize(text, dc,
+                                    ellmode,
+                                    maxWidth,
+                                    wxELLIPSIZE_EXPAND_TAB);
+            // 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++;
 
 #if defined( __WXGTK__ ) || defined(__WXMAC__)
     xpos++;


@@ -232,6 +264,9 @@ void wxStatusBarGeneric::DrawFieldText(wxDC& dc, const wxRect& rect, int i, int
 
     // draw the text
     dc.DrawText(text, xpos, ypos);
 
     // draw the text
     dc.DrawText(text, xpos, ypos);

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

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


@@ -242,15 +277,12 @@ void wxStatusBarGeneric::DrawField(wxDC& dc, int i, int textHeight)
     if (rect.GetWidth() <= 0)
         return;     // happens when the status bar is shrinked in a very small area!
 
     if (rect.GetWidth() <= 0)
         return;     // happens when the status bar is shrinked in a very small area!
 

-    int style = m_panes[i].nStyle;
+    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);


@@ -281,18 +313,17 @@ void wxStatusBarGeneric::DrawField(wxDC& dc, int i, int textHeight)
         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
     }
 
     DrawFieldText(dc, rect, i, textHeight);
 }
 
 #endif
     }
 
     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") );
+                 wxT("invalid status bar field index") );

 
     if (m_widthsAbs.IsEmpty())
         return false;
 
     if (m_widthsAbs.IsEmpty())
         return false;


@@ -309,11 +340,33 @@ bool wxStatusBarGeneric::GetFieldRect(int n, wxRect& rect) const
     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);


@@ -383,7 +436,6 @@ void wxStatusBarGeneric::OnPaint(wxPaintEvent& WXUNUSED(event) )
         DrawField(dc, i, textHeight);
 }
 
         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();