Labeling engine interface. More...

#include <qgsmaprenderer.h>

Inheritance diagram for QgsLabelingEngineInterface:

Public Member Functions
virtual	~QgsLabelingEngineInterface ()

virtual Q_DECL_DEPRECATED int	addDiagramLayer (QgsVectorLayer layer, const QgsDiagramLayerSettings s)
	adds a diagram layer to the labeling engine More...

virtual void	clearActiveLayer (const QString &layerID)=0
	clears data defined objects from PAL layer settings for a registered layer More...

virtual void	clearActiveLayers ()=0
	clears all PAL layer settings for registered layers More...

virtual QgsLabelingEngineInterface *	clone ()=0
	called when passing engine among map renderers More...

virtual void	drawLabeling (QgsRenderContext &context)=0
	called when the map is drawn and labels should be placed More...

virtual void	exit ()=0
	called when we're done with rendering More...

virtual Q_DECL_DEPRECATED void	init (QgsMapRenderer *mp)=0
	called when we're going to start with rendering More...

virtual void	init (const QgsMapSettings &mapSettings)=0
	called when we're going to start with rendering More...

virtual Q_DECL_DEPRECATED QList< QgsLabelPosition >	labelsAtPosition (const QgsPoint &p)=0
	return infos about labels at a given (map) position More...

virtual Q_DECL_DEPRECATED QList< QgsLabelPosition >	labelsWithinRect (const QgsRectangle &r)=0
	return infos about labels within a given (map) rectangle More...

virtual Q_DECL_DEPRECATED QgsPalLayerSettings &	layer (const QString &layerName)=0
	returns PAL layer settings for a registered layer More...

virtual int	prepareDiagramLayer (QgsVectorLayer *layer, QStringList &attrNames, QgsRenderContext &ctx)
	adds a diagram layer to the labeling engine More...

virtual int	prepareLayer (QgsVectorLayer *layer, QStringList &attrNames, QgsRenderContext &ctx)=0
	called when starting rendering of a layer More...

virtual void	registerDiagramFeature (const QString &layerID, QgsFeature &feat, QgsRenderContext &context)
	called for every diagram feature More...

virtual void	registerFeature (const QString &layerID, QgsFeature &feat, QgsRenderContext &context)=0
	called for every feature More...

virtual bool	willUseLayer (QgsVectorLayer *layer)=0
	called to find out whether the layer is used for labeling More...

Detailed Description

Labeling engine interface.

Definition at line 99 of file qgsmaprenderer.h.

Constructor & Destructor Documentation

◆ ~QgsLabelingEngineInterface()

virtual QgsLabelingEngineInterface::~QgsLabelingEngineInterface ( )

inlinevirtual

Definition at line 103 of file qgsmaprenderer.h.

Member Function Documentation

◆ addDiagramLayer()

virtual Q_DECL_DEPRECATED int QgsLabelingEngineInterface::addDiagramLayer	(	QgsVectorLayer *	layer,
		const QgsDiagramLayerSettings *	s
	)

inlinevirtual

adds a diagram layer to the labeling engine

Deprecated:: since 2.12 - use prepareDiagramLayer()

Reimplemented in QgsPalLabeling.

Definition at line 127 of file qgsmaprenderer.h.

◆ clearActiveLayer()

virtual void QgsLabelingEngineInterface::clearActiveLayer ( const QString & layerID )

pure virtual

clears data defined objects from PAL layer settings for a registered layer

Implemented in QgsPalLabeling.

◆ clearActiveLayers()

virtual void QgsLabelingEngineInterface::clearActiveLayers ( )

pure virtual

clears all PAL layer settings for registered layers

Implemented in QgsPalLabeling.

◆ clone()

virtual QgsLabelingEngineInterface* QgsLabelingEngineInterface::clone ( )

pure virtual

called when passing engine among map renderers

Implemented in QgsPalLabeling.

◆ drawLabeling()

virtual void QgsLabelingEngineInterface::drawLabeling ( QgsRenderContext & context )

pure virtual

called when the map is drawn and labels should be placed

Implemented in QgsPalLabeling.

◆ exit()

virtual void QgsLabelingEngineInterface::exit ( )

pure virtual

called when we're done with rendering

Implemented in QgsPalLabeling.

◆ init() [1/2]

virtual Q_DECL_DEPRECATED void QgsLabelingEngineInterface::init ( QgsMapRenderer * mp )

pure virtual

called when we're going to start with rendering

Deprecated:: since 2.4 - use override with QgsMapSettings

Implemented in QgsPalLabeling.

◆ init() [2/2]

virtual void QgsLabelingEngineInterface::init ( const QgsMapSettings & mapSettings )

pure virtual

called when we're going to start with rendering

Implemented in QgsPalLabeling.

◆ labelsAtPosition()

virtual Q_DECL_DEPRECATED QList<QgsLabelPosition> QgsLabelingEngineInterface::labelsAtPosition ( const QgsPoint & p )

pure virtual

return infos about labels at a given (map) position

Deprecated:: since 2.4 - use takeResults() and methods of QgsLabelingResults

Implemented in QgsPalLabeling.

◆ labelsWithinRect()

virtual Q_DECL_DEPRECATED QList<QgsLabelPosition> QgsLabelingEngineInterface::labelsWithinRect ( const QgsRectangle & r )

pure virtual

return infos about labels within a given (map) rectangle

Deprecated:: since 2.4 - use takeResults() and methods of QgsLabelingResults

Implemented in QgsPalLabeling.

◆ layer()

virtual Q_DECL_DEPRECATED QgsPalLayerSettings& QgsLabelingEngineInterface::layer ( const QString & layerName )

pure virtual

returns PAL layer settings for a registered layer

Deprecated:: since 2.12 - if direct access to QgsPalLayerSettings is necessary, use QgsPalLayerSettings::fromLayer()

Implemented in QgsPalLabeling.

◆ prepareDiagramLayer()

virtual int QgsLabelingEngineInterface::prepareDiagramLayer	(	QgsVectorLayer *	layer,
		QStringList &	attrNames,
		QgsRenderContext &	ctx
	)

inlinevirtual

adds a diagram layer to the labeling engine

Note: added in QGIS 2.12

Reimplemented in QgsPalLabeling.

Definition at line 123 of file qgsmaprenderer.h.

◆ prepareLayer()

virtual int QgsLabelingEngineInterface::prepareLayer	(	QgsVectorLayer *	layer,
		QStringList &	attrNames,
		QgsRenderContext &	ctx
	)

pure virtual

called when starting rendering of a layer

Implemented in QgsPalLabeling.

◆ registerDiagramFeature()

virtual void QgsLabelingEngineInterface::registerDiagramFeature	(	const QString &	layerID,
		QgsFeature &	feat,
		QgsRenderContext &	context
	)

inlinevirtual

called for every diagram feature

Reimplemented in QgsPalLabeling.

Definition at line 132 of file qgsmaprenderer.h.

◆ registerFeature()

virtual void QgsLabelingEngineInterface::registerFeature	(	const QString &	layerID,
		QgsFeature &	feat,
		QgsRenderContext &	context
	)

pure virtual

called for every feature

Implemented in QgsPalLabeling.

◆ willUseLayer()

virtual bool QgsLabelingEngineInterface::willUseLayer ( QgsVectorLayer * layer )

pure virtual

called to find out whether the layer is used for labeling

Implemented in QgsPalLabeling.

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

/tmp/buildd/qgis-2.18.21+99unstable/src/core/qgsmaprenderer.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~QgsLabelingEngineInterface()

Member Function Documentation

◆ addDiagramLayer()

◆ clearActiveLayer()

◆ clearActiveLayers()

◆ clone()

◆ drawLabeling()

◆ exit()

◆ init() [1/2]

◆ init() [2/2]

◆ labelsAtPosition()

◆ labelsWithinRect()

◆ layer()

◆ prepareDiagramLayer()

◆ prepareLayer()

◆ registerDiagramFeature()

◆ registerFeature()

◆ willUseLayer()