eric7/Documentation/Source/eric7.CondaInterface.CondaExportDialog.html

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

eric ide

mercurial