phoenix_title wx.DirDialog

This class represents the directory chooser dialog.

styles Window Styles

This class supports the following styles:

  • wx.DD_DEFAULT_STYLE: Equivalent to a combination of wx.DEFAULT_DIALOG_STYLE and wx.RESIZE_BORDER.

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

    Note

    This flag cannot be used with the DD_MULTIPLE style.

  • wx.DD_MULTIPLE: Allow the user to select multiple directories. This flag is only available since wxWidgets 3.1.4

  • wx.DD_SHOW_HIDDEN: Show hidden and system folders. This flag is only available since wxWidgets 3.1.4

Notice that

RESIZE_BORDER has special side effect under Windows where two different directory selection dialogs are available and this style also implicitly selects the new version as the old one always has fixed size. As the new version is almost always preferable, it is recommended that RESIZE_BORDER style be always used. This is the case if the dialog is created with the default style value but if you need to use any additional styles you should still specify DD_DEFAULT_STYLE unless you explicitly need to use the old dialog version under Windows. E.g. do

dlg = wx.DirDialog (None, "Choose input directory", "",
                    wx.DD_DEFAULT_STYLE | wx.DD_DIR_MUST_EXIST)

instead of just using DD_DIR_MUST_EXIST style alone.

Note

MacOS 10.11+ does not display a title bar on the dialog. Use SetMessage to change the string displayed to the user at the top of the dialog after creation. The SetTitle method is provided for compatibility with pre-10.11 MacOS versions that do still support displaying the title bar.


class_hierarchy Class Hierarchy

Inheritance diagram for class DirDialog:

appearance Control Appearance


wxMSW

wxMSW

wxMAC

wxMAC

wxGTK

wxGTK


method_summary Methods Summary

__init__

Constructor.

GetClassDefaultAttributes

GetMessage

Returns the message that will be displayed on the dialog.

GetPath

Returns the default or user-selected path.

GetPaths

Fills the array paths with the full paths of the chosen directories.

SetMessage

Sets the message that will be displayed on the dialog.

SetPath

Sets the default path.

ShowModal

Shows the dialog, returning wx.ID_OK if the user pressed wx.OK, and wx.ID_CANCEL otherwise.


property_summary Properties Summary

Message

See GetMessage and SetMessage

Path

See GetPath and SetPath


api Class API

class wx.DirDialog(Dialog)

Possible constructors:

DirDialog(parent, message=DirSelectorPromptStr, defaultPath="",
          style=DD_DEFAULT_STYLE, pos=DefaultPosition, size=DefaultSize,
          name=DirDialogNameStr)

This class represents the directory chooser dialog.


Methods

__init__(self, parent, message=DirSelectorPromptStr, defaultPath="", style=DD_DEFAULT_STYLE, pos=DefaultPosition, size=DefaultSize, name=DirDialogNameStr)

Constructor.

Use ShowModal to show the dialog.

Parameters
  • parent (wx.Window) – Parent window.

  • message (string) – Message to show on the dialog.

  • defaultPath (string) – The default path, or the empty string.

  • style (long) – The dialog style. See wx.DirDialog

  • pos (wx.Point) – Dialog position. Ignored under Windows.

  • size (wx.Size) – Dialog size. Ignored under Windows.

  • name (string) – The dialog name, not used.



static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)
Parameters

variant (WindowVariant) –

Return type

wx.VisualAttributes



GetMessage(self)

Returns the message that will be displayed on the dialog.

Return type

string



GetPath(self)

Returns the default or user-selected path.

Return type

string

Note

This function can’t be used with dialogs which have the DD_MULTIPLE style, use GetPaths instead.



GetPaths(self, paths)

Fills the array paths with the full paths of the chosen directories.

Parameters

paths (list of strings) –

New in version 4.1/wxWidgets-3.1.4.

Note

This function should only be used with the dialogs which have DD_MULTIPLE style, use GetPath for the others.



SetMessage(self, message)

Sets the message that will be displayed on the dialog.

Parameters

message (string) –



SetPath(self, path)

Sets the default path.

Parameters

path (string) –



ShowModal(self)

Shows the dialog, returning wx.ID_OK if the user pressed wx.OK, and wx.ID_CANCEL otherwise.

Return type

int


Properties

Message

See GetMessage and SetMessage



Path

See GetPath and SetPath