.. include:: headings.inc

.. currentmodule:: lib.progressindicator

.. highlight:: python



.. _lib.progressindicator.ProgressIndicator:

==========================================================================================================================================
|phoenix_title|  **ProgressIndicator**
==========================================================================================================================================





|

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

Inheritance diagram for class **ProgressIndicator**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.progressindicator.ProgressIndicator_inheritance.png" alt="Inheritance diagram of ProgressIndicator" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" 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="node6" href="Panel.html" title="A panel is a window on which controls are placed." alt="" coords="525,5,597,35"/> <area shape="rect" id="node2" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="247,5,345,35"/> <area shape="rect" id="node4" 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="node10" href="lib.progressindicator.ProgressIndicator.html" title="progressindicator.ProgressIndicator" alt="" coords="647,5,929,35"/> </map> 
   </p>

|


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

:class:`Panel`

|


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

================================================================================ ================================================================================
:meth:`~lib.progressindicator.ProgressIndicator.__init__`                        
:meth:`~lib.progressindicator.ProgressIndicator.onTimer`                         
:meth:`~lib.progressindicator.ProgressIndicator.SetLabel`                        Set the text displayed in the label.
:meth:`~lib.progressindicator.ProgressIndicator.SetRange`                        For determinante mode (non-pulse) set the max value that the gauge can
:meth:`~lib.progressindicator.ProgressIndicator.SetValue`                        For determinante mode (non-pulse) update the progress indicator to the
:meth:`~lib.progressindicator.ProgressIndicator.Start`                           Show (if necessary) and begin displaying progress
:meth:`~lib.progressindicator.ProgressIndicator.Stop`                            Stop showing progress
================================================================================ ================================================================================


|


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

.. class:: ProgressIndicator(Panel)



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


   .. method:: onTimer(self, evt)


   .. method:: SetLabel(self, text)

      Set the text displayed in the label.


   .. method:: SetRange(self, maxval)

      For determinante mode (non-pulse) set the max value that the gauge can
      be set to. Defaults to 100.


   .. method:: SetValue(self, value, label=None)

      For determinante mode (non-pulse) update the progress indicator to the
      given value. For example, if the job is 45% done then pass 45 to this
      method (as long as the range is still set to 100.)


   .. method:: Start(self, label=None)

      Show (if necessary) and begin displaying progress


   .. method:: Stop(self, clearLabel=False)

      Stop showing progress