qgslegendsettings.h

Go to the documentation of this file.

/***************************************************************************
  qgslegendsettings.h
  --------------------------------------
  Date                 : July 2014
  Copyright            : (C) 2014 by Martin Dobias
  Email                : wonder dot sk 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 QGSLEGENDSETTINGS_H
#define QGSLEGENDSETTINGS_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QColor>
#include <QSizeF>
 
class QRectF;
 
#include "qgslegendstyle.h"
 
class QgsExpressionContext;

class CORE_EXPORT QgsLegendSettings
{
  public:
    QgsLegendSettings();

    void updateDataDefinedProperties( QgsRenderContext &context );

    void setTitle( const QString &t ) { mTitle = t; }

    QString title() const { return mTitle; }

    Qt::AlignmentFlag titleAlignment() const { return mTitleAlignment; }

    void setTitleAlignment( Qt::AlignmentFlag alignment ) { mTitleAlignment = alignment; }

    SIP_SKIP QgsLegendStyle &rstyle( Qgis::LegendComponent s ) SIP_SKIP { return mStyleMap[static_cast< int >( s )]; }

    QgsLegendStyle style( Qgis::LegendComponent s ) const { return mStyleMap[ static_cast< int >( s ) ]; }

    void setStyle( Qgis::LegendComponent s, const QgsLegendStyle &style ) { mStyleMap[ static_cast< int >( s ) ] = style; }

    double boxSpace() const {return mBoxSpace;}

    void setBoxSpace( double s ) {mBoxSpace = s;}

    void setWrapChar( const QString &t ) {mWrapChar = t;}

    QString wrapChar() const {return mWrapChar;}

    double columnSpace() const {return mColumnSpace;}

    void setColumnSpace( double s ) { mColumnSpace = s;}

    int columnCount() const { return mColumnCount; }

    void setColumnCount( int c ) { mColumnCount = c;}

    bool splitLayer() const { return mSplitLayer; }

    void setSplitLayer( bool s ) { mSplitLayer = s;}

    bool equalColumnWidth() const { return mEqualColumnWidth; }

    void setEqualColumnWidth( bool s ) { mEqualColumnWidth = s;}

    Q_DECL_DEPRECATED QColor fontColor() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setFontColor( const QColor &c ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED QColor layerFontColor() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setLayerFontColor( const QColor &fontColor ) SIP_DEPRECATED;

    QSizeF symbolSize() const {return mSymbolSize;}

    void setSymbolSize( QSizeF s ) {mSymbolSize = s;}

    double maximumSymbolSize() const {return mMaxSymbolSize; }

    void setMaximumSymbolSize( double size ) { mMaxSymbolSize = size;}

    double minimumSymbolSize() const {return mMinSymbolSize; }

    void setMinimumSymbolSize( double size ) { mMinSymbolSize = size;}

    void setSymbolAlignment( Qt::AlignmentFlag alignment ) { mSymbolAlignment = alignment; }

    Qt::AlignmentFlag symbolAlignment() const { return mSymbolAlignment; }

    bool drawRasterStroke() const { return mRasterSymbolStroke; }

    void setDrawRasterStroke( bool enabled ) { mRasterSymbolStroke = enabled; }

    QColor rasterStrokeColor() const { return mRasterStrokeColor; }

    void setRasterStrokeColor( const QColor &color ) { mRasterStrokeColor = color; }

    double rasterStrokeWidth() const { return mRasterStrokeWidth; }

    void setRasterStrokeWidth( double width ) { mRasterStrokeWidth = width; }

    QSizeF wmsLegendSize() const {return mWmsLegendSize;}

    void setWmsLegendSize( QSizeF s ) {mWmsLegendSize = s;}

    void setSynchronousLegendRequests( bool b ) {mSynchronousLegendRequests = b;}

    bool synchronousLegendRequests() const {return mSynchronousLegendRequests;}

    Q_DECL_DEPRECATED double lineSpacing() const SIP_DEPRECATED  { return mLineSpacing; }

    Q_DECL_DEPRECATED void setLineSpacing( double s );

    Q_DECL_DEPRECATED double mmPerMapUnit() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setMmPerMapUnit( double mmPerMapUnit ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED bool useAdvancedEffects() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setUseAdvancedEffects( bool use ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED double mapScale() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setMapScale( double scale ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED double mapUnitsPerPixel() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setMapUnitsPerPixel( double mapUnitsPerPixel ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED int dpi() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setDpi( int dpi ) SIP_DEPRECATED;
 
// utility functions


    QStringList evaluateItemText( const QString &text, const QgsExpressionContext &context ) const;

    QStringList splitStringForWrapping( const QString &stringToSplt ) const;

    void drawText( QPainter *p, double x, double y, const QString &text, const QFont &font ) const;

    void drawText( QPainter *p, const QRectF &rect, const QString &text, const QFont &font, Qt::AlignmentFlag halignment = Qt::AlignLeft, Qt::AlignmentFlag valignment = Qt::AlignTop, int flags = Qt::TextWordWrap ) const;

    QFont scaledFontPixelSize( const QFont &font ) const;

    double pixelFontSize( double pointSize ) const;

    double textWidthMillimeters( const QFont &font, const QString &text ) const;

    double fontHeightCharacterMM( const QFont &font, QChar c ) const;

    double fontAscentMillimeters( const QFont &font ) const;

    double fontDescentMillimeters( const QFont &font ) const;

    Qgis::LegendJsonRenderFlags jsonRenderFlags() const;

    void setJsonRenderFlags( const Qgis::LegendJsonRenderFlags &jsonRenderFlags );

    double autoWrapLinesAfter() const { return mAutoWrapLinesAfter; }

    void setAutoWrapLinesAfter( double length ) { mAutoWrapLinesAfter = length; }
 
  private:
 
    QString mTitle;

    Qt::AlignmentFlag mTitleAlignment = Qt::AlignLeft;
 
    QString mWrapChar;
 
    double mAutoWrapLinesAfter = 0;

    qreal mBoxSpace = 2;

    QSizeF mSymbolSize;

    double mMaxSymbolSize = 0.0;

    double mMinSymbolSize = 0.0;

    QSizeF mWmsLegendSize;

    bool mSynchronousLegendRequests = false;

    double mLineSpacing = 1;

    double mColumnSpace = 2;

    int mColumnCount = 1;

    bool mSplitLayer = false;

    bool mEqualColumnWidth = false;
 
    bool mRasterSymbolStroke = true;
    QColor mRasterStrokeColor;
    double mRasterStrokeWidth = 0.0;
 
    QVector<QgsLegendStyle> mStyleMap;

    double mMmPerMapUnit = 1;

    bool mUseAdvancedEffects = true;

    double mMapScale = 1;

    int mDpi = 96;

    Qt::AlignmentFlag mSymbolAlignment = Qt::AlignLeft;

    Qgis::LegendJsonRenderFlags mJsonRenderFlags;
};
 
 
 
#endif // QGSLEGENDSETTINGS_H