Table Of Contents

Previous topic

WithImages

Next topic

Year

This Page

Phoenix Logo

phoenix_title WrapSizer

A wrap sizer lays out its items in a single line, like a box sizer

Once all available space in the primary direction has been used, a new line is added and items are added there.

So a wrap sizer has a primary orientation for adding items, and adds lines as needed in the secondary direction.


class_hierarchy Class Hierarchy

Inheritance diagram for class WrapSizer:


method_summary Methods Summary

__init__ Constructor for a WrapSizer.
CalcMin Implements the calculation of a box sizer’s minimal.
InformFirstDirection Not used by an application.
IsSpaceItem Can be overridden in the derived classes to treat some normal items as spacers.
RecalcSizes Implements the calculation of a box sizer’s dimensions and then sets the size of its children (calling Window.SetSize if the child is a window).

api Class API



class WrapSizer(BoxSizer)

Possible constructors:

WrapSizer(orient=HORIZONTAL, flags=WRAPSIZER_DEFAULT_FLAGS)

A wrap sizer lays out its items in a single line, like a box sizer as long as there is space available in that direction.


Methods



__init__(self, orient=HORIZONTAL, flags=WRAPSIZER_DEFAULT_FLAGS)

Constructor for a WrapSizer.

orient determines the primary direction of the sizer (the most common case being HORIZONTAL ). The flags parameter can be a combination of the values EXTEND_LAST_ON_EACH_LINE which will cause the last item on each line to use any remaining space on that line and REMOVE_LEADING_SPACES which removes any spacer elements from the beginning of a row.

Both of these flags are on by default.

Parameters:
  • orient (int) –
  • flags (int) –


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: Size


InformFirstDirection(self, direction, size, availableOtherDir)

Not used by an application.

This is the mechanism by which sizers can inform sub-items of the first determined size component. The sub-item can then better determine its size requirements.

Returns True if the information was used (and the sub-item min size was updated).

Parameters:
  • direction (int) –
  • size (int) –
  • availableOtherDir (int) –
Return type:

bool



IsSpaceItem(self, item)

Can be overridden in the derived classes to treat some normal items as spacers.

This method is used to determine whether the given item should be considered to be a spacer for the purposes of REMOVE_LEADING_SPACES implementation. By default only returns True for the real spacers.

Parameters:item (SizerItem) –
Return type:bool


RecalcSizes(self)

Implements the calculation of a box sizer’s dimensions and then sets the size of its children (calling Window.SetSize if the child is a window).

It is used internally only and must not be called by the user (call Layout if you want to resize). Documented for information.