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.CondaInterface.CondaExportDialog</h1> |
23 <h1>eric6.CondaInterface.CondaExportDialog</h1> |
|
24 |
23 <p> |
25 <p> |
24 Module implementing a dialog to generate a requirements file for conda. |
26 Module implementing a dialog to generate a requirements file for conda. |
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="#CondaExportDialog">CondaExportDialog</a></td> |
38 <td><a href="#CondaExportDialog">CondaExportDialog</a></td> |
34 <td>Class implementing a dialog to generate a requirements file for conda.</td> |
39 <td>Class implementing a dialog to generate a requirements file for conda.</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="CondaExportDialog" ID="CondaExportDialog"></a> |
49 <a NAME="CondaExportDialog" ID="CondaExportDialog"></a> |
43 <h2>CondaExportDialog</h2> |
50 <h2>CondaExportDialog</h2> |
|
51 |
44 <p> |
52 <p> |
45 Class implementing a dialog to generate a requirements file for conda. |
53 Class implementing a dialog to generate a requirements file for conda. |
46 </p> |
54 </p> |
47 <h3>Derived from</h3> |
55 <h3>Derived from</h3> |
48 QDialog, Ui_CondaExportDialog |
56 QDialog, Ui_CondaExportDialog |
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="#CondaExportDialog.__init__">CondaExportDialog</a></td> |
72 <td><a href="#CondaExportDialog.__init__">CondaExportDialog</a></td> |
61 <td>Constructor</td> |
73 <td>Constructor</td> |
62 </tr><tr> |
74 </tr> |
|
75 <tr> |
63 <td><a href="#CondaExportDialog.__refresh">__refresh</a></td> |
76 <td><a href="#CondaExportDialog.__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="#CondaExportDialog.__updateButtons">__updateButtons</a></td> |
80 <td><a href="#CondaExportDialog.__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="#CondaExportDialog.__writeToFile">__writeToFile</a></td> |
84 <td><a href="#CondaExportDialog.__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="#CondaExportDialog.closeEvent">closeEvent</a></td> |
88 <td><a href="#CondaExportDialog.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="#CondaExportDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
92 <td><a href="#CondaExportDialog.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="#CondaExportDialog.on_copyButton_clicked">on_copyButton_clicked</a></td> |
96 <td><a href="#CondaExportDialog.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="#CondaExportDialog.on_insertButton_clicked">on_insertButton_clicked</a></td> |
100 <td><a href="#CondaExportDialog.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="#CondaExportDialog.on_replaceAllButton_clicked">on_replaceAllButton_clicked</a></td> |
104 <td><a href="#CondaExportDialog.on_replaceAllButton_clicked">on_replaceAllButton_clicked</a></td> |
85 <td>Private slot to replace the text of the current editor with the requirements text.</td> |
105 <td>Private slot to replace the text of the current editor with the requirements text.</td> |
86 </tr><tr> |
106 </tr> |
|
107 <tr> |
87 <td><a href="#CondaExportDialog.on_replaceSelectionButton_clicked">on_replaceSelectionButton_clicked</a></td> |
108 <td><a href="#CondaExportDialog.on_replaceSelectionButton_clicked">on_replaceSelectionButton_clicked</a></td> |
88 <td>Private slot to replace the selected text of the current editor with the requirements text.</td> |
109 <td>Private slot to replace the selected text of the current editor with the requirements text.</td> |
89 </tr><tr> |
110 </tr> |
|
111 <tr> |
90 <td><a href="#CondaExportDialog.on_requirementsEdit_textChanged">on_requirementsEdit_textChanged</a></td> |
112 <td><a href="#CondaExportDialog.on_requirementsEdit_textChanged">on_requirementsEdit_textChanged</a></td> |
91 <td>Private slot handling changes of the requirements text.</td> |
113 <td>Private slot handling changes of the requirements text.</td> |
92 </tr><tr> |
114 </tr> |
|
115 <tr> |
93 <td><a href="#CondaExportDialog.on_requirementsFilePicker_textChanged">on_requirementsFilePicker_textChanged</a></td> |
116 <td><a href="#CondaExportDialog.on_requirementsFilePicker_textChanged">on_requirementsFilePicker_textChanged</a></td> |
94 <td>Private slot handling a change of the requirements file name.</td> |
117 <td>Private slot handling a change of the requirements file name.</td> |
95 </tr><tr> |
118 </tr> |
|
119 <tr> |
96 <td><a href="#CondaExportDialog.on_saveButton_clicked">on_saveButton_clicked</a></td> |
120 <td><a href="#CondaExportDialog.on_saveButton_clicked">on_saveButton_clicked</a></td> |
97 <td>Private slot to save the requirements text to the requirements file.</td> |
121 <td>Private slot to save the requirements text to the requirements file.</td> |
98 </tr><tr> |
122 </tr> |
|
123 <tr> |
99 <td><a href="#CondaExportDialog.on_saveToButton_clicked">on_saveToButton_clicked</a></td> |
124 <td><a href="#CondaExportDialog.on_saveToButton_clicked">on_saveToButton_clicked</a></td> |
100 <td>Private slot to write the requirements text to a new file.</td> |
125 <td>Private slot to write the requirements text to a new file.</td> |
101 </tr><tr> |
126 </tr> |
|
127 <tr> |
102 <td><a href="#CondaExportDialog.start">start</a></td> |
128 <td><a href="#CondaExportDialog.start">start</a></td> |
103 <td>Public method to start the command.</td> |
129 <td>Public method to start the command.</td> |
104 </tr> |
130 </tr> |
105 </table> |
131 </table> |
106 <h3>Static Methods</h3> |
132 <h3>Static Methods</h3> |
107 <table> |
133 |
108 <tr><td>None</td></tr> |
134 <table> |
109 </table> |
135 <tr><td>None</td></tr> |
|
136 </table> |
|
137 |
110 <a NAME="CondaExportDialog.__init__" ID="CondaExportDialog.__init__"></a> |
138 <a NAME="CondaExportDialog.__init__" ID="CondaExportDialog.__init__"></a> |
111 <h4>CondaExportDialog (Constructor)</h4> |
139 <h4>CondaExportDialog (Constructor)</h4> |
112 <b>CondaExportDialog</b>(<i>conda, envName, envPrefix, parent=None</i>) |
140 <b>CondaExportDialog</b>(<i>conda, envName, envPrefix, parent=None</i>) |
|
141 |
113 <p> |
142 <p> |
114 Constructor |
143 Constructor |
115 </p><dl> |
144 </p> |
|
145 <dl> |
|
146 |
116 <dt><i>conda</i> (Conda)</dt> |
147 <dt><i>conda</i> (Conda)</dt> |
117 <dd> |
148 <dd> |
118 reference to the master object |
149 reference to the master object |
119 </dd><dt><i>envName</i> (str)</dt> |
150 </dd> |
|
151 <dt><i>envName</i> (str)</dt> |
120 <dd> |
152 <dd> |
121 name of the environment to create the requirements |
153 name of the environment to create the requirements |
122 file from |
154 file from |
123 </dd><dt><i>envPrefix</i> (str)</dt> |
155 </dd> |
|
156 <dt><i>envPrefix</i> (str)</dt> |
124 <dd> |
157 <dd> |
125 prefix of the environment to create the requirements |
158 prefix of the environment to create the requirements |
126 file from |
159 file from |
127 </dd><dt><i>parent</i> (QWidget)</dt> |
160 </dd> |
|
161 <dt><i>parent</i> (QWidget)</dt> |
128 <dd> |
162 <dd> |
129 reference to the parent widget |
163 reference to the parent widget |
130 </dd> |
164 </dd> |
131 </dl><a NAME="CondaExportDialog.__refresh" ID="CondaExportDialog.__refresh"></a> |
165 </dl> |
|
166 <a NAME="CondaExportDialog.__refresh" ID="CondaExportDialog.__refresh"></a> |
132 <h4>CondaExportDialog.__refresh</h4> |
167 <h4>CondaExportDialog.__refresh</h4> |
133 <b>__refresh</b>(<i></i>) |
168 <b>__refresh</b>(<i></i>) |
|
169 |
134 <p> |
170 <p> |
135 Private slot to refresh the displayed list. |
171 Private slot to refresh the displayed list. |
136 </p><a NAME="CondaExportDialog.__updateButtons" ID="CondaExportDialog.__updateButtons"></a> |
172 </p> |
|
173 <a NAME="CondaExportDialog.__updateButtons" ID="CondaExportDialog.__updateButtons"></a> |
137 <h4>CondaExportDialog.__updateButtons</h4> |
174 <h4>CondaExportDialog.__updateButtons</h4> |
138 <b>__updateButtons</b>(<i></i>) |
175 <b>__updateButtons</b>(<i></i>) |
|
176 |
139 <p> |
177 <p> |
140 Private method to set the state of the various buttons. |
178 Private method to set the state of the various buttons. |
141 </p><a NAME="CondaExportDialog.__writeToFile" ID="CondaExportDialog.__writeToFile"></a> |
179 </p> |
|
180 <a NAME="CondaExportDialog.__writeToFile" ID="CondaExportDialog.__writeToFile"></a> |
142 <h4>CondaExportDialog.__writeToFile</h4> |
181 <h4>CondaExportDialog.__writeToFile</h4> |
143 <b>__writeToFile</b>(<i>fileName</i>) |
182 <b>__writeToFile</b>(<i>fileName</i>) |
|
183 |
144 <p> |
184 <p> |
145 Private method to write the requirements text to a file. |
185 Private method to write the requirements text to a file. |
146 </p><dl> |
186 </p> |
|
187 <dl> |
|
188 |
147 <dt><i>fileName</i> (str)</dt> |
189 <dt><i>fileName</i> (str)</dt> |
148 <dd> |
190 <dd> |
149 name of the file to write to |
191 name of the file to write to |
150 </dd> |
192 </dd> |
151 </dl><a NAME="CondaExportDialog.closeEvent" ID="CondaExportDialog.closeEvent"></a> |
193 </dl> |
|
194 <a NAME="CondaExportDialog.closeEvent" ID="CondaExportDialog.closeEvent"></a> |
152 <h4>CondaExportDialog.closeEvent</h4> |
195 <h4>CondaExportDialog.closeEvent</h4> |
153 <b>closeEvent</b>(<i>e</i>) |
196 <b>closeEvent</b>(<i>e</i>) |
|
197 |
154 <p> |
198 <p> |
155 Protected slot implementing a close event handler. |
199 Protected slot implementing a close event handler. |
156 </p><dl> |
200 </p> |
|
201 <dl> |
|
202 |
157 <dt><i>e</i> (QCloseEvent)</dt> |
203 <dt><i>e</i> (QCloseEvent)</dt> |
158 <dd> |
204 <dd> |
159 close event |
205 close event |
160 </dd> |
206 </dd> |
161 </dl><a NAME="CondaExportDialog.on_buttonBox_clicked" ID="CondaExportDialog.on_buttonBox_clicked"></a> |
207 </dl> |
|
208 <a NAME="CondaExportDialog.on_buttonBox_clicked" ID="CondaExportDialog.on_buttonBox_clicked"></a> |
162 <h4>CondaExportDialog.on_buttonBox_clicked</h4> |
209 <h4>CondaExportDialog.on_buttonBox_clicked</h4> |
163 <b>on_buttonBox_clicked</b>(<i>button</i>) |
210 <b>on_buttonBox_clicked</b>(<i>button</i>) |
|
211 |
164 <p> |
212 <p> |
165 Private slot called by a button of the button box clicked. |
213 Private slot called by a button of the button box clicked. |
166 </p><dl> |
214 </p> |
|
215 <dl> |
|
216 |
167 <dt><i>button</i> (QAbstractButton)</dt> |
217 <dt><i>button</i> (QAbstractButton)</dt> |
168 <dd> |
218 <dd> |
169 button that was clicked |
219 button that was clicked |
170 </dd> |
220 </dd> |
171 </dl><a NAME="CondaExportDialog.on_copyButton_clicked" ID="CondaExportDialog.on_copyButton_clicked"></a> |
221 </dl> |
|
222 <a NAME="CondaExportDialog.on_copyButton_clicked" ID="CondaExportDialog.on_copyButton_clicked"></a> |
172 <h4>CondaExportDialog.on_copyButton_clicked</h4> |
223 <h4>CondaExportDialog.on_copyButton_clicked</h4> |
173 <b>on_copyButton_clicked</b>(<i></i>) |
224 <b>on_copyButton_clicked</b>(<i></i>) |
|
225 |
174 <p> |
226 <p> |
175 Private slot to copy the requirements text to the clipboard. |
227 Private slot to copy the requirements text to the clipboard. |
176 </p><a NAME="CondaExportDialog.on_insertButton_clicked" ID="CondaExportDialog.on_insertButton_clicked"></a> |
228 </p> |
|
229 <a NAME="CondaExportDialog.on_insertButton_clicked" ID="CondaExportDialog.on_insertButton_clicked"></a> |
177 <h4>CondaExportDialog.on_insertButton_clicked</h4> |
230 <h4>CondaExportDialog.on_insertButton_clicked</h4> |
178 <b>on_insertButton_clicked</b>(<i></i>) |
231 <b>on_insertButton_clicked</b>(<i></i>) |
|
232 |
179 <p> |
233 <p> |
180 Private slot to insert the requirements text at the cursor position |
234 Private slot to insert the requirements text at the cursor position |
181 of the current editor. |
235 of the current editor. |
182 </p><a NAME="CondaExportDialog.on_replaceAllButton_clicked" ID="CondaExportDialog.on_replaceAllButton_clicked"></a> |
236 </p> |
|
237 <a NAME="CondaExportDialog.on_replaceAllButton_clicked" ID="CondaExportDialog.on_replaceAllButton_clicked"></a> |
183 <h4>CondaExportDialog.on_replaceAllButton_clicked</h4> |
238 <h4>CondaExportDialog.on_replaceAllButton_clicked</h4> |
184 <b>on_replaceAllButton_clicked</b>(<i></i>) |
239 <b>on_replaceAllButton_clicked</b>(<i></i>) |
|
240 |
185 <p> |
241 <p> |
186 Private slot to replace the text of the current editor with the |
242 Private slot to replace the text of the current editor with the |
187 requirements text. |
243 requirements text. |
188 </p><a NAME="CondaExportDialog.on_replaceSelectionButton_clicked" ID="CondaExportDialog.on_replaceSelectionButton_clicked"></a> |
244 </p> |
|
245 <a NAME="CondaExportDialog.on_replaceSelectionButton_clicked" ID="CondaExportDialog.on_replaceSelectionButton_clicked"></a> |
189 <h4>CondaExportDialog.on_replaceSelectionButton_clicked</h4> |
246 <h4>CondaExportDialog.on_replaceSelectionButton_clicked</h4> |
190 <b>on_replaceSelectionButton_clicked</b>(<i></i>) |
247 <b>on_replaceSelectionButton_clicked</b>(<i></i>) |
|
248 |
191 <p> |
249 <p> |
192 Private slot to replace the selected text of the current editor |
250 Private slot to replace the selected text of the current editor |
193 with the requirements text. |
251 with the requirements text. |
194 </p><a NAME="CondaExportDialog.on_requirementsEdit_textChanged" ID="CondaExportDialog.on_requirementsEdit_textChanged"></a> |
252 </p> |
|
253 <a NAME="CondaExportDialog.on_requirementsEdit_textChanged" ID="CondaExportDialog.on_requirementsEdit_textChanged"></a> |
195 <h4>CondaExportDialog.on_requirementsEdit_textChanged</h4> |
254 <h4>CondaExportDialog.on_requirementsEdit_textChanged</h4> |
196 <b>on_requirementsEdit_textChanged</b>(<i></i>) |
255 <b>on_requirementsEdit_textChanged</b>(<i></i>) |
|
256 |
197 <p> |
257 <p> |
198 Private slot handling changes of the requirements text. |
258 Private slot handling changes of the requirements text. |
199 </p><a NAME="CondaExportDialog.on_requirementsFilePicker_textChanged" ID="CondaExportDialog.on_requirementsFilePicker_textChanged"></a> |
259 </p> |
|
260 <a NAME="CondaExportDialog.on_requirementsFilePicker_textChanged" ID="CondaExportDialog.on_requirementsFilePicker_textChanged"></a> |
200 <h4>CondaExportDialog.on_requirementsFilePicker_textChanged</h4> |
261 <h4>CondaExportDialog.on_requirementsFilePicker_textChanged</h4> |
201 <b>on_requirementsFilePicker_textChanged</b>(<i>txt</i>) |
262 <b>on_requirementsFilePicker_textChanged</b>(<i>txt</i>) |
|
263 |
202 <p> |
264 <p> |
203 Private slot handling a change of the requirements file name. |
265 Private slot handling a change of the requirements file name. |
204 </p><dl> |
266 </p> |
|
267 <dl> |
|
268 |
205 <dt><i>txt</i> (str)</dt> |
269 <dt><i>txt</i> (str)</dt> |
206 <dd> |
270 <dd> |
207 name of the requirements file |
271 name of the requirements file |
208 </dd> |
272 </dd> |
209 </dl><a NAME="CondaExportDialog.on_saveButton_clicked" ID="CondaExportDialog.on_saveButton_clicked"></a> |
273 </dl> |
|
274 <a NAME="CondaExportDialog.on_saveButton_clicked" ID="CondaExportDialog.on_saveButton_clicked"></a> |
210 <h4>CondaExportDialog.on_saveButton_clicked</h4> |
275 <h4>CondaExportDialog.on_saveButton_clicked</h4> |
211 <b>on_saveButton_clicked</b>(<i></i>) |
276 <b>on_saveButton_clicked</b>(<i></i>) |
|
277 |
212 <p> |
278 <p> |
213 Private slot to save the requirements text to the requirements file. |
279 Private slot to save the requirements text to the requirements file. |
214 </p><a NAME="CondaExportDialog.on_saveToButton_clicked" ID="CondaExportDialog.on_saveToButton_clicked"></a> |
280 </p> |
|
281 <a NAME="CondaExportDialog.on_saveToButton_clicked" ID="CondaExportDialog.on_saveToButton_clicked"></a> |
215 <h4>CondaExportDialog.on_saveToButton_clicked</h4> |
282 <h4>CondaExportDialog.on_saveToButton_clicked</h4> |
216 <b>on_saveToButton_clicked</b>(<i></i>) |
283 <b>on_saveToButton_clicked</b>(<i></i>) |
|
284 |
217 <p> |
285 <p> |
218 Private slot to write the requirements text to a new file. |
286 Private slot to write the requirements text to a new file. |
219 </p><a NAME="CondaExportDialog.start" ID="CondaExportDialog.start"></a> |
287 </p> |
|
288 <a NAME="CondaExportDialog.start" ID="CondaExportDialog.start"></a> |
220 <h4>CondaExportDialog.start</h4> |
289 <h4>CondaExportDialog.start</h4> |
221 <b>start</b>(<i></i>) |
290 <b>start</b>(<i></i>) |
|
291 |
222 <p> |
292 <p> |
223 Public method to start the command. |
293 Public method to start the command. |
224 </p> |
294 </p> |
225 <div align="right"><a href="#top">Up</a></div> |
295 <div align="right"><a href="#top">Up</a></div> |
226 <hr /> |
296 <hr /> |