qgslayoutlegendwidget.h

Go to the documentation of this file.

/***************************************************************************
                         qgslayoutlegendwidget.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 QGSLAYOUTLEGENDWIDGET_H
#define QGSLAYOUTLEGENDWIDGET_H
 
// We don't want to expose this in the public API
 
#include "ui_qgslayoutlegendmapfilteringwidgetbase.h"
#include "ui_qgslayoutlegendwidgetbase.h"
 
#include "qgis_gui.h"
#include "qgslayoutitemlegend.h"
#include "qgslayoutitemwidget.h"
 
#include <QItemDelegate>
#include <QWidget>
 
#define SIP_NO_FILE
 
class QgsLayoutLegendMapFilteringWidget;

 
#ifndef SIP_RUN
class GUI_EXPORT QgsLegendLayerTreeProxyModel : public QgsLayerTreeProxyModel
{
    Q_OBJECT
  public:
    QgsLegendLayerTreeProxyModel( QgsLayoutItemLegend *legend, QObject *parent SIP_TRANSFERTHIS = nullptr );

    void setSyncMode( Qgis::LegendSyncMode mode );
 
  protected:
    bool nodeShown( QgsLayerTreeNode *node ) const override;
 
  private:
    Qgis::LegendSyncMode mSyncMode = Qgis::LegendSyncMode::AllProjectLayers;
};
#endif

class GUI_EXPORT QgsLayoutLegendWidget : public QgsLayoutItemBaseWidget, public QgsExpressionContextGenerator, private Ui::QgsLayoutLegendWidgetBase
{
    Q_OBJECT
 
  public:
    explicit QgsLayoutLegendWidget( QgsLayoutItemLegend *legend, QgsMapCanvas *mapCanvas );
    void setMasterLayout( QgsMasterLayoutInterface *masterLayout ) override;
    void setDesignerInterface( QgsLayoutDesignerInterface *iface ) override;

    QgsLayoutItemLegend *legend() { return mLegend; }
    void setReportTypeString( const QString &string ) override;
    QgsExpressionContext createExpressionContext() const override;
  public slots:
    void resetLayerNodeToDefaults();

    void setCurrentNodeStyleFromAction();
 
  protected:
    bool setNewItem( QgsLayoutItem *item ) override;
 
  private slots:
 
    void mWrapCharLineEdit_textChanged( const QString &text );
    void mTitleLineEdit_textChanged( const QString &text );
    void mColumnCountSpinBox_valueChanged( int c );
    void mSplitLayerCheckBox_toggled( bool checked );
    void mEqualColumnWidthCheckBox_toggled( bool checked );
    void mSymbolWidthSpinBox_valueChanged( double d );
    void mSymbolHeightSpinBox_valueChanged( double d );
    void mMaxSymbolSizeSpinBox_valueChanged( double d );
    void mMinSymbolSizeSpinBox_valueChanged( double d );
    void mWmsLegendWidthSpinBox_valueChanged( double d );
    void mWmsLegendHeightSpinBox_valueChanged( double d );
    void mTitleSpaceBottomSpinBox_valueChanged( double d );
    void mGroupSpaceSpinBox_valueChanged( double d );
    void mGroupIndentSpinBox_valueChanged( double d );
    void mSubgroupIndentSpinBox_valueChanged( double d );
    void mLayerSpaceSpinBox_valueChanged( double d );
    void mSymbolSpaceSpinBox_valueChanged( double d );
    void mIconLabelSpaceSpinBox_valueChanged( double d );
    void mBoxSpaceSpinBox_valueChanged( double d );
    void mColumnSpaceSpinBox_valueChanged( double d );
    void maxWidthChanged( double width );
    void syncModeChanged( bool userTriggered );
    void composerMapChanged( QgsLayoutItem *item );
    void mCheckboxResizeContents_toggled( bool checked );
 
    void mRasterStrokeGroupBox_toggled( bool state );
    void mRasterStrokeWidthSpinBox_valueChanged( double d );
    void mRasterStrokeColorButton_colorChanged( const QColor &newColor );
 
    //item manipulation
    void mMoveDownToolButton_clicked();
    void mMoveUpToolButton_clicked();
    void mRemoveToolButton_clicked();
    void mAddToolButton_clicked();
    void mEditPushButton_clicked();
    void mCountToolButton_clicked( bool checked );
    void mExpressionFilterButton_toggled( bool checked );
    void mFilterByMapCheckBox_toggled( bool checked );
    void resetLayers( Qgis::LegendSyncMode mode );
    void mAddGroupToolButton_clicked();
    void mLayerExpressionButton_clicked();
 
    void mFilterLegendByAtlasCheckBox_toggled( bool checked );
 
    void selectedChanged( const QModelIndex &current, const QModelIndex &previous );
 
    void setLegendMapViewData();
 
    void expandLegendTree();
    void collapseLegendTree();
 
  private slots:
    void setGuiElements();

    void updateFilterLegendByAtlasButton();
 
    void mItemTreeView_doubleClicked( const QModelIndex &index );
    void titleFontChanged();
    void groupFontChanged();
    void layerFontChanged();
    void itemFontChanged();
 
    void titleAlignmentChanged();
    void groupAlignmentChanged();
    void subgroupAlignmentChanged();
    void itemAlignmentChanged();
    void arrangementChanged();
 
    void spaceBelowSubGroupHeadingChanged( double space );
    void spaceBelowGroupHeadingChanged( double space );
 
    void spaceGroupSideChanged( double space );
    void spaceSubGroupSideChanged( double space );
 
    void spaceSymbolSideChanged( double space );
 
  private:
    QgsLayoutLegendWidget() = delete;
    void blockAllSignals( bool b );
 
    QPointer<QgsLayoutItemLegend> mLegend;
    QgsMapCanvas *mMapCanvas = nullptr;
    QgsLayoutItemPropertiesWidget *mItemPropertiesWidget = nullptr;
 
    QgsLegendLayerTreeProxyModel *mLegendProxyModel = nullptr;
 
    QPointer<QgsLayoutLegendMapFilteringWidget> mMapFilteringWidget;
};

class GUI_EXPORT QgsLayoutLegendMenuProvider : public QgsLayerTreeViewMenuProvider
{
  public:
    QgsLayoutLegendMenuProvider( QgsLayerTreeView *view, QgsLayoutLegendWidget *w );
 
    QMenu *createContextMenu() override;
 
  protected:
    QgsLayerTreeView *mView = nullptr;
    QgsLayoutLegendWidget *mWidget = nullptr;
};
 
#include "ui_qgslayoutlegendnodewidgetbase.h"

class GUI_EXPORT QgsLayoutLegendNodeWidget : public QgsPanelWidget, private Ui::QgsLayoutLegendNodeWidgetBase
{
    Q_OBJECT
 
  public:
    QgsLayoutLegendNodeWidget( QgsLayoutItemLegend *legend, QgsLayerTreeNode *node, QgsLayerTreeModelLegendNode *legendNode, int originalLegendNodeIndex, QWidget *parent = nullptr );
 
    void setDockMode( bool dockMode ) override;
 
  private slots:
 
    void labelChanged();
    void patchChanged();
    void insertExpression();
    void sizeChanged( double );
    void customSymbolChanged();
    void colorRampLegendChanged();
    void columnBreakToggled( bool checked );
    void columnSplitChanged();
 
  private:
    QgsLayoutItemLegend *mLegend = nullptr;
    QgsLayerTreeNode *mNode = nullptr;
    QgsLayerTreeLayer *mLayer = nullptr;
    QgsLayerTreeModelLegendNode *mLegendNode = nullptr;
    int mOriginalLegendNodeIndex = -1;
};
 

class GUI_EXPORT QgsLayoutLegendMapFilteringModel : public QSortFilterProxyModel
{
    Q_OBJECT
 
  public:
    explicit QgsLayoutLegendMapFilteringModel( QgsLayoutItemLegend *legend, QgsLayoutModel *layoutModel, QObject *parent = nullptr );
 
    int columnCount( const QModelIndex &parent = QModelIndex() ) const override;
    QVariant data( const QModelIndex &index, int role ) const override;
    bool setData( const QModelIndex &index, const QVariant &value, int role ) override;
    Qt::ItemFlags flags( const QModelIndex &index ) const override;
 
  protected:
    bool filterAcceptsRow( int source_row, const QModelIndex &source_parent ) const override;
 
  private:
    QgsLayoutModel *mLayoutModel = nullptr;
    QPointer<QgsLayoutItemLegend> mLegendItem;
};

class GUI_EXPORT QgsLayoutLegendMapFilteringWidget : public QgsLayoutItemBaseWidget, private Ui::QgsLayoutLegendMapFilteringWidgetBase
{
    Q_OBJECT
 
  public:
    explicit QgsLayoutLegendMapFilteringWidget( QgsLayoutItemLegend *legend );
 
  protected:
    bool setNewItem( QgsLayoutItem *item ) final;
 
  private slots:
    void updateGuiElements();
 
  private:
    QPointer<QgsLayoutItemLegend> mLegendItem;
    bool mBlockUpdates = false;
};

 
#endif //QGSLAYOUTLEGENDWIDGET_H