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
|
.. 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.BoxSizer:
==========================================================================================================================================
|phoenix_title| **wx.BoxSizer**
==========================================================================================================================================
The basic idea behind a box sizer is that windows will most often be laid out in rather simple basic geometry, typically in a row or a column or several hierarchies of either.
For more information, please see :ref:`Programming with BoxSizer <programming with boxsizer>`.
.. seealso:: :ref:`wx.Sizer`, :ref:`Sizers Overview <sizers overview>`
|
|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>BoxSizer</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.BoxSizer_inheritance.png" alt="Inheritance diagram of BoxSizer" 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.BoxSizer.html" title="wx.BoxSizer" alt="" coords="5,160,104,189"/> <area shape="rect" id="node2" href="wx.Sizer.html" title="wx.Sizer" alt="" coords="17,83,91,112"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="13,5,95,35"/> </map>
</p>
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.StaticBoxSizer`, :ref:`wx.StdDialogButtonSizer`, :ref:`wx.WrapSizer`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.BoxSizer.__init__` Constructor for a :ref:`wx.BoxSizer`.
:meth:`~wx.BoxSizer.AddSpacer` Adds non-stretchable space to the main orientation of the sizer only.
:meth:`~wx.BoxSizer.CalcMin` Implements the calculation of a box sizer's minimal.
:meth:`~wx.BoxSizer.GetOrientation` Returns the orientation of the box sizer, either ``wx.VERTICAL`` or ``wx.HORIZONTAL``.
:meth:`~wx.BoxSizer.RecalcSizes` Implements the calculation of a box sizer's dimensions and then sets the size of its children (calling :meth:`wx.Window.SetSize` if the child is a window).
:meth:`~wx.BoxSizer.SetOrientation` Sets the orientation of the box sizer, either ``wx.VERTICAL`` or ``wx.HORIZONTAL``.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.BoxSizer.Orientation` See :meth:`~wx.BoxSizer.GetOrientation` and :meth:`~wx.BoxSizer.SetOrientation`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.BoxSizer(Sizer)
**Possible constructors**::
BoxSizer(orient=HORIZONTAL)
The basic idea behind a box sizer is that windows will most often be
laid out in rather simple basic geometry, typically in a row or a
column or several hierarchies of either.
.. method:: __init__(self, orient=HORIZONTAL)
Constructor for a :ref:`wx.BoxSizer`.
`orient` may be either of ``wx.VERTICAL`` or ``wx.HORIZONTAL`` for creating either a column sizer or a row sizer.
:param `orient`:
:type `orient`: int
.. method:: AddSpacer(self, size)
Adds non-stretchable space to the main orientation of the sizer only.
More readable way of calling: ::
if boxSizer.IsVertical():
boxSizer.Add(0, size, 0)
else:
boxSizer.Add(size, 0, 0)
:param `size`:
:type `size`: int
:rtype: :ref:`wx.SizerItem`
.. method:: CalcMin(self)
Implements the calculation of a box sizer's minimal.
It is used internally only and must not be called by the user. Documented for information.
:rtype: :ref:`wx.Size`
.. method:: GetOrientation(self)
Returns the orientation of the box sizer, either ``wx.VERTICAL`` or ``wx.HORIZONTAL``.
:rtype: `int`
.. method:: RecalcSizes(self)
Implements the calculation of a box sizer's dimensions and then sets the size of its children (calling :meth:`wx.Window.SetSize` if the child is a window).
It is used internally only and must not be called by the user (call :meth:`Layout` if you want to resize). Documented for information.
.. method:: SetOrientation(self, orient)
Sets the orientation of the box sizer, either ``wx.VERTICAL`` or ``wx.HORIZONTAL``.
:param `orient`:
:type `orient`: int
.. attribute:: Orientation
See :meth:`~wx.BoxSizer.GetOrientation` and :meth:`~wx.BoxSizer.SetOrientation`
|
