qgscomposerlegend.h

Go to the documentation of this file.

/***************************************************************************
                         qgscomposerlegend.h  -  description
                         -------------------
    begin                : June 2008
    copyright            : (C) 2008 by Marco Hugentobler
    email                : marco dot hugentobler at karto dot baug dot ethz dot ch
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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 QGSCOMPOSERLEGEND_H
#define QGSCOMPOSERLEGEND_H

#include "qgscomposerlegendstyle.h"
#include "qgscomposeritem.h"
#include "qgscomposerlegenditem.h"
#include "qgslayertreemodel.h"
#include "qgslegendmodel.h"
#include "qgslegendsettings.h"

class QgsLayerTreeModel;
class QgsSymbolV2;
class QgsComposerGroupItem;
class QgsComposerLayerItem;
class QgsComposerMap;
class QgsLegendRenderer;


class CORE_EXPORT QgsLegendModelV2 : public QgsLayerTreeModel
{
    Q_OBJECT

  public:
    QgsLegendModelV2( QgsLayerTreeGroup* rootNode, QObject *parent = nullptr );

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

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


class CORE_EXPORT QgsComposerLegend : public QgsComposerItem
{
    Q_OBJECT

  public:
    QgsComposerLegend( QgsComposition* composition );
    ~QgsComposerLegend();

    virtual int type() const override { return ComposerLegend; }

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

    QSizeF paintAndDetermineSize( QPainter* painter );

    void adjustBoxSize();

    void setResizeToContents( bool enabled );

    bool resizeToContents() const;

    Q_DECL_DEPRECATED QgsLegendModel* model() {return &mLegendModel;}

    QgsLegendModelV2* modelV2() { return mLegendModel2; }

    void setAutoUpdateModel( bool autoUpdate );
    bool autoUpdateModel() const;

    void setLegendFilterByMapEnabled( bool enabled );
    bool legendFilterByMapEnabled() const { return mLegendFilterByMap; }

    virtual void updateItem() override;

    void setLegendFilterOutAtlas( bool doFilter );

    bool legendFilterOutAtlas() const;

    //setters and getters
    void setTitle( const QString& t );
    QString title() const;

    Qt::AlignmentFlag titleAlignment() const;
    void setTitleAlignment( Qt::AlignmentFlag alignment );

    QgsComposerLegendStyle & rstyle( QgsComposerLegendStyle::Style s );
    QgsComposerLegendStyle style( QgsComposerLegendStyle::Style s ) const;
    void setStyle( QgsComposerLegendStyle::Style s, const QgsComposerLegendStyle& style );

    QFont styleFont( QgsComposerLegendStyle::Style s ) const;
    void setStyleFont( QgsComposerLegendStyle::Style s, const QFont& f );

    void setStyleMargin( QgsComposerLegendStyle::Style s, double margin );
    void setStyleMargin( QgsComposerLegendStyle::Style s, QgsComposerLegendStyle::Side side, double margin );

    double boxSpace() const;
    void setBoxSpace( double s );

    double columnSpace() const;
    void setColumnSpace( double s );

    QColor fontColor() const;
    void setFontColor( const QColor& c );

    double symbolWidth() const;
    void setSymbolWidth( double w );

    double symbolHeight() const;
    void setSymbolHeight( double h );

    double wmsLegendWidth() const;
    void setWmsLegendWidth( double w );

    double wmsLegendHeight() const;
    void setWmsLegendHeight( double h );

    void setWrapChar( const QString& t );
    QString wrapChar() const;

    int columnCount() const;
    void setColumnCount( int c );

    bool splitLayer() const;
    void setSplitLayer( bool s );

    bool equalColumnWidth() const;
    void setEqualColumnWidth( bool s );

    bool drawRasterBorder() const;

    void setDrawRasterBorder( bool enabled );

    QColor rasterBorderColor() const;

    void setRasterBorderColor( const QColor& color );

    double rasterBorderWidth() const;

    void setRasterBorderWidth( double width );

    void setComposerMap( const QgsComposerMap* map );
    const QgsComposerMap* composerMap() const { return mComposerMap;}

    void updateLegend();

    bool writeXML( QDomElement& elem, QDomDocument & doc ) const override;

    bool readXML( const QDomElement& itemElem, const QDomDocument& doc ) override;

    //Overridden to show legend title
    virtual QString displayName() const override;

  public slots:
    void synchronizeWithModel();
    void invalidateCurrentMap();

  private slots:
    void updateFilterByMap( bool redraw = true );

    void mapLayerStyleOverridesChanged();

    void onAtlasEnded();
    void onAtlasFeature( QgsFeature* );

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

  private:
    QgsComposerLegend(); //forbidden

    void setCustomLayerTree( QgsLayerTreeGroup* rootGroup );

    QgsLegendModel mLegendModel;

    QgsLegendModelV2* mLegendModel2;
    QgsLayerTreeGroup* mCustomLayerTree;

    QgsLegendSettings mSettings;

    const QgsComposerMap* mComposerMap;

    bool mLegendFilterByMap;
    bool mLegendFilterByExpression;

    bool mFilterOutAtlas;

    bool mFilterAskedForUpdate;
    void doUpdateFilterByMap();

    bool mInAtlas;

    bool mInitialMapScaleCalculated;

    bool mForceResize;

    bool mSizeToContents;
};

#endif