AGW Logo

agw_title FoldWindowItem

This class is a child sibling of the FoldPanelItem class. It will contain wx.Window that can be either a separator (a coloured line simulated by a wx.Window) or a wxPython controls (such as a wx.Button, a wx.ListCtrl etc...).

hierarchy Inheritance Diagram

Inheritance diagram for: FoldWindowItem

Inheritance diagram of FoldWindowItem


method_summary Methods Summary

__init__Default class constructor
GetLeftSpacingReturns the left indent of FoldWindowItem.
GetLineColourReturns the separator line colour.
GetLineLengthReturns the separator line length.
GetLineYReturns the y position of the separator.
GetRightSpacingReturns the right indent of FoldWindowItem.
GetSpacingReturns the spacing of FoldWindowItem.
GetTypeReturns the FoldWindowItem type.
GetWindowLengthReturns space needed by the window if type is FoldWindowItem
ResizeItemResizes the element, whatever it is.

API Class API

class FoldWindowItem(object)[source]

This class is a child sibling of the FoldPanelItem class. It will contain wx.Window that can be either a separator (a coloured line simulated by a wx.Window) or a wxPython controls (such as a wx.Button, a wx.ListCtrl etc...).



__init__(parent, window=None)[source]

Default class constructor

Parameters:
  • parent – the FoldWindowItem parent;
  • window – the window contained in this item.
  • Type – can be “WINDOW” or “SEPARATOR”;
  • lineColour – the separator colour (meaningful for separators only);
  • y – the separator y position (meaningful for separators only);
  • flags – the alignment flags;
  • spacing – reserves a number of pixels before the window/separator element;
  • leftSpacing – an indent, in pixels;
  • rightSpacing – a right spacing, only relevant when the style FPB_ALIGN_WIDTH is chosen.

See also

FoldPanelBar.AddFoldPanelWindow() for a list of valid alignment flags.



GetLeftSpacing()[source]

Returns the left indent of FoldWindowItem.



GetLineColour()[source]

Returns the separator line colour.



GetLineLength()[source]

Returns the separator line length.



GetLineY()[source]

Returns the y position of the separator.



GetRightSpacing()[source]

Returns the right indent of FoldWindowItem.



GetSpacing()[source]

Returns the spacing of FoldWindowItem.



GetType()[source]

Returns the FoldWindowItem type.



GetWindowLength(vertical=True)[source]

Returns space needed by the window if type is FoldWindowItem “WINDOW” and returns the total size plus the extra spacing.

Parameters:verticalTrue if the parent FoldPanelBar is in vertical mode.


ResizeItem(size, vertical=True)[source]

Resizes the element, whatever it is.

A separator or line will be always aligned by width or height depending on orientation of the whole panel.

Parameters:
Tree

Table Of Contents

Previous topic

FoldPanelItem

Next topic

SVN Revision 68362 For foldpanelbar