QGIS API Documentation
2.18.21-Las Palmas (9fba24a)
|
Labeling engine interface. More...
#include <qgsmaprenderer.h>
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... | |
Labeling engine interface.
Definition at line 99 of file qgsmaprenderer.h.
|
inlinevirtual |
Definition at line 103 of file qgsmaprenderer.h.
|
inlinevirtual |
adds a diagram layer to the labeling engine
Reimplemented in QgsPalLabeling.
Definition at line 127 of file qgsmaprenderer.h.
|
pure virtual |
clears data defined objects from PAL layer settings for a registered layer
Implemented in QgsPalLabeling.
|
pure virtual |
clears all PAL layer settings for registered layers
Implemented in QgsPalLabeling.
|
pure virtual |
called when passing engine among map renderers
Implemented in QgsPalLabeling.
|
pure virtual |
called when the map is drawn and labels should be placed
Implemented in QgsPalLabeling.
|
pure virtual |
called when we're done with rendering
Implemented in QgsPalLabeling.
|
pure virtual |
called when we're going to start with rendering
Implemented in QgsPalLabeling.
|
pure virtual |
called when we're going to start with rendering
Implemented in QgsPalLabeling.
|
pure virtual |
return infos about labels at a given (map) position
Implemented in QgsPalLabeling.
|
pure virtual |
return infos about labels within a given (map) rectangle
Implemented in QgsPalLabeling.
|
pure virtual |
returns PAL layer settings for a registered layer
Implemented in QgsPalLabeling.
|
inlinevirtual |
adds a diagram layer to the labeling engine
Reimplemented in QgsPalLabeling.
Definition at line 123 of file qgsmaprenderer.h.
|
pure virtual |
called when starting rendering of a layer
Implemented in QgsPalLabeling.
|
inlinevirtual |
called for every diagram feature
Reimplemented in QgsPalLabeling.
Definition at line 132 of file qgsmaprenderer.h.
|
pure virtual |
called for every feature
Implemented in QgsPalLabeling.
|
pure virtual |
called to find out whether the layer is used for labeling
Implemented in QgsPalLabeling.