************
wx.DirDialog
************

Inheritance diagram for `wx.DirDialog`:

|

.. inheritance-diagram:: wx.DirDialog

|

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

This class represents the directory chooser dialog.


.. note:: on Windows the new directory button is only available with recent versions of the common dialogs.

.. seealso:: `wx.FileDialog <wx.FileDialog.html>`_


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.DD_DEFAULT_STYLE``                             Equivalent to a combination of ``wx.DEFAULT_DIALOG_STYLE`` and ``wx.RESIZE_BORDER`` (the last one is not used under wxWinCE). 
``wx.DD_DIR_MUST_EXIST``                            The dialog will allow the user to choose only an existing folder. When this style is not given, a "Create new directory" button is added to the dialog (on Windows) or some other way is provided to the user to type the name of a new folder.  
``wx.DD_CHANGE_DIR``                                Change the current working directory to the directory chosen by the user.  
==================================================  ==================================================  


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

* `__init__ <#__init__>`_ 
* `GetMessage <#GetMessage>`_ 
* `GetPath <#GetPath>`_ 
* `SetMessage <#SetMessage>`_ 
* `SetPath <#SetPath>`_ 
* `ShowModal <#ShowModal>`_ 


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

* `Message <#Message>`_ 
* `Path <#Path>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(parent, message=wx.DirSelectorPromptStr, defaultPath="", style=wx.DD_DEFAULT_STYLE, pos=wx.DefaultPosition, size=wx.DefaultSize, name=wx.DirDialogNameStr)

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

   * `parent` (`wx.Window <wx.Window.html>`_)
   * `message` (string)
   * `defaultPath` (string)
   * `style` (long)
   * `pos` (`wx.Point <wx.Point.html>`_)
   * `size` (`wx.Size <wx.Size.html>`_)
   * `name` (string)

   |

   **Returns:**

   `wx.DirDialog <wx.DirDialog.html>`_
 

--------

.. method:: GetMessage()

   Returns the message that will be displayed on the dialog.

   |  

   **Returns:**

   `string` 

--------

.. method:: GetPath()

   Returns the default or user-selected path.

   |  

   **Returns:**

   `string` 

--------

.. method:: SetMessage(message)

   Sets the message that will be displayed on the dialog.

   **Parameters:**

   * `message` (string) 

--------

.. method:: SetPath(path)

   Sets the default path.

   **Parameters:**

   * `path` (string) 

--------

.. method:: ShowModal()

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

   |

   **Returns:**

   `int`

--------

Properties
^^^^^^^^^^


.. attribute:: Message

   See `GetMessage <#GetMessage>`_ and `SetMessage <#SetMessage>`_

.. attribute:: Path

   See `GetPath <#GetPath>`_ and `SetPath <#SetPath>`_