1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.StaticText:
==========================================================================================================================================
|phoenix_title| **wx.StaticText**
==========================================================================================================================================
A static text control displays one or more lines of read-only text.
:ref:`wx.StaticText` supports the three classic text alignments, label ellipsization i.e. replacing parts of the text with the ellipsis ("...") if the label doesn't fit into the provided space and also formatting markup with :meth:`wx.Control.SetLabelMarkup` .
^^
.. _StaticText-styles:
|styles| Window Styles
================================
This class supports the following styles:
- ``wx.ALIGN_LEFT``: Align the text to the left.
- ``wx.ALIGN_RIGHT``: Align the text to the right.
- ``wx.ALIGN_CENTRE_HORIZONTAL``: Center the text (horizontally).
- ``wx.ST_NO_AUTORESIZE``: By default, the control will adjust its size to exactly fit to the size of the text when :meth:`~wx.StaticText.SetLabel` is called. If this style flag is given, the control will not change its size (this style is especially useful with controls which also have the ``ALIGN_RIGHT`` or the ``ALIGN_CENTRE_HORIZONTAL`` style because otherwise they won't make sense any longer after a call to :meth:`~wx.StaticText.SetLabel`).
- ``wx.ST_ELLIPSIZE_START``: If the labeltext width exceeds the control width, replace the beginning of the label with an ellipsis; uses :meth:`wx.Control.Ellipsize` .
- ``wx.ST_ELLIPSIZE_MIDDLE``: If the label text width exceeds the control width, replace the middle of the label with an ellipsis; uses :meth:`wx.Control.Ellipsize` .
- ``wx.ST_ELLIPSIZE_END``: If the label text width exceeds the control width, replace the end of the label with an ellipsis; uses :meth:`wx.Control.Ellipsize` . ^^
.. seealso:: :ref:`wx.StaticBitmap`, :ref:`wx.StaticBox`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>StaticText</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.StaticText_inheritance.png" alt="Inheritance diagram of StaticText" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.StaticText.html" title="wx.StaticText" alt="" coords="54,315,163,344"/> <area shape="rect" id="node2" href="wx.Control.html" title="wx.Control" alt="" coords="63,237,155,267"/> <area shape="rect" id="node3" href="wx.Window.html" title="wx.Window" alt="" coords="60,160,157,189"/> <area shape="rect" id="node4" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="50,83,167,112"/> <area shape="rect" id="node5" href="wx.Object.html" title="wx.Object" alt="" coords="5,5,92,35"/> <area shape="rect" id="node6" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="117,5,223,35"/> </map>
</p>
</div>
|
|appearance| Control Appearance
===============================
|
.. figure:: _static/images/widgets/fullsize/wxmsw/wx.statictext.png
:alt: wxMSW
:figclass: floatleft
**wxMSW**
.. figure:: _static/images/widgets/fullsize/wxmac/wx.statictext.png
:alt: wxMAC
:figclass: floatright
**wxMAC**
.. figure:: _static/images/widgets/fullsize/wxgtk/wx.statictext.png
:alt: wxGTK
:figclass: floatcenter
**wxGTK**
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.StaticText.__init__` Default constructor.
:meth:`~wx.StaticText.Create` Creation function, for two-step construction.
:meth:`~wx.StaticText.GetClassDefaultAttributes`
:meth:`~wx.StaticText.IsEllipsized` Returns ``True`` if the window styles for this control contains one of the ``ST_ELLIPSIZE_START`` , ``ST_ELLIPSIZE_MIDDLE`` or ``ST_ELLIPSIZE_END`` styles.
:meth:`~wx.StaticText.SetLabel` Change the label shown in the control.
:meth:`~wx.StaticText.Wrap` This functions wraps the controls label so that each of its lines becomes at most `width` pixels wide if possible (the lines are broken at words boundaries so it might not be the case if words are too long).
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.StaticText(Control)
**Possible constructors**::
StaticText()
StaticText(parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition,
size=DefaultSize, style=0, name=StaticTextNameStr)
A static text control displays one or more lines of read-only text.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self)`
Default constructor.
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self, parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, name=StaticTextNameStr)`
Constructor, creating and showing a text control.
:param `parent`: Parent window. Should not be ``None``.
:type `parent`: wx.Window
:param `id`: Control identifier. A value of -1 denotes a default value.
:type `id`: wx.WindowID
:param `label`: Text label.
:type `label`: string
:param `pos`: Window position.
:type `pos`: wx.Point
:param `size`: Window size.
:type `size`: wx.Size
:param `style`: Window style. See :ref:`wx.StaticText`.
:type `style`: long
:param `name`: Window name.
:type `name`: string
.. seealso:: :meth:`Create`
:html:`<hr class="overloadsep" /><br />`
.. method:: Create(self, parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, name=StaticTextNameStr)
Creation function, for two-step construction.
For details see :ref:`wx.StaticText`.
:param `parent`:
:type `parent`: wx.Window
:param `id`:
:type `id`: wx.WindowID
:param `label`:
:type `label`: string
:param `pos`:
:type `pos`: wx.Point
:param `size`:
:type `size`: wx.Size
:param `style`:
:type `style`: long
:param `name`:
:type `name`: string
:rtype: `bool`
.. staticmethod:: GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)
:param `variant`:
:type `variant`: wx.WindowVariant
:rtype: :ref:`wx.VisualAttributes`
.. method:: IsEllipsized(self)
Returns ``True`` if the window styles for this control contains one of the ``ST_ELLIPSIZE_START`` , ``ST_ELLIPSIZE_MIDDLE`` or ``ST_ELLIPSIZE_END`` styles.
:rtype: `bool`
.. method:: SetLabel(self, label)
Change the label shown in the control.
Notice that since wxWidgets 3.1.1 this function is guaranteed not to do anything if the label didn't really change, so there is no benefit to checking if the new label is different from the current one in the application code.
:param `label`:
:type `label`: string
.. seealso:: :meth:`wx.Control.SetLabel`
.. method:: Wrap(self, width)
This functions wraps the controls label so that each of its lines becomes at most `width` pixels wide if possible (the lines are broken at words boundaries so it might not be the case if words are too long).
If `width` is negative, no wrapping is done. Note that this width is not necessarily the total width of the control, since a few pixels for the border (depending on the controls border style) may be added.
:param `width`:
:type `width`: int
.. versionadded:: 2.6.2
|
