QGIS/python/core/auto_generated/actions/qgsactionscoperegistry.sip.in
2022-11-23 08:25:33 +01:00

90 lines
2.5 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/actions/qgsactionscoperegistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsActionScopeRegistry : QObject
{
%Docstring(signature="appended")
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 :py:class:`QgsApplication`:
.. code-block:: python
QgsApplication.actionScopeRegistry()
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgsactionscoperegistry.h"
%End
public:
explicit QgsActionScopeRegistry( QObject *parent = 0 );
%Docstring
Create a new QgsActionScopeRegistry.
QGIS already creates a central registry. You will normally
want to use :py:func:`QgsApplication.actionScopeRegistry()` to get access
to that one instead.
.. versionadded:: 3.0
%End
QSet<QgsActionScope> actionScopes() const;
%Docstring
Gets all registered action scopes.
.. versionadded:: 3.0
%End
void registerActionScope( const QgsActionScope &actionScope );
%Docstring
Register an additional action scope.
.. versionadded:: 3.0
%End
void unregisterActionScope( const QgsActionScope &actionScope );
%Docstring
Unregister an additional action scope.
.. versionadded:: 3.0
%End
QgsActionScope actionScope( const QString &id );
%Docstring
Gets an action scope by its id.
.. versionadded:: 3.0
%End
signals:
void actionScopesChanged();
%Docstring
Emitted whenever a new action scope is registered or an action scope
is unregistered.
.. versionadded:: 3.0
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/actions/qgsactionscoperegistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/