Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithmapplylayerstyle.cpp
       3                 :            :                          ---------------------
       4                 :            :     begin                : December 2019
       5                 :            :     copyright            : (C) 2017 by Alexander Bruy
       6                 :            :     email                : alexander dot bruy 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 "qgsalgorithmapplylayerstyle.h"
      19                 :            : 
      20                 :            : ///@cond PRIVATE
      21                 :            : 
      22                 :          0 : QString QgsApplyLayerStyleAlgorithm::name() const
      23                 :            : {
      24                 :          0 :   return QStringLiteral( "setlayerstyle" );
      25                 :            : }
      26                 :            : 
      27                 :          0 : QString QgsApplyLayerStyleAlgorithm::displayName() const
      28                 :            : {
      29                 :          0 :   return QObject::tr( "Set layer style" );
      30                 :            : }
      31                 :            : 
      32                 :          0 : QStringList QgsApplyLayerStyleAlgorithm::tags() const
      33                 :            : {
      34                 :          0 :   return QObject::tr( "change,layer,style,qml" ).split( ',' );
      35                 :          0 : }
      36                 :            : 
      37                 :          0 : QString QgsApplyLayerStyleAlgorithm::group() const
      38                 :            : {
      39                 :          0 :   return QObject::tr( "Cartography" );
      40                 :            : }
      41                 :            : 
      42                 :          0 : QString QgsApplyLayerStyleAlgorithm::groupId() const
      43                 :            : {
      44                 :          0 :   return QStringLiteral( "cartography" );
      45                 :            : }
      46                 :            : 
      47                 :          0 : QString QgsApplyLayerStyleAlgorithm::shortHelpString() const
      48                 :            : {
      49                 :          0 :   return QObject::tr( "Applies the style to a layer. The style must be defined as QML file." );
      50                 :            : }
      51                 :            : 
      52                 :          0 : QgsApplyLayerStyleAlgorithm *QgsApplyLayerStyleAlgorithm::createInstance() const
      53                 :            : {
      54                 :          0 :   return new QgsApplyLayerStyleAlgorithm();
      55                 :            : }
      56                 :            : 
      57                 :          0 : void QgsApplyLayerStyleAlgorithm::initAlgorithm( const QVariantMap & )
      58                 :            : {
      59                 :          0 :   addParameter( new QgsProcessingParameterMapLayer( QStringLiteral( "INPUT" ), QObject::tr( "Layer" ) ) );
      60                 :          0 :   addParameter( new QgsProcessingParameterFile( QStringLiteral( "STYLE" ), QObject::tr( "Style file" ),  QgsProcessingParameterFile::File, QStringLiteral( "qml" ) ) );
      61                 :          0 :   addOutput( new QgsProcessingOutputMapLayer( QStringLiteral( "OUTPUT" ), QObject::tr( "Styled" ) ) );
      62                 :          0 : }
      63                 :            : 
      64                 :          0 : bool QgsApplyLayerStyleAlgorithm::prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * )
      65                 :            : {
      66                 :          0 :   QgsMapLayer *layer = parameterAsLayer( parameters, QStringLiteral( "INPUT" ), context );
      67                 :          0 :   QString style = parameterAsFile( parameters, QStringLiteral( "STYLE" ), context );
      68                 :            : 
      69                 :          0 :   if ( !layer )
      70                 :          0 :     throw QgsProcessingException( QObject::tr( "Invalid input layer" ) );
      71                 :            : 
      72                 :          0 :   mLayerId = layer->id();
      73                 :            : 
      74                 :          0 :   bool ok = false;
      75                 :          0 :   QString msg = layer->loadNamedStyle( style, ok );
      76                 :          0 :   if ( !ok )
      77                 :            :   {
      78                 :          0 :     throw QgsProcessingException( QObject::tr( "Failed to apply style. Error: %1" ).arg( msg ) );
      79                 :            :   }
      80                 :          0 :   layer->triggerRepaint();
      81                 :            : 
      82                 :            :   return true;
      83                 :          0 : }
      84                 :            : 
      85                 :          0 : QVariantMap QgsApplyLayerStyleAlgorithm::processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * )
      86                 :            : {
      87                 :          0 :   Q_UNUSED( parameters );
      88                 :          0 :   Q_UNUSED( context );
      89                 :            : 
      90                 :          0 :   QVariantMap results;
      91                 :          0 :   results.insert( QStringLiteral( "OUTPUT" ), mLayerId );
      92                 :          0 :   return results;
      93                 :          0 : }
      94                 :            : 
      95                 :            : ///@endcond