QGIS API Documentation  3.17.0-Master (7a14973234)
Public Member Functions | Friends | List of all members
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< QgsLabelPositionlabelsAtPosition (const QgsPointXY &p) const
 Returns infos about labels at a given (map) position. More...
 
QList< QgsLabelPositionlabelsWithinRect (const QgsRectangle &r) const
 Returns infos about labels within a given (map) rectangle. More...
 
QgsLabelingResultsoperator= (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 1223 of file qgspallabeling.h.

Constructor & Destructor Documentation

◆ QgsLabelingResults() [1/2]

QgsLabelingResults::QgsLabelingResults ( )

Definition at line 4349 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 4356 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 4374 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 4392 of file qgspallabeling.cpp.

Friends And Related Function Documentation

◆ QgsPalLabeling

friend class QgsPalLabeling
friend

Definition at line 1252 of file qgspallabeling.h.

◆ QgsVectorLayerDiagramProvider

friend class QgsVectorLayerDiagramProvider
friend

Definition at line 1254 of file qgspallabeling.h.

◆ QgsVectorLayerLabelProvider

friend class QgsVectorLayerLabelProvider
friend

Definition at line 1253 of file qgspallabeling.h.


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