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

.. highlight:: python



.. _wx.lib.progressindicator.ProgressIndicator:

==========================================================================================================================================
|phoenix_title|  **wx.lib.progressindicator.ProgressIndicator**
==========================================================================================================================================

Panel() -> None
Panel(parent : Window, id: int=ID_ANY, pos: Point=DefaultPosition, size: Size=DefaultSize, style: int=TAB_TRAVERSAL, name: str=PanelNameStr) -> None

A panel is a window on which controls are placed.



|

|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>ProgressIndicator</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.progressindicator.ProgressIndicator_inheritance.svg" alt="Inheritance diagram of ProgressIndicator" 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.progressindicator.ProgressIndicator.html" title="Panel() -> None" alt="" coords="5,389,330,418"/> <area shape="rect" id="node2" href="wx.Panel.html" title="A panel is a window on which controls are placed." alt="" coords="120,313,215,341"/> <area shape="rect" id="node3" href="wx.Window.html" title="wx.Window  is the base class for all windows and represents any visible object on screen." alt="" coords="112,236,223,265"/> <area shape="rect" id="node4" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="94,159,242,188"/> <area shape="rect" id="node5" href="wx.EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="101,82,234,111"/> <area shape="rect" id="node6" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="52,5,150,34"/> <area shape="rect" id="node7" href="wx.Trackable.html" title="Add-on base class for a trackable object." alt="" coords="174,5,297,34"/> </map> 
   </p>
   </div>

|


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

:class:`wx.Panel`

|


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

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


|


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


.. class:: ProgressIndicator(wx.Panel)

   Panel() -> None
   Panel(parent : Window, id: int=ID_ANY, pos: Point=DefaultPosition, size: Size=DefaultSize, style: int=TAB_TRAVERSAL, name: str=PanelNameStr) -> None
   
   A panel is a window on which controls are placed.

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

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


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