Class: QgsLayerTreeEmbeddedWidgetRegistry¶
- class qgis.gui.QgsLayerTreeEmbeddedWidgetRegistry¶
Bases:
sip.wrapper
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 throughQgsGui.layerTreeEmbeddedWidgetRegistry()
.See also
New in version 2.16.
QgsLayerTreeEmbeddedWidgetRegistry() Constructor for QgsLayerTreeEmbeddedWidgetRegistry
QgsLayerTreeEmbeddedWidgetRegistry
is not usually directly created, but rather accessed throughQgsGui.layerTreeEmbeddedWidgetRegistry()
.Methods
Register a provider, takes ownership of the object.
Gets provider object from the provider's ID
Returns list of all registered providers
Unregister a provider, the provider object is deleted.
- addProvider(self, provider: QgsLayerTreeEmbeddedWidgetProvider) bool ¶
Register a provider, takes ownership of the object. Returns
True
on success,False
if the provider is already registered.- Parameters:
provider (QgsLayerTreeEmbeddedWidgetProvider) –
- Return type:
bool
- provider(self, providerId: str) QgsLayerTreeEmbeddedWidgetProvider ¶
Gets provider object from the provider’s ID
- Parameters:
providerId (str) –
- Return type:
- providers(self) List[str] ¶
Returns list of all registered providers
- Return type:
List[str]
- removeProvider(self, providerId: str) bool ¶
Unregister a provider, the provider object is deleted. Returns
True
on success,False
if the provider was not registered.- Parameters:
providerId (str) –
- Return type:
bool