wx.DirDialog¶This class represents the directory chooser dialog.
^^
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. 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 ^^
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¶
Inheritance diagram for class DirDialog:
Control Appearance¶
wxMSW¶
wxMAC¶
wxGTK¶
Methods Summary¶Constructor. |
|
Returns the message that will be displayed on the dialog. |
|
Returns the default or user-selected path. |
|
Fills the array paths with the full paths of the chosen directories. |
|
Sets the message that will be displayed on the dialog. |
|
Sets the default path. |
|
Shows the dialog, returning |
Properties Summary¶See |
|
Class API¶
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.
__init__(self, parent, message=DirSelectorPromptStr, defaultPath="", style=DD_DEFAULT_STYLE, pos=DefaultPosition, size=DefaultSize, name=DirDialogNameStr)¶Constructor.
Use ShowModal to show the dialog.
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.
GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)¶variant (WindowVariant) –
GetMessage(self)¶Returns the message that will be displayed on the dialog.
string
GetPath(self)¶Returns the default or user-selected path.
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.
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.
message (string) –
SetPath(self, path)¶Sets the default path.
path (string) –
ShowModal(self)¶Shows the dialog, returning wx.ID_OK if the user pressed wx.OK, and wx.ID_CANCEL otherwise.
int
Message¶See GetMessage and SetMessage