Class: QgsDataItemProviderRegistry¶
- class qgis.core.QgsDataItemProviderRegistry¶
Bases:
PyQt5.QtCore.QObject
This class keeps a list of 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 throughQgsApplication.dataItemProviderRegistry()
.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 NULL) data item provider named
providerName
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
- addProvider(self, provider: QgsDataItemProvider)¶
Adds a
provider
implementation to the registry. Ownership of the provider is transferred to the registry.- Parameters
provider (QgsDataItemProvider) –
- childEvent(self, QChildEvent)¶
- connectNotify(self, QMetaMethod)¶
- customEvent(self, QEvent)¶
- dataProviderKey(self, dataItemProviderName: str) → str¶
Returns the (possibly blank) data provider key for a given data item provider name.
- Parameters
dataItemProviderName (str) – name of the data item provider
New in version 3.14.
- Return type
str
- disconnectNotify(self, QMetaMethod)¶
- isSignalConnected(self, QMetaMethod) → bool¶
- provider(self, providerName: str) → QgsDataItemProvider¶
Returns the (possibly NULL) data item provider named
providerName
New in version 3.14.
- Parameters
providerName (str) –
- Return type
- providerAdded¶
Emitted when a new data item provider has been added.
New in version 3.14: [signal]
- Parameters
provider (QgsDataItemProvider) –
- providerWillBeRemoved¶
Emitted when a data item provider is about to be removed
New in version 3.14: [signal]
- Parameters
provider (QgsDataItemProvider) –
- providers(self) → List[QgsDataItemProvider]¶
Returns the list of available providers.
- Return type
List[QgsDataItemProvider]
- receivers(self, PYQT_SIGNAL) → int¶
- removeProvider(self, provider: QgsDataItemProvider)¶
Removes a
provider
implementation from the registry. The provider object is automatically deleted.- Parameters
provider (QgsDataItemProvider) –
- sender(self) → QObject¶
- senderSignalIndex(self) → int¶
- timerEvent(self, QTimerEvent)¶