Class PluginManager

Inherits the following classes: QObject

Public Properties

Type	Name
property QList< PluginInformation >	availableAppPlugins
property PluginModel *	pluginModel

Public Signals

Type	Name
signal void	appPluginDisabled (const QString & uuid)
signal void	appPluginEnabled (const QString & uuid)
signal void	availableAppPluginsChanged
signal void	installEnded (const QString & uuid=QString(), const QString & error=QString())
signal void	installProgress (double progress)
signal void	installTriggered (const QString & name)
signal void	pluginModelChanged
signal void	pluginPermissionRequested (const QString & pluginName, bool isProjectPlugin)

Public Functions

Type	Name
	PluginManager (QQmlEngine * engine)
QList< PluginInformation >	availableAppPlugins () const
Q_INVOKABLE void	clearPluginPermissions ()
Q_INVOKABLE void	configureAppPlugin (const QString & uuid)
Q_INVOKABLE void	denyRequestedPluginPermission (bool permanent=false)
Q_INVOKABLE void	disableAppPlugin (const QString & uuid)
Q_INVOKABLE void	enableAppPlugin (const QString & uuid)
Q_INVOKABLE void	grantRequestedPluginPermission (bool permanent=false)
Q_INVOKABLE void	installFromRepository (const QString & uuid)
Q_INVOKABLE void	installFromUrl (const QString & url)
Q_INVOKABLE bool	isAppPluginConfigurable (const QString & uuid) const
Q_INVOKABLE bool	isAppPluginEnabled (const QString & uuid) const
void	loadPlugin (const QString & pluginPath, const QString & pluginName, bool skipPermissionCheck=false, bool isProjectPlugin=false)
PluginModel *	pluginModel () const
void	restoreAppPlugins ()
Q_INVOKABLE void	uninstall (const QString & uuid)
void	unloadPlugin (const QString & pluginPath)
void	unloadPlugins ()

Public Static Functions

Type	Name
QString	findProjectPlugin (const QString & projectPath)

Public Properties Documentation

property availableAppPlugins [1/2]

QList<PluginInformation> PluginManager::availableAppPlugins;

property pluginModel [1/2]

PluginModel * PluginManager::pluginModel;

Public Signals Documentation

signal appPluginDisabled

void PluginManager::appPluginDisabled;

signal appPluginEnabled

void PluginManager::appPluginEnabled;

signal availableAppPluginsChanged

void PluginManager::availableAppPluginsChanged;

signal installEnded

void PluginManager::installEnded;

signal installProgress

void PluginManager::installProgress;

signal installTriggered

void PluginManager::installTriggered;

signal pluginModelChanged

void PluginManager::pluginModelChanged;

signal pluginPermissionRequested

void PluginManager::pluginPermissionRequested;

Public Functions Documentation

function PluginManager

explicit PluginManager::PluginManager (
    QQmlEngine * engine
)

Constructs a PluginManager with the given engine.

function availableAppPlugins [2/2]

QList< PluginInformation > PluginManager::availableAppPlugins () const

Returns the list of available app plugins installed locally.

function clearPluginPermissions

Q_INVOKABLE void PluginManager::clearPluginPermissions ()

Clears all saved plugin permissions except those explicitly enabled by the user.

function configureAppPlugin

Q_INVOKABLE void PluginManager::configureAppPlugin (
    const QString & uuid
)

Opens the configuration interface for the plugin identified by uuid.

function denyRequestedPluginPermission

Q_INVOKABLE void PluginManager::denyRequestedPluginPermission (
    bool permanent=false
)

Denies permission to the last plugin that requested it. If permanent is true, saves this choice.

function disableAppPlugin

Q_INVOKABLE void PluginManager::disableAppPlugin (
    const QString & uuid
)

Disables the application plugin identified by uuid.

function enableAppPlugin

Q_INVOKABLE void PluginManager::enableAppPlugin (
    const QString & uuid
)

Enables the application plugin identified by uuid.

function grantRequestedPluginPermission

Q_INVOKABLE void PluginManager::grantRequestedPluginPermission (
    bool permanent=false
)

Grants permission to the last plugin that requested it. If permanent is true, saves this choice.

function installFromRepository

Q_INVOKABLE void PluginManager::installFromRepository (
    const QString & uuid
)

Installs a plugin from the given repository uuid.

function installFromUrl

Q_INVOKABLE void PluginManager::installFromUrl (
    const QString & url
)

Installs a plugin from the given url.

function isAppPluginConfigurable

Q_INVOKABLE bool PluginManager::isAppPluginConfigurable (
    const QString & uuid
) const

Returns true if the application plugin with uuid is configurable.

function isAppPluginEnabled

Q_INVOKABLE bool PluginManager::isAppPluginEnabled (
    const QString & uuid
) const

Returns true if the application plugin with uuid is currently enabled.

function loadPlugin

void PluginManager::loadPlugin (
    const QString & pluginPath,
    const QString & pluginName,
    bool skipPermissionCheck=false,
    bool isProjectPlugin=false
)

Loads a plugin from pluginPath and registers it under pluginName. Optionally skips permission checks and marks it as a project plugin.

function pluginModel [2/2]

PluginModel * PluginManager::pluginModel () const

Returns the plugin model used by this manager.

function restoreAppPlugins

void PluginManager::restoreAppPlugins ()

Restores and loads previously enabled application plugins.

function uninstall

Q_INVOKABLE void PluginManager::uninstall (
    const QString & uuid
)

Uninstalls the application plugin identified by uuid.

function unloadPlugin

void PluginManager::unloadPlugin (
    const QString & pluginPath
)

Unloads the plugin loaded from pluginPath.

function unloadPlugins

void PluginManager::unloadPlugins ()

Unloads all currently loaded plugins.

Public Static Functions Documentation

function findProjectPlugin

static QString PluginManager::findProjectPlugin (
    const QString & projectPath
)

Finds and returns the plugin path corresponding to a project at projectPath. Returns an empty string if none is found.

The documentation for this class was generated from the following file src/core/pluginmanager.h