QgsLayerTreeEmbeddedWidgetRegistry class

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

Contents

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

Constructors, destructors, conversion operators

QgsLayerTreeEmbeddedWidgetRegistry()
Constructor for QgsLayerTreeEmbeddedWidgetRegistry/.
QgsLayerTreeEmbeddedWidgetRegistry(const QgsLayerTreeEmbeddedWidgetRegistry& other) deleted
QgsLayerTreeEmbeddedWidgetRegistry cannot be copied.

Public functions

auto addProvider(QgsLayerTreeEmbeddedWidgetProvider* provider) -> bool
Register a provider, takes ownership of the object.
auto operator=(const QgsLayerTreeEmbeddedWidgetRegistry& other) -> QgsLayerTreeEmbeddedWidgetRegistry& deleted
QgsLayerTreeEmbeddedWidgetRegistry cannot be copied.
auto provider(const QString& providerId) const -> QgsLayerTreeEmbeddedWidgetProvider*
Gets provider object from the provider's ID.
auto providers() const -> QStringList
Returns list of all registered providers.
auto removeProvider(const QString& providerId) -> bool
Unregister a provider, the provider object is deleted.

Protected variables

QMap<QString, QgsLayerTreeEmbeddedWidgetProvider*> mProviders
storage of all the providers

Function documentation

QgsLayerTreeEmbeddedWidgetRegistry::QgsLayerTreeEmbeddedWidgetRegistry()

Constructor for QgsLayerTreeEmbeddedWidgetRegistry/.

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

bool QgsLayerTreeEmbeddedWidgetRegistry::addProvider(QgsLayerTreeEmbeddedWidgetProvider* provider)

Register a provider, takes ownership of the object.

Returns true on success, false if the provider is already registered.

bool QgsLayerTreeEmbeddedWidgetRegistry::removeProvider(const QString& providerId)

Unregister a provider, the provider object is deleted.

Returns true on success, false if the provider was not registered.