wx.lib.agw.hypertreelist.TreeListItem

This class holds all the information and methods for every single item in HyperTreeList.

Note

Subclassed from GenericTreeItem.

Class Hierarchy

Inheritance diagram for class TreeListItem:

Known Superclasses

wx.lib.agw.customtreectrl.GenericTreeItem

Methods Summary

__init__	Default class constructor.
DeleteChildren	Deletes the item children.
DeleteWindow	Deletes the window associated to the item (if any).
GetBackgroundColour	Returns the associated background colour
GetCurrentImage	Returns the current item image.
GetExtents	Calculate text extents of this item using the given ClientDc.
GetImage	Returns the item image for a particular item state.
GetText	Returns the item text label.
GetTextX	Returns the x position of the item text.
GetWindow	Returns the window associated to the item.
GetWindowEnabled	Returns whether the window associated with an item is enabled or not.
GetWindows	Returns a list of all associated windows. May be empty list.
GetWindowSize	Returns the associated window size.
HasExtents	Returns whether the text extents are calculated for this item.
HitTest	HitTest method for an item. Called from the main window HitTest.
OnSetFocus	Handles the wx.EVT_SET_FOCUS event for a window associated to an item.
SetBackgroundColour	Sets the associated background colour
SetImage	Sets the item image for a particular item state.
SetText	Sets the item text label.
SetTextX	Sets the x position of the item text. Used internally to position
SetWindow	Sets the window associated to the item. Internal use only.
SetWindowEnabled	Sets whether the window associated with an item is enabled or not.

Class API

class TreeListItem(GenericTreeItem)

This class holds all the information and methods for every single item in HyperTreeList.

Note

Subclassed from GenericTreeItem.

Methods

__init__(self, mainWin, parent, text='', ct_type=0, wnd=None, image=-1, selImage=-1, data=None)

Default class constructor. For internal use: do not call it in your code!

Parameters:

• mainWin – the main HyperTreeList window, in this case an instance of TreeListMainWindow;

• parent – the tree item parent (may be None for root items);

• text – the tree item text;

• ct_type – the tree item kind. May be one of the following integers:

  ct_type Value	Description
  0	A normal item
  1	A checkbox-like item
  2	A radiobutton-type item

• wnd – if not None, a non-toplevel window to be displayed next to the item;

• image – an index within the normal image list specifying the image to use for the item in unselected state;

• selImage – an index within the normal image list specifying the image to use for the item in selected state; if image > -1 and selImage is -1, the same image is used for both selected and unselected items;

• data – associate the given Python object data with the item.

Note

Regarding radiobutton-type items (with ct_type = 2), the following approach is used:

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

---

DeleteChildren(self, tree)

Deletes the item children.

Parameters:

tree – the main TreeListMainWindow instance.

---

DeleteWindow(self, column=None)

Deletes the window associated to the item (if any).

Parameters:

column – if not None, an integer specifying the column index. If it is None, the main column index is used.

---

GetBackgroundColour(self, column=0)

Returns the associated background colour

:param column an integer specifying the column index.

---

GetCurrentImage(self, column=None)

Returns the current item image.

Parameters:

column – if not None, an integer specifying the column index. If it is None, the main column index is used.

---

GetExtents(self, dc=None, column=None)

Calculate text extents of this item using the given ClientDc.

Parameters:

• dc – an instance of wx.DC to use to calculate text extent if it has not been cached yet. The proper font should have been already set in the device context.

• column – The column to get extents for. If it is None, return the width of the main column and maximum height of all the columns (dc is required in this case).

Returns:

A 2-tuple of (width, height). If dc was not provided could return None.

---

GetImage(self, which=wx.TreeItemIcon_Normal, column=None)

Returns the item image for a particular item state.

Parameters:

• which – can be one of the following bits:

  Item State	Description
  TreeItemIcon_Normal	To get the normal item image
  TreeItemIcon_Selected	To get the selected item image (i.e. the image which is shown when the item is currently selected)
  TreeItemIcon_Expanded	To get the expanded image (this only makes sense for items which have children - then this image is shown when the item is expanded and the normal image is shown when it is collapsed)
  TreeItemIcon_SelectedExpanded	To get the selected expanded image (which is shown when an expanded item is currently selected)

• column – if not None, an integer specifying the column index. If it is None, the main column index is used.

Returns:

An integer index that can be used to retrieve the item image inside a wx.ImageList.

---

GetText(self, column=None)

Returns the item text label.

Parameters:

column – if not None, an integer specifying the column index. If it is None, the main column index is used.

---

GetTextX(self)

Returns the x position of the item text.

---

GetWindow(self, column=None)

Returns the window associated to the item.

Parameters:

column – if not None, an integer specifying the column index. If it is None, the main column index is used.

---

GetWindowEnabled(self, column=None)

Returns whether the window associated with an item is enabled or not.

Parameters:

column – if not None, an integer specifying the column index. If it is None, the main column index is used.

---

GetWindows(self)

Returns a list of all associated windows. May be empty list.

---

GetWindowSize(self, column=None)

Returns the associated window size.

Parameters:

column – if not None, an integer specifying the column index. If it is None, the main column index is used.

---

HasExtents(self, column=None)

Returns whether the text extents are calculated for this item.

Parameters:

column – The column to check for extents. If it is None, check that all columns have extents.

Returns:

True if extents are calculated, False otherwise.

---

HitTest(self, point, theCtrl, flags, column, level)

HitTest method for an item. Called from the main window HitTest.

Parameters:

• point – the point to test for the hit (an instance of wx.Point);

• theCtrl – the main TreeListMainWindow tree;

• flags – a bitlist of hit locations;

• column – an integer specifying the column index;

• level – the item’s level inside the tree hierarchy.

See also

TreeListMainWindow.HitTest() method for the flags explanation.

Returns:

A 3-tuple of (item, flags, column). The item may be None.

---

OnSetFocus(self, event)

Handles the wx.EVT_SET_FOCUS event for a window associated to an item.

Parameters:

event – a FocusEvent event to be processed.

---

SetBackgroundColour(self, colour, column=0)

Sets the associated background colour

Parameters:

colour – a valid wx.Colour instance.

:param integer column

---

SetImage(self, column, image, which)

Sets the item image for a particular item state.

Parameters:

• column – if not None, an integer specifying the column index. If it is None, the main column index is used;

• image – an index within the normal image list specifying the image to use;

• which – The item state for which this image applies. One of wx.TreeItemIcon_Xxx. Only valid for the main column.

See also

GetImage for a list of valid item states.

Note

Call SetItemImage instead to refresh the tree properly.

---

SetText(self, column, text)

Sets the item text label.

Parameters:

• column – if not None, an integer specifying the column index. If it is None, the main column index is used;

• text – a string specifying the new item label.

Note

Call SetItemText instead to refresh the tree properly.

---

SetTextX(self, text_x)

Sets the x position of the item text. Used internally to position text according to column alignment.

Parameters:

text_x – the x position of the item text.

---

SetWindow(self, wnd, column=None)

Sets the window associated to the item. Internal use only.

Parameters:

• wnd – a non-toplevel window to be displayed next to the item;

• column – if not None, an integer specifying the column index. If it is None, the main column index is used.

Note

Always use SetItemWindow instead to update the tree properly.

---

SetWindowEnabled(self, enable=True, column=None)

Sets whether the window associated with an item is enabled or not.

Parameters:

• enable – True to enable the associated window, False to disable it;

• column – if not None, an integer specifying the column index. If it is None, the main column index is used.