qgsvisibilitypresetcollection.h

Go to the documentation of this file.

/***************************************************************************
  qgsvisibilitypresetcollection.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 QGSVISIBILITYPRESETCOLLECTION_H
#define QGSVISIBILITYPRESETCOLLECTION_H

#include <QMap>
#include <QObject>
#include <QSet>
#include <QStringList>

class QDomDocument;
class QgsLayerTreeNode;
class QgsLayerTreeGroup;

class CORE_EXPORT QgsVisibilityPresetCollection : public QObject
{
    Q_OBJECT

  public:

    class PresetRecord
    {
      public:

        bool operator==( const PresetRecord& other ) const
        {
          return mVisibleLayerIDs.toSet() == other.mVisibleLayerIDs.toSet()
                 && mPerLayerCheckedLegendSymbols == other.mPerLayerCheckedLegendSymbols
                 && mPerLayerCurrentStyle == other.mPerLayerCurrentStyle;
        }
        bool operator!=( const PresetRecord& other ) const
        {
          return !( *this == other );
        }

        QStringList mVisibleLayerIDs;
        QMap<QString, QSet<QString> > mPerLayerCheckedLegendSymbols;
        QMap<QString, QString> mPerLayerCurrentStyle;
    };

    QgsVisibilityPresetCollection();

    bool hasPreset( const QString& name ) const;

    void insert( const QString& name, const PresetRecord& state );

    void update( const QString& name, const PresetRecord& state );

    void removePreset( const QString& name );

    void clear();

    QStringList presets() const;

    PresetRecord presetState( const QString& name ) const { return mPresets[name]; }

    QStringList presetVisibleLayers( const QString& name ) const;

    void applyPresetCheckedLegendNodesToLayer( const QString& name, const QString& layerID );

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

    void readXML( const QDomDocument& doc );

    void writeXML( QDomDocument& doc );

    static void addVisibleLayersToPreset( QgsLayerTreeGroup* parent, PresetRecord& rec );

  signals:

    void presetsChanged();

  protected slots:

    void registryLayersRemoved( const QStringList& layerIDs );

    void layerStyleRenamed( const QString& oldName, const QString& newName );

  protected:

    void reconnectToLayersStyleManager();

    typedef QMap<QString, PresetRecord> PresetRecordMap;
    PresetRecordMap mPresets;
};


#endif // QGSVISIBILITYPRESETCOLLECTION_H