src/eric7/Documentation/Source/eric7.EricWidgets.EricFileDialog.html

branch
eric7
changeset 10479
856476537696
parent 9239
3c605ab5a8c7
child 10538
decb03459cd4
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.EricWidgets.EricFileDialog</h1> 9 <h1>eric7.EricWidgets.EricFileDialog</h1>
10
11 <p> 10 <p>
12 Module implementing alternative functions for the QFileDialog static methods. 11 Module implementing alternative functions for the QFileDialog static methods.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <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> 16 <tr><td>DontConfirmOverwrite</td></tr>
17 <tr><td>DontResolveSymlinks</td></tr>
18 <tr><td>DontUseCustomDirectoryIcons</td></tr>
19 <tr><td>DontUseNativeDialog</td></tr>
20 <tr><td>HideNameFilterDetails</td></tr>
21 <tr><td>Option</td></tr>
22 <tr><td>ReadOnly</td></tr>
23 <tr><td>ShowDirsOnly</td></tr>
18 </table> 24 </table>
25
19 <h3>Classes</h3> 26 <h3>Classes</h3>
20
21 <table> 27 <table>
22 <tr><td>None</td></tr> 28 <tr><td>None</td></tr>
23 </table> 29 </table>
30
24 <h3>Functions</h3> 31 <h3>Functions</h3>
25
26 <table> 32 <table>
27
28 <tr> 33 <tr>
29 <td><a href="#__reorderFilter">__reorderFilter</a></td> 34 <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> 35 <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> 36 </tr>
32 <tr> 37 <tr>
92 <tr> 97 <tr>
93 <td><a href="#getSaveFilePathAndFilter">getSaveFilePathAndFilter</a></td> 98 <td><a href="#getSaveFilePathAndFilter">getSaveFilePathAndFilter</a></td>
94 <td>Module function to get the path of a file for saving and the selected file name filter.</td> 99 <td>Module function to get the path of a file for saving and the selected file name filter.</td>
95 </tr> 100 </tr>
96 </table> 101 </table>
102
97 <hr /> 103 <hr />
98 <hr /> 104 <hr />
99 <a NAME="__reorderFilter" ID="__reorderFilter"></a> 105 <a NAME="__reorderFilter" ID="__reorderFilter"></a>
100 <h2>__reorderFilter</h2> 106 <h2>__reorderFilter</h2>
101 <b>__reorderFilter</b>(<i>filterStr, initialFilter=""</i>) 107 <b>__reorderFilter</b>(<i>filterStr, initialFilter=""</i>)
102
103 <p> 108 <p>
104 Private function to reorder the file filter to cope with a KDE issue 109 Private function to reorder the file filter to cope with a KDE issue
105 introduced by distributor's usage of KDE file dialogs. 110 introduced by distributor's usage of KDE file dialogs.
106 </p> 111 </p>
112
107 <dl> 113 <dl>
108 114
109 <dt><i>filterStr</i> (str)</dt> 115 <dt><i>filterStr</i> (str)</dt>
110 <dd> 116 <dd>
111 Qt file filter 117 Qt file filter
131 <hr /> 137 <hr />
132 <hr /> 138 <hr />
133 <a NAME="getExistingDirectory" ID="getExistingDirectory"></a> 139 <a NAME="getExistingDirectory" ID="getExistingDirectory"></a>
134 <h2>getExistingDirectory</h2> 140 <h2>getExistingDirectory</h2>
135 <b>getExistingDirectory</b>(<i>parent=None, caption="", directory="", options=QFileDialog.Option.ShowDirsOnly</i>) 141 <b>getExistingDirectory</b>(<i>parent=None, caption="", directory="", options=QFileDialog.Option.ShowDirsOnly</i>)
136
137 <p> 142 <p>
138 Module function to get the name of a directory. 143 Module function to get the name of a directory.
139 </p> 144 </p>
145
140 <dl> 146 <dl>
141 147
142 <dt><i>parent</i> (QWidget)</dt> 148 <dt><i>parent</i> (QWidget)</dt>
143 <dd> 149 <dd>
144 parent widget of the dialog 150 parent widget of the dialog
172 <hr /> 178 <hr />
173 <hr /> 179 <hr />
174 <a NAME="getExistingDirectoryPath" ID="getExistingDirectoryPath"></a> 180 <a NAME="getExistingDirectoryPath" ID="getExistingDirectoryPath"></a>
175 <h2>getExistingDirectoryPath</h2> 181 <h2>getExistingDirectoryPath</h2>
176 <b>getExistingDirectoryPath</b>(<i>parent=None, caption="", directory="", options=QFileDialog.Option.ShowDirsOnly</i>) 182 <b>getExistingDirectoryPath</b>(<i>parent=None, caption="", directory="", options=QFileDialog.Option.ShowDirsOnly</i>)
177
178 <p> 183 <p>
179 Module function to get the path of a directory. 184 Module function to get the path of a directory.
180 </p> 185 </p>
186
181 <dl> 187 <dl>
182 188
183 <dt><i>parent</i> (QWidget)</dt> 189 <dt><i>parent</i> (QWidget)</dt>
184 <dd> 190 <dd>
185 parent widget of the dialog 191 parent widget of the dialog
213 <hr /> 219 <hr />
214 <hr /> 220 <hr />
215 <a NAME="getOpenFilPathsAndFilter" ID="getOpenFilPathsAndFilter"></a> 221 <a NAME="getOpenFilPathsAndFilter" ID="getOpenFilPathsAndFilter"></a>
216 <h2>getOpenFilPathsAndFilter</h2> 222 <h2>getOpenFilPathsAndFilter</h2>
217 <b>getOpenFilPathsAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>) 223 <b>getOpenFilPathsAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>)
218
219 <p> 224 <p>
220 Module function to get a list of paths of files for opening and the 225 Module function to get a list of paths of files for opening and the
221 selected file name filter. 226 selected file name filter.
222 </p> 227 </p>
228
223 <dl> 229 <dl>
224 230
225 <dt><i>parent</i> (QWidget)</dt> 231 <dt><i>parent</i> (QWidget)</dt>
226 <dd> 232 <dd>
227 parent widget of the dialog 233 parent widget of the dialog
263 <hr /> 269 <hr />
264 <hr /> 270 <hr />
265 <a NAME="getOpenFileAndDirNames" ID="getOpenFileAndDirNames"></a> 271 <a NAME="getOpenFileAndDirNames" ID="getOpenFileAndDirNames"></a>
266 <h2>getOpenFileAndDirNames</h2> 272 <h2>getOpenFileAndDirNames</h2>
267 <b>getOpenFileAndDirNames</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>) 273 <b>getOpenFileAndDirNames</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
268
269 <p> 274 <p>
270 Module function to get the names of files and directories for opening. 275 Module function to get the names of files and directories for opening.
271 </p> 276 </p>
277
272 <dl> 278 <dl>
273 279
274 <dt><i>parent</i> (QWidget)</dt> 280 <dt><i>parent</i> (QWidget)</dt>
275 <dd> 281 <dd>
276 parent widget of the dialog 282 parent widget of the dialog
308 <hr /> 314 <hr />
309 <hr /> 315 <hr />
310 <a NAME="getOpenFileAndDirPaths" ID="getOpenFileAndDirPaths"></a> 316 <a NAME="getOpenFileAndDirPaths" ID="getOpenFileAndDirPaths"></a>
311 <h2>getOpenFileAndDirPaths</h2> 317 <h2>getOpenFileAndDirPaths</h2>
312 <b>getOpenFileAndDirPaths</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>) 318 <b>getOpenFileAndDirPaths</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
313
314 <p> 319 <p>
315 Module function to get the paths of files and directories for opening. 320 Module function to get the paths of files and directories for opening.
316 </p> 321 </p>
322
317 <dl> 323 <dl>
318 324
319 <dt><i>parent</i> (QWidget)</dt> 325 <dt><i>parent</i> (QWidget)</dt>
320 <dd> 326 <dd>
321 parent widget of the dialog 327 parent widget of the dialog
353 <hr /> 359 <hr />
354 <hr /> 360 <hr />
355 <a NAME="getOpenFileName" ID="getOpenFileName"></a> 361 <a NAME="getOpenFileName" ID="getOpenFileName"></a>
356 <h2>getOpenFileName</h2> 362 <h2>getOpenFileName</h2>
357 <b>getOpenFileName</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>) 363 <b>getOpenFileName</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
358
359 <p> 364 <p>
360 Module function to get the name of a file for opening it. 365 Module function to get the name of a file for opening it.
361 </p> 366 </p>
367
362 <dl> 368 <dl>
363 369
364 <dt><i>parent</i> (QWidget)</dt> 370 <dt><i>parent</i> (QWidget)</dt>
365 <dd> 371 <dd>
366 parent widget of the dialog 372 parent widget of the dialog
398 <hr /> 404 <hr />
399 <hr /> 405 <hr />
400 <a NAME="getOpenFileNameAndFilter" ID="getOpenFileNameAndFilter"></a> 406 <a NAME="getOpenFileNameAndFilter" ID="getOpenFileNameAndFilter"></a>
401 <h2>getOpenFileNameAndFilter</h2> 407 <h2>getOpenFileNameAndFilter</h2>
402 <b>getOpenFileNameAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>) 408 <b>getOpenFileNameAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>)
403
404 <p> 409 <p>
405 Module function to get the name of a file for opening it and the selected 410 Module function to get the name of a file for opening it and the selected
406 file name filter. 411 file name filter.
407 </p> 412 </p>
413
408 <dl> 414 <dl>
409 415
410 <dt><i>parent</i> (QWidget)</dt> 416 <dt><i>parent</i> (QWidget)</dt>
411 <dd> 417 <dd>
412 parent widget of the dialog 418 parent widget of the dialog
448 <hr /> 454 <hr />
449 <hr /> 455 <hr />
450 <a NAME="getOpenFileNames" ID="getOpenFileNames"></a> 456 <a NAME="getOpenFileNames" ID="getOpenFileNames"></a>
451 <h2>getOpenFileNames</h2> 457 <h2>getOpenFileNames</h2>
452 <b>getOpenFileNames</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>) 458 <b>getOpenFileNames</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
453
454 <p> 459 <p>
455 Module function to get a list of names of files for opening. 460 Module function to get a list of names of files for opening.
456 </p> 461 </p>
462
457 <dl> 463 <dl>
458 464
459 <dt><i>parent</i> (QWidget)</dt> 465 <dt><i>parent</i> (QWidget)</dt>
460 <dd> 466 <dd>
461 parent widget of the dialog 467 parent widget of the dialog
493 <hr /> 499 <hr />
494 <hr /> 500 <hr />
495 <a NAME="getOpenFileNamesAndFilter" ID="getOpenFileNamesAndFilter"></a> 501 <a NAME="getOpenFileNamesAndFilter" ID="getOpenFileNamesAndFilter"></a>
496 <h2>getOpenFileNamesAndFilter</h2> 502 <h2>getOpenFileNamesAndFilter</h2>
497 <b>getOpenFileNamesAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>) 503 <b>getOpenFileNamesAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>)
498
499 <p> 504 <p>
500 Module function to get a list of names of files for opening and the 505 Module function to get a list of names of files for opening and the
501 selected file name filter. 506 selected file name filter.
502 </p> 507 </p>
508
503 <dl> 509 <dl>
504 510
505 <dt><i>parent</i> (QWidget)</dt> 511 <dt><i>parent</i> (QWidget)</dt>
506 <dd> 512 <dd>
507 parent widget of the dialog 513 parent widget of the dialog
543 <hr /> 549 <hr />
544 <hr /> 550 <hr />
545 <a NAME="getOpenFilePath" ID="getOpenFilePath"></a> 551 <a NAME="getOpenFilePath" ID="getOpenFilePath"></a>
546 <h2>getOpenFilePath</h2> 552 <h2>getOpenFilePath</h2>
547 <b>getOpenFilePath</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>) 553 <b>getOpenFilePath</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
548
549 <p> 554 <p>
550 Module function to get the path of a file for opening it. 555 Module function to get the path of a file for opening it.
551 </p> 556 </p>
557
552 <dl> 558 <dl>
553 559
554 <dt><i>parent</i> (QWidget)</dt> 560 <dt><i>parent</i> (QWidget)</dt>
555 <dd> 561 <dd>
556 parent widget of the dialog 562 parent widget of the dialog
588 <hr /> 594 <hr />
589 <hr /> 595 <hr />
590 <a NAME="getOpenFilePathAndFilter" ID="getOpenFilePathAndFilter"></a> 596 <a NAME="getOpenFilePathAndFilter" ID="getOpenFilePathAndFilter"></a>
591 <h2>getOpenFilePathAndFilter</h2> 597 <h2>getOpenFilePathAndFilter</h2>
592 <b>getOpenFilePathAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>) 598 <b>getOpenFilePathAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>)
593
594 <p> 599 <p>
595 Module function to get the path of a file for opening it and the selected 600 Module function to get the path of a file for opening it and the selected
596 file name filter. 601 file name filter.
597 </p> 602 </p>
603
598 <dl> 604 <dl>
599 605
600 <dt><i>parent</i> (QWidget)</dt> 606 <dt><i>parent</i> (QWidget)</dt>
601 <dd> 607 <dd>
602 parent widget of the dialog 608 parent widget of the dialog
638 <hr /> 644 <hr />
639 <hr /> 645 <hr />
640 <a NAME="getOpenFilePaths" ID="getOpenFilePaths"></a> 646 <a NAME="getOpenFilePaths" ID="getOpenFilePaths"></a>
641 <h2>getOpenFilePaths</h2> 647 <h2>getOpenFilePaths</h2>
642 <b>getOpenFilePaths</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>) 648 <b>getOpenFilePaths</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
643
644 <p> 649 <p>
645 Module function to get a list of paths of files for opening. 650 Module function to get a list of paths of files for opening.
646 </p> 651 </p>
652
647 <dl> 653 <dl>
648 654
649 <dt><i>parent</i> (QWidget)</dt> 655 <dt><i>parent</i> (QWidget)</dt>
650 <dd> 656 <dd>
651 parent widget of the dialog 657 parent widget of the dialog
683 <hr /> 689 <hr />
684 <hr /> 690 <hr />
685 <a NAME="getSaveFileName" ID="getSaveFileName"></a> 691 <a NAME="getSaveFileName" ID="getSaveFileName"></a>
686 <h2>getSaveFileName</h2> 692 <h2>getSaveFileName</h2>
687 <b>getSaveFileName</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>) 693 <b>getSaveFileName</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
688
689 <p> 694 <p>
690 Module function to get the name of a file for saving. 695 Module function to get the name of a file for saving.
691 </p> 696 </p>
697
692 <dl> 698 <dl>
693 699
694 <dt><i>parent</i> (QWidget)</dt> 700 <dt><i>parent</i> (QWidget)</dt>
695 <dd> 701 <dd>
696 parent widget of the dialog 702 parent widget of the dialog
728 <hr /> 734 <hr />
729 <hr /> 735 <hr />
730 <a NAME="getSaveFileNameAndFilter" ID="getSaveFileNameAndFilter"></a> 736 <a NAME="getSaveFileNameAndFilter" ID="getSaveFileNameAndFilter"></a>
731 <h2>getSaveFileNameAndFilter</h2> 737 <h2>getSaveFileNameAndFilter</h2>
732 <b>getSaveFileNameAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>) 738 <b>getSaveFileNameAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>)
733
734 <p> 739 <p>
735 Module function to get the name of a file for saving and the selected file name 740 Module function to get the name of a file for saving and the selected file name
736 filter. 741 filter.
737 </p> 742 </p>
743
738 <dl> 744 <dl>
739 745
740 <dt><i>parent</i> (QWidget)</dt> 746 <dt><i>parent</i> (QWidget)</dt>
741 <dd> 747 <dd>
742 parent widget of the dialog 748 parent widget of the dialog
778 <hr /> 784 <hr />
779 <hr /> 785 <hr />
780 <a NAME="getSaveFilePath" ID="getSaveFilePath"></a> 786 <a NAME="getSaveFilePath" ID="getSaveFilePath"></a>
781 <h2>getSaveFilePath</h2> 787 <h2>getSaveFilePath</h2>
782 <b>getSaveFilePath</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>) 788 <b>getSaveFilePath</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
783
784 <p> 789 <p>
785 Module function to get the path of a file for saving. 790 Module function to get the path of a file for saving.
786 </p> 791 </p>
792
787 <dl> 793 <dl>
788 794
789 <dt><i>parent</i> (QWidget)</dt> 795 <dt><i>parent</i> (QWidget)</dt>
790 <dd> 796 <dd>
791 parent widget of the dialog 797 parent widget of the dialog
823 <hr /> 829 <hr />
824 <hr /> 830 <hr />
825 <a NAME="getSaveFilePathAndFilter" ID="getSaveFilePathAndFilter"></a> 831 <a NAME="getSaveFilePathAndFilter" ID="getSaveFilePathAndFilter"></a>
826 <h2>getSaveFilePathAndFilter</h2> 832 <h2>getSaveFilePathAndFilter</h2>
827 <b>getSaveFilePathAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>) 833 <b>getSaveFilePathAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>)
828
829 <p> 834 <p>
830 Module function to get the path of a file for saving and the selected 835 Module function to get the path of a file for saving and the selected
831 file name filter. 836 file name filter.
832 </p> 837 </p>
838
833 <dl> 839 <dl>
834 840
835 <dt><i>parent</i> (QWidget)</dt> 841 <dt><i>parent</i> (QWidget)</dt>
836 <dd> 842 <dd>
837 parent widget of the dialog 843 parent widget of the dialog

eric ide

mercurial