QgsLabelingResults Class Reference

Class that stores computed placement from labeling engine. More...

#include <qgspallabeling.h>

Public Member Functions
	QgsLabelingResults ()
	QgsLabelingResults (const QgsLabelingResults &)=delete
	QgsLabelingResults cannot be copied. More...
	~QgsLabelingResults ()
QList< QgsLabelPosition >	labelsAtPosition (const QgsPointXY &p) const
	Returns infos about labels at a given (map) position. More...
QList< QgsLabelPosition >	labelsWithinRect (const QgsRectangle &r) const
	Returns infos about labels within a given (map) rectangle. More...
QgsLabelingResults &	operator= (const QgsLabelingResults &rh)=delete
	QgsLabelingResults cannot be copied. More...
void	setMapSettings (const QgsMapSettings &settings)
	Sets the map settings associated with the labeling run. More...

Friends
class	QgsPalLabeling
class	QgsVectorLayerDiagramProvider
class	QgsVectorLayerLabelProvider

Detailed Description

Class that stores computed placement from labeling engine.

Since

QGIS 2.4

Definition at line 1226 of file qgspallabeling.h.

Constructor & Destructor Documentation

QgsLabelingResults() [1/2]

QgsLabelingResults::QgsLabelingResults

(

)

Definition at line 4358 of file qgspallabeling.cpp.

~QgsLabelingResults()

QgsLabelingResults::~QgsLabelingResults ( )

default

QgsLabelingResults() [2/2]

QgsLabelingResults::QgsLabelingResults ( const QgsLabelingResults &  )

delete

QgsLabelingResults cannot be copied.

Member Function Documentation

labelsAtPosition()

QList< QgsLabelPosition > QgsLabelingResults::labelsAtPosition

(

const QgsPointXY &

p

)

const

Returns infos about labels at a given (map) position.

Definition at line 4365 of file qgspallabeling.cpp.

labelsWithinRect()

QList< QgsLabelPosition > QgsLabelingResults::labelsWithinRect

(

const QgsRectangle &

r

)

const

Returns infos about labels within a given (map) rectangle.

Definition at line 4383 of file qgspallabeling.cpp.

operator=()

QgsLabelingResults& QgsLabelingResults::operator= ( const QgsLabelingResults &  rh )

delete

QgsLabelingResults cannot be copied.

setMapSettings()

void QgsLabelingResults::setMapSettings

(

const QgsMapSettings &

settings

)

Sets the map settings associated with the labeling run.

Since

QGIS 3.4.8

Definition at line 4401 of file qgspallabeling.cpp.

Friends And Related Function Documentation

QgsPalLabeling

friend class QgsPalLabeling

friend

Definition at line 1255 of file qgspallabeling.h.

QgsVectorLayerDiagramProvider

friend class QgsVectorLayerDiagramProvider

friend

Definition at line 1257 of file qgspallabeling.h.

QgsVectorLayerLabelProvider

friend class QgsVectorLayerLabelProvider

friend

Definition at line 1256 of file qgspallabeling.h.

---

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

• /build/qgis-3.18.1+99unstable/src/core/labeling/qgspallabeling.h
• /build/qgis-3.18.1+99unstable/src/core/labeling/qgspallabeling.cpp