Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric4.PluginManager.PluginRepositoryDialog.html

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric4.PluginManager.PluginRepositoryDialog</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.PluginManager.PluginRepositoryDialog</h1>
24 <p>
25 Module implementing a dialog showing the available plugins.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>authorRole</td></tr><tr><td>descrRole</td></tr><tr><td>filenameRole</td></tr><tr><td>urlRole</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#PluginRepositoryDialog">PluginRepositoryDialog</a></td>
35 <td>Class for the dialog variant.</td>
36 </tr><tr>
37 <td><a href="#PluginRepositoryWidget">PluginRepositoryWidget</a></td>
38 <td>Class implementing a dialog showing the available plugins.</td>
39 </tr><tr>
40 <td><a href="#PluginRepositoryWindow">PluginRepositoryWindow</a></td>
41 <td>Main window class for the standalone dialog.</td>
42 </tr>
43 </table>
44 <h3>Functions</h3>
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <hr /><hr />
49 <a NAME="PluginRepositoryDialog" ID="PluginRepositoryDialog"></a>
50 <h2>PluginRepositoryDialog</h2>
51 <p>
52 Class for the dialog variant.
53 </p>
54 <h3>Derived from</h3>
55 QDialog
56 <h3>Class Attributes</h3>
57 <table>
58 <tr><td>None</td></tr>
59 </table>
60 <h3>Methods</h3>
61 <table>
62 <tr>
63 <td><a href="#PluginRepositoryDialog.__init__">PluginRepositoryDialog</a></td>
64 <td>Constructor</td>
65 </tr><tr>
66 <td><a href="#PluginRepositoryDialog.__closeAndInstall">__closeAndInstall</a></td>
67 <td>Private slot to handle the closeAndInstall signal.</td>
68 </tr><tr>
69 <td><a href="#PluginRepositoryDialog.getDownloadedPlugins">getDownloadedPlugins</a></td>
70 <td>Public method to get the list of recently downloaded plugin files.</td>
71 </tr>
72 </table>
73 <a NAME="PluginRepositoryDialog.__init__" ID="PluginRepositoryDialog.__init__"></a>
74 <h4>PluginRepositoryDialog (Constructor)</h4>
75 <b>PluginRepositoryDialog</b>(<i>parent = None</i>)
76 <p>
77 Constructor
78 </p><dl>
79 <dt><i>parent</i></dt>
80 <dd>
81 reference to the parent widget (QWidget)
82 </dd>
83 </dl><a NAME="PluginRepositoryDialog.__closeAndInstall" ID="PluginRepositoryDialog.__closeAndInstall"></a>
84 <h4>PluginRepositoryDialog.__closeAndInstall</h4>
85 <b>__closeAndInstall</b>(<i></i>)
86 <p>
87 Private slot to handle the closeAndInstall signal.
88 </p><a NAME="PluginRepositoryDialog.getDownloadedPlugins" ID="PluginRepositoryDialog.getDownloadedPlugins"></a>
89 <h4>PluginRepositoryDialog.getDownloadedPlugins</h4>
90 <b>getDownloadedPlugins</b>(<i></i>)
91 <p>
92 Public method to get the list of recently downloaded plugin files.
93 </p><dl>
94 <dt>Returns:</dt>
95 <dd>
96 list of plugin filenames (list of strings)
97 </dd>
98 </dl>
99 <div align="right"><a href="#top">Up</a></div>
100 <hr /><hr />
101 <a NAME="PluginRepositoryWidget" ID="PluginRepositoryWidget"></a>
102 <h2>PluginRepositoryWidget</h2>
103 <p>
104 Class implementing a dialog showing the available plugins.
105 </p><h4>Signals</h4>
106 <dl>
107 <dt>closeAndInstall</dt>
108 <dd>
109 emitted when the Close & Install button is pressed
110 </dd>
111 </dl>
112 <h3>Derived from</h3>
113 QWidget, Ui_PluginRepositoryDialog
114 <h3>Class Attributes</h3>
115 <table>
116 <tr><td>None</td></tr>
117 </table>
118 <h3>Methods</h3>
119 <table>
120 <tr>
121 <td><a href="#PluginRepositoryWidget.__init__">PluginRepositoryWidget</a></td>
122 <td>Constructor</td>
123 </tr><tr>
124 <td><a href="#PluginRepositoryWidget.__dataReadProgress">__dataReadProgress</a></td>
125 <td>Private slot to show the download progress.</td>
126 </tr><tr>
127 <td><a href="#PluginRepositoryWidget.__downloadCancel">__downloadCancel</a></td>
128 <td>Private slot to cancel the current download.</td>
129 </tr><tr>
130 <td><a href="#PluginRepositoryWidget.__downloadFile">__downloadFile</a></td>
131 <td>Private slot to download the given file.</td>
132 </tr><tr>
133 <td><a href="#PluginRepositoryWidget.__downloadFileDone">__downloadFileDone</a></td>
134 <td>Private method called, after the file has been downloaded from the internet.</td>
135 </tr><tr>
136 <td><a href="#PluginRepositoryWidget.__downloadPlugin">__downloadPlugin</a></td>
137 <td>Private method to download the next plugin.</td>
138 </tr><tr>
139 <td><a href="#PluginRepositoryWidget.__downloadPluginDone">__downloadPluginDone</a></td>
140 <td>Private method called, when the download of a plugin is finished.</td>
141 </tr><tr>
142 <td><a href="#PluginRepositoryWidget.__downloadPlugins">__downloadPlugins</a></td>
143 <td>Private slot to download the selected plugins.</td>
144 </tr><tr>
145 <td><a href="#PluginRepositoryWidget.__downloadPluginsDone">__downloadPluginsDone</a></td>
146 <td>Private method called, when the download of the plugins is finished.</td>
147 </tr><tr>
148 <td><a href="#PluginRepositoryWidget.__downloadRepositoryFileDone">__downloadRepositoryFileDone</a></td>
149 <td>Private method called after the repository file was downloaded.</td>
150 </tr><tr>
151 <td><a href="#PluginRepositoryWidget.__formatDescription">__formatDescription</a></td>
152 <td>Private method to format the description.</td>
153 </tr><tr>
154 <td><a href="#PluginRepositoryWidget.__isUpToDate">__isUpToDate</a></td>
155 <td>Private method to check, if the given archive is up-to-date.</td>
156 </tr><tr>
157 <td><a href="#PluginRepositoryWidget.__populateList">__populateList</a></td>
158 <td>Private method to populate the list of available plugins.</td>
159 </tr><tr>
160 <td><a href="#PluginRepositoryWidget.__proxyAuthenticationRequired">__proxyAuthenticationRequired</a></td>
161 <td>Private slot to handle a proxy authentication request.</td>
162 </tr><tr>
163 <td><a href="#PluginRepositoryWidget.__resortRepositoryList">__resortRepositoryList</a></td>
164 <td>Private method to resort the tree.</td>
165 </tr><tr>
166 <td><a href="#PluginRepositoryWidget.__selectedItems">__selectedItems</a></td>
167 <td>Private method to get all selected items without the toplevel ones.</td>
168 </tr><tr>
169 <td><a href="#PluginRepositoryWidget.__sslErrors">__sslErrors</a></td>
170 <td>Private slot to handle SSL errors.</td>
171 </tr><tr>
172 <td><a href="#PluginRepositoryWidget.__updateList">__updateList</a></td>
173 <td>Private slot to download a new list and display the contents.</td>
174 </tr><tr>
175 <td><a href="#PluginRepositoryWidget.addEntry">addEntry</a></td>
176 <td>Public method to add an entry to the list.</td>
177 </tr><tr>
178 <td><a href="#PluginRepositoryWidget.getDownloadedPlugins">getDownloadedPlugins</a></td>
179 <td>Public method to get the list of recently downloaded plugin files.</td>
180 </tr><tr>
181 <td><a href="#PluginRepositoryWidget.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
182 <td>Private slot to handle the click of a button of the button box.</td>
183 </tr><tr>
184 <td><a href="#PluginRepositoryWidget.on_repositoryList_currentItemChanged">on_repositoryList_currentItemChanged</a></td>
185 <td>Private slot to handle the change of the current item.</td>
186 </tr><tr>
187 <td><a href="#PluginRepositoryWidget.on_repositoryList_itemSelectionChanged">on_repositoryList_itemSelectionChanged</a></td>
188 <td>Private slot to handle a change of the selection.</td>
189 </tr>
190 </table>
191 <a NAME="PluginRepositoryWidget.__init__" ID="PluginRepositoryWidget.__init__"></a>
192 <h4>PluginRepositoryWidget (Constructor)</h4>
193 <b>PluginRepositoryWidget</b>(<i>parent = None</i>)
194 <p>
195 Constructor
196 </p><dl>
197 <dt><i>parent</i></dt>
198 <dd>
199 parent of this dialog (QWidget)
200 </dd>
201 </dl><a NAME="PluginRepositoryWidget.__dataReadProgress" ID="PluginRepositoryWidget.__dataReadProgress"></a>
202 <h4>PluginRepositoryWidget.__dataReadProgress</h4>
203 <b>__dataReadProgress</b>(<i>done, total</i>)
204 <p>
205 Private slot to show the download progress.
206 </p><dl>
207 <dt><i>done</i></dt>
208 <dd>
209 number of bytes downloaded so far (integer)
210 </dd><dt><i>total</i></dt>
211 <dd>
212 total bytes to be downloaded (integer)
213 </dd>
214 </dl><a NAME="PluginRepositoryWidget.__downloadCancel" ID="PluginRepositoryWidget.__downloadCancel"></a>
215 <h4>PluginRepositoryWidget.__downloadCancel</h4>
216 <b>__downloadCancel</b>(<i></i>)
217 <p>
218 Private slot to cancel the current download.
219 </p><a NAME="PluginRepositoryWidget.__downloadFile" ID="PluginRepositoryWidget.__downloadFile"></a>
220 <h4>PluginRepositoryWidget.__downloadFile</h4>
221 <b>__downloadFile</b>(<i>url, filename, doneMethod = None</i>)
222 <p>
223 Private slot to download the given file.
224 </p><dl>
225 <dt><i>url</i></dt>
226 <dd>
227 URL for the download (string)
228 </dd><dt><i>filename</i></dt>
229 <dd>
230 local name of the file (string)
231 </dd><dt><i>doneMethod</i></dt>
232 <dd>
233 method to be called when done
234 </dd>
235 </dl><a NAME="PluginRepositoryWidget.__downloadFileDone" ID="PluginRepositoryWidget.__downloadFileDone"></a>
236 <h4>PluginRepositoryWidget.__downloadFileDone</h4>
237 <b>__downloadFileDone</b>(<i>error</i>)
238 <p>
239 Private method called, after the file has been downloaded
240 from the internet.
241 </p><dl>
242 <dt><i>error</i></dt>
243 <dd>
244 flag indicating an error condition (boolean)
245 </dd>
246 </dl><a NAME="PluginRepositoryWidget.__downloadPlugin" ID="PluginRepositoryWidget.__downloadPlugin"></a>
247 <h4>PluginRepositoryWidget.__downloadPlugin</h4>
248 <b>__downloadPlugin</b>(<i></i>)
249 <p>
250 Private method to download the next plugin.
251 </p><a NAME="PluginRepositoryWidget.__downloadPluginDone" ID="PluginRepositoryWidget.__downloadPluginDone"></a>
252 <h4>PluginRepositoryWidget.__downloadPluginDone</h4>
253 <b>__downloadPluginDone</b>(<i>status, filename</i>)
254 <p>
255 Private method called, when the download of a plugin is finished.
256 </p><dl>
257 <dt><i>status</i></dt>
258 <dd>
259 flaging indicating a successful download (boolean)
260 </dd><dt><i>filename</i></dt>
261 <dd>
262 full path of the downloaded file (string)
263 </dd>
264 </dl><a NAME="PluginRepositoryWidget.__downloadPlugins" ID="PluginRepositoryWidget.__downloadPlugins"></a>
265 <h4>PluginRepositoryWidget.__downloadPlugins</h4>
266 <b>__downloadPlugins</b>(<i></i>)
267 <p>
268 Private slot to download the selected plugins.
269 </p><a NAME="PluginRepositoryWidget.__downloadPluginsDone" ID="PluginRepositoryWidget.__downloadPluginsDone"></a>
270 <h4>PluginRepositoryWidget.__downloadPluginsDone</h4>
271 <b>__downloadPluginsDone</b>(<i></i>)
272 <p>
273 Private method called, when the download of the plugins is finished.
274 </p><a NAME="PluginRepositoryWidget.__downloadRepositoryFileDone" ID="PluginRepositoryWidget.__downloadRepositoryFileDone"></a>
275 <h4>PluginRepositoryWidget.__downloadRepositoryFileDone</h4>
276 <b>__downloadRepositoryFileDone</b>(<i>status, filename</i>)
277 <p>
278 Private method called after the repository file was downloaded.
279 </p><dl>
280 <dt><i>status</i></dt>
281 <dd>
282 flaging indicating a successful download (boolean)
283 </dd><dt><i>filename</i></dt>
284 <dd>
285 full path of the downloaded file (string)
286 </dd>
287 </dl><a NAME="PluginRepositoryWidget.__formatDescription" ID="PluginRepositoryWidget.__formatDescription"></a>
288 <h4>PluginRepositoryWidget.__formatDescription</h4>
289 <b>__formatDescription</b>(<i>lines</i>)
290 <p>
291 Private method to format the description.
292 </p><dl>
293 <dt><i>lines</i></dt>
294 <dd>
295 lines of the description (list of strings)
296 </dd>
297 </dl><dl>
298 <dt>Returns:</dt>
299 <dd>
300 formatted description (string)
301 </dd>
302 </dl><a NAME="PluginRepositoryWidget.__isUpToDate" ID="PluginRepositoryWidget.__isUpToDate"></a>
303 <h4>PluginRepositoryWidget.__isUpToDate</h4>
304 <b>__isUpToDate</b>(<i>filename, version</i>)
305 <p>
306 Private method to check, if the given archive is up-to-date.
307 </p><dl>
308 <dt><i>filename</i></dt>
309 <dd>
310 data for the filename field (string)
311 </dd><dt><i>version</i></dt>
312 <dd>
313 data for the version field (string)
314 </dd>
315 </dl><dl>
316 <dt>Returns:</dt>
317 <dd>
318 flag indicating up-to-date (boolean)
319 </dd>
320 </dl><a NAME="PluginRepositoryWidget.__populateList" ID="PluginRepositoryWidget.__populateList"></a>
321 <h4>PluginRepositoryWidget.__populateList</h4>
322 <b>__populateList</b>(<i></i>)
323 <p>
324 Private method to populate the list of available plugins.
325 </p><a NAME="PluginRepositoryWidget.__proxyAuthenticationRequired" ID="PluginRepositoryWidget.__proxyAuthenticationRequired"></a>
326 <h4>PluginRepositoryWidget.__proxyAuthenticationRequired</h4>
327 <b>__proxyAuthenticationRequired</b>(<i>proxy, auth</i>)
328 <p>
329 Private slot to handle a proxy authentication request.
330 </p><dl>
331 <dt><i>proxy</i></dt>
332 <dd>
333 reference to the proxy object (QNetworkProxy)
334 </dd><dt><i>auth</i></dt>
335 <dd>
336 reference to the authenticator object (QAuthenticator)
337 </dd>
338 </dl><a NAME="PluginRepositoryWidget.__resortRepositoryList" ID="PluginRepositoryWidget.__resortRepositoryList"></a>
339 <h4>PluginRepositoryWidget.__resortRepositoryList</h4>
340 <b>__resortRepositoryList</b>(<i></i>)
341 <p>
342 Private method to resort the tree.
343 </p><a NAME="PluginRepositoryWidget.__selectedItems" ID="PluginRepositoryWidget.__selectedItems"></a>
344 <h4>PluginRepositoryWidget.__selectedItems</h4>
345 <b>__selectedItems</b>(<i></i>)
346 <p>
347 Private method to get all selected items without the toplevel ones.
348 </p><dl>
349 <dt>Returns:</dt>
350 <dd>
351 list of selected items (list)
352 </dd>
353 </dl><a NAME="PluginRepositoryWidget.__sslErrors" ID="PluginRepositoryWidget.__sslErrors"></a>
354 <h4>PluginRepositoryWidget.__sslErrors</h4>
355 <b>__sslErrors</b>(<i>sslErrors</i>)
356 <p>
357 Private slot to handle SSL errors.
358 </p><dl>
359 <dt><i>sslErrors</i></dt>
360 <dd>
361 list of SSL errors (list of QSslError)
362 </dd>
363 </dl><a NAME="PluginRepositoryWidget.__updateList" ID="PluginRepositoryWidget.__updateList"></a>
364 <h4>PluginRepositoryWidget.__updateList</h4>
365 <b>__updateList</b>(<i></i>)
366 <p>
367 Private slot to download a new list and display the contents.
368 </p><a NAME="PluginRepositoryWidget.addEntry" ID="PluginRepositoryWidget.addEntry"></a>
369 <h4>PluginRepositoryWidget.addEntry</h4>
370 <b>addEntry</b>(<i>name, short, description, url, author, version, filename, status</i>)
371 <p>
372 Public method to add an entry to the list.
373 </p><dl>
374 <dt><i>name</i></dt>
375 <dd>
376 data for the name field (string)
377 </dd><dt><i>short</i></dt>
378 <dd>
379 data for the short field (string)
380 </dd><dt><i>description</i></dt>
381 <dd>
382 data for the description field (list of strings)
383 </dd><dt><i>url</i></dt>
384 <dd>
385 data for the url field (string)
386 </dd><dt><i>author</i></dt>
387 <dd>
388 data for the author field (string)
389 </dd><dt><i>version</i></dt>
390 <dd>
391 data for the version field (string)
392 </dd><dt><i>filename</i></dt>
393 <dd>
394 data for the filename field (string)
395 </dd><dt><i>status</i></dt>
396 <dd>
397 status of the plugin (string [stable, unstable, unknown])
398 </dd>
399 </dl><a NAME="PluginRepositoryWidget.getDownloadedPlugins" ID="PluginRepositoryWidget.getDownloadedPlugins"></a>
400 <h4>PluginRepositoryWidget.getDownloadedPlugins</h4>
401 <b>getDownloadedPlugins</b>(<i></i>)
402 <p>
403 Public method to get the list of recently downloaded plugin files.
404 </p><dl>
405 <dt>Returns:</dt>
406 <dd>
407 list of plugin filenames (list of strings)
408 </dd>
409 </dl><a NAME="PluginRepositoryWidget.on_buttonBox_clicked" ID="PluginRepositoryWidget.on_buttonBox_clicked"></a>
410 <h4>PluginRepositoryWidget.on_buttonBox_clicked</h4>
411 <b>on_buttonBox_clicked</b>(<i>button</i>)
412 <p>
413 Private slot to handle the click of a button of the button box.
414 </p><a NAME="PluginRepositoryWidget.on_repositoryList_currentItemChanged" ID="PluginRepositoryWidget.on_repositoryList_currentItemChanged"></a>
415 <h4>PluginRepositoryWidget.on_repositoryList_currentItemChanged</h4>
416 <b>on_repositoryList_currentItemChanged</b>(<i>current, previous</i>)
417 <p>
418 Private slot to handle the change of the current item.
419 </p><dl>
420 <dt><i>current</i></dt>
421 <dd>
422 reference to the new current item (QTreeWidgetItem)
423 </dd><dt><i>previous</i></dt>
424 <dd>
425 reference to the old current item (QTreeWidgetItem)
426 </dd>
427 </dl><a NAME="PluginRepositoryWidget.on_repositoryList_itemSelectionChanged" ID="PluginRepositoryWidget.on_repositoryList_itemSelectionChanged"></a>
428 <h4>PluginRepositoryWidget.on_repositoryList_itemSelectionChanged</h4>
429 <b>on_repositoryList_itemSelectionChanged</b>(<i></i>)
430 <p>
431 Private slot to handle a change of the selection.
432 </p>
433 <div align="right"><a href="#top">Up</a></div>
434 <hr /><hr />
435 <a NAME="PluginRepositoryWindow" ID="PluginRepositoryWindow"></a>
436 <h2>PluginRepositoryWindow</h2>
437 <p>
438 Main window class for the standalone dialog.
439 </p>
440 <h3>Derived from</h3>
441 QMainWindow
442 <h3>Class Attributes</h3>
443 <table>
444 <tr><td>None</td></tr>
445 </table>
446 <h3>Methods</h3>
447 <table>
448 <tr>
449 <td><a href="#PluginRepositoryWindow.__init__">PluginRepositoryWindow</a></td>
450 <td>Constructor</td>
451 </tr><tr>
452 <td><a href="#PluginRepositoryWindow.__startPluginInstall">__startPluginInstall</a></td>
453 <td>Private slot to start the eric4 plugin installation dialog.</td>
454 </tr>
455 </table>
456 <a NAME="PluginRepositoryWindow.__init__" ID="PluginRepositoryWindow.__init__"></a>
457 <h4>PluginRepositoryWindow (Constructor)</h4>
458 <b>PluginRepositoryWindow</b>(<i>parent = None</i>)
459 <p>
460 Constructor
461 </p><dl>
462 <dt><i>parent</i></dt>
463 <dd>
464 reference to the parent widget (QWidget)
465 </dd>
466 </dl><a NAME="PluginRepositoryWindow.__startPluginInstall" ID="PluginRepositoryWindow.__startPluginInstall"></a>
467 <h4>PluginRepositoryWindow.__startPluginInstall</h4>
468 <b>__startPluginInstall</b>(<i></i>)
469 <p>
470 Private slot to start the eric4 plugin installation dialog.
471 </p>
472 <div align="right"><a href="#top">Up</a></div>
473 <hr />
474 </body></html>

Mercurial Repository: eric

eric ide

mercurial