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

branch
eric7
changeset 9323
6ae7193558ac
child 9389
7b2344009d7a
equal deleted inserted replaced
9322:3f0fe9a79aa1 9323:6ae7193558ac
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Project.ProjectVenvConfigurationDialog</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Project.ProjectVenvConfigurationDialog</h1>
10
11 <p>
12 Module implementing a dialog to enter the configuration for the embedded environment
13 of the project.
14 </p>
15 <h3>Global Attributes</h3>
16
17 <table>
18 <tr><td>None</td></tr>
19 </table>
20 <h3>Classes</h3>
21
22 <table>
23
24 <tr>
25 <td><a href="#ProjectVenvConfigurationDialog">ProjectVenvConfigurationDialog</a></td>
26 <td>Class implementing a dialog to enter the configuration for the embedded environment of the project.</td>
27 </tr>
28 </table>
29 <h3>Functions</h3>
30
31 <table>
32 <tr><td>None</td></tr>
33 </table>
34 <hr />
35 <hr />
36 <a NAME="ProjectVenvConfigurationDialog" ID="ProjectVenvConfigurationDialog"></a>
37 <h2>ProjectVenvConfigurationDialog</h2>
38
39 <p>
40 Class implementing a dialog to enter the configuration for the embedded
41 environment of the project.
42 </p>
43 <h3>Derived from</h3>
44 QDialog, Ui_ProjectVenvConfigurationDialog
45 <h3>Class Attributes</h3>
46
47 <table>
48 <tr><td>None</td></tr>
49 </table>
50 <h3>Class Methods</h3>
51
52 <table>
53 <tr><td>None</td></tr>
54 </table>
55 <h3>Methods</h3>
56
57 <table>
58
59 <tr>
60 <td><a href="#ProjectVenvConfigurationDialog.__init__">ProjectVenvConfigurationDialog</a></td>
61 <td>Constructor</td>
62 </tr>
63 <tr>
64 <td><a href="#ProjectVenvConfigurationDialog.__updateOK">__updateOK</a></td>
65 <td>Private method to update the enabled status of the OK button.</td>
66 </tr>
67 <tr>
68 <td><a href="#ProjectVenvConfigurationDialog.getData">getData</a></td>
69 <td>Public method to get the entered data.</td>
70 </tr>
71 <tr>
72 <td><a href="#ProjectVenvConfigurationDialog.on_pythonExecPicker_textChanged">on_pythonExecPicker_textChanged</a></td>
73 <td>Private slot to handle changes of the entered Python interpreter path.</td>
74 </tr>
75 </table>
76 <h3>Static Methods</h3>
77
78 <table>
79 <tr><td>None</td></tr>
80 </table>
81
82 <a NAME="ProjectVenvConfigurationDialog.__init__" ID="ProjectVenvConfigurationDialog.__init__"></a>
83 <h4>ProjectVenvConfigurationDialog (Constructor)</h4>
84 <b>ProjectVenvConfigurationDialog</b>(<i>venvName="", venvDirectory="", venvInterpreter="", execPath="", parent=None, </i>)
85
86 <p>
87 Constructor
88 </p>
89 <dl>
90
91 <dt><i>venvName</i> (str)</dt>
92 <dd>
93 logical name of a virtual environment for editing
94 </dd>
95 <dt><i>venvDirectory</i> (str)</dt>
96 <dd>
97 directory of the virtual environment
98 </dd>
99 <dt><i>venvInterpreter</i> (str)</dt>
100 <dd>
101 Python interpreter of the virtual environment
102 </dd>
103 <dt><i>execPath</i> (str)</dt>
104 <dd>
105 search path string to be prepended to the PATH
106 environment variable
107 </dd>
108 <dt><i>parent</i> (QWidget (optional))</dt>
109 <dd>
110 reference to the parent widget (defaults to None)
111 </dd>
112 </dl>
113 <a NAME="ProjectVenvConfigurationDialog.__updateOK" ID="ProjectVenvConfigurationDialog.__updateOK"></a>
114 <h4>ProjectVenvConfigurationDialog.__updateOK</h4>
115 <b>__updateOK</b>(<i></i>)
116
117 <p>
118 Private method to update the enabled status of the OK button.
119 </p>
120 <a NAME="ProjectVenvConfigurationDialog.getData" ID="ProjectVenvConfigurationDialog.getData"></a>
121 <h4>ProjectVenvConfigurationDialog.getData</h4>
122 <b>getData</b>(<i></i>)
123
124 <p>
125 Public method to get the entered data.
126 </p>
127 <dl>
128 <dt>Return:</dt>
129 <dd>
130 tuple containing the path of the selected Python interpreter and
131 a string to be prepended to the PATH environment variable
132 </dd>
133 </dl>
134 <dl>
135 <dt>Return Type:</dt>
136 <dd>
137 tuple of (str, str)
138 </dd>
139 </dl>
140 <a NAME="ProjectVenvConfigurationDialog.on_pythonExecPicker_textChanged" ID="ProjectVenvConfigurationDialog.on_pythonExecPicker_textChanged"></a>
141 <h4>ProjectVenvConfigurationDialog.on_pythonExecPicker_textChanged</h4>
142 <b>on_pythonExecPicker_textChanged</b>(<i>txt</i>)
143
144 <p>
145 Private slot to handle changes of the entered Python interpreter path.
146 </p>
147 <dl>
148
149 <dt><i>txt</i> (str)</dt>
150 <dd>
151 entered Python interpreter path
152 </dd>
153 </dl>
154 <div align="right"><a href="#top">Up</a></div>
155 <hr />
156 </body></html>

eric ide

mercurial