qgsvectorfilewritertask.h

Go to the documentation of this file.

/***************************************************************************
                          qgsvectorfilewritertask.h
                          -------------------------
    begin                : Feb 2017
    copyright            : (C) 2017 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef QGSVECTORFILEWRITERTASK_H
#define QGSVECTORFILEWRITERTASK_H

#include "qgis_core.h"
#include "qgsvectorfilewriter.h"
#include "qgstaskmanager.h"

class CORE_EXPORT QgsVectorFileWriterTask : public QgsTask
{
    Q_OBJECT

  public:

    QgsVectorFileWriterTask( QgsVectorLayer *layer,
                             const QString &fileName,
                             const QgsVectorFileWriter::SaveVectorOptions &options );

    void cancel() override;

  signals:

    void writeComplete( const QString &newFilename );

    void completed( const QString &newFilename, const QString &newLayer ) SIP_SKIP;

    void errorOccurred( int error, const QString &errorMessage );

  protected:

    bool run() override;
    void finished( bool result ) override;

  private:

    QString mDestFileName;

    std::unique_ptr< QgsFeedback > mOwnedFeedback;
    QgsVectorFileWriter::WriterError mError = QgsVectorFileWriter::NoError;

    QString mNewFilename;
    QString mNewLayer;
    QString mErrorMessage;

    QgsVectorFileWriter::SaveVectorOptions mOptions;
    QgsVectorFileWriter::PreparedWriterDetails mWriterDetails;
    std::unique_ptr< QgsVectorFileWriter::FieldValueConverter > mFieldValueConverter;
};

#endif