QgsLabelingUtils Class Reference

Contains helper utilities for working with QGIS' labeling engine. More...

#include <qgslabelingengine.h>

Static Public Member Functions
static Qgis::LabelLinePlacementFlags	decodeLinePlacementFlags (const QString &string)
	Decodes a string to set of line placement flags.
static QVector< Qgis::LabelPredefinedPointPosition >	decodePredefinedPositionOrder (const QString &positionString)
	Decodes a string to an ordered list of predefined point label positions.
static QString	encodeLinePlacementFlags (Qgis::LabelLinePlacementFlags flags)
	Encodes line placement flags to a string.
static QString	encodePredefinedPositionOrder (const QVector< Qgis::LabelPredefinedPointPosition > &positions)
	Encodes an ordered list of predefined point label positions to a string.

Detailed Description

Contains helper utilities for working with QGIS' labeling engine.

Note

this class is not a part of public API yet. See notes in QgsLabelingEngine

not available in Python bindings

Definition at line 545 of file qgslabelingengine.h.

Member Function Documentation

decodeLinePlacementFlags()

Qgis::LabelLinePlacementFlags QgsLabelingUtils::decodeLinePlacementFlags ( const QString &  string )

static

Decodes a string to set of line placement flags.

See also

encodeLinePlacementFlags()

Definition at line 840 of file qgslabelingengine.cpp.

decodePredefinedPositionOrder()

QVector< Qgis::LabelPredefinedPointPosition > QgsLabelingUtils::decodePredefinedPositionOrder ( const QString &  positionString )

static

Decodes a string to an ordered list of predefined point label positions.

Parameters

positionString

encoded string of positions

Returns

decoded list

See also

encodePredefinedPositionOrder()

Definition at line 788 of file qgslabelingengine.cpp.

encodeLinePlacementFlags()

QString QgsLabelingUtils::encodeLinePlacementFlags ( Qgis::LabelLinePlacementFlags  flags )

static

Encodes line placement flags to a string.

See also

decodeLinePlacementFlags()

Definition at line 826 of file qgslabelingengine.cpp.

encodePredefinedPositionOrder()

QString QgsLabelingUtils::encodePredefinedPositionOrder ( const QVector< Qgis::LabelPredefinedPointPosition > &  positions )

static

Encodes an ordered list of predefined point label positions to a string.

Parameters

positions

order list of positions

Returns

list encoded to string

See also

decodePredefinedPositionOrder()

Definition at line 736 of file qgslabelingengine.cpp.

---

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

• /build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/core/labeling/qgslabelingengine.h
• /build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/core/labeling/qgslabelingengine.cpp