1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.DirDialog:
==========================================================================================================================================
|phoenix_title| **wx.DirDialog**
==========================================================================================================================================
This class represents the directory chooser dialog.
^^
.. _DirDialog-styles:
|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. 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 :meth:`SetMessage` to change the string displayed to the user at the top of the dialog after creation. The :meth:`SetTitle` method is provided for compatibility with pre-10.11 MacOS versions that do still support displaying the title bar.
.. seealso:: :ref:`DirDialog Overview <dirdialog overview>`, :ref:`wx.FileDialog`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>DirDialog</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.DirDialog_inheritance.png" alt="Inheritance diagram of DirDialog" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.DirDialog.html" title="wx.DirDialog" alt="" coords="55,469,162,499"/> <area shape="rect" id="node2" href="wx.Dialog.html" title="wx.Dialog" alt="" coords="65,392,152,421"/> <area shape="rect" id="node3" href="wx.TopLevelWindow.html" title="wx.TopLevelWindow" alt="" coords="31,315,186,344"/> <area shape="rect" id="node4" href="wx.NonOwnedWindow.html" title="wx.NonOwnedWindow" alt="" coords="25,237,193,267"/> <area shape="rect" id="node5" href="wx.Window.html" title="wx.Window" alt="" coords="60,160,157,189"/> <area shape="rect" id="node6" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="50,83,167,112"/> <area shape="rect" id="node7" href="wx.Object.html" title="wx.Object" alt="" coords="5,5,92,35"/> <area shape="rect" id="node8" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="117,5,223,35"/> </map>
</p>
</div>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.DirDialog.__init__` Constructor.
:meth:`~wx.DirDialog.GetClassDefaultAttributes`
:meth:`~wx.DirDialog.GetMessage` Returns the message that will be displayed on the dialog.
:meth:`~wx.DirDialog.GetPath` Returns the default or user-selected path.
:meth:`~wx.DirDialog.GetPaths` Fills the array `paths` with the full paths of the chosen directories.
:meth:`~wx.DirDialog.SetMessage` Sets the message that will be displayed on the dialog.
:meth:`~wx.DirDialog.SetPath` Sets the default path.
:meth:`~wx.DirDialog.ShowModal` Shows the dialog, returning ``wx.ID_OK`` if the user pressed ``wx.OK``, and ``wx.ID_CANCEL`` otherwise.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.DirDialog.Message` See :meth:`~wx.DirDialog.GetMessage` and :meth:`~wx.DirDialog.SetMessage`
:attr:`~wx.DirDialog.Path` See :meth:`~wx.DirDialog.GetPath` and :meth:`~wx.DirDialog.SetPath`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.DirDialog(Dialog)
**Possible constructors**::
DirDialog(parent, message=DirSelectorPromptStr, defaultPath=EmptyString,
style=DD_DEFAULT_STYLE, pos=DefaultPosition, size=DefaultSize,
name=DirDialogNameStr)
This class represents the directory chooser dialog.
.. method:: __init__(self, parent, message=DirSelectorPromptStr, defaultPath=EmptyString, style=DD_DEFAULT_STYLE, pos=DefaultPosition, size=DefaultSize, name=DirDialogNameStr)
Constructor.
Use :meth:`ShowModal` to show the dialog.
:param `parent`: Parent window.
:type `parent`: wx.Window
:param `message`: Message to show on the dialog.
:type `message`: string
:param `defaultPath`: The default path, or the empty string.
:type `defaultPath`: string
:param `style`: The dialog style. See :ref:`wx.DirDialog`
:type `style`: long
:param `pos`: Dialog position. Ignored under Windows.
:type `pos`: wx.Point
:param `size`: Dialog size. Ignored under Windows.
:type `size`: wx.Size
:param `name`: The dialog name, not used.
:type `name`: string
.. staticmethod:: GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)
:param `variant`:
:type `variant`: wx.WindowVariant
:rtype: :ref:`wx.VisualAttributes`
.. method:: GetMessage(self)
Returns the message that will be displayed on the dialog.
:rtype: `string`
.. method:: GetPath(self)
Returns the default or user-selected path.
:rtype: `string`
.. note::
This function can't be used with dialogs which have the ``DD_MULTIPLE`` style, use :meth:`GetPaths` instead.
.. method:: GetPaths(self, paths)
Fills the array `paths` with the full paths of the chosen directories.
:param `paths`:
:type `paths`: list of strings
.. versionadded:: 4.1/wxWidgets-3.1.4
.. note::
This function should only be used with the dialogs which have ``DD_MULTIPLE`` style, use :meth:`GetPath` for the others.
.. method:: SetMessage(self, message)
Sets the message that will be displayed on the dialog.
:param `message`:
:type `message`: string
.. method:: SetPath(self, path)
Sets the default path.
:param `path`:
:type `path`: string
.. method:: ShowModal(self)
Shows the dialog, returning ``wx.ID_OK`` if the user pressed ``wx.OK``, and ``wx.ID_CANCEL`` otherwise.
:rtype: `int`
.. attribute:: Message
See :meth:`~wx.DirDialog.GetMessage` and :meth:`~wx.DirDialog.SetMessage`
.. attribute:: Path
See :meth:`~wx.DirDialog.GetPath` and :meth:`~wx.DirDialog.SetPath`
|
