QGIS API Documentation  3.23.0-Master (22c16f2067)
Public Member Functions | List of all members
QgsVectorTileLabeling Class Referenceabstract

Base class for labeling configuration classes for vector tile layers. More...

#include <qgsvectortilelabeling.h>

Inheritance diagram for QgsVectorTileLabeling:
Inheritance graph
[legend]

Public Member Functions

virtual ~QgsVectorTileLabeling ()=default
 
virtual QgsVectorTileLabelingclone () const =0SIP_FACTORY
 Returns a new copy of the object. More...
 
virtual QgsVectorTileLabelProviderprovider (QgsVectorTileLayer *layer) const SIP_SKIP
 Factory for label provider implementation. More...
 
virtual void readXml (const QDomElement &elem, const QgsReadWriteContext &context)=0
 Reads labeling properties from given XML element. More...
 
virtual void resolveReferences (const QgsProject &project)
 Resolves references to other objects - second phase of loading - after readXml() More...
 
virtual QString type () const =0
 Unique type string of the labeling configuration implementation. More...
 
virtual void writeXml (QDomElement &elem, const QgsReadWriteContext &context) const =0
 Writes labeling properties to given XML element. More...
 

Detailed Description

Base class for labeling configuration classes for vector tile layers.

Since
QGIS 3.14

Definition at line 70 of file qgsvectortilelabeling.h.

Constructor & Destructor Documentation

◆ ~QgsVectorTileLabeling()

virtual QgsVectorTileLabeling::~QgsVectorTileLabeling ( )
virtualdefault

Member Function Documentation

◆ clone()

virtual QgsVectorTileLabeling* QgsVectorTileLabeling::clone ( ) const
pure virtual

Returns a new copy of the object.

Implemented in QgsVectorTileBasicLabeling.

◆ provider()

virtual QgsVectorTileLabelProvider* QgsVectorTileLabeling::provider ( QgsVectorTileLayer layer) const
inlinevirtual

Factory for label provider implementation.

Note
not available in Python bindings

Reimplemented in QgsVectorTileBasicLabeling.

Definition at line 98 of file qgsvectortilelabeling.h.

◆ readXml()

virtual void QgsVectorTileLabeling::readXml ( const QDomElement &  elem,
const QgsReadWriteContext context 
)
pure virtual

Reads labeling properties from given XML element.

Implemented in QgsVectorTileBasicLabeling.

◆ resolveReferences()

virtual void QgsVectorTileLabeling::resolveReferences ( const QgsProject project)
inlinevirtual

Resolves references to other objects - second phase of loading - after readXml()

Definition at line 105 of file qgsvectortilelabeling.h.

◆ type()

virtual QString QgsVectorTileLabeling::type ( ) const
pure virtual

Unique type string of the labeling configuration implementation.

Implemented in QgsVectorTileBasicLabeling.

◆ writeXml()

virtual void QgsVectorTileLabeling::writeXml ( QDomElement &  elem,
const QgsReadWriteContext context 
) const
pure virtual

Writes labeling properties to given XML element.

Implemented in QgsVectorTileBasicLabeling.


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