qgslayoutexporter.h

Go to the documentation of this file.

/***************************************************************************
                              qgslayoutexporter.h
                             -------------------
    begin                : October 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 QGSLAYOUTEXPORTER_H
#define QGSLAYOUTEXPORTER_H
 
#include "qgsconfig.h"
 
#include <functional>
 
#include "qgis_core.h"
#include "qgslayoutitem.h"
#include "qgslayoutrendercontext.h"
#include "qgslayoutreportcontext.h"
#include "qgsmargins.h"
 
#include <QPdfWriter>
#include <QPointer>
#include <QRectF>
#include <QSize>
#include <QVector>
 
#if defined( HAVE_QTPRINTER )
#include <QPrinter>
#endif
 
class QgsLayout;
class QPainter;
class QgsLayoutItemMap;
class QgsAbstractLayoutIterator;
class QgsFeedback;
class QgsLabelingResults;
class QgsSettingsEntryBool;
class QgsSettingsEntryInteger;

class CORE_EXPORT QgsLayoutExporter
{
  public:
    static const QgsSettingsEntryBool *settingOpenAfterExportingImage SIP_SKIP;

    static const QgsSettingsEntryBool *settingOpenAfterExportingPdf SIP_SKIP;

    static const QgsSettingsEntryBool *settingOpenAfterExportingSvg SIP_SKIP;

    static const QgsSettingsEntryInteger *settingImageQuality SIP_SKIP;

    struct PageExportDetails
    {
        QString directory;

        QString baseName;

        QString extension;

        int page = 0;
    };

    QgsLayoutExporter( QgsLayout *layout );
 
    virtual ~QgsLayoutExporter();

    QgsLayout *layout() const;

    void renderPage( QPainter *painter, int page ) const;

    QImage renderPageToImage( int page, QSize imageSize = QSize(), double dpi = -1 ) const;

    void renderRegion( QPainter *painter, const QRectF &region ) const;

    QImage renderRegionToImage( const QRectF &region, QSize imageSize = QSize(), double dpi = -1 ) const;
 

    enum ExportResult
    {
      Success,       
      Canceled,      
      MemoryError,   
      FileError,     
      PrintError,    
      SvgLayerError, 
      IteratorError, 
    };

    struct ImageExportSettings
    {
        ImageExportSettings()
          : flags( Qgis::LayoutRenderFlag::Antialiasing | Qgis::LayoutRenderFlag::UseAdvancedEffects )
        {}

        double dpi = -1;

        QSize imageSize;

        bool cropToContents = false;

        QgsMargins cropMargins;

        QList< int > pages;

        bool generateWorldFile = false;

        bool exportMetadata = true;

        Qgis::LayoutRenderFlags flags;

        QVector<qreal> predefinedMapScales;

        int quality = -1;
    };

    ExportResult exportToImage( const QString &filePath, const QgsLayoutExporter::ImageExportSettings &settings );
 

    static ExportResult exportToImage(
      QgsAbstractLayoutIterator *iterator, const QString &baseFilePath, const QString &extension, const QgsLayoutExporter::ImageExportSettings &settings, QString &error SIP_OUT, QgsFeedback *feedback = nullptr
    );
 

    struct PdfExportSettings
    {
        PdfExportSettings()
          : flags( Qgis::LayoutRenderFlag::Antialiasing | Qgis::LayoutRenderFlag::UseAdvancedEffects )
        {}

        double dpi = -1;

        bool rasterizeWholeImage = false;

        bool forceVectorOutput = false;

        bool appendGeoreference = true;

        bool exportMetadata = true;

        Qgis::LayoutRenderFlags flags;

        Qgis::TextRenderFormat textRenderFormat = Qgis::TextRenderFormat::AlwaysOutlines;

        bool simplifyGeometries = true;

        bool writeGeoPdf = false;

        bool exportLayersAsSeperateFiles = false; // TODO QGIS 5 fix typo  //#spellok

        bool useIso32000ExtensionFormatGeoreferencing = true;

        bool useOgcBestPracticeFormatGeoreferencing = false;

        bool includeGeoPdfFeatures = true;

        QStringList exportThemes;

        QVector<qreal> predefinedMapScales;

        bool useLayerTreeConfig = false;
    };

    ExportResult exportToPdf( const QString &filePath, const QgsLayoutExporter::PdfExportSettings &settings );

    static ExportResult exportToPdf(
      QgsAbstractLayoutIterator *iterator, const QString &fileName, const QgsLayoutExporter::PdfExportSettings &settings, QString &error SIP_OUT, QgsFeedback *feedback = nullptr
    );

    static ExportResult exportToPdfs(
      QgsAbstractLayoutIterator *iterator, const QString &baseFilePath, const QgsLayoutExporter::PdfExportSettings &settings, QString &error SIP_OUT, QgsFeedback *feedback = nullptr
    );
 

    struct PrintExportSettings
    {
        PrintExportSettings()
          : flags( Qgis::LayoutRenderFlag::Antialiasing | Qgis::LayoutRenderFlag::UseAdvancedEffects )
        {}

        double dpi = -1;

        bool rasterizeWholeImage = false;

        Qgis::LayoutRenderFlags flags;

        QVector<qreal> predefinedMapScales;
    };
 
#if defined( HAVE_QTPRINTER )
    SIP_IF_FEATURE( HAVE_QTPRINTER )
 
    
    ExportResult print( QPrinter &printer, const QgsLayoutExporter::PrintExportSettings &settings );

    static ExportResult print( QgsAbstractLayoutIterator *iterator, QPrinter &printer, const QgsLayoutExporter::PrintExportSettings &settings, QString &error SIP_OUT, QgsFeedback *feedback = nullptr );
 
    SIP_END
#endif

    struct SvgExportSettings
    {
        SvgExportSettings()
          : flags( Qgis::LayoutRenderFlag::Antialiasing | Qgis::LayoutRenderFlag::UseAdvancedEffects )
        {}

        double dpi = -1;

        bool forceVectorOutput = false;

        bool cropToContents = false;

        QgsMargins cropMargins;

        bool exportAsLayers = false;

        bool exportLabelsToSeparateLayers = true;

        bool exportMetadata = true;

        Qgis::LayoutRenderFlags flags;

        Qgis::TextRenderFormat textRenderFormat = Qgis::TextRenderFormat::AlwaysOutlines;

        bool simplifyGeometries = true;

        QVector<qreal> predefinedMapScales;
    };

    ExportResult exportToSvg( const QString &filePath, const QgsLayoutExporter::SvgExportSettings &settings );

    static ExportResult exportToSvg(
      QgsAbstractLayoutIterator *iterator, const QString &baseFilePath, const QgsLayoutExporter::SvgExportSettings &settings, QString &error SIP_OUT, QgsFeedback *feedback = nullptr
    );
 

    QString errorFile() const { return mErrorFileName; }

    QString errorMessage() const { return mErrorMessage; }

    QMap< QString, QgsLabelingResults * > labelingResults();
 
#ifndef SIP_RUN

    QMap< QString, QgsLabelingResults * > takeLabelingResults();
#endif

    bool georeferenceOutput( const QString &file, QgsLayoutItemMap *referenceMap = nullptr, const QRectF &exportRegion = QRectF(), double dpi = -1 ) const;

    void computeWorldFileParameters( double &a, double &b, double &c, double &d, double &e, double &f, double dpi = -1 ) const;

    void computeWorldFileParameters( const QRectF &region, double &a, double &b, double &c, double &d, double &e, double &f, double dpi = -1 ) const;

    static bool requiresRasterization( const QgsLayout *layout );

    static bool containsAdvancedEffects( const QgsLayout *layout );
 
  protected:
    virtual QString generateFileName( const PageExportDetails &details ) const;
 
  private:
    QPointer< QgsLayout > mLayout;
 
    void captureLabelingResults();
    QMap< QString, QgsLabelingResults * > mLabelingResults;
 
    mutable QString mErrorFileName;
    mutable QString mErrorMessage;
 
    QImage createImage( const ImageExportSettings &settings, int page, QRectF &bounds, bool &skipPage ) const;

    static int firstPageToBeExported( QgsLayout *layout );

    static bool saveImage( const QImage &image, const QString &imageFilename, const QString &imageFormat, QgsProject *projectForMetadata, int quality = -1 );

    std::unique_ptr<double[]> computeGeoTransform( const QgsLayoutItemMap *referenceMap = nullptr, const QRectF &exportRegion = QRectF(), double dpi = -1 ) const;

    void writeWorldFile( const QString &fileName, double a, double b, double c, double d, double e, double f ) const;

    static void preparePrintAsPdf( QgsLayout *layout, QPdfWriter *device, const QString &filePath );
 
    static void preparePrint( QgsLayout *layout, QPagedPaintDevice *device, bool setFirstPageSize = false );

    ExportResult print( QPagedPaintDevice *device );

    ExportResult printPrivate( QPagedPaintDevice *device, QPainter &painter, bool startNewPage = false, double dpi = -1, bool rasterize = false );
 
    static void updatePrinterPageSize( QgsLayout *layout, QPagedPaintDevice *device, int page );
 
    ExportResult renderToLayeredSvg(
      const SvgExportSettings &settings,
      double width,
      double height,
      int page,
      const QRectF &bounds,
      const QString &filename,
      unsigned int svgLayerId,
      const QString &layerName,
      QDomDocument &svg,
      QDomNode &svgDocRoot,
      bool includeMetadata
    ) const;
 
    void appendMetadataToSvg( QDomDocument &svg ) const;
 
    bool georeferenceOutputPrivate(
      const QString &file, QgsLayoutItemMap *referenceMap = nullptr, const QRectF &exportRegion = QRectF(), double dpi = -1, bool includeGeoreference = true, bool includeMetadata = false
    ) const;
 
    ExportResult handleLayeredExport(
      const QList<QGraphicsItem *> &items,
      const std::function<QgsLayoutExporter::ExportResult( unsigned int layerId, const QgsLayoutItem::ExportLayerDetail &layerDetails )> &exportFunc,
      const std::function<QString( QgsLayoutItem *item )> &getItemExportGroupFunc
    );
 
    // Returns PDF creator (used also as producer)
    static QString getCreator();
 
    // Set PDF XMP metadata on pdfWriter for given layout
    static void setXmpMetadata( QPdfWriter *pdfWriter, QgsLayout *layout );
 
    static QgsVectorSimplifyMethod createExportSimplifyMethod();
    static QgsMaskRenderSettings createExportMaskSettings();
    friend class TestQgsLayout;
    friend class TestQgsLayoutExporter;
};
 
#endif //QGSLAYOUTEXPORTER_H