added template wxScopedArray<> too

[wxWidgets.git] / include / wx / statusbr.h

diff --git a/include/wx/statusbr.h b/include/wx/statusbr.h
index 1775a2594a7f8f86ef52c26ce3b2eebf74df6c88..a5593c27cf92a79a7a26d0df3c2b322a7a3dc0f0 100644 (file)
--- a/include/wx/statusbr.h
+++ b/include/wx/statusbr.h
@@ -1,7 +1,160 @@
-#ifndef __STATUSBRH_BASE__
-#define __STATUSBRH_BASE__
+/////////////////////////////////////////////////////////////////////////////
+// Name:        wx/statusbr.h
+// Purpose:     wxStatusBar class interface
+// Author:      Vadim Zeitlin
+// Modified by:
+// Created:     05.02.00
+// RCS-ID:      $Id$
+// Copyright:   (c) Vadim Zeitlin
+// Licence:     wxWindows licence
+/////////////////////////////////////////////////////////////////////////////
 
-#include "wx/generic/statusbr.h"
+#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 WXDLLIMPEXP_CORE wxStatusBarBase : public wxWindow
+{
+public:
+    wxStatusBarBase();
+
+    virtual ~wxStatusBarBase();
+
+    // field count
+    // -----------
+
+    // 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
+    // ----------
+
+    virtual void SetStatusText(const wxString& text, int number = 0) = 0;
+    virtual wxString GetStatusText(int number = 0) const = 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;
+
+    // sets the minimal vertical size of the status bar
+    virtual void SetMinHeight(int height) = 0;
+
+    // get the dimensions of the horizontal and vertical borders
+    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:
+    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)
+};
+
+// ----------------------------------------------------------------------------
+// include the actual wxStatusBar class declaration
+// ----------------------------------------------------------------------------
+
+#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"
+#endif
+
+#endif // wxUSE_STATUSBAR
 
 #endif
-    // __STATUSBRH_BASE__
+    // _WX_STATUSBR_H_BASE_