1wxStatusBar(3)             Erlang Module Definition             wxStatusBar(3)
2
3
4

NAME

6       wxStatusBar - Functions for wxStatusBar class
7

DESCRIPTION

9       A  status bar is a narrow window that can be placed along the bottom of
10       a frame to give small amounts of status information. It can contain one
11       or  more  fields, one or more of which can be variable length according
12       to the size of the window.
13
14       wxStatusBar also maintains an independent stack  of  status  texts  for
15       each field (see pushStatusText/3 and popStatusText/2).
16
17       Note  that  in  wxStatusBar  context, the terms pane and field are syn‐
18       onyms.
19
20       Styles
21
22       This class supports the following styles:
23
24       Remark: It is possible to create controls and other windows on the sta‐
25       tus bar. Position these windows from an OnSize() event handler.
26
27       Remark:  Notice  that only the first 127 characters of a string will be
28       shown in status bar fields under Windows if a proper manifest  indicat‐
29       ing  that  the program uses version 6 of common controls library is not
30       used. This is a limitation of the native control on these platforms.
31
32       See: wxStatusBarPane (not implemented in wx), wxFrame, Examples
33
34       This class is derived  (and  can  use  functions)  from:  wxWindow  wx‐
35       EvtHandler
36
37       wxWidgets docs: wxStatusBar
38

DATA TYPES

40       wxStatusBar() = wx:wx_object()
41

EXPORTS

43       new() -> wxStatusBar()
44
45              Default ctor.
46
47       new(Parent) -> wxStatusBar()
48
49              Types:
50
51                 Parent = wxWindow:wxWindow()
52
53       new(Parent, Options :: [Option]) -> wxStatusBar()
54
55              Types:
56
57                 Parent = wxWindow:wxWindow()
58                 Option = {winid, integer()} | {style, integer()}
59
60              Constructor, creating the window.
61
62              See: create/3
63
64       destroy(This :: wxStatusBar()) -> ok
65
66              Destructor.
67
68       create(This, Parent) -> boolean()
69
70              Types:
71
72                 This = wxStatusBar()
73                 Parent = wxWindow:wxWindow()
74
75       create(This, Parent, Options :: [Option]) -> boolean()
76
77              Types:
78
79                 This = wxStatusBar()
80                 Parent = wxWindow:wxWindow()
81                 Option = {winid, integer()} | {style, integer()}
82
83              Creates the window, for two-step construction.
84
85              See new/2 for details.
86
87       getFieldRect(This, I) -> Result
88
89              Types:
90
91                 Result =
92                     {Res :: boolean(),
93                      Rect ::
94                          {X :: integer(),
95                           Y :: integer(),
96                           W :: integer(),
97                           H :: integer()}}
98                 This = wxStatusBar()
99                 I = integer()
100
101              Returns  the  size  and  position of a field's internal bounding
102              rectangle.
103
104              Return: true if the field index is valid, false otherwise.
105
106              See: {X,Y,W,H}
107
108       getFieldsCount(This) -> integer()
109
110              Types:
111
112                 This = wxStatusBar()
113
114              Returns the number of fields in the status bar.
115
116       getStatusText(This) -> unicode:charlist()
117
118              Types:
119
120                 This = wxStatusBar()
121
122       getStatusText(This, Options :: [Option]) -> unicode:charlist()
123
124              Types:
125
126                 This = wxStatusBar()
127                 Option = {number, integer()}
128
129              Returns the string associated with a status bar field.
130
131              Return: The status field string if the field is valid, otherwise
132              the empty string.
133
134              See: setStatusText/3
135
136       popStatusText(This) -> ok
137
138              Types:
139
140                 This = wxStatusBar()
141
142       popStatusText(This, Options :: [Option]) -> ok
143
144              Types:
145
146                 This = wxStatusBar()
147                 Option = {number, integer()}
148
149              Restores  the  text  to the value it had before the last call to
150              pushStatusText/3.
151
152              Notice that if setStatusText/3 had been called in the meanwhile,
153              popStatusText/2 will not change the text, i.e. it does not over‐
154              ride explicit changes to status text but only restores the saved
155              text if it hadn't been changed since.
156
157              See: pushStatusText/3
158
159       pushStatusText(This, String) -> ok
160
161              Types:
162
163                 This = wxStatusBar()
164                 String = unicode:chardata()
165
166       pushStatusText(This, String, Options :: [Option]) -> ok
167
168              Types:
169
170                 This = wxStatusBar()
171                 String = unicode:chardata()
172                 Option = {number, integer()}
173
174              Saves  the current field text in a per-field stack, and sets the
175              field text to the string passed as argument.
176
177              See: popStatusText/2
178
179       setFieldsCount(This, Number) -> ok
180
181              Types:
182
183                 This = wxStatusBar()
184                 Number = integer()
185
186       setFieldsCount(This, Number, Options :: [Option]) -> ok
187
188              Types:
189
190                 This = wxStatusBar()
191                 Number = integer()
192                 Option = {widths, [integer()]}
193
194              Sets the number of fields, and optionally the field widths.
195
196       setMinHeight(This, Height) -> ok
197
198              Types:
199
200                 This = wxStatusBar()
201                 Height = integer()
202
203              Sets the minimal possible height for the status bar.
204
205              The real height may be bigger than the height specified here de‐
206              pending on the size of the font used by the status bar.
207
208       setStatusText(This, Text) -> ok
209
210              Types:
211
212                 This = wxStatusBar()
213                 Text = unicode:chardata()
214
215       setStatusText(This, Text, Options :: [Option]) -> ok
216
217              Types:
218
219                 This = wxStatusBar()
220                 Text = unicode:chardata()
221                 Option = {number, integer()}
222
223              Sets the status text for the i-th field.
224
225              The given text will replace the current text. The display of the
226              status bar is updated immediately, so there is no need  to  call
227              wxWindow:update/1 after calling this function.
228
229              Note  that  if  pushStatusText/3  had been called before the new
230              text will also replace the last saved value to  make  sure  that
231              the  next call to popStatusText/2 doesn't restore the old value,
232              which was overwritten by the call to this function.
233
234              See: getStatusText/2, wxFrame:setStatusText/3
235
236       setStatusWidths(This, Widths_field) -> ok
237
238              Types:
239
240                 This = wxStatusBar()
241                 Widths_field = [integer()]
242
243              Sets the widths of the fields in the status line.
244
245              There are two types of fields: fixed widths and  variable  width
246              fields.  For  the  fixed  width  fields you should specify their
247              (constant) width in pixels. For the variable width fields, spec‐
248              ify  a  negative number which indicates how the field should ex‐
249              pand: the space left for all variable width  fields  is  divided
250              between  them  according to the absolute value of this number. A
251              variable width field with width of -2 gets twice as much  of  it
252              as a field with width -1 and so on.
253
254              For example, to create one fixed width field of width 100 in the
255              right part of the status bar and two more fields which  get  66%
256              and  33%  of the remaining space correspondingly, you should use
257              an array containing -2, -1 and 100.
258
259              Remark: The widths of the variable fields  are  calculated  from
260              the  total  width  of all fields, minus the sum of widths of the
261              non-variable fields, divided by the number of variable fields.
262
263              See: setFieldsCount/3, wxFrame:setStatusWidths/2
264
265       setStatusStyles(This, Styles) -> ok
266
267              Types:
268
269                 This = wxStatusBar()
270                 Styles = [integer()]
271
272              Sets the styles of the fields in the status line which can  make
273              fields  appear  flat or raised instead of the standard sunken 3D
274              border.
275
276
277
278wxWidgets team.                    wx 2.1.4                     wxStatusBar(3)