QgsPalLabeling Class Reference

#include <qgspallabeling.h>

Static Public Member Functions
static void	drawLabelCandidateRect (pal::LabelPosition *lp, QPainter *painter, const QgsMapToPixel *xform, QList< QgsLabelCandidate > *candidates=nullptr)
static bool	geometryRequiresPreparation (const QgsGeometry &geometry, QgsRenderContext &context, const QgsCoordinateTransform &ct, const QgsGeometry &clipGeometry=QgsGeometry())
	Checks whether a geometry requires preparation before registration with PAL. More...
static QgsGeometry	prepareGeometry (const QgsGeometry &geometry, QgsRenderContext &context, const QgsCoordinateTransform &ct, const QgsGeometry &clipGeometry=QgsGeometry())
	Prepares a geometry for registration with PAL. More...
static QStringList	splitToGraphemes (const QString &text)
	Splits a text string to a list of graphemes, which are the smallest allowable character divisions in the string. More...
static QStringList	splitToLines (const QString &text, const QString &wrapCharacter)
	Splits a text string to a list of separate lines, using a specified wrap character. More...
static bool	staticWillUseLayer (QgsVectorLayer *layer)
	called to find out whether the layer is used for labeling More...

Friends
class	QgsDxfExport
class	QgsPalLayerSettings
class	QgsVectorLayerLabelProvider

Detailed Description

Definition at line 953 of file qgspallabeling.h.

Member Function Documentation

drawLabelCandidateRect()

void QgsPalLabeling::drawLabelCandidateRect ( pal::LabelPosition *  lp, QPainter *  painter, const QgsMapToPixel *  xform, QList< QgsLabelCandidate > *  candidates = nullptr  )

static

Note

not available in Python bindings

Definition at line 3418 of file qgspallabeling.cpp.

geometryRequiresPreparation()

bool QgsPalLabeling::geometryRequiresPreparation ( const QgsGeometry &  geometry, QgsRenderContext &  context, const QgsCoordinateTransform &  ct, const QgsGeometry &  clipGeometry = QgsGeometry()  )

static

Checks whether a geometry requires preparation before registration with PAL.

Parameters

geometry	geometry to prepare
context	render context
ct	coordinate transform, or invalid transform if no transformation required
clipGeometry	geometry to clip features to, if applicable

Returns

true if geometry requires preparation

Since

QGIS 2.9

Definition at line 2820 of file qgspallabeling.cpp.

prepareGeometry()

QgsGeometry QgsPalLabeling::prepareGeometry ( const QgsGeometry &  geometry, QgsRenderContext &  context, const QgsCoordinateTransform &  ct, const QgsGeometry &  clipGeometry = QgsGeometry()  )

static

Prepares a geometry for registration with PAL.

Handles reprojection, rotation, clipping, etc.

Parameters

geometry	geometry to prepare
context	render context
ct	coordinate transform, or invalid transform if no transformation required
clipGeometry	geometry to clip features to, if applicable

Returns

prepared geometry

Since

QGIS 2.9

Definition at line 2880 of file qgspallabeling.cpp.

splitToGraphemes()

QStringList QgsPalLabeling::splitToGraphemes ( const QString &  text )

static

Splits a text string to a list of graphemes, which are the smallest allowable character divisions in the string.

This accounts for scripts were individual characters are not allowed to be split apart (e.g., Arabic and Indic based scripts)

Parameters

text	string to split

Returns

list of graphemes

Since

QGIS 2.10

Definition at line 2866 of file qgspallabeling.cpp.

splitToLines()

QStringList QgsPalLabeling::splitToLines ( const QString &  text, const QString &  wrapCharacter  )

static

Splits a text string to a list of separate lines, using a specified wrap character.

The text string will be split on either newline characters or the wrap character.

Parameters

text	text string to split
wrapCharacter	additional character to wrap on

Returns

list of text split to lines

Since

QGIS 2.9

Definition at line 2847 of file qgspallabeling.cpp.

staticWillUseLayer()

bool QgsPalLabeling::staticWillUseLayer ( QgsVectorLayer *  layer )

static

called to find out whether the layer is used for labeling

Since

QGIS 2.4

Definition at line 2814 of file qgspallabeling.cpp.

Friends And Related Function Documentation

QgsDxfExport

friend class QgsDxfExport

friend

Definition at line 1030 of file qgspallabeling.h.

QgsPalLayerSettings

friend class QgsPalLayerSettings

friend

Definition at line 1042 of file qgspallabeling.h.

QgsVectorLayerLabelProvider

friend class QgsVectorLayerLabelProvider

friend

Definition at line 1029 of file qgspallabeling.h.

---

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

• /tmp/buildd/qgis-3.2.0+99unstable/src/core/qgspallabeling.h
• /tmp/buildd/qgis-3.2.0+99unstable/src/core/qgspallabeling.cpp