Class: QgsProviderGuiRegistry

class qgis.gui.QgsProviderGuiRegistry

Bases: sip.wrapper

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.

New in version 3.10.

QgsProviderGuiRegistry(pluginPath: str) Creates registry and loads static provider plugins

QgsProviderGuiRegistry(QgsProviderGuiRegistry)

Methods

dataItemGuiProviders

Returns all data item gui providers registered in provider with providerKey

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

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.

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

dataItemGuiProviders(self, providerKey: str)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 (str) –

Return type

List[QgsDataItemGuiProvider]

mapLayerConfigWidgetFactories(self, layer: QgsMapLayer = 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.

New in version 3.20.

Parameters

layer (QgsMapLayer = None) –

Return type

List[QgsMapLayerConfigWidgetFactory]

projectStorageGuiProviders(self, providerKey: str)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 (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)QgsProviderGuiMetadata

Returns metadata of the provider or None if not found

Parameters

providerKey (str) –

Return type

QgsProviderGuiMetadata

registerGuis(self, widget: QMainWindow)

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 (QMainWindow) –

sourceSelectProviders(self, providerKey: str)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 (str) –

Return type

List[QgsSourceSelectProvider]

sourceWidgetProviders(self, providerKey: str)List[QgsProviderSourceWidgetProvider]

Returns all source widget providers registered in provider with providerKey

Note

Ownership of providers is passed to the caller.

New in version 3.18.

Parameters

providerKey (str) –

Return type

List[QgsProviderSourceWidgetProvider]

subsetStringEditorProviders(self, providerKey: str)List[QgsSubsetStringEditorProvider]

Returns all subset string editor providers registered in provider with providerKey

Note

Ownership of providers is passed to the caller.

New in version 3.18.

Parameters

providerKey (str) –

Return type

List[QgsSubsetStringEditorProvider]