eric6.PluginManager.PluginInstallDialog

Module implementing the Plugin installation dialog.

Global Attributes

None

Classes

PluginInstallDialog	Class for the dialog variant.
PluginInstallWidget	Class implementing the Plugin installation dialog.
PluginInstallWindow	Main window class for the standalone dialog.

Functions

None

PluginInstallDialog

Class for the dialog variant.

Derived from

QDialog

Class Attributes

None

Class Methods

None

Methods

PluginInstallDialog	Constructor
restartNeeded	Public method to check, if a restart of the IDE is required.

Static Methods

None

PluginInstallDialog (Constructor)

PluginInstallDialog(pluginManager, pluginFileNames, parent=None)

Constructor

pluginManager: reference to the plugin manager object
pluginFileNames: list of plugin files suggested for installation (list of strings)
parent: reference to the parent widget (QWidget)

PluginInstallDialog.restartNeeded

restartNeeded()

Public method to check, if a restart of the IDE is required.

Returns:: flag indicating a restart is required (boolean)

PluginInstallWidget

Class implementing the Plugin installation dialog.

Derived from

QWidget, Ui_PluginInstallDialog

Class Attributes

None

Class Methods

None

Methods

PluginInstallWidget	Constructor
__createArchivesList	Private method to create a list of plugin archive names.
__installPlugin	Private slot to install the selected plugin.
__installPlugins	Private method to install the selected plugin archives.
__makedirs	Private method to create a directory and all intermediate ones.
__rollback	Private method to rollback a failed installation.
__selectPage	Private method to show the right wizard page.
__uninstallPackage	Private method to uninstall an already installed plugin to prepare the update.
on_addArchivesButton_clicked	Private slot to select plugin ZIP-archives via a file selection dialog.
on_archivesList_itemSelectionChanged	Private slot called, when the selection of the archives list changes.
on_buttonBox_clicked	Private slot to handle the click of a button of the button box.
on_removeArchivesButton_clicked	Private slot to remove archives from the list.
restartNeeded	Public method to check, if a restart of the IDE is required.

Static Methods

None

PluginInstallWidget (Constructor)

PluginInstallWidget(pluginManager, pluginFileNames, parent=None)

Constructor

pluginManager: reference to the plugin manager object
pluginFileNames: list of plugin files suggested for installation (list of strings)
parent: parent of this dialog (QWidget)

PluginInstallWidget.__createArchivesList

__createArchivesList()

Private method to create a list of plugin archive names.

Returns:: list of plugin archive names (list of strings)

PluginInstallWidget.__installPlugin

__installPlugin(archiveFilename)

Private slot to install the selected plugin.

archiveFilename: name of the plugin archive file (string)

Returns:: flag indicating success (boolean), error message upon failure (string) and flag indicating a restart of the IDE is required (boolean)

PluginInstallWidget.__installPlugins

__installPlugins()

Private method to install the selected plugin archives.

Returns:: flag indicating success (boolean)

PluginInstallWidget.__makedirs

__makedirs(name, mode=0o777)

Private method to create a directory and all intermediate ones.

This is an extended version of the Python one in order to record the created directories.

name: name of the directory to create (string)
mode: permission to set for the new directory (integer)

PluginInstallWidget.__rollback

__rollback()

Private method to rollback a failed installation.

PluginInstallWidget.__selectPage

__selectPage()

Private method to show the right wizard page.

PluginInstallWidget.__uninstallPackage

__uninstallPackage(destination, pluginFileName, packageName)

Private method to uninstall an already installed plugin to prepare the update.

destination: name of the plugin directory (string)
pluginFileName: name of the plugin file (string)
packageName: name of the plugin package (string)

PluginInstallWidget.on_addArchivesButton_clicked

on_addArchivesButton_clicked()

Private slot to select plugin ZIP-archives via a file selection dialog.

PluginInstallWidget.on_archivesList_itemSelectionChanged

on_archivesList_itemSelectionChanged()

Private slot called, when the selection of the archives list changes.

PluginInstallWidget.on_buttonBox_clicked

on_buttonBox_clicked(button)

Private slot to handle the click of a button of the button box.

button: reference to the button pressed (QAbstractButton)

PluginInstallWidget.on_removeArchivesButton_clicked

on_removeArchivesButton_clicked()

Private slot to remove archives from the list.

PluginInstallWidget.restartNeeded

restartNeeded()

Public method to check, if a restart of the IDE is required.

Returns:: flag indicating a restart is required (boolean)

PluginInstallWindow

Main window class for the standalone dialog.

Derived from

E5MainWindow

Class Attributes

None

Class Methods

None

Methods

PluginInstallWindow

Constructor

Static Methods

None

PluginInstallWindow (Constructor)

PluginInstallWindow(pluginFileNames, parent=None)

Constructor

pluginFileNames: list of plugin files suggested for installation (list of strings)
parent: reference to the parent widget (QWidget)

Home ⌂Doc Index ◂Up ▴