Class: QgsLayerTreeEmbeddedWidgetRegistry¶

Registry of widgets that may be embedded into layer tree view.

Embedded widgets are assigned per individual map layers and they are shown before any legend entries. Layer tree must have UseEmbeddedWidgets flag enabled in order to show assigned widgets.

QgsLayerTreeEmbeddedWidgetRegistry is not usually directly created, but rather accessed through QgsGui.layerTreeEmbeddedWidgetRegistry().

See also

QgsLayerTreeEmbeddedWidgetRegistry

Methods

`addProvider`	Register a provider, takes ownership of the object.
`provider`	Gets provider object from the provider's ID
`providers`	Returns list of all registered providers
`removeProvider`	Unregister a provider, the provider object is deleted.

class qgis.gui.QgsLayerTreeEmbeddedWidgetRegistry[source]¶

Bases: object

__init__()

Constructor for QgsLayerTreeEmbeddedWidgetRegistry

QgsLayerTreeEmbeddedWidgetRegistry is not usually directly created, but rather accessed through QgsGui.layerTreeEmbeddedWidgetRegistry().

addProvider(self, provider: QgsLayerTreeEmbeddedWidgetProvider | None) → bool[source]¶

Register a provider, takes ownership of the object. Returns True on success, False if the provider is already registered.

Parameters:: provider (Optional[QgsLayerTreeEmbeddedWidgetProvider])
Return type:: bool

provider(self, providerId: str | None) → QgsLayerTreeEmbeddedWidgetProvider | None[source]¶

Gets provider object from the provider’s ID

Parameters:: providerId (Optional[str])
Return type:: Optional[QgsLayerTreeEmbeddedWidgetProvider]

providers(self) → List[str][source]¶

Returns list of all registered providers

Return type:: List[str]

removeProvider(self, providerId: str | None) → bool[source]¶

Unregister a provider, the provider object is deleted. Returns True on success, False if the provider was not registered.

Parameters:: providerId (Optional[str])
Return type:: bool