Class: QgsProviderGuiRegistry

A registry / canonical manager of GUI parts of data providers.

QgsProviderGuiRegistry is not usually directly created, but rather accessed through QgsGui.providerGuiRegistry().

setPluginPath() should be called (once) to load dynamic providers. Static providers are loaded in constructor.

Added in version 3.10.

Methods

dataItemGuiProviders	Returns all data item gui providers registered in provider with providerKey
providerList	Returns list of available providers by their keys
providerMetadata	Returns metadata of the provider or None if not found
registerGuis	Called during GUI initialization - allows providers to do its internal initialization of GUI components, possibly making use of the passed pointer to the QGIS main window.

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsProviderGuiRegistry. See the FAQ for more details.

mapLayerConfigWidgetFactories	Returns all map layer config widget factories associated with the registered providers.
projectStorageGuiProviders	Returns all project storage gui providers registered in provider with providerKey
sourceSelectProviders	Returns all source select providers registered in provider with providerKey
sourceWidgetProviders	Returns all source widget providers registered in provider with providerKey
subsetStringEditorProviders	Returns all subset string editor providers registered in provider with providerKey

class qgis.gui.QgsProviderGuiRegistry

Bases: object

__init__(pluginPath: str | None)

Creates registry and loads static provider plugins

Parameters:

pluginPath (Optional[str])

__init__(a0: QgsProviderGuiRegistry)

Parameters:

a0 (QgsProviderGuiRegistry)

dataItemGuiProviders(self, providerKey: str | None) → List[QgsDataItemGuiProvider]

Returns all data item gui providers registered in provider with providerKey

Note

Ownership of created data item providers is passed to the caller.

Parameters:

providerKey (Optional[str])

Return type:

List[QgsDataItemGuiProvider]

virtual mapLayerConfigWidgetFactories(self, layer: QgsMapLayer | None = None) → List[QgsMapLayerConfigWidgetFactory]

Returns all map layer config widget factories associated with the registered providers.

The optional layer argument can be used to only return factories which support the specified layer.

Added in version 3.20.

Parameters:

layer (Optional[QgsMapLayer] = None)

Return type:

List[QgsMapLayerConfigWidgetFactory]

virtual projectStorageGuiProviders(self, providerKey: str | None) → List[QgsProjectStorageGuiProvider]

Returns all project storage gui providers registered in provider with providerKey

Note

Ownership of created project storage gui providers is passed to the caller.

Parameters:

providerKey (Optional[str])

Return type:

List[QgsProjectStorageGuiProvider]

providerList(self) → List[str]

Returns list of available providers by their keys

Return type:

List[str]

providerMetadata(self, providerKey: str | None) → QgsProviderGuiMetadata | None

Returns metadata of the provider or None if not found

Parameters:

providerKey (Optional[str])

Return type:

Optional[QgsProviderGuiMetadata]

registerGuis(self, widget: QMainWindow | None)

Called during GUI initialization - allows providers to do its internal initialization of GUI components, possibly making use of the passed pointer to the QGIS main window.

Parameters:

widget (Optional[QMainWindow])

virtual sourceSelectProviders(self, providerKey: str | None) → List[QgsSourceSelectProvider]

Returns all source select providers registered in provider with providerKey

Note

Ownership of created source select providers is passed to the caller.

Parameters:

providerKey (Optional[str])

Return type:

List[QgsSourceSelectProvider]

virtual sourceWidgetProviders(self, providerKey: str | None) → List[QgsProviderSourceWidgetProvider]

Returns all source widget providers registered in provider with providerKey

Note

Ownership of providers is passed to the caller.

Added in version 3.18.

Parameters:

providerKey (Optional[str])

Return type:

List[QgsProviderSourceWidgetProvider]

virtual subsetStringEditorProviders(self, providerKey: str | None) → List[QgsSubsetStringEditorProvider]

Returns all subset string editor providers registered in provider with providerKey

Note

Ownership of providers is passed to the caller.

Added in version 3.18.

Parameters:

providerKey (Optional[str])

Return type:

List[QgsSubsetStringEditorProvider]