phoenix_title wx.lib.agw.hypertreelist.TreeListHeaderWindow

A window which holds the header of HyperTreeList.


class_hierarchy Class Hierarchy

Inheritance diagram of TreeListHeaderWindow


super_classes Known Superclasses

wx.Window


method_summary Methods Summary

__init__

Default class constructor.

AddColumn

Appends a column to the TreeListHeaderWindow.

AddColumnInfo

Appends a column to the TreeListHeaderWindow.

AdjustDC

Shifts the wx.DC origin to match the position of the main window horizontal

DrawCurrent

Draws the column resize line on a ScreenDC.

GetColumn

Returns a column item, an instance of TreeListItem.

GetColumnAlignment

Returns the column text alignment.

GetColumnColour

Returns the column text colour.

GetColumnCount

Returns the total number of columns.

GetColumnText

Returns the column text label.

GetColumnWidth

Returns the column width, in pixels.

GetWidth

Returns the total width of all columns.

InsertColumn

Inserts a column to the TreeListHeaderWindow at the position specified

InsertColumnInfo

Inserts a column to the TreeListHeaderWindow at the position specified

IsColumnEditable

Returns True if the column is editable, False otherwise.

IsColumnShown

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

OnMouse

Handles the wx.EVT_MOUSE_EVENTS event for TreeListHeaderWindow.

OnPaint

Handles the wx.EVT_PAINT event for TreeListHeaderWindow.

OnSetFocus

Handles the wx.EVT_SET_FOCUS event for TreeListHeaderWindow.

RefreshColLabel

Redraws the column.

RemoveColumn

Removes a column from the TreeListHeaderWindow.

SendListEvent

Sends a ListEvent for the parent window.

SetBuffered

Sets/unsets the double buffering for the header.

SetColumn

Sets a column using an instance of TreeListColumnInfo.

SetColumnAlignment

Sets the column text alignment.

SetColumnColour

Sets the column text colour.

SetColumnText

Sets the column text label.

SetColumnWidth

Sets the column width, in pixels.

SetCustomRenderer

Associate a custom renderer with the header - all columns will use it

SetSortIcon

Sets the sort icon to be displayed in the column header.

XToCol

Returns the column that corresponds to the logical input x coordinate.

api Class API

class TreeListHeaderWindow(wx.Window)

A window which holds the header of HyperTreeList.


Methods

__init__(self, parent, id=wx.ID_ANY, owner=None, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, name='wxtreelistctrlcolumntitles')

Default class constructor.

Parameters:

  • parent – the window parent. Must not be None;

  • id – window identifier. A value of -1 indicates a default value;

  • owner – the window owner, in this case an instance of TreeListMainWindow;

  • pos – the control position. A value of (-1, -1) indicates a default position, chosen by either the windowing system or wxPython, depending on platform;

  • size – the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform;

  • style – the window style;

  • name – the window name.


AddColumn(self, text, width=_DEFAULT_COL_WIDTH, flag=wx.ALIGN_LEFT, image=-1, shown=True, colour=None, edit=False)

Appends a column to the TreeListHeaderWindow.

Parameters:

  • text – the column text label;

  • 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.


AddColumnInfo(self, colInfo)

Appends a column to the TreeListHeaderWindow.

Parameters:

colInfo – an instance of TreeListColumnInfo.


AdjustDC(self, dc)

Shifts the wx.DC origin to match the position of the main window horizontal scrollbar: this allows us to always use logical coordinates.

Parameters:

dc – an instance of wx.DC.


DrawCurrent(self)

Draws the column resize line on a ScreenDC.


GetColumn(self, column)

Returns a column item, an instance of TreeListItem.

Parameters:

column – an integer specifying the column index.


GetColumnAlignment(self, column)

Returns the column text alignment.

Parameters:

column – an integer specifying the column index.


GetColumnColour(self, column)

Returns the column text colour.

Parameters:

column – an integer specifying the column index.


GetColumnCount(self)

Returns the total number of columns.


GetColumnText(self, column)

Returns the column text label.

Parameters:

column – an integer specifying the column index.


GetColumnWidth(self, column)

Returns the column width, in pixels.

Parameters:

column – an integer specifying the column index.


GetWidth(self)

Returns the total width of all columns.


InsertColumn(self, before, text, width=_DEFAULT_COL_WIDTH, flag=wx.ALIGN_LEFT, image=-1, shown=True, colour=None, edit=False)

Inserts a column to the TreeListHeaderWindow at the position specified by before.

Parameters:

  • before – the index at which we wish to insert the new column;

  • text – the column text label;

  • 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.


InsertColumnInfo(self, before, colInfo)

Inserts a column to the TreeListHeaderWindow at the position specified by before.

Parameters:

  • before – the index at which we wish to insert the new column;

  • colInfo – an instance of TreeListColumnInfo.


IsColumnEditable(self, column)

Returns True if the column is editable, False otherwise.

Parameters:

column – an integer specifying the column index.


IsColumnShown(self, column)

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

Parameters:

column – an integer specifying the column index.


OnMouse(self, event)

Handles the wx.EVT_MOUSE_EVENTS event for TreeListHeaderWindow.

Parameters:

event – a MouseEvent event to be processed.


OnPaint(self, event)

Handles the wx.EVT_PAINT event for TreeListHeaderWindow.

Parameters:

event – a PaintEvent event to be processed.


OnSetFocus(self, event)

Handles the wx.EVT_SET_FOCUS event for TreeListHeaderWindow.

Parameters:

event – a FocusEvent event to be processed.


RefreshColLabel(self, col)

Redraws the column.

Parameters:

col – the index of the column to redraw.


RemoveColumn(self, column)

Removes a column from the TreeListHeaderWindow.

Parameters:

column – an integer specifying the column index.


SendListEvent(self, evtType, pos)

Sends a ListEvent for the parent window.

Parameters:

  • evtType – the event type;

  • pos – an instance of wx.Point.


SetBuffered(self, buffered)

Sets/unsets the double buffering for the header.

Parameters:

buffered – True to use double-buffering, False otherwise.

Note

Currently double-buffering is only enabled by default for Windows XP.


SetColumn(self, column, info)

Sets a column using an instance of TreeListColumnInfo.

Parameters:

  • column – an integer specifying the column index;

  • info – an instance of TreeListColumnInfo.


SetColumnAlignment(self, column, flag)

Sets the column text alignment.

Parameters:

  • column – an integer specifying the column index;

  • flag – the new text alignment flag.

See also

TreeListColumnInfo.SetAlignment() for a list of valid alignment flags.


SetColumnColour(self, column, colour)

Sets the column text colour.

Parameters:

  • column – an integer specifying the column index;

  • colour – a valid wx.Colour object.


SetColumnText(self, column, text)

Sets the column text label.

Parameters:

  • column – an integer specifying the column index;

  • text – the new column label.


SetColumnWidth(self, column, width)

Sets the column width, in pixels.

Parameters:

  • column – an integer specifying the column index;

  • width – the new width for the column, in pixels.


SetCustomRenderer(self, renderer=None)

Associate a custom renderer with the header - all columns will use it

Parameters:

renderer – a class able to correctly render header buttons

Note

the renderer class must implement the method DrawHeaderButton


SetSortIcon(self, column, sortIcon, colour=None)

Sets the sort icon to be displayed in the column header.

The sort icon will be displayed in the specified column number and all other columns will have the sort icon cleared.

Parameters:

  • column – an integer specifying the column index;

  • 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.


XToCol(self, x)

Returns the column that corresponds to the logical input x coordinate.

Parameters:

x – the x position to evaluate.

Returns:

The column that corresponds to the logical input x coordinate, or wx.NOT_FOUND if there is no column at the x position.