Phoenix Logo

phoenix_title wx.BoxSizer

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.

For more information, please see wx.BoxSizer.


class_hierarchy Class Hierarchy

Inheritance diagram for class BoxSizer:


method_summary Methods Summary

__init__ Constructor for a wx.BoxSizer.
AddSpacer Adds non-stretchable space to the main orientation of the sizer only.
CalcMin Implements the calculation of a box sizer’s minimal.
GetOrientation Returns the orientation of the box sizer, either wx.VERTICAL or wx.HORIZONTAL.
RepositionChildren Method which must be overridden in the derived sizer classes.
SetOrientation Sets the orientation of the box sizer, either wx.VERTICAL or wx.HORIZONTAL.

property_summary Properties Summary

Orientation See GetOrientation and SetOrientation

api Class API



class wx.BoxSizer(Sizer)

Possible constructors:

BoxSizer(orient=HORIZONTAL)

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.


Methods



__init__(self, orient=HORIZONTAL)

Constructor for a wx.BoxSizer.

orient may be either of wx.VERTICAL or wx.HORIZONTAL for creating either a column sizer or a row sizer.

Parameters:orient (int) –


AddSpacer(self, size)

Adds non-stretchable space to the main orientation of the sizer only.

More readable way of calling:

if boxSizer.IsVertical():

    boxSizer.Add(0, size, 0)

else:

    boxSizer.Add(size, 0, 0)
Parameters:size (int) –
Return type: wx.SizerItem


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


GetOrientation(self)

Returns the orientation of the box sizer, either wx.VERTICAL or wx.HORIZONTAL.

Return type:int


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.



SetOrientation(self, orient)

Sets the orientation of the box sizer, either wx.VERTICAL or wx.HORIZONTAL.

Parameters:orient (int) –

Properties



Orientation

See GetOrientation and SetOrientation