.. include:: headings.inc

.. currentmodule:: lib.inspection

.. highlight:: python



.. _lib.inspection._InspectionHighlighter:

==========================================================================================================================================
|phoenix_title|  **_InspectionHighlighter**
==========================================================================================================================================

All the highlighting code.  A separate class to help reduce the
clutter in InspectionFrame.



|

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

Inheritance diagram for class **_InspectionHighlighter**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.inspection._InspectionHighlighter_inheritance.png" alt="Inheritance diagram of _InspectionHighlighter" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node2" href="lib.inspection._InspectionHighlighter.html" title="All the highlighting code.  A separate class to help reduce the" alt="" coords="127,5,388,35"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~lib.inspection._InspectionHighlighter.__init__`                          
:meth:`~lib.inspection._InspectionHighlighter.AdjustRect`                        
:meth:`~lib.inspection._InspectionHighlighter.DoHighlight`                       
:meth:`~lib.inspection._InspectionHighlighter.DoUnhighlight`                     
:meth:`~lib.inspection._InspectionHighlighter.FindHighlightPos`                  
:meth:`~lib.inspection._InspectionHighlighter.FlickerTLW`                        Use a timer to alternate a TLW between shown and hidded state a
:meth:`~lib.inspection._InspectionHighlighter.HighlightCurrentItem`              Draw a highlight rectangle around the item represented by the
:meth:`~lib.inspection._InspectionHighlighter.HighlightSizer`                    
:meth:`~lib.inspection._InspectionHighlighter.HighlightSizerItem`                
:meth:`~lib.inspection._InspectionHighlighter.HighlightWindow`                   
================================================================================ ================================================================================


|


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

.. class:: _InspectionHighlighter(object)

   All the highlighting code.  A separate class to help reduce the
   clutter in InspectionFrame.

   .. method:: __init__(self)


   .. method:: AdjustRect(self, tlw, win,  rect)


   .. method:: DoHighlight(self, tlw, rect, colour, penWidth=2)


   .. method:: DoUnhighlight(self, tlw, rect)


   .. method:: FindHighlightPos(self, tlw, pos)


   .. method:: FlickerTLW(self, tlw)

      Use a timer to alternate a TLW between shown and hidded state a
      few times.  Use to highlight a TLW since drawing and clearing an
      outline is trickier.


   .. method:: HighlightCurrentItem(self, tree)

      Draw a highlight rectangle around the item represented by the
      current tree selection.


   .. method:: HighlightSizer(self, sizer)


   .. method:: HighlightSizerItem(self, item, sizer, penWidth=2)


   .. method:: HighlightWindow(self, win)