*****************
wx.ProgressDialog
*****************

Inheritance diagram for `wx.ProgressDialog`:

|

.. inheritance-diagram:: wx.ProgressDialog

|

Description
===========

This class represents a dialog that shows a short message and a progress bar. Optionally, it can display ``ABORT`` and ``SKIP`` buttons, the elapsed, 
remaining and estimated time for the end of the progress.


Derived From
^^^^^^^^^^^^^

* `wx.Dialog <wx.Dialog.html>`_ 
* `wx.Window <wx.Window.html>`_ 
* `wx.EvtHandler <wx.EvtHandler.html>`_ 
* `wx.Object <wx.Object.html>`_ 


Window Styles
^^^^^^^^^^^^^

==================================================  ==================================================  
Window Style                                        Description
==================================================  ==================================================  
``wx.PD_APP_MODAL``                                 Make the progress dialog modal. If this flag is not given, it is only "locally" modal - that is the input to the parent window is disabled, but not to the other ones.
``wx.PD_AUTO_HIDE``                                 Causes the progress dialog to disappear from screen as soon as the maximum value of the progress meter has been reached.
``wx.PD_SMOOTH``                                    Causes smooth progress of the gauge control.
``wx.PD_CAN_ABORT``                                 This flag tells the dialog that it should have a ``Cancel`` button which the user may press. If this happens, the next call to `Update <#Update>`_ will return ``False``.
``wx.PD_CAN_SKIP``                                  This flag tells the dialog that it should have a ``Skip`` button which the user may press. If this happens, the next call to `Update <#Update>`_ will return ``True`` in its skip parameter.
``wx.PD_ELAPSED_TIME``                              This flag tells the dialog that it should show elapsed time (since creating the dialog).
``wx.PD_ESTIMATED_TIME``                            This flag tells the dialog that it should show estimated time.
``wx.PD_REMAINING_TIME``                            This flag tells the dialog that it should show remaining time.
==================================================  ==================================================  


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `Pulse <#Pulse>`_ 
* `Resume <#Resume>`_ 
* `Update <#Update>`_ 


Class API
=========

Methods
^^^^^^^


.. method:: __init__(title, message, maximum=100, parent=None, style=wx.PD_AUTO_HIDE|wx.PD_APP_MODAL)

   Constructor. Creates the dialog, displays it and disables user input
   for other windows, or, if ``wx.PD_APP_MODAL`` flag is not given, for its
   parent window only.
   
   **Parameters:**

   * `title` (string)
   * `message` (string)
   * `maximum` (int)
   * `parent` (`wx.Window <wx.Window.html>`_)
   * `style` (int)

   |

   **Returns:**

   `wx.ProgressDialog <wx.ProgressDialog.html>`_
 

--------

.. method:: Pulse()

   Just like `Update <#Update>`_ but makes the gauge control run in indeterminate mode (see `wx.Gauge <wx.Gauge.html>`_ documentation), 
   sets the remaining and the estimated time labels (if present) to *Unknown* and moves the progress bar a bit to indicate that some progress was done.

   |  

   **Returns:**

   `bool` 

--------

.. method:: Resume()

   Can be used to continue with the dialog, after the user had chosen ``ABORT``.


--------

.. method:: Update(value, newmsg="")

   Updates the dialog, setting the progress bar to the new value and, if
   given changes the message above it. The value given should be less
   than or equal to the maximum value given to the constructor and the
   dialog is closed if it is equal to the maximum.  Returns a tuple of
   boolean values, (`continue`, `skip`) where `continue` is ``True``
   unless the ``Cancel`` button has been pressed, and `skip` is `False`
   unless the ``Skip`` button (if any) has been pressed.
    
   If the `continue` return value is ``False``, the application can either
   immediately destroy the dialog or ask the user for confirmation, and if the
   abort is not confirmed the dialog may be resumed with `Resume <#Resume>`_ function.

   **Parameters:**

   * `value` (int): The new value of the progress meter. It should be less than or equal to the maximum value given to 
     the constructor and the dialog is closed if it is equal to the maximum.
   * `newmsg` (string): The new messages for the progress dialog text, if it is empty (which is the default) the message is not changed.

   |  

   **Returns:**

   `(continue, skip)`