qgsmaplayerlegend.h

Go to the documentation of this file.

/***************************************************************************
  qgsmaplayerlegend.h
  --------------------------------------
  Date                 : July 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 QGSMAPLAYERLEGEND_H
#define QGSMAPLAYERLEGEND_H
 
#include <memory>
 
#include "qgis.h"
#include "qgis_sip.h"
 
#include <QObject>
 
class QDomDocument;
class QDomElement;
 
class QgsLayerTreeLayer;
class QgsLayerTreeModelLegendNode;
class QgsMeshLayer;
class QgsPluginLayer;
class QgsRasterLayer;
class QgsPointCloudLayer;
class QgsReadWriteContext;
class QgsVectorLayer;
class QgsLegendPatchShape;
class QgsColorRampLegendNodeSettings;
class QgsSymbol;
 
#include "qgis_core.h"
 

class CORE_EXPORT QgsMapLayerLegend : public QObject
{
    Q_OBJECT
  public:
    explicit QgsMapLayerLegend( QObject *parent SIP_TRANSFERTHIS = nullptr );
 
    // TODO: type

    Qgis::MapLayerLegendFlags flags() const { return mFlags; }

    void setFlag( Qgis::MapLayerLegendFlag flag, bool on = true ) { mFlags.setFlag( flag, on ); }

    void setFlags( Qgis::MapLayerLegendFlags flags ) { mFlags = flags; }

    virtual void readXml( const QDomElement &elem, const QgsReadWriteContext &context );

    virtual QDomElement writeXml( QDomDocument &doc, const QgsReadWriteContext &context ) const;

    virtual QList<QgsLayerTreeModelLegendNode *> createLayerTreeModelLegendNodes( QgsLayerTreeLayer *nodeLayer ) = 0 SIP_FACTORY;
 
    // TODO: support for layer tree view delegates

    static QgsMapLayerLegend *defaultVectorLegend( QgsVectorLayer *vl ) SIP_FACTORY;

    static QgsMapLayerLegend *defaultRasterLegend( QgsRasterLayer *rl ) SIP_FACTORY;

    static QgsMapLayerLegend *defaultMeshLegend( QgsMeshLayer *ml ) SIP_FACTORY;

    static QgsMapLayerLegend *defaultPointCloudLegend( QgsPointCloudLayer *layer ) SIP_FACTORY;
 
  signals:
    void itemsChanged();
 
  private:
    Qgis::MapLayerLegendFlags mFlags;
};
 

class CORE_EXPORT QgsMapLayerLegendUtils
{
  public:
    static void setLegendNodeOrder( QgsLayerTreeLayer *nodeLayer, const QList<int> &order );
    static QList<int> legendNodeOrder( QgsLayerTreeLayer *nodeLayer );
    static bool hasLegendNodeOrder( QgsLayerTreeLayer *nodeLayer );
 
    static void setLegendNodeUserLabel( QgsLayerTreeLayer *nodeLayer, int originalIndex, const QString &newLabel );
    static QString legendNodeUserLabel( QgsLayerTreeLayer *nodeLayer, int originalIndex );
    static bool hasLegendNodeUserLabel( QgsLayerTreeLayer *nodeLayer, int originalIndex );

    static void setLegendNodePatchShape( QgsLayerTreeLayer *nodeLayer, int originalIndex, const QgsLegendPatchShape &shape );

    static QgsLegendPatchShape legendNodePatchShape( QgsLayerTreeLayer *nodeLayer, int originalIndex );

    static void setLegendNodeSymbolSize( QgsLayerTreeLayer *nodeLayer, int originalIndex, QSizeF size );

    static QSizeF legendNodeSymbolSize( QgsLayerTreeLayer *nodeLayer, int originalIndex );

    static void setLegendNodeCustomSymbol( QgsLayerTreeLayer *nodeLayer, int originalIndex, const QgsSymbol *symbol );

    static std::unique_ptr< QgsSymbol > legendNodeCustomSymbol( QgsLayerTreeLayer *nodeLayer, int originalIndex );

    static void setLegendNodeColorRampSettings( QgsLayerTreeLayer *nodeLayer, int originalIndex, const QgsColorRampLegendNodeSettings *settings );

    static QgsColorRampLegendNodeSettings *legendNodeColorRampSettings( QgsLayerTreeLayer *nodeLayer, int originalIndex ) SIP_FACTORY;
 

    static void setLegendNodeColumnBreak( QgsLayerTreeLayer *nodeLayer, int originalIndex, bool columnBreakBeforeNode );

    static bool legendNodeColumnBreak( QgsLayerTreeLayer *nodeLayer, int originalIndex );

    static void applyLayerNodeProperties( QgsLayerTreeLayer *nodeLayer, QList<QgsLayerTreeModelLegendNode *> &nodes );
};
 
 
#include <QHash>
 
#include "qgstextformat.h"

class CORE_EXPORT QgsDefaultVectorLayerLegend : public QgsMapLayerLegend
{
    Q_OBJECT
 
  public:
    explicit QgsDefaultVectorLayerLegend( QgsVectorLayer *vl );

    bool textOnSymbolEnabled() const { return mTextOnSymbolEnabled; }

    void setTextOnSymbolEnabled( bool enabled ) { mTextOnSymbolEnabled = enabled; }

    bool showLabelLegend() const { return mShowLabelLegend; }

    void setShowLabelLegend( bool enabled ) { mShowLabelLegend = enabled; }

    QgsTextFormat textOnSymbolTextFormat() const { return mTextOnSymbolTextFormat; }

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

    QHash<QString, QString> textOnSymbolContent() const { return mTextOnSymbolContent; }

    void setTextOnSymbolContent( const QHash<QString, QString> &content ) { mTextOnSymbolContent = content; }
 
    QList<QgsLayerTreeModelLegendNode *> createLayerTreeModelLegendNodes( QgsLayerTreeLayer *nodeLayer ) SIP_FACTORY override;
    void readXml( const QDomElement &elem, const QgsReadWriteContext &context ) override;
    QDomElement writeXml( QDomDocument &doc, const QgsReadWriteContext &context ) const override;
 
  private:
    QgsVectorLayer *mLayer = nullptr;
 
    // text on symbol
    bool mTextOnSymbolEnabled = false;
    bool mShowLabelLegend = false;
    QgsTextFormat mTextOnSymbolTextFormat;
    QHash<QString, QString> mTextOnSymbolContent;
};
 

class CORE_EXPORT QgsDefaultRasterLayerLegend : public QgsMapLayerLegend
{
    Q_OBJECT
 
  public:
    explicit QgsDefaultRasterLayerLegend( QgsRasterLayer *rl );
 
    QList<QgsLayerTreeModelLegendNode *> createLayerTreeModelLegendNodes( QgsLayerTreeLayer *nodeLayer ) SIP_FACTORY override;
 
  private:
    QgsRasterLayer *mLayer = nullptr;
};
 

class CORE_EXPORT QgsDefaultMeshLayerLegend : public QgsMapLayerLegend
{
    Q_OBJECT
 
  public:
    explicit QgsDefaultMeshLayerLegend( QgsMeshLayer *ml );
 
    QList<QgsLayerTreeModelLegendNode *> createLayerTreeModelLegendNodes( QgsLayerTreeLayer *nodeLayer ) SIP_FACTORY override;
 
  private:
    QgsMeshLayer *mLayer = nullptr;
};

class CORE_EXPORT QgsDefaultPointCloudLayerLegend : public QgsMapLayerLegend
{
    Q_OBJECT
 
  public:
    explicit QgsDefaultPointCloudLayerLegend( QgsPointCloudLayer *layer );
 
    QList<QgsLayerTreeModelLegendNode *> createLayerTreeModelLegendNodes( QgsLayerTreeLayer *nodeLayer ) SIP_FACTORY override;
 
  private:
    QgsPointCloudLayer *mLayer = nullptr;
};
 
 
#endif // QGSMAPLAYERLEGEND_H