Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsprojectstylealgorithms.h
       3                 :            :                          ---------------------
       4                 :            :     begin                : July 2019
       5                 :            :     copyright            : (C) 2019 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                 :            : #ifndef QGSPROJECTSTYLESALGORITHMS_H
      19                 :            : #define QGSPROJECTSTYLESALGORITHMS_H
      20                 :            : 
      21                 :            : #define SIP_NO_FILE
      22                 :            : 
      23                 :            : #include "qgis_sip.h"
      24                 :            : #include "qgis_analysis.h"
      25                 :            : #include "qgsprocessingalgorithm.h"
      26                 :            : #include "qgsstyle.h"
      27                 :            : #include "qgsstyleentityvisitor.h"
      28                 :            : 
      29                 :            : ///@cond PRIVATE
      30                 :            : 
      31                 :            : /**
      32                 :            :  * \class QgsSaveToStyleVisitor
      33                 :            :  * \ingroup analysis
      34                 :            :  * \brief Style entity visitor which saves encountered style entities to a QgsStyle database.
      35                 :            :  * \since QGIS 3.10
      36                 :            :  */
      37                 :          0 : class ANALYSIS_EXPORT QgsSaveToStyleVisitor : public QgsStyleEntityVisitorInterface
      38                 :            : {
      39                 :            :   public:
      40                 :            : 
      41                 :            :     /**
      42                 :            :      * Constructor for QgsSaveToStyleVisitor, saving encountered objects to the specified
      43                 :            :      * \a style database (which must already be initialized). The \a objects list
      44                 :            :      * dictates which entity types should be saved to the style.
      45                 :            :      *
      46                 :            :      * An empty \a objects list indicates all entity types should be saved.
      47                 :            :      */
      48                 :            :     QgsSaveToStyleVisitor( QgsStyle *style, const QList< QgsStyle::StyleEntity > &objects = QList< QgsStyle::StyleEntity >() );
      49                 :            : 
      50                 :            :     bool visit( const QgsStyleEntityVisitorInterface::StyleLeaf &entity ) override;
      51                 :            :     bool visitEnter( const QgsStyleEntityVisitorInterface::Node &node ) override;
      52                 :            :     bool visitExit( const QgsStyleEntityVisitorInterface::Node &node ) override;
      53                 :            : 
      54                 :            :   private:
      55                 :            : 
      56                 :            :     QgsStyle *mStyle = nullptr;
      57                 :            :     QList< QgsStyle::StyleEntity > mObjects;
      58                 :            :     QStringList mParentNames;
      59                 :            : 
      60                 :            : };
      61                 :            : 
      62                 :            : /**
      63                 :            :  * Native create style from project algorithm
      64                 :            :  */
      65                 :            : class QgsStyleFromProjectAlgorithm : public QgsProcessingAlgorithm
      66                 :            : {
      67                 :            : 
      68                 :            :   public:
      69                 :            : 
      70                 :            :     QgsStyleFromProjectAlgorithm();
      71                 :            :     ~QgsStyleFromProjectAlgorithm() override;
      72                 :            :     void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
      73                 :            :     QString name() const override;
      74                 :            :     QString displayName() const override;
      75                 :            :     QStringList tags() const override;
      76                 :            :     QString group() const override;
      77                 :            :     QString groupId() const override;
      78                 :            :     QString shortHelpString() const override;
      79                 :            :     QString shortDescription() const override;
      80                 :            :     QgsStyleFromProjectAlgorithm *createInstance() const override SIP_FACTORY;
      81                 :            : 
      82                 :            :   protected:
      83                 :            : 
      84                 :            :     bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
      85                 :            :     QVariantMap processAlgorithm( const QVariantMap &parameters,
      86                 :            :                                   QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
      87                 :            : 
      88                 :            :   private:
      89                 :            : 
      90                 :            :     QString mProjectPath;
      91                 :            :     QList< QgsStyle::StyleEntity > mObjects;
      92                 :            :     std::unique_ptr< QgsStyle > mStyle;
      93                 :            : };
      94                 :            : 
      95                 :            : ///@endcond PRIVATE
      96                 :            : 
      97                 :            : #endif // QGSPROJECTSTYLESALGORITHMS_H
      98                 :            : 
      99                 :            :