QGIS API Documentation  3.8.0-Zanzibar (11aff65)
qgsactionscoperegistry.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  qgsactionscoperegistry.cpp - QgsActionScopeRegistry
3 
4  ---------------------
5  begin : 1.11.2016
6  copyright : (C) 2016 by Matthias Kuhn
7  email : matthias@opengis.ch
8  ***************************************************************************
9  * *
10  * This program is free software; you can redistribute it and/or modify *
11  * it under the terms of the GNU General Public License as published by *
12  * the Free Software Foundation; either version 2 of the License, or *
13  * (at your option) any later version. *
14  * *
15  ***************************************************************************/
16 #include "qgsactionscoperegistry.h"
17 
18 #include "qgsexpressioncontext.h"
19 
21  : QObject( parent )
22 {
23  // Register some default action scopes:
24 
25  QgsExpressionContextScope canvasScope;
26  canvasScope.addVariable( QgsExpressionContextScope::StaticVariable( QStringLiteral( "clicked_x" ), 25, true ) );
27  canvasScope.addVariable( QgsExpressionContextScope::StaticVariable( QStringLiteral( "clicked_y" ), 30, true ) );
28  mActionScopes.insert( QgsActionScope( QStringLiteral( "Canvas" ), tr( "Canvas" ), tr( "Available for the action map tool on the canvas." ), canvasScope ) );
29 
30  QgsExpressionContextScope fieldScope;
31  fieldScope.addVariable( QgsExpressionContextScope::StaticVariable( QStringLiteral( "field_index" ), 0, true ) );
32  fieldScope.addVariable( QgsExpressionContextScope::StaticVariable( QStringLiteral( "field_name" ), "[field_name]", true ) );
33  fieldScope.addVariable( QgsExpressionContextScope::StaticVariable( QStringLiteral( "field_value" ), "[field_value]", true ) );
34 
35  mActionScopes.insert( QgsActionScope( QStringLiteral( "Field" ), tr( "Field Scope" ), tr( "Available for individual fields. For example in the attribute table." ), fieldScope ) );
36  mActionScopes.insert( QgsActionScope( QStringLiteral( "Feature" ), tr( "Feature Scope" ), tr( "Available for individual features. For example on feature forms or per row in the attribute table." ) ) );
37  mActionScopes.insert( QgsActionScope( QStringLiteral( "Layer" ), tr( "Layer Scope" ), tr( "Available as layer global action. For example on top of the attribute table." ) ) );
38 }
39 
40 QSet<QgsActionScope> QgsActionScopeRegistry::actionScopes() const
41 {
42  return mActionScopes;
43 }
44 
46 {
47  mActionScopes.insert( actionScope );
48 
49  emit actionScopesChanged();
50 }
51 
53 {
54  mActionScopes.remove( actionScope );
55 
56  emit actionScopesChanged();
57 }
58 
60 {
61  const auto constMActionScopes = mActionScopes;
62  for ( const QgsActionScope &actionScope : constMActionScopes )
63  {
64  if ( actionScope.id() == id )
65  {
66  return actionScope;
67  }
68  }
69 
70  return QgsActionScope();
71 }
Single variable definition for use within a QgsExpressionContextScope.
void registerActionScope(const QgsActionScope &actionScope)
Register an additional action scope.
QString id() const
A unique identifier for this action scope.
void unregisterActionScope(const QgsActionScope &actionScope)
Unregister an additional action scope.
void addVariable(const QgsExpressionContextScope::StaticVariable &variable)
Adds a variable into the context scope.
An action scope defines a "place" for an action to be shown and may add additional expression variabl...
void actionScopesChanged()
Emitted whenever a new action scope is registered or an action scope is unregistered.
QgsActionScope actionScope(const QString &id)
Gets an action scope by its id.
QgsActionScopeRegistry(QObject *parent=nullptr)
Create a new QgsActionScopeRegistry.
Single scope for storing variables and functions for use within a QgsExpressionContext.
QSet< QgsActionScope > actionScopes() const
Gets all registered action scopes.