src/common/statbar.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/common/statbar.cpp
   3 // Purpose:     wxStatusBarBase implementation
   4 // Author:      Vadim Zeitlin
   5 // Modified by: Francesco Montorsi
   6 // Created:     14.10.01
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // License:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 // For compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24     #pragma hdrstop
  25 #endif
  26
  27 #if wxUSE_STATUSBAR
  28
  29 #include "wx/statusbr.h"
  30
  31 #ifndef WX_PRECOMP
  32     #include "wx/frame.h"
  33 #endif //WX_PRECOMP
  34
  35 const char wxStatusBarNameStr[] = "statusBar";
  36
  37
  38 // ============================================================================
  39 // wxStatusBarBase implementation
  40 // ============================================================================
  41
  42 IMPLEMENT_DYNAMIC_CLASS(wxStatusBar, wxWindow)
  43
  44 #include <wx/arrimpl.cpp> // This is a magic incantation which must be done!
  45 WX_DEFINE_OBJARRAY(wxStatusBarPaneArray);
  46
  47
  48 // ----------------------------------------------------------------------------
  49 // ctor/dtor
  50 // ----------------------------------------------------------------------------
  51
  52 wxStatusBarBase::wxStatusBarBase()
  53 {
  54     m_bSameWidthForAllPanes = true;
  55 }
  56
  57 wxStatusBarBase::~wxStatusBarBase()
  58 {
  59     // notify the frame that it doesn't have a status bar any longer to avoid
  60     // dangling pointers
  61     wxFrame *frame = dynamic_cast<wxFrame*>(GetParent());
  62     if ( frame && frame->GetStatusBar() == this )
  63         frame->SetStatusBar(NULL);
  64 }
  65
  66 // ----------------------------------------------------------------------------
  67 // field widths
  68 // ----------------------------------------------------------------------------
  69
  70 void wxStatusBarBase::SetFieldsCount(int number, const int *widths)
  71 {
  72     wxCHECK_RET( number > 0, _T("invalid field number in SetFieldsCount") );
  73
  74     bool refresh = false;
  75
  76     if ( (size_t)number > m_panes.GetCount() )
  77     {
  78         wxStatusBarPane newPane;
  79
  80         // add more entries with the default style and zero width
  81         // (this will be set later)
  82         for (size_t i = m_panes.GetCount(); i < (size_t)number; ++i)
  83             m_panes.Add(newPane);
  84     }
  85     else if ( (size_t)number < m_panes.GetCount() )
  86     {
  87         // remove entries in excess
  88         m_panes.RemoveAt(number, m_panes.GetCount()-number);
  89     }
  90
  91     refresh = true;
  92
  93     if ( widths )
  94     {
  95         SetStatusWidths(number, widths);
  96
  97         // already done from SetStatusWidths()
  98         refresh = false;
  99     }
 100
 101     if ( refresh )
 102         Refresh();
 103 }
 104
 105 void wxStatusBarBase::SetStatusWidths(int WXUNUSED_UNLESS_DEBUG(n),
 106                                       const int widths[])
 107 {
 108     wxCHECK_RET( widths, _T("NULL pointer in SetStatusWidths") );
 109
 110     wxASSERT_MSG( (size_t)n == m_panes.GetCount(), _T("field number mismatch") );
 111
 112     for ( size_t i = 0; i < m_panes.GetCount(); i++ )
 113         m_panes[i].nWidth = widths[i];
 114
 115     m_bSameWidthForAllPanes = false;
 116
 117     // update the display after the widths changed
 118     Refresh();
 119 }
 120
 121 void wxStatusBarBase::SetStatusStyles(int WXUNUSED_UNLESS_DEBUG(n),
 122                                       const int styles[])
 123 {
 124     wxCHECK_RET( styles, _T("NULL pointer in SetStatusStyles") );
 125
 126     wxASSERT_MSG( (size_t)n == m_panes.GetCount(), _T("field number mismatch") );
 127
 128     for ( size_t i = 0; i < m_panes.GetCount(); i++ )
 129         m_panes[i].nStyle = styles[i];
 130
 131     // update the display after the widths changed
 132     Refresh();
 133 }
 134
 135 wxArrayInt wxStatusBarBase::CalculateAbsWidths(wxCoord widthTotal) const
 136 {
 137     wxArrayInt widths;
 138
 139     if ( m_bSameWidthForAllPanes )
 140     {
 141         // Default: all fields have the same width. This is not always
 142         // possible to do exactly (if widthTotal is not divisible by
 143         // m_panes.GetCount()) - if that happens, we distribute the extra
 144         // pixels among all fields:
 145         int widthToUse = widthTotal;
 146
 147         for ( size_t i = m_panes.GetCount(); i > 0; i-- )
 148         {
 149             // divide the unassigned width evently between the
 150             // not yet processed fields:
 151             int w = widthToUse / i;
 152             widths.Add(w);
 153             widthToUse -= w;
 154         }
 155     }
 156     else // do not override explicit pane widths
 157     {
 158         // calculate the total width of all the fixed width fields and the
 159         // total number of var field widths counting with multiplicity
 160         size_t nTotalWidth = 0,
 161                nVarCount = 0,
 162                i;
 163
 164         for ( i = 0; i < m_panes.GetCount(); i++ )
 165         {
 166             if ( m_panes[i].nWidth >= 0 )
 167                 nTotalWidth += m_panes[i].nWidth;
 168             else
 169                 nVarCount += -m_panes[i].nWidth;
 170         }
 171
 172         // the amount of extra width we have per each var width field
 173         int widthExtra = widthTotal - nTotalWidth;
 174
 175         // do fill the array
 176         for ( i = 0; i < m_panes.GetCount(); i++ )
 177         {
 178             if ( m_panes[i].nWidth >= 0 )
 179                 widths.Add(m_panes[i].nWidth);
 180             else
 181             {
 182                 int nVarWidth = widthExtra > 0 ? (widthExtra * (-m_panes[i].nWidth)) / nVarCount : 0;
 183                 nVarCount += m_panes[i].nWidth;
 184                 widthExtra -= nVarWidth;
 185                 widths.Add(nVarWidth);
 186             }
 187         }
 188     }
 189
 190     return widths;
 191 }
 192
 193 // ----------------------------------------------------------------------------
 194 // status text stacks
 195 // ----------------------------------------------------------------------------
 196
 197 void wxStatusBarBase::PushStatusText(const wxString& text, int number)
 198 {
 199     // save current status text in the stack
 200     m_panes[number].arrStack.push_back(GetStatusText(number));
 201
 202     // update current status text
 203     SetStatusText(text, number);
 204 }
 205
 206 void wxStatusBarBase::PopStatusText(int number)
 207 {
 208     wxString text = m_panes[number].arrStack.back();
 209     m_panes[number].arrStack.pop_back();  // also remove it from the stack
 210
 211     // restore the popped status text in the pane
 212     SetStatusText(text, number);
 213 }
 214
 215 #endif // wxUSE_STATUSBAR