qgslayoutrendercontext.h

Go to the documentation of this file.

/***************************************************************************
                             qgslayoutrendercontext.h
                             -------------------
    begin                : July 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 QGSLAYOUTRENDERCONTEXT_H
#define QGSLAYOUTRENDERCONTEXT_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgslayoutmeasurementconverter.h"
#include "qgsmaskrendersettings.h"
#include "qgsvectorsimplifymethod.h"
 
#include <QColor>
#include <QVector>
#include <QtGlobal>
 
class QgsLayout;
class QgsFeatureFilterProvider;

class CORE_EXPORT QgsLayoutRenderContext : public QObject
{
    Q_OBJECT
 
  public:
    QgsLayoutRenderContext( QgsLayout *layout SIP_TRANSFERTHIS );

    void setFlags( Qgis::LayoutRenderFlags flags );

    void setFlag( Qgis::LayoutRenderFlag flag, bool on = true );

    Qgis::LayoutRenderFlags flags() const;

    bool testFlag( Qgis::LayoutRenderFlag flag ) const;

    Qgis::RenderContextFlags renderContextFlags() const;

    Qgis::RasterizedRenderingPolicy rasterizedRenderingPolicy() const;

    void setRasterizedRenderingPolicy( Qgis::RasterizedRenderingPolicy policy );

    void setDpi( double dpi );

    double dpi() const;

    void setSelectionColor( const QColor &color ) { mSelectionColor = color; }

    QColor selectionColor() const { return mSelectionColor; }

    SIP_SKIP const QgsLayoutMeasurementConverter &measurementConverter() const { return mMeasurementConverter; }

    QgsLayoutMeasurementConverter &measurementConverter() { return mMeasurementConverter; }

    bool isPreviewRender() const { return mIsPreviewRender; }

    bool gridVisible() const;

    void setGridVisible( bool visible );

    bool boundingBoxesVisible() const;

    void setBoundingBoxesVisible( bool visible );

    void setPagesVisible( bool visible );

    bool pagesVisible() const { return mPagesVisible; }

    Q_DECL_DEPRECATED void setCurrentExportLayer( int layer = -1 ) SIP_DEPRECATED { mCurrentExportLayer = layer; }

    Q_DECL_DEPRECATED int currentExportLayer() const SIP_DEPRECATED { return mCurrentExportLayer; }

    Qgis::TextRenderFormat textRenderFormat() const { return mTextRenderFormat; }

    void setTextRenderFormat( Qgis::TextRenderFormat format ) { mTextRenderFormat = format; }

    void setSimplifyMethod( const QgsVectorSimplifyMethod &method ) { mSimplifyMethod = method; }

    const QgsVectorSimplifyMethod &simplifyMethod() const { return mSimplifyMethod; }

    const QgsMaskRenderSettings &maskSettings() const SIP_SKIP { return mMaskRenderSettings; }

    QgsMaskRenderSettings &maskSettings() { return mMaskRenderSettings; }

    void setMaskSettings( const QgsMaskRenderSettings &settings );

    QStringList exportThemes() const;

    void setExportThemes( const QStringList &themes );

    void setPredefinedScales( const QVector<qreal> &scales );

    QVector<qreal> predefinedScales() const { return mPredefinedScales; }

    QgsFeatureFilterProvider *featureFilterProvider() const;

    void setFeatureFilterProvider( QgsFeatureFilterProvider *featureFilterProvider );
 
  signals:

    void flagsChanged( Qgis::LayoutRenderFlags flags );

    void dpiChanged();

    void predefinedScalesChanged();
 
  private:
    void matchRasterizedRenderingPolicyToFlags();
 
    Qgis::LayoutRenderFlags mFlags;
    Qgis::RasterizedRenderingPolicy mRasterizedRenderingPolicy = Qgis::RasterizedRenderingPolicy::PreferVector;
 
    QgsLayout *mLayout = nullptr;
 
    int mCurrentExportLayer = -1;
 
    QColor mSelectionColor = Qt::yellow;
 
    QgsLayoutMeasurementConverter mMeasurementConverter;
 
    bool mIsPreviewRender = true;
    bool mGridVisible = false;
    bool mBoundingBoxesVisible = true;
    bool mPagesVisible = true;
 
    Qgis::TextRenderFormat mTextRenderFormat = Qgis::TextRenderFormat::AlwaysOutlines;
 
    QStringList mExportThemes;
 
    QgsVectorSimplifyMethod mSimplifyMethod;
 
    QVector<qreal> mPredefinedScales;
 
    QgsFeatureFilterProvider *mFeatureFilterProvider = nullptr;
 
    QgsMaskRenderSettings mMaskRenderSettings;
 
    friend class QgsLayoutExporter;
    friend class TestQgsLayout;
    friend class LayoutContextPreviewSettingRestorer;
    friend class TestQgsLayoutMap;
    friend class TestQgsLayoutLabel;
};
 
 
#endif //QGSLAYOUTRENDERCONTEXT_H