.. 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.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 strongly 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 ` | |class_hierarchy| Class Hierarchy ================================= .. raw:: html
Inheritance diagram for class StaticBoxSizer:
| |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.RepositionChildren` Method which must be overridden in the derived sizer classes. ================================================================================ ================================================================================ | |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="") StaticBoxSizer is a sizer derived from BoxSizer but adds a static box around the sizer. .. method:: __init__(self, *args, **kw) |overload| Overloaded Implementations: :html:`

` **__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 :html:`

` **__init__** `(self, orient, parent, label="")` 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 :html:`

` .. 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:: RepositionChildren(self, minSize) Method which must be overridden in the derived sizer classes. The implementation should reposition the children using the current total size available to the sizer ( ``m_size`` ) and the size computed by the last call to :meth:`CalcMin` . :param `minSize`: :type `minSize`: wx.Size .. versionadded:: 4.1/wxWidgets-3.1.3 , before this version RecalcSizes() method not taking any arguments had to be overridden in the derived classes instead. .. attribute:: StaticBox See :meth:`~wx.StaticBoxSizer.GetStaticBox`