.. include:: headings.inc



.. _TreeItemId:

==========================================================================================================================================
|phoenix_title|  **TreeItemId**
==========================================================================================================================================

An opaque reference to a tree item.          







         



.. seealso:: :ref:`TreeCtrl`, `TreeItemData`, :ref:`TreeCtrl Overview <treectrl overview>`    







|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **TreeItemId**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/TreeItemId_inheritance.png" alt="Inheritance diagram of TreeItemId" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="TreeItemId.html" title="An opaque reference to a tree item." alt="" coords="7,5,105,35"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~TreeItemId.__init__`                                                     Default constructor.
:meth:`~TreeItemId.GetID`                                                        
:meth:`~TreeItemId.IsOk`                                                         Returns ``True`` if this instance is referencing a valid tree item.
:meth:`~TreeItemId.Unset`                                                        
:meth:`~TreeItemId.__nonzero__`                                                  
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~TreeItemId.ID`                                                           See :meth:`~TreeItemId.GetID`
================================================================================ ================================================================================


|


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

.. class:: TreeItemId(object)

   An opaque reference to a tree item.
   
   **Possible constructors**::

       TreeItemId()
       



   .. method:: __init__(self)

      Default constructor.                  

      A :ref:`TreeItemId`  is not meant to be constructed explicitly by the user; only those returned by the :ref:`TreeCtrl`  functions should be used.                   





   .. method:: GetID(self)






   .. method:: IsOk(self)

      Returns ``True`` if this instance is referencing a valid tree item.                  

      :rtype: `bool`








   .. method:: Unset(self)






   .. method:: __nonzero__(self)



      :rtype: `int`








   .. attribute:: ID

      See :meth:`~TreeItemId.GetID`