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

branch
eric7
changeset 10428
a071d4065202
parent 9209
b99e7fd55fd3
child 10479
856476537696
equal deleted inserted replaced
10427:3733e2b23cf7 10428:a071d4065202
84 <p> 84 <p>
85 Constructor 85 Constructor
86 </p> 86 </p>
87 <dl> 87 <dl>
88 88
89 <dt><i>pluginManager</i></dt> 89 <dt><i>pluginManager</i> (PluginManager)</dt>
90 <dd> 90 <dd>
91 reference to the plugin manager object 91 reference to the plugin manager object
92 </dd> 92 </dd>
93 <dt><i>pluginFileNames</i></dt> 93 <dt><i>pluginFileNames</i> (list of str)</dt>
94 <dd> 94 <dd>
95 list of plugin files suggested for 95 list of plugin files suggested for installation
96 installation (list of strings) 96 </dd>
97 </dd> 97 <dt><i>parent</i> (QWidget)</dt>
98 <dt><i>parent</i></dt> 98 <dd>
99 <dd> 99 reference to the parent widget
100 reference to the parent widget (QWidget)
101 </dd> 100 </dd>
102 </dl> 101 </dl>
103 <a NAME="PluginInstallDialog.restartNeeded" ID="PluginInstallDialog.restartNeeded"></a> 102 <a NAME="PluginInstallDialog.restartNeeded" ID="PluginInstallDialog.restartNeeded"></a>
104 <h4>PluginInstallDialog.restartNeeded</h4> 103 <h4>PluginInstallDialog.restartNeeded</h4>
105 <b>restartNeeded</b>(<i></i>) 104 <b>restartNeeded</b>(<i></i>)
108 Public method to check, if a restart of the IDE is required. 107 Public method to check, if a restart of the IDE is required.
109 </p> 108 </p>
110 <dl> 109 <dl>
111 <dt>Return:</dt> 110 <dt>Return:</dt>
112 <dd> 111 <dd>
113 flag indicating a restart is required (boolean) 112 flag indicating a restart is required
113 </dd>
114 </dl>
115 <dl>
116 <dt>Return Type:</dt>
117 <dd>
118 bool
114 </dd> 119 </dd>
115 </dl> 120 </dl>
116 <div align="right"><a href="#top">Up</a></div> 121 <div align="right"><a href="#top">Up</a></div>
117 <hr /> 122 <hr />
118 <hr /> 123 <hr />
204 <p> 209 <p>
205 Constructor 210 Constructor
206 </p> 211 </p>
207 <dl> 212 <dl>
208 213
209 <dt><i>pluginManager</i></dt> 214 <dt><i>pluginManager</i> (PluginManager)</dt>
210 <dd> 215 <dd>
211 reference to the plugin manager object 216 reference to the plugin manager object
212 </dd> 217 </dd>
213 <dt><i>pluginFileNames</i></dt> 218 <dt><i>pluginFileNames</i> (list of str)</dt>
214 <dd> 219 <dd>
215 list of plugin files suggested for 220 list of plugin files suggested for
216 installation (list of strings) 221 installation
217 </dd> 222 </dd>
218 <dt><i>parent</i></dt> 223 <dt><i>parent</i> (QWidget)</dt>
219 <dd> 224 <dd>
220 parent of this dialog (QWidget) 225 parent of this dialog
221 </dd> 226 </dd>
222 </dl> 227 </dl>
223 <a NAME="PluginInstallWidget.__createArchivesList" ID="PluginInstallWidget.__createArchivesList"></a> 228 <a NAME="PluginInstallWidget.__createArchivesList" ID="PluginInstallWidget.__createArchivesList"></a>
224 <h4>PluginInstallWidget.__createArchivesList</h4> 229 <h4>PluginInstallWidget.__createArchivesList</h4>
225 <b>__createArchivesList</b>(<i></i>) 230 <b>__createArchivesList</b>(<i></i>)
228 Private method to create a list of plugin archive names. 233 Private method to create a list of plugin archive names.
229 </p> 234 </p>
230 <dl> 235 <dl>
231 <dt>Return:</dt> 236 <dt>Return:</dt>
232 <dd> 237 <dd>
233 list of plugin archive names (list of strings) 238 list of plugin archive names
239 </dd>
240 </dl>
241 <dl>
242 <dt>Return Type:</dt>
243 <dd>
244 list of str
234 </dd> 245 </dd>
235 </dl> 246 </dl>
236 <a NAME="PluginInstallWidget.__installPlugin" ID="PluginInstallWidget.__installPlugin"></a> 247 <a NAME="PluginInstallWidget.__installPlugin" ID="PluginInstallWidget.__installPlugin"></a>
237 <h4>PluginInstallWidget.__installPlugin</h4> 248 <h4>PluginInstallWidget.__installPlugin</h4>
238 <b>__installPlugin</b>(<i>archiveFilename</i>) 249 <b>__installPlugin</b>(<i>archiveFilename</i>)
240 <p> 251 <p>
241 Private slot to install the selected plugin. 252 Private slot to install the selected plugin.
242 </p> 253 </p>
243 <dl> 254 <dl>
244 255
245 <dt><i>archiveFilename</i></dt> 256 <dt><i>archiveFilename</i> (str)</dt>
246 <dd> 257 <dd>
247 name of the plugin archive 258 name of the plugin archive
248 file (string) 259 file
249 </dd> 260 </dd>
250 </dl> 261 </dl>
251 <dl> 262 <dl>
252 <dt>Return:</dt> 263 <dt>Return:</dt>
253 <dd> 264 <dd>
254 flag indicating success (boolean), error message 265 flag indicating success (boolean), error message
255 upon failure (string) and flag indicating a restart 266 upon failure (string) and flag indicating a restart
256 of the IDE is required (boolean) 267 of the IDE is required
268 </dd>
269 </dl>
270 <dl>
271 <dt>Return Type:</dt>
272 <dd>
273 bool
257 </dd> 274 </dd>
258 </dl> 275 </dl>
259 <a NAME="PluginInstallWidget.__installPlugins" ID="PluginInstallWidget.__installPlugins"></a> 276 <a NAME="PluginInstallWidget.__installPlugins" ID="PluginInstallWidget.__installPlugins"></a>
260 <h4>PluginInstallWidget.__installPlugins</h4> 277 <h4>PluginInstallWidget.__installPlugins</h4>
261 <b>__installPlugins</b>(<i></i>) 278 <b>__installPlugins</b>(<i></i>)
264 Private method to install the selected plugin archives. 281 Private method to install the selected plugin archives.
265 </p> 282 </p>
266 <dl> 283 <dl>
267 <dt>Return:</dt> 284 <dt>Return:</dt>
268 <dd> 285 <dd>
269 flag indicating success (boolean) 286 flag indicating success
287 </dd>
288 </dl>
289 <dl>
290 <dt>Return Type:</dt>
291 <dd>
292 bool
270 </dd> 293 </dd>
271 </dl> 294 </dl>
272 <a NAME="PluginInstallWidget.__makedirs" ID="PluginInstallWidget.__makedirs"></a> 295 <a NAME="PluginInstallWidget.__makedirs" ID="PluginInstallWidget.__makedirs"></a>
273 <h4>PluginInstallWidget.__makedirs</h4> 296 <h4>PluginInstallWidget.__makedirs</h4>
274 <b>__makedirs</b>(<i>name, mode=0o777</i>) 297 <b>__makedirs</b>(<i>name, mode=0o777</i>)
280 This is an extended version of the Python one in order to 303 This is an extended version of the Python one in order to
281 record the created directories. 304 record the created directories.
282 </p> 305 </p>
283 <dl> 306 <dl>
284 307
285 <dt><i>name</i></dt> 308 <dt><i>name</i> (str)</dt>
286 <dd> 309 <dd>
287 name of the directory to create (string) 310 name of the directory to create
288 </dd> 311 </dd>
289 <dt><i>mode</i></dt> 312 <dt><i>mode</i> (int)</dt>
290 <dd> 313 <dd>
291 permission to set for the new directory (integer) 314 permission to set for the new directory
292 </dd> 315 </dd>
293 </dl> 316 </dl>
294 <a NAME="PluginInstallWidget.__rollback" ID="PluginInstallWidget.__rollback"></a> 317 <a NAME="PluginInstallWidget.__rollback" ID="PluginInstallWidget.__rollback"></a>
295 <h4>PluginInstallWidget.__rollback</h4> 318 <h4>PluginInstallWidget.__rollback</h4>
296 <b>__rollback</b>(<i></i>) 319 <b>__rollback</b>(<i></i>)
313 Private method to uninstall an already installed plugin to prepare 336 Private method to uninstall an already installed plugin to prepare
314 the update. 337 the update.
315 </p> 338 </p>
316 <dl> 339 <dl>
317 340
318 <dt><i>destination</i></dt> 341 <dt><i>destination</i> (str)</dt>
319 <dd> 342 <dd>
320 name of the plugin directory (string) 343 name of the plugin directory
321 </dd> 344 </dd>
322 <dt><i>pluginFileName</i></dt> 345 <dt><i>pluginFileName</i> (str)</dt>
323 <dd> 346 <dd>
324 name of the plugin file (string) 347 name of the plugin file
325 </dd> 348 </dd>
326 <dt><i>packageName</i></dt> 349 <dt><i>packageName</i> (str)</dt>
327 <dd> 350 <dd>
328 name of the plugin package (string) 351 name of the plugin package
329 </dd> 352 </dd>
330 </dl> 353 </dl>
331 <a NAME="PluginInstallWidget.on_addArchivesButton_clicked" ID="PluginInstallWidget.on_addArchivesButton_clicked"></a> 354 <a NAME="PluginInstallWidget.on_addArchivesButton_clicked" ID="PluginInstallWidget.on_addArchivesButton_clicked"></a>
332 <h4>PluginInstallWidget.on_addArchivesButton_clicked</h4> 355 <h4>PluginInstallWidget.on_addArchivesButton_clicked</h4>
333 <b>on_addArchivesButton_clicked</b>(<i></i>) 356 <b>on_addArchivesButton_clicked</b>(<i></i>)
349 <p> 372 <p>
350 Private slot to handle the click of a button of the button box. 373 Private slot to handle the click of a button of the button box.
351 </p> 374 </p>
352 <dl> 375 <dl>
353 376
354 <dt><i>button</i></dt> 377 <dt><i>button</i> (QAbstractButton)</dt>
355 <dd> 378 <dd>
356 reference to the button pressed (QAbstractButton) 379 reference to the button pressed
357 </dd> 380 </dd>
358 </dl> 381 </dl>
359 <a NAME="PluginInstallWidget.on_removeArchivesButton_clicked" ID="PluginInstallWidget.on_removeArchivesButton_clicked"></a> 382 <a NAME="PluginInstallWidget.on_removeArchivesButton_clicked" ID="PluginInstallWidget.on_removeArchivesButton_clicked"></a>
360 <h4>PluginInstallWidget.on_removeArchivesButton_clicked</h4> 383 <h4>PluginInstallWidget.on_removeArchivesButton_clicked</h4>
361 <b>on_removeArchivesButton_clicked</b>(<i></i>) 384 <b>on_removeArchivesButton_clicked</b>(<i></i>)
371 Public method to check, if a restart of the IDE is required. 394 Public method to check, if a restart of the IDE is required.
372 </p> 395 </p>
373 <dl> 396 <dl>
374 <dt>Return:</dt> 397 <dt>Return:</dt>
375 <dd> 398 <dd>
376 flag indicating a restart is required (boolean) 399 flag indicating a restart is required
400 </dd>
401 </dl>
402 <dl>
403 <dt>Return Type:</dt>
404 <dd>
405 bool
377 </dd> 406 </dd>
378 </dl> 407 </dl>
379 <div align="right"><a href="#top">Up</a></div> 408 <div align="right"><a href="#top">Up</a></div>
380 <hr /> 409 <hr />
381 <hr /> 410 <hr />
419 <p> 448 <p>
420 Constructor 449 Constructor
421 </p> 450 </p>
422 <dl> 451 <dl>
423 452
424 <dt><i>pluginFileNames</i></dt> 453 <dt><i>pluginFileNames</i> (list of str)</dt>
425 <dd> 454 <dd>
426 list of plugin files suggested for 455 list of plugin files suggested for
427 installation (list of strings) 456 installation
428 </dd> 457 </dd>
429 <dt><i>parent</i></dt> 458 <dt><i>parent</i> (QWidget)</dt>
430 <dd> 459 <dd>
431 reference to the parent widget (QWidget) 460 reference to the parent widget
432 </dd> 461 </dd>
433 </dl> 462 </dl>
434 <div align="right"><a href="#top">Up</a></div> 463 <div align="right"><a href="#top">Up</a></div>
435 <hr /> 464 <hr />
436 </body></html> 465 </body></html>

eric ide

mercurial