Class: QgsProviderGuiRegistry¶
A registry / canonical manager of GUI parts of data providers.
QgsProviderGuiRegistry
is not usually directly created, but
rather accessed through QgsGui.providerGuiRegistry()
.
setPluginPath()
should be called (once) to load dynamic
providers. Static providers are loaded in constructor.
Added in version 3.10.
Methods
Returns all data item gui providers registered in provider with providerKey |
|
Returns all map layer config widget factories associated with the registered providers. |
|
Returns all project storage gui providers registered in provider with providerKey |
|
Returns list of available providers by their keys |
|
Returns metadata of the provider or |
|
Called during GUI initialization - allows providers to do its internal initialization of GUI components, possibly making use of the passed pointer to the QGIS main window. |
|
Returns all source select providers registered in provider with providerKey |
|
Returns all source widget providers registered in provider with providerKey |
|
Returns all subset string editor providers registered in provider with providerKey |
- class qgis.gui.QgsProviderGuiRegistry[source]¶
Bases:
object
- __init__(pluginPath: str | None)
Creates registry and loads static provider plugins
- Parameters:
pluginPath (Optional[str])
- __init__(a0: QgsProviderGuiRegistry)
- Parameters:
- dataItemGuiProviders(self, providerKey: str | None) List[QgsDataItemGuiProvider] ¶
Returns all data item gui providers registered in provider with
providerKey
Note
Ownership of created data item providers is passed to the caller.
- Parameters:
providerKey (Optional[str])
- Return type:
List[QgsDataItemGuiProvider]
- mapLayerConfigWidgetFactories(self, layer: QgsMapLayer | None = None) List[QgsMapLayerConfigWidgetFactory] ¶
Returns all map layer config widget factories associated with the registered providers.
The optional
layer
argument can be used to only return factories which support the specified layer.Added in version 3.20.
- Parameters:
layer (Optional[QgsMapLayer] = None)
- Return type:
- projectStorageGuiProviders(self, providerKey: str | None) List[QgsProjectStorageGuiProvider] ¶
Returns all project storage gui providers registered in provider with
providerKey
Note
Ownership of created project storage gui providers is passed to the caller.
- Parameters:
providerKey (Optional[str])
- Return type:
- providerList(self) List[str] [source]¶
Returns list of available providers by their keys
- Return type:
List[str]
- providerMetadata(self, providerKey: str | None) QgsProviderGuiMetadata | None [source]¶
Returns metadata of the provider or
None
if not found- Parameters:
providerKey (Optional[str])
- Return type:
Optional[QgsProviderGuiMetadata]
- registerGuis(self, widget: QMainWindow | None)[source]¶
Called during GUI initialization - allows providers to do its internal initialization of GUI components, possibly making use of the passed pointer to the QGIS main window.
- Parameters:
widget (Optional[QMainWindow])
- sourceSelectProviders(self, providerKey: str | None) List[QgsSourceSelectProvider] ¶
Returns all source select providers registered in provider with
providerKey
Note
Ownership of created source select providers is passed to the caller.
- Parameters:
providerKey (Optional[str])
- Return type:
List[QgsSourceSelectProvider]
- sourceWidgetProviders(self, providerKey: str | None) List[QgsProviderSourceWidgetProvider] ¶
Returns all source widget providers registered in provider with
providerKey
Note
Ownership of providers is passed to the caller.
Added in version 3.18.
- Parameters:
providerKey (Optional[str])
- Return type:
- subsetStringEditorProviders(self, providerKey: str | None) List[QgsSubsetStringEditorProvider] ¶
Returns all subset string editor providers registered in provider with
providerKey
Note
Ownership of providers is passed to the caller.
Added in version 3.18.
- Parameters:
providerKey (Optional[str])
- Return type: