Class: QgsDataItemProviderRegistry

A registry for data item providers that may add items to the browser tree.

When created, it automatically adds providers from provider plugins (e.g. PostGIS, WMS, …)

QgsDataItemProviderRegistry is not usually directly created, but rather accessed through QgsApplication.dataItemProviderRegistry().

Class Hierarchy

Inheritance diagram of qgis.core.QgsDataItemProviderRegistry

Base classes

QObject

Methods

addProvider

Adds a provider implementation to the registry.

dataProviderKey

Returns the (possibly blank) data provider key for a given data item provider name.

provider

Returns the (possibly None) data item provider named providerName

providers

Returns the list of available providers.

removeProvider

Removes a provider implementation from the registry.

Signals

providerAdded

Emitted when a new data item provider has been added.

providerWillBeRemoved

Emitted when a data item provider is about to be removed

class qgis.core.QgsDataItemProviderRegistry[source]

Bases: QObject

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

Adds a provider implementation to the registry. Ownership of the provider is transferred to the registry.

Parameters:

provider (Optional[QgsDataItemProvider])

dataProviderKey(self, dataItemProviderName: str | None) str[source]

Returns the (possibly blank) data provider key for a given data item provider name.

Parameters:

dataItemProviderName (Optional[str]) – name of the data item provider

Added in version 3.14.

Return type:

str

provider(self, providerName: str | None) QgsDataItemProvider | None[source]

Returns the (possibly None) data item provider named providerName

Added in version 3.14.

Parameters:

providerName (Optional[str])

Return type:

Optional[QgsDataItemProvider]

signal providerAdded(provider: QgsDataItemProvider)[source]

Emitted when a new data item provider has been added.

Added in version 3.14.

Parameters:

provider (QgsDataItemProvider)

signal providerWillBeRemoved(provider: QgsDataItemProvider)[source]

Emitted when a data item provider is about to be removed

Added in version 3.14.

Parameters:

provider (QgsDataItemProvider)

providers(self) List[QgsDataItemProvider]

Returns the list of available providers.

Return type:

List[QgsDataItemProvider]

removeProvider(self, provider: QgsDataItemProvider | None)[source]

Removes a provider implementation from the registry. The provider object is automatically deleted.

Parameters:

provider (Optional[QgsDataItemProvider])