Class: QgsProviderSourceWidgetProviderRegistry

class qgis.gui.QgsProviderSourceWidgetProviderRegistry

Bases: sip.wrapper

This class keeps a list of provider source widget providers.

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

Added in version 3.18:

Methods

addProvider	Add a provider implementation.
createWidget	Creates a new widget to configure the source of the specified layer.
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)

addProvider(self, provider: QgsProviderSourceWidgetProvider | None)

Add a provider implementation. Takes ownership of the object.

Parameters:

provider (Optional[QgsProviderSourceWidgetProvider])

createWidget(self, layer: QgsMapLayer | None, parent: QWidget | None = None) → QgsProviderSourceWidget | None

Creates a new widget to configure the source of the specified layer. It may return None if no provider was found. The returned object must be destroyed by the caller.

Parameters:

• layer (Optional[QgsMapLayer])

• parent (Optional[QWidget] = None)

Return type:

Optional[QgsProviderSourceWidget]

initializeFromProviderGuiRegistry(self, providerGuiRegistry: QgsProviderGuiRegistry | None)

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

Parameters:

providerGuiRegistry (Optional[QgsProviderGuiRegistry])

providerByName(self, name: str | None) → QgsProviderSourceWidgetProvider | None

Returns a provider by name or None if not found

Parameters:

name (Optional[str])

Return type:

Optional[QgsProviderSourceWidgetProvider]

providers(self) → List[QgsProviderSourceWidgetProvider]

Gets list of available providers

Return type:

List[QgsProviderSourceWidgetProvider]

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

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

Parameters:

providerKey (Optional[str])

Return type:

List[QgsProviderSourceWidgetProvider]

removeProvider(self, provider: QgsProviderSourceWidgetProvider | None) → bool

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[QgsProviderSourceWidgetProvider])