QGIS API Documentation  3.23.0-Master (dd0cd13a00)
Public Member Functions | List of all members
QgsLabelSink Class Referenceabstract

Abstract base class that can be used to intercept rendered labels from a labeling / rendering job. More...

#include <qgslabelsink.h>

Inheritance diagram for QgsLabelSink:
Inheritance graph
[legend]

Public Member Functions

virtual ~QgsLabelSink ()=default
 
virtual void drawLabel (const QString &layerId, QgsRenderContext &context, pal::LabelPosition *label, const QgsPalLayerSettings &settings)=0
 The drawLabel method is called for each label that is being drawn. More...
 

Detailed Description

Abstract base class that can be used to intercept rendered labels from a labeling / rendering job.

Note
not available in Python bindings
Since
QGIS 3.14

Definition at line 37 of file qgslabelsink.h.

Constructor & Destructor Documentation

◆ ~QgsLabelSink()

virtual QgsLabelSink::~QgsLabelSink ( )
virtualdefault

Member Function Documentation

◆ drawLabel()

virtual void QgsLabelSink::drawLabel ( const QString &  layerId,
QgsRenderContext context,
pal::LabelPosition label,
const QgsPalLayerSettings settings 
)
pure virtual

The drawLabel method is called for each label that is being drawn.

Every subclass must implement this method to draw the label or send the information from label to another desired location.

Implemented in QgsDxfExport.


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