Class: QgsPluginManagerInterface

Abstract interface class for the QGIS plugin manager.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: addPluginMetadata(), addToRepositoryList(), clearPythonPluginMetadata(), clearRepositoryList(), pushMessage(), reloadModel(), showPluginManager()

Class Hierarchy

Inheritance diagram of qgis.gui.QgsPluginManagerInterface

Base classes

QObject

Abstract Methods

addPluginMetadata

add a single plugin to the metadata registry

addToRepositoryList

add repository to the repository listWidget

clearPythonPluginMetadata

remove Python plugins from the metadata registry (c++ plugins stay)

clearRepositoryList

clear the repository listWidget

pushMessage

show the given message in the Plugin Manager internal message bar

reloadModel

refresh plugin list model (and metadata browser content if necessary)

showPluginManager

show the Plugin Manager window and optionally open tab tabIndex

Methods

pluginMetadata

Returns given plugin metadata

class qgis.gui.QgsPluginManagerInterface[source]

Bases: QObject

abstract addPluginMetadata(self, metadata: Dict[str | None, str | None])[source]

add a single plugin to the metadata registry

Parameters:

metadata (Dict[Optional[str], Optional[str]])

abstract addToRepositoryList(self, repository: Dict[str | None, str | None])[source]

add repository to the repository listWidget

Parameters:

repository (Dict[Optional[str], Optional[str]])

abstract clearPythonPluginMetadata(self)[source]

remove Python plugins from the metadata registry (c++ plugins stay)

abstract clearRepositoryList(self)[source]

clear the repository listWidget

pluginMetadata(self, key: str | None) Dict[str, str] | None

Returns given plugin metadata

Parameters:

key (Optional[str])

Return type:

Optional[Dict[str, str]]

abstract pushMessage(self, text: str | None, level: Qgis.MessageLevel = Qgis.MessageLevel.Info, duration: int = -1)[source]

show the given message in the Plugin Manager internal message bar

Parameters:
  • text (Optional[str])

  • level (Qgis.MessageLevel = Qgis.MessageLevel.Info)

  • duration (int = -1)

abstract reloadModel(self)[source]

refresh plugin list model (and metadata browser content if necessary)

abstract showPluginManager(self, tabIndex: int = -1)[source]

show the Plugin Manager window and optionally open tab tabIndex

Parameters:

tabIndex (int = -1)