Basic implementation of the labeling interface. More...

#include <qgsvectorlayerlabeling.h>

Inheritance diagram for QgsVectorLayerSimpleLabeling:

Public Member Functions
	QgsVectorLayerSimpleLabeling (const QgsPalLayerSettings &settings)
	Constructs simple labeling configuration with given initial settings. More...

QgsAbstractVectorLayerLabeling *	clone () const override
	Returns a new copy of the object. More...

QgsVectorLayerLabelProvider *	provider (QgsVectorLayer *layer) const override

bool	requiresAdvancedEffects () const override
	Returns `true` if drawing labels requires advanced effects like composition modes, which could prevent it being used as an isolated cached image or exported to a vector format. More...

QDomElement	save (QDomDocument &doc, const QgsReadWriteContext &context) const override
	Returns labeling configuration as XML element. More...

void	setSettings (QgsPalLayerSettings *settings, const QString &providerId=QString()) override
	Set pal settings (takes ownership). More...

QgsPalLayerSettings	settings (const QString &providerId=QString()) const override
	Gets associated label settings. More...

void	toSld (QDomNode &parent, const QgsStringMap &props) const override
	Writes the SE 1.1 TextSymbolizer element based on the current layer labeling settings. More...

QString	type () const override
	Unique type string of the labeling configuration implementation. More...

Public Member Functions inherited from QgsAbstractVectorLayerLabeling
	QgsAbstractVectorLayerLabeling ()=default
	Default constructor. More...

virtual	~QgsAbstractVectorLayerLabeling ()=default

virtual QStringList	subProviders () const
	Gets list of sub-providers within the layer's labeling. More...

Static Public Member Functions
static QgsVectorLayerSimpleLabeling *	create (const QDomElement &element, const QgsReadWriteContext &context)
	Create the instance from a DOM element with saved configuration. More...

Static Public Member Functions inherited from QgsAbstractVectorLayerLabeling
static QgsAbstractVectorLayerLabeling *	create (const QDomElement &element, const QgsReadWriteContext &context)
	Try to create instance of an implementation based on the XML data. More...

Additional Inherited Members
Protected Member Functions inherited from QgsAbstractVectorLayerLabeling
virtual void	writeTextSymbolizer (QDomNode &parent, QgsPalLayerSettings &settings, const QgsStringMap &props) const
	Writes a TextSymbolizer element contents based on the provided labeling settings. More...

Detailed Description

Basic implementation of the labeling interface.

The configuration is kept in layer's custom properties for backward compatibility.

Since: QGIS 3.0

Definition at line 144 of file qgsvectorlayerlabeling.h.

Constructor & Destructor Documentation

◆ QgsVectorLayerSimpleLabeling()

QgsVectorLayerSimpleLabeling::QgsVectorLayerSimpleLabeling ( const QgsPalLayerSettings & settings )

explicit

Constructs simple labeling configuration with given initial settings.

Definition at line 48 of file qgsvectorlayerlabeling.cpp.

Member Function Documentation

◆ clone()

QgsAbstractVectorLayerLabeling * QgsVectorLayerSimpleLabeling::clone ( ) const

overridevirtual

Returns a new copy of the object.

Implements QgsAbstractVectorLayerLabeling.

Definition at line 59 of file qgsvectorlayerlabeling.cpp.

◆ create()

QgsVectorLayerSimpleLabeling * QgsVectorLayerSimpleLabeling::create	(	const QDomElement &	element,
		const QgsReadWriteContext &	context
	)

static

Create the instance from a DOM element with saved configuration.

Definition at line 83 of file qgsvectorlayerlabeling.cpp.

◆ provider()

QgsVectorLayerLabelProvider * QgsVectorLayerSimpleLabeling::provider ( QgsVectorLayer * layer ) const

overridevirtual

Note: not available in Python bindings

Reimplemented from QgsAbstractVectorLayerLabeling.

Definition at line 43 of file qgsvectorlayerlabeling.cpp.

◆ requiresAdvancedEffects()

bool QgsVectorLayerSimpleLabeling::requiresAdvancedEffects ( ) const

overridevirtual

Returns true if drawing labels requires advanced effects like composition modes, which could prevent it being used as an isolated cached image or exported to a vector format.

Since: QGIS 3.0

Implements QgsAbstractVectorLayerLabeling.

Definition at line 78 of file qgsvectorlayerlabeling.cpp.

◆ save()

QDomElement QgsVectorLayerSimpleLabeling::save	(	QDomDocument &	doc,
		const QgsReadWriteContext &	context
	)		const

overridevirtual

Returns labeling configuration as XML element.

Implements QgsAbstractVectorLayerLabeling.

Definition at line 64 of file qgsvectorlayerlabeling.cpp.

◆ setSettings()

void QgsVectorLayerSimpleLabeling::setSettings	(	QgsPalLayerSettings *	settings,
		const QString &	providerId = `QString()`
	)

overridevirtual

Set pal settings (takes ownership).

Parameters

settings	Pal layer settings
providerId	Unused parameter

Since: QGIS 3.0

Implements QgsAbstractVectorLayerLabeling.

Definition at line 559 of file qgsvectorlayerlabeling.cpp.

◆ settings()

QgsPalLayerSettings QgsVectorLayerSimpleLabeling::settings ( const QString & providerId = QString() ) const

overridevirtual

Gets associated label settings.

In case of multiple sub-providers with different settings, they are identified by their ID (e.g. in case of rule-based labeling, provider ID == rule key)

Implements QgsAbstractVectorLayerLabeling.

Definition at line 72 of file qgsvectorlayerlabeling.cpp.