#include <qgspallabeling.h>

Inheritance diagram for QgsPalLabeling:

Public Types
enum	DrawLabelType { LabelText = 0, LabelBuffer, LabelShape, LabelSVG, LabelShadow }

enum	Search { Chain, Popmusic_Tabu, Popmusic_Chain, Popmusic_Tabu_Chain, Falp }

Public Member Functions
	QgsPalLabeling ()

	~QgsPalLabeling ()

virtual Q_DECL_DEPRECATED int	addDiagramLayer (QgsVectorLayer layer, const QgsDiagramLayerSettings s) override
	adds a diagram layer to the labeling engine More...

Q_DECL_DEPRECATED const QList< QgsLabelCandidate > &	candidates ()

virtual void	clearActiveLayer (const QString &layerID) override
	clears data defined objects from PAL layer settings for a registered layer More...

virtual void	clearActiveLayers () override
	clears all PAL layer settings for registered layers More...

void	clearEngineSettings ()

virtual QgsPalLabeling *	clone () override
	called when passing engine among map renderers More...

virtual void	drawLabeling (QgsRenderContext &context) override
	called when the map is drawn and labels should be placed More...

bool	drawLabelRectOnly () const
	Returns whether the engine will only draw the outline rectangles of labels, not the label contents themselves. More...

virtual void	exit () override
	called when we're done with rendering More...

virtual Q_DECL_DEPRECATED void	init (QgsMapRenderer *mr) override
	called when we're going to start with rendering More...

virtual void	init (const QgsMapSettings &mapSettings) override
	called when we're going to start with rendering More...

bool	isDrawingOutlineLabels () const

bool	isShowingAllLabels () const

bool	isShowingCandidates () const

bool	isShowingPartialsLabels () const

bool	isShowingShadowRectangles () const

Q_DECL_DEPRECATED bool	isStoredWithProject () const

virtual Q_DECL_DEPRECATED QList< QgsLabelPosition >	labelsAtPosition (const QgsPoint &p) override
	return infos about labels at a given (map) position More...

virtual Q_DECL_DEPRECATED QList< QgsLabelPosition >	labelsWithinRect (const QgsRectangle &r) override
	return infos about labels within a given (map) rectangle More...

Q_DECL_DEPRECATED QgsPalLayerSettings &	layer (const QString &layerName) override

void	loadEngineSettings ()
	load/save engine settings to project file More...

void	numCandidatePositions (int &candPoint, int &candLine, int &candPolygon)

virtual int	prepareDiagramLayer (QgsVectorLayer *layer, QStringList &attrNames, QgsRenderContext &ctx) override
	adds a diagram layer to the labeling engine More...

virtual int	prepareLayer (QgsVectorLayer *layer, QStringList &attrNames, QgsRenderContext &ctx) override
	hook called when drawing layer before issuing select() More...

virtual void	registerDiagramFeature (const QString &layerID, QgsFeature &feat, QgsRenderContext &context) override
	called for every diagram feature More...

virtual void	registerFeature (const QString &layerID, QgsFeature &feat, QgsRenderContext &context) override
	Register a feature for labelling. More...

void	saveEngineSettings ()

Search	searchMethod () const

void	setDrawingOutlineLabels (bool outline)

void	setDrawLabelRectOnly (bool drawRect)
	Sets whether the engine should only draw the outline rectangles of labels, not the label contents themselves. More...

void	setNumCandidatePositions (int candPoint, int candLine, int candPolygon)

void	setSearchMethod (Search s)

void	setShowingAllLabels (bool showing)

void	setShowingCandidates (bool showing)

void	setShowingPartialsLabels (bool showing)

void	setShowingShadowRectangles (bool showing)

Q_DECL_DEPRECATED void	setStoredWithProject (bool store)

QgsLabelingResults *	takeResults ()
	Return pointer to recently computed results (in drawLabeling()) and pass the ownership of results to the caller. More...

virtual bool	willUseLayer (QgsVectorLayer *layer) override
	called to find out whether the layer is used for labeling More...

Public Member Functions inherited from QgsLabelingEngineInterface
virtual	~QgsLabelingEngineInterface ()

Static Public Member Functions
static void	drawLabelBackground (QgsRenderContext &context, QgsLabelComponent component, const QgsPalLayerSettings &tmpLyr)

static void	drawLabelBuffer (QgsRenderContext &context, const QgsLabelComponent &component, const QgsPalLayerSettings &tmpLyr)

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

static void	drawLabelShadow (QgsRenderContext &context, const QgsLabelComponent &component, const QgsPalLayerSettings &tmpLyr)

static bool	geometryRequiresPreparation (const QgsGeometry geometry, QgsRenderContext &context, const QgsCoordinateTransform ct, QgsGeometry *clipGeometry=nullptr)
	Checks whether a geometry requires preparation before registration with PAL. More...

static QgsGeometry *	prepareGeometry (const QgsGeometry geometry, QgsRenderContext &context, const QgsCoordinateTransform ct, QgsGeometry *clipGeometry=nullptr)
	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...

static bool	staticWillUseLayer (const QString &layerID)

Protected Member Functions
void	deleteTemporaryData ()

Static Protected Member Functions
static bool	checkMinimumSizeMM (const QgsRenderContext &context, const QgsGeometry *geom, double minSize)
	Checks whether a geometry exceeds the minimum required size for a geometry to be labeled. More...

static void	dataDefinedDropShadow (QgsPalLayerSettings &tmpLyr, const QMap< QgsPalLayerSettings::DataDefinedProperties, QVariant > &ddValues)

static void	dataDefinedShapeBackground (QgsPalLayerSettings &tmpLyr, const QMap< QgsPalLayerSettings::DataDefinedProperties, QVariant > &ddValues)

static void	dataDefinedTextBuffer (QgsPalLayerSettings &tmpLyr, const QMap< QgsPalLayerSettings::DataDefinedProperties, QVariant > &ddValues)

static void	dataDefinedTextFormatting (QgsPalLayerSettings &tmpLyr, const QMap< QgsPalLayerSettings::DataDefinedProperties, QVariant > &ddValues)

static void	dataDefinedTextStyle (QgsPalLayerSettings &tmpLyr, const QMap< QgsPalLayerSettings::DataDefinedProperties, QVariant > &ddValues)

Protected Attributes
QList< QgsLabelCandidate >	mCandidates

QHash< QString, QgsVectorLayerDiagramProvider * >	mDiagramProviders
	hashtable of diagram providers (key = layer ID) More...

QgsLabelingEngineV2 *	mEngine
	New labeling engine to interface with PAL. More...

QgsPalLayerSettings	mInvalidLayerSettings

QHash< QString, QgsVectorLayerLabelProvider * >	mLabelProviders
	hashtable of label providers, being filled during labeling (key = layer ID) More...

Friends
class	QgsDxfExport

class	QgsPalLayerSettings

class	QgsVectorLayerLabelProvider

Detailed Description

Definition at line 860 of file qgspallabeling.h.

Member Enumeration Documentation

enum QgsPalLabeling::DrawLabelType

Enumerator
LabelText
LabelBuffer
LabelShape
LabelSVG
LabelShadow

Definition at line 863 of file qgspallabeling.h.

enum QgsPalLabeling::Search

Enumerator
Chain
Popmusic_Tabu
Popmusic_Chain
Popmusic_Tabu_Chain
Falp

Definition at line 881 of file qgspallabeling.h.

Constructor & Destructor Documentation

QgsPalLabeling::QgsPalLabeling ( )

Definition at line 3863 of file qgspallabeling.cpp.

QgsPalLabeling::~QgsPalLabeling ( )

Definition at line 3868 of file qgspallabeling.cpp.

Member Function Documentation

int QgsPalLabeling::addDiagramLayer	(	QgsVectorLayer *	layer,
		const QgsDiagramLayerSettings *	s
	)

overridevirtual

adds a diagram layer to the labeling engine

Deprecated:: since 2.12 - use prepareDiagramLayer()

Reimplemented from QgsLabelingEngineInterface.

Definition at line 3955 of file qgspallabeling.cpp.

Q_DECL_DEPRECATED const QList<QgsLabelCandidate>& QgsPalLabeling::candidates ( )

inline

Deprecated:: since 2.12

Definition at line 889 of file qgspallabeling.h.

bool QgsPalLabeling::checkMinimumSizeMM	(	const QgsRenderContext &	context,
		const QgsGeometry *	geom,
		double	minSize
	)

staticprotected

Checks whether a geometry exceeds the minimum required size for a geometry to be labeled.

Parameters

context	render context
geom	geometry
minSize	minimum size for geometry

Returns: true if geometry exceeds minimum size

Note: added in QGIS 2.9

Definition at line 4111 of file qgspallabeling.cpp.

void QgsPalLabeling::clearActiveLayer ( const QString & layerID )

overridevirtual

clears data defined objects from PAL layer settings for a registered layer

Implements QgsLabelingEngineInterface.

Definition at line 3905 of file qgspallabeling.cpp.

void QgsPalLabeling::clearActiveLayers ( )

overridevirtual

clears all PAL layer settings for registered layers

Implements QgsLabelingEngineInterface.

Definition at line 3901 of file qgspallabeling.cpp.

void QgsPalLabeling::clearEngineSettings ( )

Definition at line 5168 of file qgspallabeling.cpp.

QgsPalLabeling * QgsPalLabeling::clone ( )

overridevirtual

called when passing engine among map renderers

Implements QgsLabelingEngineInterface.

Definition at line 5181 of file qgspallabeling.cpp.

void QgsPalLabeling::dataDefinedDropShadow	(	QgsPalLayerSettings &	tmpLyr,
		const QMap< QgsPalLayerSettings::DataDefinedProperties, QVariant > &	ddValues
	)

staticprotected

Definition at line 4425 of file qgspallabeling.cpp.

void QgsPalLabeling::dataDefinedShapeBackground	(	QgsPalLayerSettings &	tmpLyr,
		const QMap< QgsPalLayerSettings::DataDefinedProperties, QVariant > &	ddValues
	)

staticprotected

Definition at line 4314 of file qgspallabeling.cpp.

void QgsPalLabeling::dataDefinedTextBuffer	(	QgsPalLayerSettings &	tmpLyr,
		const QMap< QgsPalLayerSettings::DataDefinedProperties, QVariant > &	ddValues
	)

staticprotected

Definition at line 4257 of file qgspallabeling.cpp.

void QgsPalLabeling::dataDefinedTextFormatting	(	QgsPalLayerSettings &	tmpLyr,
		const QMap< QgsPalLayerSettings::DataDefinedProperties, QVariant > &	ddValues
	)

staticprotected

Definition at line 4204 of file qgspallabeling.cpp.

void QgsPalLabeling::dataDefinedTextStyle	(	QgsPalLayerSettings &	tmpLyr,
		const QMap< QgsPalLayerSettings::DataDefinedProperties, QVariant > &	ddValues
	)

staticprotected

Definition at line 4179 of file qgspallabeling.cpp.

void QgsPalLabeling::deleteTemporaryData ( )

protected

Definition at line 4498 of file qgspallabeling.cpp.

void QgsPalLabeling::drawLabelBackground	(	QgsRenderContext &	context,
		QgsLabelComponent	component,
		const QgsPalLayerSettings &	tmpLyr
	)

static

Definition at line 4713 of file qgspallabeling.cpp.

void QgsPalLabeling::drawLabelBuffer	(	QgsRenderContext &	context,
		const QgsLabelComponent &	component,
		const QgsPalLayerSettings &	tmpLyr
	)

static

Definition at line 4657 of file qgspallabeling.cpp.

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 4597 of file qgspallabeling.cpp.

void QgsPalLabeling::drawLabeling ( QgsRenderContext & context )

overridevirtual

called when the map is drawn and labels should be placed

Implements QgsLabelingEngineInterface.

Definition at line 4493 of file qgspallabeling.cpp.

bool QgsPalLabeling::drawLabelRectOnly ( ) const

Returns whether the engine will only draw the outline rectangles of labels, not the label contents themselves.

Used for debugging and testing purposes.

See also: setDrawLabelRectOnly

Note: added in QGIS 2.12

Definition at line 4587 of file qgspallabeling.cpp.

void QgsPalLabeling::drawLabelShadow	(	QgsRenderContext &	context,
		const QgsLabelComponent &	component,
		const QgsPalLayerSettings &	tmpLyr
	)

static

Definition at line 5010 of file qgspallabeling.cpp.

void QgsPalLabeling::exit ( )

overridevirtual

called when we're done with rendering

Implements QgsLabelingEngineInterface.

Definition at line 4167 of file qgspallabeling.cpp.

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

static

Checks whether a geometry requires preparation before registration with PAL.

Parameters

geometry	geometry to prepare
context	render context
ct	coordinate transform
clipGeometry	geometry to clip features to, if applicable

Returns: true if geometry requires preparation

Note: added in QGIS 2.9

Definition at line 3969 of file qgspallabeling.cpp.

void QgsPalLabeling::init ( QgsMapRenderer * mr )

overridevirtual

called when we're going to start with rendering

Deprecated:: since 2.4 - use override with QgsMapSettings

Implements QgsLabelingEngineInterface.

Definition at line 4156 of file qgspallabeling.cpp.

void QgsPalLabeling::init ( const QgsMapSettings & mapSettings )

overridevirtual

called when we're going to start with rendering

Implements QgsLabelingEngineInterface.

Definition at line 4162 of file qgspallabeling.cpp.

bool QgsPalLabeling::isDrawingOutlineLabels ( ) const

Note: added in 2.4

Definition at line 4577 of file qgspallabeling.cpp.

bool QgsPalLabeling::isShowingAllLabels ( ) const

Definition at line 4557 of file qgspallabeling.cpp.

bool QgsPalLabeling::isShowingCandidates ( ) const

Definition at line 4537 of file qgspallabeling.cpp.

bool QgsPalLabeling::isShowingPartialsLabels ( ) const

Definition at line 4567 of file qgspallabeling.cpp.

bool QgsPalLabeling::isShowingShadowRectangles ( ) const

Definition at line 4547 of file qgspallabeling.cpp.

Q_DECL_DEPRECATED bool QgsPalLabeling::isStoredWithProject ( ) const

inline

Deprecated:: since 2.4 - settings are always stored in project

Definition at line 995 of file qgspallabeling.h.

QList< QgsLabelPosition > QgsPalLabeling::labelsAtPosition ( const QgsPoint & p )

overridevirtual

return infos about labels at a given (map) position

Deprecated:: since 2.4 - use takeResults() and methods of QgsLabelingResults

Implements QgsLabelingEngineInterface.

Definition at line 4502 of file qgspallabeling.cpp.

QList< QgsLabelPosition > QgsPalLabeling::labelsWithinRect ( const QgsRectangle & r )

overridevirtual

return infos about labels within a given (map) rectangle

Deprecated:: since 2.4 - use takeResults() and methods of QgsLabelingResults

Implements QgsLabelingEngineInterface.

Definition at line 4507 of file qgspallabeling.cpp.

QgsPalLayerSettings & QgsPalLabeling::layer ( const QString & layerName )

overridevirtual

Deprecated:: since 2.12 - if direct access to QgsPalLayerSettings is necessary, use QgsPalLayerSettings::fromLayer()

Implements QgsLabelingEngineInterface.

Definition at line 4173 of file qgspallabeling.cpp.

void QgsPalLabeling::loadEngineSettings ( )

load/save engine settings to project file

Definition at line 5158 of file qgspallabeling.cpp.

void QgsPalLabeling::numCandidatePositions	(	int &	candPoint,
		int &	candLine,
		int &	candPolygon
	)

Definition at line 4517 of file qgspallabeling.cpp.

int QgsPalLabeling::prepareDiagramLayer	(	QgsVectorLayer *	layer,
		QStringList &	attrNames,
		QgsRenderContext &	ctx
	)

overridevirtual

adds a diagram layer to the labeling engine

Note: added in QGIS 2.12

Reimplemented from QgsLabelingEngineInterface.

Definition at line 3939 of file qgspallabeling.cpp.

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

static

Prepares a geometry for registration with PAL.

Handles reprojection, rotation, clipping, etc.

Parameters

geometry	geometry to prepare
context	render context
ct	coordinate transform
clipGeometry	geometry to clip features to, if applicable

Returns: prepared geometry, the caller takes ownership

Note: added in QGIS 2.9

Definition at line 4029 of file qgspallabeling.cpp.

int QgsPalLabeling::prepareLayer	(	QgsVectorLayer *	layer,
		QStringList &	attrNames,
		QgsRenderContext &	ctx
	)

overridevirtual

hook called when drawing layer before issuing select()

Implements QgsLabelingEngineInterface.

Definition at line 3911 of file qgspallabeling.cpp.

void QgsPalLabeling::registerDiagramFeature	(	const QString &	layerID,
		QgsFeature &	feat,
		QgsRenderContext &	context
	)

overridevirtual

called for every diagram feature

Reimplemented from QgsLabelingEngineInterface.

Definition at line 4149 of file qgspallabeling.cpp.

void QgsPalLabeling::registerFeature	(	const QString &	layerID,
		QgsFeature &	feat,
		QgsRenderContext &	context
	)

overridevirtual

Register a feature for labelling.

Parameters

layerID	string identifying layer associated with label
feat	feature to label
context	render context. The QgsExpressionContext contained within the render context must have already had the feature and fields sets prior to calling this method.

Implements QgsLabelingEngineInterface.

Definition at line 3963 of file qgspallabeling.cpp.

void QgsPalLabeling::saveEngineSettings ( )

Definition at line 5163 of file qgspallabeling.cpp.

QgsPalLabeling::Search QgsPalLabeling::searchMethod ( ) const

Definition at line 4532 of file qgspallabeling.cpp.

void QgsPalLabeling::setDrawingOutlineLabels ( bool outline )

Definition at line 4582 of file qgspallabeling.cpp.

void QgsPalLabeling::setDrawLabelRectOnly ( bool drawRect )

Sets whether the engine should only draw the outline rectangles of labels, not the label contents themselves.

Used for debugging and testing purposes.

Parameters

drawRect set to true to enable rect drawing only

See also: drawLabelRectOnly

Note: added in QGIS 2.12

Definition at line 4592 of file qgspallabeling.cpp.

void QgsPalLabeling::setNumCandidatePositions	(	int	candPoint,
		int	candLine,
		int	candPolygon
	)

Definition at line 4522 of file qgspallabeling.cpp.

void QgsPalLabeling::setSearchMethod ( QgsPalLabeling::Search s )

Definition at line 4527 of file qgspallabeling.cpp.

void QgsPalLabeling::setShowingAllLabels ( bool showing )

Definition at line 4562 of file qgspallabeling.cpp.

void QgsPalLabeling::setShowingCandidates ( bool showing )

Definition at line 4542 of file qgspallabeling.cpp.

void QgsPalLabeling::setShowingPartialsLabels ( bool showing )

Definition at line 4572 of file qgspallabeling.cpp.

void QgsPalLabeling::setShowingShadowRectangles ( bool showing )

Definition at line 4552 of file qgspallabeling.cpp.

Q_DECL_DEPRECATED void QgsPalLabeling::setStoredWithProject ( bool store )

inline

Deprecated:: since 2.4 - settings are always stored in project

Definition at line 997 of file qgspallabeling.h.

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 (eg Arabic and Indic based scripts)

Parameters

text	string to split

Returns: list of graphemes

Note: added in QGIS 2.10

Definition at line 4015 of file qgspallabeling.cpp.

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

Note: added in QGIS 2.9

Definition at line 3996 of file qgspallabeling.cpp.

bool QgsPalLabeling::staticWillUseLayer ( QgsVectorLayer * layer )

static

called to find out whether the layer is used for labeling

Note: added in 2.4

Definition at line 3888 of file qgspallabeling.cpp.

bool QgsPalLabeling::staticWillUseLayer ( const QString & layerID )

static

Definition at line 3879 of file qgspallabeling.cpp.

QgsLabelingResults * QgsPalLabeling::takeResults ( )

Return pointer to recently computed results (in drawLabeling()) and pass the ownership of results to the caller.

Note: added in 2.4

Definition at line 4512 of file qgspallabeling.cpp.

bool QgsPalLabeling::willUseLayer ( QgsVectorLayer * layer )

overridevirtual

called to find out whether the layer is used for labeling

Implements QgsLabelingEngineInterface.

Definition at line 3874 of file qgspallabeling.cpp.

Friends And Related Function Documentation

friend class QgsDxfExport

friend

Definition at line 1059 of file qgspallabeling.h.

friend class QgsPalLayerSettings

friend

Definition at line 1084 of file qgspallabeling.h.

friend class QgsVectorLayerLabelProvider

friend

Definition at line 1058 of file qgspallabeling.h.

Member Data Documentation

QList<QgsLabelCandidate> QgsPalLabeling::mCandidates

protected

Definition at line 1082 of file qgspallabeling.h.

QHash<QString, QgsVectorLayerDiagramProvider*> QgsPalLabeling::mDiagramProviders

protected

hashtable of diagram providers (key = layer ID)

Definition at line 1075 of file qgspallabeling.h.

QgsLabelingEngineV2* QgsPalLabeling::mEngine

protected

New labeling engine to interface with PAL.

Definition at line 1079 of file qgspallabeling.h.

QgsPalLayerSettings QgsPalLabeling::mInvalidLayerSettings

protected

Definition at line 1076 of file qgspallabeling.h.

QHash<QString, QgsVectorLayerLabelProvider*> QgsPalLabeling::mLabelProviders

protected

hashtable of label providers, being filled during labeling (key = layer ID)

Definition at line 1073 of file qgspallabeling.h.

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

/build/qgis-wWl0JB/qgis-2.14.5+dfsg/src/core/qgspallabeling.h
/build/qgis-wWl0JB/qgis-2.14.5+dfsg/src/core/qgspallabeling.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation