qgslayertreemodellegendnode.h

Go to the documentation of this file.

/***************************************************************************
  qgslayertreemodellegendnode.h
  --------------------------------------
  Date                 : August 2014
  Copyright            : (C) 2014 by Martin Dobias
  Email                : wonder dot sk at gmail dot com
 
  QgsWMSLegendNode     : Sandro Santilli < strk at keybit dot net >
 
 ***************************************************************************
 *                                                                         *
 *   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 QGSLAYERTREEMODELLEGENDNODE_H
#define QGSLAYERTREEMODELLEGENDNODE_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsexpressioncontext.h"
#include "qgslegendpatchshape.h"
#include "qgspallabeling.h"
 
#include <QIcon>
#include <QObject>
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QgsLayerTreeLayer;
class QgsLayerTreeModel;
class QgsLegendSettings;
class QgsMapSettings;
class QgsSymbol;
class QgsRenderContext;
class QgsSettingsEntryDouble;
class QgsTextFormat;
class QgsTextDocument;
class QgsTextDocumentMetrics;

class CORE_EXPORT QgsLayerTreeModelLegendNode : public QObject
{
    //SIP_TYPEHEADER_INCLUDE( "qgscolorramplegendnode.h" );
 
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( qobject_cast<QgsSymbolLegendNode *>( sipCpp ) )
      sipType = sipType_QgsSymbolLegendNode;
    else if ( qobject_cast<QgsDataDefinedSizeLegendNode *>( sipCpp ) )
      sipType = sipType_QgsDataDefinedSizeLegendNode;
    else if ( qobject_cast<QgsImageLegendNode *>( sipCpp ) )
      sipType = sipType_QgsImageLegendNode;
    else if ( qobject_cast<QgsRasterSymbolLegendNode *>( sipCpp ) )
      sipType = sipType_QgsRasterSymbolLegendNode;
    else if ( qobject_cast<QgsSimpleLegendNode *>( sipCpp ) )
      sipType = sipType_QgsSimpleLegendNode;
    else if ( qobject_cast<QgsWmsLegendNode *>( sipCpp ) )
      sipType = sipType_QgsWmsLegendNode;
    else if ( qobject_cast<QgsColorRampLegendNode *>( sipCpp ) )
      sipType = sipType_QgsColorRampLegendNode;
    else
      sipType = 0;
    SIP_END
#endif
 
    // clang-format off
  Q_OBJECT
 
  public:
 
    // *INDENT-OFF*

    enum class CustomRole SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsLayerTreeModelLegendNode, LegendNodeRoles ) : int
    {
      RuleKey SIP_MONKEYPATCH_COMPAT_NAME( RuleKeyRole ) = Qt::UserRole,      
      ParentRuleKey SIP_MONKEYPATCH_COMPAT_NAME( ParentRuleKeyRole ),         
      NodeType SIP_MONKEYPATCH_COMPAT_NAME( NodeTypeRole ),                   
      IsDataDefinedSize SIP_MONKEYPATCH_COMPAT_NAME( IsDataDefinedSizeRole ), 
    };
    Q_ENUM( CustomRole )
    // clang-format on
    // *INDENT-ON*
 
    
    enum NodeTypes
    {
      SimpleLegend,          
      SymbolLegend,          
      RasterSymbolLegend,    
      ImageLegend,           
      WmsLegend,             
      DataDefinedSizeLegend, 
      EmbeddedWidget,        
      ColorRampLegend,       
    };

    QgsLayerTreeLayer *layerNode() const { return mLayerNode; }

    QgsLayerTreeModel *model() const;

    virtual Qt::ItemFlags flags() const;

    virtual QVariant data( int role ) const = 0;

    virtual bool setData( const QVariant &value, int role );
 
    virtual bool isEmbeddedInParent() const { return mEmbeddedInParent; }
    virtual void setEmbeddedInParent( bool embedded ) { mEmbeddedInParent = embedded; }
 
    virtual QString userLabel() const { return mUserLabel; }
    virtual void setUserLabel( const QString &userLabel ) { mUserLabel = userLabel; }

    virtual QSizeF userPatchSize() const;

    virtual void setUserPatchSize( QSizeF size );

    virtual void setColumnBreak( bool breakBeforeNode ) { mColumnBreakBeforeNode = breakBeforeNode; }

    virtual bool columnBreak() const { return mColumnBreakBeforeNode; }
 
    virtual bool isScaleOK( double scale ) const
    {
      Q_UNUSED( scale )
      return true;
    }

    virtual void invalidateMapBasedData() {}

    virtual void invalidateDisplayData() {}
 
    struct ItemContext
    {
        Q_NOWARN_DEPRECATED_PUSH //because of deprecated members
          ItemContext()
          = default;
        Q_NOWARN_DEPRECATED_POP

        QgsRenderContext *context = nullptr;
        QPainter *painter = nullptr;

        Q_DECL_DEPRECATED QPointF point;

        Q_DECL_DEPRECATED double labelXOffset = 0.0;

        double top = 0.0;

        double columnLeft = 0.0;

        double columnRight = 0.0;

        double maxSiblingSymbolWidth = 0.0;

        QgsLegendPatchShape patchShape;

        QSizeF patchSize;

        const QgsTextDocument *textDocument = nullptr;

        const QgsTextDocumentMetrics *textDocumentMetrics = nullptr;

        QgsScreenProperties screenProperties;
    };
 
    struct ItemMetrics
    {
        QSizeF symbolSize;
        QSizeF labelSize;
    };

    virtual ItemMetrics draw( const QgsLegendSettings &settings, ItemContext &ctx );

    QJsonObject exportToJson( const QgsLegendSettings &settings, const QgsRenderContext &context );

    virtual QSizeF drawSymbol( const QgsLegendSettings &settings, ItemContext *ctx, double itemHeight ) const;

    virtual QJsonObject exportSymbolToJson( const QgsLegendSettings &settings, const QgsRenderContext &context ) const;

    virtual QSizeF drawSymbolText( const QgsLegendSettings &settings, ItemContext *ctx, QSizeF symbolSize ) const;
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsLayerTreeModelLegendNode: \"%1\">"_s.arg( sipCpp->data( Qt::DisplayRole ).toString() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
      public slots :

      void checkAllItems();

    void uncheckAllItems();

    void toggleAllItems();
 
  signals:
    void dataChanged();

    void sizeChanged();
 
  protected:
    explicit QgsLayerTreeModelLegendNode( QgsLayerTreeLayer *nodeL, QObject *parent SIP_TRANSFERTHIS = nullptr );

    QgsRenderContext *createTemporaryRenderContext() const SIP_FACTORY;
 
  protected:
    QgsLayerTreeLayer *mLayerNode = nullptr;
    bool mEmbeddedInParent = false;
    QString mUserLabel;
    QgsLegendPatchShape mPatchShape;
    QSizeF mUserSize;
    bool mColumnBreakBeforeNode = false;
 
  private:
    void checkAll( bool state );
};
Q_DECLARE_METATYPE( QgsLayerTreeModelLegendNode::NodeTypes )
 
#include "qgslegendsymbolitem.h"
#include "qgstextformat.h"

class CORE_EXPORT QgsSymbolLegendNode : public QgsLayerTreeModelLegendNode
{
    Q_OBJECT
 
  public:
    static double MINIMUM_SIZE;
    static double MAXIMUM_SIZE;
 
#ifndef SIP_RUN
    static const QgsSettingsEntryDouble *settingsLegendSymbolMinimumSize SIP_SKIP;
    static const QgsSettingsEntryDouble *settingsLegendSymbolMaximumSize SIP_SKIP;
#endif

    QgsSymbolLegendNode( QgsLayerTreeLayer *nodeLayer, const QgsLegendSymbolItem &item, QObject *parent SIP_TRANSFERTHIS = nullptr );
    ~QgsSymbolLegendNode() override;
 
    Qt::ItemFlags flags() const override;
    QVariant data( int role ) const override;
    bool setData( const QVariant &value, int role ) override;
    void invalidateDisplayData() override;
    QSizeF drawSymbol( const QgsLegendSettings &settings, ItemContext *ctx, double itemHeight ) const override;
 
    QJsonObject exportSymbolToJson( const QgsLegendSettings &settings, const QgsRenderContext &context ) const override;
 
    void setEmbeddedInParent( bool embedded ) override;
 
    void setUserLabel( const QString &userLabel ) override
    {
      mUserLabel = userLabel;
      updateLabel();
    }
 
    bool isScaleOK( double scale ) const override { return mItem.isScaleOK( scale ); }
 
    void invalidateMapBasedData() override;

    void setIconSize( QSize sz );
    QSize iconSize() const { return mIconSize; }

    QSize minimumIconSize() const;

    QSize minimumIconSize( QgsRenderContext *context ) const;

    const QgsSymbol *symbol() const;

    void setSymbol( QgsSymbol *symbol SIP_TRANSFER );

    QString textOnSymbolLabel() const { return mTextOnSymbolLabel; }

    void setTextOnSymbolLabel( const QString &label ) { mTextOnSymbolLabel = label; }

    QgsTextFormat textOnSymbolTextFormat() const { return mTextOnSymbolTextFormat; }

    void setTextOnSymbolTextFormat( const QgsTextFormat &format ) { mTextOnSymbolTextFormat = format; }

    QString symbolLabel() const;

    QgsLegendPatchShape patchShape() const;

    void setPatchShape( const QgsLegendPatchShape &shape );

    QgsSymbol *customSymbol() const;

    void setCustomSymbol( QgsSymbol *symbol SIP_TRANSFER );

    QString evaluateLabel( const QgsExpressionContext &context = QgsExpressionContext(), const QString &label = QString() );

    QgsExpressionContextScope *createSymbolScope() const SIP_FACTORY;
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsSymbolLegendNode: %1 \"%2\""_s.arg(
                    sipCpp->data( static_cast< int >( QgsLayerTreeModelLegendNode::CustomRole::RuleKey ) ).toString(),
                    sipCpp->data( Qt::DisplayRole ).toString() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
    // clang-format off
    private:
    // clang-format on
    void updateLabel();
 
  private:
    QgsLegendSymbolItem mItem;
    mutable QPixmap mPixmap; // cached symbol preview
    QString mLabel;
    bool mSymbolUsesMapUnits = false;
 
    QSize mIconSize;
 
    QString mTextOnSymbolLabel;
    QgsTextFormat mTextOnSymbolTextFormat;
 
    std::unique_ptr< QgsSymbol > mCustomSymbol;
 
    // ident the symbol icon to make it look like a tree structure
    static const int INDENT_SIZE = 20;
};
 

class CORE_EXPORT QgsSimpleLegendNode : public QgsLayerTreeModelLegendNode
{
    Q_OBJECT
 
  public:
    QgsSimpleLegendNode( QgsLayerTreeLayer *nodeLayer, const QString &label, const QIcon &icon = QIcon(), QObject *parent SIP_TRANSFERTHIS = nullptr, const QString &key = QString() );
 
    QVariant data( int role ) const override;
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsSimpleLegendNode: \"%1\">"_s.arg( sipCpp->data( Qt::DisplayRole ).toString() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
    // clang-format off
    private:
    // clang-format on
    QString mLabel;
    QString mId;
    QIcon mIcon;
    QString mKey;
};
 

class CORE_EXPORT QgsImageLegendNode : public QgsLayerTreeModelLegendNode
{
    Q_OBJECT
 
  public:
    QgsImageLegendNode( QgsLayerTreeLayer *nodeLayer, const QImage &img, QObject *parent SIP_TRANSFERTHIS = nullptr );
 
    QVariant data( int role ) const override;
 
    QSizeF drawSymbol( const QgsLegendSettings &settings, ItemContext *ctx, double itemHeight ) const override;
 
    QJsonObject exportSymbolToJson( const QgsLegendSettings &settings, const QgsRenderContext &context ) const override;
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsImageLegendNode: \"%1\">"_s.arg( sipCpp->data( Qt::DisplayRole ).toString() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
    // clang-format off
    private:
    // clang-format on
    QImage mImage;
};

class CORE_EXPORT QgsRasterSymbolLegendNode : public QgsLayerTreeModelLegendNode
{
    Q_OBJECT
 
  public:
    QgsRasterSymbolLegendNode(
      QgsLayerTreeLayer *nodeLayer,
      const QColor &color,
      const QString &label,
      QObject *parent SIP_TRANSFERTHIS = nullptr,
      bool isCheckable = false,
      const QString &ruleKey = QString(),
      const QString &parentRuleKey = QString()
    );
 
    Qt::ItemFlags flags() const override;
    QVariant data( int role ) const override;
    bool setData( const QVariant &value, int role ) override;
    QSizeF drawSymbol( const QgsLegendSettings &settings, ItemContext *ctx, double itemHeight ) const override;
    QJsonObject exportSymbolToJson( const QgsLegendSettings &settings, const QgsRenderContext &context ) const override;

    QString ruleKey() const { return mRuleKey; }

    bool isCheckable() const { return mCheckable; }
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsRasterSymbolLegendNode: \"%1\">"_s.arg( sipCpp->data( Qt::DisplayRole ).toString() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
    // clang-format off
    private:
    // clang-format on
    QColor mColor;
    QString mLabel;
    bool mCheckable = false;
    QString mRuleKey;
    QString mParentRuleKey;
};
 
class QgsImageFetcher;

class CORE_EXPORT QgsWmsLegendNode : public QgsLayerTreeModelLegendNode
{
    Q_OBJECT
 
  public:
    QgsWmsLegendNode( QgsLayerTreeLayer *nodeLayer, QObject *parent SIP_TRANSFERTHIS = nullptr );
 
    ~QgsWmsLegendNode() override;
 
    QVariant data( int role ) const override;
 
    QSizeF drawSymbol( const QgsLegendSettings &settings, ItemContext *ctx, double itemHeight ) const override;
 
    QJsonObject exportSymbolToJson( const QgsLegendSettings &settings, const QgsRenderContext &context ) const override;
 
    void invalidateMapBasedData() override;

    QImage getLegendGraphicBlocking() const;
 
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsWmsLegendNode: \"%1\">"_s.arg( sipCpp->data( Qt::DisplayRole ).toString() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
      // clang-format off
      private slots:
      // clang-format on
 
      void getLegendGraphicFinished( const QImage & );
    void getLegendGraphicErrored( const QString & );
    void getLegendGraphicProgress( qint64, qint64 );
 
  private:
    // Lazy loading of the image
    QImage getLegendGraphic( bool synchronous = false ) const;
 
    QImage renderMessage( const QString &msg ) const;
 
    QImage mImage;
 
    bool mValid = false;
 
    mutable std::unique_ptr<QgsImageFetcher> mFetcher;
};
 

class CORE_EXPORT QgsDataDefinedSizeLegendNode : public QgsLayerTreeModelLegendNode
{
    Q_OBJECT
 
  public:
    QgsDataDefinedSizeLegendNode( QgsLayerTreeLayer *nodeLayer, const QgsDataDefinedSizeLegend &settings, QObject *parent SIP_TRANSFERTHIS = nullptr );
    ~QgsDataDefinedSizeLegendNode() override;
 
    QVariant data( int role ) const override;
    void invalidateDisplayData() override;
    ItemMetrics draw( const QgsLegendSettings &settings, ItemContext &ctx ) override;
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsDataDefinedSizeLegendNode: \"%1\">"_s.arg( sipCpp->data( Qt::DisplayRole ).toString() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
    // clang-format off
    private:
    // clang-format on
    void cacheImage() const;
    std::unique_ptr<QgsDataDefinedSizeLegend> mSettings;
    mutable QImage mImage;
};

class CORE_EXPORT QgsVectorLabelLegendNode : public QgsLayerTreeModelLegendNode
{
    Q_OBJECT
  public:
    QgsVectorLabelLegendNode( QgsLayerTreeLayer *nodeLayer, const QgsPalLayerSettings &labelSettings, QObject *parent = nullptr );
    ~QgsVectorLabelLegendNode() override;

    QVariant data( int role ) const override;

    QSizeF drawSymbol( const QgsLegendSettings &settings, ItemContext *ctx, double itemHeight ) const override;

    QJsonObject exportSymbolToJson( const QgsLegendSettings &settings, const QgsRenderContext &context ) const override;
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsVectorLabelLegendNode: \"%1\">"_s.arg( sipCpp->data( Qt::DisplayRole ).toString() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
    // clang-format off
    private:
    // clang-format on
    QgsPalLayerSettings mLabelSettings;
    QSizeF drawSymbol( const QgsLegendSettings &settings, const QgsRenderContext &renderContext, double xOffset = 0.0, double yOffset = 0.0 ) const;
    void textWidthHeight( double &width, double &height, QgsRenderContext &ctx, const QgsTextFormat &textFormat, const QStringList &textLines ) const;
};
 
 
#endif // QGSLAYERTREEMODELLEGENDNODE_H