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

Inheritance diagram for QgsLabelSink:

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.

virtual void	drawUnplacedLabel (const QString &layerId, QgsRenderContext &context, pal::LabelPosition *label, const QgsPalLayerSettings &settings)
	The drawLabel method is called for each unplaced label.

Detailed Description

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

Definition at line 37 of file qgslabelsink.h.

Constructor & Destructor Documentation

virtual QgsLabelSink::~QgsLabelSink ( )

virtualdefault

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.

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

inlinevirtual

The drawLabel method is called for each unplaced label.

Parameters

layerId	The layer ID associated to the label
context	The render context object
label	The label object
settings	The layer labeling settings

Definition at line 57 of file qgslabelsink.h.

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

/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/core/labeling/qgslabelsink.h