QGIS API Documentation  3.13.0-Master (7f54853aae)
Static Public Member Functions | List of all members
QgsLabelingUtils Class Reference

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

#include <qgslabelingengine.h>

Static Public Member Functions

static QgsLabeling::LinePlacementFlags decodeLinePlacementFlags (const QString &string)
 Decodes a string to set of line placement flags. More...
 
static QVector< QgsPalLayerSettings::PredefinedPointPositiondecodePredefinedPositionOrder (const QString &positionString)
 Decodes a string to an ordered list of predefined point label positions. More...
 
static QString encodeLinePlacementFlags (QgsLabeling::LinePlacementFlags flags)
 Encodes line placement flags to a string. More...
 
static QString encodePredefinedPositionOrder (const QVector< QgsPalLayerSettings::PredefinedPointPosition > &positions)
 Encodes an ordered list of predefined point label positions to a string. More...
 

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
Since
QGIS 2.14

Definition at line 397 of file qgslabelingengine.h.

Member Function Documentation

◆ decodeLinePlacementFlags()

QgsLabeling::LinePlacementFlags QgsLabelingUtils::decodeLinePlacementFlags ( const QString &  string)
static

Decodes a string to set of line placement flags.

See also
encodeLinePlacementFlags()

Definition at line 754 of file qgslabelingengine.cpp.

◆ decodePredefinedPositionOrder()

QVector< QgsPalLayerSettings::PredefinedPointPosition > QgsLabelingUtils::decodePredefinedPositionOrder ( const QString &  positionString)
static

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

Parameters
positionStringencoded string of positions
Returns
decoded list
See also
encodePredefinedPositionOrder()

Definition at line 704 of file qgslabelingengine.cpp.

◆ encodeLinePlacementFlags()

QString QgsLabelingUtils::encodeLinePlacementFlags ( QgsLabeling::LinePlacementFlags  flags)
static

Encodes line placement flags to a string.

See also
decodeLinePlacementFlags()

Definition at line 740 of file qgslabelingengine.cpp.

◆ encodePredefinedPositionOrder()

QString QgsLabelingUtils::encodePredefinedPositionOrder ( const QVector< QgsPalLayerSettings::PredefinedPointPosition > &  positions)
static

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

Parameters
positionsorder list of positions
Returns
list encoded to string
See also
decodePredefinedPositionOrder()

Definition at line 655 of file qgslabelingengine.cpp.


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