qgscolorramplegendnode.h

Go to the documentation of this file.

/***************************************************************************
  qgscolorramplegendnode.h
  --------------------------------------
  Date                 : December 2020
  Copyright            : (C) 2020 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 QGSCOLORRAMPLEGENDNODE_H
#define QGSCOLORRAMPLEGENDNODE_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgscolorramplegendnodesettings.h"
#include "qgslayertreemodellegendnode.h"
 
class QgsColorRamp;

class CORE_EXPORT QgsColorRampLegendNode : public QgsLayerTreeModelLegendNode
{
    Q_OBJECT
 
 
  public:
    QgsColorRampLegendNode(
      QgsLayerTreeLayer *nodeLayer,
      QgsColorRamp *ramp SIP_TRANSFER,
      const QString &minimumLabel,
      const QString &maximumLabel,
      QObject *parent SIP_TRANSFERTHIS = nullptr,
      const QString &key = QString(),
      const QString &parentKey = QString()
    );

    QgsColorRampLegendNode(
      QgsLayerTreeLayer *nodeLayer,
      QgsColorRamp *ramp SIP_TRANSFER,
      const QgsColorRampLegendNodeSettings &settings,
      double minimumValue,
      double maximumValue,
      QObject *parent SIP_TRANSFERTHIS = nullptr,
      const QString &key = QString(),
      const QString &parentKey = QString()
    );
 
 
    QVariant data( int role ) const override;
    QSizeF drawSymbol( const QgsLegendSettings &settings, ItemContext *ctx, double itemHeight ) const override;
    QSizeF drawSymbolText( const QgsLegendSettings &settings, ItemContext *ctx, QSizeF symbolSize ) const override;
    QJsonObject exportSymbolToJson( const QgsLegendSettings &settings, const QgsRenderContext &context ) const override;
    void invalidateDisplayData() override;

    void setIconSize( QSize size ) { mIconSize = size; }

    QSize iconSize() const { return mIconSize; }

    const QgsColorRamp *ramp() const;

    QgsColorRampLegendNodeSettings settings() const;

    void setSettings( const QgsColorRampLegendNodeSettings &settings );

    void setMinimum( double minimum ) { mMinimumValue = minimum; };

    void setMaximum( double maximum ) { mMaximumValue = maximum; };

    double minimum() const { return mMinimumValue; };

    double maximum() const { return mMaximumValue; };
 
  private:
    void init( QgsLayerTreeLayer *nodeLayer );
 
    QString labelForMinimum() const;
    QString labelForMaximum() const;
 
    std::unique_ptr< QgsColorRamp > mRamp;
 
    mutable QPixmap mPixmap; // cached symbol preview
    QSize mIconSize;
 
    QgsColorRampLegendNodeSettings mSettings;
    double mMinimumValue = 0;
    double mMaximumValue = 0;
    QString mKey;
    QString mParentKey;
};
 
 
#endif // QGSCOLORRAMPLEGENDNODE_H