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

.. highlight:: python



.. _wx.lib.inspection.InspectionTree:

==========================================================================================================================================
|phoenix_title|  **wx.lib.inspection.InspectionTree**
==========================================================================================================================================

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



|

|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>InspectionTree</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.inspection.InspectionTree_inheritance.svg" alt="Inheritance diagram of InspectionTree" 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.inspection.InspectionTree.html" title="All of the widgets in the app, and optionally their sizers, are" alt="" coords="66,466,321,495"/> <area shape="rect" id="node2" href="wx.TreeCtrl.html" title="A tree control presents information as a hierarchy, with items that may be expanded to show further items." alt="" coords="138,389,248,418"/> <area shape="rect" id="node3" href="wx.Control.html" title="This is the base class for a control or 'widget'." alt="" coords="69,313,174,341"/> <area shape="rect" id="node4" href="wx.WithImages.html" title="A mixin class to be used with other classes that use a wx.ImageList." alt="" coords="198,313,335,341"/> <area shape="rect" id="node5" href="wx.Window.html" title="wx.Window  is the base class for all windows and represents any visible object on screen." alt="" coords="66,236,177,265"/> <area shape="rect" id="node6" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="48,159,195,188"/> <area shape="rect" id="node7" href="wx.EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="55,82,188,111"/> <area shape="rect" id="node8" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="5,5,104,34"/> <area shape="rect" id="node9" href="wx.Trackable.html" title="Add-on base class for a trackable object." alt="" coords="128,5,251,34"/> </map> 
   </p>
   </div>

|


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

:class:`wx.TreeCtrl`

|


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

================================================================================ ================================================================================
:meth:`~wx.lib.inspection.InspectionTree.__init__`                               Initialize self.  See help(type(self)) for accurate signature.
:meth:`~wx.lib.inspection.InspectionTree.BuildTree`                              
:meth:`~wx.lib.inspection.InspectionTree.FindWidgetItem`                         Find the tree item for a widget.
:meth:`~wx.lib.inspection.InspectionTree.GetTextForSizer`                        Returns the string to be used in the tree for a sizer
:meth:`~wx.lib.inspection.InspectionTree.GetTextForWidget`                       Returns the string to be used in the tree for a widget
:meth:`~wx.lib.inspection.InspectionTree.OnSelectionChanged`                     
:meth:`~wx.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)

      Initialize self.  See help(type(self)) for accurate signature.


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