X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/1f361cddbfcff9c54eef6b8c447d2b93ee2825f5..31cc5049d386913adeba034e499e3c181ad54a50:/include/wx/statusbr.h diff --git a/include/wx/statusbr.h b/include/wx/statusbr.h index 103e8479f7..0b286fc7f7 100644 --- a/include/wx/statusbr.h +++ b/include/wx/statusbr.h @@ -5,30 +5,98 @@ // Modified by: // Created: 05.02.00 // RCS-ID: $Id$ -// Copyright: (c) wxWindows team -// Licence: wxWindows license +// Copyright: (c) Vadim Zeitlin +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifndef _WX_STATUSBR_H_BASE_ #define _WX_STATUSBR_H_BASE_ -#ifdef __GNUG__ - #pragma interface "statbar.h" -#endif - -#include "wx/window.h" +#include "wx/defs.h" #if wxUSE_STATUSBAR +#include "wx/window.h" #include "wx/list.h" +#include "wx/dynarray.h" + +extern WXDLLIMPEXP_DATA_CORE(const char) wxStatusBarNameStr[]; + +// ---------------------------------------------------------------------------- +// wxStatusBar constants +// ---------------------------------------------------------------------------- + +// wxStatusBar styles +#define wxSTB_SIZEGRIP 0x0010 +#define wxSTB_SHOW_TIPS 0x0020 + +#define wxSTB_ELLIPSIZE_START 0x0040 +#define wxSTB_ELLIPSIZE_MIDDLE 0x0080 +#define wxSTB_ELLIPSIZE_END 0x0100 + +#define wxSTB_DEFAULT_STYLE (wxSTB_SIZEGRIP|wxSTB_ELLIPSIZE_END|wxSTB_SHOW_TIPS|wxFULL_REPAINT_ON_RESIZE) + + +// old compat style name: +#define wxST_SIZEGRIP wxSTB_SIZEGRIP + + +// style flags for wxStatusBar fields +#define wxSB_NORMAL 0x0000 +#define wxSB_FLAT 0x0001 +#define wxSB_RAISED 0x0002 + +// ---------------------------------------------------------------------------- +// wxStatusBarPane: an helper for wxStatusBar +// ---------------------------------------------------------------------------- -WX_DECLARE_LIST(wxString, wxListString); +class WXDLLIMPEXP_CORE wxStatusBarPane +{ + // only wxStatusBarBase can access our internal members and modify them: + friend class WXDLLIMPEXP_FWD_CORE wxStatusBarBase; + +public: + wxStatusBarPane(int style = wxSB_NORMAL, size_t width = 0) + : m_nStyle(style), m_nWidth(width) + { m_arrStack.Add(wxEmptyString); m_bEllipsized=false; } + + int GetWidth() const + { return m_nWidth; } + int GetStyle() const + { return m_nStyle; } + + const wxArrayString& GetStack() const + { return m_arrStack; } + + // implementation-only getter: + bool IsEllipsized() const + { return m_bEllipsized; } + + // NOTE: there are no setters in wxStatusBarPane; + // use wxStatusBar functions to modify a wxStatusBarPane + +protected: + int m_nStyle; + int m_nWidth; // the width maybe negative, indicating a variable-width field + + // this is the array of the stacked strings of this pane; note that this + // stack does include also the string currently displayed in this pane + // as the version stored in the native status bar control is possibly + // ellipsized; note that m_arrStack.Last() is the top of the stack + // (i.e. the string shown in the status bar) + wxArrayString m_arrStack; + + // was the m_arrStack.Last() string shown in the status bar control ellipsized? + bool m_bEllipsized; +}; + +WX_DECLARE_OBJARRAY(wxStatusBarPane, wxStatusBarPaneArray); // ---------------------------------------------------------------------------- // wxStatusBar: a window near the bottom of the frame used for status info // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxStatusBarBase : public wxWindow +class WXDLLIMPEXP_CORE wxStatusBarBase : public wxWindow { public: wxStatusBarBase(); @@ -41,13 +109,19 @@ public: // set the number of fields and call SetStatusWidths(widths) if widths are // given virtual void SetFieldsCount(int number = 1, const int *widths = NULL); - int GetFieldsCount() const { return m_nFields; } + int GetFieldsCount() const { return m_panes.GetCount(); } // field text // ---------- - virtual void SetStatusText(const wxString& text, int number = 0) = 0; - virtual wxString GetStatusText(int number = 0) const = 0; + // NOTE: even if it is not pure virtual, SetStatusText() must be overloaded by + // the derived classes to update the given text in the native control + virtual void SetStatusText(const wxString& text, int number = 0) + { m_panes[number].GetStack().Last() = text; } + virtual wxString GetStatusText(int number = 0) const + { return m_panes[number].GetStack().Last(); } + const wxArrayString& GetStatusStack(int n) const + { return m_panes[n].GetStack(); } void PushStatusText(const wxString& text, int number = 0); void PopStatusText(int number = 0); @@ -62,6 +136,21 @@ public: // negative width according to the abs value of the width (field with width // -2 grows twice as much as one with width -1 &c) virtual void SetStatusWidths(int n, const int widths[]); + + int GetStatusWidth(int n) const + { return m_panes[n].GetWidth(); } + + // field styles + // ------------ + + // Set the field style. Use either wxSB_NORMAL (default) for a standard 3D + // border around a field, wxSB_FLAT for no border around a field, so that it + // appears flat or wxSB_POPOUT to make the field appear raised. + // Setting field styles only works on wxMSW + virtual void SetStatusStyles(int n, const int styles[]); + + int GetStatusStyle(int n) const + { return m_panes[n].GetStyle(); } // geometry // -------- @@ -75,42 +164,57 @@ public: // get the dimensions of the horizontal and vertical borders virtual int GetBorderX() const = 0; virtual int GetBorderY() const = 0; + + wxSize GetBorders() const + { return wxSize(GetBorderX(), GetBorderY()); } + // miscellaneous + // ------------- + + const wxStatusBarPane& GetField(int n) const + { return m_panes[n]; } + + // wxWindow overrides: + // don't want status bars to accept the focus at all - virtual bool AcceptsFocus() const { return FALSE; } + virtual bool AcceptsFocus() const { return false; } + + // the client size of a toplevel window doesn't include the status bar + virtual bool CanBeOutsideClientArea() const { return true; } protected: - // set the widths array to NULL - void InitWidths(); - // free the status widths arrays - void FreeWidths(); + // wxWindow overrides: + +#if wxUSE_TOOLTIPS + virtual void DoSetToolTip( wxToolTip *tip ) + { + wxASSERT_MSG(!HasFlag(wxSTB_SHOW_TIPS), + "Do not set tooltip(s) manually when using wxSTB_SHOW_TIPS!"); + wxWindow::DoSetToolTip(tip); + } +#endif + + virtual wxBorder GetDefaultBorder() const { return wxBORDER_NONE; } - // reset the widths - void ReinitWidths() { FreeWidths(); InitWidths(); } - // same, for text stacks - void InitStacks(); - void FreeStacks(); - void ReinitStacks() { FreeStacks(); InitStacks(); } + // internal helpers & data: // calculate the real field widths for the given total available size wxArrayInt CalculateAbsWidths(wxCoord widthTotal) const; + + // an internal utility used to keep track of which panes have labels + // which were last rendered as ellipsized... + void SetEllipsizedFlag(int n, bool ellipsized) + { m_panes[n].m_bEllipsized = ellipsized; } - // use these functions to access the stacks of field strings - wxListString *GetStatusStack(int i) const; - wxListString *GetOrCreateStatusStack(int i); - - // the current number of fields - int m_nFields; + // the array with the pane infos: + wxStatusBarPaneArray m_panes; - // the widths of the fields in pixels if !NULL, all fields have the same - // width otherwise - int *m_statusWidths; + // if true overrides the width info of the wxStatusBarPanes + bool m_bSameWidthForAllPanes; - // stacks of previous values for PushStatusText/PopStatusText - // this is created on demand, use GetStatusStack/GetOrCreateStatusStack - wxListString **m_statusTextStacks; + wxDECLARE_NO_COPY_CLASS(wxStatusBarBase); }; // ---------------------------------------------------------------------------- @@ -119,24 +223,18 @@ protected: #if defined(__WXUNIVERSAL__) #define wxStatusBarUniv wxStatusBar - #define sm_classwxStatusBarUniv sm_classwxStatusBar - #include "wx/univ/statusbr.h" +#elif defined(__WXPALMOS__) + #define wxStatusBarPalm wxStatusBar + #include "wx/palmos/statusbr.h" #elif defined(__WIN32__) && wxUSE_NATIVE_STATUSBAR - #define wxStatusBar95 wxStatusBar - #define sm_classwxStatusBar95 sm_classwxStatusBar - - #include "wx/msw/statbr95.h" + #include "wx/msw/statusbar.h" #elif defined(__WXMAC__) #define wxStatusBarMac wxStatusBar - #define sm_classwxStatusBarMac sm_classwxStatusBar - #include "wx/generic/statusbr.h" - #include "wx/mac/statusbr.h" + #include "wx/osx/statusbr.h" #else #define wxStatusBarGeneric wxStatusBar - #define sm_classwxStatusBarGeneric sm_classwxStatusBar - #include "wx/generic/statusbr.h" #endif