Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.PluginManager.PluginRepositoryDialog.html

eric6/Documentation/Source/eric6.PluginManager.PluginRepositoryDialog.html

changeset 6942
2602857055c5
parent 6616
05b9ad19c8e1
child 6967
29bf199c5e9b
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.PluginManager.PluginRepositoryDialog</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.PluginManager.PluginRepositoryDialog</h1>
23 <p>
24 Module implementing a dialog showing the available plugins.
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="#PluginRepositoryDialog">PluginRepositoryDialog</a></td>
34 <td>Class for the dialog variant.</td>
35 </tr><tr>
36 <td><a href="#PluginRepositoryWidget">PluginRepositoryWidget</a></td>
37 <td>Class implementing a dialog showing the available plugins.</td>
38 </tr><tr>
39 <td><a href="#PluginRepositoryWindow">PluginRepositoryWindow</a></td>
40 <td>Main window class for the standalone dialog.</td>
41 </tr>
42 </table>
43 <h3>Functions</h3>
44 <table>
45 <tr>
46 <td><a href="#PluginRepositoryDownloadCleanup">PluginRepositoryDownloadCleanup</a></td>
47 <td>Module function to clean up the plug-in downloads area.</td>
48 </tr><tr>
49 <td><a href="#registerPlugin">registerPlugin</a></td>
50 <td>Method to register a plug-in's data.</td>
51 </tr>
52 </table>
53 <hr /><hr />
54 <a NAME="PluginRepositoryDialog" ID="PluginRepositoryDialog"></a>
55 <h2>PluginRepositoryDialog</h2>
56 <p>
57 Class for the dialog variant.
58 </p>
59 <h3>Derived from</h3>
60 QDialog
61 <h3>Class Attributes</h3>
62 <table>
63 <tr><td>None</td></tr>
64 </table>
65 <h3>Class Methods</h3>
66 <table>
67 <tr><td>None</td></tr>
68 </table>
69 <h3>Methods</h3>
70 <table>
71 <tr>
72 <td><a href="#PluginRepositoryDialog.__init__">PluginRepositoryDialog</a></td>
73 <td>Constructor</td>
74 </tr><tr>
75 <td><a href="#PluginRepositoryDialog.__closeAndInstall">__closeAndInstall</a></td>
76 <td>Private slot to handle the closeAndInstall signal.</td>
77 </tr><tr>
78 <td><a href="#PluginRepositoryDialog.getDownloadedPlugins">getDownloadedPlugins</a></td>
79 <td>Public method to get the list of recently downloaded plugin files.</td>
80 </tr>
81 </table>
82 <h3>Static Methods</h3>
83 <table>
84 <tr><td>None</td></tr>
85 </table>
86 <a NAME="PluginRepositoryDialog.__init__" ID="PluginRepositoryDialog.__init__"></a>
87 <h4>PluginRepositoryDialog (Constructor)</h4>
88 <b>PluginRepositoryDialog</b>(<i>pluginManager, parent=None</i>)
89 <p>
90 Constructor
91 </p><dl>
92 <dt><i>pluginManager</i> (PluginManager)</dt>
93 <dd>
94 reference to the plugin manager object
95 </dd><dt><i>parent</i> (QWidget)</dt>
96 <dd>
97 reference to the parent widget
98 </dd>
99 </dl><a NAME="PluginRepositoryDialog.__closeAndInstall" ID="PluginRepositoryDialog.__closeAndInstall"></a>
100 <h4>PluginRepositoryDialog.__closeAndInstall</h4>
101 <b>__closeAndInstall</b>(<i></i>)
102 <p>
103 Private slot to handle the closeAndInstall signal.
104 </p><a NAME="PluginRepositoryDialog.getDownloadedPlugins" ID="PluginRepositoryDialog.getDownloadedPlugins"></a>
105 <h4>PluginRepositoryDialog.getDownloadedPlugins</h4>
106 <b>getDownloadedPlugins</b>(<i></i>)
107 <p>
108 Public method to get the list of recently downloaded plugin files.
109 </p><dl>
110 <dt>Returns:</dt>
111 <dd>
112 list of plugin filenames (list of strings)
113 </dd>
114 </dl>
115 <div align="right"><a href="#top">Up</a></div>
116 <hr /><hr />
117 <a NAME="PluginRepositoryWidget" ID="PluginRepositoryWidget"></a>
118 <h2>PluginRepositoryWidget</h2>
119 <p>
120 Class implementing a dialog showing the available plugins.
121 </p><h3>Signals</h3>
122 <dl>
123 <dt>closeAndInstall()</dt>
124 <dd>
125 emitted when the Close & Install button is
126 pressed
127 </dd>
128 </dl>
129 <h3>Derived from</h3>
130 QWidget, Ui_PluginRepositoryDialog
131 <h3>Class Attributes</h3>
132 <table>
133 <tr><td>AuthorRole</td></tr><tr><td>DescrRole</td></tr><tr><td>FilenameRole</td></tr><tr><td>PluginStatusLocalUpdate</td></tr><tr><td>PluginStatusNew</td></tr><tr><td>PluginStatusRemoteUpdate</td></tr><tr><td>PluginStatusUpToDate</td></tr><tr><td>UrlRole</td></tr>
134 </table>
135 <h3>Class Methods</h3>
136 <table>
137 <tr><td>None</td></tr>
138 </table>
139 <h3>Methods</h3>
140 <table>
141 <tr>
142 <td><a href="#PluginRepositoryWidget.__init__">PluginRepositoryWidget</a></td>
143 <td>Constructor</td>
144 </tr><tr>
145 <td><a href="#PluginRepositoryWidget.__cleanupDownloads">__cleanupDownloads</a></td>
146 <td>Private slot to cleanup the plug-in downloads area.</td>
147 </tr><tr>
148 <td><a href="#PluginRepositoryWidget.__closeAndInstall">__closeAndInstall</a></td>
149 <td>Private method to close the dialog and invoke the install dialog.</td>
150 </tr><tr>
151 <td><a href="#PluginRepositoryWidget.__downloadCancel">__downloadCancel</a></td>
152 <td>Private slot to cancel the current download.</td>
153 </tr><tr>
154 <td><a href="#PluginRepositoryWidget.__downloadFile">__downloadFile</a></td>
155 <td>Private slot to download the given file.</td>
156 </tr><tr>
157 <td><a href="#PluginRepositoryWidget.__downloadFileDone">__downloadFileDone</a></td>
158 <td>Private method called, after the file has been downloaded from the Internet.</td>
159 </tr><tr>
160 <td><a href="#PluginRepositoryWidget.__downloadPlugin">__downloadPlugin</a></td>
161 <td>Private method to download the next plugin.</td>
162 </tr><tr>
163 <td><a href="#PluginRepositoryWidget.__downloadPluginDone">__downloadPluginDone</a></td>
164 <td>Private method called, when the download of a plugin is finished.</td>
165 </tr><tr>
166 <td><a href="#PluginRepositoryWidget.__downloadPlugins">__downloadPlugins</a></td>
167 <td>Private slot to download the selected plugins.</td>
168 </tr><tr>
169 <td><a href="#PluginRepositoryWidget.__downloadPluginsDone">__downloadPluginsDone</a></td>
170 <td>Private method called, when the download of the plugins is finished.</td>
171 </tr><tr>
172 <td><a href="#PluginRepositoryWidget.__downloadProgress">__downloadProgress</a></td>
173 <td>Private slot to show the download progress.</td>
174 </tr><tr>
175 <td><a href="#PluginRepositoryWidget.__downloadRepositoryFileDone">__downloadRepositoryFileDone</a></td>
176 <td>Private method called after the repository file was downloaded.</td>
177 </tr><tr>
178 <td><a href="#PluginRepositoryWidget.__formatDescription">__formatDescription</a></td>
179 <td>Private method to format the description.</td>
180 </tr><tr>
181 <td><a href="#PluginRepositoryWidget.__hasHiddenPlugins">__hasHiddenPlugins</a></td>
182 <td>Private method to check, if there are any hidden plug-ins.</td>
183 </tr><tr>
184 <td><a href="#PluginRepositoryWidget.__hidePlugin">__hidePlugin</a></td>
185 <td>Private slot to hide the current plug-in.</td>
186 </tr><tr>
187 <td><a href="#PluginRepositoryWidget.__hideSelectedPlugins">__hideSelectedPlugins</a></td>
188 <td>Private slot to hide all selected plug-ins.</td>
189 </tr><tr>
190 <td><a href="#PluginRepositoryWidget.__isOnline">__isOnline</a></td>
191 <td>Private method to check the online status.</td>
192 </tr><tr>
193 <td><a href="#PluginRepositoryWidget.__onlineStateChanged">__onlineStateChanged</a></td>
194 <td>Private slot handling online state changes.</td>
195 </tr><tr>
196 <td><a href="#PluginRepositoryWidget.__populateList">__populateList</a></td>
197 <td>Private method to populate the list of available plugins.</td>
198 </tr><tr>
199 <td><a href="#PluginRepositoryWidget.__resortRepositoryList">__resortRepositoryList</a></td>
200 <td>Private method to resort the tree.</td>
201 </tr><tr>
202 <td><a href="#PluginRepositoryWidget.__selectedItems">__selectedItems</a></td>
203 <td>Private method to get all selected items without the toplevel ones.</td>
204 </tr><tr>
205 <td><a href="#PluginRepositoryWidget.__showAllPlugins">__showAllPlugins</a></td>
206 <td>Private slot to show all plug-ins.</td>
207 </tr><tr>
208 <td><a href="#PluginRepositoryWidget.__sslErrors">__sslErrors</a></td>
209 <td>Private slot to handle SSL errors.</td>
210 </tr><tr>
211 <td><a href="#PluginRepositoryWidget.__updateHiddenPluginsList">__updateHiddenPluginsList</a></td>
212 <td>Private method to store the list of hidden plug-ins to the settings.</td>
213 </tr><tr>
214 <td><a href="#PluginRepositoryWidget.__updateList">__updateList</a></td>
215 <td>Private slot to download a new list and display the contents.</td>
216 </tr><tr>
217 <td><a href="#PluginRepositoryWidget.__updateStatus">__updateStatus</a></td>
218 <td>Private method to check the given archive update status.</td>
219 </tr><tr>
220 <td><a href="#PluginRepositoryWidget.addEntry">addEntry</a></td>
221 <td>Public method to add an entry to the list.</td>
222 </tr><tr>
223 <td><a href="#PluginRepositoryWidget.getDownloadedPlugins">getDownloadedPlugins</a></td>
224 <td>Public method to get the list of recently downloaded plugin files.</td>
225 </tr><tr>
226 <td><a href="#PluginRepositoryWidget.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
227 <td>Private slot to handle the click of a button of the button box.</td>
228 </tr><tr>
229 <td><a href="#PluginRepositoryWidget.on_repositoryList_currentItemChanged">on_repositoryList_currentItemChanged</a></td>
230 <td>Private slot to handle the change of the current item.</td>
231 </tr><tr>
232 <td><a href="#PluginRepositoryWidget.on_repositoryList_customContextMenuRequested">on_repositoryList_customContextMenuRequested</a></td>
233 <td>Private slot to show the context menu.</td>
234 </tr><tr>
235 <td><a href="#PluginRepositoryWidget.on_repositoryList_itemSelectionChanged">on_repositoryList_itemSelectionChanged</a></td>
236 <td>Private slot to handle a change of the selection.</td>
237 </tr><tr>
238 <td><a href="#PluginRepositoryWidget.on_repositoryUrlEditButton_toggled">on_repositoryUrlEditButton_toggled</a></td>
239 <td>Private slot to set the read only status of the repository URL line edit.</td>
240 </tr>
241 </table>
242 <h3>Static Methods</h3>
243 <table>
244 <tr><td>None</td></tr>
245 </table>
246 <a NAME="PluginRepositoryWidget.__init__" ID="PluginRepositoryWidget.__init__"></a>
247 <h4>PluginRepositoryWidget (Constructor)</h4>
248 <b>PluginRepositoryWidget</b>(<i>pluginManager, parent=None</i>)
249 <p>
250 Constructor
251 </p><dl>
252 <dt><i>pluginManager</i> (PluginManager)</dt>
253 <dd>
254 reference to the plugin manager object
255 </dd><dt><i>parent</i> (QWidget)</dt>
256 <dd>
257 parent of this dialog
258 </dd>
259 </dl><a NAME="PluginRepositoryWidget.__cleanupDownloads" ID="PluginRepositoryWidget.__cleanupDownloads"></a>
260 <h4>PluginRepositoryWidget.__cleanupDownloads</h4>
261 <b>__cleanupDownloads</b>(<i></i>)
262 <p>
263 Private slot to cleanup the plug-in downloads area.
264 </p><a NAME="PluginRepositoryWidget.__closeAndInstall" ID="PluginRepositoryWidget.__closeAndInstall"></a>
265 <h4>PluginRepositoryWidget.__closeAndInstall</h4>
266 <b>__closeAndInstall</b>(<i></i>)
267 <p>
268 Private method to close the dialog and invoke the install dialog.
269 </p><a NAME="PluginRepositoryWidget.__downloadCancel" ID="PluginRepositoryWidget.__downloadCancel"></a>
270 <h4>PluginRepositoryWidget.__downloadCancel</h4>
271 <b>__downloadCancel</b>(<i>reply=None</i>)
272 <p>
273 Private slot to cancel the current download.
274 </p><dl>
275 <dt><i>reply</i> (QNetworkReply)</dt>
276 <dd>
277 reference to the network reply
278 </dd>
279 </dl><a NAME="PluginRepositoryWidget.__downloadFile" ID="PluginRepositoryWidget.__downloadFile"></a>
280 <h4>PluginRepositoryWidget.__downloadFile</h4>
281 <b>__downloadFile</b>(<i>url, filename, doneMethod=None</i>)
282 <p>
283 Private slot to download the given file.
284 </p><dl>
285 <dt><i>url</i></dt>
286 <dd>
287 URL for the download (string)
288 </dd><dt><i>filename</i></dt>
289 <dd>
290 local name of the file (string)
291 </dd><dt><i>doneMethod</i></dt>
292 <dd>
293 method to be called when done
294 </dd>
295 </dl><a NAME="PluginRepositoryWidget.__downloadFileDone" ID="PluginRepositoryWidget.__downloadFileDone"></a>
296 <h4>PluginRepositoryWidget.__downloadFileDone</h4>
297 <b>__downloadFileDone</b>(<i>reply, fileName, doneMethod</i>)
298 <p>
299 Private method called, after the file has been downloaded
300 from the Internet.
301 </p><dl>
302 <dt><i>reply</i> (QNetworkReply)</dt>
303 <dd>
304 reference to the reply object of the download
305 </dd><dt><i>fileName</i> (str)</dt>
306 <dd>
307 local name of the file
308 </dd><dt><i>doneMethod</i> (func)</dt>
309 <dd>
310 method to be called when done
311 </dd>
312 </dl><a NAME="PluginRepositoryWidget.__downloadPlugin" ID="PluginRepositoryWidget.__downloadPlugin"></a>
313 <h4>PluginRepositoryWidget.__downloadPlugin</h4>
314 <b>__downloadPlugin</b>(<i></i>)
315 <p>
316 Private method to download the next plugin.
317 </p><a NAME="PluginRepositoryWidget.__downloadPluginDone" ID="PluginRepositoryWidget.__downloadPluginDone"></a>
318 <h4>PluginRepositoryWidget.__downloadPluginDone</h4>
319 <b>__downloadPluginDone</b>(<i>status, filename</i>)
320 <p>
321 Private method called, when the download of a plugin is finished.
322 </p><dl>
323 <dt><i>status</i></dt>
324 <dd>
325 flag indicating a successful download (boolean)
326 </dd><dt><i>filename</i></dt>
327 <dd>
328 full path of the downloaded file (string)
329 </dd>
330 </dl><a NAME="PluginRepositoryWidget.__downloadPlugins" ID="PluginRepositoryWidget.__downloadPlugins"></a>
331 <h4>PluginRepositoryWidget.__downloadPlugins</h4>
332 <b>__downloadPlugins</b>(<i></i>)
333 <p>
334 Private slot to download the selected plugins.
335 </p><a NAME="PluginRepositoryWidget.__downloadPluginsDone" ID="PluginRepositoryWidget.__downloadPluginsDone"></a>
336 <h4>PluginRepositoryWidget.__downloadPluginsDone</h4>
337 <b>__downloadPluginsDone</b>(<i></i>)
338 <p>
339 Private method called, when the download of the plugins is finished.
340 </p><a NAME="PluginRepositoryWidget.__downloadProgress" ID="PluginRepositoryWidget.__downloadProgress"></a>
341 <h4>PluginRepositoryWidget.__downloadProgress</h4>
342 <b>__downloadProgress</b>(<i>done, total</i>)
343 <p>
344 Private slot to show the download progress.
345 </p><dl>
346 <dt><i>done</i></dt>
347 <dd>
348 number of bytes downloaded so far (integer)
349 </dd><dt><i>total</i></dt>
350 <dd>
351 total bytes to be downloaded (integer)
352 </dd>
353 </dl><a NAME="PluginRepositoryWidget.__downloadRepositoryFileDone" ID="PluginRepositoryWidget.__downloadRepositoryFileDone"></a>
354 <h4>PluginRepositoryWidget.__downloadRepositoryFileDone</h4>
355 <b>__downloadRepositoryFileDone</b>(<i>status, filename</i>)
356 <p>
357 Private method called after the repository file was downloaded.
358 </p><dl>
359 <dt><i>status</i></dt>
360 <dd>
361 flaging indicating a successful download (boolean)
362 </dd><dt><i>filename</i></dt>
363 <dd>
364 full path of the downloaded file (string)
365 </dd>
366 </dl><a NAME="PluginRepositoryWidget.__formatDescription" ID="PluginRepositoryWidget.__formatDescription"></a>
367 <h4>PluginRepositoryWidget.__formatDescription</h4>
368 <b>__formatDescription</b>(<i>lines</i>)
369 <p>
370 Private method to format the description.
371 </p><dl>
372 <dt><i>lines</i></dt>
373 <dd>
374 lines of the description (list of strings)
375 </dd>
376 </dl><dl>
377 <dt>Returns:</dt>
378 <dd>
379 formatted description (string)
380 </dd>
381 </dl><a NAME="PluginRepositoryWidget.__hasHiddenPlugins" ID="PluginRepositoryWidget.__hasHiddenPlugins"></a>
382 <h4>PluginRepositoryWidget.__hasHiddenPlugins</h4>
383 <b>__hasHiddenPlugins</b>(<i></i>)
384 <p>
385 Private method to check, if there are any hidden plug-ins.
386 </p><dl>
387 <dt>Returns:</dt>
388 <dd>
389 flag indicating the presence of hidden plug-ins (boolean)
390 </dd>
391 </dl><a NAME="PluginRepositoryWidget.__hidePlugin" ID="PluginRepositoryWidget.__hidePlugin"></a>
392 <h4>PluginRepositoryWidget.__hidePlugin</h4>
393 <b>__hidePlugin</b>(<i></i>)
394 <p>
395 Private slot to hide the current plug-in.
396 </p><a NAME="PluginRepositoryWidget.__hideSelectedPlugins" ID="PluginRepositoryWidget.__hideSelectedPlugins"></a>
397 <h4>PluginRepositoryWidget.__hideSelectedPlugins</h4>
398 <b>__hideSelectedPlugins</b>(<i></i>)
399 <p>
400 Private slot to hide all selected plug-ins.
401 </p><a NAME="PluginRepositoryWidget.__isOnline" ID="PluginRepositoryWidget.__isOnline"></a>
402 <h4>PluginRepositoryWidget.__isOnline</h4>
403 <b>__isOnline</b>(<i></i>)
404 <p>
405 Private method to check the online status.
406 </p><dl>
407 <dt>Returns:</dt>
408 <dd>
409 flag indicating the online status
410 </dd>
411 </dl><dl>
412 <dt>Return Type:</dt>
413 <dd>
414 bool
415 </dd>
416 </dl><a NAME="PluginRepositoryWidget.__onlineStateChanged" ID="PluginRepositoryWidget.__onlineStateChanged"></a>
417 <h4>PluginRepositoryWidget.__onlineStateChanged</h4>
418 <b>__onlineStateChanged</b>(<i>online</i>)
419 <p>
420 Private slot handling online state changes.
421 </p><dl>
422 <dt><i>online</i> (bool)</dt>
423 <dd>
424 flag indicating the online status
425 </dd>
426 </dl><a NAME="PluginRepositoryWidget.__populateList" ID="PluginRepositoryWidget.__populateList"></a>
427 <h4>PluginRepositoryWidget.__populateList</h4>
428 <b>__populateList</b>(<i></i>)
429 <p>
430 Private method to populate the list of available plugins.
431 </p><a NAME="PluginRepositoryWidget.__resortRepositoryList" ID="PluginRepositoryWidget.__resortRepositoryList"></a>
432 <h4>PluginRepositoryWidget.__resortRepositoryList</h4>
433 <b>__resortRepositoryList</b>(<i></i>)
434 <p>
435 Private method to resort the tree.
436 </p><a NAME="PluginRepositoryWidget.__selectedItems" ID="PluginRepositoryWidget.__selectedItems"></a>
437 <h4>PluginRepositoryWidget.__selectedItems</h4>
438 <b>__selectedItems</b>(<i></i>)
439 <p>
440 Private method to get all selected items without the toplevel ones.
441 </p><dl>
442 <dt>Returns:</dt>
443 <dd>
444 list of selected items (list)
445 </dd>
446 </dl><a NAME="PluginRepositoryWidget.__showAllPlugins" ID="PluginRepositoryWidget.__showAllPlugins"></a>
447 <h4>PluginRepositoryWidget.__showAllPlugins</h4>
448 <b>__showAllPlugins</b>(<i></i>)
449 <p>
450 Private slot to show all plug-ins.
451 </p><a NAME="PluginRepositoryWidget.__sslErrors" ID="PluginRepositoryWidget.__sslErrors"></a>
452 <h4>PluginRepositoryWidget.__sslErrors</h4>
453 <b>__sslErrors</b>(<i>reply, errors</i>)
454 <p>
455 Private slot to handle SSL errors.
456 </p><dl>
457 <dt><i>reply</i></dt>
458 <dd>
459 reference to the reply object (QNetworkReply)
460 </dd><dt><i>errors</i></dt>
461 <dd>
462 list of SSL errors (list of QSslError)
463 </dd>
464 </dl><a NAME="PluginRepositoryWidget.__updateHiddenPluginsList" ID="PluginRepositoryWidget.__updateHiddenPluginsList"></a>
465 <h4>PluginRepositoryWidget.__updateHiddenPluginsList</h4>
466 <b>__updateHiddenPluginsList</b>(<i>hideList</i>)
467 <p>
468 Private method to store the list of hidden plug-ins to the settings.
469 </p><dl>
470 <dt><i>hideList</i></dt>
471 <dd>
472 list of plug-ins to add to the list of hidden ones
473 (list of string)
474 </dd>
475 </dl><a NAME="PluginRepositoryWidget.__updateList" ID="PluginRepositoryWidget.__updateList"></a>
476 <h4>PluginRepositoryWidget.__updateList</h4>
477 <b>__updateList</b>(<i></i>)
478 <p>
479 Private slot to download a new list and display the contents.
480 </p><a NAME="PluginRepositoryWidget.__updateStatus" ID="PluginRepositoryWidget.__updateStatus"></a>
481 <h4>PluginRepositoryWidget.__updateStatus</h4>
482 <b>__updateStatus</b>(<i>filename, version</i>)
483 <p>
484 Private method to check the given archive update status.
485 </p><dl>
486 <dt><i>filename</i></dt>
487 <dd>
488 data for the filename field (string)
489 </dd><dt><i>version</i></dt>
490 <dd>
491 data for the version field (string)
492 </dd>
493 </dl><dl>
494 <dt>Returns:</dt>
495 <dd>
496 plug-in update status (integer, one of PluginStatusNew,
497 PluginStatusUpToDate, PluginStatusLocalUpdate,
498 PluginStatusRemoteUpdate)
499 </dd>
500 </dl><a NAME="PluginRepositoryWidget.addEntry" ID="PluginRepositoryWidget.addEntry"></a>
501 <h4>PluginRepositoryWidget.addEntry</h4>
502 <b>addEntry</b>(<i>name, short, description, url, author, version, filename, status</i>)
503 <p>
504 Public method to add an entry to the list.
505 </p><dl>
506 <dt><i>name</i></dt>
507 <dd>
508 data for the name field (string)
509 </dd><dt><i>short</i></dt>
510 <dd>
511 data for the short field (string)
512 </dd><dt><i>description</i></dt>
513 <dd>
514 data for the description field (list of strings)
515 </dd><dt><i>url</i></dt>
516 <dd>
517 data for the url field (string)
518 </dd><dt><i>author</i></dt>
519 <dd>
520 data for the author field (string)
521 </dd><dt><i>version</i></dt>
522 <dd>
523 data for the version field (string)
524 </dd><dt><i>filename</i></dt>
525 <dd>
526 data for the filename field (string)
527 </dd><dt><i>status</i></dt>
528 <dd>
529 status of the plugin (string [stable, unstable, unknown])
530 </dd>
531 </dl><a NAME="PluginRepositoryWidget.getDownloadedPlugins" ID="PluginRepositoryWidget.getDownloadedPlugins"></a>
532 <h4>PluginRepositoryWidget.getDownloadedPlugins</h4>
533 <b>getDownloadedPlugins</b>(<i></i>)
534 <p>
535 Public method to get the list of recently downloaded plugin files.
536 </p><dl>
537 <dt>Returns:</dt>
538 <dd>
539 list of plugin filenames (list of strings)
540 </dd>
541 </dl><a NAME="PluginRepositoryWidget.on_buttonBox_clicked" ID="PluginRepositoryWidget.on_buttonBox_clicked"></a>
542 <h4>PluginRepositoryWidget.on_buttonBox_clicked</h4>
543 <b>on_buttonBox_clicked</b>(<i>button</i>)
544 <p>
545 Private slot to handle the click of a button of the button box.
546 </p><dl>
547 <dt><i>button</i></dt>
548 <dd>
549 reference to the button pressed (QAbstractButton)
550 </dd>
551 </dl><a NAME="PluginRepositoryWidget.on_repositoryList_currentItemChanged" ID="PluginRepositoryWidget.on_repositoryList_currentItemChanged"></a>
552 <h4>PluginRepositoryWidget.on_repositoryList_currentItemChanged</h4>
553 <b>on_repositoryList_currentItemChanged</b>(<i>current, previous</i>)
554 <p>
555 Private slot to handle the change of the current item.
556 </p><dl>
557 <dt><i>current</i></dt>
558 <dd>
559 reference to the new current item (QTreeWidgetItem)
560 </dd><dt><i>previous</i></dt>
561 <dd>
562 reference to the old current item (QTreeWidgetItem)
563 </dd>
564 </dl><a NAME="PluginRepositoryWidget.on_repositoryList_customContextMenuRequested" ID="PluginRepositoryWidget.on_repositoryList_customContextMenuRequested"></a>
565 <h4>PluginRepositoryWidget.on_repositoryList_customContextMenuRequested</h4>
566 <b>on_repositoryList_customContextMenuRequested</b>(<i>pos</i>)
567 <p>
568 Private slot to show the context menu.
569 </p><dl>
570 <dt><i>pos</i></dt>
571 <dd>
572 position to show the menu (QPoint)
573 </dd>
574 </dl><a NAME="PluginRepositoryWidget.on_repositoryList_itemSelectionChanged" ID="PluginRepositoryWidget.on_repositoryList_itemSelectionChanged"></a>
575 <h4>PluginRepositoryWidget.on_repositoryList_itemSelectionChanged</h4>
576 <b>on_repositoryList_itemSelectionChanged</b>(<i></i>)
577 <p>
578 Private slot to handle a change of the selection.
579 </p><a NAME="PluginRepositoryWidget.on_repositoryUrlEditButton_toggled" ID="PluginRepositoryWidget.on_repositoryUrlEditButton_toggled"></a>
580 <h4>PluginRepositoryWidget.on_repositoryUrlEditButton_toggled</h4>
581 <b>on_repositoryUrlEditButton_toggled</b>(<i>checked</i>)
582 <p>
583 Private slot to set the read only status of the repository URL line
584 edit.
585 </p><dl>
586 <dt><i>checked</i></dt>
587 <dd>
588 state of the push button (boolean)
589 </dd>
590 </dl>
591 <div align="right"><a href="#top">Up</a></div>
592 <hr /><hr />
593 <a NAME="PluginRepositoryWindow" ID="PluginRepositoryWindow"></a>
594 <h2>PluginRepositoryWindow</h2>
595 <p>
596 Main window class for the standalone dialog.
597 </p>
598 <h3>Derived from</h3>
599 E5MainWindow
600 <h3>Class Attributes</h3>
601 <table>
602 <tr><td>None</td></tr>
603 </table>
604 <h3>Class Methods</h3>
605 <table>
606 <tr><td>None</td></tr>
607 </table>
608 <h3>Methods</h3>
609 <table>
610 <tr>
611 <td><a href="#PluginRepositoryWindow.__init__">PluginRepositoryWindow</a></td>
612 <td>Constructor</td>
613 </tr><tr>
614 <td><a href="#PluginRepositoryWindow.__startPluginInstall">__startPluginInstall</a></td>
615 <td>Private slot to start the eric6 plugin installation dialog.</td>
616 </tr>
617 </table>
618 <h3>Static Methods</h3>
619 <table>
620 <tr><td>None</td></tr>
621 </table>
622 <a NAME="PluginRepositoryWindow.__init__" ID="PluginRepositoryWindow.__init__"></a>
623 <h4>PluginRepositoryWindow (Constructor)</h4>
624 <b>PluginRepositoryWindow</b>(<i>parent=None</i>)
625 <p>
626 Constructor
627 </p><dl>
628 <dt><i>parent</i></dt>
629 <dd>
630 reference to the parent widget (QWidget)
631 </dd>
632 </dl><a NAME="PluginRepositoryWindow.__startPluginInstall" ID="PluginRepositoryWindow.__startPluginInstall"></a>
633 <h4>PluginRepositoryWindow.__startPluginInstall</h4>
634 <b>__startPluginInstall</b>(<i></i>)
635 <p>
636 Private slot to start the eric6 plugin installation dialog.
637 </p>
638 <div align="right"><a href="#top">Up</a></div>
639 <hr /><hr />
640 <a NAME="PluginRepositoryDownloadCleanup" ID="PluginRepositoryDownloadCleanup"></a>
641 <h2>PluginRepositoryDownloadCleanup</h2>
642 <b>PluginRepositoryDownloadCleanup</b>(<i>quiet=False</i>)
643 <p>
644 Module function to clean up the plug-in downloads area.
645 </p><dl>
646 <dt><i>quiet</i> (bool)</dt>
647 <dd>
648 flag indicating quiet operations
649 </dd>
650 </dl>
651 <div align="right"><a href="#top">Up</a></div>
652 <hr /><hr />
653 <a NAME="registerPlugin" ID="registerPlugin"></a>
654 <h2>registerPlugin</h2>
655 <b>registerPlugin</b>(<i>name, short, description, url, author, version, filename, status</i>)
656 <p>
657 Method to register a plug-in's data.
658 </p><dl>
659 <dt><i>name</i></dt>
660 <dd>
661 data for the name field (string)
662 </dd><dt><i>short</i></dt>
663 <dd>
664 data for the short field (string)
665 </dd><dt><i>description</i></dt>
666 <dd>
667 data for the description field (list of strings)
668 </dd><dt><i>url</i></dt>
669 <dd>
670 data for the url field (string)
671 </dd><dt><i>author</i></dt>
672 <dd>
673 data for the author field (string)
674 </dd><dt><i>version</i></dt>
675 <dd>
676 data for the version field (string)
677 </dd><dt><i>filename</i></dt>
678 <dd>
679 data for the filename field (string)
680 </dd><dt><i>status</i></dt>
681 <dd>
682 status of the plugin (string [stable, unstable, unknown])
683 </dd>
684 </dl>
685 <div align="right"><a href="#top">Up</a></div>
686 <hr />
687 </body></html>

Mercurial Repository: eric

eric ide

mercurial