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

branch
eric7
changeset 9238
a7cbf3d61498
parent 9209
b99e7fd55fd3
child 10479
856476537696
equal deleted inserted replaced
9237:03c714bd4ebf 9238:a7cbf3d61498
73 </tr> 73 </tr>
74 <tr> 74 <tr>
75 <td><a href="#EricComboPathPicker.getPathItems">getPathItems</a></td> 75 <td><a href="#EricComboPathPicker.getPathItems">getPathItems</a></td>
76 <td>Public method to get the list of remembered paths.</td> 76 <td>Public method to get the list of remembered paths.</td>
77 </tr> 77 </tr>
78 <tr>
79 <td><a href="#EricComboPathPicker.getPathLibItems">getPathLibItems</a></td>
80 <td>Public method to get the list of remembered paths.</td>
81 </tr>
78 </table> 82 </table>
79 <h3>Static Methods</h3> 83 <h3>Static Methods</h3>
80 84
81 <table> 85 <table>
82 <tr><td>None</td></tr> 86 <tr><td>None</td></tr>
104 Public method to get the list of remembered paths. 108 Public method to get the list of remembered paths.
105 </p> 109 </p>
106 <dl> 110 <dl>
107 <dt>Return:</dt> 111 <dt>Return:</dt>
108 <dd> 112 <dd>
109 list od remembered paths 113 list of remembered paths
110 </dd> 114 </dd>
111 </dl> 115 </dl>
112 <dl> 116 <dl>
113 <dt>Return Type:</dt> 117 <dt>Return Type:</dt>
114 <dd> 118 <dd>
115 list of str 119 list of str
120 </dd>
121 </dl>
122 <a NAME="EricComboPathPicker.getPathLibItems" ID="EricComboPathPicker.getPathLibItems"></a>
123 <h4>EricComboPathPicker.getPathLibItems</h4>
124 <b>getPathLibItems</b>(<i></i>)
125
126 <p>
127 Public method to get the list of remembered paths.
128 </p>
129 <dl>
130 <dt>Return:</dt>
131 <dd>
132 list of remembered paths
133 </dd>
134 </dl>
135 <dl>
136 <dt>Return Type:</dt>
137 <dd>
138 list of pathlib.Path
116 </dd> 139 </dd>
117 </dl> 140 </dl>
118 <div align="right"><a href="#top">Up</a></div> 141 <div align="right"><a href="#top">Up</a></div>
119 <hr /> 142 <hr />
120 <hr /> 143 <hr />
267 <tr> 290 <tr>
268 <td><a href="#EricPathPickerBase.defaultDirectory">defaultDirectory</a></td> 291 <td><a href="#EricPathPickerBase.defaultDirectory">defaultDirectory</a></td>
269 <td>Public method to get the default directory.</td> 292 <td>Public method to get the default directory.</td>
270 </tr> 293 </tr>
271 <tr> 294 <tr>
295 <td><a href="#EricPathPickerBase.defaultDirectoryPath">defaultDirectoryPath</a></td>
296 <td>Public method to get the default directory as a pathlib.Path object.</td>
297 </tr>
298 <tr>
272 <td><a href="#EricPathPickerBase.editorEnabled">editorEnabled</a></td> 299 <td><a href="#EricPathPickerBase.editorEnabled">editorEnabled</a></td>
273 <td>Public method to get the path editor's enabled state.</td> 300 <td>Public method to get the path editor's enabled state.</td>
274 </tr> 301 </tr>
275 <tr> 302 <tr>
276 <td><a href="#EricPathPickerBase.editorToolTip">editorToolTip</a></td> 303 <td><a href="#EricPathPickerBase.editorToolTip">editorToolTip</a></td>
313 <td>Public method to set the tool button tool tip.</td> 340 <td>Public method to set the tool button tool tip.</td>
314 </tr> 341 </tr>
315 <tr> 342 <tr>
316 <td><a href="#EricPathPickerBase.setCurrentIndex">setCurrentIndex</a></td> 343 <td><a href="#EricPathPickerBase.setCurrentIndex">setCurrentIndex</a></td>
317 <td>Public slot to set the current index.</td> 344 <td>Public slot to set the current index.</td>
345 </tr>
346 <tr>
347 <td><a href="#EricPathPickerBase.setCurrentPath">setCurrentPath</a></td>
348 <td>Public method to set the current path.</td>
318 </tr> 349 </tr>
319 <tr> 350 <tr>
320 <td><a href="#EricPathPickerBase.setCurrentText">setCurrentText</a></td> 351 <td><a href="#EricPathPickerBase.setCurrentText">setCurrentText</a></td>
321 <td>Public slot to set the current text.</td> 352 <td>Public slot to set the current text.</td>
322 </tr> 353 </tr>
474 <p> 505 <p>
475 Public method to add a paths to the current list. 506 Public method to add a paths to the current list.
476 </p> 507 </p>
477 <dl> 508 <dl>
478 509
479 <dt><i>fpath</i> (str)</dt> 510 <dt><i>fpath</i> (str or pathlib.Path)</dt>
480 <dd> 511 <dd>
481 path to add 512 path to add
482 </dd> 513 </dd>
483 </dl> 514 </dl>
484 <a NAME="EricPathPickerBase.addItems" ID="EricPathPickerBase.addItems"></a> 515 <a NAME="EricPathPickerBase.addItems" ID="EricPathPickerBase.addItems"></a>
488 <p> 519 <p>
489 Public method to add paths to the current list. 520 Public method to add paths to the current list.
490 </p> 521 </p>
491 <dl> 522 <dl>
492 523
493 <dt><i>pathsList</i> (list of str)</dt> 524 <dt><i>pathsList</i> (list of str or pathlib.Path)</dt>
494 <dd> 525 <dd>
495 list of paths to add 526 list of paths
496 </dd> 527 </dd>
497 </dl> 528 </dl>
498 <a NAME="EricPathPickerBase.buttonToolTip" ID="EricPathPickerBase.buttonToolTip"></a> 529 <a NAME="EricPathPickerBase.buttonToolTip" ID="EricPathPickerBase.buttonToolTip"></a>
499 <h4>EricPathPickerBase.buttonToolTip</h4> 530 <h4>EricPathPickerBase.buttonToolTip</h4>
500 <b>buttonToolTip</b>(<i></i>) 531 <b>buttonToolTip</b>(<i></i>)
572 <dt>Return Type:</dt> 603 <dt>Return Type:</dt>
573 <dd> 604 <dd>
574 str 605 str
575 </dd> 606 </dd>
576 </dl> 607 </dl>
608 <a NAME="EricPathPickerBase.defaultDirectoryPath" ID="EricPathPickerBase.defaultDirectoryPath"></a>
609 <h4>EricPathPickerBase.defaultDirectoryPath</h4>
610 <b>defaultDirectoryPath</b>(<i></i>)
611
612 <p>
613 Public method to get the default directory as a pathlib.Path object.
614 </p>
615 <dl>
616 <dt>Return:</dt>
617 <dd>
618 default directory
619 </dd>
620 </dl>
621 <dl>
622 <dt>Return Type:</dt>
623 <dd>
624 pathlib.Path
625 </dd>
626 </dl>
577 <a NAME="EricPathPickerBase.editorEnabled" ID="EricPathPickerBase.editorEnabled"></a> 627 <a NAME="EricPathPickerBase.editorEnabled" ID="EricPathPickerBase.editorEnabled"></a>
578 <h4>EricPathPickerBase.editorEnabled</h4> 628 <h4>EricPathPickerBase.editorEnabled</h4>
579 <b>editorEnabled</b>(<i></i>) 629 <b>editorEnabled</b>(<i></i>)
580 630
581 <p> 631 <p>
631 str 681 str
632 </dd> 682 </dd>
633 </dl> 683 </dl>
634 <a NAME="EricPathPickerBase.firstPath" ID="EricPathPickerBase.firstPath"></a> 684 <a NAME="EricPathPickerBase.firstPath" ID="EricPathPickerBase.firstPath"></a>
635 <h4>EricPathPickerBase.firstPath</h4> 685 <h4>EricPathPickerBase.firstPath</h4>
636 <b>firstPath</b>(<i>toNative=True</i>) 686 <b>firstPath</b>(<i></i>)
637 687
638 <p> 688 <p>
639 Public method to get the first path of a list of entered paths. 689 Public method to get the first path of a list of entered paths.
640 </p> 690 </p>
641 <dl> 691 <dl>
642
643 <dt><i>toNative</i> (bool)</dt>
644 <dd>
645 flag indicating to convert the path into
646 a native format
647 </dd>
648 </dl>
649 <dl>
650 <dt>Return:</dt> 692 <dt>Return:</dt>
651 <dd> 693 <dd>
652 first path 694 first path
653 </dd> 695 </dd>
654 </dl> 696 </dl>
655 <dl> 697 <dl>
656 <dt>Return Type:</dt> 698 <dt>Return Type:</dt>
657 <dd> 699 <dd>
658 str 700 pathlib.Path
659 </dd> 701 </dd>
660 </dl> 702 </dl>
661 <a NAME="EricPathPickerBase.isPickerEnabled" ID="EricPathPickerBase.isPickerEnabled"></a> 703 <a NAME="EricPathPickerBase.isPickerEnabled" ID="EricPathPickerBase.isPickerEnabled"></a>
662 <h4>EricPathPickerBase.isPickerEnabled</h4> 704 <h4>EricPathPickerBase.isPickerEnabled</h4>
663 <b>isPickerEnabled</b>(<i></i>) 705 <b>isPickerEnabled</b>(<i></i>)
696 bool 738 bool
697 </dd> 739 </dd>
698 </dl> 740 </dl>
699 <a NAME="EricPathPickerBase.lastPath" ID="EricPathPickerBase.lastPath"></a> 741 <a NAME="EricPathPickerBase.lastPath" ID="EricPathPickerBase.lastPath"></a>
700 <h4>EricPathPickerBase.lastPath</h4> 742 <h4>EricPathPickerBase.lastPath</h4>
701 <b>lastPath</b>(<i>toNative=True</i>) 743 <b>lastPath</b>(<i></i>)
702 744
703 <p> 745 <p>
704 Public method to get the last path of a list of entered paths. 746 Public method to get the last path of a list of entered paths.
705 </p> 747 </p>
706 <dl> 748 <dl>
707
708 <dt><i>toNative</i> (bool)</dt>
709 <dd>
710 flag indicating to convert the path into
711 a native format
712 </dd>
713 </dl>
714 <dl>
715 <dt>Return:</dt> 749 <dt>Return:</dt>
716 <dd> 750 <dd>
717 last path 751 last path
718 </dd> 752 </dd>
719 </dl> 753 </dl>
720 <dl> 754 <dl>
721 <dt>Return Type:</dt> 755 <dt>Return Type:</dt>
722 <dd> 756 <dd>
723 str 757 pathlib.Path
724 </dd> 758 </dd>
725 </dl> 759 </dl>
726 <a NAME="EricPathPickerBase.mode" ID="EricPathPickerBase.mode"></a> 760 <a NAME="EricPathPickerBase.mode" ID="EricPathPickerBase.mode"></a>
727 <h4>EricPathPickerBase.mode</h4> 761 <h4>EricPathPickerBase.mode</h4>
728 <b>mode</b>(<i></i>) 762 <b>mode</b>(<i></i>)
742 EricPathPickerModes 776 EricPathPickerModes
743 </dd> 777 </dd>
744 </dl> 778 </dl>
745 <a NAME="EricPathPickerBase.path" ID="EricPathPickerBase.path"></a> 779 <a NAME="EricPathPickerBase.path" ID="EricPathPickerBase.path"></a>
746 <h4>EricPathPickerBase.path</h4> 780 <h4>EricPathPickerBase.path</h4>
747 <b>path</b>(<i>toNative=True</i>) 781 <b>path</b>(<i></i>)
748 782
749 <p> 783 <p>
750 Public method to get the current path. 784 Public method to get the current path.
751 </p> 785 </p>
752 <dl> 786 <dl>
753
754 <dt><i>toNative</i> (bool)</dt>
755 <dd>
756 flag indicating to convert the path into
757 a native format
758 </dd>
759 </dl>
760 <dl>
761 <dt>Return:</dt> 787 <dt>Return:</dt>
762 <dd> 788 <dd>
763 current path 789 current path
764 </dd> 790 </dd>
765 </dl> 791 </dl>
766 <dl> 792 <dl>
767 <dt>Return Type:</dt> 793 <dt>Return Type:</dt>
768 <dd> 794 <dd>
769 str 795 pathlib.Path
770 </dd> 796 </dd>
771 </dl> 797 </dl>
772 <a NAME="EricPathPickerBase.paths" ID="EricPathPickerBase.paths"></a> 798 <a NAME="EricPathPickerBase.paths" ID="EricPathPickerBase.paths"></a>
773 <h4>EricPathPickerBase.paths</h4> 799 <h4>EricPathPickerBase.paths</h4>
774 <b>paths</b>(<i>toNative=True</i>) 800 <b>paths</b>(<i></i>)
775 801
776 <p> 802 <p>
777 Public method to get the list of entered paths. 803 Public method to get the list of entered paths.
778 </p> 804 </p>
779 <dl> 805 <dl>
780
781 <dt><i>toNative</i> (bool)</dt>
782 <dd>
783 flag indicating to convert the path into
784 a native format
785 </dd>
786 </dl>
787 <dl>
788 <dt>Return:</dt> 806 <dt>Return:</dt>
789 <dd> 807 <dd>
790 entered paths 808 entered paths
791 </dd> 809 </dd>
792 </dl> 810 </dl>
793 <dl> 811 <dl>
794 <dt>Return Type:</dt> 812 <dt>Return Type:</dt>
795 <dd> 813 <dd>
796 list of str 814 list of pathlib.Path
797 </dd> 815 </dd>
798 </dl> 816 </dl>
799 <a NAME="EricPathPickerBase.setButtonToolTip" ID="EricPathPickerBase.setButtonToolTip"></a> 817 <a NAME="EricPathPickerBase.setButtonToolTip" ID="EricPathPickerBase.setButtonToolTip"></a>
800 <h4>EricPathPickerBase.setButtonToolTip</h4> 818 <h4>EricPathPickerBase.setButtonToolTip</h4>
801 <b>setButtonToolTip</b>(<i>tooltip</i>) 819 <b>setButtonToolTip</b>(<i>tooltip</i>)
822 <dt><i>index</i> (int)</dt> 840 <dt><i>index</i> (int)</dt>
823 <dd> 841 <dd>
824 index of the item to set current 842 index of the item to set current
825 </dd> 843 </dd>
826 </dl> 844 </dl>
845 <a NAME="EricPathPickerBase.setCurrentPath" ID="EricPathPickerBase.setCurrentPath"></a>
846 <h4>EricPathPickerBase.setCurrentPath</h4>
847 <b>setCurrentPath</b>(<i>fpath</i>)
848
849 <p>
850 Public method to set the current path.
851 </p>
852 <dl>
853
854 <dt><i>fpath</i> (pathlib.Path)</dt>
855 <dd>
856 current path
857 </dd>
858 </dl>
827 <a NAME="EricPathPickerBase.setCurrentText" ID="EricPathPickerBase.setCurrentText"></a> 859 <a NAME="EricPathPickerBase.setCurrentText" ID="EricPathPickerBase.setCurrentText"></a>
828 <h4>EricPathPickerBase.setCurrentText</h4> 860 <h4>EricPathPickerBase.setCurrentText</h4>
829 <b>setCurrentText</b>(<i>text</i>) 861 <b>setCurrentText</b>(<i>text</i>)
830 862
831 <p> 863 <p>
845 <p> 877 <p>
846 Public method to set the default directory. 878 Public method to set the default directory.
847 </p> 879 </p>
848 <dl> 880 <dl>
849 881
850 <dt><i>directory</i> (str)</dt> 882 <dt><i>directory</i> (str or pathlib.Path)</dt>
851 <dd> 883 <dd>
852 default directory 884 default directory
853 </dd> 885 </dd>
854 </dl> 886 </dl>
855 <a NAME="EricPathPickerBase.setEditText" ID="EricPathPickerBase.setEditText"></a> 887 <a NAME="EricPathPickerBase.setEditText" ID="EricPathPickerBase.setEditText"></a>
965 list of file name filters 997 list of file name filters
966 </dd> 998 </dd>
967 </dl> 999 </dl>
968 <a NAME="EricPathPickerBase.setPath" ID="EricPathPickerBase.setPath"></a> 1000 <a NAME="EricPathPickerBase.setPath" ID="EricPathPickerBase.setPath"></a>
969 <h4>EricPathPickerBase.setPath</h4> 1001 <h4>EricPathPickerBase.setPath</h4>
970 <b>setPath</b>(<i>fpath, toNative=True</i>) 1002 <b>setPath</b>(<i>fpath</i>)
971 1003
972 <p> 1004 <p>
973 Public method to set the current path. 1005 Public method to set the current path.
974 </p> 1006 </p>
975 <dl> 1007 <dl>
976 1008
977 <dt><i>fpath</i> (str)</dt> 1009 <dt><i>fpath</i> (str or pathlib.Path)</dt>
978 <dd> 1010 <dd>
979 path to be set 1011 path to be set
980 </dd>
981 <dt><i>toNative</i> (bool)</dt>
982 <dd>
983 flag indicating to convert the path into
984 a native format
985 </dd> 1012 </dd>
986 </dl> 1013 </dl>
987 <a NAME="EricPathPickerBase.setPathsList" ID="EricPathPickerBase.setPathsList"></a> 1014 <a NAME="EricPathPickerBase.setPathsList" ID="EricPathPickerBase.setPathsList"></a>
988 <h4>EricPathPickerBase.setPathsList</h4> 1015 <h4>EricPathPickerBase.setPathsList</h4>
989 <b>setPathsList</b>(<i>pathsList</i>) 1016 <b>setPathsList</b>(<i>pathsList</i>)
991 <p> 1018 <p>
992 Public method to set the paths list. 1019 Public method to set the paths list.
993 </p> 1020 </p>
994 <dl> 1021 <dl>
995 1022
996 <dt><i>pathsList</i> (list of str)</dt> 1023 <dt><i>pathsList</i> (list of str or pathlib.Path)</dt>
997 <dd> 1024 <dd>
998 list of paths 1025 list of paths
999 </dd> 1026 </dd>
1000 </dl> 1027 </dl>
1001 <a NAME="EricPathPickerBase.setPickerEnabled" ID="EricPathPickerBase.setPickerEnabled"></a> 1028 <a NAME="EricPathPickerBase.setPickerEnabled" ID="EricPathPickerBase.setPickerEnabled"></a>

eric ide

mercurial