Mercurial Repositories > eric / file comparison

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

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

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.PluginManager.PluginInstallDialog</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.PluginInstallDialog</h1>
24
25 <p>
26 Module implementing the Plugin installation dialog.
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="#PluginInstallDialog">PluginInstallDialog</a></td>
39 <td>Class for the dialog variant.</td>
40 </tr>
41 <tr>
42 <td><a href="#PluginInstallWidget">PluginInstallWidget</a></td>
43 <td>Class implementing the Plugin installation dialog.</td>
44 </tr>
45 <tr>
46 <td><a href="#PluginInstallWindow">PluginInstallWindow</a></td>
47 <td>Main window class for the standalone dialog.</td>
48 </tr>
49 </table>
50 <h3>Functions</h3>
51
52 <table>
53 <tr><td>None</td></tr>
54 </table>
55 <hr />
56 <hr />
57 <a NAME="PluginInstallDialog" ID="PluginInstallDialog"></a>
58 <h2>PluginInstallDialog</h2>
59
60 <p>
61 Class for the dialog variant.
62 </p>
63 <h3>Derived from</h3>
64 QDialog
65 <h3>Class Attributes</h3>
66
67 <table>
68 <tr><td>None</td></tr>
69 </table>
70 <h3>Class Methods</h3>
71
72 <table>
73 <tr><td>None</td></tr>
74 </table>
75 <h3>Methods</h3>
76
77 <table>
78
79 <tr>
80 <td><a href="#PluginInstallDialog.__init__">PluginInstallDialog</a></td>
81 <td>Constructor</td>
82 </tr>
83 <tr>
84 <td><a href="#PluginInstallDialog.restartNeeded">restartNeeded</a></td>
85 <td>Public method to check, if a restart of the IDE is required.</td>
86 </tr>
87 </table>
88 <h3>Static Methods</h3>
89
90 <table>
91 <tr><td>None</td></tr>
92 </table>
93
94 <a NAME="PluginInstallDialog.__init__" ID="PluginInstallDialog.__init__"></a>
95 <h4>PluginInstallDialog (Constructor)</h4>
96 <b>PluginInstallDialog</b>(<i>pluginManager, pluginFileNames, parent=None</i>)
97
98 <p>
99 Constructor
100 </p>
101 <dl>
102
103 <dt><i>pluginManager</i></dt>
104 <dd>
105 reference to the plugin manager object
106 </dd>
107 <dt><i>pluginFileNames</i></dt>
108 <dd>
109 list of plugin files suggested for
110 installation (list of strings)
111 </dd>
112 <dt><i>parent</i></dt>
113 <dd>
114 reference to the parent widget (QWidget)
115 </dd>
116 </dl>
117 <a NAME="PluginInstallDialog.restartNeeded" ID="PluginInstallDialog.restartNeeded"></a>
118 <h4>PluginInstallDialog.restartNeeded</h4>
119 <b>restartNeeded</b>(<i></i>)
120
121 <p>
122 Public method to check, if a restart of the IDE is required.
123 </p>
124 <dl>
125 <dt>Return:</dt>
126 <dd>
127 flag indicating a restart is required (boolean)
128 </dd>
129 </dl>
130 <div align="right"><a href="#top">Up</a></div>
131 <hr />
132 <hr />
133 <a NAME="PluginInstallWidget" ID="PluginInstallWidget"></a>
134 <h2>PluginInstallWidget</h2>
135
136 <p>
137 Class implementing the Plugin installation dialog.
138 </p>
139 <h3>Derived from</h3>
140 QWidget, Ui_PluginInstallDialog
141 <h3>Class Attributes</h3>
142
143 <table>
144 <tr><td>None</td></tr>
145 </table>
146 <h3>Class Methods</h3>
147
148 <table>
149 <tr><td>None</td></tr>
150 </table>
151 <h3>Methods</h3>
152
153 <table>
154
155 <tr>
156 <td><a href="#PluginInstallWidget.__init__">PluginInstallWidget</a></td>
157 <td>Constructor</td>
158 </tr>
159 <tr>
160 <td><a href="#PluginInstallWidget.__createArchivesList">__createArchivesList</a></td>
161 <td>Private method to create a list of plugin archive names.</td>
162 </tr>
163 <tr>
164 <td><a href="#PluginInstallWidget.__installPlugin">__installPlugin</a></td>
165 <td>Private slot to install the selected plugin.</td>
166 </tr>
167 <tr>
168 <td><a href="#PluginInstallWidget.__installPlugins">__installPlugins</a></td>
169 <td>Private method to install the selected plugin archives.</td>
170 </tr>
171 <tr>
172 <td><a href="#PluginInstallWidget.__makedirs">__makedirs</a></td>
173 <td>Private method to create a directory and all intermediate ones.</td>
174 </tr>
175 <tr>
176 <td><a href="#PluginInstallWidget.__rollback">__rollback</a></td>
177 <td>Private method to rollback a failed installation.</td>
178 </tr>
179 <tr>
180 <td><a href="#PluginInstallWidget.__selectPage">__selectPage</a></td>
181 <td>Private method to show the right wizard page.</td>
182 </tr>
183 <tr>
184 <td><a href="#PluginInstallWidget.__uninstallPackage">__uninstallPackage</a></td>
185 <td>Private method to uninstall an already installed plugin to prepare the update.</td>
186 </tr>
187 <tr>
188 <td><a href="#PluginInstallWidget.on_addArchivesButton_clicked">on_addArchivesButton_clicked</a></td>
189 <td>Private slot to select plugin ZIP-archives via a file selection dialog.</td>
190 </tr>
191 <tr>
192 <td><a href="#PluginInstallWidget.on_archivesList_itemSelectionChanged">on_archivesList_itemSelectionChanged</a></td>
193 <td>Private slot called, when the selection of the archives list changes.</td>
194 </tr>
195 <tr>
196 <td><a href="#PluginInstallWidget.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
197 <td>Private slot to handle the click of a button of the button box.</td>
198 </tr>
199 <tr>
200 <td><a href="#PluginInstallWidget.on_removeArchivesButton_clicked">on_removeArchivesButton_clicked</a></td>
201 <td>Private slot to remove archives from the list.</td>
202 </tr>
203 <tr>
204 <td><a href="#PluginInstallWidget.restartNeeded">restartNeeded</a></td>
205 <td>Public method to check, if a restart of the IDE is required.</td>
206 </tr>
207 </table>
208 <h3>Static Methods</h3>
209
210 <table>
211 <tr><td>None</td></tr>
212 </table>
213
214 <a NAME="PluginInstallWidget.__init__" ID="PluginInstallWidget.__init__"></a>
215 <h4>PluginInstallWidget (Constructor)</h4>
216 <b>PluginInstallWidget</b>(<i>pluginManager, pluginFileNames, parent=None</i>)
217
218 <p>
219 Constructor
220 </p>
221 <dl>
222
223 <dt><i>pluginManager</i></dt>
224 <dd>
225 reference to the plugin manager object
226 </dd>
227 <dt><i>pluginFileNames</i></dt>
228 <dd>
229 list of plugin files suggested for
230 installation (list of strings)
231 </dd>
232 <dt><i>parent</i></dt>
233 <dd>
234 parent of this dialog (QWidget)
235 </dd>
236 </dl>
237 <a NAME="PluginInstallWidget.__createArchivesList" ID="PluginInstallWidget.__createArchivesList"></a>
238 <h4>PluginInstallWidget.__createArchivesList</h4>
239 <b>__createArchivesList</b>(<i></i>)
240
241 <p>
242 Private method to create a list of plugin archive names.
243 </p>
244 <dl>
245 <dt>Return:</dt>
246 <dd>
247 list of plugin archive names (list of strings)
248 </dd>
249 </dl>
250 <a NAME="PluginInstallWidget.__installPlugin" ID="PluginInstallWidget.__installPlugin"></a>
251 <h4>PluginInstallWidget.__installPlugin</h4>
252 <b>__installPlugin</b>(<i>archiveFilename</i>)
253
254 <p>
255 Private slot to install the selected plugin.
256 </p>
257 <dl>
258
259 <dt><i>archiveFilename</i></dt>
260 <dd>
261 name of the plugin archive
262 file (string)
263 </dd>
264 </dl>
265 <dl>
266 <dt>Return:</dt>
267 <dd>
268 flag indicating success (boolean), error message
269 upon failure (string) and flag indicating a restart
270 of the IDE is required (boolean)
271 </dd>
272 </dl>
273 <a NAME="PluginInstallWidget.__installPlugins" ID="PluginInstallWidget.__installPlugins"></a>
274 <h4>PluginInstallWidget.__installPlugins</h4>
275 <b>__installPlugins</b>(<i></i>)
276
277 <p>
278 Private method to install the selected plugin archives.
279 </p>
280 <dl>
281 <dt>Return:</dt>
282 <dd>
283 flag indicating success (boolean)
284 </dd>
285 </dl>
286 <a NAME="PluginInstallWidget.__makedirs" ID="PluginInstallWidget.__makedirs"></a>
287 <h4>PluginInstallWidget.__makedirs</h4>
288 <b>__makedirs</b>(<i>name, mode=0o777</i>)
289
290 <p>
291 Private method to create a directory and all intermediate ones.
292 </p>
293 <p>
294 This is an extended version of the Python one in order to
295 record the created directories.
296 </p>
297 <dl>
298
299 <dt><i>name</i></dt>
300 <dd>
301 name of the directory to create (string)
302 </dd>
303 <dt><i>mode</i></dt>
304 <dd>
305 permission to set for the new directory (integer)
306 </dd>
307 </dl>
308 <a NAME="PluginInstallWidget.__rollback" ID="PluginInstallWidget.__rollback"></a>
309 <h4>PluginInstallWidget.__rollback</h4>
310 <b>__rollback</b>(<i></i>)
311
312 <p>
313 Private method to rollback a failed installation.
314 </p>
315 <a NAME="PluginInstallWidget.__selectPage" ID="PluginInstallWidget.__selectPage"></a>
316 <h4>PluginInstallWidget.__selectPage</h4>
317 <b>__selectPage</b>(<i></i>)
318
319 <p>
320 Private method to show the right wizard page.
321 </p>
322 <a NAME="PluginInstallWidget.__uninstallPackage" ID="PluginInstallWidget.__uninstallPackage"></a>
323 <h4>PluginInstallWidget.__uninstallPackage</h4>
324 <b>__uninstallPackage</b>(<i>destination, pluginFileName, packageName</i>)
325
326 <p>
327 Private method to uninstall an already installed plugin to prepare
328 the update.
329 </p>
330 <dl>
331
332 <dt><i>destination</i></dt>
333 <dd>
334 name of the plugin directory (string)
335 </dd>
336 <dt><i>pluginFileName</i></dt>
337 <dd>
338 name of the plugin file (string)
339 </dd>
340 <dt><i>packageName</i></dt>
341 <dd>
342 name of the plugin package (string)
343 </dd>
344 </dl>
345 <a NAME="PluginInstallWidget.on_addArchivesButton_clicked" ID="PluginInstallWidget.on_addArchivesButton_clicked"></a>
346 <h4>PluginInstallWidget.on_addArchivesButton_clicked</h4>
347 <b>on_addArchivesButton_clicked</b>(<i></i>)
348
349 <p>
350 Private slot to select plugin ZIP-archives via a file selection dialog.
351 </p>
352 <a NAME="PluginInstallWidget.on_archivesList_itemSelectionChanged" ID="PluginInstallWidget.on_archivesList_itemSelectionChanged"></a>
353 <h4>PluginInstallWidget.on_archivesList_itemSelectionChanged</h4>
354 <b>on_archivesList_itemSelectionChanged</b>(<i></i>)
355
356 <p>
357 Private slot called, when the selection of the archives list changes.
358 </p>
359 <a NAME="PluginInstallWidget.on_buttonBox_clicked" ID="PluginInstallWidget.on_buttonBox_clicked"></a>
360 <h4>PluginInstallWidget.on_buttonBox_clicked</h4>
361 <b>on_buttonBox_clicked</b>(<i>button</i>)
362
363 <p>
364 Private slot to handle the click of a button of the button box.
365 </p>
366 <dl>
367
368 <dt><i>button</i></dt>
369 <dd>
370 reference to the button pressed (QAbstractButton)
371 </dd>
372 </dl>
373 <a NAME="PluginInstallWidget.on_removeArchivesButton_clicked" ID="PluginInstallWidget.on_removeArchivesButton_clicked"></a>
374 <h4>PluginInstallWidget.on_removeArchivesButton_clicked</h4>
375 <b>on_removeArchivesButton_clicked</b>(<i></i>)
376
377 <p>
378 Private slot to remove archives from the list.
379 </p>
380 <a NAME="PluginInstallWidget.restartNeeded" ID="PluginInstallWidget.restartNeeded"></a>
381 <h4>PluginInstallWidget.restartNeeded</h4>
382 <b>restartNeeded</b>(<i></i>)
383
384 <p>
385 Public method to check, if a restart of the IDE is required.
386 </p>
387 <dl>
388 <dt>Return:</dt>
389 <dd>
390 flag indicating a restart is required (boolean)
391 </dd>
392 </dl>
393 <div align="right"><a href="#top">Up</a></div>
394 <hr />
395 <hr />
396 <a NAME="PluginInstallWindow" ID="PluginInstallWindow"></a>
397 <h2>PluginInstallWindow</h2>
398
399 <p>
400 Main window class for the standalone dialog.
401 </p>
402 <h3>Derived from</h3>
403 EricMainWindow
404 <h3>Class Attributes</h3>
405
406 <table>
407 <tr><td>None</td></tr>
408 </table>
409 <h3>Class Methods</h3>
410
411 <table>
412 <tr><td>None</td></tr>
413 </table>
414 <h3>Methods</h3>
415
416 <table>
417
418 <tr>
419 <td><a href="#PluginInstallWindow.__init__">PluginInstallWindow</a></td>
420 <td>Constructor</td>
421 </tr>
422 </table>
423 <h3>Static Methods</h3>
424
425 <table>
426 <tr><td>None</td></tr>
427 </table>
428
429 <a NAME="PluginInstallWindow.__init__" ID="PluginInstallWindow.__init__"></a>
430 <h4>PluginInstallWindow (Constructor)</h4>
431 <b>PluginInstallWindow</b>(<i>pluginFileNames, parent=None</i>)
432
433 <p>
434 Constructor
435 </p>
436 <dl>
437
438 <dt><i>pluginFileNames</i></dt>
439 <dd>
440 list of plugin files suggested for
441 installation (list of strings)
442 </dd>
443 <dt><i>parent</i></dt>
444 <dd>
445 reference to the parent widget (QWidget)
446 </dd>
447 </dl>
448 <div align="right"><a href="#top">Up</a></div>
449 <hr />
450 </body></html>

Mercurial Repository: eric

eric ide

mercurial