
wx.lib.agw.hypertreelist.TreeListColumnInfo¶Class used to store information (width, alignment flags, colours, etc…) about a
HyperTreeList column header.
Class Hierarchy¶
Inheritance diagram for class TreeListColumnInfo:

Methods Summary¶Default class constructor. |
|
Returns the column text alignment. |
|
Returns the column text colour. |
|
Returns the column text font. |
|
Returns the column image index. |
|
Returns the column image index in the selected state. |
|
Returns the column sort icon displayed in the header. |
|
Return the colour of the sort icon ( |
|
Returns the column header label. |
|
Returns the column header width in pixels. |
|
Returns |
|
Returns |
|
Sets the column text alignment. |
|
Sets the column text colour. |
|
Sets the column as editable or non-editable. |
|
Sets the column text font. |
|
Sets the column image index. |
|
Sets the column image index in the selected state. |
|
Sets the column as shown or hidden. |
|
Sets the column sort icon displayed in the header. |
|
Sets the column header label. |
|
Sets the column header width. |
Class API¶TreeListColumnInfo(object)¶Class used to store information (width, alignment flags, colours, etc…) about a
HyperTreeList column header.
__init__(self, input="", width=_DEFAULT_COL_WIDTH, flag=wx.ALIGN_LEFT, image=-1, shown=True, colour=None, edit=False)¶Default class constructor.
input – can be a string (representing the column header text) or
another instance of TreeListColumnInfo. In the latter case, all the
other input parameters are not used;
width – the column width in pixels;
flag – the column alignment flag, one of wx.ALIGN_LEFT,
wx.ALIGN_RIGHT, wx.ALIGN_CENTER;
image – an index within the normal image list assigned to
HyperTreeList specifying the image to use for the column;
shown – True to show the column, False to hide it;
colour – a valid wx.Colour, representing the text foreground colour
for the column;
edit – True to set the column as editable, False otherwise.
GetAlignment(self)¶Returns the column text alignment.
GetColour(self)¶Returns the column text colour.
GetFont(self)¶Returns the column text font.
GetImage(self)¶Returns the column image index.
GetSelectedImage(self)¶Returns the column image index in the selected state.
GetSortIcon(self)¶Returns the column sort icon displayed in the header.
GetSortIconColour(self)¶Return the colour of the sort icon (None = Default).
GetText(self)¶Returns the column header label.
GetWidth(self)¶Returns the column header width in pixels.
IsEditable(self)¶Returns True if the column is editable, False otherwise.
IsShown(self)¶Returns True if the column is shown, False if it is hidden.
SetAlignment(self, flag)¶Sets the column text alignment.
flag – the alignment flag, one of wx.ALIGN_LEFT, wx.ALIGN_RIGHT,
wx.ALIGN_CENTER.
SetColour(self, colour)¶Sets the column text colour.
colour – a valid wx.Colour object.
SetEditable(self, edit)¶Sets the column as editable or non-editable.
edit – True if the column should be editable, False otherwise.
SetImage(self, image)¶Sets the column image index.
image – an index within the normal image list assigned to
HyperTreeList specifying the image to use for the column.
SetSelectedImage(self, image)¶Sets the column image index in the selected state.
image – an index within the normal image list assigned to
HyperTreeList specifying the image to use for the column when in
selected state.
SetShown(self, shown)¶Sets the column as shown or hidden.
shown – True if the column should be shown, False if it
should be hidden.
SetSortIcon(self, sortIcon, colour=None)¶Sets the column sort icon displayed in the header.
sortIcon – the sort icon to display, one of wx.HDR_SORT_ICON_NONE,
wx.HDR_SORT_ICON_UP, wx.HDR_SORT_ICON_DOWN.
colour – the colour of the sort icon as a wx.Colour. Optional.
Set to None to restore native colour.
SetText(self, text)¶Sets the column header label.
text – the new column header text.
SetWidth(self, width)¶Sets the column header width.
width – the column header width, in pixels.