Navigation

Phoenix Logo

phoenix_title 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 Class Hierarchy

Inheritance diagram for class TreeListItem:


method_summary Methods Summary

__init__ Default class constructor.
DeleteChildren Deletes the item children.
DeleteWindow Deletes the window associated to the item (if any).
GetCurrentImage Returns the current item image.
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.
GetWindowSize Returns the associated window size.
Hide Hides/shows the TreeListItem.
HitTest HitTest method for an item. Called from the main window HitTest.
IsEnabled Returns whether the item is enabled or not.
IsExpanded Returns whether the item is expanded or not.
IsHidden Returns whether the item is hidden or not.
OnSetFocus Handles the wx.EVT_SET_FOCUS event for a window associated to an item.
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.

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

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.

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.

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.

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.

Hide(self, hide)

Hides/shows the TreeListItem.

Parameters:hide – True to hide the item, False to show it.

Note

Always use HideItem instead to update the tree properly.


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.


IsEnabled(self)

Returns whether the item is enabled or not.

Returns:True if the item is enabled, False if it is disabled or hidden.

IsExpanded(self)

Returns whether the item is expanded or not.

Returns:True if the item is expanded, False if it is collapsed or hidden.

IsHidden(self)

Returns whether the item is hidden or not.


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.

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.

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.