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
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.StaticBox:
==========================================================================================================================================
|phoenix_title| **wx.StaticBox**
==========================================================================================================================================
A static box is a rectangle drawn around other windows to denote a logical grouping of items.
Note that while the previous versions required that windows appearing inside a static box be created as its siblings (i.e. use the same parent as the static box itself), since wxWidgets 2.9.1 it is also possible to create them as children of :ref:`wx.StaticBox` itself and you are actually encouraged to do it like this if compatibility with the previous versions is not important.
So the new recommended way to create static box is: ::
def CreateControls(self):
panel = wx.Panel(self)
box = wx.StaticBox(panel, wx.ID_ANY, "StaticBox")
text = wx.StaticText(box, wx.ID_ANY, "This window is a child of the staticbox")
# Other code...
While the compatible ::
box = wx.StaticBox(panel, wx.ID_ANY, "StaticBox")
text = wx.StaticText(panel, wx.ID_ANY, "This window is a child of the panel")
# Other code...
Also note that there is a specialized :ref:`wx.Sizer` class (:ref:`wx.StaticBoxSizer`) which can be used as an easier way to pack items into a static box.
.. seealso:: :ref:`wx.StaticText`, :ref:`wx.StaticBoxSizer`
|
|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>StaticBox</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.StaticBox_inheritance.png" alt="Inheritance diagram of StaticBox" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Control.html" title="wx.Control" alt="" coords="60,237,148,267"/> <area shape="rect" id="node6" href="wx.StaticBox.html" title="wx.StaticBox" alt="" coords="53,315,155,344"/> <area shape="rect" id="node2" href="wx.Window.html" title="wx.Window" alt="" coords="59,160,148,189"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="5,5,87,35"/> <area shape="rect" id="node5" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="48,83,159,112"/> <area shape="rect" id="node4" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="112,5,213,35"/> </map>
</p>
|
|appearance| Control Appearance
===============================
|
.. figure:: _static/images/widgets/fullsize/wxmsw/wx.staticbox.png
:alt: wxMSW
:figclass: floatleft
**wxMSW**
.. figure:: _static/images/widgets/fullsize/wxmac/wx.staticbox.png
:alt: wxMAC
:figclass: floatright
**wxMAC**
.. figure:: _static/images/widgets/fullsize/wxgtk/wx.staticbox.png
:alt: wxGTK
:figclass: floatcenter
**wxGTK**
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.StaticBox.__init__` Default constructor.
:meth:`~wx.StaticBox.Create` Creates the static box for two-step construction.
:meth:`~wx.StaticBox.GetBordersForSizer` Returns extra space that may be needed for borders within a StaticBox.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.StaticBox(Control)
**Possible constructors**::
StaticBox()
StaticBox(parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition,
size=DefaultSize, style=0, name=StaticBoxNameStr)
A static box is a rectangle drawn around other windows to denote a
logical grouping of items.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self)`
Default constructor.
**~~~**
**__init__** `(self, parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, name=StaticBoxNameStr)`
Constructor, creating and showing a static box.
:param `parent`: Parent window. Must not be ``None``.
:type `parent`: wx.Window
:param `id`: Window identifier. The value ``wx.ID_ANY`` indicates a default value.
:type `id`: wx.WindowID
:param `label`: Text to be displayed in the static box, the empty string for no label.
:type `label`: string
:param `pos`: Window position. If :ref:`wx.DefaultPosition` is specified then a default position is chosen.
:type `pos`: wx.Point
:param `size`: Checkbox size. If :ref:`wx.DefaultSize` is specified then a default size is chosen.
:type `size`: wx.Size
:param `style`: Window style. See :ref:`wx.StaticBox`.
:type `style`: long
:param `name`: Window name.
:type `name`: string
.. seealso:: :meth:`Create`
**~~~**
.. method:: Create(self, parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, name=StaticBoxNameStr)
Creates the static box for two-step construction.
See :ref:`wx.StaticBox` for further details.
: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`
.. method:: GetBordersForSizer(self)
Returns extra space that may be needed for borders within a StaticBox.
:rtype: `tuple`
:returns:
( `borderTop`, `borderOther` )
|
