///////////////////////////////////////////////////////////////////////////////
-// Name: common/statbar.cpp
+// Name: src/common/statbar.cpp
// Purpose: wxStatusBarBase implementation
// Author: Vadim Zeitlin
-// Modified by:
+// Modified by: Francesco Montorsi
// Created: 14.10.01
-// RCS-ID: $Id$
// Copyright: (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// License: wxWindows licence
+// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
// ============================================================================
// headers
// ----------------------------------------------------------------------------
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
- #pragma implementation "statbar.h"
-#endif
-
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#pragma hdrstop
#endif
+#if wxUSE_STATUSBAR
+
+#include "wx/statusbr.h"
+
#ifndef WX_PRECOMP
#include "wx/frame.h"
- #include "wx/statusbr.h"
#endif //WX_PRECOMP
-#if wxUSE_STATUSBAR
-
-#include "wx/listimpl.cpp"
-WX_DEFINE_LIST(wxListString);
+const char wxStatusBarNameStr[] = "statusBar";
// ============================================================================
-// wxStatusBarBase implementation
+// wxStatusBarPane implementation
// ============================================================================
-IMPLEMENT_DYNAMIC_CLASS(wxStatusBar, wxWindow)
-
-// ----------------------------------------------------------------------------
-// ctor/dtor
-// ----------------------------------------------------------------------------
-
-wxStatusBarBase::wxStatusBarBase()
+bool wxStatusBarPane::SetText(const wxString& text)
{
- m_nFields = 0;
+ 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;
- InitWidths();
- InitStacks();
- InitStyles();
+ return true;
}
-wxStatusBarBase::~wxStatusBarBase()
+bool wxStatusBarPane::PushText(const wxString& text)
{
- FreeWidths();
- FreeStacks();
- FreeStyles();
+ // save the currently shown text
+ m_arrStack.push_back(m_text);
- // notify the frame that it doesn't have a status bar any longer to avoid
- // dangling pointers
- wxFrameBase *frame = wxDynamicCast(GetParent(), wxFrameBase);
- if ( frame && frame->GetStatusBar() == this )
- {
- frame->SetStatusBar(NULL);
- }
-}
+ // and update the new one if necessary
+ if ( text == m_text )
+ return false;
-// ----------------------------------------------------------------------------
-// widths array handling
-// ----------------------------------------------------------------------------
+ m_text = text;
-void wxStatusBarBase::InitWidths()
-{
- m_statusWidths = NULL;
+ return true;
}
-void wxStatusBarBase::FreeWidths()
+bool wxStatusBarPane::PopText()
{
- delete [] m_statusWidths;
+ 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
+// ============================================================================
+
+IMPLEMENT_DYNAMIC_CLASS(wxStatusBar, wxWindow)
+
+#include "wx/arrimpl.cpp" // This is a magic incantation which must be done!
+WX_DEFINE_EXPORTED_OBJARRAY(wxStatusBarPaneArray)
+
+
// ----------------------------------------------------------------------------
-// styles array handling
+// ctor/dtor
// ----------------------------------------------------------------------------
-void wxStatusBarBase::InitStyles()
+wxStatusBarBase::wxStatusBarBase()
{
- m_statusStyles = NULL;
+ m_bSameWidthForAllPanes = true;
}
-void wxStatusBarBase::FreeStyles()
+wxStatusBarBase::~wxStatusBarBase()
{
- delete [] m_statusStyles;
+ // notify the frame that it doesn't have a status bar any longer to avoid
+ // dangling pointers
+ wxFrame *frame = wxDynamicCast(GetParent(), wxFrame);
+ if ( frame && frame->GetStatusBar() == this )
+ frame->SetStatusBar(NULL);
}
// ----------------------------------------------------------------------------
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 ( number != m_nFields )
+ if ( (size_t)number > m_panes.GetCount() )
{
- // copy stacks if present
- if(m_statusTextStacks)
- {
- wxListString **newStacks = new wxListString*[number];
- size_t i, j, max = wxMin(number, m_nFields);
-
- // copy old stacks
- for(i = 0; i < max; ++i)
- newStacks[i] = m_statusTextStacks[i];
- // free old stacks in excess
- for(j = i; j < (size_t)m_nFields; ++j)
- {
- if(m_statusTextStacks[j])
- {
- m_statusTextStacks[j]->Clear();
- delete m_statusTextStacks[j];
- }
- }
- // initialize new stacks to NULL
- for(j = i; j < (size_t)number; ++j)
- newStacks[j] = 0;
-
- m_statusTextStacks = newStacks;
- }
-
- // Resize styles array
- if (m_statusStyles)
- {
- int *oldStyles = m_statusStyles;
- m_statusStyles = new int[number];
- int i, max = wxMin(number, m_nFields);
-
- // copy old styles
- for (i = 0; i < max; ++i)
- m_statusStyles[i] = oldStyles[i];
-
- // initialize new styles to wxSB_NORMAL
- for (i = max; i < number; ++i)
- m_statusStyles[i] = wxSB_NORMAL;
-
- // free old styles
- delete [] oldStyles;
- }
+ wxStatusBarPane newPane;
-
- m_nFields = number;
-
- ReinitWidths();
-
- refresh = true;
+ // add more entries with the default style and zero width
+ // (this will be set later)
+ for (size_t i = m_panes.GetCount(); i < (size_t)number; ++i)
+ m_panes.Add(newPane);
}
- //else: keep the old m_statusWidths if we had them
-
- if ( widths )
+ else if ( (size_t)number < m_panes.GetCount() )
{
- SetStatusWidths(number, widths);
-
- // already done from SetStatusWidths()
- refresh = false;
+ // remove entries in excess
+ m_panes.RemoveAt(number, m_panes.GetCount()-number);
}
- 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( n == m_nFields, _T("field number mismatch") );
-
- if ( !m_statusWidths )
- m_statusWidths = new int[m_nFields];
+ wxASSERT_MSG( (size_t)n == m_panes.GetCount(), wxT("field number mismatch") );
- for ( int i = 0; i < m_nFields; i++ )
+ if (widths == NULL)
{
- m_statusWidths[i] = widths[i];
+ // 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;
}
// update the display after the widths changed
}
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( n == m_nFields, _T("field number mismatch") );
+ wxASSERT_MSG( (size_t)n == m_panes.GetCount(), wxT("field number mismatch") );
- if ( !m_statusStyles )
- m_statusStyles = new int[m_nFields];
-
- for ( int i = 0; i < m_nFields; i++ )
- {
- m_statusStyles[i] = styles[i];
- }
+ for ( size_t i = 0; i < m_panes.GetCount(); i++ )
+ m_panes[i].SetStyle(styles[i]);
// update the display after the widths changed
Refresh();
{
wxArrayInt widths;
- if ( m_statusWidths == NULL )
+ if ( m_bSameWidthForAllPanes )
{
- if ( m_nFields )
+ // Default: all fields have the same width. This is not always
+ // possible to do exactly (if widthTotal is not divisible by
+ // m_panes.GetCount()) - if that happens, we distribute the extra
+ // pixels among all fields:
+ int widthToUse = widthTotal;
+
+ for ( size_t i = m_panes.GetCount(); i > 0; i-- )
{
- // default: all fields have the same width
- int nWidth = widthTotal / m_nFields;
- for ( int i = 0; i < m_nFields; i++ )
- {
- widths.Add(nWidth);
- }
+ // divide the unassigned width evently between the
+ // not yet processed fields:
+ int w = widthToUse / i;
+ widths.Add(w);
+ widthToUse -= w;
}
- //else: we're empty anyhow
}
- else // have explicit status widths
+ else // do not override explicit pane widths
{
// calculate the total width of all the fixed width fields and the
// total number of var field widths counting with multiplicity
- int nTotalWidth = 0,
+ size_t nTotalWidth = 0,
nVarCount = 0,
i;
- for ( i = 0; i < m_nFields; i++ )
+
+ for ( i = 0; i < m_panes.GetCount(); i++ )
{
- if ( m_statusWidths[i] >= 0 )
- {
- nTotalWidth += m_statusWidths[i];
- }
+ if ( m_panes[i].GetWidth() >= 0 )
+ nTotalWidth += m_panes[i].GetWidth();
else
- {
- nVarCount += -m_statusWidths[i];
- }
+ nVarCount += -m_panes[i].GetWidth();
}
// the amount of extra width we have per each var width field
int widthExtra = widthTotal - nTotalWidth;
// do fill the array
- for ( i = 0; i < m_nFields; i++ )
+ for ( i = 0; i < m_panes.GetCount(); i++ )
{
- if ( m_statusWidths[i] >= 0 )
- {
- widths.Add(m_statusWidths[i]);
- }
+ if ( m_panes[i].GetWidth() >= 0 )
+ widths.Add(m_panes[i].GetWidth());
else
{
- int nVarWidth = widthExtra > 0 ? (widthExtra * -m_statusWidths[i]) / nVarCount : 0;
- nVarCount += m_statusWidths[i];
+ int nVarWidth = widthExtra > 0 ? (widthExtra * (-m_panes[i].GetWidth())) / nVarCount : 0;
+ nVarCount += m_panes[i].GetWidth();
widthExtra -= nVarWidth;
widths.Add(nVarWidth);
}
}
// ----------------------------------------------------------------------------
-// text stacks handling
+// setting/getting status text
// ----------------------------------------------------------------------------
-void wxStatusBarBase::InitStacks()
+void wxStatusBarBase::SetStatusText(const wxString& text, int number)
{
- m_statusTextStacks = NULL;
+ wxCHECK_RET( (unsigned)number < m_panes.size(),
+ "invalid status bar field index" );
+
+ if ( m_panes[number].SetText(text) )
+ DoUpdateStatusText(number);
}
-void wxStatusBarBase::FreeStacks()
+wxString wxStatusBarBase::GetStatusText(int number) const
{
- if ( !m_statusTextStacks )
- return;
+ wxCHECK_MSG( (unsigned)number < m_panes.size(), wxString(),
+ "invalid status bar field index" );
- for ( size_t i = 0; i < (size_t)m_nFields; ++i )
- {
- if ( m_statusTextStacks[i] )
- {
- wxListString& t = *m_statusTextStacks[i];
- WX_CLEAR_LIST(wxListString, t);
- delete m_statusTextStacks[i];
- }
- }
+ return m_panes[number].GetText();
+}
+
+void wxStatusBarBase::SetEllipsizedFlag(int number, bool isEllipsized)
+{
+ wxCHECK_RET( (unsigned)number < m_panes.size(),
+ "invalid status bar field index" );
- delete[] m_statusTextStacks;
+ m_panes[number].SetIsEllipsized(isEllipsized);
}
// ----------------------------------------------------------------------------
-// text stacks
+// pushing/popping status text
// ----------------------------------------------------------------------------
void wxStatusBarBase::PushStatusText(const wxString& text, int number)
{
- wxListString* st = GetOrCreateStatusStack(number);
- // This long-winded way around avoids an internal compiler error
- // in VC++ 6 with RTTI enabled
- wxString tmp1(GetStatusText(number));
- wxString* tmp = new wxString(tmp1);
- st->Insert(tmp);
- SetStatusText(text, number);
-}
+ wxCHECK_RET( (unsigned)number < m_panes.size(),
+ "invalid status bar field index" );
-void wxStatusBarBase::PopStatusText(int number)
-{
- wxListString *st = GetStatusStack(number);
- wxCHECK_RET( st, _T("Unbalanced PushStatusText/PopStatusText") );
- wxListString::compatibility_iterator top = st->GetFirst();
-
- SetStatusText(*top->GetData(), number);
- delete top->GetData();
- st->Erase(top);
- if(st->GetCount() == 0)
- {
- delete st;
- m_statusTextStacks[number] = 0;
- }
+ if ( m_panes[number].PushText(text) )
+ DoUpdateStatusText(number);
}
-wxListString *wxStatusBarBase::GetStatusStack(int i) const
-{
- if(!m_statusTextStacks)
- return 0;
- return m_statusTextStacks[i];
-}
-
-wxListString *wxStatusBarBase::GetOrCreateStatusStack(int i)
+void wxStatusBarBase::PopStatusText(int number)
{
- if(!m_statusTextStacks)
- {
- m_statusTextStacks = new wxListString*[m_nFields];
+ wxCHECK_RET( (unsigned)number < m_panes.size(),
+ "invalid status bar field index" );
- size_t j;
- for(j = 0; j < (size_t)m_nFields; ++j) m_statusTextStacks[j] = 0;
- }
-
- if(!m_statusTextStacks[i])
- {
- m_statusTextStacks[i] = new wxListString();
- }
-
- return m_statusTextStacks[i];
+ if ( m_panes[number].PopText() )
+ DoUpdateStatusText(number);
}
#endif // wxUSE_STATUSBAR
-