Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.PluginManager.PluginInstallDialog.html

src/eric7/Documentation/Source/eric7.PluginManager.PluginInstallDialog.html

branch
eric7
changeset 10479
856476537696
parent 10428
a071d4065202
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.PluginManager.PluginInstallDialog</h1> 9 <h1>eric7.PluginManager.PluginInstallDialog</h1>
10
11 <p> 10 <p>
12 Module implementing the Plugin installation dialog. 11 Module implementing the Plugin installation dialog.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#PluginInstallDialog">PluginInstallDialog</a></td> 22 <td><a href="#PluginInstallDialog">PluginInstallDialog</a></td>
25 <td>Class for the dialog variant.</td> 23 <td>Class for the dialog variant.</td>
26 </tr> 24 </tr>
27 <tr> 25 <tr>
31 <tr> 29 <tr>
32 <td><a href="#PluginInstallWindow">PluginInstallWindow</a></td> 30 <td><a href="#PluginInstallWindow">PluginInstallWindow</a></td>
33 <td>Main window class for the standalone dialog.</td> 31 <td>Main window class for the standalone dialog.</td>
34 </tr> 32 </tr>
35 </table> 33 </table>
34
36 <h3>Functions</h3> 35 <h3>Functions</h3>
37 36 <table>
38 <table> 37 <tr><td>None</td></tr>
39 <tr><td>None</td></tr> 38 </table>
40 </table> 39
41 <hr /> 40 <hr />
42 <hr /> 41 <hr />
43 <a NAME="PluginInstallDialog" ID="PluginInstallDialog"></a> 42 <a NAME="PluginInstallDialog" ID="PluginInstallDialog"></a>
44 <h2>PluginInstallDialog</h2> 43 <h2>PluginInstallDialog</h2>
45
46 <p> 44 <p>
47 Class for the dialog variant. 45 Class for the dialog variant.
48 </p> 46 </p>
47
49 <h3>Derived from</h3> 48 <h3>Derived from</h3>
50 QDialog 49 QDialog
51 <h3>Class Attributes</h3> 50 <h3>Class Attributes</h3>
52 51 <table>
53 <table> 52 <tr><td>None</td></tr>
54 <tr><td>None</td></tr> 53 </table>
55 </table> 54
56 <h3>Class Methods</h3> 55 <h3>Class Methods</h3>
57 56 <table>
58 <table> 57 <tr><td>None</td></tr>
59 <tr><td>None</td></tr> 58 </table>
60 </table> 59
61 <h3>Methods</h3> 60 <h3>Methods</h3>
62 61 <table>
63 <table>
64
65 <tr> 62 <tr>
66 <td><a href="#PluginInstallDialog.__init__">PluginInstallDialog</a></td> 63 <td><a href="#PluginInstallDialog.__init__">PluginInstallDialog</a></td>
67 <td>Constructor</td> 64 <td>Constructor</td>
68 </tr> 65 </tr>
69 <tr> 66 <tr>
70 <td><a href="#PluginInstallDialog.restartNeeded">restartNeeded</a></td> 67 <td><a href="#PluginInstallDialog.restartNeeded">restartNeeded</a></td>
71 <td>Public method to check, if a restart of the IDE is required.</td> 68 <td>Public method to check, if a restart of the IDE is required.</td>
72 </tr> 69 </tr>
73 </table> 70 </table>
71
74 <h3>Static Methods</h3> 72 <h3>Static Methods</h3>
75 73 <table>
76 <table> 74 <tr><td>None</td></tr>
77 <tr><td>None</td></tr> 75 </table>
78 </table> 76
79 77
80 <a NAME="PluginInstallDialog.__init__" ID="PluginInstallDialog.__init__"></a> 78 <a NAME="PluginInstallDialog.__init__" ID="PluginInstallDialog.__init__"></a>
81 <h4>PluginInstallDialog (Constructor)</h4> 79 <h4>PluginInstallDialog (Constructor)</h4>
82 <b>PluginInstallDialog</b>(<i>pluginManager, pluginFileNames, parent=None</i>) 80 <b>PluginInstallDialog</b>(<i>pluginManager, pluginFileNames, parent=None</i>)
83
84 <p> 81 <p>
85 Constructor 82 Constructor
86 </p> 83 </p>
84
87 <dl> 85 <dl>
88 86
89 <dt><i>pluginManager</i> (PluginManager)</dt> 87 <dt><i>pluginManager</i> (PluginManager)</dt>
90 <dd> 88 <dd>
91 reference to the plugin manager object 89 reference to the plugin manager object
100 </dd> 98 </dd>
101 </dl> 99 </dl>
102 <a NAME="PluginInstallDialog.restartNeeded" ID="PluginInstallDialog.restartNeeded"></a> 100 <a NAME="PluginInstallDialog.restartNeeded" ID="PluginInstallDialog.restartNeeded"></a>
103 <h4>PluginInstallDialog.restartNeeded</h4> 101 <h4>PluginInstallDialog.restartNeeded</h4>
104 <b>restartNeeded</b>(<i></i>) 102 <b>restartNeeded</b>(<i></i>)
105
106 <p> 103 <p>
107 Public method to check, if a restart of the IDE is required. 104 Public method to check, if a restart of the IDE is required.
108 </p> 105 </p>
106
109 <dl> 107 <dl>
110 <dt>Return:</dt> 108 <dt>Return:</dt>
111 <dd> 109 <dd>
112 flag indicating a restart is required 110 flag indicating a restart is required
113 </dd> 111 </dd>
121 <div align="right"><a href="#top">Up</a></div> 119 <div align="right"><a href="#top">Up</a></div>
122 <hr /> 120 <hr />
123 <hr /> 121 <hr />
124 <a NAME="PluginInstallWidget" ID="PluginInstallWidget"></a> 122 <a NAME="PluginInstallWidget" ID="PluginInstallWidget"></a>
125 <h2>PluginInstallWidget</h2> 123 <h2>PluginInstallWidget</h2>
126
127 <p> 124 <p>
128 Class implementing the Plugin installation dialog. 125 Class implementing the Plugin installation dialog.
129 </p> 126 </p>
127
130 <h3>Derived from</h3> 128 <h3>Derived from</h3>
131 QWidget, Ui_PluginInstallDialog 129 QWidget, Ui_PluginInstallDialog
132 <h3>Class Attributes</h3> 130 <h3>Class Attributes</h3>
133 131 <table>
134 <table> 132 <tr><td>None</td></tr>
135 <tr><td>None</td></tr> 133 </table>
136 </table> 134
137 <h3>Class Methods</h3> 135 <h3>Class Methods</h3>
138 136 <table>
139 <table> 137 <tr><td>None</td></tr>
140 <tr><td>None</td></tr> 138 </table>
141 </table> 139
142 <h3>Methods</h3> 140 <h3>Methods</h3>
143 141 <table>
144 <table>
145
146 <tr> 142 <tr>
147 <td><a href="#PluginInstallWidget.__init__">PluginInstallWidget</a></td> 143 <td><a href="#PluginInstallWidget.__init__">PluginInstallWidget</a></td>
148 <td>Constructor</td> 144 <td>Constructor</td>
149 </tr> 145 </tr>
150 <tr> 146 <tr>
194 <tr> 190 <tr>
195 <td><a href="#PluginInstallWidget.restartNeeded">restartNeeded</a></td> 191 <td><a href="#PluginInstallWidget.restartNeeded">restartNeeded</a></td>
196 <td>Public method to check, if a restart of the IDE is required.</td> 192 <td>Public method to check, if a restart of the IDE is required.</td>
197 </tr> 193 </tr>
198 </table> 194 </table>
195
199 <h3>Static Methods</h3> 196 <h3>Static Methods</h3>
200 197 <table>
201 <table> 198 <tr><td>None</td></tr>
202 <tr><td>None</td></tr> 199 </table>
203 </table> 200
204 201
205 <a NAME="PluginInstallWidget.__init__" ID="PluginInstallWidget.__init__"></a> 202 <a NAME="PluginInstallWidget.__init__" ID="PluginInstallWidget.__init__"></a>
206 <h4>PluginInstallWidget (Constructor)</h4> 203 <h4>PluginInstallWidget (Constructor)</h4>
207 <b>PluginInstallWidget</b>(<i>pluginManager, pluginFileNames, parent=None</i>) 204 <b>PluginInstallWidget</b>(<i>pluginManager, pluginFileNames, parent=None</i>)
208
209 <p> 205 <p>
210 Constructor 206 Constructor
211 </p> 207 </p>
208
212 <dl> 209 <dl>
213 210
214 <dt><i>pluginManager</i> (PluginManager)</dt> 211 <dt><i>pluginManager</i> (PluginManager)</dt>
215 <dd> 212 <dd>
216 reference to the plugin manager object 213 reference to the plugin manager object
226 </dd> 223 </dd>
227 </dl> 224 </dl>
228 <a NAME="PluginInstallWidget.__createArchivesList" ID="PluginInstallWidget.__createArchivesList"></a> 225 <a NAME="PluginInstallWidget.__createArchivesList" ID="PluginInstallWidget.__createArchivesList"></a>
229 <h4>PluginInstallWidget.__createArchivesList</h4> 226 <h4>PluginInstallWidget.__createArchivesList</h4>
230 <b>__createArchivesList</b>(<i></i>) 227 <b>__createArchivesList</b>(<i></i>)
231
232 <p> 228 <p>
233 Private method to create a list of plugin archive names. 229 Private method to create a list of plugin archive names.
234 </p> 230 </p>
231
235 <dl> 232 <dl>
236 <dt>Return:</dt> 233 <dt>Return:</dt>
237 <dd> 234 <dd>
238 list of plugin archive names 235 list of plugin archive names
239 </dd> 236 </dd>
245 </dd> 242 </dd>
246 </dl> 243 </dl>
247 <a NAME="PluginInstallWidget.__installPlugin" ID="PluginInstallWidget.__installPlugin"></a> 244 <a NAME="PluginInstallWidget.__installPlugin" ID="PluginInstallWidget.__installPlugin"></a>
248 <h4>PluginInstallWidget.__installPlugin</h4> 245 <h4>PluginInstallWidget.__installPlugin</h4>
249 <b>__installPlugin</b>(<i>archiveFilename</i>) 246 <b>__installPlugin</b>(<i>archiveFilename</i>)
250
251 <p> 247 <p>
252 Private slot to install the selected plugin. 248 Private slot to install the selected plugin.
253 </p> 249 </p>
250
254 <dl> 251 <dl>
255 252
256 <dt><i>archiveFilename</i> (str)</dt> 253 <dt><i>archiveFilename</i> (str)</dt>
257 <dd> 254 <dd>
258 name of the plugin archive 255 name of the plugin archive
274 </dd> 271 </dd>
275 </dl> 272 </dl>
276 <a NAME="PluginInstallWidget.__installPlugins" ID="PluginInstallWidget.__installPlugins"></a> 273 <a NAME="PluginInstallWidget.__installPlugins" ID="PluginInstallWidget.__installPlugins"></a>
277 <h4>PluginInstallWidget.__installPlugins</h4> 274 <h4>PluginInstallWidget.__installPlugins</h4>
278 <b>__installPlugins</b>(<i></i>) 275 <b>__installPlugins</b>(<i></i>)
279
280 <p> 276 <p>
281 Private method to install the selected plugin archives. 277 Private method to install the selected plugin archives.
282 </p> 278 </p>
279
283 <dl> 280 <dl>
284 <dt>Return:</dt> 281 <dt>Return:</dt>
285 <dd> 282 <dd>
286 flag indicating success 283 flag indicating success
287 </dd> 284 </dd>
293 </dd> 290 </dd>
294 </dl> 291 </dl>
295 <a NAME="PluginInstallWidget.__makedirs" ID="PluginInstallWidget.__makedirs"></a> 292 <a NAME="PluginInstallWidget.__makedirs" ID="PluginInstallWidget.__makedirs"></a>
296 <h4>PluginInstallWidget.__makedirs</h4> 293 <h4>PluginInstallWidget.__makedirs</h4>
297 <b>__makedirs</b>(<i>name, mode=0o777</i>) 294 <b>__makedirs</b>(<i>name, mode=0o777</i>)
298
299 <p> 295 <p>
300 Private method to create a directory and all intermediate ones. 296 Private method to create a directory and all intermediate ones.
301 </p> 297 </p>
302 <p> 298 <p>
303 This is an extended version of the Python one in order to 299 This is an extended version of the Python one in order to
304 record the created directories. 300 record the created directories.
305 </p> 301 </p>
302
306 <dl> 303 <dl>
307 304
308 <dt><i>name</i> (str)</dt> 305 <dt><i>name</i> (str)</dt>
309 <dd> 306 <dd>
310 name of the directory to create 307 name of the directory to create
315 </dd> 312 </dd>
316 </dl> 313 </dl>
317 <a NAME="PluginInstallWidget.__rollback" ID="PluginInstallWidget.__rollback"></a> 314 <a NAME="PluginInstallWidget.__rollback" ID="PluginInstallWidget.__rollback"></a>
318 <h4>PluginInstallWidget.__rollback</h4> 315 <h4>PluginInstallWidget.__rollback</h4>
319 <b>__rollback</b>(<i></i>) 316 <b>__rollback</b>(<i></i>)
320
321 <p> 317 <p>
322 Private method to rollback a failed installation. 318 Private method to rollback a failed installation.
323 </p> 319 </p>
320
324 <a NAME="PluginInstallWidget.__selectPage" ID="PluginInstallWidget.__selectPage"></a> 321 <a NAME="PluginInstallWidget.__selectPage" ID="PluginInstallWidget.__selectPage"></a>
325 <h4>PluginInstallWidget.__selectPage</h4> 322 <h4>PluginInstallWidget.__selectPage</h4>
326 <b>__selectPage</b>(<i></i>) 323 <b>__selectPage</b>(<i></i>)
327
328 <p> 324 <p>
329 Private method to show the right wizard page. 325 Private method to show the right wizard page.
330 </p> 326 </p>
327
331 <a NAME="PluginInstallWidget.__uninstallPackage" ID="PluginInstallWidget.__uninstallPackage"></a> 328 <a NAME="PluginInstallWidget.__uninstallPackage" ID="PluginInstallWidget.__uninstallPackage"></a>
332 <h4>PluginInstallWidget.__uninstallPackage</h4> 329 <h4>PluginInstallWidget.__uninstallPackage</h4>
333 <b>__uninstallPackage</b>(<i>destination, pluginFileName, packageName</i>) 330 <b>__uninstallPackage</b>(<i>destination, pluginFileName, packageName</i>)
334
335 <p> 331 <p>
336 Private method to uninstall an already installed plugin to prepare 332 Private method to uninstall an already installed plugin to prepare
337 the update. 333 the update.
338 </p> 334 </p>
335
339 <dl> 336 <dl>
340 337
341 <dt><i>destination</i> (str)</dt> 338 <dt><i>destination</i> (str)</dt>
342 <dd> 339 <dd>
343 name of the plugin directory 340 name of the plugin directory
352 </dd> 349 </dd>
353 </dl> 350 </dl>
354 <a NAME="PluginInstallWidget.on_addArchivesButton_clicked" ID="PluginInstallWidget.on_addArchivesButton_clicked"></a> 351 <a NAME="PluginInstallWidget.on_addArchivesButton_clicked" ID="PluginInstallWidget.on_addArchivesButton_clicked"></a>
355 <h4>PluginInstallWidget.on_addArchivesButton_clicked</h4> 352 <h4>PluginInstallWidget.on_addArchivesButton_clicked</h4>
356 <b>on_addArchivesButton_clicked</b>(<i></i>) 353 <b>on_addArchivesButton_clicked</b>(<i></i>)
357
358 <p> 354 <p>
359 Private slot to select plugin ZIP-archives via a file selection dialog. 355 Private slot to select plugin ZIP-archives via a file selection dialog.
360 </p> 356 </p>
357
361 <a NAME="PluginInstallWidget.on_archivesList_itemSelectionChanged" ID="PluginInstallWidget.on_archivesList_itemSelectionChanged"></a> 358 <a NAME="PluginInstallWidget.on_archivesList_itemSelectionChanged" ID="PluginInstallWidget.on_archivesList_itemSelectionChanged"></a>
362 <h4>PluginInstallWidget.on_archivesList_itemSelectionChanged</h4> 359 <h4>PluginInstallWidget.on_archivesList_itemSelectionChanged</h4>
363 <b>on_archivesList_itemSelectionChanged</b>(<i></i>) 360 <b>on_archivesList_itemSelectionChanged</b>(<i></i>)
364
365 <p> 361 <p>
366 Private slot called, when the selection of the archives list changes. 362 Private slot called, when the selection of the archives list changes.
367 </p> 363 </p>
364
368 <a NAME="PluginInstallWidget.on_buttonBox_clicked" ID="PluginInstallWidget.on_buttonBox_clicked"></a> 365 <a NAME="PluginInstallWidget.on_buttonBox_clicked" ID="PluginInstallWidget.on_buttonBox_clicked"></a>
369 <h4>PluginInstallWidget.on_buttonBox_clicked</h4> 366 <h4>PluginInstallWidget.on_buttonBox_clicked</h4>
370 <b>on_buttonBox_clicked</b>(<i>button</i>) 367 <b>on_buttonBox_clicked</b>(<i>button</i>)
371
372 <p> 368 <p>
373 Private slot to handle the click of a button of the button box. 369 Private slot to handle the click of a button of the button box.
374 </p> 370 </p>
371
375 <dl> 372 <dl>
376 373
377 <dt><i>button</i> (QAbstractButton)</dt> 374 <dt><i>button</i> (QAbstractButton)</dt>
378 <dd> 375 <dd>
379 reference to the button pressed 376 reference to the button pressed
380 </dd> 377 </dd>
381 </dl> 378 </dl>
382 <a NAME="PluginInstallWidget.on_removeArchivesButton_clicked" ID="PluginInstallWidget.on_removeArchivesButton_clicked"></a> 379 <a NAME="PluginInstallWidget.on_removeArchivesButton_clicked" ID="PluginInstallWidget.on_removeArchivesButton_clicked"></a>
383 <h4>PluginInstallWidget.on_removeArchivesButton_clicked</h4> 380 <h4>PluginInstallWidget.on_removeArchivesButton_clicked</h4>
384 <b>on_removeArchivesButton_clicked</b>(<i></i>) 381 <b>on_removeArchivesButton_clicked</b>(<i></i>)
385
386 <p> 382 <p>
387 Private slot to remove archives from the list. 383 Private slot to remove archives from the list.
388 </p> 384 </p>
385
389 <a NAME="PluginInstallWidget.restartNeeded" ID="PluginInstallWidget.restartNeeded"></a> 386 <a NAME="PluginInstallWidget.restartNeeded" ID="PluginInstallWidget.restartNeeded"></a>
390 <h4>PluginInstallWidget.restartNeeded</h4> 387 <h4>PluginInstallWidget.restartNeeded</h4>
391 <b>restartNeeded</b>(<i></i>) 388 <b>restartNeeded</b>(<i></i>)
392
393 <p> 389 <p>
394 Public method to check, if a restart of the IDE is required. 390 Public method to check, if a restart of the IDE is required.
395 </p> 391 </p>
392
396 <dl> 393 <dl>
397 <dt>Return:</dt> 394 <dt>Return:</dt>
398 <dd> 395 <dd>
399 flag indicating a restart is required 396 flag indicating a restart is required
400 </dd> 397 </dd>
408 <div align="right"><a href="#top">Up</a></div> 405 <div align="right"><a href="#top">Up</a></div>
409 <hr /> 406 <hr />
410 <hr /> 407 <hr />
411 <a NAME="PluginInstallWindow" ID="PluginInstallWindow"></a> 408 <a NAME="PluginInstallWindow" ID="PluginInstallWindow"></a>
412 <h2>PluginInstallWindow</h2> 409 <h2>PluginInstallWindow</h2>
413
414 <p> 410 <p>
415 Main window class for the standalone dialog. 411 Main window class for the standalone dialog.
416 </p> 412 </p>
413
417 <h3>Derived from</h3> 414 <h3>Derived from</h3>
418 EricMainWindow 415 EricMainWindow
419 <h3>Class Attributes</h3> 416 <h3>Class Attributes</h3>
420 417 <table>
421 <table> 418 <tr><td>None</td></tr>
422 <tr><td>None</td></tr> 419 </table>
423 </table> 420
424 <h3>Class Methods</h3> 421 <h3>Class Methods</h3>
425 422 <table>
426 <table> 423 <tr><td>None</td></tr>
427 <tr><td>None</td></tr> 424 </table>
428 </table> 425
429 <h3>Methods</h3> 426 <h3>Methods</h3>
430 427 <table>
431 <table>
432
433 <tr> 428 <tr>
434 <td><a href="#PluginInstallWindow.__init__">PluginInstallWindow</a></td> 429 <td><a href="#PluginInstallWindow.__init__">PluginInstallWindow</a></td>
435 <td>Constructor</td> 430 <td>Constructor</td>
436 </tr> 431 </tr>
437 </table> 432 </table>
433
438 <h3>Static Methods</h3> 434 <h3>Static Methods</h3>
439 435 <table>
440 <table> 436 <tr><td>None</td></tr>
441 <tr><td>None</td></tr> 437 </table>
442 </table> 438
443 439
444 <a NAME="PluginInstallWindow.__init__" ID="PluginInstallWindow.__init__"></a> 440 <a NAME="PluginInstallWindow.__init__" ID="PluginInstallWindow.__init__"></a>
445 <h4>PluginInstallWindow (Constructor)</h4> 441 <h4>PluginInstallWindow (Constructor)</h4>
446 <b>PluginInstallWindow</b>(<i>pluginFileNames, parent=None</i>) 442 <b>PluginInstallWindow</b>(<i>pluginFileNames, parent=None</i>)
447
448 <p> 443 <p>
449 Constructor 444 Constructor
450 </p> 445 </p>
446
451 <dl> 447 <dl>
452 448
453 <dt><i>pluginFileNames</i> (list of str)</dt> 449 <dt><i>pluginFileNames</i> (list of str)</dt>
454 <dd> 450 <dd>
455 list of plugin files suggested for 451 list of plugin files suggested for

Mercurial Repository: eric

eric ide

mercurial