QgsLabelingEngineInterface Class Reference

Labeling engine interface. More...

#include <qgsmaprenderer.h>

Inheritance diagram for QgsLabelingEngineInterface:

Public Member Functions
virtual	~QgsLabelingEngineInterface ()
virtual int	addDiagramLayer (QgsVectorLayer *layer, const QgsDiagramLayerSettings *s)
	adds a diagram layer to the labeling engine
virtual void	clearActiveLayer (const QString &layerID)=0
	clears data defined objects from PAL layer settings for a registered layer
virtual void	clearActiveLayers ()=0
	clears all PAL layer settings for registered layers
virtual QgsLabelingEngineInterface *	clone ()=0
	called when passing engine among map renderers
virtual void	drawLabeling (QgsRenderContext &context)=0
	called when the map is drawn and labels should be placed
virtual void	exit ()=0
	called when we're done with rendering
virtual Q_DECL_DEPRECATED void	init (QgsMapRenderer *mp)=0
	called when we're going to start with rendering
virtual void	init (const QgsMapSettings &mapSettings)=0
	called when we're going to start with rendering
virtual Q_DECL_DEPRECATED QList< QgsLabelPosition >	labelsAtPosition (const QgsPoint &p)=0
	return infos about labels at a given (map) position
virtual Q_DECL_DEPRECATED QList< QgsLabelPosition >	labelsWithinRect (const QgsRectangle &r)=0
	return infos about labels within a given (map) rectangle
virtual QgsPalLayerSettings &	layer (const QString &layerName)=0
	returns PAL layer settings for a registered layer
virtual int	prepareLayer (QgsVectorLayer *layer, QStringList &attrNames, QgsRenderContext &ctx)=0
	called when starting rendering of a layer
virtual void	registerDiagramFeature (const QString &layerID, QgsFeature &feat, const QgsRenderContext &context=QgsRenderContext())
	called for every diagram feature
virtual void	registerFeature (const QString &layerID, QgsFeature &feat, const QgsRenderContext &context=QgsRenderContext(), QString dxfLayer=QString::null)=0
	called for every feature
virtual bool	willUseLayer (QgsVectorLayer *layer)=0
	called to find out whether the layer is used for labeling

Detailed Description

Labeling engine interface.

Definition at line 67 of file qgsmaprenderer.h.

Constructor & Destructor Documentation

virtual QgsLabelingEngineInterface::~QgsLabelingEngineInterface ( )

inlinevirtual

Definition at line 71 of file qgsmaprenderer.h.

Member Function Documentation

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

inlinevirtual

adds a diagram layer to the labeling engine

Reimplemented in QgsPalLabeling.

Definition at line 89 of file qgsmaprenderer.h.

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

pure virtual

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

Implemented in QgsPalLabeling.

virtual void QgsLabelingEngineInterface::clearActiveLayers ( )

pure virtual

clears all PAL layer settings for registered layers

Implemented in QgsPalLabeling.

virtual QgsLabelingEngineInterface* QgsLabelingEngineInterface::clone ( )

pure virtual

called when passing engine among map renderers

Implemented in QgsPalLabeling.

virtual void QgsLabelingEngineInterface::drawLabeling ( QgsRenderContext &  context )

pure virtual

called when the map is drawn and labels should be placed

Implemented in QgsPalLabeling.

virtual void QgsLabelingEngineInterface::exit ( )

pure virtual

called when we're done with rendering

Implemented in QgsPalLabeling.

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.

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

pure virtual

called when we're going to start with rendering

Implemented in QgsPalLabeling.

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.

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.

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

pure virtual

returns PAL layer settings for a registered layer

Implemented in QgsPalLabeling.

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

pure virtual

called when starting rendering of a layer

Implemented in QgsPalLabeling.

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

inlinevirtual

called for every diagram feature

Reimplemented in QgsPalLabeling.

Definition at line 94 of file qgsmaprenderer.h.

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

pure virtual

called for every feature

Implemented in QgsPalLabeling.

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.8.2+12wheezy/src/core/qgsmaprenderer.h