Mercurial Repositories > eric / file comparison

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

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

changeset 7273
391d6b7b1eff
parent 7232
0b840f7ed593
child 7989
a21d673a8f99
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.E5Gui.E5FileDialog</h1> 23 <h1>eric6.E5Gui.E5FileDialog</h1>
24
23 <p> 25 <p>
24 Module implementing alternative functions for the QFileDialog static methods 26 Module implementing alternative functions for the QFileDialog static methods
25 to cope with distributor's usage of KDE wrapper dialogs for Qt file dialogs. 27 to cope with distributor's usage of KDE wrapper dialogs for Qt file dialogs.
26 </p> 28 </p>
27 <h3>Global Attributes</h3> 29 <h3>Global Attributes</h3>
30
28 <table> 31 <table>
29 <tr><td>DontConfirmOverwrite</td></tr><tr><td>DontResolveSymlinks</td></tr><tr><td>DontUseCustomDirectoryIcons</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> 32 <tr><td>DontConfirmOverwrite</td></tr><tr><td>DontResolveSymlinks</td></tr><tr><td>DontUseCustomDirectoryIcons</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> 33 </table>
31 <h3>Classes</h3> 34 <h3>Classes</h3>
35
32 <table> 36 <table>
33 <tr><td>None</td></tr> 37 <tr><td>None</td></tr>
34 </table> 38 </table>
35 <h3>Functions</h3> 39 <h3>Functions</h3>
40
36 <table> 41 <table>
42
37 <tr> 43 <tr>
38 <td><a href="#__reorderFilter">__reorderFilter</a></td> 44 <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> 45 <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> 46 </tr>
47 <tr>
41 <td><a href="#getExistingDirectory">getExistingDirectory</a></td> 48 <td><a href="#getExistingDirectory">getExistingDirectory</a></td>
42 <td>Module function to get the name of a directory.</td> 49 <td>Module function to get the name of a directory.</td>
43 </tr><tr> 50 </tr>
51 <tr>
44 <td><a href="#getOpenFileName">getOpenFileName</a></td> 52 <td><a href="#getOpenFileName">getOpenFileName</a></td>
45 <td>Module function to get the name of a file for opening it.</td> 53 <td>Module function to get the name of a file for opening it.</td>
46 </tr><tr> 54 </tr>
55 <tr>
47 <td><a href="#getOpenFileNameAndFilter">getOpenFileNameAndFilter</a></td> 56 <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> 57 <td>Module function to get the name of a file for opening it and the selected file name filter.</td>
49 </tr><tr> 58 </tr>
59 <tr>
50 <td><a href="#getOpenFileNames">getOpenFileNames</a></td> 60 <td><a href="#getOpenFileNames">getOpenFileNames</a></td>
51 <td>Module function to get a list of names of files for opening.</td> 61 <td>Module function to get a list of names of files for opening.</td>
52 </tr><tr> 62 </tr>
63 <tr>
53 <td><a href="#getOpenFileNamesAndFilter">getOpenFileNamesAndFilter</a></td> 64 <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> 65 <td>Module function to get a list of names of files for opening and the selected file name filter.</td>
55 </tr><tr> 66 </tr>
67 <tr>
56 <td><a href="#getSaveFileName">getSaveFileName</a></td> 68 <td><a href="#getSaveFileName">getSaveFileName</a></td>
57 <td>Module function to get the name of a file for saving it.</td> 69 <td>Module function to get the name of a file for saving it.</td>
58 </tr><tr> 70 </tr>
71 <tr>
59 <td><a href="#getSaveFileNameAndFilter">getSaveFileNameAndFilter</a></td> 72 <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> 73 <td>Module function to get the name of a file for saving it and the selected file name filter.</td>
61 </tr> 74 </tr>
62 </table> 75 </table>
63 <hr /><hr /> 76 <hr />
77 <hr />
64 <a NAME="__reorderFilter" ID="__reorderFilter"></a> 78 <a NAME="__reorderFilter" ID="__reorderFilter"></a>
65 <h2>__reorderFilter</h2> 79 <h2>__reorderFilter</h2>
66 <b>__reorderFilter</b>(<i>filterStr, initialFilter=""</i>) 80 <b>__reorderFilter</b>(<i>filterStr, initialFilter=""</i>)
81
67 <p> 82 <p>
68 Private function to reorder the file filter to cope with a KDE issue 83 Private function to reorder the file filter to cope with a KDE issue
69 introduced by distributor's usage of KDE file dialogs. 84 introduced by distributor's usage of KDE file dialogs.
70 </p><dl> 85 </p>
86 <dl>
87
71 <dt><i>filterStr</i></dt> 88 <dt><i>filterStr</i></dt>
72 <dd> 89 <dd>
73 Qt file filter (string) 90 Qt file filter (string)
74 </dd><dt><i>initialFilter</i></dt> 91 </dd>
92 <dt><i>initialFilter</i></dt>
75 <dd> 93 <dd>
76 initial filter (string) 94 initial filter (string)
77 </dd> 95 </dd>
78 </dl><dl> 96 </dl>
97 <dl>
79 <dt>Returns:</dt> 98 <dt>Returns:</dt>
80 <dd> 99 <dd>
81 the rearranged Qt file filter (string) 100 the rearranged Qt file filter (string)
82 </dd> 101 </dd>
83 </dl> 102 </dl>
84 <div align="right"><a href="#top">Up</a></div> 103 <div align="right"><a href="#top">Up</a></div>
85 <hr /><hr /> 104 <hr />
105 <hr />
86 <a NAME="getExistingDirectory" ID="getExistingDirectory"></a> 106 <a NAME="getExistingDirectory" ID="getExistingDirectory"></a>
87 <h2>getExistingDirectory</h2> 107 <h2>getExistingDirectory</h2>
88 <b>getExistingDirectory</b>(<i>parent=None, caption="", directory="", options=QFileDialog.ShowDirsOnly</i>) 108 <b>getExistingDirectory</b>(<i>parent=None, caption="", directory="", options=QFileDialog.ShowDirsOnly</i>)
109
89 <p> 110 <p>
90 Module function to get the name of a directory. 111 Module function to get the name of a directory.
91 </p><dl> 112 </p>
92 <dt><i>parent</i></dt> 113 <dl>
93 <dd> 114
94 parent widget of the dialog (QWidget) 115 <dt><i>parent</i></dt>
95 </dd><dt><i>caption</i></dt> 116 <dd>
96 <dd> 117 parent widget of the dialog (QWidget)
97 window title of the dialog (string) 118 </dd>
98 </dd><dt><i>directory</i></dt> 119 <dt><i>caption</i></dt>
99 <dd> 120 <dd>
100 working directory of the dialog (string) 121 window title of the dialog (string)
101 </dd><dt><i>options</i></dt> 122 </dd>
102 <dd> 123 <dt><i>directory</i></dt>
103 various options for the dialog (QFileDialog.Options) 124 <dd>
104 </dd> 125 working directory of the dialog (string)
105 </dl><dl> 126 </dd>
127 <dt><i>options</i></dt>
128 <dd>
129 various options for the dialog (QFileDialog.Options)
130 </dd>
131 </dl>
132 <dl>
106 <dt>Returns:</dt> 133 <dt>Returns:</dt>
107 <dd> 134 <dd>
108 name of selected directory (string) 135 name of selected directory (string)
109 </dd> 136 </dd>
110 </dl> 137 </dl>
111 <div align="right"><a href="#top">Up</a></div> 138 <div align="right"><a href="#top">Up</a></div>
112 <hr /><hr /> 139 <hr />
140 <hr />
113 <a NAME="getOpenFileName" ID="getOpenFileName"></a> 141 <a NAME="getOpenFileName" ID="getOpenFileName"></a>
114 <h2>getOpenFileName</h2> 142 <h2>getOpenFileName</h2>
115 <b>getOpenFileName</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>) 143 <b>getOpenFileName</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
144
116 <p> 145 <p>
117 Module function to get the name of a file for opening it. 146 Module function to get the name of a file for opening it.
118 </p><dl> 147 </p>
119 <dt><i>parent</i></dt> 148 <dl>
120 <dd> 149
121 parent widget of the dialog (QWidget) 150 <dt><i>parent</i></dt>
122 </dd><dt><i>caption</i></dt> 151 <dd>
123 <dd> 152 parent widget of the dialog (QWidget)
124 window title of the dialog (string) 153 </dd>
125 </dd><dt><i>directory</i></dt> 154 <dt><i>caption</i></dt>
126 <dd> 155 <dd>
127 working directory of the dialog (string) 156 window title of the dialog (string)
128 </dd><dt><i>filterStr</i></dt> 157 </dd>
129 <dd> 158 <dt><i>directory</i></dt>
130 filter string for the dialog (string) 159 <dd>
131 </dd><dt><i>options</i></dt> 160 working directory of the dialog (string)
132 <dd> 161 </dd>
133 various options for the dialog (QFileDialog.Options) 162 <dt><i>filterStr</i></dt>
134 </dd> 163 <dd>
135 </dl><dl> 164 filter string for the dialog (string)
165 </dd>
166 <dt><i>options</i></dt>
167 <dd>
168 various options for the dialog (QFileDialog.Options)
169 </dd>
170 </dl>
171 <dl>
136 <dt>Returns:</dt> 172 <dt>Returns:</dt>
137 <dd> 173 <dd>
138 name of file to be opened (string) 174 name of file to be opened (string)
139 </dd> 175 </dd>
140 </dl> 176 </dl>
141 <div align="right"><a href="#top">Up</a></div> 177 <div align="right"><a href="#top">Up</a></div>
142 <hr /><hr /> 178 <hr />
179 <hr />
143 <a NAME="getOpenFileNameAndFilter" ID="getOpenFileNameAndFilter"></a> 180 <a NAME="getOpenFileNameAndFilter" ID="getOpenFileNameAndFilter"></a>
144 <h2>getOpenFileNameAndFilter</h2> 181 <h2>getOpenFileNameAndFilter</h2>
145 <b>getOpenFileNameAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>) 182 <b>getOpenFileNameAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>)
183
146 <p> 184 <p>
147 Module function to get the name of a file for opening it and the selected 185 Module function to get the name of a file for opening it and the selected
148 file name filter. 186 file name filter.
149 </p><dl> 187 </p>
150 <dt><i>parent</i></dt> 188 <dl>
151 <dd> 189
152 parent widget of the dialog (QWidget) 190 <dt><i>parent</i></dt>
153 </dd><dt><i>caption</i></dt> 191 <dd>
154 <dd> 192 parent widget of the dialog (QWidget)
155 window title of the dialog (string) 193 </dd>
156 </dd><dt><i>directory</i></dt> 194 <dt><i>caption</i></dt>
157 <dd> 195 <dd>
158 working directory of the dialog (string) 196 window title of the dialog (string)
159 </dd><dt><i>filterStr</i></dt> 197 </dd>
160 <dd> 198 <dt><i>directory</i></dt>
161 filter string for the dialog (string) 199 <dd>
162 </dd><dt><i>initialFilter</i></dt> 200 working directory of the dialog (string)
201 </dd>
202 <dt><i>filterStr</i></dt>
203 <dd>
204 filter string for the dialog (string)
205 </dd>
206 <dt><i>initialFilter</i></dt>
163 <dd> 207 <dd>
164 initial filter for the dialog (string) 208 initial filter for the dialog (string)
165 </dd><dt><i>options</i></dt> 209 </dd>
166 <dd> 210 <dt><i>options</i></dt>
167 various options for the dialog (QFileDialog.Options) 211 <dd>
168 </dd> 212 various options for the dialog (QFileDialog.Options)
169 </dl><dl> 213 </dd>
214 </dl>
215 <dl>
170 <dt>Returns:</dt> 216 <dt>Returns:</dt>
171 <dd> 217 <dd>
172 name of file to be opened and selected filter (string, string) 218 name of file to be opened and selected filter (string, string)
173 </dd> 219 </dd>
174 </dl> 220 </dl>
175 <div align="right"><a href="#top">Up</a></div> 221 <div align="right"><a href="#top">Up</a></div>
176 <hr /><hr /> 222 <hr />
223 <hr />
177 <a NAME="getOpenFileNames" ID="getOpenFileNames"></a> 224 <a NAME="getOpenFileNames" ID="getOpenFileNames"></a>
178 <h2>getOpenFileNames</h2> 225 <h2>getOpenFileNames</h2>
179 <b>getOpenFileNames</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>) 226 <b>getOpenFileNames</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
227
180 <p> 228 <p>
181 Module function to get a list of names of files for opening. 229 Module function to get a list of names of files for opening.
182 </p><dl> 230 </p>
183 <dt><i>parent</i></dt> 231 <dl>
184 <dd> 232
185 parent widget of the dialog (QWidget) 233 <dt><i>parent</i></dt>
186 </dd><dt><i>caption</i></dt> 234 <dd>
187 <dd> 235 parent widget of the dialog (QWidget)
188 window title of the dialog (string) 236 </dd>
189 </dd><dt><i>directory</i></dt> 237 <dt><i>caption</i></dt>
190 <dd> 238 <dd>
191 working directory of the dialog (string) 239 window title of the dialog (string)
192 </dd><dt><i>filterStr</i></dt> 240 </dd>
193 <dd> 241 <dt><i>directory</i></dt>
194 filter string for the dialog (string) 242 <dd>
195 </dd><dt><i>options</i></dt> 243 working directory of the dialog (string)
196 <dd> 244 </dd>
197 various options for the dialog (QFileDialog.Options) 245 <dt><i>filterStr</i></dt>
198 </dd> 246 <dd>
199 </dl><dl> 247 filter string for the dialog (string)
248 </dd>
249 <dt><i>options</i></dt>
250 <dd>
251 various options for the dialog (QFileDialog.Options)
252 </dd>
253 </dl>
254 <dl>
200 <dt>Returns:</dt> 255 <dt>Returns:</dt>
201 <dd> 256 <dd>
202 list of file names to be opened (list of string) 257 list of file names to be opened (list of string)
203 </dd> 258 </dd>
204 </dl> 259 </dl>
205 <div align="right"><a href="#top">Up</a></div> 260 <div align="right"><a href="#top">Up</a></div>
206 <hr /><hr /> 261 <hr />
262 <hr />
207 <a NAME="getOpenFileNamesAndFilter" ID="getOpenFileNamesAndFilter"></a> 263 <a NAME="getOpenFileNamesAndFilter" ID="getOpenFileNamesAndFilter"></a>
208 <h2>getOpenFileNamesAndFilter</h2> 264 <h2>getOpenFileNamesAndFilter</h2>
209 <b>getOpenFileNamesAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>) 265 <b>getOpenFileNamesAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>)
266
210 <p> 267 <p>
211 Module function to get a list of names of files for opening and the 268 Module function to get a list of names of files for opening and the
212 selected file name filter. 269 selected file name filter.
213 </p><dl> 270 </p>
214 <dt><i>parent</i></dt> 271 <dl>
215 <dd> 272
216 parent widget of the dialog (QWidget) 273 <dt><i>parent</i></dt>
217 </dd><dt><i>caption</i></dt> 274 <dd>
218 <dd> 275 parent widget of the dialog (QWidget)
219 window title of the dialog (string) 276 </dd>
220 </dd><dt><i>directory</i></dt> 277 <dt><i>caption</i></dt>
221 <dd> 278 <dd>
222 working directory of the dialog (string) 279 window title of the dialog (string)
223 </dd><dt><i>filterStr</i></dt> 280 </dd>
224 <dd> 281 <dt><i>directory</i></dt>
225 filter string for the dialog (string) 282 <dd>
226 </dd><dt><i>initialFilter</i></dt> 283 working directory of the dialog (string)
284 </dd>
285 <dt><i>filterStr</i></dt>
286 <dd>
287 filter string for the dialog (string)
288 </dd>
289 <dt><i>initialFilter</i></dt>
227 <dd> 290 <dd>
228 initial filter for the dialog (string) 291 initial filter for the dialog (string)
229 </dd><dt><i>options</i></dt> 292 </dd>
230 <dd> 293 <dt><i>options</i></dt>
231 various options for the dialog (QFileDialog.Options) 294 <dd>
232 </dd> 295 various options for the dialog (QFileDialog.Options)
233 </dl><dl> 296 </dd>
297 </dl>
298 <dl>
234 <dt>Returns:</dt> 299 <dt>Returns:</dt>
235 <dd> 300 <dd>
236 list of file names to be opened and selected filter 301 list of file names to be opened and selected filter
237 (list of string, string) 302 (list of string, string)
238 </dd> 303 </dd>
239 </dl> 304 </dl>
240 <div align="right"><a href="#top">Up</a></div> 305 <div align="right"><a href="#top">Up</a></div>
241 <hr /><hr /> 306 <hr />
307 <hr />
242 <a NAME="getSaveFileName" ID="getSaveFileName"></a> 308 <a NAME="getSaveFileName" ID="getSaveFileName"></a>
243 <h2>getSaveFileName</h2> 309 <h2>getSaveFileName</h2>
244 <b>getSaveFileName</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>) 310 <b>getSaveFileName</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
311
245 <p> 312 <p>
246 Module function to get the name of a file for saving it. 313 Module function to get the name of a file for saving it.
247 </p><dl> 314 </p>
248 <dt><i>parent</i></dt> 315 <dl>
249 <dd> 316
250 parent widget of the dialog (QWidget) 317 <dt><i>parent</i></dt>
251 </dd><dt><i>caption</i></dt> 318 <dd>
252 <dd> 319 parent widget of the dialog (QWidget)
253 window title of the dialog (string) 320 </dd>
254 </dd><dt><i>directory</i></dt> 321 <dt><i>caption</i></dt>
255 <dd> 322 <dd>
256 working directory of the dialog (string) 323 window title of the dialog (string)
257 </dd><dt><i>filterStr</i></dt> 324 </dd>
258 <dd> 325 <dt><i>directory</i></dt>
259 filter string for the dialog (string) 326 <dd>
260 </dd><dt><i>options</i></dt> 327 working directory of the dialog (string)
261 <dd> 328 </dd>
262 various options for the dialog (QFileDialog.Options) 329 <dt><i>filterStr</i></dt>
263 </dd> 330 <dd>
264 </dl><dl> 331 filter string for the dialog (string)
332 </dd>
333 <dt><i>options</i></dt>
334 <dd>
335 various options for the dialog (QFileDialog.Options)
336 </dd>
337 </dl>
338 <dl>
265 <dt>Returns:</dt> 339 <dt>Returns:</dt>
266 <dd> 340 <dd>
267 name of file to be saved (string) 341 name of file to be saved (string)
268 </dd> 342 </dd>
269 </dl> 343 </dl>
270 <div align="right"><a href="#top">Up</a></div> 344 <div align="right"><a href="#top">Up</a></div>
271 <hr /><hr /> 345 <hr />
346 <hr />
272 <a NAME="getSaveFileNameAndFilter" ID="getSaveFileNameAndFilter"></a> 347 <a NAME="getSaveFileNameAndFilter" ID="getSaveFileNameAndFilter"></a>
273 <h2>getSaveFileNameAndFilter</h2> 348 <h2>getSaveFileNameAndFilter</h2>
274 <b>getSaveFileNameAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>) 349 <b>getSaveFileNameAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>)
350
275 <p> 351 <p>
276 Module function to get the name of a file for saving it and the selected 352 Module function to get the name of a file for saving it and the selected
277 file name filter. 353 file name filter.
278 </p><dl> 354 </p>
279 <dt><i>parent</i></dt> 355 <dl>
280 <dd> 356
281 parent widget of the dialog (QWidget) 357 <dt><i>parent</i></dt>
282 </dd><dt><i>caption</i></dt> 358 <dd>
283 <dd> 359 parent widget of the dialog (QWidget)
284 window title of the dialog (string) 360 </dd>
285 </dd><dt><i>directory</i></dt> 361 <dt><i>caption</i></dt>
286 <dd> 362 <dd>
287 working directory of the dialog (string) 363 window title of the dialog (string)
288 </dd><dt><i>filterStr</i></dt> 364 </dd>
289 <dd> 365 <dt><i>directory</i></dt>
290 filter string for the dialog (string) 366 <dd>
291 </dd><dt><i>initialFilter</i></dt> 367 working directory of the dialog (string)
368 </dd>
369 <dt><i>filterStr</i></dt>
370 <dd>
371 filter string for the dialog (string)
372 </dd>
373 <dt><i>initialFilter</i></dt>
292 <dd> 374 <dd>
293 initial filter for the dialog (string) 375 initial filter for the dialog (string)
294 </dd><dt><i>options</i></dt> 376 </dd>
295 <dd> 377 <dt><i>options</i></dt>
296 various options for the dialog (QFileDialog.Options) 378 <dd>
297 </dd> 379 various options for the dialog (QFileDialog.Options)
298 </dl><dl> 380 </dd>
381 </dl>
382 <dl>
299 <dt>Returns:</dt> 383 <dt>Returns:</dt>
300 <dd> 384 <dd>
301 name of file to be saved and selected filter (string, string) 385 name of file to be saved and selected filter (string, string)
302 </dd> 386 </dd>
303 </dl> 387 </dl>

Mercurial Repository: eric

eric ide

mercurial