QGIS API Documentation  3.17.0-Master (3b262f2a79)
Public Member Functions | Public Attributes | List of all members
QgsMapThemeCollection::MapThemeLayerRecord Class Reference

Individual record of a visible layer in a map theme record. More...

#include <qgsmapthemecollection.h>

Public Member Functions

 MapThemeLayerRecord (QgsMapLayer *l=nullptr)
 Initialize layer record with a map layer - it will be stored as a weak pointer. More...
 
QgsMapLayerlayer () const
 Returns map layer or nullptr if the layer does not exist anymore. More...
 
bool operator!= (const QgsMapThemeCollection::MapThemeLayerRecord &other) const
 
bool operator== (const QgsMapThemeCollection::MapThemeLayerRecord &other) const
 
void setLayer (QgsMapLayer *layer)
 Sets the map layer for this record. More...
 

Public Attributes

QSet< QString > checkedLegendItems
 Rule keys of check legend items in layer tree model. More...
 
QString currentStyle
 Name of the current style of the layer. More...
 
bool expandedLayerNode = false
 Whether the layer's tree node is expanded (only to be applied if the parent MapThemeRecord has the information about expanded nodes stored) More...
 
QSet< QString > expandedLegendItems
 Rule keys of expanded legend items in layer tree view. More...
 
bool isVisible = true
 true if the layer is visible in the associated theme. More...
 
bool usingCurrentStyle = false
 Whether current style is valid and should be applied. More...
 
bool usingLegendItems = false
 Whether checkedLegendItems should be applied. More...
 

Detailed Description

Individual record of a visible layer in a map theme record.

Since
QGIS 3.0

Definition at line 58 of file qgsmapthemecollection.h.

Constructor & Destructor Documentation

◆ MapThemeLayerRecord()

QgsMapThemeCollection::MapThemeLayerRecord::MapThemeLayerRecord ( QgsMapLayer l = nullptr)
inline

Initialize layer record with a map layer - it will be stored as a weak pointer.

Definition at line 62 of file qgsmapthemecollection.h.

Member Function Documentation

◆ layer()

QgsMapLayer* QgsMapThemeCollection::MapThemeLayerRecord::layer ( ) const
inline

Returns map layer or nullptr if the layer does not exist anymore.

Definition at line 77 of file qgsmapthemecollection.h.

◆ operator!=()

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

Definition at line 71 of file qgsmapthemecollection.h.

◆ operator==()

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

Definition at line 64 of file qgsmapthemecollection.h.

◆ setLayer()

void QgsMapThemeCollection::MapThemeLayerRecord::setLayer ( QgsMapLayer layer)

Sets the map layer for this record.

Definition at line 745 of file qgsmapthemecollection.cpp.

Member Data Documentation

◆ checkedLegendItems

QSet<QString> QgsMapThemeCollection::MapThemeLayerRecord::checkedLegendItems

Rule keys of check legend items in layer tree model.

Definition at line 95 of file qgsmapthemecollection.h.

◆ currentStyle

QString QgsMapThemeCollection::MapThemeLayerRecord::currentStyle

Name of the current style of the layer.

Definition at line 91 of file qgsmapthemecollection.h.

◆ expandedLayerNode

bool QgsMapThemeCollection::MapThemeLayerRecord::expandedLayerNode = false

Whether the layer's tree node is expanded (only to be applied if the parent MapThemeRecord has the information about expanded nodes stored)

Since
QGIS 3.2

Definition at line 108 of file qgsmapthemecollection.h.

◆ expandedLegendItems

QSet<QString> QgsMapThemeCollection::MapThemeLayerRecord::expandedLegendItems

Rule keys of expanded legend items in layer tree view.

Since
QGIS 3.2

Definition at line 101 of file qgsmapthemecollection.h.

◆ isVisible

bool QgsMapThemeCollection::MapThemeLayerRecord::isVisible = true

true if the layer is visible in the associated theme.

Since
QGIS 3.14

Definition at line 86 of file qgsmapthemecollection.h.

◆ usingCurrentStyle

bool QgsMapThemeCollection::MapThemeLayerRecord::usingCurrentStyle = false

Whether current style is valid and should be applied.

Definition at line 89 of file qgsmapthemecollection.h.

◆ usingLegendItems

bool QgsMapThemeCollection::MapThemeLayerRecord::usingLegendItems = false

Whether checkedLegendItems should be applied.

Definition at line 93 of file qgsmapthemecollection.h.


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