Documentation/Source/eric6.Project.Project.html

changeset 6260
581b0ed6ac47
parent 5972
8499df251632
child 6265
56bd09c4c297
diff -r abbe684782af -r 581b0ed6ac47 Documentation/Source/eric6.Project.Project.html
--- a/Documentation/Source/eric6.Project.Project.html	Thu Apr 19 19:28:02 2018 +0200
+++ b/Documentation/Source/eric6.Project.Project.html	Thu Apr 19 19:30:53 2018 +0200
@@ -45,7 +45,15 @@
     Class implementing the project management functionality.
 </p><h3>Signals</h3>
 <dl>
-<dt>completeRepopulateItem(str)</dt>
+<dt>appendStderr(str)</dt>
+<dd>
+emitted after something was received from
+        a QProcess on stderr
+</dd><dt>appendStdout(str)</dt>
+<dd>
+emitted after something was received from
+        a QProcess on stdout
+</dd><dt>completeRepopulateItem(str)</dt>
 <dd>
 emitted after an item of the model was
         repopulated
@@ -179,7 +187,7 @@
 QObject
 <h3>Class Attributes</h3>
 <table>
-<tr><td>eols</td></tr>
+<tr><td>DefaultMake</td></tr><tr><td>DefaultMakefile</td></tr><tr><td>eols</td></tr>
 </table>
 <h3>Class Methods</h3>
 <table>
@@ -206,6 +214,9 @@
 <td><a href="#Project.__checkProjectFileGroup">__checkProjectFileGroup</a></td>
 <td>Private method to check, if a file is in a specific file group of the project.</td>
 </tr><tr>
+<td><a href="#Project.__cleanupMake">__cleanupMake</a></td>
+<td>Private method to clean up make related stuff.</td>
+</tr><tr>
 <td><a href="#Project.__closeAllWindows">__closeAllWindows</a></td>
 <td>Private method to close all project related windows.</td>
 </tr><tr>
@@ -224,6 +235,9 @@
 <td><a href="#Project.__doSearchNewFiles">__doSearchNewFiles</a></td>
 <td>Private method to search for new files in the project directory.</td>
 </tr><tr>
+<td><a href="#Project.__executeMake">__executeMake</a></td>
+<td>Private method to execute a project specific make run.</td>
+</tr><tr>
 <td><a href="#Project.__initData">__initData</a></td>
 <td>Private method to initialize the project data part.</td>
 </tr><tr>
@@ -239,6 +253,15 @@
 <td><a href="#Project.__loadRecent">__loadRecent</a></td>
 <td>Private method to load the recently opened project filenames.</td>
 </tr><tr>
+<td><a href="#Project.__makeFinished">__makeFinished</a></td>
+<td>Private slot handling the make process finished signal.</td>
+</tr><tr>
+<td><a href="#Project.__makeReadStdErr">__makeReadStdErr</a></td>
+<td>Private slot to process process output received via stderr.</td>
+</tr><tr>
+<td><a href="#Project.__makeReadStdOut">__makeReadStdOut</a></td>
+<td>Private slot to process process output received via stdout.</td>
+</tr><tr>
 <td><a href="#Project.__openRecent">__openRecent</a></td>
 <td>Private method to open a project from the list of rencently opened projects.</td>
 </tr><tr>
@@ -302,6 +325,9 @@
 <td><a href="#Project.__showContextMenuGraphics">__showContextMenuGraphics</a></td>
 <td>Private slot called before the graphics menu is shown.</td>
 </tr><tr>
+<td><a href="#Project.__showContextMenuMake">__showContextMenuMake</a></td>
+<td>Private slot called before the make menu is shown.</td>
+</tr><tr>
 <td><a href="#Project.__showContextMenuPackagers">__showContextMenuPackagers</a></td>
 <td>Private slot called before the packagers menu is shown.</td>
 </tr><tr>
@@ -458,6 +484,9 @@
 <td><a href="#Project.deleteLanguageFile">deleteLanguageFile</a></td>
 <td>Public slot to delete a translation from the project directory.</td>
 </tr><tr>
+<td><a href="#Project.executeMake">executeMake</a></td>
+<td>Public slot to execute a project specific make run (auto-run) (execute or question).</td>
+</tr><tr>
 <td><a href="#Project.getAbsolutePath">getAbsolutePath</a></td>
 <td>Public method to convert a project relative file path to an absolute file path.</td>
 </tr><tr>
@@ -575,6 +604,9 @@
 <td><a href="#Project.handlePreferencesChanged">handlePreferencesChanged</a></td>
 <td>Public slot used to handle the preferencesChanged signal.</td>
 </tr><tr>
+<td><a href="#Project.hasDefaultMakeParameters">hasDefaultMakeParameters</a></td>
+<td>Private method to test, if the project contains the default make parameters.</td>
+</tr><tr>
 <td><a href="#Project.hasEntry">hasEntry</a></td>
 <td>Public method to check the project for a file.</td>
 </tr><tr>
@@ -605,6 +637,9 @@
 <td><a href="#Project.isJavaScriptProject">isJavaScriptProject</a></td>
 <td>Public method to check, if this project is a JavaScript project.</td>
 </tr><tr>
+<td><a href="#Project.isMakeEnabled">isMakeEnabled</a></td>
+<td>Public method to test, if make is enabled for the project.</td>
+</tr><tr>
 <td><a href="#Project.isMixedLanguageProject">isMixedLanguageProject</a></td>
 <td>Public method to check, if this is a mixed language project.</td>
 </tr><tr>
@@ -840,7 +875,12 @@
 <dd>
 flag indicating membership (boolean)
 </dd>
-</dl><a NAME="Project.__closeAllWindows" ID="Project.__closeAllWindows"></a>
+</dl><a NAME="Project.__cleanupMake" ID="Project.__cleanupMake"></a>
+<h4>Project.__cleanupMake</h4>
+<b>__cleanupMake</b>(<i></i>)
+<p>
+        Private method to clean up make related stuff.
+</p><a NAME="Project.__closeAllWindows" ID="Project.__closeAllWindows"></a>
 <h4>Project.__closeAllWindows</h4>
 <b>__closeAllWindows</b>(<i></i>)
 <p>
@@ -907,6 +947,20 @@
 flag indicating whether this method was
                 requested by the user via a menu action (boolean)
 </dd>
+</dl><a NAME="Project.__executeMake" ID="Project.__executeMake"></a>
+<h4>Project.__executeMake</h4>
+<b>__executeMake</b>(<i>questionOnly=False, interactive=True</i>)
+<p>
+        Private method to execute a project specific make run.
+</p><dl>
+<dt><i>questionOnly</i> (bool)</dt>
+<dd>
+flag indicating to ask make for changes only
+</dd><dt><i>interactive</i> (bool)</dt>
+<dd>
+flag indicating an interactive invocation (i.e.
+            through a menu action)
+</dd>
 </dl><a NAME="Project.__initData" ID="Project.__initData"></a>
 <h4>Project.__initData</h4>
 <b>__initData</b>(<i></i>)
@@ -932,6 +986,36 @@
 <b>__loadRecent</b>(<i></i>)
 <p>
         Private method to load the recently opened project filenames.
+</p><a NAME="Project.__makeFinished" ID="Project.__makeFinished"></a>
+<h4>Project.__makeFinished</h4>
+<b>__makeFinished</b>(<i>exitCode, exitStatus, questionOnly, interactive=True</i>)
+<p>
+        Private slot handling the make process finished signal.
+</p><dl>
+<dt><i>exitCode</i> (int)</dt>
+<dd>
+exit code of the make process
+</dd><dt><i>exitStatus</i> (QProcess.ExitStatus)</dt>
+<dd>
+exit status of the make process
+</dd><dt><i>questionOnly</i> (bool)</dt>
+<dd>
+flag indicating a test only run
+</dd><dt><i>interactive</i> (bool)</dt>
+<dd>
+flag indicating an interactive invocation (i.e.
+            through a menu action)
+</dd>
+</dl><a NAME="Project.__makeReadStdErr" ID="Project.__makeReadStdErr"></a>
+<h4>Project.__makeReadStdErr</h4>
+<b>__makeReadStdErr</b>(<i></i>)
+<p>
+        Private slot to process process output received via stderr.
+</p><a NAME="Project.__makeReadStdOut" ID="Project.__makeReadStdOut"></a>
+<h4>Project.__makeReadStdOut</h4>
+<b>__makeReadStdOut</b>(<i></i>)
+<p>
+        Private slot to process process output received via stdout.
 </p><a NAME="Project.__openRecent" ID="Project.__openRecent"></a>
 <h4>Project.__openRecent</h4>
 <b>__openRecent</b>(<i>act</i>)
@@ -1100,6 +1184,11 @@
 <b>__showContextMenuGraphics</b>(<i></i>)
 <p>
         Private slot called before the graphics menu is shown.
+</p><a NAME="Project.__showContextMenuMake" ID="Project.__showContextMenuMake"></a>
+<h4>Project.__showContextMenuMake</h4>
+<b>__showContextMenuMake</b>(<i></i>)
+<p>
+        Private slot called before the make menu is shown.
 </p><a NAME="Project.__showContextMenuPackagers" ID="Project.__showContextMenuPackagers"></a>
 <h4>Project.__showContextMenuPackagers</h4>
 <b>__showContextMenuPackagers</b>(<i></i>)
@@ -1526,7 +1615,13 @@
 <dd>
 the translation file to be removed (string)
 </dd>
-</dl><a NAME="Project.getAbsolutePath" ID="Project.getAbsolutePath"></a>
+</dl><a NAME="Project.executeMake" ID="Project.executeMake"></a>
+<h4>Project.executeMake</h4>
+<b>executeMake</b>(<i></i>)
+<p>
+        Public slot to execute a project specific make run (auto-run)
+        (execute or question).
+</p><a NAME="Project.getAbsolutePath" ID="Project.getAbsolutePath"></a>
 <h4>Project.getAbsolutePath</h4>
 <b>getAbsolutePath</b>(<i>fn</i>)
 <p>
@@ -2034,7 +2129,23 @@
 <b>handlePreferencesChanged</b>(<i></i>)
 <p>
         Public slot used to handle the preferencesChanged signal.
-</p><a NAME="Project.hasEntry" ID="Project.hasEntry"></a>
+</p><a NAME="Project.hasDefaultMakeParameters" ID="Project.hasDefaultMakeParameters"></a>
+<h4>Project.hasDefaultMakeParameters</h4>
+<b>hasDefaultMakeParameters</b>(<i></i>)
+<p>
+        Private method to test, if the project contains the default make
+        parameters.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating default parameter set
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl><a NAME="Project.hasEntry" ID="Project.hasEntry"></a>
 <h4>Project.hasEntry</h4>
 <b>hasEntry</b>(<i>fn</i>)
 <p>
@@ -2154,6 +2265,21 @@
 <dd>
 flag indicating a JavaScript project (boolean)
 </dd>
+</dl><a NAME="Project.isMakeEnabled" ID="Project.isMakeEnabled"></a>
+<h4>Project.isMakeEnabled</h4>
+<b>isMakeEnabled</b>(<i></i>)
+<p>
+        Public method to test, if make is enabled for the project.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating enabled make support
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
 </dl><a NAME="Project.isMixedLanguageProject" ID="Project.isMixedLanguageProject"></a>
 <h4>Project.isMixedLanguageProject</h4>
 <b>isMixedLanguageProject</b>(<i></i>)

eric ide

mercurial