Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.EricWidgets.EricFileDialog.html
src/eric7/Documentation/Source/eric7.EricWidgets.EricFileDialog.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 9239
- 3c605ab5a8c7
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.EricWidgets.EricFileDialog</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.EricWidgets.EricFileDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing alternative functions for the QFileDialog static methods. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>DontConfirmOverwrite</td></tr><tr><td>DontResolveSymlinks</td></tr><tr><td>DontUseCustomDirectoryIcons</td></tr><tr><td>DontUseNativeDialog</td></tr><tr><td>HideNameFilterDetails</td></tr><tr><td>Option</td></tr><tr><td>ReadOnly</td></tr><tr><td>ShowDirsOnly</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 <tr><td>None</td></tr> | |
| 23 </table> | |
| 24 <h3>Functions</h3> | |
| 25 | |
| 26 <table> | |
| 27 | |
| 28 <tr> | |
| 29 <td><a href="#__reorderFilter">__reorderFilter</a></td> | |
| 30 <td>Private function to reorder the file filter to cope with a KDE issue introduced by distributor's usage of KDE file dialogs.</td> | |
| 31 </tr> | |
| 32 <tr> | |
| 33 <td><a href="#getExistingDirectory">getExistingDirectory</a></td> | |
| 34 <td>Module function to get the name of a directory.</td> | |
| 35 </tr> | |
| 36 <tr> | |
| 37 <td><a href="#getOpenFileAndDirNames">getOpenFileAndDirNames</a></td> | |
| 38 <td>Module function to get the names of files and directories for opening.</td> | |
| 39 </tr> | |
| 40 <tr> | |
| 41 <td><a href="#getOpenFileName">getOpenFileName</a></td> | |
| 42 <td>Module function to get the name of a file for opening it.</td> | |
| 43 </tr> | |
| 44 <tr> | |
| 45 <td><a href="#getOpenFileNameAndFilter">getOpenFileNameAndFilter</a></td> | |
| 46 <td>Module function to get the name of a file for opening it and the selected file name filter.</td> | |
| 47 </tr> | |
| 48 <tr> | |
| 49 <td><a href="#getOpenFileNames">getOpenFileNames</a></td> | |
| 50 <td>Module function to get a list of names of files for opening.</td> | |
| 51 </tr> | |
| 52 <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> | |
| 56 <tr> | |
| 57 <td><a href="#getSaveFileName">getSaveFileName</a></td> | |
| 58 <td>Module function to get the name of a file for saving it.</td> | |
| 59 </tr> | |
| 60 <tr> | |
| 61 <td><a href="#getSaveFileNameAndFilter">getSaveFileNameAndFilter</a></td> | |
| 62 <td>Module function to get the name of a file for saving it and the selected file name filter.</td> | |
| 63 </tr> | |
| 64 </table> | |
| 65 <hr /> | |
| 66 <hr /> | |
| 67 <a NAME="__reorderFilter" ID="__reorderFilter"></a> | |
| 68 <h2>__reorderFilter</h2> | |
| 69 <b>__reorderFilter</b>(<i>filterStr, initialFilter=""</i>) | |
| 70 | |
| 71 <p> | |
| 72 Private function to reorder the file filter to cope with a KDE issue | |
| 73 introduced by distributor's usage of KDE file dialogs. | |
| 74 </p> | |
| 75 <dl> | |
| 76 | |
| 77 <dt><i>filterStr</i> (str)</dt> | |
| 78 <dd> | |
| 79 Qt file filter | |
| 80 </dd> | |
| 81 <dt><i>initialFilter</i> (str)</dt> | |
| 82 <dd> | |
| 83 initial filter | |
| 84 </dd> | |
| 85 </dl> | |
| 86 <dl> | |
| 87 <dt>Return:</dt> | |
| 88 <dd> | |
| 89 the rearranged Qt file filter | |
| 90 </dd> | |
| 91 </dl> | |
| 92 <dl> | |
| 93 <dt>Return Type:</dt> | |
| 94 <dd> | |
| 95 str | |
| 96 </dd> | |
| 97 </dl> | |
| 98 <div align="right"><a href="#top">Up</a></div> | |
| 99 <hr /> | |
| 100 <hr /> | |
| 101 <a NAME="getExistingDirectory" ID="getExistingDirectory"></a> | |
| 102 <h2>getExistingDirectory</h2> | |
| 103 <b>getExistingDirectory</b>(<i>parent=None, caption="", directory="", options=QFileDialog.Option.ShowDirsOnly</i>) | |
| 104 | |
| 105 <p> | |
| 106 Module function to get the name of a directory. | |
| 107 </p> | |
| 108 <dl> | |
| 109 | |
| 110 <dt><i>parent</i> (QWidget)</dt> | |
| 111 <dd> | |
| 112 parent widget of the dialog | |
| 113 </dd> | |
| 114 <dt><i>caption</i> (str)</dt> | |
| 115 <dd> | |
| 116 window title of the dialog | |
| 117 </dd> | |
| 118 <dt><i>directory</i> (str)</dt> | |
| 119 <dd> | |
| 120 working directory of the dialog | |
| 121 </dd> | |
| 122 <dt><i>options</i> (QFileDialog.Options)</dt> | |
| 123 <dd> | |
| 124 various options for the dialog | |
| 125 </dd> | |
| 126 </dl> | |
| 127 <dl> | |
| 128 <dt>Return:</dt> | |
| 129 <dd> | |
| 130 name of selected directory | |
| 131 </dd> | |
| 132 </dl> | |
| 133 <dl> | |
| 134 <dt>Return Type:</dt> | |
| 135 <dd> | |
| 136 str | |
| 137 </dd> | |
| 138 </dl> | |
| 139 <div align="right"><a href="#top">Up</a></div> | |
| 140 <hr /> | |
| 141 <hr /> | |
| 142 <a NAME="getOpenFileAndDirNames" ID="getOpenFileAndDirNames"></a> | |
| 143 <h2>getOpenFileAndDirNames</h2> | |
| 144 <b>getOpenFileAndDirNames</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>) | |
| 145 | |
| 146 <p> | |
| 147 Module function to get the names of files and directories for opening. | |
| 148 </p> | |
| 149 <dl> | |
| 150 | |
| 151 <dt><i>parent</i> (QWidget)</dt> | |
| 152 <dd> | |
| 153 parent widget of the dialog | |
| 154 </dd> | |
| 155 <dt><i>caption</i> (str)</dt> | |
| 156 <dd> | |
| 157 window title of the dialog | |
| 158 </dd> | |
| 159 <dt><i>directory</i> (str)</dt> | |
| 160 <dd> | |
| 161 working directory of the dialog | |
| 162 </dd> | |
| 163 <dt><i>filterStr</i> (str)</dt> | |
| 164 <dd> | |
| 165 filter string for the dialog | |
| 166 </dd> | |
| 167 <dt><i>options</i> (QFileDialog.Options)</dt> | |
| 168 <dd> | |
| 169 various options for the dialog | |
| 170 </dd> | |
| 171 </dl> | |
| 172 <dl> | |
| 173 <dt>Return:</dt> | |
| 174 <dd> | |
| 175 names of the selected files and folders | |
| 176 </dd> | |
| 177 </dl> | |
| 178 <dl> | |
| 179 <dt>Return Type:</dt> | |
| 180 <dd> | |
| 181 list of str | |
| 182 </dd> | |
| 183 </dl> | |
| 184 <div align="right"><a href="#top">Up</a></div> | |
| 185 <hr /> | |
| 186 <hr /> | |
| 187 <a NAME="getOpenFileName" ID="getOpenFileName"></a> | |
| 188 <h2>getOpenFileName</h2> | |
| 189 <b>getOpenFileName</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>) | |
| 190 | |
| 191 <p> | |
| 192 Module function to get the name of a file for opening it. | |
| 193 </p> | |
| 194 <dl> | |
| 195 | |
| 196 <dt><i>parent</i> (QWidget)</dt> | |
| 197 <dd> | |
| 198 parent widget of the dialog | |
| 199 </dd> | |
| 200 <dt><i>caption</i> (str)</dt> | |
| 201 <dd> | |
| 202 window title of the dialog | |
| 203 </dd> | |
| 204 <dt><i>directory</i> (str)</dt> | |
| 205 <dd> | |
| 206 working directory of the dialog | |
| 207 </dd> | |
| 208 <dt><i>filterStr</i> (str)</dt> | |
| 209 <dd> | |
| 210 filter string for the dialog | |
| 211 </dd> | |
| 212 <dt><i>options</i> (QFileDialog.Options)</dt> | |
| 213 <dd> | |
| 214 various options for the dialog | |
| 215 </dd> | |
| 216 </dl> | |
| 217 <dl> | |
| 218 <dt>Return:</dt> | |
| 219 <dd> | |
| 220 name of file to be opened | |
| 221 </dd> | |
| 222 </dl> | |
| 223 <dl> | |
| 224 <dt>Return Type:</dt> | |
| 225 <dd> | |
| 226 str | |
| 227 </dd> | |
| 228 </dl> | |
| 229 <div align="right"><a href="#top">Up</a></div> | |
| 230 <hr /> | |
| 231 <hr /> | |
| 232 <a NAME="getOpenFileNameAndFilter" ID="getOpenFileNameAndFilter"></a> | |
| 233 <h2>getOpenFileNameAndFilter</h2> | |
| 234 <b>getOpenFileNameAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>) | |
| 235 | |
| 236 <p> | |
| 237 Module function to get the name of a file for opening it and the selected | |
| 238 file name filter. | |
| 239 </p> | |
| 240 <dl> | |
| 241 | |
| 242 <dt><i>parent</i> (QWidget)</dt> | |
| 243 <dd> | |
| 244 parent widget of the dialog | |
| 245 </dd> | |
| 246 <dt><i>caption</i> (str)</dt> | |
| 247 <dd> | |
| 248 window title of the dialog | |
| 249 </dd> | |
| 250 <dt><i>directory</i> (str)</dt> | |
| 251 <dd> | |
| 252 working directory of the dialog | |
| 253 </dd> | |
| 254 <dt><i>filterStr</i> (str)</dt> | |
| 255 <dd> | |
| 256 filter string for the dialog | |
| 257 </dd> | |
| 258 <dt><i>initialFilter</i> (str)</dt> | |
| 259 <dd> | |
| 260 initial filter for the dialog | |
| 261 </dd> | |
| 262 <dt><i>options</i> (QFileDialog.Options)</dt> | |
| 263 <dd> | |
| 264 various options for the dialog | |
| 265 </dd> | |
| 266 </dl> | |
| 267 <dl> | |
| 268 <dt>Return:</dt> | |
| 269 <dd> | |
| 270 name of file to be opened and selected filter | |
| 271 </dd> | |
| 272 </dl> | |
| 273 <dl> | |
| 274 <dt>Return Type:</dt> | |
| 275 <dd> | |
| 276 tuple of (str, str) | |
| 277 </dd> | |
| 278 </dl> | |
| 279 <div align="right"><a href="#top">Up</a></div> | |
| 280 <hr /> | |
| 281 <hr /> | |
| 282 <a NAME="getOpenFileNames" ID="getOpenFileNames"></a> | |
| 283 <h2>getOpenFileNames</h2> | |
| 284 <b>getOpenFileNames</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>) | |
| 285 | |
| 286 <p> | |
| 287 Module function to get a list of names of files for opening. | |
| 288 </p> | |
| 289 <dl> | |
| 290 | |
| 291 <dt><i>parent</i> (QWidget)</dt> | |
| 292 <dd> | |
| 293 parent widget of the dialog | |
| 294 </dd> | |
| 295 <dt><i>caption</i> (str)</dt> | |
| 296 <dd> | |
| 297 window title of the dialog | |
| 298 </dd> | |
| 299 <dt><i>directory</i> (str)</dt> | |
| 300 <dd> | |
| 301 working directory of the dialog | |
| 302 </dd> | |
| 303 <dt><i>filterStr</i> (str)</dt> | |
| 304 <dd> | |
| 305 filter string for the dialog | |
| 306 </dd> | |
| 307 <dt><i>options</i> (QFileDialog.Options)</dt> | |
| 308 <dd> | |
| 309 various options for the dialog | |
| 310 </dd> | |
| 311 </dl> | |
| 312 <dl> | |
| 313 <dt>Return:</dt> | |
| 314 <dd> | |
| 315 list of file names to be opened | |
| 316 </dd> | |
| 317 </dl> | |
| 318 <dl> | |
| 319 <dt>Return Type:</dt> | |
| 320 <dd> | |
| 321 list of str | |
| 322 </dd> | |
| 323 </dl> | |
| 324 <div align="right"><a href="#top">Up</a></div> | |
| 325 <hr /> | |
| 326 <hr /> | |
| 327 <a NAME="getOpenFileNamesAndFilter" ID="getOpenFileNamesAndFilter"></a> | |
| 328 <h2>getOpenFileNamesAndFilter</h2> | |
| 329 <b>getOpenFileNamesAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>) | |
| 330 | |
| 331 <p> | |
| 332 Module function to get a list of names of files for opening and the | |
| 333 selected file name filter. | |
| 334 </p> | |
| 335 <dl> | |
| 336 | |
| 337 <dt><i>parent</i> (QWidget)</dt> | |
| 338 <dd> | |
| 339 parent widget of the dialog | |
| 340 </dd> | |
| 341 <dt><i>caption</i> (str)</dt> | |
| 342 <dd> | |
| 343 window title of the dialog | |
| 344 </dd> | |
| 345 <dt><i>directory</i> (str)</dt> | |
| 346 <dd> | |
| 347 working directory of the dialog | |
| 348 </dd> | |
| 349 <dt><i>filterStr</i> (str)</dt> | |
| 350 <dd> | |
| 351 filter string for the dialog | |
| 352 </dd> | |
| 353 <dt><i>initialFilter</i> (str)</dt> | |
| 354 <dd> | |
| 355 initial filter for the dialog | |
| 356 </dd> | |
| 357 <dt><i>options</i> (QFileDialog.Options)</dt> | |
| 358 <dd> | |
| 359 various options for the dialog | |
| 360 </dd> | |
| 361 </dl> | |
| 362 <dl> | |
| 363 <dt>Return:</dt> | |
| 364 <dd> | |
| 365 list of file names to be opened and selected filter | |
| 366 </dd> | |
| 367 </dl> | |
| 368 <dl> | |
| 369 <dt>Return Type:</dt> | |
| 370 <dd> | |
| 371 tuple of (list of str, str) | |
| 372 </dd> | |
| 373 </dl> | |
| 374 <div align="right"><a href="#top">Up</a></div> | |
| 375 <hr /> | |
| 376 <hr /> | |
| 377 <a NAME="getSaveFileName" ID="getSaveFileName"></a> | |
| 378 <h2>getSaveFileName</h2> | |
| 379 <b>getSaveFileName</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>) | |
| 380 | |
| 381 <p> | |
| 382 Module function to get the name of a file for saving it. | |
| 383 </p> | |
| 384 <dl> | |
| 385 | |
| 386 <dt><i>parent</i> (QWidget)</dt> | |
| 387 <dd> | |
| 388 parent widget of the dialog | |
| 389 </dd> | |
| 390 <dt><i>caption</i> (str)</dt> | |
| 391 <dd> | |
| 392 window title of the dialog | |
| 393 </dd> | |
| 394 <dt><i>directory</i> (str)</dt> | |
| 395 <dd> | |
| 396 working directory of the dialog | |
| 397 </dd> | |
| 398 <dt><i>filterStr</i> (str)</dt> | |
| 399 <dd> | |
| 400 filter string for the dialog | |
| 401 </dd> | |
| 402 <dt><i>options</i> (QFileDialog.Options)</dt> | |
| 403 <dd> | |
| 404 various options for the dialog | |
| 405 </dd> | |
| 406 </dl> | |
| 407 <dl> | |
| 408 <dt>Return:</dt> | |
| 409 <dd> | |
| 410 name of file to be saved | |
| 411 </dd> | |
| 412 </dl> | |
| 413 <dl> | |
| 414 <dt>Return Type:</dt> | |
| 415 <dd> | |
| 416 str | |
| 417 </dd> | |
| 418 </dl> | |
| 419 <div align="right"><a href="#top">Up</a></div> | |
| 420 <hr /> | |
| 421 <hr /> | |
| 422 <a NAME="getSaveFileNameAndFilter" ID="getSaveFileNameAndFilter"></a> | |
| 423 <h2>getSaveFileNameAndFilter</h2> | |
| 424 <b>getSaveFileNameAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>) | |
| 425 | |
| 426 <p> | |
| 427 Module function to get the name of a file for saving it and the selected | |
| 428 file name filter. | |
| 429 </p> | |
| 430 <dl> | |
| 431 | |
| 432 <dt><i>parent</i> (QWidget)</dt> | |
| 433 <dd> | |
| 434 parent widget of the dialog | |
| 435 </dd> | |
| 436 <dt><i>caption</i> (str)</dt> | |
| 437 <dd> | |
| 438 window title of the dialog | |
| 439 </dd> | |
| 440 <dt><i>directory</i> (str)</dt> | |
| 441 <dd> | |
| 442 working directory of the dialog | |
| 443 </dd> | |
| 444 <dt><i>filterStr</i> (str)</dt> | |
| 445 <dd> | |
| 446 filter string for the dialog | |
| 447 </dd> | |
| 448 <dt><i>initialFilter</i> (str)</dt> | |
| 449 <dd> | |
| 450 initial filter for the dialog | |
| 451 </dd> | |
| 452 <dt><i>options</i> (QFileDialog.Options)</dt> | |
| 453 <dd> | |
| 454 various options for the dialog | |
| 455 </dd> | |
| 456 </dl> | |
| 457 <dl> | |
| 458 <dt>Return:</dt> | |
| 459 <dd> | |
| 460 name of file to be saved and selected filte | |
| 461 </dd> | |
| 462 </dl> | |
| 463 <dl> | |
| 464 <dt>Return Type:</dt> | |
| 465 <dd> | |
| 466 tuple of (str, str) | |
| 467 </dd> | |
| 468 </dl> | |
| 469 <div align="right"><a href="#top">Up</a></div> | |
| 470 <hr /> | |
| 471 </body></html> |
