]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/statbar.cpp
Add missing WXK constants for the control keys
[wxWidgets.git] / src / common / statbar.cpp
index a8ad8868c82f5330d92172269a3c8865ad3cc3b9..d196f159339704ef54f53232c58efd2d71bb6d25 100644 (file)
@@ -6,7 +6,7 @@
 // Created:     14.10.01
 // RCS-ID:      $Id$
 // Copyright:   (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// License:     wxWindows licence
+// Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 
 const char wxStatusBarNameStr[] = "statusBar";
 
+// ============================================================================
+// wxStatusBarPane implementation
+// ============================================================================
+
+bool wxStatusBarPane::SetText(const wxString& text)
+{
+    if ( text == m_text )
+        return false;
+
+    /*
+        If we have a message to restore on the stack, we update it to
+        correspond to the current one so that a sequence of calls such as
+
+        1. SetStatusText("foo")
+        2. PushStatusText("bar")
+        3. SetStatusText("new foo")
+        4. PopStatusText()
+
+        doesn't overwrite the "new foo" which should be shown at the end with
+        the old value "foo". This would be unexpected and hard to avoid,
+        especially when PushStatusText() is used internally by wxWidgets
+        without knowledge of the user program, as it is for showing the menu
+        and toolbar help strings.
+
+        By updating the top of the stack we ensure that the next call to
+        PopStatusText() basically becomes a NOP without breaking the balance
+        between the calls to push and pop as we would have done if we really
+        called PopStatusText() here.
+     */
+    if ( !m_arrStack.empty() )
+    {
+        m_arrStack.back() = text;
+    }
+
+    m_text = text;
+
+    return true;
+}
+
+bool wxStatusBarPane::PushText(const wxString& text)
+{
+    // save the currently shown text
+    m_arrStack.push_back(m_text);
+
+    // and update the new one if necessary
+    if ( text == m_text )
+        return false;
+
+    m_text = text;
+
+    return true;
+}
+
+bool wxStatusBarPane::PopText()
+{
+    wxCHECK_MSG( !m_arrStack.empty(), false, "no status message to pop" );
+
+    const wxString text = m_arrStack.back();
+
+    m_arrStack.pop_back();
+
+    if ( text == m_text )
+        return false;
+
+    m_text = text;
+
+    return true;
+}
 
 // ============================================================================
 // wxStatusBarBase implementation
@@ -41,8 +109,8 @@ const char wxStatusBarNameStr[] = "statusBar";
 
 IMPLEMENT_DYNAMIC_CLASS(wxStatusBar, wxWindow)
 
-#include <wx/arrimpl.cpp> // This is a magic incantation which must be done!
-WX_DEFINE_OBJARRAY(wxStatusBarPaneArray);
+#include "wx/arrimpl.cpp" // This is a magic incantation which must be done!
+WX_DEFINE_EXPORTED_OBJARRAY(wxStatusBarPaneArray)
 
 
 // ----------------------------------------------------------------------------
@@ -58,7 +126,7 @@ wxStatusBarBase::~wxStatusBarBase()
 {
     // notify the frame that it doesn't have a status bar any longer to avoid
     // dangling pointers
-    wxFrame *frame = dynamic_cast<wxFrame*>(GetParent());
+    wxFrame *frame = wxDynamicCast(GetParent(), wxFrame);
     if ( frame && frame->GetStatusBar() == this )
         frame->SetStatusBar(NULL);
 }
@@ -69,9 +137,7 @@ wxStatusBarBase::~wxStatusBarBase()
 
 void wxStatusBarBase::SetFieldsCount(int number, const int *widths)
 {
-    wxCHECK_RET( number > 0, _T("invalid field number in SetFieldsCount") );
-
-    bool refresh = false;
+    wxCHECK_RET( number > 0, wxT("invalid field number in SetFieldsCount") );
 
     if ( (size_t)number > m_panes.GetCount() )
     {
@@ -88,45 +154,42 @@ void wxStatusBarBase::SetFieldsCount(int number, const int *widths)
         m_panes.RemoveAt(number, m_panes.GetCount()-number);
     }
 
-    refresh = true;
-
-    if ( widths )
-    {
-        SetStatusWidths(number, widths);
-
-        // already done from SetStatusWidths()
-        refresh = false;
-    }
-
-    if ( refresh )
-        Refresh();
+    // SetStatusWidths will automatically refresh
+    SetStatusWidths(number, widths);
 }
 
 void wxStatusBarBase::SetStatusWidths(int WXUNUSED_UNLESS_DEBUG(n),
-                                      const int widths[])
+                                    const int widths[])
 {
-    wxCHECK_RET( widths, _T("NULL pointer in SetStatusWidths") );
+    wxASSERT_MSG( (size_t)n == m_panes.GetCount(), wxT("field number mismatch") );
 
-    wxASSERT_MSG( (size_t)n == m_panes.GetCount(), _T("field number mismatch") );
-
-    for ( size_t i = 0; i < m_panes.GetCount(); i++ )
-        m_panes[i].nWidth = widths[i];
+    if (widths == NULL)
+    {
+        // special value meaning: override explicit pane widths and make them all
+        // of the same size
+        m_bSameWidthForAllPanes = true;
+    }
+    else
+    {
+        for ( size_t i = 0; i < m_panes.GetCount(); i++ )
+            m_panes[i].SetWidth(widths[i]);
 
-    m_bSameWidthForAllPanes = false;
+        m_bSameWidthForAllPanes = false;
+    }
 
     // update the display after the widths changed
     Refresh();
 }
 
 void wxStatusBarBase::SetStatusStyles(int WXUNUSED_UNLESS_DEBUG(n),
-                                      const int styles[])
+                                    const int styles[])
 {
-    wxCHECK_RET( styles, _T("NULL pointer in SetStatusStyles") );
+    wxCHECK_RET( styles, wxT("NULL pointer in SetStatusStyles") );
 
-    wxASSERT_MSG( (size_t)n == m_panes.GetCount(), _T("field number mismatch") );
+    wxASSERT_MSG( (size_t)n == m_panes.GetCount(), wxT("field number mismatch") );
 
     for ( size_t i = 0; i < m_panes.GetCount(); i++ )
-        m_panes[i].nStyle = styles[i];
+        m_panes[i].SetStyle(styles[i]);
 
     // update the display after the widths changed
     Refresh();
@@ -158,15 +221,15 @@ wxArrayInt wxStatusBarBase::CalculateAbsWidths(wxCoord widthTotal) const
         // calculate the total width of all the fixed width fields and the
         // total number of var field widths counting with multiplicity
         size_t nTotalWidth = 0,
-               nVarCount = 0,
-               i;
+            nVarCount = 0,
+            i;
 
         for ( i = 0; i < m_panes.GetCount(); i++ )
         {
-            if ( m_panes[i].nWidth >= 0 )
-                nTotalWidth += m_panes[i].nWidth;
+            if ( m_panes[i].GetWidth() >= 0 )
+                nTotalWidth += m_panes[i].GetWidth();
             else
-                nVarCount += -m_panes[i].nWidth;
+                nVarCount += -m_panes[i].GetWidth();
         }
 
         // the amount of extra width we have per each var width field
@@ -175,12 +238,12 @@ wxArrayInt wxStatusBarBase::CalculateAbsWidths(wxCoord widthTotal) const
         // do fill the array
         for ( i = 0; i < m_panes.GetCount(); i++ )
         {
-            if ( m_panes[i].nWidth >= 0 )
-                widths.Add(m_panes[i].nWidth);
+            if ( m_panes[i].GetWidth() >= 0 )
+                widths.Add(m_panes[i].GetWidth());
             else
             {
-                int nVarWidth = widthExtra > 0 ? (widthExtra * (-m_panes[i].nWidth)) / nVarCount : 0;
-                nVarCount += m_panes[i].nWidth;
+                int nVarWidth = widthExtra > 0 ? (widthExtra * (-m_panes[i].GetWidth())) / nVarCount : 0;
+                nVarCount += m_panes[i].GetWidth();
                 widthExtra -= nVarWidth;
                 widths.Add(nVarWidth);
             }
@@ -191,25 +254,54 @@ wxArrayInt wxStatusBarBase::CalculateAbsWidths(wxCoord widthTotal) const
 }
 
 // ----------------------------------------------------------------------------
-// status text stacks
+// setting/getting status text
+// ----------------------------------------------------------------------------
+
+void wxStatusBarBase::SetStatusText(const wxString& text, int number)
+{
+    wxCHECK_RET( (unsigned)number < m_panes.size(),
+                    "invalid status bar field index" );
+
+    if ( m_panes[number].SetText(text) )
+        DoUpdateStatusText(number);
+}
+
+wxString wxStatusBarBase::GetStatusText(int number) const
+{
+    wxCHECK_MSG( (unsigned)number < m_panes.size(), wxString(),
+                    "invalid status bar field index" );
+
+    return m_panes[number].GetText();
+}
+
+void wxStatusBarBase::SetEllipsizedFlag(int number, bool isEllipsized)
+{
+    wxCHECK_RET( (unsigned)number < m_panes.size(),
+                    "invalid status bar field index" );
+
+    m_panes[number].SetIsEllipsized(isEllipsized);
+}
+
+// ----------------------------------------------------------------------------
+// pushing/popping status text
 // ----------------------------------------------------------------------------
 
 void wxStatusBarBase::PushStatusText(const wxString& text, int number)
 {
-    // save current status text in the stack
-    m_panes[number].arrStack.push_back(GetStatusText(number));
+    wxCHECK_RET( (unsigned)number < m_panes.size(),
+                    "invalid status bar field index" );
 
-    // update current status text
-    SetStatusText(text, number);
+    if ( m_panes[number].PushText(text) )
+        DoUpdateStatusText(number);
 }
 
 void wxStatusBarBase::PopStatusText(int number)
 {
-    wxString text = m_panes[number].arrStack.back();
-    m_panes[number].arrStack.pop_back();  // also remove it from the stack
+    wxCHECK_RET( (unsigned)number < m_panes.size(),
+                    "invalid status bar field index" );
 
-    // restore the popped status text in the pane
-    SetStatusText(text, number);
+    if ( m_panes[number].PopText() )
+        DoUpdateStatusText(number);
 }
 
 #endif // wxUSE_STATUSBAR