Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.E5Gui.E5FileDialog.html

eric6/Documentation/Source/eric6.E5Gui.E5FileDialog.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7232
0b840f7ed593
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.E5Gui.E5FileDialog</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.E5Gui.E5FileDialog</h1>
23 <p>
24 Module implementing alternative functions for the QFileDialog static methods
25 to cope with distributor's usage of KDE wrapper dialogs for Qt file dialogs.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>DontConfirmOverwrite</td></tr><tr><td>DontResolveSymlinks</td></tr><tr><td>DontUseNativeDialog</td></tr><tr><td>DontUseSheet</td></tr><tr><td>HideNameFilterDetails</td></tr><tr><td>Option</td></tr><tr><td>Options</td></tr><tr><td>ReadOnly</td></tr><tr><td>ShowDirsOnly</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr><td>None</td></tr>
34 </table>
35 <h3>Functions</h3>
36 <table>
37 <tr>
38 <td><a href="#__reorderFilter">__reorderFilter</a></td>
39 <td>Private function to reorder the file filter to cope with a KDE issue introduced by distributor's usage of KDE file dialogs.</td>
40 </tr><tr>
41 <td><a href="#getExistingDirectory">getExistingDirectory</a></td>
42 <td>Module function to get the name of a directory.</td>
43 </tr><tr>
44 <td><a href="#getOpenFileName">getOpenFileName</a></td>
45 <td>Module function to get the name of a file for opening it.</td>
46 </tr><tr>
47 <td><a href="#getOpenFileNameAndFilter">getOpenFileNameAndFilter</a></td>
48 <td>Module function to get the name of a file for opening it and the selected file name filter.</td>
49 </tr><tr>
50 <td><a href="#getOpenFileNames">getOpenFileNames</a></td>
51 <td>Module function to get a list of names of files for opening.</td>
52 </tr><tr>
53 <td><a href="#getOpenFileNamesAndFilter">getOpenFileNamesAndFilter</a></td>
54 <td>Module function to get a list of names of files for opening and the selected file name filter.</td>
55 </tr><tr>
56 <td><a href="#getSaveFileName">getSaveFileName</a></td>
57 <td>Module function to get the name of a file for saving it.</td>
58 </tr><tr>
59 <td><a href="#getSaveFileNameAndFilter">getSaveFileNameAndFilter</a></td>
60 <td>Module function to get the name of a file for saving it and the selected file name filter.</td>
61 </tr>
62 </table>
63 <hr /><hr />
64 <a NAME="__reorderFilter" ID="__reorderFilter"></a>
65 <h2>__reorderFilter</h2>
66 <b>__reorderFilter</b>(<i>filterStr, initialFilter=""</i>)
67 <p>
68 Private function to reorder the file filter to cope with a KDE issue
69 introduced by distributor's usage of KDE file dialogs.
70 </p><dl>
71 <dt><i>filterStr</i></dt>
72 <dd>
73 Qt file filter (string)
74 </dd><dt><i>initialFilter</i></dt>
75 <dd>
76 initial filter (string)
77 </dd>
78 </dl><dl>
79 <dt>Returns:</dt>
80 <dd>
81 the rearranged Qt file filter (string)
82 </dd>
83 </dl>
84 <div align="right"><a href="#top">Up</a></div>
85 <hr /><hr />
86 <a NAME="getExistingDirectory" ID="getExistingDirectory"></a>
87 <h2>getExistingDirectory</h2>
88 <b>getExistingDirectory</b>(<i>parent=None, caption="", directory="", options=QFileDialog.ShowDirsOnly</i>)
89 <p>
90 Module function to get the name of a directory.
91 </p><dl>
92 <dt><i>parent</i></dt>
93 <dd>
94 parent widget of the dialog (QWidget)
95 </dd><dt><i>caption</i></dt>
96 <dd>
97 window title of the dialog (string)
98 </dd><dt><i>directory</i></dt>
99 <dd>
100 working directory of the dialog (string)
101 </dd><dt><i>options</i></dt>
102 <dd>
103 various options for the dialog (QFileDialog.Options)
104 </dd>
105 </dl><dl>
106 <dt>Returns:</dt>
107 <dd>
108 name of selected directory (string)
109 </dd>
110 </dl>
111 <div align="right"><a href="#top">Up</a></div>
112 <hr /><hr />
113 <a NAME="getOpenFileName" ID="getOpenFileName"></a>
114 <h2>getOpenFileName</h2>
115 <b>getOpenFileName</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
116 <p>
117 Module function to get the name of a file for opening it.
118 </p><dl>
119 <dt><i>parent</i></dt>
120 <dd>
121 parent widget of the dialog (QWidget)
122 </dd><dt><i>caption</i></dt>
123 <dd>
124 window title of the dialog (string)
125 </dd><dt><i>directory</i></dt>
126 <dd>
127 working directory of the dialog (string)
128 </dd><dt><i>filterStr</i></dt>
129 <dd>
130 filter string for the dialog (string)
131 </dd><dt><i>options</i></dt>
132 <dd>
133 various options for the dialog (QFileDialog.Options)
134 </dd>
135 </dl><dl>
136 <dt>Returns:</dt>
137 <dd>
138 name of file to be opened (string)
139 </dd>
140 </dl>
141 <div align="right"><a href="#top">Up</a></div>
142 <hr /><hr />
143 <a NAME="getOpenFileNameAndFilter" ID="getOpenFileNameAndFilter"></a>
144 <h2>getOpenFileNameAndFilter</h2>
145 <b>getOpenFileNameAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>)
146 <p>
147 Module function to get the name of a file for opening it and the selected
148 file name filter.
149 </p><dl>
150 <dt><i>parent</i></dt>
151 <dd>
152 parent widget of the dialog (QWidget)
153 </dd><dt><i>caption</i></dt>
154 <dd>
155 window title of the dialog (string)
156 </dd><dt><i>directory</i></dt>
157 <dd>
158 working directory of the dialog (string)
159 </dd><dt><i>filterStr</i></dt>
160 <dd>
161 filter string for the dialog (string)
162 </dd><dt><i>initialFilter</i></dt>
163 <dd>
164 initial filter for the dialog (string)
165 </dd><dt><i>options</i></dt>
166 <dd>
167 various options for the dialog (QFileDialog.Options)
168 </dd>
169 </dl><dl>
170 <dt>Returns:</dt>
171 <dd>
172 name of file to be opened and selected filter (string, string)
173 </dd>
174 </dl>
175 <div align="right"><a href="#top">Up</a></div>
176 <hr /><hr />
177 <a NAME="getOpenFileNames" ID="getOpenFileNames"></a>
178 <h2>getOpenFileNames</h2>
179 <b>getOpenFileNames</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
180 <p>
181 Module function to get a list of names of files for opening.
182 </p><dl>
183 <dt><i>parent</i></dt>
184 <dd>
185 parent widget of the dialog (QWidget)
186 </dd><dt><i>caption</i></dt>
187 <dd>
188 window title of the dialog (string)
189 </dd><dt><i>directory</i></dt>
190 <dd>
191 working directory of the dialog (string)
192 </dd><dt><i>filterStr</i></dt>
193 <dd>
194 filter string for the dialog (string)
195 </dd><dt><i>options</i></dt>
196 <dd>
197 various options for the dialog (QFileDialog.Options)
198 </dd>
199 </dl><dl>
200 <dt>Returns:</dt>
201 <dd>
202 list of file names to be opened (list of string)
203 </dd>
204 </dl>
205 <div align="right"><a href="#top">Up</a></div>
206 <hr /><hr />
207 <a NAME="getOpenFileNamesAndFilter" ID="getOpenFileNamesAndFilter"></a>
208 <h2>getOpenFileNamesAndFilter</h2>
209 <b>getOpenFileNamesAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>)
210 <p>
211 Module function to get a list of names of files for opening and the
212 selected file name filter.
213 </p><dl>
214 <dt><i>parent</i></dt>
215 <dd>
216 parent widget of the dialog (QWidget)
217 </dd><dt><i>caption</i></dt>
218 <dd>
219 window title of the dialog (string)
220 </dd><dt><i>directory</i></dt>
221 <dd>
222 working directory of the dialog (string)
223 </dd><dt><i>filterStr</i></dt>
224 <dd>
225 filter string for the dialog (string)
226 </dd><dt><i>initialFilter</i></dt>
227 <dd>
228 initial filter for the dialog (string)
229 </dd><dt><i>options</i></dt>
230 <dd>
231 various options for the dialog (QFileDialog.Options)
232 </dd>
233 </dl><dl>
234 <dt>Returns:</dt>
235 <dd>
236 list of file names to be opened and selected filter
237 (list of string, string)
238 </dd>
239 </dl>
240 <div align="right"><a href="#top">Up</a></div>
241 <hr /><hr />
242 <a NAME="getSaveFileName" ID="getSaveFileName"></a>
243 <h2>getSaveFileName</h2>
244 <b>getSaveFileName</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
245 <p>
246 Module function to get the name of a file for saving it.
247 </p><dl>
248 <dt><i>parent</i></dt>
249 <dd>
250 parent widget of the dialog (QWidget)
251 </dd><dt><i>caption</i></dt>
252 <dd>
253 window title of the dialog (string)
254 </dd><dt><i>directory</i></dt>
255 <dd>
256 working directory of the dialog (string)
257 </dd><dt><i>filterStr</i></dt>
258 <dd>
259 filter string for the dialog (string)
260 </dd><dt><i>options</i></dt>
261 <dd>
262 various options for the dialog (QFileDialog.Options)
263 </dd>
264 </dl><dl>
265 <dt>Returns:</dt>
266 <dd>
267 name of file to be saved (string)
268 </dd>
269 </dl>
270 <div align="right"><a href="#top">Up</a></div>
271 <hr /><hr />
272 <a NAME="getSaveFileNameAndFilter" ID="getSaveFileNameAndFilter"></a>
273 <h2>getSaveFileNameAndFilter</h2>
274 <b>getSaveFileNameAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>)
275 <p>
276 Module function to get the name of a file for saving it and the selected
277 file name filter.
278 </p><dl>
279 <dt><i>parent</i></dt>
280 <dd>
281 parent widget of the dialog (QWidget)
282 </dd><dt><i>caption</i></dt>
283 <dd>
284 window title of the dialog (string)
285 </dd><dt><i>directory</i></dt>
286 <dd>
287 working directory of the dialog (string)
288 </dd><dt><i>filterStr</i></dt>
289 <dd>
290 filter string for the dialog (string)
291 </dd><dt><i>initialFilter</i></dt>
292 <dd>
293 initial filter for the dialog (string)
294 </dd><dt><i>options</i></dt>
295 <dd>
296 various options for the dialog (QFileDialog.Options)
297 </dd>
298 </dl><dl>
299 <dt>Returns:</dt>
300 <dd>
301 name of file to be saved and selected filter (string, string)
302 </dd>
303 </dl>
304 <div align="right"><a href="#top">Up</a></div>
305 <hr />
306 </body></html>

Mercurial Repository: eric

eric ide

mercurial