Branch data     Line data    Source code

       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                 :            : 
      20                 :          5 : QgsActionScopeRegistry::QgsActionScopeRegistry( QObject *parent )
      21                 :          5 :   : QObject( parent )
      22                 :         10 : {
      23                 :            :   // Register some default action scopes:
      24                 :            : 
      25                 :          5 :   QgsExpressionContextScope canvasScope;
      26                 :         10 :   canvasScope.addVariable( QgsExpressionContextScope::StaticVariable( QStringLiteral( "clicked_x" ), 25, true ) );
      27                 :         10 :   canvasScope.addVariable( QgsExpressionContextScope::StaticVariable( QStringLiteral( "clicked_y" ), 30, true ) );
      28                 :         10 :   mActionScopes.insert( QgsActionScope( QStringLiteral( "Canvas" ), tr( "Canvas" ), tr( "Available for the action map tool on the canvas." ), canvasScope ) );
      29                 :            : 
      30                 :          5 :   QgsExpressionContextScope fieldScope;
      31                 :         10 :   fieldScope.addVariable( QgsExpressionContextScope::StaticVariable( QStringLiteral( "field_index" ), 0, true ) );
      32                 :         10 :   fieldScope.addVariable( QgsExpressionContextScope::StaticVariable( QStringLiteral( "field_name" ), "[field_name]", true ) );
      33                 :         10 :   fieldScope.addVariable( QgsExpressionContextScope::StaticVariable( QStringLiteral( "field_value" ), "[field_value]", true ) );
      34                 :            : 
      35                 :         10 :   mActionScopes.insert( QgsActionScope( QStringLiteral( "Field" ), tr( "Field" ), tr( "Available for individual fields. For example in the attribute table." ), fieldScope ) );
      36                 :         10 :   mActionScopes.insert( QgsActionScope( QStringLiteral( "Feature" ), tr( "Feature" ), tr( "Available for individual features. For example on feature forms or per row in the attribute table." ) ) );
      37                 :         10 :   mActionScopes.insert( QgsActionScope( QStringLiteral( "Layer" ), tr( "Layer" ), tr( "Available as layer global action. For example on top of the attribute table." ) ) );
      38                 :          5 : }
      39                 :            : 
      40                 :          0 : QSet<QgsActionScope> QgsActionScopeRegistry::actionScopes() const
      41                 :            : {
      42                 :          0 :   return mActionScopes;
      43                 :            : }
      44                 :            : 
      45                 :          0 : void QgsActionScopeRegistry::registerActionScope( const QgsActionScope &actionScope )
      46                 :            : {
      47                 :          0 :   mActionScopes.insert( actionScope );
      48                 :            : 
      49                 :          0 :   emit actionScopesChanged();
      50                 :          0 : }
      51                 :            : 
      52                 :          0 : void QgsActionScopeRegistry::unregisterActionScope( const QgsActionScope &actionScope )
      53                 :            : {
      54                 :          0 :   mActionScopes.remove( actionScope );
      55                 :            : 
      56                 :          0 :   emit actionScopesChanged();
      57                 :          0 : }
      58                 :            : 
      59                 :          0 : QgsActionScope QgsActionScopeRegistry::actionScope( const QString &id )
      60                 :            : {
      61                 :          0 :   const auto constMActionScopes = mActionScopes;
      62                 :          0 :   for ( const QgsActionScope &actionScope : constMActionScopes )
      63                 :            :   {
      64                 :          0 :     if ( actionScope.id() == id )
      65                 :            :     {
      66                 :          0 :       return actionScope;
      67                 :            :     }
      68                 :            :   }
      69                 :            : 
      70                 :          0 :   return QgsActionScope();
      71                 :          0 : }