# wx.lib.agw.hypertreelist¶

HyperTreeList is a class that combines the multicolumn features of a wx.ListCtrl in report mode with the hierarchical features of a wx.TreeCtrl. Although it looks more like a wx.ListCtrl, the API tends to follow the API of wx.TreeCtrl.

## Description¶

HyperTreeList was originally inspired from the wx.gizmos.TreeListCtrl class from Classic wxPython. Now in Phoenix the old wrapped C++ wxTreeListCtrl class is gone and this class can be used in its place. In addition to the features of the old wx.gizmos.TreeListCtrl this class supports:

• CheckBox-type items: checkboxes are easy to handle, just selected or unselected state with no particular issues in handling the item’s children;

• Added support for 3-state value checkbox items;

• RadioButton-type items: since I elected to put radiobuttons in CustomTreeCtrl, I needed some way to handle them that made sense. So, I used the following approach:

• All peer-nodes that are radiobuttons will be mutually exclusive. In other words, only one of a set of radiobuttons that share a common parent can be checked at once. If a radiobutton node becomes checked, then all of its peer radiobuttons must be unchecked.

• If a radiobutton node becomes unchecked, then all of its child nodes will become inactive.

• Hyperlink-type items: they look like an hyperlink, with the proper mouse cursor on hovering;

• Multiline text items;

• Enabling/disabling items (together with their plain or grayed out icons);

• Whatever non-toplevel widget can be attached next to a tree item;

• Whatever non-toplevel widget can be attached next to a list item;

• Column headers are fully customizable in terms of icons, colour, font, alignment etc…;

• Default selection style, gradient (horizontal/vertical) selection style and Windows Vista selection style;

• Customized drag and drop images built on the fly;

• Setting the HyperTreeList item buttons to a personalized imagelist;

• Setting the HyperTreeList check/radio item icons to a personalized imagelist;

• Changing the style of the lines that connect the items (in terms of wx.Pen styles);

• Using an image as a HyperTreeList background (currently only in “tile” mode);

• Ellipsization of long items when the horizontal space is low, via the TR_ELLIPSIZE_LONG_ITEMS style (New in version 0.9.3).

And a lot more. Check the demo for an almost complete review of the functionalities.

## Base Functionalities¶

HyperTreeList supports all the wx.TreeCtrl styles, except:

• TR_EXTENDED: supports for this style is on the todo list (Am I sure of this?).

Plus it has 3 more styles to handle checkbox-type items:

• TR_AUTO_CHECK_CHILD: automatically checks/unchecks the item children;

• TR_AUTO_CHECK_PARENT: automatically checks/unchecks the item parent;

• TR_AUTO_TOGGLE_CHILD: automatically toggles the item children.

And a style useful to hide the TreeListCtrl header:

And a style related to long items (with a lot of text in them), which can be ellipsized:

• TR_ELLIPSIZE_LONG_ITEMS: ellipsizes long items when the horizontal space for HyperTreeList is low (New in version 0.9.3).

Please note that most TreeCtrl-like APIs are available in this class, although they may not be visible to IDEs or other tools as they are automatically delegated to the CustomTreeCtrl or other helper classes.

## Usage¶

Usage example:

import wx
import wx.lib.agw.hypertreelist as HTL

class MyFrame(wx.Frame):

def __init__(self, parent):

wx.Frame.__init__(self, parent, -1, "HyperTreeList Demo")

tree_list = HTL.HyperTreeList(self)

parent = tree_list.AppendItem(root, "First child")
child = tree_list.AppendItem(parent, "First Grandchild")

tree_list.AppendItem(root, "Second child")

# our normal wxApp-derived class, as usual

app = wx.App(0)

frame = MyFrame(None)
app.SetTopWindow(frame)
frame.Show()

app.MainLoop()


## Events¶

All the events supported by wx.TreeCtrl and some from wx.ListCtrl are also available in HyperTreeList, with a few exceptions:

• EVT_TREE_GET_INFO (don’t know what this means);

• EVT_TREE_SET_INFO (don’t know what this means);

• EVT_TREE_ITEM_MIDDLE_CLICK (not implemented, but easy to add);

• EVT_TREE_STATE_IMAGE_CLICK (no need for that, look at the checking events below).

Plus, HyperTreeList supports the events related to the checkbutton-type items:

• EVT_TREE_ITEM_CHECKING: an item is being checked;

• EVT_TREE_ITEM_CHECKED: an item has been checked.

• EVT_TREE_ITEM_HYPERLINK: an hyperlink item has been clicked (this event is sent after the EVT_TREE_SEL_CHANGED event).

## Supported Platforms¶

HyperTreeList has been tested on the following platforms:
• Windows

• Linux

• Mac

## Window Styles¶

This class supports the following window styles:

Window Styles

Hex Value

Description

TR_NO_BUTTONS

0x0

For convenience to document that no buttons are to be drawn.

TR_SINGLE

0x0

For convenience to document that only one item may be selected at a time. Selecting another item causes the current selection, if any, to be deselected. This is the default.

TR_HAS_BUTTONS

0x1

Use this style to show + and - buttons to the left of parent items.

TR_NO_LINES

0x4

Use this style to hide vertical level connectors.

TR_LINES_AT_ROOT

0x8

Use this style to show lines between root nodes. Only applicable if TR_HIDE_ROOT is set and TR_NO_LINES is not set.

TR_DEFAULT_STYLE

0x9

The set of flags that are closest to the defaults for the native control for a particular toolkit.

TR_TWIST_BUTTONS

0x10

Use old Mac-twist style buttons.

TR_MULTIPLE

0x20

Use this style to allow a range of items to be selected. If a second range is selected, the current range, if any, is deselected.

TR_EXTENDED

0x40

Use this style to allow disjoint items to be selected. (Only partially implemented; may not work in all cases).

TR_HAS_VARIABLE_ROW_HEIGHT

0x80

Use this style to cause row heights to be just big enough to fit the content. If not set, all rows use the largest row height. The default is that this flag is unset.

TR_EDIT_LABELS

0x200

Use this style if you wish the user to be able to edit labels in the tree control.

TR_ROW_LINES

0x400

Use this style to draw a contrasting border between displayed rows.

TR_HIDE_ROOT

0x800

Use this style to suppress the display of the root node, effectively causing the first-level nodes to appear as a series of root nodes.

TR_COLUMN_LINES

0x1000

Use this style to draw a contrasting border between displayed columns.

TR_FULL_ROW_HIGHLIGHT

0x2000

Use this style to have the background colour and the selection highlight extend over the entire horizontal row of the tree control window.

TR_AUTO_CHECK_CHILD

0x4000

Only meaningful for checkbox-type items: when a parent item is checked/unchecked its children are checked/unchecked as well.

TR_AUTO_TOGGLE_CHILD

0x8000

Only meaningful for checkbox-type items: when a parent item is checked/unchecked its children are toggled accordingly.

TR_AUTO_CHECK_PARENT

0x10000

Only meaningful for checkbox-type items: when a child item is checked/unchecked its parent item is checked/unchecked as well.

TR_ALIGN_WINDOWS

0x20000

Flag used to align windows (in items with windows) at the same horizontal position.

TR_NO_HEADER

0x40000

Use this style to hide the columns header.

TR_ELLIPSIZE_LONG_ITEMS

0x80000

Flag used to ellipsize long items when the horizontal space for HyperTreeList columns is low.

TR_VIRTUAL

0x100000

HyperTreeList will have virtual behaviour.

## Events Processing¶

This class processes the following events, Note that these are the same events as wx.ListCtrl and wx.TreeCtrl:

Event Name

Description

EVT_LIST_COL_BEGIN_DRAG

The user started resizing a column - can be vetoed.

EVT_LIST_COL_CLICK

A column has been left-clicked.

EVT_LIST_COL_DRAGGING

The divider between columns is being dragged.

EVT_LIST_COL_END_DRAG

A column has been resized by the user.

EVT_LIST_COL_RIGHT_CLICK

A column has been right-clicked.

EVT_TREE_BEGIN_DRAG

Begin dragging with the left mouse button.

EVT_TREE_BEGIN_LABEL_EDIT

Begin editing a label. This can be prevented by calling TreeEvent.Veto().

EVT_TREE_BEGIN_RDRAG

Begin dragging with the right mouse button.

EVT_TREE_DELETE_ITEM

Delete an item.

EVT_TREE_END_DRAG

End dragging with the left or right mouse button.

EVT_TREE_END_LABEL_EDIT

End editing a label. This can be prevented by calling TreeEvent.Veto().

EVT_TREE_GET_INFO

Request information from the application (not implemented in HyperTreeList).

EVT_TREE_ITEM_ACTIVATED

The item has been activated, i.e. chosen by double clicking it with mouse or from keyboard.

EVT_TREE_ITEM_CHECKED

A checkbox or radiobox type item has been checked.

EVT_TREE_ITEM_CHECKING

A checkbox or radiobox type item is being checked.

EVT_TREE_ITEM_COLLAPSED

The item has been collapsed.

EVT_TREE_ITEM_COLLAPSING

The item is being collapsed. This can be prevented by calling TreeEvent.Veto().

EVT_TREE_ITEM_EXPANDED

The item has been expanded.s

EVT_TREE_ITEM_EXPANDING

The item is being expanded. This can be prevented by calling TreeEvent.Veto().

EVT_TREE_ITEM_GETTOOLTIP

The opportunity to set the item tooltip is being given to the application (call TreeEvent.SetToolTip()).

EVT_TREE_ITEM_HYPERLINK

An hyperlink type item has been clicked.

EVT_TREE_ITEM_MENU

The context menu for the selected item has been requested, either by a right click or by using the menu key.

EVT_TREE_ITEM_MIDDLE_CLICK

The user has clicked the item with the middle mouse button (not implemented in HyperTreeList).

EVT_TREE_ITEM_RIGHT_CLICK

The user has clicked the item with the right mouse button.

EVT_TREE_KEY_DOWN

A key has been pressed.

EVT_TREE_SEL_CHANGED

Selection has changed.

EVT_TREE_SEL_CHANGING

Selection is changing. This can be prevented by calling TreeEvent.Veto().

EVT_TREE_SET_INFO

Information is being supplied to the application (not implemented in HyperTreeList).

EVT_TREE_STATE_IMAGE_CLICK

The state image has been clicked (not implemented in HyperTreeList).

HyperTreeList is distributed under the wxPython license.

Latest Revision: Andrea Gavana @ 30 Jul 2014, 21.00 GMT

Version 1.4

## Functions Summary¶

 create_delegator_for Creates a method that forwards calls to self._main_win (an instance of TreeListMainWindow). IsBufferingSupported Utility function which checks if a platform handles correctly double

## Classes Summary¶

 EditCtrl Base class for controls used for in-place edit. EditTextCtrl Text control used for in-place edit. HyperTreeList HyperTreeList is a generic widget that combines the multicolumn TreeListColumnInfo Class used to store information (width, alignment flags, colours, etc…) about a TreeListHeaderWindow A window which holds the header of HyperTreeList. TreeListItem This class holds all the information and methods for every single item in TreeListMainWindow This class represents the main window (and thus the main column) in HyperTreeList.

### Functions¶

create_delegator_for(method)

Creates a method that forwards calls to self._main_win (an instance of TreeListMainWindow).

Parameters

method – one method inside the TreeListMainWindow local scope.

IsBufferingSupported()

Utility function which checks if a platform handles correctly double buffering for the header. Currently returns False for all platforms except Windows XP.