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
|
.. 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.StaticBoxSizer:
==========================================================================================================================================
|phoenix_title| **wx.StaticBoxSizer**
==========================================================================================================================================
:ref:`wx.StaticBoxSizer` is a sizer derived from :ref:`wx.BoxSizer` but adds a static box around the sizer.
The static box may be either created independently or the sizer may create it itself as a convenience. In any case, the sizer owns the :ref:`wx.StaticBox` control and will delete it in the :ref:`wx.StaticBoxSizer` destructor.
Note that since wxWidgets 2.9.1 you are encouraged to create the windows which are added to :ref:`wx.StaticBoxSizer` as children of :ref:`wx.StaticBox` itself, see this class documentation for more details.
Example of use of this class: ::
def CreateControls(self):
panel = wx.Panel(self)
# Other controls here...
sz = wx.StaticBoxSizer(wx.VERTICAL, panel, "Box")
sz.Add(wx.StaticText(sz.GetStaticBox(), wx.ID_ANY,
"This window is a child of the staticbox"))
# Other code...
.. seealso:: :ref:`wx.Sizer`, :ref:`wx.StaticBox`, :ref:`wx.BoxSizer`, :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>StaticBoxSizer</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.StaticBoxSizer_inheritance.png" alt="Inheritance diagram of StaticBoxSizer" 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.StaticBoxSizer.html" title="wx.StaticBoxSizer" alt="" coords="5,237,139,267"/> <area shape="rect" id="node2" href="wx.BoxSizer.html" title="wx.BoxSizer" alt="" coords="23,160,121,189"/> <area shape="rect" id="node3" href="wx.Sizer.html" title="wx.Sizer" alt="" coords="35,83,108,112"/> <area shape="rect" id="node4" href="wx.Object.html" title="wx.Object" alt="" coords="31,5,112,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.StaticBoxSizer.__init__` This constructor uses an already existing static box.
:meth:`~wx.StaticBoxSizer.CalcMin` Implements the calculation of a box sizer's minimal.
:meth:`~wx.StaticBoxSizer.GetStaticBox` Returns the static box associated with the sizer.
:meth:`~wx.StaticBoxSizer.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).
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.StaticBoxSizer.StaticBox` See :meth:`~wx.StaticBoxSizer.GetStaticBox`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.StaticBoxSizer(BoxSizer)
**Possible constructors**::
StaticBoxSizer(box, orient=HORIZONTAL)
StaticBoxSizer(orient, parent, label=EmptyString)
StaticBoxSizer is a sizer derived from BoxSizer but adds a static
box around the sizer.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self, box, orient=HORIZONTAL)`
This constructor uses an already existing static box.
:param `box`: The static box to associate with the sizer (which will take its ownership).
:type `box`: wx.StaticBox
:param `orient`: Can be either ``VERTICAL`` or ``HORIZONTAL`` .
:type `orient`: int
**~~~**
**__init__** `(self, orient, parent, label=EmptyString)`
This constructor creates a new static box with the given label and parent window.
:param `orient`:
:type `orient`: int
:param `parent`:
:type `parent`: wx.Window
:param `label`:
:type `label`: string
**~~~**
.. 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:: GetStaticBox(self)
Returns the static box associated with the sizer.
:rtype: :ref:`wx.StaticBox`
.. 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.
.. attribute:: StaticBox
See :meth:`~wx.StaticBoxSizer.GetStaticBox`
|