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¶
Base classes¶
Methods
Adds a provider implementation to the registry. |
|
Returns the (possibly blank) data provider key for a given data item provider name. |
|
Returns the (possibly |
|
Returns the list of available providers. |
|
Removes a provider implementation from the registry. |
Signals
Emitted when a new data item provider has been added. |
|
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 namedproviderName
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])