Class: QgsLayerTreeEmbeddedWidgetProvider¶
- class qgis.gui.QgsLayerTreeEmbeddedWidgetProvider¶
Bases:
sip.wrapper
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
Methods
Factory to create widgets.
Unique name of the provider (among other providers)
Human readable name - may be translatable with
tr()
Whether it makes sense to use this widget for a particular layer
- createWidget(self, layer: QgsMapLayer, widgetIndex: int) → QWidget¶
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 (QgsMapLayer) –
widgetIndex (int) –
- Return type
QWidget
- id(self) → str¶
Unique name of the provider (among other providers)
- Return type
str
- name(self) → str¶
Human readable name - may be translatable with
tr()
- Return type
str
- supportsLayer(self, layer: QgsMapLayer) → bool¶
Whether it makes sense to use this widget for a particular layer
- Parameters
layer (QgsMapLayer) –
- Return type
bool