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

branch
eric7
changeset 9323
6ae7193558ac
parent 9295
d14096c04126
child 9338
e7e6c61805cf
diff -r 3f0fe9a79aa1 -r 6ae7193558ac src/eric7/Documentation/Source/eric7.Project.Project.html
--- a/src/eric7/Documentation/Source/eric7.Project.Project.html	Sun Sep 11 18:32:12 2022 +0200
+++ b/src/eric7/Documentation/Source/eric7.Project.Project.html	Mon Sep 12 18:07:42 2022 +0200
@@ -289,6 +289,14 @@
 <td>Private method to close all project related windows.</td>
 </tr>
 <tr>
+<td><a href="#Project.__configureEnvironment">__configureEnvironment</a></td>
+<td>Private slot to configure the embedded environment.</td>
+</tr>
+<tr>
+<td><a href="#Project.__createEmbeddedEnvironment">__createEmbeddedEnvironment</a></td>
+<td>Private method to create the embedded virtual environment.</td>
+</tr>
+<tr>
 <td><a href="#Project.__createSBOMFile">__createSBOMFile</a></td>
 <td>Private slot to create a SBOM file of the project dependencies.</td>
 </tr>
@@ -317,6 +325,10 @@
 <td>Private method to execute a project specific make run.</td>
 </tr>
 <tr>
+<td><a href="#Project.__findEmbeddedEnvironment">__findEmbeddedEnvironment</a></td>
+<td>Private method to find the path of the embedded virtual environment.</td>
+</tr>
+<tr>
 <td><a href="#Project.__initData">__initData</a></td>
 <td>Private method to initialize the project data part.</td>
 </tr>
@@ -329,6 +341,14 @@
 <td>Private method to initialize the list of supported project types.</td>
 </tr>
 <tr>
+<td><a href="#Project.__initVenvConfiguration">__initVenvConfiguration</a></td>
+<td>Private method to initialize the environment configuration.</td>
+</tr>
+<tr>
+<td><a href="#Project.__installProjectIntoEnvironment">__installProjectIntoEnvironment</a></td>
+<td>Private method to install the project into the embedded environment in development mode.</td>
+</tr>
+<tr>
 <td><a href="#Project.__isInPdata">__isInPdata</a></td>
 <td>Private method used to check, if the passed in filename is project controlled..</td>
 </tr>
@@ -337,6 +357,10 @@
 <td>Private slot to load a diagram from file.</td>
 </tr>
 <tr>
+<td><a href="#Project.__loadEnvironmentConfiguration">__loadEnvironmentConfiguration</a></td>
+<td>Private method to load the embedded environment configuration.</td>
+</tr>
+<tr>
 <td><a href="#Project.__loadRecent">__loadRecent</a></td>
 <td>Private method to load the recently opened project filenames.</td>
 </tr>
@@ -405,6 +429,10 @@
 <td>Private method to reorganize files stored in the project.</td>
 </tr>
 <tr>
+<td><a href="#Project.__saveEnvironmentConfiguration">__saveEnvironmentConfiguration</a></td>
+<td>Private method to save the embedded environment configuration.</td>
+</tr>
+<tr>
 <td><a href="#Project.__saveRecent">__saveRecent</a></td>
 <td>Private method to save the list of recently opened filenames.</td>
 </tr>
@@ -417,6 +445,10 @@
 <td>Private slot to show the Find Project File dialog.</td>
 </tr>
 <tr>
+<td><a href="#Project.__setEmbeddedEnvironmentProjectConfig">__setEmbeddedEnvironmentProjectConfig</a></td>
+<td>Private method to set the embedded environment project configuration.</td>
+</tr>
+<tr>
 <td><a href="#Project.__showCodeCoverage">__showCodeCoverage</a></td>
 <td>Private slot used to show the code coverage information for the project files.</td>
 </tr>
@@ -437,6 +469,10 @@
 <td>Private slot called before the Debugger menu is shown.</td>
 </tr>
 <tr>
+<td><a href="#Project.__showContextMenuEnvironment">__showContextMenuEnvironment</a></td>
+<td>Private slot called before the 'Embedded Environment' menu is shown.</td>
+</tr>
+<tr>
 <td><a href="#Project.__showContextMenuFormat">__showContextMenuFormat</a></td>
 <td>Private slot called before the 'Code Formatting' menu is shown.</td>
 </tr>
@@ -1272,6 +1308,27 @@
 <p>
         Private method to close all project related windows.
 </p>
+<a NAME="Project.__configureEnvironment" ID="Project.__configureEnvironment"></a>
+<h4>Project.__configureEnvironment</h4>
+<b>__configureEnvironment</b>(<i>environmentPath=""</i>)
+
+<p>
+        Private slot to configure the embedded environment.
+</p>
+<dl>
+
+<dt><i>environmentPath</i> (str (optional))</dt>
+<dd>
+path of the virtual environment (defaults to "")
+</dd>
+</dl>
+<a NAME="Project.__createEmbeddedEnvironment" ID="Project.__createEmbeddedEnvironment"></a>
+<h4>Project.__createEmbeddedEnvironment</h4>
+<b>__createEmbeddedEnvironment</b>(<i></i>)
+
+<p>
+        Private method to create the embedded virtual environment.
+</p>
 <a NAME="Project.__createSBOMFile" ID="Project.__createSBOMFile"></a>
 <h4>Project.__createSBOMFile</h4>
 <b>__createSBOMFile</b>(<i></i>)
@@ -1382,6 +1439,25 @@
             through a menu action)
 </dd>
 </dl>
+<a NAME="Project.__findEmbeddedEnvironment" ID="Project.__findEmbeddedEnvironment"></a>
+<h4>Project.__findEmbeddedEnvironment</h4>
+<b>__findEmbeddedEnvironment</b>(<i></i>)
+
+<p>
+        Private method to find the path of the embedded virtual environment.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+path of the embedded virtual environment (empty if not found)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
 <a NAME="Project.__initData" ID="Project.__initData"></a>
 <h4>Project.__initData</h4>
 <b>__initData</b>(<i></i>)
@@ -1403,6 +1479,21 @@
 <p>
         Private method to initialize the list of supported project types.
 </p>
+<a NAME="Project.__initVenvConfiguration" ID="Project.__initVenvConfiguration"></a>
+<h4>Project.__initVenvConfiguration</h4>
+<b>__initVenvConfiguration</b>(<i></i>)
+
+<p>
+        Private method to initialize the environment configuration.
+</p>
+<a NAME="Project.__installProjectIntoEnvironment" ID="Project.__installProjectIntoEnvironment"></a>
+<h4>Project.__installProjectIntoEnvironment</h4>
+<b>__installProjectIntoEnvironment</b>(<i></i>)
+
+<p>
+        Private method to install the project into the embedded environment in
+        development mode.
+</p>
 <a NAME="Project.__isInPdata" ID="Project.__isInPdata"></a>
 <h4>Project.__isInPdata</h4>
 <b>__isInPdata</b>(<i>fn</i>)
@@ -1437,6 +1528,13 @@
 <p>
         Private slot to load a diagram from file.
 </p>
+<a NAME="Project.__loadEnvironmentConfiguration" ID="Project.__loadEnvironmentConfiguration"></a>
+<h4>Project.__loadEnvironmentConfiguration</h4>
+<b>__loadEnvironmentConfiguration</b>(<i></i>)
+
+<p>
+        Private method to load the embedded environment configuration.
+</p>
 <a NAME="Project.__loadRecent" ID="Project.__loadRecent"></a>
 <h4>Project.__loadRecent</h4>
 <b>__loadRecent</b>(<i></i>)
@@ -1676,6 +1774,13 @@
 <p>
         Private method to reorganize files stored in the project.
 </p>
+<a NAME="Project.__saveEnvironmentConfiguration" ID="Project.__saveEnvironmentConfiguration"></a>
+<h4>Project.__saveEnvironmentConfiguration</h4>
+<b>__saveEnvironmentConfiguration</b>(<i></i>)
+
+<p>
+        Private method to save the embedded environment configuration.
+</p>
 <a NAME="Project.__saveRecent" ID="Project.__saveRecent"></a>
 <h4>Project.__saveRecent</h4>
 <b>__saveRecent</b>(<i></i>)
@@ -1697,6 +1802,20 @@
 <p>
         Private slot to show the Find Project File dialog.
 </p>
+<a NAME="Project.__setEmbeddedEnvironmentProjectConfig" ID="Project.__setEmbeddedEnvironmentProjectConfig"></a>
+<h4>Project.__setEmbeddedEnvironmentProjectConfig</h4>
+<b>__setEmbeddedEnvironmentProjectConfig</b>(<i>value</i>)
+
+<p>
+        Private method to set the embedded environment project configuration.
+</p>
+<dl>
+
+<dt><i>value</i> (bool)</dt>
+<dd>
+flag indicating an embedded environment
+</dd>
+</dl>
 <a NAME="Project.__showCodeCoverage" ID="Project.__showCodeCoverage"></a>
 <h4>Project.__showCodeCoverage</h4>
 <b>__showCodeCoverage</b>(<i></i>)
@@ -1733,6 +1852,13 @@
 <p>
         Private slot called before the Debugger menu is shown.
 </p>
+<a NAME="Project.__showContextMenuEnvironment" ID="Project.__showContextMenuEnvironment"></a>
+<h4>Project.__showContextMenuEnvironment</h4>
+<b>__showContextMenuEnvironment</b>(<i></i>)
+
+<p>
+        Private slot called before the 'Embedded Environment' menu is shown.
+</p>
 <a NAME="Project.__showContextMenuFormat" ID="Project.__showContextMenuFormat"></a>
 <h4>Project.__showContextMenuFormat</h4>
 <b>__showContextMenuFormat</b>(<i></i>)

eric ide

mercurial