src/eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvUpgradeConfigurationDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 9144
135240382a3e
child 10479
856476537696
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.VirtualEnv.VirtualenvUpgradeConfigurationDialog</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.VirtualEnv.VirtualenvUpgradeConfigurationDialog</h1>
10
11 <p>
12 Module implementing a dialog to enter the virtual environment upgrade
13 parameters.
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="#VirtualenvUpgradeConfigurationDialog">VirtualenvUpgradeConfigurationDialog</a></td>
26 <td>Class implementing a dialog to enter the virtual environment upgrade parameters.</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="VirtualenvUpgradeConfigurationDialog" ID="VirtualenvUpgradeConfigurationDialog"></a>
37 <h2>VirtualenvUpgradeConfigurationDialog</h2>
38
39 <p>
40 Class implementing a dialog to enter the virtual environment upgrade
41 parameters.
42 </p>
43 <h3>Derived from</h3>
44 QDialog, Ui_VirtualenvUpgradeConfigurationDialog
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="#VirtualenvUpgradeConfigurationDialog.__init__">VirtualenvUpgradeConfigurationDialog</a></td>
61 <td>Constructor</td>
62 </tr>
63 <tr>
64 <td><a href="#VirtualenvUpgradeConfigurationDialog.__getPyvenvVersion">__getPyvenvVersion</a></td>
65 <td>Private method to determine the version of the venv module.</td>
66 </tr>
67 <tr>
68 <td><a href="#VirtualenvUpgradeConfigurationDialog.__updateOkButton">__updateOkButton</a></td>
69 <td>Private slot to set the enabled state of the OK button.</td>
70 </tr>
71 <tr>
72 <td><a href="#VirtualenvUpgradeConfigurationDialog.__updateUpgradeDepsCheckBox">__updateUpgradeDepsCheckBox</a></td>
73 <td>Private slot to set the enabled state of the button depending on the version of the given Python interpreter.</td>
74 </tr>
75 <tr>
76 <td><a href="#VirtualenvUpgradeConfigurationDialog.getData">getData</a></td>
77 <td>Public method to retrieve the dialog data.</td>
78 </tr>
79 </table>
80 <h3>Static Methods</h3>
81
82 <table>
83 <tr><td>None</td></tr>
84 </table>
85
86 <a NAME="VirtualenvUpgradeConfigurationDialog.__init__" ID="VirtualenvUpgradeConfigurationDialog.__init__"></a>
87 <h4>VirtualenvUpgradeConfigurationDialog (Constructor)</h4>
88 <b>VirtualenvUpgradeConfigurationDialog</b>(<i>envName, envPath, parent=None</i>)
89
90 <p>
91 Constructor
92 </p>
93 <dl>
94
95 <dt><i>envName</i> (str)</dt>
96 <dd>
97 name of the environment to be upgraded
98 </dd>
99 <dt><i>envPath</i> (str)</dt>
100 <dd>
101 directory of the environment to be upgraded
102 </dd>
103 <dt><i>parent</i> (QWidget (optional))</dt>
104 <dd>
105 reference to the parent widget (defaults to None)
106 </dd>
107 </dl>
108 <a NAME="VirtualenvUpgradeConfigurationDialog.__getPyvenvVersion" ID="VirtualenvUpgradeConfigurationDialog.__getPyvenvVersion"></a>
109 <h4>VirtualenvUpgradeConfigurationDialog.__getPyvenvVersion</h4>
110 <b>__getPyvenvVersion</b>(<i></i>)
111
112 <p>
113 Private method to determine the version of the venv module.
114 </p>
115 <dl>
116 <dt>Return:</dt>
117 <dd>
118 tuple containing the venv modules version
119 </dd>
120 </dl>
121 <dl>
122 <dt>Return Type:</dt>
123 <dd>
124 tuple of (int, int, int)
125 </dd>
126 </dl>
127 <a NAME="VirtualenvUpgradeConfigurationDialog.__updateOkButton" ID="VirtualenvUpgradeConfigurationDialog.__updateOkButton"></a>
128 <h4>VirtualenvUpgradeConfigurationDialog.__updateOkButton</h4>
129 <b>__updateOkButton</b>(<i></i>)
130
131 <p>
132 Private slot to set the enabled state of the OK button.
133 </p>
134 <a NAME="VirtualenvUpgradeConfigurationDialog.__updateUpgradeDepsCheckBox" ID="VirtualenvUpgradeConfigurationDialog.__updateUpgradeDepsCheckBox"></a>
135 <h4>VirtualenvUpgradeConfigurationDialog.__updateUpgradeDepsCheckBox</h4>
136 <b>__updateUpgradeDepsCheckBox</b>(<i></i>)
137
138 <p>
139 Private slot to set the enabled state of the button depending
140 on the version of the given Python interpreter.
141 </p>
142 <a NAME="VirtualenvUpgradeConfigurationDialog.getData" ID="VirtualenvUpgradeConfigurationDialog.getData"></a>
143 <h4>VirtualenvUpgradeConfigurationDialog.getData</h4>
144 <b>getData</b>(<i></i>)
145
146 <p>
147 Public method to retrieve the dialog data.
148 </p>
149 <dl>
150 <dt>Return:</dt>
151 <dd>
152 tuple containing the selected python executable, the list of
153 arguments and a flag indicating to write a log file
154 </dd>
155 </dl>
156 <dl>
157 <dt>Return Type:</dt>
158 <dd>
159 tuple of (str, list of str, bool)
160 </dd>
161 </dl>
162 <div align="right"><a href="#top">Up</a></div>
163 <hr />
164 </body></html>

eric ide

mercurial