src/eric7/Documentation/Source/eric7.Project.Project.html

branch
eric7
changeset 10256
1b728f26d1ae
parent 10114
593c609f80ee
child 10321
4a017fdf316f
equal deleted inserted replaced
10255:a25f95af0a51 10256:1b728f26d1ae
673 <tr> 673 <tr>
674 <td><a href="#Project.getFileCategoryFilterString">getFileCategoryFilterString</a></td> 674 <td><a href="#Project.getFileCategoryFilterString">getFileCategoryFilterString</a></td>
675 <td>Public method to get a file selection string for the given categories.</td> 675 <td>Public method to get a file selection string for the given categories.</td>
676 </tr> 676 </tr>
677 <tr> 677 <tr>
678 <td><a href="#Project.getFileCategoryFilters">getFileCategoryFilters</a></td>
679 <td>Public method to get a list of file selection filters for the given categories.</td>
680 </tr>
681 <tr>
678 <td><a href="#Project.getFileCategoryString">getFileCategoryString</a></td> 682 <td><a href="#Project.getFileCategoryString">getFileCategoryString</a></td>
679 <td>Public method to get a user string for the given category.</td> 683 <td>Public method to get a user string for the given category.</td>
680 </tr> 684 </tr>
681 <tr> 685 <tr>
682 <td><a href="#Project.getFileCategoryType">getFileCategoryType</a></td> 686 <td><a href="#Project.getFileCategoryType">getFileCategoryType</a></td>
2700 <dt>Return Type:</dt> 2704 <dt>Return Type:</dt>
2701 <dd> 2705 <dd>
2702 str 2706 str
2703 </dd> 2707 </dd>
2704 </dl> 2708 </dl>
2709 <a NAME="Project.getFileCategoryFilters" ID="Project.getFileCategoryFilters"></a>
2710 <h4>Project.getFileCategoryFilters</h4>
2711 <b>getFileCategoryFilters</b>(<i>categories=None, withOthers=False, withAll=True</i>)
2712
2713 <p>
2714 Public method to get a list of file selection filters for the given categories.
2715 </p>
2716 <dl>
2717
2718 <dt><i>categories</i> (list of str (optional))</dt>
2719 <dd>
2720 list of file type categories (defaults to None).
2721 A value of None means all categories except 'OTHERS'.
2722 </dd>
2723 <dt><i>withOthers</i> (bool (optional))</dt>
2724 <dd>
2725 flag indicating to include the 'OTHERS' category
2726 (defaults to False)
2727 </dd>
2728 <dt><i>withAll</i> (bool (optional))</dt>
2729 <dd>
2730 flag indicating to include a filter for 'All Files'
2731 (defaults to True)
2732 </dd>
2733 </dl>
2734 <dl>
2735 <dt>Return:</dt>
2736 <dd>
2737 list of file selection filter strings
2738 </dd>
2739 </dl>
2740 <dl>
2741 <dt>Return Type:</dt>
2742 <dd>
2743 list of str
2744 </dd>
2745 </dl>
2705 <a NAME="Project.getFileCategoryString" ID="Project.getFileCategoryString"></a> 2746 <a NAME="Project.getFileCategoryString" ID="Project.getFileCategoryString"></a>
2706 <h4>Project.getFileCategoryString</h4> 2747 <h4>Project.getFileCategoryString</h4>
2707 <b>getFileCategoryString</b>(<i>category</i>) 2748 <b>getFileCategoryString</b>(<i>category</i>)
2708 2749
2709 <p> 2750 <p>

eric ide

mercurial