.. include:: headings.inc



.. _StaticBox:

==========================================================================================================================================
|phoenix_title|  **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:`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 -- and now deprecated -- way is ::

                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:`Sizer`  class (:ref:`StaticBoxSizer`) which can be used as an easier way to pack items into a static box. 







         



.. seealso:: :ref:`StaticText`, :ref:`StaticBoxSizer`    







|

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

Inheritance diagram for class **StaticBox**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/StaticBox_inheritance.png" alt="Inheritance diagram of StaticBox" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Control.html" title="This is the base class for a control or 'widget'." alt="" coords="427,31,501,62"/> <area shape="rect" id="node9" href="StaticBox.html" title="A static box is a rectangle drawn around other windows to denote a logical grouping of items." alt="" coords="549,31,640,62"/> <area shape="rect" id="node2" href="Window.html" title="Window  is the base class for all windows and represents any visible object on screen." alt="" coords="297,31,377,62"/> <area shape="rect" id="node4" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="16,5,88,35"/> <area shape="rect" id="node6" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="148,31,247,62"/> <area shape="rect" id="node5" href="Trackable.html" title="Add-on base class for a trackable object." alt="" coords="5,58,99,89"/> </map> 
   </p>

|


|appearance| Control Appearance
===============================

|

.. figure:: _static/images/widgets/fullsize/wxmsw/staticbox.png
   :alt: wxMSW
   :figclass: floatleft
   
   **wxMSW**


.. figure:: _static/images/widgets/fullsize/wxmac/staticbox.png
   :alt: wxMAC
   :figclass: floatright
   
   **wxMAC**


.. figure:: _static/images/widgets/fullsize/wxgtk/staticbox.png
   :alt: wxGTK
   :figclass: floatcenter
   
   **wxGTK**


|


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

================================================================================ ================================================================================
:meth:`~StaticBox.__init__`                                                      Default constructor.
:meth:`~StaticBox.Create`                                                        Creates the static box for two-step construction.
================================================================================ ================================================================================


|


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

.. class:: StaticBox(Control)

   A static box is a rectangle drawn around other windows to denote a logical grouping of items.
   
   **Possible constructors**::

       StaticBox()
       
       StaticBox(parent, id=ID_ANY, label='', pos=DefaultPosition,
                 size=DefaultSize, style=0, name=StaticBoxNameStr)
       



   .. method:: __init__(self, *args, **kw)



      |overload| **Overloaded Implementations**:

      **~~~**

      
      **__init__** `(self)`
      
      Default constructor.                   
      
      
      
      
      **~~~**

      
      **__init__** `(self, parent, id=ID_ANY, label='', 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`: Window
      :param `id`: Window identifier. The value ``ID_ANY`` indicates a default value.   
      :type `id`: int
      :param `label`: Text to be displayed in the static box, the empty string for no label.   
      :type `label`: string
      :param `pos`: Window position. If ``DefaultPosition``   is specified then a default position is chosen.   
      :type `pos`: Point
      :param `size`: Checkbox size. If ``DefaultSize``   is specified then a default size is chosen.   
      :type `size`: Size
      :param `style`: Window style. See :ref:`StaticBox`.   
      :type `style`: long
      :param `name`: Window name.  
      :type `name`: string
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
                        
      
      
      
      .. seealso:: :meth:`Create`     
      
      
      
      
      
      
      
      **~~~**






   .. method:: Create(self, parent, id=ID_ANY, label='', pos=DefaultPosition, size=DefaultSize, style=0, name=StaticBoxNameStr)

      Creates the static box for two-step construction.                  

      See :ref:`StaticBox`   for further details.                  


      :param `parent`: 
      :type `parent`: Window
      :param `id`: 
      :type `id`: int
      :param `label`: 
      :type `label`: string
      :param `pos`: 
      :type `pos`: Point
      :param `size`: 
      :type `size`: Size
      :param `style`: 
      :type `style`: long
      :param `name`: 
      :type `name`: string




      :rtype: `bool`