Documentation/Source/eric6.Project.Project.html

changeset 5344
cd3a3d0d7823
parent 5254
c89ecaa0eda3
child 5352
ddcf6fd8c316
child 5353
60fcaa1c3c3c
equal deleted inserted replaced
5343:e9112dac1314 5344:cd3a3d0d7823
486 <td>Public method to get the most recently opened project.</td> 486 <td>Public method to get the most recently opened project.</td>
487 </tr><tr> 487 </tr><tr>
488 <td><a href="#Project.getProgrammingLanguages">getProgrammingLanguages</a></td> 488 <td><a href="#Project.getProgrammingLanguages">getProgrammingLanguages</a></td>
489 <td>Public method to get the programming languages supported by project.</td> 489 <td>Public method to get the programming languages supported by project.</td>
490 </tr><tr> 490 </tr><tr>
491 <td><a href="#Project.getProjectAuthor">getProjectAuthor</a></td>
492 <td>Public method to get the author of the project.</td>
493 </tr><tr>
494 <td><a href="#Project.getProjectAuthorEmail">getProjectAuthorEmail</a></td>
495 <td>Public method to get the email address of the project author.</td>
496 </tr><tr>
497 <td><a href="#Project.getProjectDescription">getProjectDescription</a></td>
498 <td>Public method to get the description of the project.</td>
499 </tr><tr>
491 <td><a href="#Project.getProjectDictionaries">getProjectDictionaries</a></td> 500 <td><a href="#Project.getProjectDictionaries">getProjectDictionaries</a></td>
492 <td>Public method to get the names of the project specific dictionaries.</td> 501 <td>Public method to get the names of the project specific dictionaries.</td>
493 </tr><tr> 502 </tr><tr>
494 <td><a href="#Project.getProjectFile">getProjectFile</a></td> 503 <td><a href="#Project.getProjectFile">getProjectFile</a></td>
495 <td>Public method to get the path of the project file.</td> 504 <td>Public method to get the path of the project file.</td>
496 </tr><tr> 505 </tr><tr>
506 <td><a href="#Project.getProjectFiles">getProjectFiles</a></td>
507 <td>Public method to get the file entries of the given type.</td>
508 </tr><tr>
497 <td><a href="#Project.getProjectLanguage">getProjectLanguage</a></td> 509 <td><a href="#Project.getProjectLanguage">getProjectLanguage</a></td>
498 <td>Public method to get the project's programming language.</td> 510 <td>Public method to get the project's programming language.</td>
499 </tr><tr> 511 </tr><tr>
500 <td><a href="#Project.getProjectManagementDir">getProjectManagementDir</a></td> 512 <td><a href="#Project.getProjectManagementDir">getProjectManagementDir</a></td>
501 <td>Public method to get the path of the management directory.</td> 513 <td>Public method to get the path of the management directory.</td>
512 <td><a href="#Project.getProjectType">getProjectType</a></td> 524 <td><a href="#Project.getProjectType">getProjectType</a></td>
513 <td>Public method to get the type of the project.</td> 525 <td>Public method to get the type of the project.</td>
514 </tr><tr> 526 </tr><tr>
515 <td><a href="#Project.getProjectTypes">getProjectTypes</a></td> 527 <td><a href="#Project.getProjectTypes">getProjectTypes</a></td>
516 <td>Public method to get the list of supported project types.</td> 528 <td>Public method to get the list of supported project types.</td>
529 </tr><tr>
530 <td><a href="#Project.getProjectVersion">getProjectVersion</a></td>
531 <td>Public mehod to get the version number of the project.</td>
517 </tr><tr> 532 </tr><tr>
518 <td><a href="#Project.getRelativePath">getRelativePath</a></td> 533 <td><a href="#Project.getRelativePath">getRelativePath</a></td>
519 <td>Public method to convert a file path to a project relative file path.</td> 534 <td>Public method to convert a file path to a project relative file path.</td>
520 </tr><tr> 535 </tr><tr>
521 <td><a href="#Project.getRelativeUniversalPath">getRelativeUniversalPath</a></td> 536 <td><a href="#Project.getRelativeUniversalPath">getRelativeUniversalPath</a></td>
1673 </p><dl> 1688 </p><dl>
1674 <dt>Returns:</dt> 1689 <dt>Returns:</dt>
1675 <dd> 1690 <dd>
1676 list of supported programming languages (list of string) 1691 list of supported programming languages (list of string)
1677 </dd> 1692 </dd>
1693 </dl><a NAME="Project.getProjectAuthor" ID="Project.getProjectAuthor"></a>
1694 <h4>Project.getProjectAuthor</h4>
1695 <b>getProjectAuthor</b>(<i></i>)
1696 <p>
1697 Public method to get the author of the project.
1698 </p><dl>
1699 <dt>Returns:</dt>
1700 <dd>
1701 author name
1702 </dd>
1703 </dl><dl>
1704 <dt>Return Type:</dt>
1705 <dd>
1706 str
1707 </dd>
1708 </dl><a NAME="Project.getProjectAuthorEmail" ID="Project.getProjectAuthorEmail"></a>
1709 <h4>Project.getProjectAuthorEmail</h4>
1710 <b>getProjectAuthorEmail</b>(<i></i>)
1711 <p>
1712 Public method to get the email address of the project author.
1713 </p><dl>
1714 <dt>Returns:</dt>
1715 <dd>
1716 project author email
1717 </dd>
1718 </dl><dl>
1719 <dt>Return Type:</dt>
1720 <dd>
1721 str
1722 </dd>
1723 </dl><a NAME="Project.getProjectDescription" ID="Project.getProjectDescription"></a>
1724 <h4>Project.getProjectDescription</h4>
1725 <b>getProjectDescription</b>(<i></i>)
1726 <p>
1727 Public method to get the description of the project.
1728 </p><dl>
1729 <dt>Returns:</dt>
1730 <dd>
1731 project description
1732 </dd>
1733 </dl><dl>
1734 <dt>Return Type:</dt>
1735 <dd>
1736 str
1737 </dd>
1678 </dl><a NAME="Project.getProjectDictionaries" ID="Project.getProjectDictionaries"></a> 1738 </dl><a NAME="Project.getProjectDictionaries" ID="Project.getProjectDictionaries"></a>
1679 <h4>Project.getProjectDictionaries</h4> 1739 <h4>Project.getProjectDictionaries</h4>
1680 <b>getProjectDictionaries</b>(<i></i>) 1740 <b>getProjectDictionaries</b>(<i></i>)
1681 <p> 1741 <p>
1682 Public method to get the names of the project specific dictionaries. 1742 Public method to get the names of the project specific dictionaries.
1694 </p><dl> 1754 </p><dl>
1695 <dt>Returns:</dt> 1755 <dt>Returns:</dt>
1696 <dd> 1756 <dd>
1697 path of the project file (string) 1757 path of the project file (string)
1698 </dd> 1758 </dd>
1759 </dl><a NAME="Project.getProjectFiles" ID="Project.getProjectFiles"></a>
1760 <h4>Project.getProjectFiles</h4>
1761 <b>getProjectFiles</b>(<i>fileType, normalized=False</i>)
1762 <p>
1763 Public method to get the file entries of the given type.
1764 </p><dl>
1765 <dt><i>fileType</i> (str)</dt>
1766 <dd>
1767 project file type (one of SOURCES, FORMS, RESOURCES,
1768 INTERFACES, OTHERS, TRANSLATIONS)
1769 </dd><dt><i>normalized</i> (boolean)</dt>
1770 <dd>
1771 flag indicating normalized file names are wanted
1772 </dd>
1773 </dl><dl>
1774 <dt>Returns:</dt>
1775 <dd>
1776 list of file names
1777 </dd>
1778 </dl><dl>
1779 <dt>Return Type:</dt>
1780 <dd>
1781 list of str
1782 </dd>
1699 </dl><a NAME="Project.getProjectLanguage" ID="Project.getProjectLanguage"></a> 1783 </dl><a NAME="Project.getProjectLanguage" ID="Project.getProjectLanguage"></a>
1700 <h4>Project.getProjectLanguage</h4> 1784 <h4>Project.getProjectLanguage</h4>
1701 <b>getProjectLanguage</b>(<i></i>) 1785 <b>getProjectLanguage</b>(<i></i>)
1702 <p> 1786 <p>
1703 Public method to get the project's programming language. 1787 Public method to get the project's programming language.
1771 </dd> 1855 </dd>
1772 </dl><dl> 1856 </dl><dl>
1773 <dt>Returns:</dt> 1857 <dt>Returns:</dt>
1774 <dd> 1858 <dd>
1775 reference to the dictionary of project types. 1859 reference to the dictionary of project types.
1860 </dd>
1861 </dl><a NAME="Project.getProjectVersion" ID="Project.getProjectVersion"></a>
1862 <h4>Project.getProjectVersion</h4>
1863 <b>getProjectVersion</b>(<i></i>)
1864 <p>
1865 Public mehod to get the version number of the project.
1866 </p><dl>
1867 <dt>Returns:</dt>
1868 <dd>
1869 version number
1870 </dd>
1871 </dl><dl>
1872 <dt>Return Type:</dt>
1873 <dd>
1874 str
1776 </dd> 1875 </dd>
1777 </dl><a NAME="Project.getRelativePath" ID="Project.getRelativePath"></a> 1876 </dl><a NAME="Project.getRelativePath" ID="Project.getRelativePath"></a>
1778 <h4>Project.getRelativePath</h4> 1877 <h4>Project.getRelativePath</h4>
1779 <b>getRelativePath</b>(<i>path</i>) 1878 <b>getRelativePath</b>(<i>path</i>)
1780 <p> 1879 <p>

eric ide

mercurial