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

branch
eric7
changeset 9239
3c605ab5a8c7
parent 9209
b99e7fd55fd3
child 10479
856476537696
equal deleted inserted replaced
9238:a7cbf3d61498 9239:3c605ab5a8c7
32 <tr> 32 <tr>
33 <td><a href="#getExistingDirectory">getExistingDirectory</a></td> 33 <td><a href="#getExistingDirectory">getExistingDirectory</a></td>
34 <td>Module function to get the name of a directory.</td> 34 <td>Module function to get the name of a directory.</td>
35 </tr> 35 </tr>
36 <tr> 36 <tr>
37 <td><a href="#getExistingDirectoryPath">getExistingDirectoryPath</a></td>
38 <td>Module function to get the path of a directory.</td>
39 </tr>
40 <tr>
41 <td><a href="#getOpenFilPathsAndFilter">getOpenFilPathsAndFilter</a></td>
42 <td>Module function to get a list of paths of files for opening and the selected file name filter.</td>
43 </tr>
44 <tr>
37 <td><a href="#getOpenFileAndDirNames">getOpenFileAndDirNames</a></td> 45 <td><a href="#getOpenFileAndDirNames">getOpenFileAndDirNames</a></td>
38 <td>Module function to get the names of files and directories for opening.</td> 46 <td>Module function to get the names of files and directories for opening.</td>
39 </tr> 47 </tr>
40 <tr> 48 <tr>
49 <td><a href="#getOpenFileAndDirPaths">getOpenFileAndDirPaths</a></td>
50 <td>Module function to get the paths of files and directories for opening.</td>
51 </tr>
52 <tr>
41 <td><a href="#getOpenFileName">getOpenFileName</a></td> 53 <td><a href="#getOpenFileName">getOpenFileName</a></td>
42 <td>Module function to get the name of a file for opening it.</td> 54 <td>Module function to get the name of a file for opening it.</td>
43 </tr> 55 </tr>
44 <tr> 56 <tr>
45 <td><a href="#getOpenFileNameAndFilter">getOpenFileNameAndFilter</a></td> 57 <td><a href="#getOpenFileNameAndFilter">getOpenFileNameAndFilter</a></td>
52 <tr> 64 <tr>
53 <td><a href="#getOpenFileNamesAndFilter">getOpenFileNamesAndFilter</a></td> 65 <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> 66 <td>Module function to get a list of names of files for opening and the selected file name filter.</td>
55 </tr> 67 </tr>
56 <tr> 68 <tr>
69 <td><a href="#getOpenFilePath">getOpenFilePath</a></td>
70 <td>Module function to get the path of a file for opening it.</td>
71 </tr>
72 <tr>
73 <td><a href="#getOpenFilePathAndFilter">getOpenFilePathAndFilter</a></td>
74 <td>Module function to get the path of a file for opening it and the selected file name filter.</td>
75 </tr>
76 <tr>
77 <td><a href="#getOpenFilePaths">getOpenFilePaths</a></td>
78 <td>Module function to get a list of paths of files for opening.</td>
79 </tr>
80 <tr>
57 <td><a href="#getSaveFileName">getSaveFileName</a></td> 81 <td><a href="#getSaveFileName">getSaveFileName</a></td>
58 <td>Module function to get the name of a file for saving it.</td> 82 <td>Module function to get the name of a file for saving.</td>
59 </tr> 83 </tr>
60 <tr> 84 <tr>
61 <td><a href="#getSaveFileNameAndFilter">getSaveFileNameAndFilter</a></td> 85 <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> 86 <td>Module function to get the name of a file for saving and the selected file name filter.</td>
87 </tr>
88 <tr>
89 <td><a href="#getSaveFilePath">getSaveFilePath</a></td>
90 <td>Module function to get the path of a file for saving.</td>
91 </tr>
92 <tr>
93 <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>
63 </tr> 95 </tr>
64 </table> 96 </table>
65 <hr /> 97 <hr />
66 <hr /> 98 <hr />
67 <a NAME="__reorderFilter" ID="__reorderFilter"></a> 99 <a NAME="__reorderFilter" ID="__reorderFilter"></a>
137 </dd> 169 </dd>
138 </dl> 170 </dl>
139 <div align="right"><a href="#top">Up</a></div> 171 <div align="right"><a href="#top">Up</a></div>
140 <hr /> 172 <hr />
141 <hr /> 173 <hr />
174 <a NAME="getExistingDirectoryPath" ID="getExistingDirectoryPath"></a>
175 <h2>getExistingDirectoryPath</h2>
176 <b>getExistingDirectoryPath</b>(<i>parent=None, caption="", directory="", options=QFileDialog.Option.ShowDirsOnly</i>)
177
178 <p>
179 Module function to get the path of a directory.
180 </p>
181 <dl>
182
183 <dt><i>parent</i> (QWidget)</dt>
184 <dd>
185 parent widget of the dialog
186 </dd>
187 <dt><i>caption</i> (str)</dt>
188 <dd>
189 window title of the dialog
190 </dd>
191 <dt><i>directory</i> (str or pathlib.Path)</dt>
192 <dd>
193 working directory of the dialog
194 </dd>
195 <dt><i>options</i> (QFileDialog.Options)</dt>
196 <dd>
197 various options for the dialog
198 </dd>
199 </dl>
200 <dl>
201 <dt>Return:</dt>
202 <dd>
203 path of selected directory
204 </dd>
205 </dl>
206 <dl>
207 <dt>Return Type:</dt>
208 <dd>
209 pathlib.Path
210 </dd>
211 </dl>
212 <div align="right"><a href="#top">Up</a></div>
213 <hr />
214 <hr />
215 <a NAME="getOpenFilPathsAndFilter" ID="getOpenFilPathsAndFilter"></a>
216 <h2>getOpenFilPathsAndFilter</h2>
217 <b>getOpenFilPathsAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>)
218
219 <p>
220 Module function to get a list of paths of files for opening and the
221 selected file name filter.
222 </p>
223 <dl>
224
225 <dt><i>parent</i> (QWidget)</dt>
226 <dd>
227 parent widget of the dialog
228 </dd>
229 <dt><i>caption</i> (str)</dt>
230 <dd>
231 window title of the dialog
232 </dd>
233 <dt><i>directory</i> (str or pathlib.Path)</dt>
234 <dd>
235 working directory of the dialog
236 </dd>
237 <dt><i>filterStr</i> (str)</dt>
238 <dd>
239 filter string for the dialog
240 </dd>
241 <dt><i>initialFilter</i> (str)</dt>
242 <dd>
243 initial filter for the dialog
244 </dd>
245 <dt><i>options</i> (QFileDialog.Options)</dt>
246 <dd>
247 various options for the dialog
248 </dd>
249 </dl>
250 <dl>
251 <dt>Return:</dt>
252 <dd>
253 list of file paths to be opened and selected filter
254 </dd>
255 </dl>
256 <dl>
257 <dt>Return Type:</dt>
258 <dd>
259 tuple of (list of pathlib.Path, str)
260 </dd>
261 </dl>
262 <div align="right"><a href="#top">Up</a></div>
263 <hr />
264 <hr />
142 <a NAME="getOpenFileAndDirNames" ID="getOpenFileAndDirNames"></a> 265 <a NAME="getOpenFileAndDirNames" ID="getOpenFileAndDirNames"></a>
143 <h2>getOpenFileAndDirNames</h2> 266 <h2>getOpenFileAndDirNames</h2>
144 <b>getOpenFileAndDirNames</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>) 267 <b>getOpenFileAndDirNames</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
145 268
146 <p> 269 <p>
182 </dd> 305 </dd>
183 </dl> 306 </dl>
184 <div align="right"><a href="#top">Up</a></div> 307 <div align="right"><a href="#top">Up</a></div>
185 <hr /> 308 <hr />
186 <hr /> 309 <hr />
310 <a NAME="getOpenFileAndDirPaths" ID="getOpenFileAndDirPaths"></a>
311 <h2>getOpenFileAndDirPaths</h2>
312 <b>getOpenFileAndDirPaths</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
313
314 <p>
315 Module function to get the paths of files and directories for opening.
316 </p>
317 <dl>
318
319 <dt><i>parent</i> (QWidget)</dt>
320 <dd>
321 parent widget of the dialog
322 </dd>
323 <dt><i>caption</i> (str)</dt>
324 <dd>
325 window title of the dialog
326 </dd>
327 <dt><i>directory</i> (str or pathlib.Path)</dt>
328 <dd>
329 working directory of the dialog
330 </dd>
331 <dt><i>filterStr</i> (str)</dt>
332 <dd>
333 filter string for the dialog
334 </dd>
335 <dt><i>options</i> (QFileDialog.Options)</dt>
336 <dd>
337 various options for the dialog
338 </dd>
339 </dl>
340 <dl>
341 <dt>Return:</dt>
342 <dd>
343 paths of the selected files and folders
344 </dd>
345 </dl>
346 <dl>
347 <dt>Return Type:</dt>
348 <dd>
349 list of pathlib.Path
350 </dd>
351 </dl>
352 <div align="right"><a href="#top">Up</a></div>
353 <hr />
354 <hr />
187 <a NAME="getOpenFileName" ID="getOpenFileName"></a> 355 <a NAME="getOpenFileName" ID="getOpenFileName"></a>
188 <h2>getOpenFileName</h2> 356 <h2>getOpenFileName</h2>
189 <b>getOpenFileName</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>) 357 <b>getOpenFileName</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
190 358
191 <p> 359 <p>
372 </dd> 540 </dd>
373 </dl> 541 </dl>
374 <div align="right"><a href="#top">Up</a></div> 542 <div align="right"><a href="#top">Up</a></div>
375 <hr /> 543 <hr />
376 <hr /> 544 <hr />
545 <a NAME="getOpenFilePath" ID="getOpenFilePath"></a>
546 <h2>getOpenFilePath</h2>
547 <b>getOpenFilePath</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
548
549 <p>
550 Module function to get the path of a file for opening it.
551 </p>
552 <dl>
553
554 <dt><i>parent</i> (QWidget)</dt>
555 <dd>
556 parent widget of the dialog
557 </dd>
558 <dt><i>caption</i> (str)</dt>
559 <dd>
560 window title of the dialog
561 </dd>
562 <dt><i>directory</i> (str or pathlib.Path)</dt>
563 <dd>
564 working directory of the dialog
565 </dd>
566 <dt><i>filterStr</i> (str)</dt>
567 <dd>
568 filter string for the dialog
569 </dd>
570 <dt><i>options</i> (QFileDialog.Options)</dt>
571 <dd>
572 various options for the dialog
573 </dd>
574 </dl>
575 <dl>
576 <dt>Return:</dt>
577 <dd>
578 path of file to be opened
579 </dd>
580 </dl>
581 <dl>
582 <dt>Return Type:</dt>
583 <dd>
584 pathlib.Path
585 </dd>
586 </dl>
587 <div align="right"><a href="#top">Up</a></div>
588 <hr />
589 <hr />
590 <a NAME="getOpenFilePathAndFilter" ID="getOpenFilePathAndFilter"></a>
591 <h2>getOpenFilePathAndFilter</h2>
592 <b>getOpenFilePathAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>)
593
594 <p>
595 Module function to get the path of a file for opening it and the selected
596 file name filter.
597 </p>
598 <dl>
599
600 <dt><i>parent</i> (QWidget)</dt>
601 <dd>
602 parent widget of the dialog
603 </dd>
604 <dt><i>caption</i> (str)</dt>
605 <dd>
606 window title of the dialog
607 </dd>
608 <dt><i>directory</i> (str or pathlib.Path)</dt>
609 <dd>
610 working directory of the dialog
611 </dd>
612 <dt><i>filterStr</i> (str)</dt>
613 <dd>
614 filter string for the dialog
615 </dd>
616 <dt><i>initialFilter</i> (str)</dt>
617 <dd>
618 initial filter for the dialog
619 </dd>
620 <dt><i>options</i> (QFileDialog.Options)</dt>
621 <dd>
622 various options for the dialog
623 </dd>
624 </dl>
625 <dl>
626 <dt>Return:</dt>
627 <dd>
628 path of file to be opened and selected filter
629 </dd>
630 </dl>
631 <dl>
632 <dt>Return Type:</dt>
633 <dd>
634 tuple of (pathlib.Path, str)
635 </dd>
636 </dl>
637 <div align="right"><a href="#top">Up</a></div>
638 <hr />
639 <hr />
640 <a NAME="getOpenFilePaths" ID="getOpenFilePaths"></a>
641 <h2>getOpenFilePaths</h2>
642 <b>getOpenFilePaths</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
643
644 <p>
645 Module function to get a list of paths of files for opening.
646 </p>
647 <dl>
648
649 <dt><i>parent</i> (QWidget)</dt>
650 <dd>
651 parent widget of the dialog
652 </dd>
653 <dt><i>caption</i> (str)</dt>
654 <dd>
655 window title of the dialog
656 </dd>
657 <dt><i>directory</i> (str or pathlib.Path)</dt>
658 <dd>
659 working directory of the dialog
660 </dd>
661 <dt><i>filterStr</i> (str)</dt>
662 <dd>
663 filter string for the dialog
664 </dd>
665 <dt><i>options</i> (QFileDialog.Options)</dt>
666 <dd>
667 various options for the dialog
668 </dd>
669 </dl>
670 <dl>
671 <dt>Return:</dt>
672 <dd>
673 list of file paths to be opened
674 </dd>
675 </dl>
676 <dl>
677 <dt>Return Type:</dt>
678 <dd>
679 list of pathlib.Path
680 </dd>
681 </dl>
682 <div align="right"><a href="#top">Up</a></div>
683 <hr />
684 <hr />
377 <a NAME="getSaveFileName" ID="getSaveFileName"></a> 685 <a NAME="getSaveFileName" ID="getSaveFileName"></a>
378 <h2>getSaveFileName</h2> 686 <h2>getSaveFileName</h2>
379 <b>getSaveFileName</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>) 687 <b>getSaveFileName</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
380 688
381 <p> 689 <p>
382 Module function to get the name of a file for saving it. 690 Module function to get the name of a file for saving.
383 </p> 691 </p>
384 <dl> 692 <dl>
385 693
386 <dt><i>parent</i> (QWidget)</dt> 694 <dt><i>parent</i> (QWidget)</dt>
387 <dd> 695 <dd>
422 <a NAME="getSaveFileNameAndFilter" ID="getSaveFileNameAndFilter"></a> 730 <a NAME="getSaveFileNameAndFilter" ID="getSaveFileNameAndFilter"></a>
423 <h2>getSaveFileNameAndFilter</h2> 731 <h2>getSaveFileNameAndFilter</h2>
424 <b>getSaveFileNameAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>) 732 <b>getSaveFileNameAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>)
425 733
426 <p> 734 <p>
427 Module function to get the name of a file for saving it and the selected 735 Module function to get the name of a file for saving and the selected file name
736 filter.
737 </p>
738 <dl>
739
740 <dt><i>parent</i> (QWidget)</dt>
741 <dd>
742 parent widget of the dialog
743 </dd>
744 <dt><i>caption</i> (str)</dt>
745 <dd>
746 window title of the dialog
747 </dd>
748 <dt><i>directory</i> (str)</dt>
749 <dd>
750 working directory of the dialog
751 </dd>
752 <dt><i>filterStr</i> (str)</dt>
753 <dd>
754 filter string for the dialog
755 </dd>
756 <dt><i>initialFilter</i> (str)</dt>
757 <dd>
758 initial filter for the dialog
759 </dd>
760 <dt><i>options</i> (QFileDialog.Options)</dt>
761 <dd>
762 various options for the dialog
763 </dd>
764 </dl>
765 <dl>
766 <dt>Return:</dt>
767 <dd>
768 name of file to be saved and selected filte
769 </dd>
770 </dl>
771 <dl>
772 <dt>Return Type:</dt>
773 <dd>
774 tuple of (str, str)
775 </dd>
776 </dl>
777 <div align="right"><a href="#top">Up</a></div>
778 <hr />
779 <hr />
780 <a NAME="getSaveFilePath" ID="getSaveFilePath"></a>
781 <h2>getSaveFilePath</h2>
782 <b>getSaveFilePath</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
783
784 <p>
785 Module function to get the path of a file for saving.
786 </p>
787 <dl>
788
789 <dt><i>parent</i> (QWidget)</dt>
790 <dd>
791 parent widget of the dialog
792 </dd>
793 <dt><i>caption</i> (str)</dt>
794 <dd>
795 window title of the dialog
796 </dd>
797 <dt><i>directory</i> (str or pathlib.Path)</dt>
798 <dd>
799 working directory of the dialog
800 </dd>
801 <dt><i>filterStr</i> (str)</dt>
802 <dd>
803 filter string for the dialog
804 </dd>
805 <dt><i>options</i> (QFileDialog.Options)</dt>
806 <dd>
807 various options for the dialog
808 </dd>
809 </dl>
810 <dl>
811 <dt>Return:</dt>
812 <dd>
813 path of file to be saved
814 </dd>
815 </dl>
816 <dl>
817 <dt>Return Type:</dt>
818 <dd>
819 pathlib.Path
820 </dd>
821 </dl>
822 <div align="right"><a href="#top">Up</a></div>
823 <hr />
824 <hr />
825 <a NAME="getSaveFilePathAndFilter" ID="getSaveFilePathAndFilter"></a>
826 <h2>getSaveFilePathAndFilter</h2>
827 <b>getSaveFilePathAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>)
828
829 <p>
830 Module function to get the path of a file for saving and the selected
428 file name filter. 831 file name filter.
429 </p> 832 </p>
430 <dl> 833 <dl>
431 834
432 <dt><i>parent</i> (QWidget)</dt> 835 <dt><i>parent</i> (QWidget)</dt>
435 </dd> 838 </dd>
436 <dt><i>caption</i> (str)</dt> 839 <dt><i>caption</i> (str)</dt>
437 <dd> 840 <dd>
438 window title of the dialog 841 window title of the dialog
439 </dd> 842 </dd>
440 <dt><i>directory</i> (str)</dt> 843 <dt><i>directory</i> (str or pathlib.Path)</dt>
441 <dd> 844 <dd>
442 working directory of the dialog 845 working directory of the dialog
443 </dd> 846 </dd>
444 <dt><i>filterStr</i> (str)</dt> 847 <dt><i>filterStr</i> (str)</dt>
445 <dd> 848 <dd>
455 </dd> 858 </dd>
456 </dl> 859 </dl>
457 <dl> 860 <dl>
458 <dt>Return:</dt> 861 <dt>Return:</dt>
459 <dd> 862 <dd>
460 name of file to be saved and selected filte 863 path of file to be saved and selected filte
461 </dd> 864 </dd>
462 </dl> 865 </dl>
463 <dl> 866 <dl>
464 <dt>Return Type:</dt> 867 <dt>Return Type:</dt>
465 <dd> 868 <dd>
466 tuple of (str, str) 869 tuple of (pathlib.Path, str)
467 </dd> 870 </dd>
468 </dl> 871 </dl>
469 <div align="right"><a href="#top">Up</a></div> 872 <div align="right"><a href="#top">Up</a></div>
470 <hr /> 873 <hr />
471 </body></html> 874 </body></html>

eric ide

mercurial