qgsmapthemecollection.h

Go to the documentation of this file.

/***************************************************************************
  qgsmapthemecollection.h
  --------------------------------------
  Date                 : September 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 QGSMAPTHEMECOLLECTION_H
#define QGSMAPTHEMECOLLECTION_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsmaplayer.h"
 
#include <QMap>
#include <QObject>
#include <QPointer>
#include <QSet>
#include <QStringList>
 
class QDomDocument;
class QgsLayerTreeModel;
class QgsLayerTreeNode;
class QgsLayerTreeGroup;
class QgsLayerTreeLayer;
class QgsProject;

 
class CORE_EXPORT QgsMapThemeCollection : public QObject
{
    Q_OBJECT
 
    Q_PROPERTY( QStringList mapThemes READ mapThemes NOTIFY mapThemesChanged )
    Q_PROPERTY( QgsProject *project READ project WRITE setProject NOTIFY projectChanged )
 
  public:
    class CORE_EXPORT MapThemeLayerRecord
    {
      public:
        MapThemeLayerRecord( QgsMapLayer *l = nullptr )
          : mLayer( l )
        {}
 
        // TODO c++20 - replace with = default
        bool operator==( const QgsMapThemeCollection::MapThemeLayerRecord &other ) const
        {
          return mLayer == other.mLayer
                 && isVisible == other.isVisible
                 && usingCurrentStyle == other.usingCurrentStyle
                 && currentStyle == other.currentStyle
                 && usingLegendItems == other.usingLegendItems
                 && checkedLegendItems == other.checkedLegendItems
                 && expandedLegendItems == other.expandedLegendItems
                 && expandedLayerNode == other.expandedLayerNode;
        }
        bool operator!=( const QgsMapThemeCollection::MapThemeLayerRecord &other ) const { return !( *this == other ); }

        QgsMapLayer *layer() const { return mLayer; }

        void setLayer( QgsMapLayer *layer );

        bool isVisible = true;

        bool usingCurrentStyle = false;
        QString currentStyle;
        bool usingLegendItems = false;
        QSet<QString> checkedLegendItems;

        QSet<QString> expandedLegendItems;

        bool expandedLayerNode = false;
 
      private:
        QgsWeakMapLayerPointer mLayer;
    };

    class CORE_EXPORT MapThemeRecord
    {
      public:
        bool operator==( const QgsMapThemeCollection::MapThemeRecord &other ) const
        {
          return validLayerRecords() == other.validLayerRecords()
                 && mHasExpandedStateInfo == other.mHasExpandedStateInfo
                 && mExpandedGroupNodes == other.mExpandedGroupNodes
                 && mCheckedGroupNodes == other.mCheckedGroupNodes;
        }
        bool operator!=( const QgsMapThemeCollection::MapThemeRecord &other ) const { return !( *this == other ); }

        QList<QgsMapThemeCollection::MapThemeLayerRecord> layerRecords() const { return mLayerRecords; }

        void setLayerRecords( const QList<QgsMapThemeCollection::MapThemeLayerRecord> &records ) { mLayerRecords = records; }

        void removeLayerRecord( QgsMapLayer *layer );

        void addLayerRecord( const QgsMapThemeCollection::MapThemeLayerRecord &record );

        QHash<QgsMapLayer *, QgsMapThemeCollection::MapThemeLayerRecord> validLayerRecords() const SIP_SKIP;

        bool hasExpandedStateInfo() const { return mHasExpandedStateInfo; }

        bool hasCheckedStateInfo() const { return mHasCheckedStateInfo; };

        void setHasExpandedStateInfo( bool hasInfo ) { mHasExpandedStateInfo = hasInfo; }

        void setHasCheckedStateInfo( bool hasInfo ) { mHasCheckedStateInfo = hasInfo; };

        QSet<QString> expandedGroupNodes() const { return mExpandedGroupNodes; }

        QSet<QString> checkedGroupNodes() const { return mCheckedGroupNodes; }

        void setExpandedGroupNodes( const QSet<QString> &expandedGroupNodes ) { mExpandedGroupNodes = expandedGroupNodes; }

        void setCheckedGroupNodes( const QSet<QString> &checkedGroupNodes ) { mCheckedGroupNodes = checkedGroupNodes; }

        static MapThemeRecord readXml( const QDomElement &element, const QgsProject *project );

        void writeXml( QDomElement element, QDomDocument &document ) const;
 
      private:
        QList<MapThemeLayerRecord> mLayerRecords;

        bool mHasExpandedStateInfo = false;
        bool mHasCheckedStateInfo = false;

        QSet<QString> mExpandedGroupNodes;

        QSet<QString> mCheckedGroupNodes;
 
        friend class QgsMapThemeCollection;
    };

    QgsMapThemeCollection( QgsProject *project = nullptr );

    bool hasMapTheme( const QString &name ) const;

    void insert( const QString &name, const QgsMapThemeCollection::MapThemeRecord &state );

    void update( const QString &name, const QgsMapThemeCollection::MapThemeRecord &state );

    void removeMapTheme( const QString &name );

    bool renameMapTheme( const QString &name, const QString &newName );

    void clear();

    QStringList mapThemes() const;

    QgsMapThemeCollection::MapThemeRecord mapThemeState( const QString &name ) const { return mMapThemes[name]; }

    QStringList mapThemeVisibleLayerIds( const QString &name ) const;

    QList<QgsMapLayer *> mapThemeVisibleLayers( const QString &name ) const;

    QMap<QString, QString> mapThemeStyleOverrides( const QString &name );

    void readXml( const QDomDocument &doc );

    void writeXml( QDomDocument &doc ) const;

    static QgsMapThemeCollection::MapThemeRecord createThemeFromCurrentState( QgsLayerTreeGroup *root, QgsLayerTreeModel *model );

    void applyTheme( const QString &name, QgsLayerTreeGroup *root, QgsLayerTreeModel *model );

    QgsProject *project();

    void setProject( QgsProject *project );

    QList< QgsMapLayer * > masterLayerOrder() const;

    QList< QgsMapLayer * > masterVisibleLayers() const;
 
  signals:

    void mapThemesChanged();

    void mapThemeChanged( const QString &theme );

    void mapThemeRenamed( const QString &name, const QString &newName );

    void projectChanged();
 
  private slots:

    void registryLayersRemoved( const QStringList &layerIDs );

    void layerStyleRenamed( const QString &oldName, const QString &newName );
 
  private:
    void applyMapThemeCheckedLegendNodesToLayer( const MapThemeLayerRecord &layerRec, QgsMapLayer *layer );

    void reconnectToLayersStyleManager();
 
    static bool findRecordForLayer( QgsMapLayer *layer, const MapThemeRecord &rec, MapThemeLayerRecord &layerRec );
    static MapThemeLayerRecord createThemeLayerRecord( QgsLayerTreeLayer *nodeLayer, QgsLayerTreeModel *model );
    static void createThemeFromCurrentState( QgsLayerTreeGroup *parent, QgsLayerTreeModel *model, MapThemeRecord &rec );
    static void applyThemeToLayer( QgsLayerTreeLayer *nodeLayer, QgsLayerTreeModel *model, const MapThemeRecord &rec );
    static void applyThemeToGroup( QgsLayerTreeGroup *parent, QgsLayerTreeModel *model, const MapThemeRecord &rec );
 
    typedef QMap<QString, MapThemeRecord> MapThemeRecordMap;
    MapThemeRecordMap mMapThemes;
    QgsProject *mProject = nullptr;
};
 
 
#endif // QGSMAPTHEMECOLLECTION_H