Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.CondaInterface.CondaPackagesWidget.html

eric6/Documentation/Source/eric6.CondaInterface.CondaPackagesWidget.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.CondaInterface.CondaPackagesWidget</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><a NAME="top" ID="top"></a>
22 <h1>eric6.CondaInterface.CondaPackagesWidget</h1>
23 <p>
24 Module implementing the conda packages management widget.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#CondaPackagesWidget">CondaPackagesWidget</a></td>
34 <td>Class implementing the conda packages management widget.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="CondaPackagesWidget" ID="CondaPackagesWidget"></a>
43 <h2>CondaPackagesWidget</h2>
44 <p>
45 Class implementing the conda packages management widget.
46 </p>
47 <h3>Derived from</h3>
48 QWidget, Ui_CondaPackagesWidget
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>PackageBuildRole</td></tr><tr><td>PackageDetailedDataRole</td></tr><tr><td>PackageVersionRole</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#CondaPackagesWidget.__init__">CondaPackagesWidget</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#CondaPackagesWidget.__aboutConda">__aboutConda</a></td>
64 <td>Private slot to show some information about the conda installation.</td>
65 </tr><tr>
66 <td><a href="#CondaPackagesWidget.__aboutToShowCondaMenu">__aboutToShowCondaMenu</a></td>
67 <td>Private slot to handle the conda menu about to be shown.</td>
68 </tr><tr>
69 <td><a href="#CondaPackagesWidget.__allUpdateableItems">__allUpdateableItems</a></td>
70 <td>Private method to get a list of all items that can be updated.</td>
71 </tr><tr>
72 <td><a href="#CondaPackagesWidget.__cloneEnvironment">__cloneEnvironment</a></td>
73 <td>Private slot to clone a conda environment.</td>
74 </tr><tr>
75 <td><a href="#CondaPackagesWidget.__condaConfigure">__condaConfigure</a></td>
76 <td>Private slot to open the configuration page.</td>
77 </tr><tr>
78 <td><a href="#CondaPackagesWidget.__createEnvironment">__createEnvironment</a></td>
79 <td>Private slot to create a conda environment from a requirements file.</td>
80 </tr><tr>
81 <td><a href="#CondaPackagesWidget.__deleteEnvironment">__deleteEnvironment</a></td>
82 <td>Private slot to delete a conda environment.</td>
83 </tr><tr>
84 <td><a href="#CondaPackagesWidget.__doSearch">__doSearch</a></td>
85 <td>Private method to search for packages.</td>
86 </tr><tr>
87 <td><a href="#CondaPackagesWidget.__editUserConfiguration">__editUserConfiguration</a></td>
88 <td>Private slot to edit the user configuration.</td>
89 </tr><tr>
90 <td><a href="#CondaPackagesWidget.__generateRequirements">__generateRequirements</a></td>
91 <td>Private slot to generate a requirements file.</td>
92 </tr><tr>
93 <td><a href="#CondaPackagesWidget.__initCondaInterface">__initCondaInterface</a></td>
94 <td>Private method to initialize the conda interface elements.</td>
95 </tr><tr>
96 <td><a href="#CondaPackagesWidget.__initCondaMenu">__initCondaMenu</a></td>
97 <td>Private method to create the super menu and attach it to the super menu button.</td>
98 </tr><tr>
99 <td><a href="#CondaPackagesWidget.__installPackages">__installPackages</a></td>
100 <td>Private slot to install packages.</td>
101 </tr><tr>
102 <td><a href="#CondaPackagesWidget.__installRequirements">__installRequirements</a></td>
103 <td>Private slot to install packages from requirements files.</td>
104 </tr><tr>
105 <td><a href="#CondaPackagesWidget.__populateEnvironments">__populateEnvironments</a></td>
106 <td>Private method to get a list of environments and populate the selector.</td>
107 </tr><tr>
108 <td><a href="#CondaPackagesWidget.__selectedUpdateableItems">__selectedUpdateableItems</a></td>
109 <td>Private method to get a list of selected items that can be updated.</td>
110 </tr><tr>
111 <td><a href="#CondaPackagesWidget.__showDetails">__showDetails</a></td>
112 <td>Private method to show a dialog with details about a package item.</td>
113 </tr><tr>
114 <td><a href="#CondaPackagesWidget.__updateActionButtons">__updateActionButtons</a></td>
115 <td>Private method to set the state of the action buttons.</td>
116 </tr><tr>
117 <td><a href="#CondaPackagesWidget.__updateSearchActionButtons">__updateSearchActionButtons</a></td>
118 <td>Private method to update the action button states of the search widget.</td>
119 </tr><tr>
120 <td><a href="#CondaPackagesWidget.on_environmentsComboBox_currentIndexChanged">on_environmentsComboBox_currentIndexChanged</a></td>
121 <td>Private slot handling the selection of a conda environment.</td>
122 </tr><tr>
123 <td><a href="#CondaPackagesWidget.on_installButton_clicked">on_installButton_clicked</a></td>
124 <td>Private slot to install a selected package.</td>
125 </tr><tr>
126 <td><a href="#CondaPackagesWidget.on_packagesList_itemSelectionChanged">on_packagesList_itemSelectionChanged</a></td>
127 <td>Private slot to handle the selection of some items..</td>
128 </tr><tr>
129 <td><a href="#CondaPackagesWidget.on_recheckButton_clicked">on_recheckButton_clicked</a></td>
130 <td>Private slot to re-check the availability of conda and adjust the interface if it became available.</td>
131 </tr><tr>
132 <td><a href="#CondaPackagesWidget.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
133 <td>Private slot to refresh the display.</td>
134 </tr><tr>
135 <td><a href="#CondaPackagesWidget.on_searchButton_clicked">on_searchButton_clicked</a></td>
136 <td>Private slot handling the press of the search button.</td>
137 </tr><tr>
138 <td><a href="#CondaPackagesWidget.on_searchEdit_returnPressed">on_searchEdit_returnPressed</a></td>
139 <td>Private slot handling the user pressing the Return button in the search edit.</td>
140 </tr><tr>
141 <td><a href="#CondaPackagesWidget.on_searchEdit_textChanged">on_searchEdit_textChanged</a></td>
142 <td>Private slot handling changes of the entered search specification.</td>
143 </tr><tr>
144 <td><a href="#CondaPackagesWidget.on_searchResultList_itemDoubleClicked">on_searchResultList_itemDoubleClicked</a></td>
145 <td>Private slot handling a double click of an item.</td>
146 </tr><tr>
147 <td><a href="#CondaPackagesWidget.on_searchResultList_itemExpanded">on_searchResultList_itemExpanded</a></td>
148 <td>Private slot handling the expansion of an item.</td>
149 </tr><tr>
150 <td><a href="#CondaPackagesWidget.on_searchResultList_itemSelectionChanged">on_searchResultList_itemSelectionChanged</a></td>
151 <td>Private slot handling a change of selected search results.</td>
152 </tr><tr>
153 <td><a href="#CondaPackagesWidget.on_searchToggleButton_toggled">on_searchToggleButton_toggled</a></td>
154 <td>Private slot to togle the search widget.</td>
155 </tr><tr>
156 <td><a href="#CondaPackagesWidget.on_showDetailsButton_clicked">on_showDetailsButton_clicked</a></td>
157 <td>Private slot handling the 'Show Details' button.</td>
158 </tr><tr>
159 <td><a href="#CondaPackagesWidget.on_uninstallButton_clicked">on_uninstallButton_clicked</a></td>
160 <td>Private slot to remove selected packages of the selected environment.</td>
161 </tr><tr>
162 <td><a href="#CondaPackagesWidget.on_upgradeAllButton_clicked">on_upgradeAllButton_clicked</a></td>
163 <td>Private slot to upgrade all packages of the selected environment.</td>
164 </tr><tr>
165 <td><a href="#CondaPackagesWidget.on_upgradeButton_clicked">on_upgradeButton_clicked</a></td>
166 <td>Private slot to upgrade selected packages of the selected environment.</td>
167 </tr>
168 </table>
169 <h3>Static Methods</h3>
170 <table>
171 <tr><td>None</td></tr>
172 </table>
173 <a NAME="CondaPackagesWidget.__init__" ID="CondaPackagesWidget.__init__"></a>
174 <h4>CondaPackagesWidget (Constructor)</h4>
175 <b>CondaPackagesWidget</b>(<i>conda, parent=None</i>)
176 <p>
177 Constructor
178 </p><dl>
179 <dt><i>conda</i> (Conda)</dt>
180 <dd>
181 reference to the conda interface
182 </dd><dt><i>parent</i> (QWidget)</dt>
183 <dd>
184 reference to the parent widget
185 </dd>
186 </dl><a NAME="CondaPackagesWidget.__aboutConda" ID="CondaPackagesWidget.__aboutConda"></a>
187 <h4>CondaPackagesWidget.__aboutConda</h4>
188 <b>__aboutConda</b>(<i></i>)
189 <p>
190 Private slot to show some information about the conda installation.
191 </p><a NAME="CondaPackagesWidget.__aboutToShowCondaMenu" ID="CondaPackagesWidget.__aboutToShowCondaMenu"></a>
192 <h4>CondaPackagesWidget.__aboutToShowCondaMenu</h4>
193 <b>__aboutToShowCondaMenu</b>(<i></i>)
194 <p>
195 Private slot to handle the conda menu about to be shown.
196 </p><a NAME="CondaPackagesWidget.__allUpdateableItems" ID="CondaPackagesWidget.__allUpdateableItems"></a>
197 <h4>CondaPackagesWidget.__allUpdateableItems</h4>
198 <b>__allUpdateableItems</b>(<i></i>)
199 <p>
200 Private method to get a list of all items that can be updated.
201 </p><dl>
202 <dt>Returns:</dt>
203 <dd>
204 list of all items that can be updated
205 </dd>
206 </dl><dl>
207 <dt>Return Type:</dt>
208 <dd>
209 list of QTreeWidgetItem
210 </dd>
211 </dl><a NAME="CondaPackagesWidget.__cloneEnvironment" ID="CondaPackagesWidget.__cloneEnvironment"></a>
212 <h4>CondaPackagesWidget.__cloneEnvironment</h4>
213 <b>__cloneEnvironment</b>(<i></i>)
214 <p>
215 Private slot to clone a conda environment.
216 </p><a NAME="CondaPackagesWidget.__condaConfigure" ID="CondaPackagesWidget.__condaConfigure"></a>
217 <h4>CondaPackagesWidget.__condaConfigure</h4>
218 <b>__condaConfigure</b>(<i></i>)
219 <p>
220 Private slot to open the configuration page.
221 </p><a NAME="CondaPackagesWidget.__createEnvironment" ID="CondaPackagesWidget.__createEnvironment"></a>
222 <h4>CondaPackagesWidget.__createEnvironment</h4>
223 <b>__createEnvironment</b>(<i></i>)
224 <p>
225 Private slot to create a conda environment from a requirements file.
226 </p><a NAME="CondaPackagesWidget.__deleteEnvironment" ID="CondaPackagesWidget.__deleteEnvironment"></a>
227 <h4>CondaPackagesWidget.__deleteEnvironment</h4>
228 <b>__deleteEnvironment</b>(<i></i>)
229 <p>
230 Private slot to delete a conda environment.
231 </p><a NAME="CondaPackagesWidget.__doSearch" ID="CondaPackagesWidget.__doSearch"></a>
232 <h4>CondaPackagesWidget.__doSearch</h4>
233 <b>__doSearch</b>(<i></i>)
234 <p>
235 Private method to search for packages.
236 </p><a NAME="CondaPackagesWidget.__editUserConfiguration" ID="CondaPackagesWidget.__editUserConfiguration"></a>
237 <h4>CondaPackagesWidget.__editUserConfiguration</h4>
238 <b>__editUserConfiguration</b>(<i></i>)
239 <p>
240 Private slot to edit the user configuration.
241 </p><a NAME="CondaPackagesWidget.__generateRequirements" ID="CondaPackagesWidget.__generateRequirements"></a>
242 <h4>CondaPackagesWidget.__generateRequirements</h4>
243 <b>__generateRequirements</b>(<i></i>)
244 <p>
245 Private slot to generate a requirements file.
246 </p><a NAME="CondaPackagesWidget.__initCondaInterface" ID="CondaPackagesWidget.__initCondaInterface"></a>
247 <h4>CondaPackagesWidget.__initCondaInterface</h4>
248 <b>__initCondaInterface</b>(<i></i>)
249 <p>
250 Private method to initialize the conda interface elements.
251 </p><a NAME="CondaPackagesWidget.__initCondaMenu" ID="CondaPackagesWidget.__initCondaMenu"></a>
252 <h4>CondaPackagesWidget.__initCondaMenu</h4>
253 <b>__initCondaMenu</b>(<i></i>)
254 <p>
255 Private method to create the super menu and attach it to the super
256 menu button.
257 </p><a NAME="CondaPackagesWidget.__installPackages" ID="CondaPackagesWidget.__installPackages"></a>
258 <h4>CondaPackagesWidget.__installPackages</h4>
259 <b>__installPackages</b>(<i></i>)
260 <p>
261 Private slot to install packages.
262 </p><a NAME="CondaPackagesWidget.__installRequirements" ID="CondaPackagesWidget.__installRequirements"></a>
263 <h4>CondaPackagesWidget.__installRequirements</h4>
264 <b>__installRequirements</b>(<i></i>)
265 <p>
266 Private slot to install packages from requirements files.
267 </p><a NAME="CondaPackagesWidget.__populateEnvironments" ID="CondaPackagesWidget.__populateEnvironments"></a>
268 <h4>CondaPackagesWidget.__populateEnvironments</h4>
269 <b>__populateEnvironments</b>(<i></i>)
270 <p>
271 Private method to get a list of environments and populate the selector.
272 </p><a NAME="CondaPackagesWidget.__selectedUpdateableItems" ID="CondaPackagesWidget.__selectedUpdateableItems"></a>
273 <h4>CondaPackagesWidget.__selectedUpdateableItems</h4>
274 <b>__selectedUpdateableItems</b>(<i></i>)
275 <p>
276 Private method to get a list of selected items that can be updated.
277 </p><dl>
278 <dt>Returns:</dt>
279 <dd>
280 list of selected items that can be updated
281 </dd>
282 </dl><dl>
283 <dt>Return Type:</dt>
284 <dd>
285 list of QTreeWidgetItem
286 </dd>
287 </dl><a NAME="CondaPackagesWidget.__showDetails" ID="CondaPackagesWidget.__showDetails"></a>
288 <h4>CondaPackagesWidget.__showDetails</h4>
289 <b>__showDetails</b>(<i>item</i>)
290 <p>
291 Private method to show a dialog with details about a package item.
292 </p><dl>
293 <dt><i>item</i> (QTreeWidgetItem)</dt>
294 <dd>
295 reference to the package item
296 </dd>
297 </dl><a NAME="CondaPackagesWidget.__updateActionButtons" ID="CondaPackagesWidget.__updateActionButtons"></a>
298 <h4>CondaPackagesWidget.__updateActionButtons</h4>
299 <b>__updateActionButtons</b>(<i></i>)
300 <p>
301 Private method to set the state of the action buttons.
302 </p><a NAME="CondaPackagesWidget.__updateSearchActionButtons" ID="CondaPackagesWidget.__updateSearchActionButtons"></a>
303 <h4>CondaPackagesWidget.__updateSearchActionButtons</h4>
304 <b>__updateSearchActionButtons</b>(<i></i>)
305 <p>
306 Private method to update the action button states of the search widget.
307 </p><a NAME="CondaPackagesWidget.on_environmentsComboBox_currentIndexChanged" ID="CondaPackagesWidget.on_environmentsComboBox_currentIndexChanged"></a>
308 <h4>CondaPackagesWidget.on_environmentsComboBox_currentIndexChanged</h4>
309 <b>on_environmentsComboBox_currentIndexChanged</b>(<i>index</i>)
310 <p>
311 Private slot handling the selection of a conda environment.
312 </p><dl>
313 <dt><i>index</i> (int)</dt>
314 <dd>
315 index of the selected conda environment
316 </dd>
317 </dl><a NAME="CondaPackagesWidget.on_installButton_clicked" ID="CondaPackagesWidget.on_installButton_clicked"></a>
318 <h4>CondaPackagesWidget.on_installButton_clicked</h4>
319 <b>on_installButton_clicked</b>(<i></i>)
320 <p>
321 Private slot to install a selected package.
322 </p><a NAME="CondaPackagesWidget.on_packagesList_itemSelectionChanged" ID="CondaPackagesWidget.on_packagesList_itemSelectionChanged"></a>
323 <h4>CondaPackagesWidget.on_packagesList_itemSelectionChanged</h4>
324 <b>on_packagesList_itemSelectionChanged</b>(<i></i>)
325 <p>
326 Private slot to handle the selection of some items..
327 </p><a NAME="CondaPackagesWidget.on_recheckButton_clicked" ID="CondaPackagesWidget.on_recheckButton_clicked"></a>
328 <h4>CondaPackagesWidget.on_recheckButton_clicked</h4>
329 <b>on_recheckButton_clicked</b>(<i></i>)
330 <p>
331 Private slot to re-check the availability of conda and adjust the
332 interface if it became available.
333 </p><a NAME="CondaPackagesWidget.on_refreshButton_clicked" ID="CondaPackagesWidget.on_refreshButton_clicked"></a>
334 <h4>CondaPackagesWidget.on_refreshButton_clicked</h4>
335 <b>on_refreshButton_clicked</b>(<i></i>)
336 <p>
337 Private slot to refresh the display.
338 </p><a NAME="CondaPackagesWidget.on_searchButton_clicked" ID="CondaPackagesWidget.on_searchButton_clicked"></a>
339 <h4>CondaPackagesWidget.on_searchButton_clicked</h4>
340 <b>on_searchButton_clicked</b>(<i></i>)
341 <p>
342 Private slot handling the press of the search button.
343 </p><a NAME="CondaPackagesWidget.on_searchEdit_returnPressed" ID="CondaPackagesWidget.on_searchEdit_returnPressed"></a>
344 <h4>CondaPackagesWidget.on_searchEdit_returnPressed</h4>
345 <b>on_searchEdit_returnPressed</b>(<i></i>)
346 <p>
347 Private slot handling the user pressing the Return button in the
348 search edit.
349 </p><a NAME="CondaPackagesWidget.on_searchEdit_textChanged" ID="CondaPackagesWidget.on_searchEdit_textChanged"></a>
350 <h4>CondaPackagesWidget.on_searchEdit_textChanged</h4>
351 <b>on_searchEdit_textChanged</b>(<i>txt</i>)
352 <p>
353 Private slot handling changes of the entered search specification.
354 </p><dl>
355 <dt><i>txt</i> (str)</dt>
356 <dd>
357 current search entry
358 </dd>
359 </dl><a NAME="CondaPackagesWidget.on_searchResultList_itemDoubleClicked" ID="CondaPackagesWidget.on_searchResultList_itemDoubleClicked"></a>
360 <h4>CondaPackagesWidget.on_searchResultList_itemDoubleClicked</h4>
361 <b>on_searchResultList_itemDoubleClicked</b>(<i>item, column</i>)
362 <p>
363 Private slot handling a double click of an item.
364 </p><dl>
365 <dt><i>item</i> (QTreeWidgetItem)</dt>
366 <dd>
367 reference to the item that was double clicked
368 </dd><dt><i>column</i> (int)</dt>
369 <dd>
370 column of the double click
371 </dd>
372 </dl><a NAME="CondaPackagesWidget.on_searchResultList_itemExpanded" ID="CondaPackagesWidget.on_searchResultList_itemExpanded"></a>
373 <h4>CondaPackagesWidget.on_searchResultList_itemExpanded</h4>
374 <b>on_searchResultList_itemExpanded</b>(<i>item</i>)
375 <p>
376 Private slot handling the expansion of an item.
377 </p><dl>
378 <dt><i>item</i> (QTreeWidgetItem)</dt>
379 <dd>
380 reference to the expanded item
381 </dd>
382 </dl><a NAME="CondaPackagesWidget.on_searchResultList_itemSelectionChanged" ID="CondaPackagesWidget.on_searchResultList_itemSelectionChanged"></a>
383 <h4>CondaPackagesWidget.on_searchResultList_itemSelectionChanged</h4>
384 <b>on_searchResultList_itemSelectionChanged</b>(<i></i>)
385 <p>
386 Private slot handling a change of selected search results.
387 </p><a NAME="CondaPackagesWidget.on_searchToggleButton_toggled" ID="CondaPackagesWidget.on_searchToggleButton_toggled"></a>
388 <h4>CondaPackagesWidget.on_searchToggleButton_toggled</h4>
389 <b>on_searchToggleButton_toggled</b>(<i>checked</i>)
390 <p>
391 Private slot to togle the search widget.
392 </p><dl>
393 <dt><i>checked</i> (bool)</dt>
394 <dd>
395 state of the search widget button
396 </dd>
397 </dl><a NAME="CondaPackagesWidget.on_showDetailsButton_clicked" ID="CondaPackagesWidget.on_showDetailsButton_clicked"></a>
398 <h4>CondaPackagesWidget.on_showDetailsButton_clicked</h4>
399 <b>on_showDetailsButton_clicked</b>(<i></i>)
400 <p>
401 Private slot handling the 'Show Details' button.
402 </p><a NAME="CondaPackagesWidget.on_uninstallButton_clicked" ID="CondaPackagesWidget.on_uninstallButton_clicked"></a>
403 <h4>CondaPackagesWidget.on_uninstallButton_clicked</h4>
404 <b>on_uninstallButton_clicked</b>(<i></i>)
405 <p>
406 Private slot to remove selected packages of the selected environment.
407 </p><a NAME="CondaPackagesWidget.on_upgradeAllButton_clicked" ID="CondaPackagesWidget.on_upgradeAllButton_clicked"></a>
408 <h4>CondaPackagesWidget.on_upgradeAllButton_clicked</h4>
409 <b>on_upgradeAllButton_clicked</b>(<i></i>)
410 <p>
411 Private slot to upgrade all packages of the selected environment.
412 </p><a NAME="CondaPackagesWidget.on_upgradeButton_clicked" ID="CondaPackagesWidget.on_upgradeButton_clicked"></a>
413 <h4>CondaPackagesWidget.on_upgradeButton_clicked</h4>
414 <b>on_upgradeButton_clicked</b>(<i></i>)
415 <p>
416 Private slot to upgrade selected packages of the selected environment.
417 </p>
418 <div align="right"><a href="#top">Up</a></div>
419 <hr />
420 </body></html>

Mercurial Repository: eric

eric ide

mercurial