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
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.agw.multidirdialog
.. highlight:: python
.. _wx.lib.agw.multidirdialog.MultiDirDialog:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.multidirdialog.MultiDirDialog**
==========================================================================================================================================
A different implementation of :class:`DirDialog` which allows multiple
folders to be selected at once.
|
|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>MultiDirDialog</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.lib.agw.multidirdialog.MultiDirDialog_inheritance.png" alt="Inheritance diagram of MultiDirDialog" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="31,5,132,35"/> <area shape="rect" id="node2" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="83,83,193,112"/> <area shape="rect" id="node4" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="78,160,199,189"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="156,5,237,35"/> <area shape="rect" id="node7" href="wx.Window.html" title="wx.Window" alt="" coords="94,237,183,267"/> <area shape="rect" id="node5" href="wx.lib.agw.multidirdialog.MultiDirDialog.html" title="wx.lib.agw.multidirdialog.MultiDirDialog" alt="" coords="5,547,272,576"/> <area shape="rect" id="node6" href="wx.Dialog.html" title="wx.Dialog" alt="" coords="97,469,179,499"/> <area shape="rect" id="node9" href="wx.NonOwnedWindow.html" title="wx.NonOwnedWindow" alt="" coords="59,315,217,344"/> <area shape="rect" id="node8" href="wx.TopLevelWindow.html" title="wx.TopLevelWindow" alt="" coords="67,392,209,421"/> </map>
</p>
|
|appearance| Control Appearance
===============================
|
.. figure:: _static/images/widgets/fullsize/wxmsw/wx.lib.agw.multidirdialog.multidirdialog.png
:alt: wxMSW
:figclass: floatleft
**wxMSW**
.. figure:: _static/images/widgets/fullsize/wxmac/../no_appearance.png
:alt: wxMAC
:figclass: floatright
**wxMAC**
.. figure:: _static/images/widgets/fullsize/wxgtk/wx.lib.agw.multidirdialog.multidirdialog.png
:alt: wxGTK
:figclass: floatcenter
**wxGTK**
|
|super_classes| Known Superclasses
==================================
:class:`wx.Dialog`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.multidirdialog.MultiDirDialog.__init__` Default class constructor.
:meth:`~wx.lib.agw.multidirdialog.MultiDirDialog.BindEvents` Binds the events to specific methods.
:meth:`~wx.lib.agw.multidirdialog.MultiDirDialog.CreateButtons` Creates the ``OK``, ``Cancel`` and ``Make New Folder`` bitmap buttons.
:meth:`~wx.lib.agw.multidirdialog.MultiDirDialog.GetPaths` Returns the folders selected by the user, or the default path.
:meth:`~wx.lib.agw.multidirdialog.MultiDirDialog.LayoutItems` Layout the widgets using sizers.
:meth:`~wx.lib.agw.multidirdialog.MultiDirDialog.OnCancel` Handles the ``wx.EVT_BUTTON`` event for the dialog.
:meth:`~wx.lib.agw.multidirdialog.MultiDirDialog.OnClose` Handles the ``wx.EVT_CLOSE`` event for the dialog.
:meth:`~wx.lib.agw.multidirdialog.MultiDirDialog.OnKeyUp` Handles the ``wx.EVT_CHAR_HOOK`` event for the dialog.
:meth:`~wx.lib.agw.multidirdialog.MultiDirDialog.OnOk` Handles the ``wx.EVT_BUTTON`` event for the dialog.
:meth:`~wx.lib.agw.multidirdialog.MultiDirDialog.OnSelChanged` Handles the ``wx.EVT_TREE_SEL_CHANGED`` event for the tree control associated
:meth:`~wx.lib.agw.multidirdialog.MultiDirDialog.RecurseTopDir` Recurse a directory tree to include the parent-folder.
:meth:`~wx.lib.agw.multidirdialog.MultiDirDialog.SetProperties` Sets few properties for the dialog.
:meth:`~wx.lib.agw.multidirdialog.MultiDirDialog.SetupDirCtrl` Setup the internal :class:`GenericDirCtrl` (icons, labels, etc...).
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: MultiDirDialog(wx.Dialog)
A different implementation of :class:`DirDialog` which allows multiple
folders to be selected at once.
.. method:: __init__(self, parent, message=_("Choose one or more folders:"), title=_("Browse For Folders"), defaultPath="", style=wx.DD_DEFAULT_STYLE, agwStyle=DD_MULTIPLE, pos=wx.DefaultPosition, size=wx.DefaultSize, name="multidirdialog")
Default class constructor.
:param `parent`: the dialog parent widget;
:param `message`: the message to show on the dialog;
:param `title`: the dialog title;
:param `defaultPath`: the default path, or the empty string;
:param `style`: the underlying :class:`Dialog` window style;
:param `agwStyle`: the AGW-specific dialog style; this can be a combination of the
following bits:
===================== =========== ==================================================
Window Styles Hex Value Description
===================== =========== ==================================================
``DD_NEW_DIR_BUTTON`` 0x080 Enable/disable the "Make new folder" button
``DD_DIR_MUST_EXIST`` 0x200 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.
``DD_MULTIPLE`` 0x400 Allows the selection of multiple folders.
===================== =========== ==================================================
:param `pos`: the dialog position;
:param `size`: the dialog size;
:param `name`: the dialog name.
.. method:: BindEvents(self)
Binds the events to specific methods.
.. method:: CreateButtons(self)
Creates the ``OK``, ``Cancel`` and ``Make New Folder`` bitmap buttons.
.. method:: GetPaths(self)
Returns the folders selected by the user, or the default path.
.. method:: LayoutItems(self, message)
Layout the widgets using sizers.
.. method:: OnCancel(self, event)
Handles the ``wx.EVT_BUTTON`` event for the dialog.
:param `event`: a :class:`CommandEvent` event to be processed.
:note: This method handles the ``Cancel`` button press.
.. method:: OnClose(self, event)
Handles the ``wx.EVT_CLOSE`` event for the dialog.
:param `event`: a :class:`CloseEvent` event to be processed.
.. method:: OnKeyUp(self, event)
Handles the ``wx.EVT_CHAR_HOOK`` event for the dialog.
:param `event`: a :class:`KeyEvent` event to be processed.
.. method:: OnOk(self, event)
Handles the ``wx.EVT_BUTTON`` event for the dialog.
:param `event`: a :class:`CommandEvent` event to be processed.
:note: This method handles the ``OK`` button press.
.. method:: OnSelChanged(self, event)
Handles the ``wx.EVT_TREE_SEL_CHANGED`` event for the tree control associated
with :class:`MultiDirDialog`.
:param `event`: a :class:`TreeEvent` event to be processed.
.. method:: RecurseTopDir(self, treeCtrl, item, itemText)
Recurse a directory tree to include the parent-folder.
:param `treeCtrl`: the tree control associated with teh internal :class:`GenericDirCtrl`;
:param `item`: the selected tree control item;
:param `itemText`: the selected tree control item text.
.. method:: SetProperties(self, title)
Sets few properties for the dialog.
:param `title`: the dialog title.
.. method:: SetupDirCtrl(self, defaultPath)
Setup the internal :class:`GenericDirCtrl` (icons, labels, etc...).
:param `defaultPath`: the default path for :class:`MultiDirDialog`, can be an
empty string.
|
