QGIS/python/core/auto_generated/qgsactionscoperegistry.sip.in

89 lines
2.4 KiB
Plaintext
Raw Normal View History

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsactionscoperegistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
2017-03-30 17:54:46 +02:00
class QgsActionScopeRegistry : QObject
{
2017-03-30 17:54:46 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
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.
2017-03-30 17:54:46 +02:00
2017-12-15 10:36:55 -04:00
To get access use the QgsApplication:
2017-03-30 17:54:46 +02:00
2017-12-15 10:36:55 -04:00
```
2017-12-19 11:43:52 -04:00
:py:func:`QgsApplication.actionScopeRegistry()`
2017-12-15 10:36:55 -04:00
```
2017-03-30 17:54:46 +02:00
.. versionadded:: 3.0
2017-03-30 17:54:46 +02:00
%End
%TypeHeaderCode
#include "qgsactionscoperegistry.h"
%End
public:
2017-03-30 17:54:46 +02:00
explicit QgsActionScopeRegistry( QObject *parent = 0 );
%Docstring
2017-12-15 10:36:55 -04:00
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.
2017-03-30 17:54:46 +02:00
.. versionadded:: 3.0
2017-03-30 17:54:46 +02:00
%End
QSet<QgsActionScope> actionScopes() const;
2017-03-30 17:54:46 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Get all registered action scopes.
.. versionadded:: 3.0
2017-03-30 17:54:46 +02:00
%End
2017-03-30 17:54:46 +02:00
void registerActionScope( const QgsActionScope &actionScope );
%Docstring
2017-12-15 10:36:55 -04:00
Register an additional action scope.
2017-03-30 17:54:46 +02:00
.. versionadded:: 3.0
2017-03-30 17:54:46 +02:00
%End
void unregisterActionScope( const QgsActionScope &actionScope );
%Docstring
2017-12-15 10:36:55 -04:00
Unregister an additional action scope.
2017-03-30 17:54:46 +02:00
.. versionadded:: 3.0
2017-03-30 17:54:46 +02:00
%End
QgsActionScope actionScope( const QString &id );
%Docstring
2017-12-15 10:36:55 -04:00
Get an action scope by its id.
.. versionadded:: 3.0
2017-03-30 17:54:46 +02:00
%End
signals:
2017-03-30 17:54:46 +02:00
void actionScopesChanged();
2017-03-30 17:54:46 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Emitted whenever a new action scope is registered or an action scope
is unregistered.
2017-03-30 17:54:46 +02:00
.. versionadded:: 3.0
2017-03-30 17:54:46 +02:00
%End
};
2017-03-30 17:54:46 +02:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsactionscoperegistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/