.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2020 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc

.. currentmodule:: wx.lib.mixins.treemixin

.. highlight:: python



.. _wx.lib.mixins.treemixin.TreeHelper:

==========================================================================================================================================
|phoenix_title|  **wx.lib.mixins.treemixin.TreeHelper**
==========================================================================================================================================

This class provides methods that are not part of the API of any
tree control, but are convenient to have available. 



|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>TreeHelper</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.lib.mixins.treemixin.TreeHelper_inheritance.png" alt="Inheritance diagram of TreeHelper" usemap="#dummy" class="inheritance"/></center>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.mixins.treemixin.TreeHelper.html" title="wx.lib.mixins.treemixin.TreeHelper" alt="" coords="5,5,256,35"/> </map> 
   </p>
   </div>

|


|sub_classes| Known Subclasses
==============================

:class:`wx.lib.mixins.treemixin.DragAndDrop`, :class:`wx.lib.mixins.treemixin.ExpansionState`, :class:`wx.lib.mixins.treemixin.VirtualTree`

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.lib.mixins.treemixin.TreeHelper.GetIndexOfItem`                       Return the index of item.
:meth:`~wx.lib.mixins.treemixin.TreeHelper.GetItemByIndex`                       Return the item specified by index.
:meth:`~wx.lib.mixins.treemixin.TreeHelper.GetItemChildren`                      Return the children of item as a list.
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: TreeHelper(object)

   This class provides methods that are not part of the API of any
   tree control, but are convenient to have available. 

   .. method:: GetIndexOfItem(self, item)

      Return the index of item. 


   .. method:: GetItemByIndex(self, index)

      Return the item specified by index. 


   .. method:: GetItemChildren(self, item=None, recursively=False)

      Return the children of item as a list. 


