QGIS API Documentation 3.39.0-Master (9ea1ddbe645)
|
Individual map theme record of visible layers and styles. More...
#include <qgsmapthemecollection.h>
Public Member Functions | |
void | addLayerRecord (const QgsMapThemeCollection::MapThemeLayerRecord &record) |
Add a new record for a layer. | |
QSet< QString > | checkedGroupNodes () const |
Returns a set of group identifiers for group nodes that should have checked state (other group nodes should be unchecked). | |
QSet< QString > | expandedGroupNodes () const |
Returns a set of group identifiers for group nodes that should have expanded state (other group nodes should be collapsed). | |
bool | hasCheckedStateInfo () const |
Returns whether information about checked/unchecked state of groups has been recorded and thus whether checkedGroupNodes() is valid. | |
bool | hasExpandedStateInfo () const |
Returns whether information about expanded/collapsed state of nodes has been recorded and thus whether expandedGroupNodes() and expandedLegendItems + expandedLayerNode from layer records are valid. | |
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 |
bool | operator== (const QgsMapThemeCollection::MapThemeRecord &other) const |
void | removeLayerRecord (QgsMapLayer *layer) |
Removes a record for layer if present. | |
void | setCheckedGroupNodes (const QSet< QString > &checkedGroupNodes) |
Sets a set of group identifiers for group nodes that should have checked state. | |
void | setExpandedGroupNodes (const QSet< QString > &expandedGroupNodes) |
Sets a set of group identifiers for group nodes that should have expanded state. | |
void | setHasCheckedStateInfo (bool hasInfo) |
Sets whether the map theme contains valid checked/unchecked state of group nodes. | |
void | setHasExpandedStateInfo (bool hasInfo) |
Sets whether the map theme contains valid expanded/collapsed state of nodes. | |
void | setLayerRecords (const QList< QgsMapThemeCollection::MapThemeLayerRecord > &records) |
Sets layer records for the theme. | |
QHash< QgsMapLayer *, QgsMapThemeCollection::MapThemeLayerRecord > | validLayerRecords () const |
Returns set with only records for valid layers. | |
Friends | |
class | QgsMapThemeCollection |
Individual map theme record of visible layers and styles.
Definition at line 118 of file qgsmapthemecollection.h.
void QgsMapThemeCollection::MapThemeRecord::addLayerRecord | ( | const QgsMapThemeCollection::MapThemeLayerRecord & | record | ) |
Add a new record for a layer.
Definition at line 727 of file qgsmapthemecollection.cpp.
|
inline |
Returns a set of group identifiers for group nodes that should have checked state (other group nodes should be unchecked).
The returned value is valid only when hasCheckedStateInfo() returns true
. Group identifiers are built using group names, a sub-group name is prepended by parent group's identifier and a forward slash, e.g. "level1/level2"
Definition at line 192 of file qgsmapthemecollection.h.
|
inline |
Returns a set of group identifiers for group nodes that should have expanded state (other group nodes should be collapsed).
The returned value is valid only when hasExpandedStateInfo() returns true
. Group identifiers are built using group names, a sub-group name is prepended by parent group's identifier and a forward slash, e.g. "level1/level2"
Definition at line 183 of file qgsmapthemecollection.h.
|
inline |
Returns whether information about checked/unchecked state of groups has been recorded and thus whether checkedGroupNodes() is valid.
Definition at line 162 of file qgsmapthemecollection.h.
|
inline |
Returns whether information about expanded/collapsed state of nodes has been recorded and thus whether expandedGroupNodes() and expandedLegendItems + expandedLayerNode from layer records are valid.
Definition at line 155 of file qgsmapthemecollection.h.
|
inline |
Returns a list of records for all visible layer belonging to the theme.
Definition at line 134 of file qgsmapthemecollection.h.
|
inline |
Definition at line 128 of file qgsmapthemecollection.h.
|
inline |
Definition at line 122 of file qgsmapthemecollection.h.
void QgsMapThemeCollection::MapThemeRecord::removeLayerRecord | ( | QgsMapLayer * | layer | ) |
Removes a record for layer if present.
Definition at line 718 of file qgsmapthemecollection.cpp.
|
inline |
Sets a set of group identifiers for group nodes that should have checked state.
See checkedGroupNodes().
Definition at line 204 of file qgsmapthemecollection.h.
|
inline |
Sets a set of group identifiers for group nodes that should have expanded state.
See expandedGroupNodes().
Definition at line 198 of file qgsmapthemecollection.h.
|
inline |
Sets whether the map theme contains valid checked/unchecked state of group nodes.
Definition at line 174 of file qgsmapthemecollection.h.
|
inline |
Sets whether the map theme contains valid expanded/collapsed state of nodes.
Definition at line 168 of file qgsmapthemecollection.h.
|
inline |
Sets layer records for the theme.
Definition at line 137 of file qgsmapthemecollection.h.
QHash< QgsMapLayer *, QgsMapThemeCollection::MapThemeLayerRecord > QgsMapThemeCollection::MapThemeRecord::validLayerRecords | ( | ) | const |
Returns set with only records for valid layers.
Definition at line 732 of file qgsmapthemecollection.cpp.
|
friend |
Definition at line 227 of file qgsmapthemecollection.h.