Documentation/Source/eric6.Project.Project.html

changeset 5344
cd3a3d0d7823
parent 5254
c89ecaa0eda3
child 5352
ddcf6fd8c316
child 5353
60fcaa1c3c3c
--- a/Documentation/Source/eric6.Project.Project.html	Fri Nov 25 19:06:40 2016 +0100
+++ b/Documentation/Source/eric6.Project.Project.html	Sat Nov 26 15:35:12 2016 +0100
@@ -488,12 +488,24 @@
 <td><a href="#Project.getProgrammingLanguages">getProgrammingLanguages</a></td>
 <td>Public method to get the programming languages supported by project.</td>
 </tr><tr>
+<td><a href="#Project.getProjectAuthor">getProjectAuthor</a></td>
+<td>Public method to get the author of the project.</td>
+</tr><tr>
+<td><a href="#Project.getProjectAuthorEmail">getProjectAuthorEmail</a></td>
+<td>Public method to get the email address of the project author.</td>
+</tr><tr>
+<td><a href="#Project.getProjectDescription">getProjectDescription</a></td>
+<td>Public method to get the description of the project.</td>
+</tr><tr>
 <td><a href="#Project.getProjectDictionaries">getProjectDictionaries</a></td>
 <td>Public method to get the names of the project specific dictionaries.</td>
 </tr><tr>
 <td><a href="#Project.getProjectFile">getProjectFile</a></td>
 <td>Public method to get the path of the project file.</td>
 </tr><tr>
+<td><a href="#Project.getProjectFiles">getProjectFiles</a></td>
+<td>Public method to get the file entries of the given type.</td>
+</tr><tr>
 <td><a href="#Project.getProjectLanguage">getProjectLanguage</a></td>
 <td>Public method to get the project's programming language.</td>
 </tr><tr>
@@ -515,6 +527,9 @@
 <td><a href="#Project.getProjectTypes">getProjectTypes</a></td>
 <td>Public method to get the list of supported project types.</td>
 </tr><tr>
+<td><a href="#Project.getProjectVersion">getProjectVersion</a></td>
+<td>Public mehod to get the version number of the project.</td>
+</tr><tr>
 <td><a href="#Project.getRelativePath">getRelativePath</a></td>
 <td>Public method to convert a file path to a project relative file path.</td>
 </tr><tr>
@@ -1675,6 +1690,51 @@
 <dd>
 list of supported programming languages (list of string)
 </dd>
+</dl><a NAME="Project.getProjectAuthor" ID="Project.getProjectAuthor"></a>
+<h4>Project.getProjectAuthor</h4>
+<b>getProjectAuthor</b>(<i></i>)
+<p>
+        Public method to get the author of the project.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+author name
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl><a NAME="Project.getProjectAuthorEmail" ID="Project.getProjectAuthorEmail"></a>
+<h4>Project.getProjectAuthorEmail</h4>
+<b>getProjectAuthorEmail</b>(<i></i>)
+<p>
+        Public method to get the email address of the project author.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+project author email
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl><a NAME="Project.getProjectDescription" ID="Project.getProjectDescription"></a>
+<h4>Project.getProjectDescription</h4>
+<b>getProjectDescription</b>(<i></i>)
+<p>
+        Public method to get the description of the project.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+project description
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
 </dl><a NAME="Project.getProjectDictionaries" ID="Project.getProjectDictionaries"></a>
 <h4>Project.getProjectDictionaries</h4>
 <b>getProjectDictionaries</b>(<i></i>)
@@ -1696,6 +1756,30 @@
 <dd>
 path of the project file (string)
 </dd>
+</dl><a NAME="Project.getProjectFiles" ID="Project.getProjectFiles"></a>
+<h4>Project.getProjectFiles</h4>
+<b>getProjectFiles</b>(<i>fileType, normalized=False</i>)
+<p>
+        Public method to get the file entries of the given type.
+</p><dl>
+<dt><i>fileType</i> (str)</dt>
+<dd>
+project file type (one of SOURCES, FORMS, RESOURCES,
+            INTERFACES, OTHERS, TRANSLATIONS)
+</dd><dt><i>normalized</i> (boolean)</dt>
+<dd>
+flag indicating normalized file names are wanted
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+list of file names
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
 </dl><a NAME="Project.getProjectLanguage" ID="Project.getProjectLanguage"></a>
 <h4>Project.getProjectLanguage</h4>
 <b>getProjectLanguage</b>(<i></i>)
@@ -1774,6 +1858,21 @@
 <dd>
 reference to the dictionary of project types.
 </dd>
+</dl><a NAME="Project.getProjectVersion" ID="Project.getProjectVersion"></a>
+<h4>Project.getProjectVersion</h4>
+<b>getProjectVersion</b>(<i></i>)
+<p>
+        Public mehod to get the version number of the project.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+version number
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
 </dl><a NAME="Project.getRelativePath" ID="Project.getRelativePath"></a>
 <h4>Project.getRelativePath</h4>
 <b>getRelativePath</b>(<i>path</i>)

eric ide

mercurial