qgscategorizedsymbolrenderer.h

Go to the documentation of this file.

/***************************************************************************
    qgscategorizedsymbolrenderer.h
    ---------------------
    begin                : November 2009
    copyright            : (C) 2009 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 QGSCATEGORIZEDSYMBOLRENDERER_H
#define QGSCATEGORIZEDSYMBOLRENDERER_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgsrenderer.h"
 
#include <QHash>
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QgsVectorLayer;
class QgsStyle;
class QgsDataDefinedSizeLegend;
class QgsSymbol;
class QgsExpression;
class QgsColorRamp;

class CORE_EXPORT QgsRendererCategory
{
  public:
    QgsRendererCategory() = default;

    QgsRendererCategory( const QVariant &value, QgsSymbol *symbol SIP_TRANSFER, const QString &label, bool render = true, const QString &uuid = QString() );
 
    QgsRendererCategory( const QgsRendererCategory &cat );
    QgsRendererCategory &operator=( QgsRendererCategory cat );
    ~QgsRendererCategory();

    QString uuid() const;

    QVariant value() const;

    QgsSymbol *symbol() const;

    QString label() const;

    void setValue( const QVariant &value );

    void setSymbol( QgsSymbol *s SIP_TRANSFER );

    void setLabel( const QString &label );

    bool renderState() const;

    void setRenderState( bool render );
 
    // debugging

    QString dump() const;

    Q_DECL_DEPRECATED void toSld( QDomDocument &doc, QDomElement &element, QVariantMap props ) const SIP_DEPRECATED;

    bool toSld( QDomDocument &doc, QDomElement &element, const QString &classAttribute, QgsSldExportContext &context ) const;
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    const QString str = !sipCpp->value().isValid()
                        ? u"<QgsRendererCategory>"_s
                        : sipCpp->label().isEmpty()
                        ? u"<QgsRendererCategory: %1>"_s.arg( sipCpp->value().toString() )
                        : u"<QgsRendererCategory: %1 (%2)>"_s.arg( sipCpp->value().toString(), sipCpp->label() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
    // clang-format off
    protected:
    // clang-format on
    friend class QgsCategorizedSymbolRendererWidget;
 
    QVariant mValue;
    std::unique_ptr<QgsSymbol> mSymbol;
    QString mLabel;
    bool mRender = true;
    QString mUuid;
};
 
typedef QList<QgsRendererCategory> QgsCategoryList;

class CORE_EXPORT QgsCategorizedSymbolRenderer : public QgsFeatureRenderer
{
  public:
    using Category = QgsRendererCategory;
    using Categories = QgsCategoryList;

    QgsCategorizedSymbolRenderer( const QString &attrName = QString(), const QgsCategoryList &categories = QgsCategoryList() );
    ~QgsCategorizedSymbolRenderer() override;
 
    Qgis::FeatureRendererFlags flags() const override;
    QgsSymbol *symbolForFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
    QgsSymbol *originalSymbolForFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
    void startRender( QgsRenderContext &context, const QgsFields &fields ) override;
    void stopRender( QgsRenderContext &context ) override;
    QSet<QString> usedAttributes( const QgsRenderContext &context ) const override;
    bool filterNeedsGeometry() const override;
    QString dump() const override;
    QgsCategorizedSymbolRenderer *clone() const override SIP_FACTORY;
    Q_DECL_DEPRECATED void toSld( QDomDocument &doc, QDomElement &element, const QVariantMap &props = QVariantMap() ) const override SIP_DEPRECATED;
    bool toSld( QDomDocument &doc, QDomElement &element, QgsSldExportContext &context ) const override;
    QgsFeatureRenderer::Capabilities capabilities() override { return SymbolLevels | Filter; }
    QString filter( const QgsFields &fields = QgsFields() ) override;
    QgsSymbolList symbols( QgsRenderContext &context ) const override;
    bool accept( QgsStyleEntityVisitorInterface *visitor ) const override;

    void updateSymbols( QgsSymbol *sym );

    const QgsCategoryList &categories() const { return mCategories; }

    int categoryIndexForValue( const QVariant &val );

    int categoryIndexForLabel( const QString &val );

    bool updateCategoryValue( int catIndex, const QVariant &value );

    bool updateCategorySymbol( int catIndex, QgsSymbol *symbol SIP_TRANSFER );

    bool updateCategoryLabel( int catIndex, const QString &label );

    bool updateCategoryRenderState( int catIndex, bool render );

    void addCategory( const QgsRendererCategory &category );

    bool deleteCategory( int catIndex );

    void deleteAllCategories();

    void moveCategory( int from, int to );

    void sortByValue( Qt::SortOrder order = Qt::AscendingOrder );

    void sortByLabel( Qt::SortOrder order = Qt::AscendingOrder );

    QString classAttribute() const { return mAttrName; }

    void setClassAttribute( const QString &attr ) { mAttrName = attr; }

    static QgsFeatureRenderer *create( QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;
 
    QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) override;
    QgsLegendSymbolList legendSymbolItems() const override;
    QSet< QString > legendKeysForFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
    QString legendKeyToExpression( const QString &key, QgsVectorLayer *layer, bool &ok ) const override;

    QgsSymbol *sourceSymbol();

    const QgsSymbol *sourceSymbol() const SIP_SKIP;

    void setSourceSymbol( QgsSymbol *sym SIP_TRANSFER );

    QgsColorRamp *sourceColorRamp();

    const QgsColorRamp *sourceColorRamp() const SIP_SKIP;

    void setSourceColorRamp( QgsColorRamp *ramp SIP_TRANSFER );

    void updateColorRamp( QgsColorRamp *ramp SIP_TRANSFER );
 
    bool legendSymbolItemsCheckable() const override;
    bool legendSymbolItemChecked( const QString &key ) override;
    void setLegendSymbolItem( const QString &key, QgsSymbol *symbol SIP_TRANSFER ) override;
    void checkLegendSymbolItem( const QString &key, bool state = true ) override;
    QString legendClassificationAttribute() const override { return classAttribute(); }

    static QgsCategorizedSymbolRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer, QgsVectorLayer *layer = nullptr ) SIP_FACTORY;

    void setDataDefinedSizeLegend( QgsDataDefinedSizeLegend *settings SIP_TRANSFER );

    QgsDataDefinedSizeLegend *dataDefinedSizeLegend() const;

    int matchToSymbols( QgsStyle *style, Qgis::SymbolType type, QVariantList &unmatchedCategories SIP_OUT, QStringList &unmatchedSymbols SIP_OUT, bool caseSensitive = true, bool useTolerantMatch = false );
 

    static QgsCategoryList createCategories( const QVariantList &values, const QgsSymbol *symbol, QgsVectorLayer *layer = nullptr, const QString &fieldName = QString() );

    Q_DECL_DEPRECATED static QString displayString( const QVariant &value, int precision = -1 ) SIP_DEPRECATED;
 
 
  protected:
    QString mAttrName;
    QgsCategoryList mCategories;
    std::unique_ptr<QgsSymbol> mSourceSymbol;
    std::unique_ptr<QgsColorRamp> mSourceColorRamp;
    std::unique_ptr<QgsExpression> mExpression;
 
    std::unique_ptr<QgsDataDefinedSizeLegend> mDataDefinedSizeLegend;

    int mAttrNum = -1;

    bool mAttrIsNumeric = false;

    QHash<QString, QgsSymbol *> mSymbolHash;
    bool mCounting = false;
 
    void rebuildHash();

    Q_DECL_DEPRECATED QgsSymbol *skipRender() SIP_DEPRECATED;

    Q_DECL_DEPRECATED QgsSymbol *symbolForValue( const QVariant &value ) const SIP_DEPRECATED;
 
    // TODO QGIS 5.0 - rename Python method to symbolForValue

    QgsSymbol *symbolForValue( const QVariant &value, bool &foundMatchingSymbol SIP_OUT ) const SIP_PYNAME( symbolForValue2 );
 
  private:
#ifdef SIP_RUN
    QgsCategorizedSymbolRenderer( const QgsCategorizedSymbolRenderer & );
    QgsCategorizedSymbolRenderer &operator=( const QgsCategorizedSymbolRenderer & );
#endif

    QVariant valueForFeature( const QgsFeature &feature, QgsRenderContext &context ) const;

    QgsLegendSymbolList baseLegendSymbolItems() const;
};
 
#endif // QGSCATEGORIZEDSYMBOLRENDERER_H