QGIS API Documentation 3.29.0-Master (ade4f0cf0f)
qgsmapthemecollection.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsmapthemecollection.h
3 --------------------------------------
4 Date : September 2014
5 Copyright : (C) 2014 by Martin Dobias
6 Email : wonder dot sk at gmail dot com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16#ifndef QGSMAPTHEMECOLLECTION_H
17#define QGSMAPTHEMECOLLECTION_H
18
19#include "qgis_core.h"
20#include "qgis_sip.h"
21#include <QMap>
22#include <QObject>
23#include <QPointer>
24#include <QSet>
25#include <QStringList>
26
27#include "qgsmaplayer.h"
28
29class QDomDocument;
34class QgsProject;
35
44class CORE_EXPORT QgsMapThemeCollection : public QObject
45{
46 Q_OBJECT
47
48 Q_PROPERTY( QStringList mapThemes READ mapThemes NOTIFY mapThemesChanged )
49 Q_PROPERTY( QgsProject *project READ project WRITE setProject NOTIFY projectChanged )
50
51 public:
52
58 class CORE_EXPORT MapThemeLayerRecord
59 {
60 public:
62 MapThemeLayerRecord( QgsMapLayer *l = nullptr ): mLayer( l ) {}
63
64 // TODO c++20 - replace with = default
66 {
67 return mLayer == other.mLayer && isVisible == other.isVisible &&
68 usingCurrentStyle == other.usingCurrentStyle && currentStyle == other.currentStyle &&
69 usingLegendItems == other.usingLegendItems && checkedLegendItems == other.checkedLegendItems &&
70 expandedLegendItems == other.expandedLegendItems && expandedLayerNode == other.expandedLayerNode;
71 }
73 {
74 return !( *this == other );
75 }
76
78 QgsMapLayer *layer() const { return mLayer; }
79
81 void setLayer( QgsMapLayer *layer );
82
87 bool isVisible = true;
88
90 bool usingCurrentStyle = false;
92 QString currentStyle;
94 bool usingLegendItems = false;
96 QSet<QString> checkedLegendItems;
97
102 QSet<QString> expandedLegendItems;
103
109 bool expandedLayerNode = false;
110 private:
113 };
114
121 class CORE_EXPORT MapThemeRecord
122 {
123 public:
124
126 {
127 return validLayerRecords() == other.validLayerRecords() &&
128 mHasExpandedStateInfo == other.mHasExpandedStateInfo &&
129 mExpandedGroupNodes == other.mExpandedGroupNodes && mCheckedGroupNodes == other.mCheckedGroupNodes;
130 }
132 {
133 return !( *this == other );
134 }
135
137 QList<QgsMapThemeCollection::MapThemeLayerRecord> layerRecords() const { return mLayerRecords; }
138
140 void setLayerRecords( const QList<QgsMapThemeCollection::MapThemeLayerRecord> &records ) { mLayerRecords = records; }
141
143 void removeLayerRecord( QgsMapLayer *layer );
144
146 void addLayerRecord( const QgsMapThemeCollection::MapThemeLayerRecord &record );
147
151 QHash<QgsMapLayer *, QgsMapThemeCollection::MapThemeLayerRecord> validLayerRecords() const SIP_SKIP;
152
158 bool hasExpandedStateInfo() const { return mHasExpandedStateInfo; }
159
166 bool hasCheckedStateInfo() const { return mHasCheckedStateInfo; } SIP_SKIP;
167
172 void setHasExpandedStateInfo( bool hasInfo ) { mHasExpandedStateInfo = hasInfo; }
173
179 void setHasCheckedStateInfo( bool hasInfo ) { mHasCheckedStateInfo = hasInfo; } SIP_SKIP;
180
188 QSet<QString> expandedGroupNodes() const { return mExpandedGroupNodes; }
189
197 QSet<QString> checkedGroupNodes() const { return mCheckedGroupNodes; }
198
203 void setExpandedGroupNodes( const QSet<QString> &expandedGroupNodes ) { mExpandedGroupNodes = expandedGroupNodes; }
204
209 void setCheckedGroupNodes( const QSet<QString> &checkedGroupNodes ) { mCheckedGroupNodes = checkedGroupNodes; }
210
211 private:
213 QList<MapThemeLayerRecord> mLayerRecords;
214
216 bool mHasExpandedStateInfo = false;
218 bool mHasCheckedStateInfo = false;
219
224 QSet<QString> mExpandedGroupNodes;
225
230 QSet<QString> mCheckedGroupNodes;
231
233 };
234
239
244 bool hasMapTheme( const QString &name ) const;
245
250 void insert( const QString &name, const QgsMapThemeCollection::MapThemeRecord &state );
251
258 void update( const QString &name, const QgsMapThemeCollection::MapThemeRecord &state );
259
264 void removeMapTheme( const QString &name );
265
271 bool renameMapTheme( const QString &name, const QString &newName );
272
274 void clear();
275
280 QStringList mapThemes() const;
281
286 QgsMapThemeCollection::MapThemeRecord mapThemeState( const QString &name ) const { return mMapThemes[name]; }
287
295 QStringList mapThemeVisibleLayerIds( const QString &name ) const;
296
304 QList<QgsMapLayer *> mapThemeVisibleLayers( const QString &name ) const;
305
310 QMap<QString, QString> mapThemeStyleOverrides( const QString &name );
311
317 void readXml( const QDomDocument &doc );
318
324 void writeXml( QDomDocument &doc );
325
332
338 void applyTheme( const QString &name, QgsLayerTreeGroup *root, QgsLayerTreeModel *model );
339
346
352
359 QList< QgsMapLayer * > masterLayerOrder() const;
360
368 QList< QgsMapLayer * > masterVisibleLayers() const;
369
370 signals:
371
377
382 void mapThemeChanged( const QString &theme );
383
388 void mapThemeRenamed( const QString &name, const QString &newName );
389
397
398 private slots:
399
403 void registryLayersRemoved( const QStringList &layerIDs );
404
406 void layerStyleRenamed( const QString &oldName, const QString &newName );
407
408 private:
409
413 void applyMapThemeCheckedLegendNodesToLayer( const MapThemeLayerRecord &layerRec, QgsMapLayer *layer );
414
418 void reconnectToLayersStyleManager();
419
420 static bool findRecordForLayer( QgsMapLayer *layer, const MapThemeRecord &rec, MapThemeLayerRecord &layerRec );
421 static MapThemeLayerRecord createThemeLayerRecord( QgsLayerTreeLayer *nodeLayer, QgsLayerTreeModel *model );
423 static void applyThemeToLayer( QgsLayerTreeLayer *nodeLayer, QgsLayerTreeModel *model, const MapThemeRecord &rec );
424 static void applyThemeToGroup( QgsLayerTreeGroup *parent, QgsLayerTreeModel *model, const MapThemeRecord &rec );
425
426 typedef QMap<QString, MapThemeRecord> MapThemeRecordMap;
427 MapThemeRecordMap mMapThemes;
429 QgsProject *mProject = nullptr;
430};
431
432
433#endif // QGSMAPTHEMECOLLECTION_H
Layer tree group node serves as a container for layers and further groups.
Layer tree node points to a map layer.
The QgsLayerTreeModel class is model implementation for Qt item views framework.
This class is a base class for nodes in a layer tree.
Base class for all map layer types.
Definition: qgsmaplayer.h:73
Individual record of a visible layer in a map theme record.
QString currentStyle
Name of the current style of the layer.
QSet< QString > expandedLegendItems
Rule keys of expanded legend items in layer tree view.
QSet< QString > checkedLegendItems
Rule keys of check legend items in layer tree model.
bool operator!=(const QgsMapThemeCollection::MapThemeLayerRecord &other) const
bool expandedLayerNode
Whether the layer's tree node is expanded (only to be applied if the parent MapThemeRecord has the in...
MapThemeLayerRecord(QgsMapLayer *l=nullptr)
Initialize layer record with a map layer - it will be stored as a weak pointer.
bool isVisible
true if the layer is visible in the associated theme.
bool usingLegendItems
Whether checkedLegendItems should be applied.
bool usingCurrentStyle
Whether current style is valid and should be applied.
QgsMapLayer * layer() const
Returns map layer or nullptr if the layer does not exist anymore.
bool operator==(const QgsMapThemeCollection::MapThemeLayerRecord &other) const
Individual map theme record of visible layers and styles.
bool operator!=(const QgsMapThemeCollection::MapThemeRecord &other) const
void setExpandedGroupNodes(const QSet< QString > &expandedGroupNodes)
Sets a set of group identifiers for group nodes that should have expanded state.
QSet< QString > expandedGroupNodes() const
Returns a set of group identifiers for group nodes that should have expanded state (other group nodes...
void setCheckedGroupNodes(const QSet< QString > &checkedGroupNodes)
Sets a set of group identifiers for group nodes that should have checked state.
void setHasExpandedStateInfo(bool hasInfo)
Sets whether the map theme contains valid expanded/collapsed state of nodes.
QList< QgsMapThemeCollection::MapThemeLayerRecord > layerRecords() const
Returns a list of records for all visible layer belonging to the theme.
bool operator==(const QgsMapThemeCollection::MapThemeRecord &other) const
QSet< QString > checkedGroupNodes() const
Returns a set of group identifiers for group nodes that should have checked state (other group nodes ...
void setLayerRecords(const QList< QgsMapThemeCollection::MapThemeLayerRecord > &records)
Sets layer records for the theme.
void setHasCheckedStateInfo(bool hasInfo)
Sets whether the map theme contains valid checked/unchecked state of group nodes.
QHash< QgsMapLayer *, QgsMapThemeCollection::MapThemeLayerRecord > validLayerRecords() const
Returns set with only records for valid layers.
bool hasCheckedStateInfo() const
Returns whether information about checked/unchecked state of groups has been recorded and thus whethe...
Container class that allows storage of map themes consisting of visible map layers and layer styles.
void mapThemesChanged()
Emitted when map themes within the collection are changed.
static QgsMapThemeCollection::MapThemeRecord createThemeFromCurrentState(QgsLayerTreeGroup *root, QgsLayerTreeModel *model)
Static method to create theme from the current state of layer visibilities in layer tree,...
void insert(const QString &name, const QgsMapThemeCollection::MapThemeRecord &state)
Inserts a new map theme to the collection.
bool renameMapTheme(const QString &name, const QString &newName)
Renames the existing map theme called name to newName.
void mapThemeRenamed(const QString &name, const QString &newName)
Emitted when a map theme within the collection is renamed.
void clear()
Removes all map themes from the collection.
bool hasMapTheme(const QString &name) const
Returns whether a map theme with a matching name exists.
QList< QgsMapLayer * > mapThemeVisibleLayers(const QString &name) const
Returns the list of layers that are visible for the specified map theme.
void removeMapTheme(const QString &name)
Removes an existing map theme from collection.
QgsMapThemeCollection::MapThemeRecord mapThemeState(const QString &name) const
Returns the recorded state of a map theme.
void setProject(QgsProject *project)
QList< QgsMapLayer * > masterLayerOrder() const
Returns the master layer order (this will always match the project's QgsProject::layerOrder() ).
void applyTheme(const QString &name, QgsLayerTreeGroup *root, QgsLayerTreeModel *model)
Apply theme given by its name and modify layer tree, current style of layers and checked legend items...
QMap< QString, QString > mapThemeStyleOverrides(const QString &name)
Gets layer style overrides (for QgsMapSettings) of the visible layers for given map theme.
QList< QgsMapLayer * > masterVisibleLayers() const
Returns the master list of visible layers.
QStringList mapThemeVisibleLayerIds(const QString &name) const
Returns the list of layer IDs that are visible for the specified map theme.
void update(const QString &name, const QgsMapThemeCollection::MapThemeRecord &state)
Updates a map theme within the collection.
void mapThemeChanged(const QString &theme)
Emitted when a map theme changes definition.
QgsProject * project()
The QgsProject on which this map theme collection works.
QgsMapThemeCollection(QgsProject *project=nullptr)
Create map theme collection that handles themes of the given project.
void writeXml(QDomDocument &doc)
Writes the map theme collection state to XML.
void projectChanged()
Emitted when the project changes.
void readXml(const QDomDocument &doc)
Reads the map theme collection state from XML.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition: qgsproject.h:105
#define SIP_SKIP
Definition: qgis_sip.h:126
QPointer< QgsMapLayer > QgsWeakMapLayerPointer
Weak pointer for QgsMapLayer.
Definition: qgsmaplayer.h:2180