AGW Logo

agw_title TreeListColumnInfo

Class used to store information (width, alignment flags, colours, etc...) about a HyperTreeList column header.

hierarchy Inheritance Diagram

Inheritance diagram for: TreeListColumnInfo

Inheritance diagram of TreeListColumnInfo


method_summary Methods Summary

__init__Default class constructor.
GetAlignmentReturns the column text alignment.
GetColourReturns the column text colour.
GetFontReturns the column text font.
GetImageReturns the column image index.
GetSelectedImageReturns the column image index in the selected state.
GetTextReturns the column header label.
GetWidthReturns the column header width in pixels.
IsEditableReturns True if the column is editable, False otherwise.
IsShownReturns True if the column is shown, False if it is hidden.
SetAlignmentSets the column text alignment.
SetColourSets the column text colour.
SetEditableSets the column as editable or non-editable.
SetFontSets the column text font.
SetImageSets the column image index.
SetSelectedImageSets the column image index in the selected state.
SetShownSets the column as shown or hidden.
SetTextSets the column header label.
SetWidthSets the column header width.

API Class API

class TreeListColumnInfo(object)[source]

Class used to store information (width, alignment flags, colours, etc...) about a HyperTreeList column header.



__init__(input="", width=_DEFAULT_COL_WIDTH, flag=wx.ALIGN_LEFT, image=-1, shown=True, colour=None, edit=False)[source]

Default class constructor.

Parameters:
  • 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;
  • shownTrue to show the column, False to hide it;
  • colour – a valid wx.Colour, representing the text foreground colour for the column;
  • editTrue to set the column as editable, False otherwise.


GetAlignment()[source]

Returns the column text alignment.



GetColour()[source]

Returns the column text colour.



GetFont()[source]

Returns the column text font.



GetImage()[source]

Returns the column image index.



GetSelectedImage()[source]

Returns the column image index in the selected state.



GetText()[source]

Returns the column header label.



GetWidth()[source]

Returns the column header width in pixels.



IsEditable()[source]

Returns True if the column is editable, False otherwise.



IsShown()[source]

Returns True if the column is shown, False if it is hidden.



SetAlignment(flag)[source]

Sets the column text alignment.

Parameters:flag – the alignment flag, one of wx.ALIGN_LEFT, wx.ALIGN_RIGHT, wx.ALIGN_CENTER.


SetColour(colour)[source]

Sets the column text colour.

Parameters:colour – a valid wx.Colour object.



SetEditable(edit)[source]

Sets the column as editable or non-editable.

Parameters:editTrue if the column should be editable, False otherwise.


SetFont(font)[source]

Sets the column text font.

Parameters:font – a valid wx.Font object.


SetImage(image)[source]

Sets the column image index.

Parameters:image – an index within the normal image list assigned to HyperTreeList specifying the image to use for the column.


SetSelectedImage(image)[source]

Sets the column image index in the selected state.

Parameters:image – an index within the normal image list assigned to HyperTreeList specifying the image to use for the column when in selected state.


SetShown(shown)[source]

Sets the column as shown or hidden.

Parameters:shownTrue if the column should be shown, False if it should be hidden.


SetText(text)[source]

Sets the column header label.

Parameters:text – the new column header text.


SetWidth(width)[source]

Sets the column header width.

Parameters:width – the column header width, in pixels.
Tree

Table Of Contents

Previous topic

HyperTreeList

Next topic

TreeListHeaderWindow