.. include:: headings.inc

.. currentmodule:: lib.inspection

.. highlight:: python



.. _lib.inspection.InspectionTool:

==========================================================================================================================================
|phoenix_title|  **InspectionTool**
==========================================================================================================================================

The InspectionTool is a singleton that manages creating and
showing an InspectionFrame.



|

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

Inheritance diagram for class **InspectionTool**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.inspection.InspectionTool_inheritance.png" alt="Inheritance diagram of InspectionTool" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="lib.inspection.InspectionTool.html" title="The InspectionTool is a singleton that manages creating and" alt="" coords="7,5,212,35"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~lib.inspection.InspectionTool.__init__`                                  
:meth:`~lib.inspection.InspectionTool.Init`                                      Init is used to set some parameters that will be used later
:meth:`~lib.inspection.InspectionTool.Show`                                      Creates the inspection frame if it hasn't been already, and
================================================================================ ================================================================================


|


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

.. class:: InspectionTool

   The InspectionTool is a singleton that manages creating and
   showing an InspectionFrame.

   .. method:: __init__(self)


   .. method:: Init(self, pos=DefaultPosition, size=Size(850,700), config=None, locals=None, app=None)

      Init is used to set some parameters that will be used later
      when the inspection tool is shown.  Suitable defaults will be
      used for all of these parameters if they are not provided.
      
      :param pos:   The default position to show the frame at
      :param size:  The default size of the frame
      :param config: A wx.Config object to be used to store layout
          and other info to when the inspection frame is closed.
          This info will be restored the next time the inspection
          frame is used.
      :param locals: A dictionary of names to be added to the PyCrust
          namespace.
      :param app:  A reference to the wx.App object.


   .. method:: Show(self, selectObj=None, refreshTree=False)

      Creates the inspection frame if it hasn't been already, and
      raises it if neccessary.  Pass a widget or sizer in selectObj
      to have that object be preselected in widget tree.  If
      refreshTree is ``True`` then the widget tree will be rebuilt,
      otherwise if the tree has already been built it will be left
      alone.