qgslayoutitemlegend.h

Go to the documentation of this file.

/***************************************************************************
                         qgslayoutitemlegend.h
                         ---------------------
    begin                : October 2017
    copyright            : (C) 2017 by Nyall Dawson
    email                : nyall dot dawson 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 QGSLAYOUTITEMLEGEND_H
#define QGSLAYOUTITEMLEGEND_H

#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgslayoutitem.h"
#include "qgslayertreemodel.h"
#include "qgslegendsettings.h"
#include "qgslayertreegroup.h"
#include "qgsexpressioncontext.h"

class QgsLayerTreeModel;
class QgsSymbol;
class QgsLayoutItemMap;
class QgsLegendRenderer;
class QgsLayoutItemLegend;

class CORE_EXPORT QgsLegendModel : public QgsLayerTreeModel
{
    Q_OBJECT

  public:
    QgsLegendModel( QgsLayerTree *rootNode, QObject *parent SIP_TRANSFERTHIS = nullptr, QgsLayoutItemLegend *layout = nullptr );

    QgsLegendModel( QgsLayerTree *rootNode,  QgsLayoutItemLegend *layout );

    QVariant data( const QModelIndex &index, int role ) const override;

    Qt::ItemFlags flags( const QModelIndex &index ) const override;

  signals:

    void refreshLegend();

  private slots:

    void forceRefresh();

  private:

    QList<QgsLayerTreeModelLegendNode *> layerLegendNodes( QgsLayerTreeLayer *nodeLayer, bool skipNodeEmbeddedInParent = false ) const;

    QgsLayoutItemLegend *mLayoutLegend = nullptr;

};



class CORE_EXPORT QgsLayoutItemLegend : public QgsLayoutItem
{
    Q_OBJECT

  public:

    QgsLayoutItemLegend( QgsLayout *layout );

    static QgsLayoutItemLegend *create( QgsLayout *layout ) SIP_FACTORY;

    int type() const override;
    QIcon icon() const override;
    QgsLayoutItem::Flags itemFlags() const override;
    //Overridden to show legend title
    QString displayName() const override;

    void adjustBoxSize();

    void setResizeToContents( bool enabled );

    bool resizeToContents() const;

    QgsLegendModel *model() { return mLegendModel.get(); }

    void setAutoUpdateModel( bool autoUpdate );

    bool autoUpdateModel() const;

    void setLegendFilterByMapEnabled( bool enabled );

    bool legendFilterByMapEnabled() const { return mLegendFilterByMap; }

    void setLegendFilterOutAtlas( bool doFilter );

    bool legendFilterOutAtlas() const;

    void setTitle( const QString &title );

    QString title() const;

    Qt::AlignmentFlag titleAlignment() const;

    void setTitleAlignment( Qt::AlignmentFlag alignment );

    QgsLegendStyle &rstyle( QgsLegendStyle::Style s );

    QgsLegendStyle style( QgsLegendStyle::Style s ) const;

    void setStyle( QgsLegendStyle::Style component, const QgsLegendStyle &style );

    QFont styleFont( QgsLegendStyle::Style component ) const;

    void setStyleFont( QgsLegendStyle::Style component, const QFont &font );

    void setStyleMargin( QgsLegendStyle::Style component, double margin );

    void setStyleMargin( QgsLegendStyle::Style component, QgsLegendStyle::Side side, double margin );

    double lineSpacing() const;

    void setLineSpacing( double spacing );

    double boxSpace() const;

    void setBoxSpace( double space );

    double columnSpace() const;

    void setColumnSpace( double spacing );

    QColor fontColor() const;

    void setFontColor( const QColor &color );

    double symbolWidth() const;

    void setSymbolWidth( double width );

    void setSymbolAlignment( Qt::AlignmentFlag alignment );

    Qt::AlignmentFlag symbolAlignment() const;

    double symbolHeight() const;

    void setSymbolHeight( double height );

    double wmsLegendWidth() const;

    void setWmsLegendWidth( double width );

    double wmsLegendHeight() const;

    void setWmsLegendHeight( double height );

    void setWrapString( const QString &string );

    QString wrapString() const;

    int columnCount() const;

    void setColumnCount( int count );

    bool splitLayer() const;

    void setSplitLayer( bool enabled );

    bool equalColumnWidth() const;

    void setEqualColumnWidth( bool equalize );

    bool drawRasterStroke() const;

    void setDrawRasterStroke( bool enabled );

    QColor rasterStrokeColor() const;

    void setRasterStrokeColor( const QColor &color );

    double rasterStrokeWidth() const;

    void setRasterStrokeWidth( double width );

    void setLinkedMap( QgsLayoutItemMap *map );

    QgsLayoutItemMap *linkedMap() const { return mMap; }

    void updateLegend();

    void updateFilterByMap( bool redraw = true );

    const QgsLegendSettings &legendSettings() const { return mSettings; }

    void paint( QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget ) override;

    void finalizeRestoreFromXml() override;

    QgsExpressionContext createExpressionContext() const override;
    ExportLayerBehavior exportLayerBehavior() const override;

  public slots:

    void refresh() override;
    void refreshDataDefinedProperty( QgsLayoutObject::DataDefinedProperty property = QgsLayoutObject::AllProperties ) override;

  protected:
    void draw( QgsLayoutItemRenderContext &context ) override;
    bool writePropertiesToElement( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const override;
    bool readPropertiesFromElement( const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context ) override;

  private slots:

    void invalidateCurrentMap();

    void updateFilterByMapAndRedraw();


    void mapLayerStyleOverridesChanged();

    void onAtlasEnded();
    void onAtlasFeature();

    void nodeCustomPropertyChanged( QgsLayerTreeNode *node, const QString &key );


  private:
    QgsLayoutItemLegend() = delete;

    void setCustomLayerTree( QgsLayerTree *rootGroup );

    void setupMapConnections( QgsLayoutItemMap *map, bool connect = true );

    std::unique_ptr< QgsLegendModel > mLegendModel;
    std::unique_ptr< QgsLayerTreeGroup > mCustomLayerTree;

    QgsLegendSettings mSettings;

    QString mTitle;
    int mColumnCount = 1;

    QString mMapUuid;
    QgsLayoutItemMap *mMap = nullptr;

    bool mLegendFilterByMap = false;
    bool mLegendFilterByExpression = false;

    bool mFilterOutAtlas = false;

    bool mFilterAskedForUpdate = false;
    void doUpdateFilterByMap();

    bool mInAtlas = false;

    bool mInitialMapScaleCalculated = false;

    bool mForceResize = false;

    bool mSizeToContents = true;

    friend class QgsCompositionConverter;

};

#endif // QGSLAYOUTITEMLEGEND_H