Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithmsetvariable.cpp
       3                 :            :                          ---------------------
       4                 :            :     begin                : June 2020
       5                 :            :     copyright            : (C) 2020 by Nyall Dawson
       6                 :            :     email                : nyall dot dawson at gmail dot com
       7                 :            :  ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #include "qgsalgorithmsetvariable.h"
      19                 :            : #include "qgsexpressioncontextutils.h"
      20                 :            : 
      21                 :            : ///@cond PRIVATE
      22                 :            : 
      23                 :          0 : QString QgsSetProjectVariableAlgorithm::name() const
      24                 :            : {
      25                 :          0 :   return QStringLiteral( "setprojectvariable" );
      26                 :            : }
      27                 :            : 
      28                 :          0 : QgsProcessingAlgorithm::Flags QgsSetProjectVariableAlgorithm::flags() const
      29                 :            : {
      30                 :          0 :   return QgsProcessingAlgorithm::FlagHideFromToolbox
      31                 :          0 :          | QgsProcessingAlgorithm::FlagSkipGenericModelLogging
      32                 :          0 :          | QgsProcessingAlgorithm::FlagNotAvailableInStandaloneTool;
      33                 :            : }
      34                 :            : 
      35                 :          0 : QString QgsSetProjectVariableAlgorithm::displayName() const
      36                 :            : {
      37                 :          0 :   return QObject::tr( "Set project variable" );
      38                 :            : }
      39                 :            : 
      40                 :          0 : QStringList QgsSetProjectVariableAlgorithm::tags() const
      41                 :            : {
      42                 :          0 :   return QObject::tr( "expression" ).split( ',' );
      43                 :          0 : }
      44                 :            : 
      45                 :          0 : QString QgsSetProjectVariableAlgorithm::group() const
      46                 :            : {
      47                 :          0 :   return QObject::tr( "Modeler tools" );
      48                 :            : }
      49                 :            : 
      50                 :          0 : QString QgsSetProjectVariableAlgorithm::groupId() const
      51                 :            : {
      52                 :          0 :   return QStringLiteral( "modelertools" );
      53                 :            : }
      54                 :            : 
      55                 :          0 : QString QgsSetProjectVariableAlgorithm::shortDescription() const
      56                 :            : {
      57                 :          0 :   return QObject::tr( "Sets an expression variable for the current project" );
      58                 :            : }
      59                 :            : 
      60                 :          0 : QString QgsSetProjectVariableAlgorithm::shortHelpString() const
      61                 :            : {
      62                 :          0 :   return QObject::tr( "This algorithm sets an expression variable for the current project." );
      63                 :            : }
      64                 :            : 
      65                 :          0 : QgsSetProjectVariableAlgorithm *QgsSetProjectVariableAlgorithm::createInstance() const
      66                 :            : {
      67                 :          0 :   return new QgsSetProjectVariableAlgorithm();
      68                 :            : }
      69                 :            : 
      70                 :          0 : bool QgsSetProjectVariableAlgorithm::prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
      71                 :            : {
      72                 :            :   // this is all nice and quick, we can (and should) do it in the main thread without issue
      73                 :          0 :   const QString name = parameterAsString( parameters, QStringLiteral( "NAME" ), context );
      74                 :          0 :   const QString value = parameterAsString( parameters, QStringLiteral( "VALUE" ), context );
      75                 :            : 
      76                 :          0 :   if ( name.isEmpty() )
      77                 :          0 :     throw QgsProcessingException( QObject::tr( "Variable name cannot be empty" ) );
      78                 :            : 
      79                 :          0 :   QgsExpressionContextUtils::setProjectVariable( context.project(), name, value );
      80                 :          0 :   feedback->pushInfo( QObject::tr( "Set variable \'%1\' to \'%2\'" ).arg( name, value ) );
      81                 :            : 
      82                 :            :   return true;
      83                 :          0 : }
      84                 :            : 
      85                 :          0 : void QgsSetProjectVariableAlgorithm::initAlgorithm( const QVariantMap & )
      86                 :            : {
      87                 :          0 :   addParameter( new QgsProcessingParameterString( QStringLiteral( "NAME" ), QObject::tr( "Variable name" ) ) );
      88                 :          0 :   addParameter( new QgsProcessingParameterString( QStringLiteral( "VALUE" ), QObject::tr( "Variable value" ) ) );
      89                 :          0 : }
      90                 :            : 
      91                 :          0 : QVariantMap QgsSetProjectVariableAlgorithm::processAlgorithm( const QVariantMap &, QgsProcessingContext &, QgsProcessingFeedback * )
      92                 :            : {
      93                 :          0 :   return QVariantMap();
      94                 :            : }
      95                 :            : 
      96                 :            : ///@endcond