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_core.h"
#include "qgslayoutmeasurementconverter.h"
#include "qgsrendercontext.h"
#include <QtGlobal>

class QgsLayout;

class CORE_EXPORT QgsLayoutRenderContext : public QObject
{

    Q_OBJECT

  public:

    enum Flag
    {
      FlagDebug = 1 << 1,  
      FlagOutlineOnly = 1 << 2, 
      FlagAntialiasing = 1 << 3, 
      FlagUseAdvancedEffects = 1 << 4, 
      FlagForceVectorOutput = 1 << 5, 
      FlagHideCoverageLayer = 1 << 6, 
      FlagDrawSelection = 1 << 7, 
      FlagDisableTiledRasterLayerRenders = 1 << 8, 
      FlagRenderLabelsByMapLayer = 1 << 9, 
    };
    Q_DECLARE_FLAGS( Flags, Flag )

    
    QgsLayoutRenderContext( QgsLayout *layout SIP_TRANSFERTHIS );

    void setFlags( QgsLayoutRenderContext::Flags flags );

    void setFlag( QgsLayoutRenderContext::Flag flag, bool on = true );

    QgsLayoutRenderContext::Flags flags() const;

    bool testFlag( Flag flag ) const;

    QgsRenderContext::Flags renderContextFlags() const;

    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; }

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

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

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

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

    QStringList exportThemes() const;

    void setExportThemes( const QStringList &themes );

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

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

  signals:

    void flagsChanged( QgsLayoutRenderContext::Flags flags );

    void dpiChanged();

    void predefinedScalesChanged();

  private:

    Flags mFlags = nullptr;

    QgsLayout *mLayout = nullptr;

    int mCurrentExportLayer = -1;

    QColor mSelectionColor = Qt::yellow;

    QgsLayoutMeasurementConverter mMeasurementConverter;

    bool mIsPreviewRender = true;
    bool mGridVisible = false;
    bool mBoundingBoxesVisible = true;
    bool mPagesVisible = true;

    QgsRenderContext::TextRenderFormat mTextRenderFormat = QgsRenderContext::TextFormatAlwaysOutlines;

    QStringList mExportThemes;

    QgsVectorSimplifyMethod mSimplifyMethod;

    QVector<qreal> mPredefinedScales;

    friend class QgsLayoutExporter;
    friend class TestQgsLayout;
    friend class LayoutContextPreviewSettingRestorer;
    friend class TestQgsLayoutMap;
    friend class TestQgsLayoutLabel;

};

Q_DECLARE_METATYPE( QgsLayoutRenderContext::Flags )

#endif //QGSLAYOUTRENDERCONTEXT_H