16 |
16 |
17 a { color: #BA6D36; } |
17 a { color: #BA6D36; } |
18 |
18 |
19 </style> |
19 </style> |
20 </head> |
20 </head> |
21 <body><a NAME="top" ID="top"></a> |
21 <body> |
|
22 <a NAME="top" ID="top"></a> |
22 <h1>eric6.PipInterface.PipFreezeDialog</h1> |
23 <h1>eric6.PipInterface.PipFreezeDialog</h1> |
|
24 |
23 <p> |
25 <p> |
24 Module implementing a dialog to generate a requirements file. |
26 Module implementing a dialog to generate a requirements file. |
25 </p> |
27 </p> |
26 <h3>Global Attributes</h3> |
28 <h3>Global Attributes</h3> |
|
29 |
27 <table> |
30 <table> |
28 <tr><td>None</td></tr> |
31 <tr><td>None</td></tr> |
29 </table> |
32 </table> |
30 <h3>Classes</h3> |
33 <h3>Classes</h3> |
31 <table> |
34 |
|
35 <table> |
|
36 |
32 <tr> |
37 <tr> |
33 <td><a href="#PipFreezeDialog">PipFreezeDialog</a></td> |
38 <td><a href="#PipFreezeDialog">PipFreezeDialog</a></td> |
34 <td>Class implementing a dialog to generate a requirements file.</td> |
39 <td>Class implementing a dialog to generate a requirements file.</td> |
35 </tr> |
40 </tr> |
36 </table> |
41 </table> |
37 <h3>Functions</h3> |
42 <h3>Functions</h3> |
38 <table> |
43 |
39 <tr><td>None</td></tr> |
44 <table> |
40 </table> |
45 <tr><td>None</td></tr> |
41 <hr /><hr /> |
46 </table> |
|
47 <hr /> |
|
48 <hr /> |
42 <a NAME="PipFreezeDialog" ID="PipFreezeDialog"></a> |
49 <a NAME="PipFreezeDialog" ID="PipFreezeDialog"></a> |
43 <h2>PipFreezeDialog</h2> |
50 <h2>PipFreezeDialog</h2> |
|
51 |
44 <p> |
52 <p> |
45 Class implementing a dialog to generate a requirements file. |
53 Class implementing a dialog to generate a requirements file. |
46 </p> |
54 </p> |
47 <h3>Derived from</h3> |
55 <h3>Derived from</h3> |
48 QDialog, Ui_PipFreezeDialog |
56 QDialog, Ui_PipFreezeDialog |
49 <h3>Class Attributes</h3> |
57 <h3>Class Attributes</h3> |
|
58 |
50 <table> |
59 <table> |
51 <tr><td>None</td></tr> |
60 <tr><td>None</td></tr> |
52 </table> |
61 </table> |
53 <h3>Class Methods</h3> |
62 <h3>Class Methods</h3> |
|
63 |
54 <table> |
64 <table> |
55 <tr><td>None</td></tr> |
65 <tr><td>None</td></tr> |
56 </table> |
66 </table> |
57 <h3>Methods</h3> |
67 <h3>Methods</h3> |
58 <table> |
68 |
|
69 <table> |
|
70 |
59 <tr> |
71 <tr> |
60 <td><a href="#PipFreezeDialog.__init__">PipFreezeDialog</a></td> |
72 <td><a href="#PipFreezeDialog.__init__">PipFreezeDialog</a></td> |
61 <td>Constructor</td> |
73 <td>Constructor</td> |
62 </tr><tr> |
74 </tr> |
|
75 <tr> |
63 <td><a href="#PipFreezeDialog.__refresh">__refresh</a></td> |
76 <td><a href="#PipFreezeDialog.__refresh">__refresh</a></td> |
64 <td>Private slot to refresh the displayed list.</td> |
77 <td>Private slot to refresh the displayed list.</td> |
65 </tr><tr> |
78 </tr> |
|
79 <tr> |
66 <td><a href="#PipFreezeDialog.__updateButtons">__updateButtons</a></td> |
80 <td><a href="#PipFreezeDialog.__updateButtons">__updateButtons</a></td> |
67 <td>Private method to set the state of the various buttons.</td> |
81 <td>Private method to set the state of the various buttons.</td> |
68 </tr><tr> |
82 </tr> |
|
83 <tr> |
69 <td><a href="#PipFreezeDialog.__writeToFile">__writeToFile</a></td> |
84 <td><a href="#PipFreezeDialog.__writeToFile">__writeToFile</a></td> |
70 <td>Private method to write the requirements text to a file.</td> |
85 <td>Private method to write the requirements text to a file.</td> |
71 </tr><tr> |
86 </tr> |
|
87 <tr> |
72 <td><a href="#PipFreezeDialog.closeEvent">closeEvent</a></td> |
88 <td><a href="#PipFreezeDialog.closeEvent">closeEvent</a></td> |
73 <td>Protected slot implementing a close event handler.</td> |
89 <td>Protected slot implementing a close event handler.</td> |
74 </tr><tr> |
90 </tr> |
|
91 <tr> |
75 <td><a href="#PipFreezeDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
92 <td><a href="#PipFreezeDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
76 <td>Private slot called by a button of the button box clicked.</td> |
93 <td>Private slot called by a button of the button box clicked.</td> |
77 </tr><tr> |
94 </tr> |
|
95 <tr> |
78 <td><a href="#PipFreezeDialog.on_copyButton_clicked">on_copyButton_clicked</a></td> |
96 <td><a href="#PipFreezeDialog.on_copyButton_clicked">on_copyButton_clicked</a></td> |
79 <td>Private slot to copy the requirements text to the clipboard.</td> |
97 <td>Private slot to copy the requirements text to the clipboard.</td> |
80 </tr><tr> |
98 </tr> |
|
99 <tr> |
81 <td><a href="#PipFreezeDialog.on_insertButton_clicked">on_insertButton_clicked</a></td> |
100 <td><a href="#PipFreezeDialog.on_insertButton_clicked">on_insertButton_clicked</a></td> |
82 <td>Private slot to insert the requirements text at the cursor position of the current editor.</td> |
101 <td>Private slot to insert the requirements text at the cursor position of the current editor.</td> |
83 </tr><tr> |
102 </tr> |
|
103 <tr> |
84 <td><a href="#PipFreezeDialog.on_localCheckBox_clicked">on_localCheckBox_clicked</a></td> |
104 <td><a href="#PipFreezeDialog.on_localCheckBox_clicked">on_localCheckBox_clicked</a></td> |
85 <td>Private slot handling the switching of the local mode.</td> |
105 <td>Private slot handling the switching of the local mode.</td> |
86 </tr><tr> |
106 </tr> |
|
107 <tr> |
87 <td><a href="#PipFreezeDialog.on_replaceAllButton_clicked">on_replaceAllButton_clicked</a></td> |
108 <td><a href="#PipFreezeDialog.on_replaceAllButton_clicked">on_replaceAllButton_clicked</a></td> |
88 <td>Private slot to replace the text of the current editor with the requirements text.</td> |
109 <td>Private slot to replace the text of the current editor with the requirements text.</td> |
89 </tr><tr> |
110 </tr> |
|
111 <tr> |
90 <td><a href="#PipFreezeDialog.on_replaceSelectionButton_clicked">on_replaceSelectionButton_clicked</a></td> |
112 <td><a href="#PipFreezeDialog.on_replaceSelectionButton_clicked">on_replaceSelectionButton_clicked</a></td> |
91 <td>Private slot to replace the selected text of the current editor with the requirements text.</td> |
113 <td>Private slot to replace the selected text of the current editor with the requirements text.</td> |
92 </tr><tr> |
114 </tr> |
|
115 <tr> |
93 <td><a href="#PipFreezeDialog.on_requirementsEdit_textChanged">on_requirementsEdit_textChanged</a></td> |
116 <td><a href="#PipFreezeDialog.on_requirementsEdit_textChanged">on_requirementsEdit_textChanged</a></td> |
94 <td>Private slot handling changes of the requirements text.</td> |
117 <td>Private slot handling changes of the requirements text.</td> |
95 </tr><tr> |
118 </tr> |
|
119 <tr> |
96 <td><a href="#PipFreezeDialog.on_requirementsFilePicker_textChanged">on_requirementsFilePicker_textChanged</a></td> |
120 <td><a href="#PipFreezeDialog.on_requirementsFilePicker_textChanged">on_requirementsFilePicker_textChanged</a></td> |
97 <td>Private slot handling a change of the requirements file name.</td> |
121 <td>Private slot handling a change of the requirements file name.</td> |
98 </tr><tr> |
122 </tr> |
|
123 <tr> |
99 <td><a href="#PipFreezeDialog.on_saveButton_clicked">on_saveButton_clicked</a></td> |
124 <td><a href="#PipFreezeDialog.on_saveButton_clicked">on_saveButton_clicked</a></td> |
100 <td>Private slot to save the requirements text to the requirements file.</td> |
125 <td>Private slot to save the requirements text to the requirements file.</td> |
101 </tr><tr> |
126 </tr> |
|
127 <tr> |
102 <td><a href="#PipFreezeDialog.on_saveToButton_clicked">on_saveToButton_clicked</a></td> |
128 <td><a href="#PipFreezeDialog.on_saveToButton_clicked">on_saveToButton_clicked</a></td> |
103 <td>Private slot to write the requirements text to a new file.</td> |
129 <td>Private slot to write the requirements text to a new file.</td> |
104 </tr><tr> |
130 </tr> |
|
131 <tr> |
105 <td><a href="#PipFreezeDialog.start">start</a></td> |
132 <td><a href="#PipFreezeDialog.start">start</a></td> |
106 <td>Public method to start the command.</td> |
133 <td>Public method to start the command.</td> |
107 </tr> |
134 </tr> |
108 </table> |
135 </table> |
109 <h3>Static Methods</h3> |
136 <h3>Static Methods</h3> |
110 <table> |
137 |
111 <tr><td>None</td></tr> |
138 <table> |
112 </table> |
139 <tr><td>None</td></tr> |
|
140 </table> |
|
141 |
113 <a NAME="PipFreezeDialog.__init__" ID="PipFreezeDialog.__init__"></a> |
142 <a NAME="PipFreezeDialog.__init__" ID="PipFreezeDialog.__init__"></a> |
114 <h4>PipFreezeDialog (Constructor)</h4> |
143 <h4>PipFreezeDialog (Constructor)</h4> |
115 <b>PipFreezeDialog</b>(<i>pip, parent=None</i>) |
144 <b>PipFreezeDialog</b>(<i>pip, parent=None</i>) |
|
145 |
116 <p> |
146 <p> |
117 Constructor |
147 Constructor |
118 </p><dl> |
148 </p> |
|
149 <dl> |
|
150 |
119 <dt><i>pip</i> (Pip)</dt> |
151 <dt><i>pip</i> (Pip)</dt> |
120 <dd> |
152 <dd> |
121 reference to the master object |
153 reference to the master object |
122 </dd><dt><i>parent</i> (QWidget)</dt> |
154 </dd> |
|
155 <dt><i>parent</i> (QWidget)</dt> |
123 <dd> |
156 <dd> |
124 reference to the parent widget |
157 reference to the parent widget |
125 </dd> |
158 </dd> |
126 </dl><a NAME="PipFreezeDialog.__refresh" ID="PipFreezeDialog.__refresh"></a> |
159 </dl> |
|
160 <a NAME="PipFreezeDialog.__refresh" ID="PipFreezeDialog.__refresh"></a> |
127 <h4>PipFreezeDialog.__refresh</h4> |
161 <h4>PipFreezeDialog.__refresh</h4> |
128 <b>__refresh</b>(<i></i>) |
162 <b>__refresh</b>(<i></i>) |
|
163 |
129 <p> |
164 <p> |
130 Private slot to refresh the displayed list. |
165 Private slot to refresh the displayed list. |
131 </p><a NAME="PipFreezeDialog.__updateButtons" ID="PipFreezeDialog.__updateButtons"></a> |
166 </p> |
|
167 <a NAME="PipFreezeDialog.__updateButtons" ID="PipFreezeDialog.__updateButtons"></a> |
132 <h4>PipFreezeDialog.__updateButtons</h4> |
168 <h4>PipFreezeDialog.__updateButtons</h4> |
133 <b>__updateButtons</b>(<i></i>) |
169 <b>__updateButtons</b>(<i></i>) |
|
170 |
134 <p> |
171 <p> |
135 Private method to set the state of the various buttons. |
172 Private method to set the state of the various buttons. |
136 </p><a NAME="PipFreezeDialog.__writeToFile" ID="PipFreezeDialog.__writeToFile"></a> |
173 </p> |
|
174 <a NAME="PipFreezeDialog.__writeToFile" ID="PipFreezeDialog.__writeToFile"></a> |
137 <h4>PipFreezeDialog.__writeToFile</h4> |
175 <h4>PipFreezeDialog.__writeToFile</h4> |
138 <b>__writeToFile</b>(<i>fileName</i>) |
176 <b>__writeToFile</b>(<i>fileName</i>) |
|
177 |
139 <p> |
178 <p> |
140 Private method to write the requirements text to a file. |
179 Private method to write the requirements text to a file. |
141 </p><dl> |
180 </p> |
|
181 <dl> |
|
182 |
142 <dt><i>fileName</i> (str)</dt> |
183 <dt><i>fileName</i> (str)</dt> |
143 <dd> |
184 <dd> |
144 name of the file to write to |
185 name of the file to write to |
145 </dd> |
186 </dd> |
146 </dl><a NAME="PipFreezeDialog.closeEvent" ID="PipFreezeDialog.closeEvent"></a> |
187 </dl> |
|
188 <a NAME="PipFreezeDialog.closeEvent" ID="PipFreezeDialog.closeEvent"></a> |
147 <h4>PipFreezeDialog.closeEvent</h4> |
189 <h4>PipFreezeDialog.closeEvent</h4> |
148 <b>closeEvent</b>(<i>e</i>) |
190 <b>closeEvent</b>(<i>e</i>) |
|
191 |
149 <p> |
192 <p> |
150 Protected slot implementing a close event handler. |
193 Protected slot implementing a close event handler. |
151 </p><dl> |
194 </p> |
|
195 <dl> |
|
196 |
152 <dt><i>e</i> (QCloseEvent)</dt> |
197 <dt><i>e</i> (QCloseEvent)</dt> |
153 <dd> |
198 <dd> |
154 close event |
199 close event |
155 </dd> |
200 </dd> |
156 </dl><a NAME="PipFreezeDialog.on_buttonBox_clicked" ID="PipFreezeDialog.on_buttonBox_clicked"></a> |
201 </dl> |
|
202 <a NAME="PipFreezeDialog.on_buttonBox_clicked" ID="PipFreezeDialog.on_buttonBox_clicked"></a> |
157 <h4>PipFreezeDialog.on_buttonBox_clicked</h4> |
203 <h4>PipFreezeDialog.on_buttonBox_clicked</h4> |
158 <b>on_buttonBox_clicked</b>(<i>button</i>) |
204 <b>on_buttonBox_clicked</b>(<i>button</i>) |
|
205 |
159 <p> |
206 <p> |
160 Private slot called by a button of the button box clicked. |
207 Private slot called by a button of the button box clicked. |
161 </p><dl> |
208 </p> |
|
209 <dl> |
|
210 |
162 <dt><i>button</i> (QAbstractButton)</dt> |
211 <dt><i>button</i> (QAbstractButton)</dt> |
163 <dd> |
212 <dd> |
164 button that was clicked |
213 button that was clicked |
165 </dd> |
214 </dd> |
166 </dl><a NAME="PipFreezeDialog.on_copyButton_clicked" ID="PipFreezeDialog.on_copyButton_clicked"></a> |
215 </dl> |
|
216 <a NAME="PipFreezeDialog.on_copyButton_clicked" ID="PipFreezeDialog.on_copyButton_clicked"></a> |
167 <h4>PipFreezeDialog.on_copyButton_clicked</h4> |
217 <h4>PipFreezeDialog.on_copyButton_clicked</h4> |
168 <b>on_copyButton_clicked</b>(<i></i>) |
218 <b>on_copyButton_clicked</b>(<i></i>) |
|
219 |
169 <p> |
220 <p> |
170 Private slot to copy the requirements text to the clipboard. |
221 Private slot to copy the requirements text to the clipboard. |
171 </p><a NAME="PipFreezeDialog.on_insertButton_clicked" ID="PipFreezeDialog.on_insertButton_clicked"></a> |
222 </p> |
|
223 <a NAME="PipFreezeDialog.on_insertButton_clicked" ID="PipFreezeDialog.on_insertButton_clicked"></a> |
172 <h4>PipFreezeDialog.on_insertButton_clicked</h4> |
224 <h4>PipFreezeDialog.on_insertButton_clicked</h4> |
173 <b>on_insertButton_clicked</b>(<i></i>) |
225 <b>on_insertButton_clicked</b>(<i></i>) |
|
226 |
174 <p> |
227 <p> |
175 Private slot to insert the requirements text at the cursor position |
228 Private slot to insert the requirements text at the cursor position |
176 of the current editor. |
229 of the current editor. |
177 </p><a NAME="PipFreezeDialog.on_localCheckBox_clicked" ID="PipFreezeDialog.on_localCheckBox_clicked"></a> |
230 </p> |
|
231 <a NAME="PipFreezeDialog.on_localCheckBox_clicked" ID="PipFreezeDialog.on_localCheckBox_clicked"></a> |
178 <h4>PipFreezeDialog.on_localCheckBox_clicked</h4> |
232 <h4>PipFreezeDialog.on_localCheckBox_clicked</h4> |
179 <b>on_localCheckBox_clicked</b>(<i>checked</i>) |
233 <b>on_localCheckBox_clicked</b>(<i>checked</i>) |
|
234 |
180 <p> |
235 <p> |
181 Private slot handling the switching of the local mode. |
236 Private slot handling the switching of the local mode. |
182 </p><dl> |
237 </p> |
|
238 <dl> |
|
239 |
183 <dt><i>checked</i> (bool)</dt> |
240 <dt><i>checked</i> (bool)</dt> |
184 <dd> |
241 <dd> |
185 state of the local check box |
242 state of the local check box |
186 </dd> |
243 </dd> |
187 </dl><a NAME="PipFreezeDialog.on_replaceAllButton_clicked" ID="PipFreezeDialog.on_replaceAllButton_clicked"></a> |
244 </dl> |
|
245 <a NAME="PipFreezeDialog.on_replaceAllButton_clicked" ID="PipFreezeDialog.on_replaceAllButton_clicked"></a> |
188 <h4>PipFreezeDialog.on_replaceAllButton_clicked</h4> |
246 <h4>PipFreezeDialog.on_replaceAllButton_clicked</h4> |
189 <b>on_replaceAllButton_clicked</b>(<i></i>) |
247 <b>on_replaceAllButton_clicked</b>(<i></i>) |
|
248 |
190 <p> |
249 <p> |
191 Private slot to replace the text of the current editor with the |
250 Private slot to replace the text of the current editor with the |
192 requirements text. |
251 requirements text. |
193 </p><a NAME="PipFreezeDialog.on_replaceSelectionButton_clicked" ID="PipFreezeDialog.on_replaceSelectionButton_clicked"></a> |
252 </p> |
|
253 <a NAME="PipFreezeDialog.on_replaceSelectionButton_clicked" ID="PipFreezeDialog.on_replaceSelectionButton_clicked"></a> |
194 <h4>PipFreezeDialog.on_replaceSelectionButton_clicked</h4> |
254 <h4>PipFreezeDialog.on_replaceSelectionButton_clicked</h4> |
195 <b>on_replaceSelectionButton_clicked</b>(<i></i>) |
255 <b>on_replaceSelectionButton_clicked</b>(<i></i>) |
|
256 |
196 <p> |
257 <p> |
197 Private slot to replace the selected text of the current editor |
258 Private slot to replace the selected text of the current editor |
198 with the requirements text. |
259 with the requirements text. |
199 </p><a NAME="PipFreezeDialog.on_requirementsEdit_textChanged" ID="PipFreezeDialog.on_requirementsEdit_textChanged"></a> |
260 </p> |
|
261 <a NAME="PipFreezeDialog.on_requirementsEdit_textChanged" ID="PipFreezeDialog.on_requirementsEdit_textChanged"></a> |
200 <h4>PipFreezeDialog.on_requirementsEdit_textChanged</h4> |
262 <h4>PipFreezeDialog.on_requirementsEdit_textChanged</h4> |
201 <b>on_requirementsEdit_textChanged</b>(<i></i>) |
263 <b>on_requirementsEdit_textChanged</b>(<i></i>) |
|
264 |
202 <p> |
265 <p> |
203 Private slot handling changes of the requirements text. |
266 Private slot handling changes of the requirements text. |
204 </p><a NAME="PipFreezeDialog.on_requirementsFilePicker_textChanged" ID="PipFreezeDialog.on_requirementsFilePicker_textChanged"></a> |
267 </p> |
|
268 <a NAME="PipFreezeDialog.on_requirementsFilePicker_textChanged" ID="PipFreezeDialog.on_requirementsFilePicker_textChanged"></a> |
205 <h4>PipFreezeDialog.on_requirementsFilePicker_textChanged</h4> |
269 <h4>PipFreezeDialog.on_requirementsFilePicker_textChanged</h4> |
206 <b>on_requirementsFilePicker_textChanged</b>(<i>txt</i>) |
270 <b>on_requirementsFilePicker_textChanged</b>(<i>txt</i>) |
|
271 |
207 <p> |
272 <p> |
208 Private slot handling a change of the requirements file name. |
273 Private slot handling a change of the requirements file name. |
209 </p><dl> |
274 </p> |
|
275 <dl> |
|
276 |
210 <dt><i>txt</i> (str)</dt> |
277 <dt><i>txt</i> (str)</dt> |
211 <dd> |
278 <dd> |
212 name of the requirements file |
279 name of the requirements file |
213 </dd> |
280 </dd> |
214 </dl><a NAME="PipFreezeDialog.on_saveButton_clicked" ID="PipFreezeDialog.on_saveButton_clicked"></a> |
281 </dl> |
|
282 <a NAME="PipFreezeDialog.on_saveButton_clicked" ID="PipFreezeDialog.on_saveButton_clicked"></a> |
215 <h4>PipFreezeDialog.on_saveButton_clicked</h4> |
283 <h4>PipFreezeDialog.on_saveButton_clicked</h4> |
216 <b>on_saveButton_clicked</b>(<i></i>) |
284 <b>on_saveButton_clicked</b>(<i></i>) |
|
285 |
217 <p> |
286 <p> |
218 Private slot to save the requirements text to the requirements file. |
287 Private slot to save the requirements text to the requirements file. |
219 </p><a NAME="PipFreezeDialog.on_saveToButton_clicked" ID="PipFreezeDialog.on_saveToButton_clicked"></a> |
288 </p> |
|
289 <a NAME="PipFreezeDialog.on_saveToButton_clicked" ID="PipFreezeDialog.on_saveToButton_clicked"></a> |
220 <h4>PipFreezeDialog.on_saveToButton_clicked</h4> |
290 <h4>PipFreezeDialog.on_saveToButton_clicked</h4> |
221 <b>on_saveToButton_clicked</b>(<i></i>) |
291 <b>on_saveToButton_clicked</b>(<i></i>) |
|
292 |
222 <p> |
293 <p> |
223 Private slot to write the requirements text to a new file. |
294 Private slot to write the requirements text to a new file. |
224 </p><a NAME="PipFreezeDialog.start" ID="PipFreezeDialog.start"></a> |
295 </p> |
|
296 <a NAME="PipFreezeDialog.start" ID="PipFreezeDialog.start"></a> |
225 <h4>PipFreezeDialog.start</h4> |
297 <h4>PipFreezeDialog.start</h4> |
226 <b>start</b>(<i>venvName</i>) |
298 <b>start</b>(<i>venvName</i>) |
|
299 |
227 <p> |
300 <p> |
228 Public method to start the command. |
301 Public method to start the command. |
229 </p><dl> |
302 </p> |
|
303 <dl> |
|
304 |
230 <dt><i>venvName</i> (str)</dt> |
305 <dt><i>venvName</i> (str)</dt> |
231 <dd> |
306 <dd> |
232 name of the environment to act upon |
307 name of the environment to act upon |
233 </dd> |
308 </dd> |
234 </dl> |
309 </dl> |