Class: QgsDataItemGuiProviderRegistry¶
A registry for data item GUI providers that may affect how
QgsDataItems
behave within the application GUI.
QgsDataItemGuiProviderRegistry
is not usually directly
created, but rather accessed through
QgsGui.instance()
->:py:func:dataItemGuiProviderRegistry() <qgis.gui.QgsDataItemGuiProviderRegistry.dataItemGuiProviderRegistry>.
Added in version 3.6.
Methods
Adds a provider implementation to the registry. |
|
Initializes the registry. |
|
Returns the list of available providers. |
|
Removes a provider implementation from the registry. |
- class qgis.gui.QgsDataItemGuiProviderRegistry[source]¶
Bases:
object
- addProvider(self, provider: QgsDataItemGuiProvider | None)[source]¶
Adds a
provider
implementation to the registry. Ownership of the provider is transferred to the registry.- Parameters:
provider (Optional[QgsDataItemGuiProvider])
- 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])
- providers(self) List[QgsDataItemGuiProvider] ¶
Returns the list of available providers.
- Return type:
List[QgsDataItemGuiProvider]
- removeProvider(self, provider: QgsDataItemGuiProvider | None)[source]¶
Removes a
provider
implementation from the registry. The provider object is automatically deleted.- Parameters:
provider (Optional[QgsDataItemGuiProvider])