Phoenix Logo

phoenix_title wx.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 wx.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

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


class_hierarchy Class Hierarchy

Inheritance diagram for class StaticBox:


appearance Control Appearance


wxMSW

wxMSW

wxMAC

wxMAC

wxGTK

wxGTK


method_summary Methods Summary

__init__ Default constructor.
Create Creates the static box for two-step construction.
GetBordersForSizer Returns extra space that may be needed for borders within a StaticBox.
GetClassDefaultAttributes  

api Class API



class wx.StaticBox(Control)

Possible constructors:

StaticBox()

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

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


Methods



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

Parameters:
  • parent (wx.Window) – Parent window. Must not be None.
  • id (wx.WindowID) – Window identifier. The value wx.ID_ANY indicates a default value.
  • label (string) – Text to be displayed in the static box, the empty string for no label.
  • pos (wx.Point) – Window position. If wx.DefaultPosition is specified then a default position is chosen.
  • size (wx.Size) – Checkbox size. If wx.DefaultSize is specified then a default size is chosen.
  • style (long) – Window style. See wx.StaticBox.
  • name (string) – Window name.

See also

Create





Create(self, parent, id=ID_ANY, label="", pos=DefaultPosition, size=DefaultSize, style=0, name=StaticBoxNameStr)

Creates the static box for two-step construction.

See wx.StaticBox for further details.

Parameters:
  • parent (wx.Window) –
  • id (wx.WindowID) –
  • label (string) –
  • pos (wx.Point) –
  • size (wx.Size) –
  • style (long) –
  • name (string) –
Return type:

bool



GetBordersForSizer(self)

Returns extra space that may be needed for borders within a StaticBox.

Return type:tuple
Returns:( borderTop, borderOther )


static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)
Parameters:variant (WindowVariant) –
Return type: wx.VisualAttributes