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

branch
eric7
changeset 9323
6ae7193558ac
child 9389
7b2344009d7a
diff -r 3f0fe9a79aa1 -r 6ae7193558ac src/eric7/Documentation/Source/eric7.Project.ProjectVenvConfigurationDialog.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.Project.ProjectVenvConfigurationDialog.html	Mon Sep 12 18:07:42 2022 +0200
@@ -0,0 +1,156 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Project.ProjectVenvConfigurationDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.Project.ProjectVenvConfigurationDialog</h1>
+
+<p>
+Module implementing a dialog to enter the configuration for the embedded environment
+of the project.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#ProjectVenvConfigurationDialog">ProjectVenvConfigurationDialog</a></td>
+<td>Class implementing a dialog to enter the configuration for the embedded environment of the project.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="ProjectVenvConfigurationDialog" ID="ProjectVenvConfigurationDialog"></a>
+<h2>ProjectVenvConfigurationDialog</h2>
+
+<p>
+    Class implementing a dialog to enter the configuration for the embedded
+    environment of the project.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_ProjectVenvConfigurationDialog
+<h3>Class Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Class Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+
+<table>
+
+<tr>
+<td><a href="#ProjectVenvConfigurationDialog.__init__">ProjectVenvConfigurationDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#ProjectVenvConfigurationDialog.__updateOK">__updateOK</a></td>
+<td>Private method to update the enabled status of the OK button.</td>
+</tr>
+<tr>
+<td><a href="#ProjectVenvConfigurationDialog.getData">getData</a></td>
+<td>Public method to get the entered data.</td>
+</tr>
+<tr>
+<td><a href="#ProjectVenvConfigurationDialog.on_pythonExecPicker_textChanged">on_pythonExecPicker_textChanged</a></td>
+<td>Private slot to handle changes of the entered Python interpreter path.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="ProjectVenvConfigurationDialog.__init__" ID="ProjectVenvConfigurationDialog.__init__"></a>
+<h4>ProjectVenvConfigurationDialog (Constructor)</h4>
+<b>ProjectVenvConfigurationDialog</b>(<i>venvName="", venvDirectory="", venvInterpreter="", execPath="", parent=None, </i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>venvName</i> (str)</dt>
+<dd>
+logical name of a virtual environment for editing
+</dd>
+<dt><i>venvDirectory</i> (str)</dt>
+<dd>
+directory of the virtual environment
+</dd>
+<dt><i>venvInterpreter</i> (str)</dt>
+<dd>
+Python interpreter of the virtual environment
+</dd>
+<dt><i>execPath</i> (str)</dt>
+<dd>
+search path string to be prepended to the PATH
+            environment variable
+</dd>
+<dt><i>parent</i> (QWidget (optional))</dt>
+<dd>
+reference to the parent widget (defaults to None)
+</dd>
+</dl>
+<a NAME="ProjectVenvConfigurationDialog.__updateOK" ID="ProjectVenvConfigurationDialog.__updateOK"></a>
+<h4>ProjectVenvConfigurationDialog.__updateOK</h4>
+<b>__updateOK</b>(<i></i>)
+
+<p>
+        Private method to update the enabled status of the OK button.
+</p>
+<a NAME="ProjectVenvConfigurationDialog.getData" ID="ProjectVenvConfigurationDialog.getData"></a>
+<h4>ProjectVenvConfigurationDialog.getData</h4>
+<b>getData</b>(<i></i>)
+
+<p>
+        Public method to get the entered data.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing the path of the selected Python interpreter and
+            a string to be prepended to the PATH environment variable
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, str)
+</dd>
+</dl>
+<a NAME="ProjectVenvConfigurationDialog.on_pythonExecPicker_textChanged" ID="ProjectVenvConfigurationDialog.on_pythonExecPicker_textChanged"></a>
+<h4>ProjectVenvConfigurationDialog.on_pythonExecPicker_textChanged</h4>
+<b>on_pythonExecPicker_textChanged</b>(<i>txt</i>)
+
+<p>
+        Private slot to handle changes of the entered Python interpreter path.
+</p>
+<dl>
+
+<dt><i>txt</i> (str)</dt>
+<dd>
+entered Python interpreter path
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial