.. include:: headings.inc



.. _StaticBoxSizer:

==========================================================================================================================================
|phoenix_title|  **StaticBoxSizer**
==========================================================================================================================================

:ref:`StaticBoxSizer`  is a sizer derived from :ref:`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:`StaticBox`  control and will delete it in the :ref:`StaticBoxSizer`  destructor. 

Note that since wxWidgets 2.9.1 you are encouraged to create the windows which are added to :ref:`StaticBoxSizer`  as children of :ref:`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:`Sizer`, :ref:`StaticBox`, :ref:`BoxSizer`, :ref:`Sizers Overview <sizers overview>`    







|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **StaticBoxSizer**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/StaticBoxSizer_inheritance.png" alt="Inheritance diagram of StaticBoxSizer" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="StaticBoxSizer.html" title="StaticBoxSizer  is a sizer derived from BoxSizer  but adds a static box around the sizer." alt="" coords="381,5,509,35"/> <area shape="rect" id="node2" href="BoxSizer.html" title="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." alt="" coords="247,5,332,35"/> <area shape="rect" id="node4" href="Sizer.html" title="Sizer  is the abstract base class used for laying out subwindows in a window." alt="" coords="125,5,197,35"/> <area shape="rect" id="node5" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="5,5,77,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~StaticBoxSizer.__init__`                                                 This constructor uses an already existing static box.
:meth:`~StaticBoxSizer.CalcMin`                                                  Implements the calculation of a box sizer's minimal.
:meth:`~StaticBoxSizer.GetStaticBox`                                             Returns the static box associated with the sizer.
:meth:`~StaticBoxSizer.RecalcSizes`                                              Implements the calculation of a box sizer's dimensions and then sets the size of its children (calling :meth:`Window.SetSize`   if the child is a window).
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~StaticBoxSizer.StaticBox`                                                See :meth:`~StaticBoxSizer.GetStaticBox`
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: StaticBoxSizer(BoxSizer)

   StaticBoxSizer is a sizer derived from BoxSizer but adds a static box around the sizer.
   
   **Possible constructors**::

       StaticBoxSizer(box, orient=HORIZONTAL)
       
       StaticBoxSizer(orient, parent, label='')
       



   .. 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`: StaticBox
      :param `orient`: Can be either  ``VERTICAL``   or   ``HORIZONTAL`` .    
      :type `orient`: int
      
      
      
      
      
      
                        
      
      
      
      
      **~~~**

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








   .. method:: GetStaticBox(self)

      Returns the static box associated with the sizer.                  

      :rtype: :ref:`StaticBox`








   .. method:: RecalcSizes(self)

      Implements the calculation of a box sizer's dimensions and then sets the size of its children (calling :meth:`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:`~StaticBoxSizer.GetStaticBox`