SizerFlags

Container for sizer items flags providing readable names for them.

Normally, when you add an item to a sizer via Sizer.Add , you have to specify a lot of flags and parameters which can be unwieldy. This is where SizerFlags comes in: it allows you to specify all parameters using the named methods instead. For example, instead of

sizer.Add(ctrl, 0, wx.EXPAND | wx.ALL, 10)

you can now write

sizer.Add(ctrl, wx.SizerFlags().Expand().Border(wx.ALL, 10))

This is more readable and also allows you to create SizerFlags objects which can be reused for several sizer items.

flagsExpand = wx.SizerFlags(1)
flagsExpand.Expand().Border(wx.ALL, 10)

sizer.Add(ctrl1, flagsExpand)
sizer.Add(ctrl2, flagsExpand)

Note that by specification, all methods of SizerFlags return the SizerFlags object itself to allowing chaining multiple methods calls like in the examples above.

See also

Sizer

Inheritance Diagram

Inheritance diagram for class SizerFlags

Methods Summary

__init__	Creates the Sizer with the proportion specified by proportion.
Align	Sets the alignment of this SizerFlags to align.
Border	Sets the SizerFlags to have a border of a number of pixels specified by borderinpixels with the directions specified by direction.
Bottom	Aligns the object to the bottom, similar for Align(wxALIGN_BOTTOM) .
Center	Sets the object of the SizerFlags to center itself in the area it is given.
Centre	Center for people with the other dialect of English.
DoubleBorder	Sets the border in the given direction having twice the default border size.
DoubleHorzBorder	Sets the border in left and right directions having twice the default border size.
Expand	Sets the object of the SizerFlags to expand to fill as much area as it can.
FixedMinSize	Set the FIXED_MINSIZE flag which indicates that the initial size of the window should be also set as its minimal size.
GetDefaultBorder	Returns the border used by default in Border method.
Left	Aligns the object to the left, similar for Align(wxALIGN_LEFT) .
Proportion	Sets the proportion of this SizerFlags to proportion.
ReserveSpaceEvenIfHidden	Set the RESERVE_SPACE_EVEN_IF_HIDDEN flag.
Right	Aligns the object to the right, similar for Align(wxALIGN_RIGHT) .
Shaped	Set the _SHAPED flag which indicates that the elements should always keep the fixed width to height ratio equal to its original value.
Top	Aligns the object to the top, similar for Align(wxALIGN_TOP) .
TripleBorder	Sets the border in the given direction having thrice the default border size.

Class API

---

class SizerFlags(object)

Container for sizer items flags providing readable names for them.

Possible constructors:

SizerFlags(proportion=0)

Methods

---

__init__(self, proportion=0)

Creates the Sizer with the proportion specified by proportion.

Parameters:proportion (int) –

---

Align(self, alignment)

Sets the alignment of this SizerFlags to align.

This method replaces the previously set alignment with the specified one.

Parameters:alignment (int) – Combination of ALIGN_XXX bit masks. Return type: SizerFlags

See also

Top , Left , Right , Bottom , Centre

---

Border(self, *args, **kw)

Overloaded Implementations:

---

Border (self, direction, borderinpixels)

Sets the SizerFlags to have a border of a number of pixels specified by borderinpixels with the directions specified by direction.

Parameters:

• direction (int) –
• borderinpixels (int) –

Return type:

SizerFlags

---

Border (self, direction=ALL)

Sets the SizerFlags to have a border with size as returned by GetDefaultBorder .

Parameters:direction (int) – Direction(s) to apply the border in. Return type: SizerFlags

---

---

Bottom(self)

Aligns the object to the bottom, similar for Align(wxALIGN_BOTTOM) .

Unlike Align , this method doesn’t change the horizontal alignment of the item.

Return type: SizerFlags

---

Center(self)

Sets the object of the SizerFlags to center itself in the area it is given.

Return type: SizerFlags

---

Centre(self)

Center for people with the other dialect of English.

Return type: SizerFlags

---

DoubleBorder(self, direction=ALL)

Sets the border in the given direction having twice the default border size.

Parameters:direction (int) – Return type: SizerFlags

---

DoubleHorzBorder(self)

Sets the border in left and right directions having twice the default border size.

Return type: SizerFlags

---

Expand(self)

Sets the object of the SizerFlags to expand to fill as much area as it can.

Return type: SizerFlags

---

FixedMinSize(self)

Set the FIXED_MINSIZE flag which indicates that the initial size of the window should be also set as its minimal size.

Return type: SizerFlags

---

static GetDefaultBorder()

Returns the border used by default in Border method.

Return type:int

---

Left(self)

Aligns the object to the left, similar for Align(wxALIGN_LEFT) .

Unlike Align , this method doesn’t change the vertical alignment of the item.

Return type: SizerFlags

---

Proportion(self, proportion)

Sets the proportion of this SizerFlags to proportion.

Parameters:proportion (int) – Return type: SizerFlags

---

ReserveSpaceEvenIfHidden(self)

Set the RESERVE_SPACE_EVEN_IF_HIDDEN flag.

Normally Sizers don’t allocate space for hidden windows or other items. This flag overrides this behaviour so that sufficient space is allocated for the window even if it isn’t visible. This makes it possible to dynamically show and hide controls without resizing parent dialog, for example.

Return type: SizerFlags

New in version 2.8.8.

---

Right(self)

Aligns the object to the right, similar for Align(wxALIGN_RIGHT) .

Unlike Align , this method doesn’t change the vertical alignment of the item.

Return type: SizerFlags

---

Shaped(self)

Set the _SHAPED flag which indicates that the elements should always keep the fixed width to height ratio equal to its original value.

Return type: SizerFlags

---

Top(self)

Aligns the object to the top, similar for Align(wxALIGN_TOP) .

Unlike Align , this method doesn’t change the horizontal alignment of the item.

Return type: SizerFlags

---

TripleBorder(self, direction=ALL)

Sets the border in the given direction having thrice the default border size.

Parameters:direction (int) – Return type: SizerFlags