Class: QgsSourceSelectProviderRegistry¶

A registry for QgsSourceSelectProvider source select providers.

This class keeps a list of source select providers that may add items to the QgsDataSourceManagerDialog When created, it automatically adds providers from data provider plugins (e.g. PostGIS, WMS, …)

QgsSourceSelectProviderRegistry is not usually directly created, but rather accessed through QgsGui.sourceSelectProviderRegistry().

Class Hierarchy¶

Base classes¶

QObject

Methods

`addProvider`	Add a provider implementation.
`createSelectionWidget`	Gets select widget from provider with name
`initializeFromProviderGuiRegistry`	Initializes the registry.
`providerByName`	Returns a provider by name or `None` if not found
`providers`	Gets list of available providers
`providersByKey`	Returns a (possibly empty) list of providers by data providerkey
`removeProvider`	Remove provider implementation from the list (provider object is deleted)

Signals

`providerAdded`	Emitted whenever a provider is added to the registry.
`providerRemoved`	Emitted whenever a provider is removed from the registry.

class qgis.gui.QgsSourceSelectProviderRegistry[source]¶

Bases: QObject

addProvider(self, provider: QgsSourceSelectProvider | None)[source]¶

Add a provider implementation. Takes ownership of the object.

Parameters:: provider (Optional[QgsSourceSelectProvider])

createSelectionWidget(self, name: str | None, parent: QWidget | None, fl: Qt.WindowFlags | Qt.WindowType, widgetMode: QgsProviderRegistry.WidgetMode) → QgsAbstractDataSourceWidget | None[source]¶

Gets select widget from provider with name

The function is replacement of QgsProviderRegistry.createSelectionWidget() from QGIS 3.8

Added in version 3.10.

Parameters:

name (Optional[str])
parent (Optional[QWidget])
fl (Union[Qt.WindowFlags, Qt.WindowType])
widgetMode (QgsProviderRegistry.WidgetMode)

Return type:

Optional[QgsAbstractDataSourceWidget]

initializeFromProviderGuiRegistry(self, providerGuiRegistry: QgsProviderGuiRegistry | None)[source]¶

Initializes the registry. The registry needs to be passed explicitly (instead of using singleton) because this gets called from QgsGui constructor.

Added in version 3.10.

Parameters:: providerGuiRegistry (Optional[QgsProviderGuiRegistry])

signal providerAdded(name: str)[source]¶

Emitted whenever a provider is added to the registry.

Added in version 3.30.

Parameters:: name (str)

providerByName(self, name: str | None) → QgsSourceSelectProvider | None[source]¶

Returns a provider by name or None if not found

Parameters:: name (Optional[str])
Return type:: Optional[QgsSourceSelectProvider]

signal providerRemoved(name: str)[source]¶

Emitted whenever a provider is removed from the registry.

Added in version 3.30.

Parameters:: name (str)

providers(self) → List[QgsSourceSelectProvider]¶

Gets list of available providers

Return type:: List[QgsSourceSelectProvider]

providersByKey(self, providerKey: str | None) → List[QgsSourceSelectProvider]¶

Returns a (possibly empty) list of providers by data providerkey

Parameters:: providerKey (Optional[str])
Return type:: List[QgsSourceSelectProvider]

removeProvider(self, provider: QgsSourceSelectProvider | None) → bool[source]¶

Remove provider implementation from the list (provider object is deleted)

Return type:: bool
Returns:: True if the provider was actually removed and deleted
Parameters:: provider (Optional[QgsSourceSelectProvider])