QGIS API Documentation 3.35.0-Master (f6e073f0eed)
Loading...
Searching...
No Matches
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
43class CORE_EXPORT QgsMapThemeCollection : public QObject
44{
45 Q_OBJECT
46
47 Q_PROPERTY( QStringList mapThemes READ mapThemes NOTIFY mapThemesChanged )
48 Q_PROPERTY( QgsProject *project READ project WRITE setProject NOTIFY projectChanged )
49
50 public:
51
56 class CORE_EXPORT MapThemeLayerRecord
57 {
58 public:
60 MapThemeLayerRecord( QgsMapLayer *l = nullptr ): mLayer( l ) {}
61
62 // TODO c++20 - replace with = default
64 {
65 return mLayer == other.mLayer && isVisible == other.isVisible &&
66 usingCurrentStyle == other.usingCurrentStyle && currentStyle == other.currentStyle &&
67 usingLegendItems == other.usingLegendItems && checkedLegendItems == other.checkedLegendItems &&
68 expandedLegendItems == other.expandedLegendItems && expandedLayerNode == other.expandedLayerNode;
69 }
71 {
72 return !( *this == other );
73 }
74
76 QgsMapLayer *layer() const { return mLayer; }
77
79 void setLayer( QgsMapLayer *layer );
80
85 bool isVisible = true;
86
88 bool usingCurrentStyle = false;
90 QString currentStyle;
92 bool usingLegendItems = false;
94 QSet<QString> checkedLegendItems;
95
100 QSet<QString> expandedLegendItems;
101
107 bool expandedLayerNode = false;
108 private:
111 };
112
118 class CORE_EXPORT MapThemeRecord
119 {
120 public:
121
123 {
124 return validLayerRecords() == other.validLayerRecords() &&
125 mHasExpandedStateInfo == other.mHasExpandedStateInfo &&
126 mExpandedGroupNodes == other.mExpandedGroupNodes && mCheckedGroupNodes == other.mCheckedGroupNodes;
127 }
129 {
130 return !( *this == other );
131 }
132
134 QList<QgsMapThemeCollection::MapThemeLayerRecord> layerRecords() const { return mLayerRecords; }
135
137 void setLayerRecords( const QList<QgsMapThemeCollection::MapThemeLayerRecord> &records ) { mLayerRecords = records; }
138
140 void removeLayerRecord( QgsMapLayer *layer );
141
143 void addLayerRecord( const QgsMapThemeCollection::MapThemeLayerRecord &record );
144
148 QHash<QgsMapLayer *, QgsMapThemeCollection::MapThemeLayerRecord> validLayerRecords() const SIP_SKIP;
149
155 bool hasExpandedStateInfo() const { return mHasExpandedStateInfo; }
156
162 bool hasCheckedStateInfo() const { return mHasCheckedStateInfo; };
163
168 void setHasExpandedStateInfo( bool hasInfo ) { mHasExpandedStateInfo = hasInfo; }
169
174 void setHasCheckedStateInfo( bool hasInfo ) { mHasCheckedStateInfo = hasInfo; };
175
183 QSet<QString> expandedGroupNodes() const { return mExpandedGroupNodes; }
184
192 QSet<QString> checkedGroupNodes() const { return mCheckedGroupNodes; }
193
198 void setExpandedGroupNodes( const QSet<QString> &expandedGroupNodes ) { mExpandedGroupNodes = expandedGroupNodes; }
199
204 void setCheckedGroupNodes( const QSet<QString> &checkedGroupNodes ) { mCheckedGroupNodes = checkedGroupNodes; }
205
206 private:
208 QList<MapThemeLayerRecord> mLayerRecords;
209
211 bool mHasExpandedStateInfo = false;
213 bool mHasCheckedStateInfo = false;
214
219 QSet<QString> mExpandedGroupNodes;
220
225 QSet<QString> mCheckedGroupNodes;
226
228 };
229
233 QgsMapThemeCollection( QgsProject *project = nullptr );
234
238 bool hasMapTheme( const QString &name ) const;
239
244 void insert( const QString &name, const QgsMapThemeCollection::MapThemeRecord &state );
245
252 void update( const QString &name, const QgsMapThemeCollection::MapThemeRecord &state );
253
257 void removeMapTheme( const QString &name );
258
264 bool renameMapTheme( const QString &name, const QString &newName );
265
267 void clear();
268
272 QStringList mapThemes() const;
273
277 QgsMapThemeCollection::MapThemeRecord mapThemeState( const QString &name ) const { return mMapThemes[name]; }
278
285 QStringList mapThemeVisibleLayerIds( const QString &name ) const;
286
293 QList<QgsMapLayer *> mapThemeVisibleLayers( const QString &name ) const;
294
298 QMap<QString, QString> mapThemeStyleOverrides( const QString &name );
299
305 void readXml( const QDomDocument &doc );
306
312 void writeXml( QDomDocument &doc );
313
318 static QgsMapThemeCollection::MapThemeRecord createThemeFromCurrentState( QgsLayerTreeGroup *root, QgsLayerTreeModel *model );
319
324 void applyTheme( const QString &name, QgsLayerTreeGroup *root, QgsLayerTreeModel *model );
325
331
335 void setProject( QgsProject *project );
336
342 QList< QgsMapLayer * > masterLayerOrder() const;
343
350 QList< QgsMapLayer * > masterVisibleLayers() const;
351
352 signals:
353
358
362 void mapThemeChanged( const QString &theme );
363
368 void mapThemeRenamed( const QString &name, const QString &newName );
369
376
377 private slots:
378
382 void registryLayersRemoved( const QStringList &layerIDs );
383
385 void layerStyleRenamed( const QString &oldName, const QString &newName );
386
387 private:
388
392 void applyMapThemeCheckedLegendNodesToLayer( const MapThemeLayerRecord &layerRec, QgsMapLayer *layer );
393
397 void reconnectToLayersStyleManager();
398
399 static bool findRecordForLayer( QgsMapLayer *layer, const MapThemeRecord &rec, MapThemeLayerRecord &layerRec );
400 static MapThemeLayerRecord createThemeLayerRecord( QgsLayerTreeLayer *nodeLayer, QgsLayerTreeModel *model );
401 static void createThemeFromCurrentState( QgsLayerTreeGroup *parent, QgsLayerTreeModel *model, MapThemeRecord &rec );
402 static void applyThemeToLayer( QgsLayerTreeLayer *nodeLayer, QgsLayerTreeModel *model, const MapThemeRecord &rec );
403 static void applyThemeToGroup( QgsLayerTreeGroup *parent, QgsLayerTreeModel *model, const MapThemeRecord &rec );
404
405 typedef QMap<QString, MapThemeRecord> MapThemeRecordMap;
406 MapThemeRecordMap mMapThemes;
408 QgsProject *mProject = nullptr;
409};
410
411
412#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:75
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.
void mapThemeRenamed(const QString &name, const QString &newName)
Emitted when a map theme within the collection is renamed.
QgsMapThemeCollection::MapThemeRecord mapThemeState(const QString &name) const
Returns the recorded state of a map theme.
void mapThemeChanged(const QString &theme)
Emitted when a map theme changes definition.
QgsProject * project()
The QgsProject on which this map theme collection works.
void projectChanged()
Emitted when the project changes.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition qgsproject.h:107
#define SIP_SKIP
Definition qgis_sip.h:126
QPointer< QgsMapLayer > QgsWeakMapLayerPointer
Weak pointer for QgsMapLayer.