Mercurial Repositories > eric / file comparison

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

eric7/Documentation/Source/eric7.PluginManager.PluginRepositoryDialog.html

branch
eric7
changeset 8372
e0227a7c850e
child 8580
e91b276e0771
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.PluginManager.PluginRepositoryDialog</h1>
24
25 <p>
26 Module implementing a dialog showing the available plugins.
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="#PluginRepositoryDialog">PluginRepositoryDialog</a></td>
39 <td>Class for the dialog variant.</td>
40 </tr>
41 <tr>
42 <td><a href="#PluginRepositoryWidget">PluginRepositoryWidget</a></td>
43 <td>Class implementing a dialog showing the available plugins.</td>
44 </tr>
45 <tr>
46 <td><a href="#PluginRepositoryWindow">PluginRepositoryWindow</a></td>
47 <td>Main window class for the standalone dialog.</td>
48 </tr>
49 </table>
50 <h3>Functions</h3>
51
52 <table>
53
54 <tr>
55 <td><a href="#PluginRepositoryDownloadCleanup">PluginRepositoryDownloadCleanup</a></td>
56 <td>Module function to clean up the plug-in downloads area.</td>
57 </tr>
58 <tr>
59 <td><a href="#registerPlugin">registerPlugin</a></td>
60 <td>Method to register a plug-in's data.</td>
61 </tr>
62 </table>
63 <hr />
64 <hr />
65 <a NAME="PluginRepositoryDialog" ID="PluginRepositoryDialog"></a>
66 <h2>PluginRepositoryDialog</h2>
67
68 <p>
69 Class for the dialog variant.
70 </p>
71 <h3>Derived from</h3>
72 QDialog
73 <h3>Class Attributes</h3>
74
75 <table>
76 <tr><td>None</td></tr>
77 </table>
78 <h3>Class Methods</h3>
79
80 <table>
81 <tr><td>None</td></tr>
82 </table>
83 <h3>Methods</h3>
84
85 <table>
86
87 <tr>
88 <td><a href="#PluginRepositoryDialog.__init__">PluginRepositoryDialog</a></td>
89 <td>Constructor</td>
90 </tr>
91 <tr>
92 <td><a href="#PluginRepositoryDialog.__closeAndInstall">__closeAndInstall</a></td>
93 <td>Private slot to handle the closeAndInstall signal.</td>
94 </tr>
95 <tr>
96 <td><a href="#PluginRepositoryDialog.getDownloadedPlugins">getDownloadedPlugins</a></td>
97 <td>Public method to get the list of recently downloaded plugin files.</td>
98 </tr>
99 </table>
100 <h3>Static Methods</h3>
101
102 <table>
103 <tr><td>None</td></tr>
104 </table>
105
106 <a NAME="PluginRepositoryDialog.__init__" ID="PluginRepositoryDialog.__init__"></a>
107 <h4>PluginRepositoryDialog (Constructor)</h4>
108 <b>PluginRepositoryDialog</b>(<i>pluginManager, parent=None</i>)
109
110 <p>
111 Constructor
112 </p>
113 <dl>
114
115 <dt><i>pluginManager</i> (PluginManager)</dt>
116 <dd>
117 reference to the plugin manager object
118 </dd>
119 <dt><i>parent</i> (QWidget)</dt>
120 <dd>
121 reference to the parent widget
122 </dd>
123 </dl>
124 <a NAME="PluginRepositoryDialog.__closeAndInstall" ID="PluginRepositoryDialog.__closeAndInstall"></a>
125 <h4>PluginRepositoryDialog.__closeAndInstall</h4>
126 <b>__closeAndInstall</b>(<i></i>)
127
128 <p>
129 Private slot to handle the closeAndInstall signal.
130 </p>
131 <a NAME="PluginRepositoryDialog.getDownloadedPlugins" ID="PluginRepositoryDialog.getDownloadedPlugins"></a>
132 <h4>PluginRepositoryDialog.getDownloadedPlugins</h4>
133 <b>getDownloadedPlugins</b>(<i></i>)
134
135 <p>
136 Public method to get the list of recently downloaded plugin files.
137 </p>
138 <dl>
139 <dt>Return:</dt>
140 <dd>
141 list of plugin filenames (list of strings)
142 </dd>
143 </dl>
144 <div align="right"><a href="#top">Up</a></div>
145 <hr />
146 <hr />
147 <a NAME="PluginRepositoryWidget" ID="PluginRepositoryWidget"></a>
148 <h2>PluginRepositoryWidget</h2>
149
150 <p>
151 Class implementing a dialog showing the available plugins.
152 </p>
153 <h3>Signals</h3>
154 <dl>
155
156 <dt>closeAndInstall()</dt>
157 <dd>
158 emitted when the Close & Install button is
159 pressed
160 </dd>
161 </dl>
162 <h3>Derived from</h3>
163 QWidget, Ui_PluginRepositoryDialog
164 <h3>Class Attributes</h3>
165
166 <table>
167 <tr><td>AuthorRole</td></tr><tr><td>DescrRole</td></tr><tr><td>FilenameRole</td></tr><tr><td>PluginStatusError</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>
168 </table>
169 <h3>Class Methods</h3>
170
171 <table>
172 <tr><td>None</td></tr>
173 </table>
174 <h3>Methods</h3>
175
176 <table>
177
178 <tr>
179 <td><a href="#PluginRepositoryWidget.__init__">PluginRepositoryWidget</a></td>
180 <td>Constructor</td>
181 </tr>
182 <tr>
183 <td><a href="#PluginRepositoryWidget.__changeScheme">__changeScheme</a></td>
184 <td>Private method to change the scheme of the given URL.</td>
185 </tr>
186 <tr>
187 <td><a href="#PluginRepositoryWidget.__cleanupDownloads">__cleanupDownloads</a></td>
188 <td>Private slot to cleanup the plug-in downloads area.</td>
189 </tr>
190 <tr>
191 <td><a href="#PluginRepositoryWidget.__closeAndInstall">__closeAndInstall</a></td>
192 <td>Private method to close the dialog and invoke the install dialog.</td>
193 </tr>
194 <tr>
195 <td><a href="#PluginRepositoryWidget.__downloadCancel">__downloadCancel</a></td>
196 <td>Private slot to cancel the current download.</td>
197 </tr>
198 <tr>
199 <td><a href="#PluginRepositoryWidget.__downloadFile">__downloadFile</a></td>
200 <td>Private slot to download the given file.</td>
201 </tr>
202 <tr>
203 <td><a href="#PluginRepositoryWidget.__downloadFileDone">__downloadFileDone</a></td>
204 <td>Private method called, after the file has been downloaded from the Internet.</td>
205 </tr>
206 <tr>
207 <td><a href="#PluginRepositoryWidget.__downloadPlugin">__downloadPlugin</a></td>
208 <td>Private method to download the next plugin.</td>
209 </tr>
210 <tr>
211 <td><a href="#PluginRepositoryWidget.__downloadPluginDone">__downloadPluginDone</a></td>
212 <td>Private method called, when the download of a plugin is finished.</td>
213 </tr>
214 <tr>
215 <td><a href="#PluginRepositoryWidget.__downloadPlugins">__downloadPlugins</a></td>
216 <td>Private slot to download the selected plugins.</td>
217 </tr>
218 <tr>
219 <td><a href="#PluginRepositoryWidget.__downloadPluginsDone">__downloadPluginsDone</a></td>
220 <td>Private method called, when the download of the plugins is finished.</td>
221 </tr>
222 <tr>
223 <td><a href="#PluginRepositoryWidget.__downloadProgress">__downloadProgress</a></td>
224 <td>Private slot to show the download progress.</td>
225 </tr>
226 <tr>
227 <td><a href="#PluginRepositoryWidget.__downloadRepositoryFileDone">__downloadRepositoryFileDone</a></td>
228 <td>Private method called after the repository file was downloaded.</td>
229 </tr>
230 <tr>
231 <td><a href="#PluginRepositoryWidget.__formatDescription">__formatDescription</a></td>
232 <td>Private method to format the description.</td>
233 </tr>
234 <tr>
235 <td><a href="#PluginRepositoryWidget.__hasHiddenPlugins">__hasHiddenPlugins</a></td>
236 <td>Private method to check, if there are any hidden plug-ins.</td>
237 </tr>
238 <tr>
239 <td><a href="#PluginRepositoryWidget.__hidePlugin">__hidePlugin</a></td>
240 <td>Private slot to hide the current plug-in.</td>
241 </tr>
242 <tr>
243 <td><a href="#PluginRepositoryWidget.__hideSelectedPlugins">__hideSelectedPlugins</a></td>
244 <td>Private slot to hide all selected plug-ins.</td>
245 </tr>
246 <tr>
247 <td><a href="#PluginRepositoryWidget.__populateList">__populateList</a></td>
248 <td>Private method to populate the list of available plugins.</td>
249 </tr>
250 <tr>
251 <td><a href="#PluginRepositoryWidget.__resortRepositoryList">__resortRepositoryList</a></td>
252 <td>Private method to resort the tree.</td>
253 </tr>
254 <tr>
255 <td><a href="#PluginRepositoryWidget.__selectedItems">__selectedItems</a></td>
256 <td>Private method to get all selected items without the toplevel ones.</td>
257 </tr>
258 <tr>
259 <td><a href="#PluginRepositoryWidget.__showAllPlugins">__showAllPlugins</a></td>
260 <td>Private slot to show all plug-ins.</td>
261 </tr>
262 <tr>
263 <td><a href="#PluginRepositoryWidget.__sslErrors">__sslErrors</a></td>
264 <td>Private slot to handle SSL errors.</td>
265 </tr>
266 <tr>
267 <td><a href="#PluginRepositoryWidget.__updateHiddenPluginsList">__updateHiddenPluginsList</a></td>
268 <td>Private method to store the list of hidden plug-ins to the settings.</td>
269 </tr>
270 <tr>
271 <td><a href="#PluginRepositoryWidget.__updateList">__updateList</a></td>
272 <td>Private slot to download a new list and display the contents.</td>
273 </tr>
274 <tr>
275 <td><a href="#PluginRepositoryWidget.__updateStatus">__updateStatus</a></td>
276 <td>Private method to check the given archive update status.</td>
277 </tr>
278 <tr>
279 <td><a href="#PluginRepositoryWidget.addEntry">addEntry</a></td>
280 <td>Public method to add an entry to the list.</td>
281 </tr>
282 <tr>
283 <td><a href="#PluginRepositoryWidget.getDownloadedPlugins">getDownloadedPlugins</a></td>
284 <td>Public method to get the list of recently downloaded plugin files.</td>
285 </tr>
286 <tr>
287 <td><a href="#PluginRepositoryWidget.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
288 <td>Private slot to handle the click of a button of the button box.</td>
289 </tr>
290 <tr>
291 <td><a href="#PluginRepositoryWidget.on_repositoryList_currentItemChanged">on_repositoryList_currentItemChanged</a></td>
292 <td>Private slot to handle the change of the current item.</td>
293 </tr>
294 <tr>
295 <td><a href="#PluginRepositoryWidget.on_repositoryList_customContextMenuRequested">on_repositoryList_customContextMenuRequested</a></td>
296 <td>Private slot to show the context menu.</td>
297 </tr>
298 <tr>
299 <td><a href="#PluginRepositoryWidget.on_repositoryList_itemSelectionChanged">on_repositoryList_itemSelectionChanged</a></td>
300 <td>Private slot to handle a change of the selection.</td>
301 </tr>
302 <tr>
303 <td><a href="#PluginRepositoryWidget.on_repositoryUrlEditButton_toggled">on_repositoryUrlEditButton_toggled</a></td>
304 <td>Private slot to set the read only status of the repository URL line edit.</td>
305 </tr>
306 </table>
307 <h3>Static Methods</h3>
308
309 <table>
310 <tr><td>None</td></tr>
311 </table>
312
313 <a NAME="PluginRepositoryWidget.__init__" ID="PluginRepositoryWidget.__init__"></a>
314 <h4>PluginRepositoryWidget (Constructor)</h4>
315 <b>PluginRepositoryWidget</b>(<i>pluginManager, parent=None</i>)
316
317 <p>
318 Constructor
319 </p>
320 <dl>
321
322 <dt><i>pluginManager</i> (PluginManager)</dt>
323 <dd>
324 reference to the plugin manager object
325 </dd>
326 <dt><i>parent</i> (QWidget)</dt>
327 <dd>
328 parent of this dialog
329 </dd>
330 </dl>
331 <a NAME="PluginRepositoryWidget.__changeScheme" ID="PluginRepositoryWidget.__changeScheme"></a>
332 <h4>PluginRepositoryWidget.__changeScheme</h4>
333 <b>__changeScheme</b>(<i>url, newScheme=""</i>)
334
335 <p>
336 Private method to change the scheme of the given URL.
337 </p>
338 <dl>
339
340 <dt><i>url</i> (str)</dt>
341 <dd>
342 URL to be modified
343 </dd>
344 <dt><i>newScheme</i></dt>
345 <dd>
346 scheme to be set for the given URL
347 </dd>
348 </dl>
349 <dl>
350 <dt>Return:</dt>
351 <dd>
352 modified URL
353 </dd>
354 </dl>
355 <dl>
356 <dt>Return Type:</dt>
357 <dd>
358 str
359 </dd>
360 </dl>
361 <a NAME="PluginRepositoryWidget.__cleanupDownloads" ID="PluginRepositoryWidget.__cleanupDownloads"></a>
362 <h4>PluginRepositoryWidget.__cleanupDownloads</h4>
363 <b>__cleanupDownloads</b>(<i></i>)
364
365 <p>
366 Private slot to cleanup the plug-in downloads area.
367 </p>
368 <a NAME="PluginRepositoryWidget.__closeAndInstall" ID="PluginRepositoryWidget.__closeAndInstall"></a>
369 <h4>PluginRepositoryWidget.__closeAndInstall</h4>
370 <b>__closeAndInstall</b>(<i></i>)
371
372 <p>
373 Private method to close the dialog and invoke the install dialog.
374 </p>
375 <a NAME="PluginRepositoryWidget.__downloadCancel" ID="PluginRepositoryWidget.__downloadCancel"></a>
376 <h4>PluginRepositoryWidget.__downloadCancel</h4>
377 <b>__downloadCancel</b>(<i>reply=None</i>)
378
379 <p>
380 Private slot to cancel the current download.
381 </p>
382 <dl>
383
384 <dt><i>reply</i> (QNetworkReply)</dt>
385 <dd>
386 reference to the network reply
387 </dd>
388 </dl>
389 <a NAME="PluginRepositoryWidget.__downloadFile" ID="PluginRepositoryWidget.__downloadFile"></a>
390 <h4>PluginRepositoryWidget.__downloadFile</h4>
391 <b>__downloadFile</b>(<i>url, filename, doneMethod=None</i>)
392
393 <p>
394 Private slot to download the given file.
395 </p>
396 <dl>
397
398 <dt><i>url</i></dt>
399 <dd>
400 URL for the download (string)
401 </dd>
402 <dt><i>filename</i></dt>
403 <dd>
404 local name of the file (string)
405 </dd>
406 <dt><i>doneMethod</i></dt>
407 <dd>
408 method to be called when done
409 </dd>
410 </dl>
411 <a NAME="PluginRepositoryWidget.__downloadFileDone" ID="PluginRepositoryWidget.__downloadFileDone"></a>
412 <h4>PluginRepositoryWidget.__downloadFileDone</h4>
413 <b>__downloadFileDone</b>(<i>reply, fileName, doneMethod</i>)
414
415 <p>
416 Private method called, after the file has been downloaded
417 from the Internet.
418 </p>
419 <dl>
420
421 <dt><i>reply</i> (QNetworkReply)</dt>
422 <dd>
423 reference to the reply object of the download
424 </dd>
425 <dt><i>fileName</i> (str)</dt>
426 <dd>
427 local name of the file
428 </dd>
429 <dt><i>doneMethod</i> (func)</dt>
430 <dd>
431 method to be called when done
432 </dd>
433 </dl>
434 <a NAME="PluginRepositoryWidget.__downloadPlugin" ID="PluginRepositoryWidget.__downloadPlugin"></a>
435 <h4>PluginRepositoryWidget.__downloadPlugin</h4>
436 <b>__downloadPlugin</b>(<i></i>)
437
438 <p>
439 Private method to download the next plugin.
440 </p>
441 <a NAME="PluginRepositoryWidget.__downloadPluginDone" ID="PluginRepositoryWidget.__downloadPluginDone"></a>
442 <h4>PluginRepositoryWidget.__downloadPluginDone</h4>
443 <b>__downloadPluginDone</b>(<i>status, filename</i>)
444
445 <p>
446 Private method called, when the download of a plugin is finished.
447 </p>
448 <dl>
449
450 <dt><i>status</i></dt>
451 <dd>
452 flag indicating a successful download (boolean)
453 </dd>
454 <dt><i>filename</i></dt>
455 <dd>
456 full path of the downloaded file (string)
457 </dd>
458 </dl>
459 <a NAME="PluginRepositoryWidget.__downloadPlugins" ID="PluginRepositoryWidget.__downloadPlugins"></a>
460 <h4>PluginRepositoryWidget.__downloadPlugins</h4>
461 <b>__downloadPlugins</b>(<i></i>)
462
463 <p>
464 Private slot to download the selected plugins.
465 </p>
466 <a NAME="PluginRepositoryWidget.__downloadPluginsDone" ID="PluginRepositoryWidget.__downloadPluginsDone"></a>
467 <h4>PluginRepositoryWidget.__downloadPluginsDone</h4>
468 <b>__downloadPluginsDone</b>(<i></i>)
469
470 <p>
471 Private method called, when the download of the plugins is finished.
472 </p>
473 <a NAME="PluginRepositoryWidget.__downloadProgress" ID="PluginRepositoryWidget.__downloadProgress"></a>
474 <h4>PluginRepositoryWidget.__downloadProgress</h4>
475 <b>__downloadProgress</b>(<i>done, total</i>)
476
477 <p>
478 Private slot to show the download progress.
479 </p>
480 <dl>
481
482 <dt><i>done</i></dt>
483 <dd>
484 number of bytes downloaded so far (integer)
485 </dd>
486 <dt><i>total</i></dt>
487 <dd>
488 total bytes to be downloaded (integer)
489 </dd>
490 </dl>
491 <a NAME="PluginRepositoryWidget.__downloadRepositoryFileDone" ID="PluginRepositoryWidget.__downloadRepositoryFileDone"></a>
492 <h4>PluginRepositoryWidget.__downloadRepositoryFileDone</h4>
493 <b>__downloadRepositoryFileDone</b>(<i>status, filename</i>)
494
495 <p>
496 Private method called after the repository file was downloaded.
497 </p>
498 <dl>
499
500 <dt><i>status</i></dt>
501 <dd>
502 flaging indicating a successful download (boolean)
503 </dd>
504 <dt><i>filename</i></dt>
505 <dd>
506 full path of the downloaded file (string)
507 </dd>
508 </dl>
509 <a NAME="PluginRepositoryWidget.__formatDescription" ID="PluginRepositoryWidget.__formatDescription"></a>
510 <h4>PluginRepositoryWidget.__formatDescription</h4>
511 <b>__formatDescription</b>(<i>lines</i>)
512
513 <p>
514 Private method to format the description.
515 </p>
516 <dl>
517
518 <dt><i>lines</i></dt>
519 <dd>
520 lines of the description (list of strings)
521 </dd>
522 </dl>
523 <dl>
524 <dt>Return:</dt>
525 <dd>
526 formatted description (string)
527 </dd>
528 </dl>
529 <a NAME="PluginRepositoryWidget.__hasHiddenPlugins" ID="PluginRepositoryWidget.__hasHiddenPlugins"></a>
530 <h4>PluginRepositoryWidget.__hasHiddenPlugins</h4>
531 <b>__hasHiddenPlugins</b>(<i></i>)
532
533 <p>
534 Private method to check, if there are any hidden plug-ins.
535 </p>
536 <dl>
537 <dt>Return:</dt>
538 <dd>
539 flag indicating the presence of hidden plug-ins (boolean)
540 </dd>
541 </dl>
542 <a NAME="PluginRepositoryWidget.__hidePlugin" ID="PluginRepositoryWidget.__hidePlugin"></a>
543 <h4>PluginRepositoryWidget.__hidePlugin</h4>
544 <b>__hidePlugin</b>(<i></i>)
545
546 <p>
547 Private slot to hide the current plug-in.
548 </p>
549 <a NAME="PluginRepositoryWidget.__hideSelectedPlugins" ID="PluginRepositoryWidget.__hideSelectedPlugins"></a>
550 <h4>PluginRepositoryWidget.__hideSelectedPlugins</h4>
551 <b>__hideSelectedPlugins</b>(<i></i>)
552
553 <p>
554 Private slot to hide all selected plug-ins.
555 </p>
556 <a NAME="PluginRepositoryWidget.__populateList" ID="PluginRepositoryWidget.__populateList"></a>
557 <h4>PluginRepositoryWidget.__populateList</h4>
558 <b>__populateList</b>(<i></i>)
559
560 <p>
561 Private method to populate the list of available plugins.
562 </p>
563 <a NAME="PluginRepositoryWidget.__resortRepositoryList" ID="PluginRepositoryWidget.__resortRepositoryList"></a>
564 <h4>PluginRepositoryWidget.__resortRepositoryList</h4>
565 <b>__resortRepositoryList</b>(<i></i>)
566
567 <p>
568 Private method to resort the tree.
569 </p>
570 <a NAME="PluginRepositoryWidget.__selectedItems" ID="PluginRepositoryWidget.__selectedItems"></a>
571 <h4>PluginRepositoryWidget.__selectedItems</h4>
572 <b>__selectedItems</b>(<i></i>)
573
574 <p>
575 Private method to get all selected items without the toplevel ones.
576 </p>
577 <dl>
578 <dt>Return:</dt>
579 <dd>
580 list of selected items (list)
581 </dd>
582 </dl>
583 <a NAME="PluginRepositoryWidget.__showAllPlugins" ID="PluginRepositoryWidget.__showAllPlugins"></a>
584 <h4>PluginRepositoryWidget.__showAllPlugins</h4>
585 <b>__showAllPlugins</b>(<i></i>)
586
587 <p>
588 Private slot to show all plug-ins.
589 </p>
590 <a NAME="PluginRepositoryWidget.__sslErrors" ID="PluginRepositoryWidget.__sslErrors"></a>
591 <h4>PluginRepositoryWidget.__sslErrors</h4>
592 <b>__sslErrors</b>(<i>reply, errors</i>)
593
594 <p>
595 Private slot to handle SSL errors.
596 </p>
597 <dl>
598
599 <dt><i>reply</i></dt>
600 <dd>
601 reference to the reply object (QNetworkReply)
602 </dd>
603 <dt><i>errors</i></dt>
604 <dd>
605 list of SSL errors (list of QSslError)
606 </dd>
607 </dl>
608 <a NAME="PluginRepositoryWidget.__updateHiddenPluginsList" ID="PluginRepositoryWidget.__updateHiddenPluginsList"></a>
609 <h4>PluginRepositoryWidget.__updateHiddenPluginsList</h4>
610 <b>__updateHiddenPluginsList</b>(<i>hideList</i>)
611
612 <p>
613 Private method to store the list of hidden plug-ins to the settings.
614 </p>
615 <dl>
616
617 <dt><i>hideList</i></dt>
618 <dd>
619 list of plug-ins to add to the list of hidden ones
620 (list of string)
621 </dd>
622 </dl>
623 <a NAME="PluginRepositoryWidget.__updateList" ID="PluginRepositoryWidget.__updateList"></a>
624 <h4>PluginRepositoryWidget.__updateList</h4>
625 <b>__updateList</b>(<i></i>)
626
627 <p>
628 Private slot to download a new list and display the contents.
629 </p>
630 <a NAME="PluginRepositoryWidget.__updateStatus" ID="PluginRepositoryWidget.__updateStatus"></a>
631 <h4>PluginRepositoryWidget.__updateStatus</h4>
632 <b>__updateStatus</b>(<i>filename, version</i>)
633
634 <p>
635 Private method to check the given archive update status.
636 </p>
637 <dl>
638
639 <dt><i>filename</i></dt>
640 <dd>
641 data for the filename field (string)
642 </dd>
643 <dt><i>version</i></dt>
644 <dd>
645 data for the version field (string)
646 </dd>
647 </dl>
648 <dl>
649 <dt>Return:</dt>
650 <dd>
651 plug-in update status (integer, one of PluginStatusNew,
652 PluginStatusUpToDate, PluginStatusLocalUpdate,
653 PluginStatusRemoteUpdate)
654 </dd>
655 </dl>
656 <a NAME="PluginRepositoryWidget.addEntry" ID="PluginRepositoryWidget.addEntry"></a>
657 <h4>PluginRepositoryWidget.addEntry</h4>
658 <b>addEntry</b>(<i>name, short, description, url, author, version, filename, status</i>)
659
660 <p>
661 Public method to add an entry to the list.
662 </p>
663 <dl>
664
665 <dt><i>name</i></dt>
666 <dd>
667 data for the name field (string)
668 </dd>
669 <dt><i>short</i></dt>
670 <dd>
671 data for the short field (string)
672 </dd>
673 <dt><i>description</i></dt>
674 <dd>
675 data for the description field (list of strings)
676 </dd>
677 <dt><i>url</i></dt>
678 <dd>
679 data for the url field (string)
680 </dd>
681 <dt><i>author</i></dt>
682 <dd>
683 data for the author field (string)
684 </dd>
685 <dt><i>version</i></dt>
686 <dd>
687 data for the version field (string)
688 </dd>
689 <dt><i>filename</i></dt>
690 <dd>
691 data for the filename field (string)
692 </dd>
693 <dt><i>status</i></dt>
694 <dd>
695 status of the plugin (string [stable, unstable, unknown])
696 </dd>
697 </dl>
698 <a NAME="PluginRepositoryWidget.getDownloadedPlugins" ID="PluginRepositoryWidget.getDownloadedPlugins"></a>
699 <h4>PluginRepositoryWidget.getDownloadedPlugins</h4>
700 <b>getDownloadedPlugins</b>(<i></i>)
701
702 <p>
703 Public method to get the list of recently downloaded plugin files.
704 </p>
705 <dl>
706 <dt>Return:</dt>
707 <dd>
708 list of plugin filenames (list of strings)
709 </dd>
710 </dl>
711 <a NAME="PluginRepositoryWidget.on_buttonBox_clicked" ID="PluginRepositoryWidget.on_buttonBox_clicked"></a>
712 <h4>PluginRepositoryWidget.on_buttonBox_clicked</h4>
713 <b>on_buttonBox_clicked</b>(<i>button</i>)
714
715 <p>
716 Private slot to handle the click of a button of the button box.
717 </p>
718 <dl>
719
720 <dt><i>button</i></dt>
721 <dd>
722 reference to the button pressed (QAbstractButton)
723 </dd>
724 </dl>
725 <a NAME="PluginRepositoryWidget.on_repositoryList_currentItemChanged" ID="PluginRepositoryWidget.on_repositoryList_currentItemChanged"></a>
726 <h4>PluginRepositoryWidget.on_repositoryList_currentItemChanged</h4>
727 <b>on_repositoryList_currentItemChanged</b>(<i>current, previous</i>)
728
729 <p>
730 Private slot to handle the change of the current item.
731 </p>
732 <dl>
733
734 <dt><i>current</i></dt>
735 <dd>
736 reference to the new current item (QTreeWidgetItem)
737 </dd>
738 <dt><i>previous</i></dt>
739 <dd>
740 reference to the old current item (QTreeWidgetItem)
741 </dd>
742 </dl>
743 <a NAME="PluginRepositoryWidget.on_repositoryList_customContextMenuRequested" ID="PluginRepositoryWidget.on_repositoryList_customContextMenuRequested"></a>
744 <h4>PluginRepositoryWidget.on_repositoryList_customContextMenuRequested</h4>
745 <b>on_repositoryList_customContextMenuRequested</b>(<i>pos</i>)
746
747 <p>
748 Private slot to show the context menu.
749 </p>
750 <dl>
751
752 <dt><i>pos</i></dt>
753 <dd>
754 position to show the menu (QPoint)
755 </dd>
756 </dl>
757 <a NAME="PluginRepositoryWidget.on_repositoryList_itemSelectionChanged" ID="PluginRepositoryWidget.on_repositoryList_itemSelectionChanged"></a>
758 <h4>PluginRepositoryWidget.on_repositoryList_itemSelectionChanged</h4>
759 <b>on_repositoryList_itemSelectionChanged</b>(<i></i>)
760
761 <p>
762 Private slot to handle a change of the selection.
763 </p>
764 <a NAME="PluginRepositoryWidget.on_repositoryUrlEditButton_toggled" ID="PluginRepositoryWidget.on_repositoryUrlEditButton_toggled"></a>
765 <h4>PluginRepositoryWidget.on_repositoryUrlEditButton_toggled</h4>
766 <b>on_repositoryUrlEditButton_toggled</b>(<i>checked</i>)
767
768 <p>
769 Private slot to set the read only status of the repository URL line
770 edit.
771 </p>
772 <dl>
773
774 <dt><i>checked</i></dt>
775 <dd>
776 state of the push button (boolean)
777 </dd>
778 </dl>
779 <div align="right"><a href="#top">Up</a></div>
780 <hr />
781 <hr />
782 <a NAME="PluginRepositoryWindow" ID="PluginRepositoryWindow"></a>
783 <h2>PluginRepositoryWindow</h2>
784
785 <p>
786 Main window class for the standalone dialog.
787 </p>
788 <h3>Derived from</h3>
789 EricMainWindow
790 <h3>Class Attributes</h3>
791
792 <table>
793 <tr><td>None</td></tr>
794 </table>
795 <h3>Class Methods</h3>
796
797 <table>
798 <tr><td>None</td></tr>
799 </table>
800 <h3>Methods</h3>
801
802 <table>
803
804 <tr>
805 <td><a href="#PluginRepositoryWindow.__init__">PluginRepositoryWindow</a></td>
806 <td>Constructor</td>
807 </tr>
808 <tr>
809 <td><a href="#PluginRepositoryWindow.__startPluginInstall">__startPluginInstall</a></td>
810 <td>Private slot to start the eric plugin installation dialog.</td>
811 </tr>
812 </table>
813 <h3>Static Methods</h3>
814
815 <table>
816 <tr><td>None</td></tr>
817 </table>
818
819 <a NAME="PluginRepositoryWindow.__init__" ID="PluginRepositoryWindow.__init__"></a>
820 <h4>PluginRepositoryWindow (Constructor)</h4>
821 <b>PluginRepositoryWindow</b>(<i>parent=None</i>)
822
823 <p>
824 Constructor
825 </p>
826 <dl>
827
828 <dt><i>parent</i></dt>
829 <dd>
830 reference to the parent widget (QWidget)
831 </dd>
832 </dl>
833 <a NAME="PluginRepositoryWindow.__startPluginInstall" ID="PluginRepositoryWindow.__startPluginInstall"></a>
834 <h4>PluginRepositoryWindow.__startPluginInstall</h4>
835 <b>__startPluginInstall</b>(<i></i>)
836
837 <p>
838 Private slot to start the eric plugin installation dialog.
839 </p>
840 <div align="right"><a href="#top">Up</a></div>
841 <hr />
842 <hr />
843 <a NAME="PluginRepositoryDownloadCleanup" ID="PluginRepositoryDownloadCleanup"></a>
844 <h2>PluginRepositoryDownloadCleanup</h2>
845 <b>PluginRepositoryDownloadCleanup</b>(<i>quiet=False</i>)
846
847 <p>
848 Module function to clean up the plug-in downloads area.
849 </p>
850 <dl>
851
852 <dt><i>quiet</i> (bool)</dt>
853 <dd>
854 flag indicating quiet operations
855 </dd>
856 </dl>
857 <div align="right"><a href="#top">Up</a></div>
858 <hr />
859 <hr />
860 <a NAME="registerPlugin" ID="registerPlugin"></a>
861 <h2>registerPlugin</h2>
862 <b>registerPlugin</b>(<i>name, short, description, url, author, version, filename, status</i>)
863
864 <p>
865 Method to register a plug-in's data.
866 </p>
867 <dl>
868
869 <dt><i>name</i></dt>
870 <dd>
871 data for the name field (string)
872 </dd>
873 <dt><i>short</i></dt>
874 <dd>
875 data for the short field (string)
876 </dd>
877 <dt><i>description</i></dt>
878 <dd>
879 data for the description field (list of strings)
880 </dd>
881 <dt><i>url</i></dt>
882 <dd>
883 data for the url field (string)
884 </dd>
885 <dt><i>author</i></dt>
886 <dd>
887 data for the author field (string)
888 </dd>
889 <dt><i>version</i></dt>
890 <dd>
891 data for the version field (string)
892 </dd>
893 <dt><i>filename</i></dt>
894 <dd>
895 data for the filename field (string)
896 </dd>
897 <dt><i>status</i></dt>
898 <dd>
899 status of the plugin (string [stable, unstable, unknown])
900 </dd>
901 </dl>
902 <div align="right"><a href="#top">Up</a></div>
903 <hr />
904 </body></html>

Mercurial Repository: eric

eric ide

mercurial