Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithmexporttospreadsheet.h
       3                 :            :                          ------------------
       4                 :            :     begin                : December 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                 :            : #ifndef QGSALGORITHMEXPORTTOSPREADSHEET_H
      19                 :            : #define QGSALGORITHMEXPORTTOSPREADSHEET_H
      20                 :            : 
      21                 :            : #define SIP_NO_FILE
      22                 :            : 
      23                 :            : #include "qgis_sip.h"
      24                 :            : #include "qgsprocessingalgorithm.h"
      25                 :            : #include "qgsvectorfilewriter.h"
      26                 :            : 
      27                 :            : ///@cond PRIVATE
      28                 :            : 
      29                 :            : class QgsVectorLayer;
      30                 :            : 
      31                 :            : /**
      32                 :            :  * Native export to spreadsheet algorithm.
      33                 :            :  */
      34                 :          0 : class QgsExportToSpreadsheetAlgorithm : public QgsProcessingAlgorithm
      35                 :            : {
      36                 :            : 
      37                 :            :   public:
      38                 :            : 
      39                 :          0 :     QgsExportToSpreadsheetAlgorithm() = default;
      40                 :            :     void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
      41                 :            :     QString name() const override;
      42                 :            :     QString displayName() const override;
      43                 :            :     QStringList tags() const override;
      44                 :            :     QString group() const override;
      45                 :            :     QString groupId() const override;
      46                 :            :     QString shortHelpString() const override;
      47                 :            :     QgsExportToSpreadsheetAlgorithm *createInstance() const override SIP_FACTORY;
      48                 :            : 
      49                 :            :   protected:
      50                 :            : 
      51                 :            :     bool prepareAlgorithm( const QVariantMap &parameters,
      52                 :            :                            QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
      53                 :            :     QVariantMap processAlgorithm( const QVariantMap &parameters,
      54                 :            :                                   QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
      55                 :            : 
      56                 :            :   private:
      57                 :            : 
      58                 :            :     bool exportVectorLayer( QgsVectorLayer *layer, const QString &path, QgsProcessingContext &context,
      59                 :            :                             QgsProcessingFeedback *feedback, const QString &driverName, bool createNew, bool preferAlias,
      60                 :            :                             QgsVectorFileWriter::FieldValueConverter *converter );
      61                 :            : 
      62                 :            :     std::vector< std::unique_ptr< QgsMapLayer> > mLayers;
      63                 :            : 
      64                 :            : };
      65                 :            : 
      66                 :            : ///@endcond PRIVATE
      67                 :            : 
      68                 :            : #endif // QGSALGORITHMEXPORTTOSPREADSHEET_H
      69                 :            : 
      70                 :            :