qgsdatadefinedsizelegend.h

Go to the documentation of this file.

/***************************************************************************
  qgsdatadefinedsizelegend.h
  --------------------------------------
  Date                 : June 2017
  Copyright            : (C) 2017 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 QGSDATADEFINEDSIZELEGEND_H
#define QGSDATADEFINEDSIZELEGEND_H

#include "qgslegendsymbolitem.h"

#include <QColor>
#include <QFont>

class QDomElement;
class QgsMarkerSymbol;
class QgsProperty;
class QgsReadWriteContext;
class QgsRenderContext;
class QgsSizeScaleTransformer;


class CORE_EXPORT QgsDataDefinedSizeLegend
{
  public:

    QgsDataDefinedSizeLegend() = default;

    QgsDataDefinedSizeLegend( const QgsDataDefinedSizeLegend &other );
    QgsDataDefinedSizeLegend &operator=( const QgsDataDefinedSizeLegend &other );

    enum LegendType
    {
      LegendSeparated,   
      LegendCollapsed,   
    };

    enum VerticalAlignment
    {
      AlignCenter,      
      AlignBottom,      
    };

    struct SizeClass
    {
      SizeClass( double size, const QString &label ): size( size ), label( label ) {}

      double size;    
      QString label;  
    };

    void setLegendType( LegendType type ) { mType = type; }
    LegendType legendType() const { return mType; }

    void setSymbol( QgsMarkerSymbol *symbol SIP_TRANSFER );
    QgsMarkerSymbol *symbol() const;

    void setSizeScaleTransformer( QgsSizeScaleTransformer *transformer SIP_TRANSFER );
    QgsSizeScaleTransformer *sizeScaleTransformer() const;

    void setClasses( const QList< QgsDataDefinedSizeLegend::SizeClass > &classes ) { mSizeClasses = classes; }
    QList< QgsDataDefinedSizeLegend::SizeClass > classes() const { return mSizeClasses; }

    void setTitle( const QString &title ) { mTitleLabel = title; }
    QString title() const { return mTitleLabel; }

    void setVerticalAlignment( VerticalAlignment vAlign ) { mVAlign = vAlign; }
    VerticalAlignment verticalAlignment() const { return mVAlign; }

    void setFont( const QFont &font ) { mFont = font; }
    QFont font() const { return mFont; }

    void setTextColor( const QColor &color ) { mTextColor = color; }
    QColor textColor() const { return mTextColor; }

    void setTextAlignment( Qt::AlignmentFlag flag ) { mTextAlignment = flag; }
    Qt::AlignmentFlag textAlignment() const { return mTextAlignment; }

    //

    void updateFromSymbolAndProperty( const QgsMarkerSymbol *symbol, const QgsProperty &ddSize );

    QgsLegendSymbolList legendSymbolList() const;

    void drawCollapsedLegend( QgsRenderContext &context, QSize *outputSize SIP_OUT = nullptr, int *labelXOffset SIP_OUT = nullptr ) const;

    QImage collapsedLegendImage( QgsRenderContext &context, const QColor &backgroundColor = Qt::transparent, double paddingMM = 1 ) const;

    static QgsDataDefinedSizeLegend *readXml( const QDomElement &elem, const QgsReadWriteContext &context ) SIP_FACTORY;

    void writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const;

  private:
    LegendType mType = LegendSeparated;
    QString mTitleLabel;  
    QList< SizeClass > mSizeClasses;  
    std::unique_ptr<QgsMarkerSymbol> mSymbol;
    std::unique_ptr<QgsSizeScaleTransformer> mSizeScaleTransformer;  
    VerticalAlignment mVAlign = AlignBottom;
    QFont mFont;
    QColor mTextColor = Qt::black;
    Qt::AlignmentFlag mTextAlignment = Qt::AlignLeft;
};

#endif // QGSDATADEFINEDSIZELEGEND_H