qgslegendsymbolitemv2.h

Go to the documentation of this file.

/***************************************************************************
  qgslegendsymbolitemv2.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 QGSLEGENDSYMBOLITEMV2_H
#define QGSLEGENDSYMBOLITEMV2_H

#include <QString>

class QgsSymbolV2;

class CORE_EXPORT QgsLegendSymbolItemV2
{
  public:
    QgsLegendSymbolItemV2();
    QgsLegendSymbolItemV2( QgsSymbolV2* symbol, const QString& label, const QString& ruleKey, bool checkable = false, int scaleMinDenom = -1, int scaleMaxDenom = -1, int level = 0, const QString& parentRuleKey = QString() );
    ~QgsLegendSymbolItemV2();
    QgsLegendSymbolItemV2( const QgsLegendSymbolItemV2& other );
    QgsLegendSymbolItemV2& operator=( const QgsLegendSymbolItemV2& other );

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

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

  protected:
    void setSymbol( QgsSymbolV2* s );

  private:
    QgsSymbolV2* mSymbol;
    QString mLabel;
    QString mKey;
    bool mCheckable;

    QgsSymbolV2* mOriginalSymbolPointer;

    // additional data that may be used for filtering

    int mScaleMinDenom;
    int mScaleMaxDenom;

    int mLevel;
    QString mParentKey;
};


typedef QList< QgsLegendSymbolItemV2 > QgsLegendSymbolListV2;

#endif // QGSLEGENDSYMBOLITEMV2_H