Class: QgsLayerTreeEmbeddedWidgetProvider

Provider interface to be implemented in order to introduce new kinds of embedded widgets for use in layer tree.

Embedded widgets are assigned per individual map layers and they are shown before any legend entries.

See also

QgsLayerTreeEmbeddedWidgetRegistry

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: createWidget(), id(), name(), supportsLayer()

Abstract Methods

createWidget	Factory to create widgets.
id	Unique name of the provider (among other providers)
name	Human readable name - may be translatable with tr()
supportsLayer	Whether it makes sense to use this widget for a particular layer

class qgis.gui.QgsLayerTreeEmbeddedWidgetProvider

Bases: object

abstract createWidget(self, layer: QgsMapLayer | None, widgetIndex: int) → QWidget | None

Factory to create widgets. The returned widget is owned by the caller. The widgetIndex argument may be used to identify which widget is being created (useful when using multiple widgets from the same provider for one layer).

Parameters:

• layer (Optional[QgsMapLayer])

• widgetIndex (int)

Return type:

Optional[QWidget]

abstract id(self) → str

Unique name of the provider (among other providers)

Return type:

str

abstract name(self) → str

Human readable name - may be translatable with tr()

Return type:

str

abstract supportsLayer(self, layer: QgsMapLayer | None) → bool

Whether it makes sense to use this widget for a particular layer

Parameters:

layer (Optional[QgsMapLayer])

Return type:

bool