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 "qgsexpressioncontext.h"
#include "qgslayertree.h"
#include "qgslayertreefilterproxymodel.h"
#include "qgslayertreemodel.h"
#include "qgslayoutitem.h"
#include "qgslegendsettings.h"
#include "qgssettingsentryenumflag.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;

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

    void clearCachedData( QgsLayerTreeNode *node ) const;
 
  signals:

    void refreshLegend();
 
  private slots:

    void forceRefresh();
 
  private:

    QgsLayoutItemLegend *mLayoutLegend = nullptr;

    QString evaluateLayerExpressions( QgsLayerTreeLayer *nodeLayer ) const;
 
};
 
#ifndef SIP_RUN
class CORE_EXPORT QgsLegendFilterProxyModel : public QgsLayerTreeFilterProxyModel
{
    Q_OBJECT
  public:

    QgsLegendFilterProxyModel( QObject *parent SIP_TRANSFERTHIS = nullptr );

    void setIsDefaultLegend( bool isDefault );

    void setFilterToCheckedLayers( bool filter );
 
  private:
 
    bool layerShown( QgsMapLayer *layer ) const override;
 
    bool mIsDefaultLegend = true;
    bool mFilterToCheckedLayers = false;
 
};
#endif

class CORE_EXPORT QgsLayoutItemLegend : public QgsLayoutItem
{
    Q_OBJECT
 
  public:

    static const QgsSettingsEntryEnumFlag< Qgis::LegendSyncMode > *settingDefaultLegendSyncMode SIP_SKIP;

    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;
    bool requiresRasterization() const override;
    bool containsAdvancedEffects() const override;

    void adjustBoxSize();

    void setResizeToContents( bool enabled );

    bool resizeToContents() const;

    QgsLegendModel *model();

    const QgsLegendModel *model() const SIP_SKIP;

    Q_DECL_DEPRECATED void setAutoUpdateModel( bool autoUpdate ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED bool autoUpdateModel() const SIP_DEPRECATED;

    void setSyncMode( Qgis::LegendSyncMode mode );

    void resetManualLayers( Qgis::LegendSyncMode mode );

    Qgis::LegendSyncMode syncMode() 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( Qgis::LegendComponent s );

    QgsLegendStyle style( Qgis::LegendComponent s ) const;

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

    Q_DECL_DEPRECATED QFont styleFont( Qgis::LegendComponent component ) const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setStyleFont( Qgis::LegendComponent component, const QFont &font ) SIP_DEPRECATED;

    void setStyleMargin( Qgis::LegendComponent component, double margin );

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

    Q_DECL_DEPRECATED double lineSpacing() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setLineSpacing( double spacing ) SIP_DEPRECATED;

    double boxSpace() const;

    void setBoxSpace( double space );

    double columnSpace() const;

    void setColumnSpace( double spacing );

    Q_DECL_DEPRECATED QColor fontColor() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setFontColor( const QColor &color ) SIP_DEPRECATED;

    double symbolWidth() const;

    void setSymbolWidth( double width );

    double maximumSymbolSize() const;

    void setMaximumSymbolSize( double size );

    double minimumSymbolSize() const;

    void setMinimumSymbolSize( double size );

    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 );

    double autoWrapLinesAfter() const;

    void setAutoWrapLinesAfter( double length );

    void setLinkedMap( QgsLayoutItemMap *map );

    QgsLayoutItemMap *linkedMap() const { return mMap; }

    void setFilterByMapItems( const QList< QgsLayoutItemMap * > &maps );

    QList< QgsLayoutItemMap * > filterByMapItems() const;

    QString themeName() const;

    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;
    bool accept( QgsStyleEntityVisitorInterface *visitor ) const override;
    bool isRefreshing() const override;
 
  public slots:
 
    void refresh() override;
    void invalidateCache() override;
    void refreshDataDefinedProperty( QgsLayoutObject::DataDefinedProperty property = QgsLayoutObject::DataDefinedProperty::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 mapThemeChanged( const QString &theme );

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

    void clearLegendCachedData();
 
  private:
    QgsLayoutItemLegend() = delete;

    void setCustomLayerTree( QgsLayerTree *rootGroup );
 
    void setupMapConnections( QgsLayoutItemMap *map, bool connect = true );
 
    void setModelStyleOverrides( const QMap<QString, QString> &overrides );
 
    void ensureModelIsInitialized() const;

    bool requiresFilteringBecauseOfRendererSetting();
 
    QgsLegendRenderer createRenderer() const;
 
    std::unique_ptr< QgsLegendModel > mLegendModel;
    std::unique_ptr< QgsLayerTree > mCustomLayerTree;
 
    Qgis::LegendSyncMode mSyncMode = Qgis::LegendSyncMode::AllProjectLayers;
 
    bool mDeferLegendModelInitialization = true;
 
    QgsLegendSettings mSettings;
 
    QString mTitle;
    int mColumnCount = 1;
 
    QString mMapUuid;
    QgsLayoutItemMap *mMap = nullptr;
 
    QList< QString > mFilterByMapUuids;
    QList< QPointer< QgsLayoutItemMap >> mFilterByMapItems;
 
    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;

    QString mThemeName;
 
    friend class QgsCompositionConverter;
 
};
 
#endif // QGSLAYOUTITEMLEGEND_H