Documentation/Source/eric5.PluginManager.PluginRepositoryDialog.html

changeset 3200
83bde5e6f146
parent 3018
70924c0bdaf1
equal deleted inserted replaced
3197:4103c8013c36 3200:83bde5e6f146
23 <p> 23 <p>
24 Module implementing a dialog showing the available plugins. 24 Module implementing a dialog showing the available plugins.
25 </p> 25 </p>
26 <h3>Global Attributes</h3> 26 <h3>Global Attributes</h3>
27 <table> 27 <table>
28 <tr><td>authorRole</td></tr><tr><td>descrRole</td></tr><tr><td>filenameRole</td></tr><tr><td>urlRole</td></tr> 28 <tr><td>None</td></tr>
29 </table> 29 </table>
30 <h3>Classes</h3> 30 <h3>Classes</h3>
31 <table> 31 <table>
32 <tr> 32 <tr>
33 <td><a href="#PluginRepositoryDialog">PluginRepositoryDialog</a></td> 33 <td><a href="#PluginRepositoryDialog">PluginRepositoryDialog</a></td>
119 </dl> 119 </dl>
120 <h3>Derived from</h3> 120 <h3>Derived from</h3>
121 QWidget, Ui_PluginRepositoryDialog 121 QWidget, Ui_PluginRepositoryDialog
122 <h3>Class Attributes</h3> 122 <h3>Class Attributes</h3>
123 <table> 123 <table>
124 <tr><td>None</td></tr> 124 <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>
125 </table> 125 </table>
126 <h3>Class Methods</h3> 126 <h3>Class Methods</h3>
127 <table> 127 <table>
128 <tr><td>None</td></tr> 128 <tr><td>None</td></tr>
129 </table> 129 </table>
131 <table> 131 <table>
132 <tr> 132 <tr>
133 <td><a href="#PluginRepositoryWidget.__init__">PluginRepositoryWidget</a></td> 133 <td><a href="#PluginRepositoryWidget.__init__">PluginRepositoryWidget</a></td>
134 <td>Constructor</td> 134 <td>Constructor</td>
135 </tr><tr> 135 </tr><tr>
136 <td><a href="#PluginRepositoryWidget.__cleanupDownloads">__cleanupDownloads</a></td>
137 <td>Private slot to cleanup the plug-in downloads area.</td>
138 </tr><tr>
139 <td><a href="#PluginRepositoryWidget.__closeAndInstall">__closeAndInstall</a></td>
140 <td>Private method to close the dialog and invoke the install dialog.</td>
141 </tr><tr>
136 <td><a href="#PluginRepositoryWidget.__downloadCancel">__downloadCancel</a></td> 142 <td><a href="#PluginRepositoryWidget.__downloadCancel">__downloadCancel</a></td>
137 <td>Private slot to cancel the current download.</td> 143 <td>Private slot to cancel the current download.</td>
138 </tr><tr> 144 </tr><tr>
139 <td><a href="#PluginRepositoryWidget.__downloadFile">__downloadFile</a></td> 145 <td><a href="#PluginRepositoryWidget.__downloadFile">__downloadFile</a></td>
140 <td>Private slot to download the given file.</td> 146 <td>Private slot to download the given file.</td>
161 <td>Private method called after the repository file was downloaded.</td> 167 <td>Private method called after the repository file was downloaded.</td>
162 </tr><tr> 168 </tr><tr>
163 <td><a href="#PluginRepositoryWidget.__formatDescription">__formatDescription</a></td> 169 <td><a href="#PluginRepositoryWidget.__formatDescription">__formatDescription</a></td>
164 <td>Private method to format the description.</td> 170 <td>Private method to format the description.</td>
165 </tr><tr> 171 </tr><tr>
166 <td><a href="#PluginRepositoryWidget.__isUpToDate">__isUpToDate</a></td> 172 <td><a href="#PluginRepositoryWidget.__hasHiddenPlugins">__hasHiddenPlugins</a></td>
167 <td>Private method to check, if the given archive is up-to-date.</td> 173 <td>Private method to check, if there are any hidden plug-ins.</td>
174 </tr><tr>
175 <td><a href="#PluginRepositoryWidget.__hidePlugin">__hidePlugin</a></td>
176 <td>Private slot to hide the current plug-in.</td>
177 </tr><tr>
178 <td><a href="#PluginRepositoryWidget.__hideSelectedPlugins">__hideSelectedPlugins</a></td>
179 <td>Private slot to hide all selected plug-ins.</td>
168 </tr><tr> 180 </tr><tr>
169 <td><a href="#PluginRepositoryWidget.__populateList">__populateList</a></td> 181 <td><a href="#PluginRepositoryWidget.__populateList">__populateList</a></td>
170 <td>Private method to populate the list of available plugins.</td> 182 <td>Private method to populate the list of available plugins.</td>
171 </tr><tr> 183 </tr><tr>
172 <td><a href="#PluginRepositoryWidget.__resortRepositoryList">__resortRepositoryList</a></td> 184 <td><a href="#PluginRepositoryWidget.__resortRepositoryList">__resortRepositoryList</a></td>
173 <td>Private method to resort the tree.</td> 185 <td>Private method to resort the tree.</td>
174 </tr><tr> 186 </tr><tr>
175 <td><a href="#PluginRepositoryWidget.__selectedItems">__selectedItems</a></td> 187 <td><a href="#PluginRepositoryWidget.__selectedItems">__selectedItems</a></td>
176 <td>Private method to get all selected items without the toplevel ones.</td> 188 <td>Private method to get all selected items without the toplevel ones.</td>
177 </tr><tr> 189 </tr><tr>
190 <td><a href="#PluginRepositoryWidget.__showAllPlugins">__showAllPlugins</a></td>
191 <td>Private slot to show all plug-ins.</td>
192 </tr><tr>
178 <td><a href="#PluginRepositoryWidget.__sslErrors">__sslErrors</a></td> 193 <td><a href="#PluginRepositoryWidget.__sslErrors">__sslErrors</a></td>
179 <td>Private slot to handle SSL errors.</td> 194 <td>Private slot to handle SSL errors.</td>
180 </tr><tr> 195 </tr><tr>
196 <td><a href="#PluginRepositoryWidget.__updateHiddenPluginsList">__updateHiddenPluginsList</a></td>
197 <td>Private method to store the list of hidden plug-ins to the settings.</td>
198 </tr><tr>
181 <td><a href="#PluginRepositoryWidget.__updateList">__updateList</a></td> 199 <td><a href="#PluginRepositoryWidget.__updateList">__updateList</a></td>
182 <td>Private slot to download a new list and display the contents.</td> 200 <td>Private slot to download a new list and display the contents.</td>
183 </tr><tr> 201 </tr><tr>
202 <td><a href="#PluginRepositoryWidget.__updateStatus">__updateStatus</a></td>
203 <td>Private method to check, if the given archive update status.</td>
204 </tr><tr>
184 <td><a href="#PluginRepositoryWidget.addEntry">addEntry</a></td> 205 <td><a href="#PluginRepositoryWidget.addEntry">addEntry</a></td>
185 <td>Public method to add an entry to the list.</td> 206 <td>Public method to add an entry to the list.</td>
186 </tr><tr> 207 </tr><tr>
187 <td><a href="#PluginRepositoryWidget.getDownloadedPlugins">getDownloadedPlugins</a></td> 208 <td><a href="#PluginRepositoryWidget.getDownloadedPlugins">getDownloadedPlugins</a></td>
188 <td>Public method to get the list of recently downloaded plugin files.</td> 209 <td>Public method to get the list of recently downloaded plugin files.</td>
190 <td><a href="#PluginRepositoryWidget.on_buttonBox_clicked">on_buttonBox_clicked</a></td> 211 <td><a href="#PluginRepositoryWidget.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
191 <td>Private slot to handle the click of a button of the button box.</td> 212 <td>Private slot to handle the click of a button of the button box.</td>
192 </tr><tr> 213 </tr><tr>
193 <td><a href="#PluginRepositoryWidget.on_repositoryList_currentItemChanged">on_repositoryList_currentItemChanged</a></td> 214 <td><a href="#PluginRepositoryWidget.on_repositoryList_currentItemChanged">on_repositoryList_currentItemChanged</a></td>
194 <td>Private slot to handle the change of the current item.</td> 215 <td>Private slot to handle the change of the current item.</td>
216 </tr><tr>
217 <td><a href="#PluginRepositoryWidget.on_repositoryList_customContextMenuRequested">on_repositoryList_customContextMenuRequested</a></td>
218 <td>Private slot to show the context menu.</td>
195 </tr><tr> 219 </tr><tr>
196 <td><a href="#PluginRepositoryWidget.on_repositoryList_itemSelectionChanged">on_repositoryList_itemSelectionChanged</a></td> 220 <td><a href="#PluginRepositoryWidget.on_repositoryList_itemSelectionChanged">on_repositoryList_itemSelectionChanged</a></td>
197 <td>Private slot to handle a change of the selection.</td> 221 <td>Private slot to handle a change of the selection.</td>
198 </tr><tr> 222 </tr><tr>
199 <td><a href="#PluginRepositoryWidget.on_repositoryUrlEditButton_toggled">on_repositoryUrlEditButton_toggled</a></td> 223 <td><a href="#PluginRepositoryWidget.on_repositoryUrlEditButton_toggled">on_repositoryUrlEditButton_toggled</a></td>
216 </dd><dt><i>external</i></dt> 240 </dd><dt><i>external</i></dt>
217 <dd> 241 <dd>
218 flag indicating an instatiation as a main 242 flag indicating an instatiation as a main
219 window (boolean) 243 window (boolean)
220 </dd> 244 </dd>
221 </dl><a NAME="PluginRepositoryWidget.__downloadCancel" ID="PluginRepositoryWidget.__downloadCancel"></a> 245 </dl><a NAME="PluginRepositoryWidget.__cleanupDownloads" ID="PluginRepositoryWidget.__cleanupDownloads"></a>
246 <h4>PluginRepositoryWidget.__cleanupDownloads</h4>
247 <b>__cleanupDownloads</b>(<i></i>)
248 <p>
249 Private slot to cleanup the plug-in downloads area.
250 </p><a NAME="PluginRepositoryWidget.__closeAndInstall" ID="PluginRepositoryWidget.__closeAndInstall"></a>
251 <h4>PluginRepositoryWidget.__closeAndInstall</h4>
252 <b>__closeAndInstall</b>(<i></i>)
253 <p>
254 Private method to close the dialog and invoke the install dialog.
255 </p><a NAME="PluginRepositoryWidget.__downloadCancel" ID="PluginRepositoryWidget.__downloadCancel"></a>
222 <h4>PluginRepositoryWidget.__downloadCancel</h4> 256 <h4>PluginRepositoryWidget.__downloadCancel</h4>
223 <b>__downloadCancel</b>(<i></i>) 257 <b>__downloadCancel</b>(<i></i>)
224 <p> 258 <p>
225 Private slot to cancel the current download. 259 Private slot to cancel the current download.
226 </p><a NAME="PluginRepositoryWidget.__downloadFile" ID="PluginRepositoryWidget.__downloadFile"></a> 260 </p><a NAME="PluginRepositoryWidget.__downloadFile" ID="PluginRepositoryWidget.__downloadFile"></a>
312 </dl><dl> 346 </dl><dl>
313 <dt>Returns:</dt> 347 <dt>Returns:</dt>
314 <dd> 348 <dd>
315 formatted description (string) 349 formatted description (string)
316 </dd> 350 </dd>
317 </dl><a NAME="PluginRepositoryWidget.__isUpToDate" ID="PluginRepositoryWidget.__isUpToDate"></a> 351 </dl><a NAME="PluginRepositoryWidget.__hasHiddenPlugins" ID="PluginRepositoryWidget.__hasHiddenPlugins"></a>
318 <h4>PluginRepositoryWidget.__isUpToDate</h4> 352 <h4>PluginRepositoryWidget.__hasHiddenPlugins</h4>
319 <b>__isUpToDate</b>(<i>filename, version</i>) 353 <b>__hasHiddenPlugins</b>(<i></i>)
320 <p> 354 <p>
321 Private method to check, if the given archive is up-to-date. 355 Private method to check, if there are any hidden plug-ins.
322 </p><dl> 356 </p><dl>
323 <dt><i>filename</i></dt>
324 <dd>
325 data for the filename field (string)
326 </dd><dt><i>version</i></dt>
327 <dd>
328 data for the version field (string)
329 </dd>
330 </dl><dl>
331 <dt>Returns:</dt> 357 <dt>Returns:</dt>
332 <dd> 358 <dd>
333 flag indicating up-to-date (boolean) 359 flag indicating the presence of hidden plug-ins (boolean)
334 </dd> 360 </dd>
335 </dl><a NAME="PluginRepositoryWidget.__populateList" ID="PluginRepositoryWidget.__populateList"></a> 361 </dl><a NAME="PluginRepositoryWidget.__hidePlugin" ID="PluginRepositoryWidget.__hidePlugin"></a>
362 <h4>PluginRepositoryWidget.__hidePlugin</h4>
363 <b>__hidePlugin</b>(<i></i>)
364 <p>
365 Private slot to hide the current plug-in.
366 </p><a NAME="PluginRepositoryWidget.__hideSelectedPlugins" ID="PluginRepositoryWidget.__hideSelectedPlugins"></a>
367 <h4>PluginRepositoryWidget.__hideSelectedPlugins</h4>
368 <b>__hideSelectedPlugins</b>(<i></i>)
369 <p>
370 Private slot to hide all selected plug-ins.
371 </p><a NAME="PluginRepositoryWidget.__populateList" ID="PluginRepositoryWidget.__populateList"></a>
336 <h4>PluginRepositoryWidget.__populateList</h4> 372 <h4>PluginRepositoryWidget.__populateList</h4>
337 <b>__populateList</b>(<i></i>) 373 <b>__populateList</b>(<i></i>)
338 <p> 374 <p>
339 Private method to populate the list of available plugins. 375 Private method to populate the list of available plugins.
340 </p><a NAME="PluginRepositoryWidget.__resortRepositoryList" ID="PluginRepositoryWidget.__resortRepositoryList"></a> 376 </p><a NAME="PluginRepositoryWidget.__resortRepositoryList" ID="PluginRepositoryWidget.__resortRepositoryList"></a>
350 </p><dl> 386 </p><dl>
351 <dt>Returns:</dt> 387 <dt>Returns:</dt>
352 <dd> 388 <dd>
353 list of selected items (list) 389 list of selected items (list)
354 </dd> 390 </dd>
355 </dl><a NAME="PluginRepositoryWidget.__sslErrors" ID="PluginRepositoryWidget.__sslErrors"></a> 391 </dl><a NAME="PluginRepositoryWidget.__showAllPlugins" ID="PluginRepositoryWidget.__showAllPlugins"></a>
392 <h4>PluginRepositoryWidget.__showAllPlugins</h4>
393 <b>__showAllPlugins</b>(<i></i>)
394 <p>
395 Private slot to show all plug-ins.
396 </p><a NAME="PluginRepositoryWidget.__sslErrors" ID="PluginRepositoryWidget.__sslErrors"></a>
356 <h4>PluginRepositoryWidget.__sslErrors</h4> 397 <h4>PluginRepositoryWidget.__sslErrors</h4>
357 <b>__sslErrors</b>(<i>reply, errors</i>) 398 <b>__sslErrors</b>(<i>reply, errors</i>)
358 <p> 399 <p>
359 Private slot to handle SSL errors. 400 Private slot to handle SSL errors.
360 </p><dl> 401 </p><dl>
362 <dd> 403 <dd>
363 reference to the reply object (QNetworkReply) 404 reference to the reply object (QNetworkReply)
364 </dd><dt><i>errors</i></dt> 405 </dd><dt><i>errors</i></dt>
365 <dd> 406 <dd>
366 list of SSL errors (list of QSslError) 407 list of SSL errors (list of QSslError)
408 </dd>
409 </dl><a NAME="PluginRepositoryWidget.__updateHiddenPluginsList" ID="PluginRepositoryWidget.__updateHiddenPluginsList"></a>
410 <h4>PluginRepositoryWidget.__updateHiddenPluginsList</h4>
411 <b>__updateHiddenPluginsList</b>(<i>hideList</i>)
412 <p>
413 Private method to store the list of hidden plug-ins to the settings.
414 </p><dl>
415 <dt><i>hideList</i></dt>
416 <dd>
417 list of plug-ins to add to the list of hidden ones
418 (list of string)
367 </dd> 419 </dd>
368 </dl><a NAME="PluginRepositoryWidget.__updateList" ID="PluginRepositoryWidget.__updateList"></a> 420 </dl><a NAME="PluginRepositoryWidget.__updateList" ID="PluginRepositoryWidget.__updateList"></a>
369 <h4>PluginRepositoryWidget.__updateList</h4> 421 <h4>PluginRepositoryWidget.__updateList</h4>
370 <b>__updateList</b>(<i></i>) 422 <b>__updateList</b>(<i></i>)
371 <p> 423 <p>
372 Private slot to download a new list and display the contents. 424 Private slot to download a new list and display the contents.
373 </p><a NAME="PluginRepositoryWidget.addEntry" ID="PluginRepositoryWidget.addEntry"></a> 425 </p><a NAME="PluginRepositoryWidget.__updateStatus" ID="PluginRepositoryWidget.__updateStatus"></a>
426 <h4>PluginRepositoryWidget.__updateStatus</h4>
427 <b>__updateStatus</b>(<i>filename, version</i>)
428 <p>
429 Private method to check, if the given archive update status.
430 </p><dl>
431 <dt><i>filename</i></dt>
432 <dd>
433 data for the filename field (string)
434 </dd><dt><i>version</i></dt>
435 <dd>
436 data for the version field (string)
437 </dd>
438 </dl><dl>
439 <dt>Returns:</dt>
440 <dd>
441 plug-in update status (integer, one of PluginStatusNew,
442 PluginStatusUpToDate, PluginStatusLocalUpdate,
443 PluginStatusRemoteUpdate)
444 </dd>
445 </dl><a NAME="PluginRepositoryWidget.addEntry" ID="PluginRepositoryWidget.addEntry"></a>
374 <h4>PluginRepositoryWidget.addEntry</h4> 446 <h4>PluginRepositoryWidget.addEntry</h4>
375 <b>addEntry</b>(<i>name, short, description, url, author, version, filename, status</i>) 447 <b>addEntry</b>(<i>name, short, description, url, author, version, filename, status</i>)
376 <p> 448 <p>
377 Public method to add an entry to the list. 449 Public method to add an entry to the list.
378 </p><dl> 450 </p><dl>
431 <dd> 503 <dd>
432 reference to the new current item (QTreeWidgetItem) 504 reference to the new current item (QTreeWidgetItem)
433 </dd><dt><i>previous</i></dt> 505 </dd><dt><i>previous</i></dt>
434 <dd> 506 <dd>
435 reference to the old current item (QTreeWidgetItem) 507 reference to the old current item (QTreeWidgetItem)
508 </dd>
509 </dl><a NAME="PluginRepositoryWidget.on_repositoryList_customContextMenuRequested" ID="PluginRepositoryWidget.on_repositoryList_customContextMenuRequested"></a>
510 <h4>PluginRepositoryWidget.on_repositoryList_customContextMenuRequested</h4>
511 <b>on_repositoryList_customContextMenuRequested</b>(<i>pos</i>)
512 <p>
513 Private slot to show the context menu.
514 </p><dl>
515 <dt><i>pos</i></dt>
516 <dd>
517 position to show the menu (QPoint)
436 </dd> 518 </dd>
437 </dl><a NAME="PluginRepositoryWidget.on_repositoryList_itemSelectionChanged" ID="PluginRepositoryWidget.on_repositoryList_itemSelectionChanged"></a> 519 </dl><a NAME="PluginRepositoryWidget.on_repositoryList_itemSelectionChanged" ID="PluginRepositoryWidget.on_repositoryList_itemSelectionChanged"></a>
438 <h4>PluginRepositoryWidget.on_repositoryList_itemSelectionChanged</h4> 520 <h4>PluginRepositoryWidget.on_repositoryList_itemSelectionChanged</h4>
439 <b>on_repositoryList_itemSelectionChanged</b>(<i></i>) 521 <b>on_repositoryList_itemSelectionChanged</b>(<i></i>)
440 <p> 522 <p>

eric ide

mercurial