Class: QgsActionScopeRegistry¶
- class qgis.core.QgsActionScopeRegistry¶
Bases:
PyQt5.QtCore.QObject
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()
New in version 3.0.
QgsActionScopeRegistry(parent: QObject = 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.New in version 3.0:
Methods
Gets an action scope by its id.
Gets all registered action scopes.
Register an additional action scope.
Unregister an additional action scope.
Signals
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
- actionScope(self, id: str) QgsActionScope ¶
Gets an action scope by its id.
New in version 3.0.
- Parameters:
id (str) –
- Return type:
- actionScopes(self) Set[QgsActionScope] ¶
Gets all registered action scopes.
New in version 3.0.
- Return type:
Set[QgsActionScope]
- actionScopesChanged¶
pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL
types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.
- Parameters:
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type:
PYQT_SIGNAL
- childEvent(self, QChildEvent)¶
- connectNotify(self, QMetaMethod)¶
- customEvent(self, QEvent)¶
- disconnectNotify(self, QMetaMethod)¶
- isSignalConnected(self, QMetaMethod) bool ¶
- receivers(self, PYQT_SIGNAL) int ¶
- registerActionScope(self, actionScope: QgsActionScope)¶
Register an additional action scope.
New in version 3.0.
- Parameters:
actionScope (QgsActionScope) –
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- timerEvent(self, QTimerEvent)¶
- unregisterActionScope(self, actionScope: QgsActionScope)¶
Unregister an additional action scope.
New in version 3.0.
- Parameters:
actionScope (QgsActionScope) –