]> git.saurik.com Git - wxWidgets.git/blame - include/wx/statusbr.h
fixing warning and compile error against 10.4
[wxWidgets.git] / include / wx / statusbr.h
CommitLineData
ed791986
VZ
1/////////////////////////////////////////////////////////////////////////////
2// Name: wx/statusbr.h
3// Purpose: wxStatusBar class interface
4// Author: Vadim Zeitlin
5// Modified by:
6// Created: 05.02.00
7// RCS-ID: $Id$
99d80019 8// Copyright: (c) Vadim Zeitlin
65571936 9// Licence: wxWindows licence
ed791986
VZ
10/////////////////////////////////////////////////////////////////////////////
11
34138703
JS
12#ifndef _WX_STATUSBR_H_BASE_
13#define _WX_STATUSBR_H_BASE_
c801d85f 14
3304646d 15#include "wx/defs.h"
ed791986 16
1e6feb95
VZ
17#if wxUSE_STATUSBAR
18
f771bae3 19#include "wx/control.h"
1f361cdd 20#include "wx/list.h"
ed39ff57 21#include "wx/dynarray.h"
1f361cdd 22
23318a53 23extern WXDLLIMPEXP_DATA_CORE(const char) wxStatusBarNameStr[];
53b6d7a2 24
c2919ab3
VZ
25// ----------------------------------------------------------------------------
26// wxStatusBar constants
27// ----------------------------------------------------------------------------
28
c94bdf2a 29// wxStatusBar styles
c4c178c1
FM
30#define wxSTB_SIZEGRIP 0x0010
31#define wxSTB_SHOW_TIPS 0x0020
c94bdf2a 32
c4c178c1
FM
33#define wxSTB_ELLIPSIZE_START 0x0040
34#define wxSTB_ELLIPSIZE_MIDDLE 0x0080
35#define wxSTB_ELLIPSIZE_END 0x0100
c94bdf2a 36
c4c178c1
FM
37#define wxSTB_DEFAULT_STYLE (wxSTB_SIZEGRIP|wxSTB_ELLIPSIZE_END|wxSTB_SHOW_TIPS|wxFULL_REPAINT_ON_RESIZE)
38
39
40// old compat style name:
41#define wxST_SIZEGRIP wxSTB_SIZEGRIP
42
43
44// style flags for wxStatusBar fields
c2919ab3
VZ
45#define wxSB_NORMAL 0x0000
46#define wxSB_FLAT 0x0001
47#define wxSB_RAISED 0x0002
48
7b6fefbe
FM
49// ----------------------------------------------------------------------------
50// wxStatusBarPane: an helper for wxStatusBar
51// ----------------------------------------------------------------------------
52
7235c54d 53class WXDLLIMPEXP_CORE wxStatusBarPane
7b6fefbe
FM
54{
55public:
56 wxStatusBarPane(int style = wxSB_NORMAL, size_t width = 0)
41d6e8b6 57 : m_nStyle(style), m_nWidth(width)
6cf68971
VZ
58 { m_bEllipsized = false; }
59
60 int GetWidth() const { return m_nWidth; }
61 int GetStyle() const { return m_nStyle; }
62 wxString GetText() const { return m_text; }
41d6e8b6 63
41d6e8b6 64
6cf68971
VZ
65 // implementation-only from now on
66 // -------------------------------
b31eaa5c 67
c94bdf2a
FM
68 bool IsEllipsized() const
69 { return m_bEllipsized; }
6cf68971 70 void SetIsEllipsized(bool isEllipsized) { m_bEllipsized = isEllipsized; }
c94bdf2a 71
6cf68971
VZ
72 void SetWidth(int width) { m_nWidth = width; }
73 void SetStyle(int style) { m_nStyle = style; }
7b6fefbe 74
6cf68971
VZ
75 // set text, return true if it changed or false if it was already set to
76 // this value
77 bool SetText(const wxString& text);
78
79 // save the existing text on top of our stack and make the new text
80 // current; return true if the text really changed
81 bool PushText(const wxString& text);
82
83 // restore the message saved by the last call to Push() (unless it was
84 // changed by an intervening call to SetText()) and return true if we
85 // really restored anything
86 bool PopText();
87
88private:
b31eaa5c 89 int m_nStyle;
6cf68971
VZ
90 int m_nWidth; // may be negative, indicating a variable-width field
91 wxString m_text;
7b6fefbe 92
6cf68971
VZ
93 // the array used to keep the previous values of this pane after a
94 // PushStatusText() call, its top element is the value to restore after the
95 // next PopStatusText() call while the currently shown value is always in
96 // m_text
b31eaa5c 97 wxArrayString m_arrStack;
c94bdf2a 98
6cf68971 99 // is the currently shown value shown with ellipsis in the status bar?
c94bdf2a 100 bool m_bEllipsized;
7b6fefbe
FM
101};
102
b2d76621 103WX_DECLARE_EXPORTED_OBJARRAY(wxStatusBarPane, wxStatusBarPaneArray);
7b6fefbe 104
ed791986
VZ
105// ----------------------------------------------------------------------------
106// wxStatusBar: a window near the bottom of the frame used for status info
107// ----------------------------------------------------------------------------
108
f771bae3 109class WXDLLIMPEXP_CORE wxStatusBarBase : public wxControl
ed791986
VZ
110{
111public:
71e03035
VZ
112 wxStatusBarBase();
113
114 virtual ~wxStatusBarBase();
115
116 // field count
117 // -----------
ed791986 118
71e03035
VZ
119 // set the number of fields and call SetStatusWidths(widths) if widths are
120 // given
121 virtual void SetFieldsCount(int number = 1, const int *widths = NULL);
7b6fefbe 122 int GetFieldsCount() const { return m_panes.GetCount(); }
ed791986 123
71e03035
VZ
124 // field text
125 // ----------
126
6cf68971
VZ
127 // just change or get the currently shown text
128 void SetStatusText(const wxString& text, int number = 0);
129 wxString GetStatusText(int number = 0) const;
ed791986 130
6cf68971
VZ
131 // change the currently shown text to the new one and save the current
132 // value to be restored by the next call to PopStatusText()
1f361cdd
MB
133 void PushStatusText(const wxString& text, int number = 0);
134 void PopStatusText(int number = 0);
135
71e03035
VZ
136 // fields widths
137 // -------------
138
139 // set status field widths as absolute numbers: positive widths mean that
140 // the field has the specified absolute width, negative widths are
141 // interpreted as the sizer options, i.e. the extra space (total space
142 // minus the sum of fixed width fields) is divided between the fields with
143 // negative width according to the abs value of the width (field with width
144 // -2 grows twice as much as one with width -1 &c)
145 virtual void SetStatusWidths(int n, const int widths[]);
41d6e8b6 146
b31eaa5c
FM
147 int GetStatusWidth(int n) const
148 { return m_panes[n].GetWidth(); }
71e03035 149
c2919ab3
VZ
150 // field styles
151 // ------------
152
d775fa82
WS
153 // Set the field style. Use either wxSB_NORMAL (default) for a standard 3D
154 // border around a field, wxSB_FLAT for no border around a field, so that it
c2919ab3
VZ
155 // appears flat or wxSB_POPOUT to make the field appear raised.
156 // Setting field styles only works on wxMSW
157 virtual void SetStatusStyles(int n, const int styles[]);
41d6e8b6 158
b31eaa5c
FM
159 int GetStatusStyle(int n) const
160 { return m_panes[n].GetStyle(); }
c2919ab3 161
71e03035
VZ
162 // geometry
163 // --------
ed791986
VZ
164
165 // Get the position and size of the field's internal bounding rectangle
166 virtual bool GetFieldRect(int i, wxRect& rect) const = 0;
167
168 // sets the minimal vertical size of the status bar
169 virtual void SetMinHeight(int height) = 0;
170
171 // get the dimensions of the horizontal and vertical borders
172 virtual int GetBorderX() const = 0;
173 virtual int GetBorderY() const = 0;
41d6e8b6 174
c94bdf2a
FM
175 wxSize GetBorders() const
176 { return wxSize(GetBorderX(), GetBorderY()); }
ed791986 177
b31eaa5c
FM
178 // miscellaneous
179 // -------------
41d6e8b6 180
b31eaa5c
FM
181 const wxStatusBarPane& GetField(int n) const
182 { return m_panes[n]; }
41d6e8b6 183
b31eaa5c 184 // wxWindow overrides:
41d6e8b6 185
1e6feb95 186 // don't want status bars to accept the focus at all
d775fa82 187 virtual bool AcceptsFocus() const { return false; }
1e6feb95 188
b31eaa5c 189 // the client size of a toplevel window doesn't include the status bar
c04c7a3d
VS
190 virtual bool CanBeOutsideClientArea() const { return true; }
191
ed791986 192protected:
6cf68971
VZ
193 // called after the status bar pane text changed and should update its
194 // display
195 virtual void DoUpdateStatusText(int number) = 0;
196
6418ad5e
FM
197
198 // wxWindow overrides:
199
c437b3f4
JJ
200#if wxUSE_TOOLTIPS
201 virtual void DoSetToolTip( wxToolTip *tip )
8f99e9c3 202 {
6418ad5e
FM
203 wxASSERT_MSG(!HasFlag(wxSTB_SHOW_TIPS),
204 "Do not set tooltip(s) manually when using wxSTB_SHOW_TIPS!");
8f99e9c3 205 wxWindow::DoSetToolTip(tip);
6418ad5e 206 }
6cf68971 207#endif // wxUSE_TOOLTIPS
3c75d8ba
PC
208 virtual wxBorder GetDefaultBorder() const { return wxBORDER_NONE; }
209
6418ad5e
FM
210
211 // internal helpers & data:
212
71e03035
VZ
213 // calculate the real field widths for the given total available size
214 wxArrayInt CalculateAbsWidths(wxCoord widthTotal) const;
41d6e8b6 215
6cf68971
VZ
216 // should be called to remember if the pane text is currently being show
217 // ellipsized or not
218 void SetEllipsizedFlag(int n, bool isEllipsized);
219
71e03035 220
7b6fefbe
FM
221 // the array with the pane infos:
222 wxStatusBarPaneArray m_panes;
1f361cdd 223
7b6fefbe
FM
224 // if true overrides the width info of the wxStatusBarPanes
225 bool m_bSameWidthForAllPanes;
22f3361e 226
c0c133e1 227 wxDECLARE_NO_COPY_CLASS(wxStatusBarBase);
ed791986
VZ
228};
229
71e03035
VZ
230// ----------------------------------------------------------------------------
231// include the actual wxStatusBar class declaration
232// ----------------------------------------------------------------------------
233
234#if defined(__WXUNIVERSAL__)
235 #define wxStatusBarUniv wxStatusBar
71e03035 236 #include "wx/univ/statusbr.h"
4055ed82 237#elif defined(__WXPALMOS__)
ffecfa5a 238 #define wxStatusBarPalm wxStatusBar
771be77f 239 #include "wx/palmos/statusbr.h"
71e03035 240#elif defined(__WIN32__) && wxUSE_NATIVE_STATUSBAR
936f6353 241 #include "wx/msw/statusbar.h"
656fc51c 242#elif defined(__WXMAC__)
71e03035 243 #define wxStatusBarMac wxStatusBar
5fde6fcc 244 #include "wx/generic/statusbr.h"
ef0e9220 245 #include "wx/osx/statusbr.h"
ed791986 246#else
71e03035 247 #define wxStatusBarGeneric wxStatusBar
71e03035 248 #include "wx/generic/statusbr.h"
ed791986
VZ
249#endif
250
71e03035 251#endif // wxUSE_STATUSBAR
1e6feb95 252
c801d85f 253#endif
34138703 254 // _WX_STATUSBR_H_BASE_