]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/statusbr.h
abstract VC6 workaround inside a WX_CPPUNIT_ALLOW_EQUALS_TO_INT() macro
[wxWidgets.git] / include / wx / statusbr.h
index 510309de159f3cb6cc4f0f73edfff24d0296c883..a5593c27cf92a79a7a26d0df3c2b322a7a3dc0f0 100644 (file)
 // 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_
 
+#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
+// ----------------------------------------------------------------------------
+
+// style flags for fields
+#define wxSB_NORMAL    0x0000
+#define wxSB_FLAT      0x0001
+#define wxSB_RAISED    0x0002
+
+// ----------------------------------------------------------------------------
+// wxStatusBarPane: an helper for wxStatusBar
+// ----------------------------------------------------------------------------
+
+class wxStatusBarPane
+{
+public:
+    wxStatusBarPane(int style = wxSB_NORMAL, size_t width = 0)
+        : nStyle(style), nWidth(width) {}
+
+    int nStyle;
+    int 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 not include the string currently displayed in this pane
+    // as it's stored in the native status bar control
+    wxArrayString arrStack;
+};
+
+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() { m_statusWidths = NULL; }
+    wxStatusBarBase();
+
+    virtual ~wxStatusBarBase();
+
+    // field count
+    // -----------
 
-    // get/set the number of fields
-    virtual void SetFieldsCount(int number = 1,
-                                const int *widths = (const int *) NULL) = 0;
-    int GetFieldsCount() const { return m_nFields; }
+    // 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_panes.GetCount(); }
+
+    // field text
+    // ----------
 
-    // get/set the text of the given field
     virtual void SetStatusText(const wxString& text, int number = 0) = 0;
     virtual wxString GetStatusText(int number = 0) const = 0;
 
-    // set status line widths (n should be the same as field count)
-    virtual void SetStatusWidths(int n, const int widths[]) = 0;
+    void PushStatusText(const wxString& text, int number = 0);
+    void PopStatusText(int number = 0);
+
+    // fields widths
+    // -------------
+
+    // set status field widths as absolute numbers: positive widths mean that
+    // the field has the specified absolute width, negative widths are
+    // interpreted as the sizer options, i.e. the extra space (total space
+    // minus the sum of fixed width fields) is divided between the fields with
+    // 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[]);
+
+    // 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[]);
+
+    // geometry
+    // --------
 
     // Get the position and size of the field's internal bounding rectangle
     virtual bool GetFieldRect(int i, wxRect& rect) const = 0;
@@ -45,48 +113,48 @@ public:
     virtual int GetBorderX() const = 0;
     virtual int GetBorderY() const = 0;
 
+    // don't want status bars to accept the focus at all
+    virtual bool AcceptsFocus() const { return false; }
+
+    virtual bool CanBeOutsideClientArea() const { return true; }
+
 protected:
-    int     m_nFields;      // the current number of fields
-    int    *m_statusWidths; // the width (if !NULL) of the fields
+    virtual wxBorder GetDefaultBorder() const { return wxBORDER_NONE; }
+
+    // calculate the real field widths for the given total available size
+    wxArrayInt CalculateAbsWidths(wxCoord widthTotal) const;
+
+    // the array with the pane infos:
+    wxStatusBarPaneArray m_panes;
+
+    // if true overrides the width info of the wxStatusBarPanes
+    bool m_bSameWidthForAllPanes;
+
+    DECLARE_NO_COPY_CLASS(wxStatusBarBase)
 };
 
-#if defined(__WIN32__) && wxUSE_NATIVE_STATUSBAR
-    #include "wx/msw/statbr95.h"
+// ----------------------------------------------------------------------------
+// include the actual wxStatusBar class declaration
+// ----------------------------------------------------------------------------
 
-    typedef wxStatusBar95 wxStatusBarReal;
+#if defined(__WXUNIVERSAL__)
+    #define wxStatusBarUniv wxStatusBar
+    #include "wx/univ/statusbr.h"
+#elif defined(__WXPALMOS__)
+    #define wxStatusBarPalm wxStatusBar
+    #include "wx/palmos/statusbr.h"
+#elif defined(__WIN32__) && wxUSE_NATIVE_STATUSBAR
+    #include "wx/msw/statusbar.h"
+#elif defined(__WXMAC__)
+    #define wxStatusBarMac wxStatusBar
+    #include "wx/generic/statusbr.h"
+    #include "wx/osx/statusbr.h"
 #else
+    #define wxStatusBarGeneric wxStatusBar
     #include "wx/generic/statusbr.h"
-
-    typedef wxStatusBarGeneric wxStatusBarReal;
 #endif
 
-// we can't just typedef wxStatusBar to be one of 95/Generic because we should
-// be able to forward declare it (done in several places) and because wxWin
-// RTTI wouldn't work then
-class WXDLLEXPORT wxStatusBar : public wxStatusBarReal
-{
-public:
-    wxStatusBar() { }
-    wxStatusBar(wxWindow *parent,
-                wxWindowID id,
-                const wxPoint& WXUNUSED(pos) = wxDefaultPosition,
-                const wxSize& WXUNUSED(size) = wxDefaultSize,
-                long style = wxST_SIZEGRIP,
-                const wxString& name = wxPanelNameStr)
-    {
-        Create(parent, id, style, name);
-    }
-    wxStatusBar(wxWindow *parent,
-                wxWindowID id,
-                long style,
-                const wxString& name = wxPanelNameStr)
-    {
-        Create(parent, id, style, name);
-    }
-
-private:
-    DECLARE_DYNAMIC_CLASS(wxStatusBar)
-};
+#endif // wxUSE_STATUSBAR
 
 #endif
     // _WX_STATUSBR_H_BASE_