**********************
wx.PasswordEntryDialog
**********************

Inheritance diagram for `wx.PasswordEntryDialog`:

|

.. inheritance-diagram:: wx.PasswordEntryDialog

|

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

This class represents a dialog that requests a one-line password string from the user. It is implemented as a generic wxWidgets dialog.


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

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


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

* `__init__ <#__init__>`_ 
* `ShowModal <#ShowModal>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(parent, message, caption=wx.GetPasswordFromUserPromptStr, value="", style=wx.TextEntryDialogStyle, pos=wx.DefaultPosition)

   Constructor. Use the `ShowModal <#ShowModal>`_ method to show the dialog.

   **Parameters:**

   * `parent` (`wx.Window <wx.Window.html>`_): The parent window.
   * `message` (string): Message to show on the dialog.
   * `caption` (string): The dialog title.
   * `value` (string): The default value, which may be the empty string.
   * `style` (long): A dialog style, specifying the buttons (``wx.OK``, ``wx.CANCEL``) and an optional ``wx.CENTRE`` style. 
     You do not need to specify the ``wx.TE_PASSWORD`` style, it is always applied.
   * `pos` (`wx.Point <wx.Point.html>`_): The dialog position.

   |

   **Returns:**

   `wx.PasswordEntryDialog <wx.PasswordEntryDialog.html>`_

-----------

.. method:: ShowModal()

   Shows the dialog, returning one of ``wx.ID_OK`` or ``wx.ID_CANCEL``.

   |

   **Returns:**

   `int`