QGIS API Documentation  2.99.0-Master (23ddace)
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
 return infos about labels at a given (map) position More...
 
QList< QgsLabelPositionlabelsWithinRect (const QgsRectangle &r) const
 return infos about labels within a given (map) rectangle More...
 
QgsLabelingResultsoperator= (const QgsLabelingResults &rh)=delete
 QgsLabelingResults cannot be copied. 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 703 of file qgspallabeling.h.

Constructor & Destructor Documentation

◆ QgsLabelingResults() [1/2]

QgsLabelingResults::QgsLabelingResults ( )

Definition at line 3431 of file qgspallabeling.cpp.

◆ ~QgsLabelingResults()

QgsLabelingResults::~QgsLabelingResults ( )

Definition at line 3436 of file qgspallabeling.cpp.

◆ QgsLabelingResults() [2/2]

QgsLabelingResults::QgsLabelingResults ( const QgsLabelingResults )
delete

QgsLabelingResults cannot be copied.

Member Function Documentation

◆ labelsAtPosition()

QList< QgsLabelPosition > QgsLabelingResults::labelsAtPosition ( const QgsPointXY p) const

return infos about labels at a given (map) position

Definition at line 3442 of file qgspallabeling.cpp.

◆ labelsWithinRect()

QList< QgsLabelPosition > QgsLabelingResults::labelsWithinRect ( const QgsRectangle r) const

return infos about labels within a given (map) rectangle

Definition at line 3460 of file qgspallabeling.cpp.

◆ operator=()

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

QgsLabelingResults cannot be copied.

Friends And Related Function Documentation

◆ QgsPalLabeling

friend class QgsPalLabeling
friend

Definition at line 726 of file qgspallabeling.h.

◆ QgsVectorLayerDiagramProvider

friend class QgsVectorLayerDiagramProvider
friend

Definition at line 728 of file qgspallabeling.h.

◆ QgsVectorLayerLabelProvider

friend class QgsVectorLayerLabelProvider
friend

Definition at line 727 of file qgspallabeling.h.


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