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

#include <qgsactionscoperegistry.h>

Inheritance diagram for QgsActionScopeRegistry:

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

Public Member Functions
	QgsActionScopeRegistry (QObject *parent=nullptr)
	Create a new QgsActionScopeRegistry. More...

QgsActionScope	actionScope (const QString &id)
	Gets an action scope by its id. More...

QSet< QgsActionScope >	actionScopes () const
	Gets all registered action scopes. More...

void	registerActionScope (const QgsActionScope &actionScope)
	Register an additional action scope. More...

void	unregisterActionScope (const QgsActionScope &actionScope)
	Unregister an additional action scope. More...

Properties
QSet< QgsActionScope >	actionScopes

Detailed Description

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

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

QgsApplication::actionScopeRegistry

static QgsActionScopeRegistry * actionScopeRegistry()

Returns the action scope registry.

Definition: qgsapplication.cpp:2069

QgsApplication.actionScopeRegistry()

Since: QGIS 3.0

Definition at line 44 of file qgsactionscoperegistry.h.

Constructor & Destructor Documentation

◆ QgsActionScopeRegistry()

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.

Since: QGIS 3.0

Definition at line 20 of file qgsactionscoperegistry.cpp.

Member Function Documentation

◆ actionScope()

QgsActionScope QgsActionScopeRegistry::actionScope ( const QString & id )

Gets an action scope by its id.

Since: QGIS 3.0

Definition at line 60 of file qgsactionscoperegistry.cpp.

◆ actionScopes()

QSet< QgsActionScope > QgsActionScopeRegistry::actionScopes ( ) const

Gets all registered action scopes.

Since: QGIS 3.0

Definition at line 41 of file qgsactionscoperegistry.cpp.

◆ actionScopesChanged

void QgsActionScopeRegistry::actionScopesChanged ( )

signal

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

Since: QGIS 3.0

◆ registerActionScope()

void QgsActionScopeRegistry::registerActionScope ( const QgsActionScope & actionScope )

Register an additional action scope.

Since: QGIS 3.0

Definition at line 46 of file qgsactionscoperegistry.cpp.

◆ unregisterActionScope()

void QgsActionScopeRegistry::unregisterActionScope ( const QgsActionScope & actionScope )

Unregister an additional action scope.

Since: QGIS 3.0

Definition at line 53 of file qgsactionscoperegistry.cpp.

Property Documentation

◆ actionScopes

QSet<QgsActionScope> QgsActionScopeRegistry::actionScopes

read