Class: QgsActionScopeRegistry

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

Class Hierarchy

Inheritance diagram of qgis.core.QgsActionScopeRegistry

Base classes

QObject

Methods

actionScope

Gets an action scope by its id.

actionScopes

Gets all registered action scopes.

registerActionScope

Register an additional action scope.

unregisterActionScope

Unregister an additional action scope.

Signals

actionScopesChanged

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

class qgis.core.QgsActionScopeRegistry[source]

Bases: QObject

__init__(parent: QObject | None = None)

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.

Parameters:

parent (Optional[QObject] = None)

actionScope(self, id: str | None) QgsActionScope[source]

Gets an action scope by its id.

Parameters:

id (Optional[str])

Return type:

QgsActionScope

actionScopes(self) Set[QgsActionScope]

Gets all registered action scopes.

Return type:

Set[QgsActionScope]

signal actionScopesChanged[source]

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

registerActionScope(self, actionScope: QgsActionScope)[source]

Register an additional action scope.

Parameters:

actionScope (QgsActionScope)

unregisterActionScope(self, actionScope: QgsActionScope)[source]

Unregister an additional action scope.

Parameters:

actionScope (QgsActionScope)