QGIS API Documentation  2.99.0-Master (37c43df)
Public Member Functions | List of all members
QgsLabelingEngineInterface Class Referenceabstract

Labeling engine interface. More...

#include <qgspallabeling.h>

Inheritance diagram for QgsLabelingEngineInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~QgsLabelingEngineInterface ()
 
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 QgsLabelingEngineInterfaceclone ()=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 void init (const QgsMapSettings &mapSettings)=0
 called when we're going to start with rendering More...
 
virtual int prepareDiagramLayer (QgsVectorLayer *layer, QSet< QString > &attrNames, QgsRenderContext &ctx)
 adds a diagram layer to the labeling engine More...
 
virtual int prepareLayer (QgsVectorLayer *layer, QSet< QString > &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 124 of file qgspallabeling.h.

Constructor & Destructor Documentation

§ ~QgsLabelingEngineInterface()

virtual QgsLabelingEngineInterface::~QgsLabelingEngineInterface ( )
inlinevirtual

Definition at line 128 of file qgspallabeling.h.

Member Function Documentation

§ 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()

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

called when we're going to start with rendering

Implemented in QgsPalLabeling.

§ prepareDiagramLayer()

virtual int QgsLabelingEngineInterface::prepareDiagramLayer ( QgsVectorLayer layer,
QSet< QString > &  attrNames,
QgsRenderContext ctx 
)
inlinevirtual

adds a diagram layer to the labeling engine

Note
added in QGIS 2.12

Reimplemented in QgsPalLabeling.

Definition at line 143 of file qgspallabeling.h.

§ prepareLayer()

virtual int QgsLabelingEngineInterface::prepareLayer ( QgsVectorLayer layer,
QSet< QString > &  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 149 of file qgspallabeling.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: