QgsLayerTreeEmbeddedWidgetProvider class

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

Contents

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

Public functions

auto createWidget(QgsMapLayer* layer, int widgetIndex) -> QWidget* pure virtual
Factory to create widgets.
auto id() const -> QString pure virtual
Unique name of the provider (among other providers)
auto name() const -> QString pure virtual
Human readable name - may be translatable with tr()
auto supportsLayer(QgsMapLayer* layer) -> bool pure virtual
Whether it makes sense to use this widget for a particular layer.

Function documentation

QWidget* QgsLayerTreeEmbeddedWidgetProvider::createWidget(QgsMapLayer* layer, int widgetIndex) pure virtual

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).