.. include:: headings.inc

.. currentmodule:: lib.inspection

.. highlight:: python



.. _lib.inspection.InspectionTree:

==========================================================================================================================================
|phoenix_title|  **InspectionTree**
==========================================================================================================================================

All of the widgets in the app, and optionally their sizers, are
loaded into this tree.



|

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

Inheritance diagram for class **InspectionTree**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.inspection.InspectionTree_inheritance.png" alt="Inheritance diagram of InspectionTree" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Control.html" title="This is the base class for a control or 'widget'." alt="" coords="525,5,600,35"/> <area shape="rect" id="node8" href="TreeCtrl.html" title="A tree control presents information as a hierarchy, with items that may be expanded to show further items." alt="" coords="648,5,728,35"/> <area shape="rect" id="node2" href="Window.html" title="Window  is the base class for all windows and represents any visible object on screen." alt="" coords="396,5,476,35"/> <area shape="rect" id="node4" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="247,5,345,35"/> <area shape="rect" id="node6" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="125,5,197,35"/> <area shape="rect" id="node12" href="lib.inspection.InspectionTree.html" title="All of the widgets in the app, and optionally their sizers, are" alt="" coords="777,5,985,35"/> </map> 
   </p>

|


|super_classes| Known Superclasses
==================================

:class:`TreeCtrl`

|


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

================================================================================ ================================================================================
:meth:`~lib.inspection.InspectionTree.__init__`                                  
:meth:`~lib.inspection.InspectionTree.BuildTree`                                 
:meth:`~lib.inspection.InspectionTree.FindWidgetItem`                            Find the tree item for a widget.
:meth:`~lib.inspection.InspectionTree.GetTextForSizer`                           Returns the string to be used in the tree for a sizer
:meth:`~lib.inspection.InspectionTree.GetTextForWidget`                          Returns the string to be used in the tree for a widget
:meth:`~lib.inspection.InspectionTree.OnSelectionChanged`                        
:meth:`~lib.inspection.InspectionTree.SelectObj`                                 
================================================================================ ================================================================================


|


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

.. class:: InspectionTree(TreeBaseClass)

   All of the widgets in the app, and optionally their sizers, are
   loaded into this tree.

   .. method:: __init__(self, \*args, \*\*kw)


   .. method:: BuildTree(self, startWidget, includeSizers=False, expandFrame=False)


   .. method:: FindWidgetItem(self, widget)

      Find the tree item for a widget.


   .. method:: GetTextForSizer(self, sizer)

      Returns the string to be used in the tree for a sizer


   .. method:: GetTextForWidget(self, widget)

      Returns the string to be used in the tree for a widget


   .. method:: OnSelectionChanged(self, evt)


   .. method:: SelectObj(self, obj)