qgslegendsymbolitem.h

Go to the documentation of this file.

/***************************************************************************
  qgslegendsymbolitem.h
  --------------------------------------
  Date                 : August 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 QGSLEGENDSYMBOLITEM_H
#define QGSLEGENDSYMBOLITEM_H

#include <memory>
#include <QString>

#include "qgis.h"
#include "qgis_core.h"

class QgsDataDefinedSizeLegend;
class QgsSymbol;

class CORE_EXPORT QgsLegendSymbolItem
{
  public:

    QgsLegendSymbolItem() = default;

    QgsLegendSymbolItem( QgsSymbol *symbol, const QString &label, const QString &ruleKey, bool checkable = false, int scaleMinDenom = -1, int scaleMaxDenom = -1, int level = 0, const QString &parentRuleKey = QString() );
    ~QgsLegendSymbolItem();

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

    QgsSymbol *symbol() const { return mSymbol; }
    QString label() const { return mLabel; }
    QString ruleKey() const { return mKey; }
    bool isCheckable() const { return mCheckable; }

    QgsSymbol *legacyRuleKey() const { return mOriginalSymbolPointer; }

    bool isScaleOK( double scale ) const;

    int scaleMinDenom() const { return mScaleMinDenom; }

    int scaleMaxDenom() const { return mScaleMaxDenom; }

    int level() const { return mLevel; }

    QString parentRuleKey() const { return mParentKey; }

    void setSymbol( QgsSymbol *s );

    void setDataDefinedSizeLegendSettings( QgsDataDefinedSizeLegend *settings SIP_TRANSFER );

    QgsDataDefinedSizeLegend *dataDefinedSizeLegendSettings() const;

  private:
    QgsSymbol *mSymbol = nullptr;
    QString mLabel;
    QString mKey;
    bool mCheckable = false;

    QgsSymbol *mOriginalSymbolPointer = nullptr;

    QgsDataDefinedSizeLegend *mDataDefinedSizeLegendSettings = nullptr;

    // additional data that may be used for filtering

    int mScaleMinDenom = -1;
    int mScaleMaxDenom = -1;

    int mLevel = 0;
    QString mParentKey;
};

typedef QList< QgsLegendSymbolItem > QgsLegendSymbolList;

#endif // QGSLEGENDSYMBOLITEM_H