QGIS API Documentation  3.11.0-Master (68611307d7)
Public Member Functions | Friends | List of all members
QgsMapThemeCollection::MapThemeRecord Class Reference

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. More...
 
QSet< QString > checkedGroupNodes () const
 Returns a set of group identifiers for group nodes that should have checked state (other group nodes should be unchecked). More...
 
QSet< QString > expandedGroupNodes () const
 Returns a set of group identifiers for group nodes that should have expanded state (other group nodes should be collapsed). More...
 
bool hasCheckedStateInfo () const
 Returns whether information about checked/unchecked state of groups has been recorded and thus whether checkedGroupNodes() is valid. More...
 
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. More...
 
QList< QgsMapThemeCollection::MapThemeLayerRecordlayerRecords () const
 Returns a list of records for all visible layer belonging to the theme. More...
 
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. More...
 
void setCheckedGroupNodes (const QSet< QString > &checkedGroupNodes)
 Sets a set of group identifiers for group nodes that should have checked state. More...
 
void setExpandedGroupNodes (const QSet< QString > &expandedGroupNodes)
 Sets a set of group identifiers for group nodes that should have expanded state. More...
 
void setHasCheckedStateInfo (bool hasInfo)
 Sets whether the map theme contains valid checked/unchecked state of group nodes. More...
 
void setHasExpandedStateInfo (bool hasInfo)
 Sets whether the map theme contains valid expanded/collapsed state of nodes. More...
 
void setLayerRecords (const QList< QgsMapThemeCollection::MapThemeLayerRecord > &records)
 Sets layer records for the theme. More...
 
QHash< QgsMapLayer *, QgsMapThemeCollection::MapThemeLayerRecordvalidLayerRecords () const
 Returns set with only records for valid layers. More...
 

Friends

class QgsMapThemeCollection
 

Detailed Description

Individual map theme record of visible layers and styles.

Since
QGIS 3.0, Previously called PresetRecord

Definition at line 114 of file qgsmapthemecollection.h.

Member Function Documentation

◆ addLayerRecord()

void QgsMapThemeCollection::MapThemeRecord::addLayerRecord ( const QgsMapThemeCollection::MapThemeLayerRecord record)

Add a new record for a layer.

Definition at line 713 of file qgsmapthemecollection.cpp.

◆ checkedGroupNodes()

QSet<QString> QgsMapThemeCollection::MapThemeRecord::checkedGroupNodes ( ) const
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"

Since
QGIS 3.10.1

Definition at line 190 of file qgsmapthemecollection.h.

◆ expandedGroupNodes()

QSet<QString> QgsMapThemeCollection::MapThemeRecord::expandedGroupNodes ( ) const
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"

Since
QGIS 3.2

Definition at line 181 of file qgsmapthemecollection.h.

◆ hasCheckedStateInfo()

bool QgsMapThemeCollection::MapThemeRecord::hasCheckedStateInfo ( ) const
inline

Returns whether information about checked/unchecked state of groups has been recorded and thus whether checkedGroupNodes() is valid.

Note
Not available in Python bindings
Since
QGIS 3.10.1

Definition at line 159 of file qgsmapthemecollection.h.

◆ hasExpandedStateInfo()

bool QgsMapThemeCollection::MapThemeRecord::hasExpandedStateInfo ( ) const
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.

Since
QGIS 3.2

Definition at line 151 of file qgsmapthemecollection.h.

◆ layerRecords()

QList<QgsMapThemeCollection::MapThemeLayerRecord> QgsMapThemeCollection::MapThemeRecord::layerRecords ( ) const
inline

Returns a list of records for all visible layer belonging to the theme.

Definition at line 130 of file qgsmapthemecollection.h.

◆ operator!=()

bool QgsMapThemeCollection::MapThemeRecord::operator!= ( const QgsMapThemeCollection::MapThemeRecord other) const
inline

Definition at line 124 of file qgsmapthemecollection.h.

◆ operator==()

bool QgsMapThemeCollection::MapThemeRecord::operator== ( const QgsMapThemeCollection::MapThemeRecord other) const
inline

Definition at line 118 of file qgsmapthemecollection.h.

◆ removeLayerRecord()

void QgsMapThemeCollection::MapThemeRecord::removeLayerRecord ( QgsMapLayer layer)

Removes a record for layer if present.

Definition at line 704 of file qgsmapthemecollection.cpp.

◆ setCheckedGroupNodes()

void QgsMapThemeCollection::MapThemeRecord::setCheckedGroupNodes ( const QSet< QString > &  checkedGroupNodes)
inline

Sets a set of group identifiers for group nodes that should have checked state.

See checkedGroupNodes().

Since
QGIS 3.10.1

Definition at line 202 of file qgsmapthemecollection.h.

◆ setExpandedGroupNodes()

void QgsMapThemeCollection::MapThemeRecord::setExpandedGroupNodes ( const QSet< QString > &  expandedGroupNodes)
inline

Sets a set of group identifiers for group nodes that should have expanded state.

See expandedGroupNodes().

Since
QGIS 3.2

Definition at line 196 of file qgsmapthemecollection.h.

◆ setHasCheckedStateInfo()

void QgsMapThemeCollection::MapThemeRecord::setHasCheckedStateInfo ( bool  hasInfo)
inline

Sets whether the map theme contains valid checked/unchecked state of group nodes.

Note
Not available in Python bindings
Since
QGIS 3.10.1

Definition at line 172 of file qgsmapthemecollection.h.

◆ setHasExpandedStateInfo()

void QgsMapThemeCollection::MapThemeRecord::setHasExpandedStateInfo ( bool  hasInfo)
inline

Sets whether the map theme contains valid expanded/collapsed state of nodes.

Since
QGIS 3.2

Definition at line 165 of file qgsmapthemecollection.h.

◆ setLayerRecords()

void QgsMapThemeCollection::MapThemeRecord::setLayerRecords ( const QList< QgsMapThemeCollection::MapThemeLayerRecord > &  records)
inline

Sets layer records for the theme.

Definition at line 133 of file qgsmapthemecollection.h.

◆ validLayerRecords()

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

Returns set with only records for valid layers.

Definition at line 718 of file qgsmapthemecollection.cpp.

Friends And Related Function Documentation

◆ QgsMapThemeCollection

friend class QgsMapThemeCollection
friend

Definition at line 225 of file qgsmapthemecollection.h.


The documentation for this class was generated from the following files: