wx.lib.combotreebox.IterableTreeCtrl¶

TreeCtrl is the same as TreeCtrl, with a few convenience methods added for easier navigation of items.

Class Hierarchy¶

Inheritance diagram for class IterableTreeCtrl:

Known Superclasses¶

wx.TreeCtrl

Methods Summary¶

`GetFirstItem`	Returns the very first item in the tree. This is the root item
`GetLastChildRecursively`	Returns the last child of the last child ... of item. If item
`GetNextItem`	Returns the item that is on the line immediately below item
`GetNextSiblingRecursively`	Returns the next sibling of item if it has one. If item has no
`GetPreviousItem`	Returns the item that is on the line immediately above item
`GetSelection`	Extend GetSelection to never return the root item if the

Class API¶

class IterableTreeCtrl(wx.TreeCtrl)¶

TreeCtrl is the same as TreeCtrl, with a few convenience methods added for easier navigation of items.

Methods¶

GetFirstItem(self)¶

Returns the very first item in the tree. This is the root item unless the root item is hidden. In that case the first child of the root item is returned, if any. If the tree is empty, an invalid tree item is returned.

Returns:	`TreeItemId`
Return type:	`TreeItemId`

GetLastChildRecursively(self, item)¶

Returns the last child of the last child ... of item. If item has no children, item itself is returned. So the returned item is always valid, assuming a valid item has been passed.

Parameters:	item (TreeItemId) – a `TreeItemId`
Returns:	`TreeItemId` of the last item or an invalid item
Return type:	`TreeItemId`

GetNextItem(self, item)¶

Returns the item that is on the line immediately below item (as is displayed when the tree is fully expanded). The returned item is invalid if item is the last item in the tree.

Parameters:	item (TreeItemId) – a `TreeItemId`
Returns:	`TreeItemId` of the next item or an invalid item
Return type:	`TreeItemId`

GetNextSiblingRecursively(self, item)¶

Returns the next sibling of item if it has one. If item has no next sibling the next sibling of the parent of item is returned. If the parent has no next sibling the next sibling of the parent of the parent is returned, etc. If none of the ancestors of item has a next sibling, an invalid item is returned.

Parameters:	item (TreeItemId) – a `TreeItemId`
Returns:	`TreeItemId` of the next item or an invalid item
Return type:	`TreeItemId`

GetPreviousItem(self, item)¶

Returns the item that is on the line immediately above item (as is displayed when the tree is fully expanded). The returned item is invalid if item is the first item in the tree.

Parameters:	item (TreeItemId) – a `TreeItemId`
Returns:	the `TreeItemId` previous to the one passed in or an invalid item
Return type:	`TreeItemId`

GetSelection(self)¶: Extend GetSelection to never return the root item if the root item is hidden.

Navigation