QgsActionScopeRegistry class

The action scope registry is an application wide registry that contains a list of available action scopes.

Contents

Some scopes are available by default, additional ones can be registered at runtime by plugins or custom applications.

To get access use the QgsApplication:

QgsApplication::actionScopeRegistry()

Constructors, destructors, conversion operators

QgsActionScopeRegistry(QObject* parent = nullptr) explicit
Create a new QgsActionScopeRegistry.

Public functions

auto actionScope(const QString& id) -> QgsActionScope
Gets an action scope by its id.
auto actionScopes() const -> QSet<QgsActionScope>
Gets all registered action scopes.
void registerActionScope(const QgsActionScope& actionScope)
Register an additional action scope.
void unregisterActionScope(const QgsActionScope& actionScope)
Unregister an additional action scope.

Signals

void actionScopesChanged()
Emitted whenever a new action scope is registered or an action scope is unregistered.

Function documentation

QgsActionScopeRegistry::QgsActionScopeRegistry(QObject* parent = nullptr) explicit

Create a new QgsActionScopeRegistry.

QGIS already creates a central registry. You will normally want to use QgsApplication::actionScopeRegistry() to get access to that one instead.

QgsActionScope QgsActionScopeRegistry::actionScope(const QString& id)

Gets an action scope by its id.

QSet<QgsActionScope> QgsActionScopeRegistry::actionScopes() const

Gets all registered action scopes.

void QgsActionScopeRegistry::registerActionScope(const QgsActionScope& actionScope)

Register an additional action scope.

void QgsActionScopeRegistry::unregisterActionScope(const QgsActionScope& actionScope)

Unregister an additional action scope.

void QgsActionScopeRegistry::actionScopesChanged() signal

Emitted whenever a new action scope is registered or an action scope is unregistered.