Phoenix Logo

phoenix_title wx.StaticBoxSizer

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

Note that since wxWidgets 2.9.1 you are encouraged to create the windows which are added to wx.StaticBoxSizer as children of 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...

class_hierarchy Class Hierarchy

Inheritance diagram for class StaticBoxSizer:


method_summary Methods Summary

__init__ This constructor uses an already existing static box.
CalcMin Implements the calculation of a box sizer’s minimal.
GetStaticBox Returns the static box associated with the sizer.
RepositionChildren Method which must be overridden in the derived sizer classes.

property_summary Properties Summary

StaticBox See 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.


Methods



__init__(self, *args, **kw)

overload Overloaded Implementations:



__init__ (self, box, orient=HORIZONTAL)

This constructor uses an already existing static box.

Parameters:
  • box (wx.StaticBox) – The static box to associate with the sizer (which will take its ownership).
  • orient (int) – Can be either VERTICAL or HORIZONTAL .



__init__ (self, orient, parent, label=”“)

This constructor creates a new static box with the given label and parent window.

Parameters:
  • orient (int) –
  • parent (wx.Window) –
  • label (string) –





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.

Return type: wx.Size


GetStaticBox(self)

Returns the static box associated with the sizer.

Return type: wx.StaticBox


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 CalcMin .

Parameters:minSize (wx.Size) –

New in version 3.1.3,: before this version RecalcSizes() method not taking any arguments had to be overridden in the derived classes instead.


Properties



StaticBox

See GetStaticBox