******************
wx.TextEntryDialog
******************

Inheritance diagram for `wx.TextEntryDialog`:

|

.. inheritance-diagram:: wx.TextEntryDialog

|

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

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


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

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


Known Subclasses
^^^^^^^^^^^^^^^^

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

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

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


Properties Summary
^^^^^^^^^^^^^^^^^^

* `Value <#Value>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(parent, message, caption="Please enter text", defaultValue="", style=wx.OK|wx.CANCEL|wx.CENTRE, pos=wx.DefaultPosition)

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

   * `parent` (`wx.Window <wx.Window.html>`_)
   * `message` (string)
   * `caption` (string)
   * `defaultValue` (string)
   * `style` (long)
   * `pos` (`wx.Point <wx.Point.html>`_)

   |

   **Returns:**

   `wx.TextEntryDialog <wx.TextEntryDialog.html>`_
 

--------

.. method:: GetValue()

   Returns the text that the user has entered if the user has pressed ``OK``, or the original value if the user has pressed ``Cancel``.

   |  

   **Returns:**

   `string` 

--------

.. method:: SetValue(value)

   Sets the default text value.

   **Parameters:**

   * `value` (string) 

--------

.. method:: ShowModal()

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

   |

   **Returns:**

   `int`

--------

Properties
^^^^^^^^^^


.. attribute:: Value

   See `GetValue <#GetValue>`_ and `SetValue <#SetValue>`_