Quantum GIS API Documentation  1.7.5-Wroclaw
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
QgsLabelingEngineInterface Class Referenceabstract

Labeling engine interface. More...

#include <qgsmaprenderer.h>

Inheritance diagram for QgsLabelingEngineInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~QgsLabelingEngineInterface ()
 
virtual void init (QgsMapRenderer *mp)=0
 called when we're going to start with rendering More...
 
virtual bool willUseLayer (QgsVectorLayer *layer)=0
 called to find out whether the layer is used for labeling More...
 
virtual int prepareLayer (QgsVectorLayer *layer, QSet< int > &attrIndices, QgsRenderContext &ctx)=0
 called when starting rendering of a layer More...
 
virtual int addDiagramLayer (QgsVectorLayer *layer, QgsDiagramLayerSettings *s)
 adds a diagram layer to the labeling engine More...
 
virtual void registerFeature (QgsVectorLayer *layer, QgsFeature &feat, const QgsRenderContext &context=QgsRenderContext())=0
 called for every feature More...
 
virtual void registerDiagramFeature (QgsVectorLayer *layer, QgsFeature &feat, const QgsRenderContext &context=QgsRenderContext())
 called for every diagram feature 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 QList< QgsLabelPositionlabelsAtPosition (const QgsPoint &p)=0
 return infos about labels at a given (map) position More...
 
virtual
QgsLabelingEngineInterface
clone ()=0
 called when passing engine among map renderers More...
 

Detailed Description

Labeling engine interface.

Note
Added in QGIS v1.4

Definition at line 63 of file qgsmaprenderer.h.

Constructor & Destructor Documentation

virtual QgsLabelingEngineInterface::~QgsLabelingEngineInterface ( )
inlinevirtual

Definition at line 67 of file qgsmaprenderer.h.

Member Function Documentation

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

adds a diagram layer to the labeling engine

Reimplemented in QgsPalLabeling.

Definition at line 77 of file qgsmaprenderer.h.

Referenced by QgsVectorLayer::prepareLabelingAndDiagrams().

virtual QgsLabelingEngineInterface* QgsLabelingEngineInterface::clone ( )
pure virtual

called when passing engine among map renderers

Implemented in QgsPalLabeling.

Referenced by QgsComposerMap::draw().

virtual void QgsLabelingEngineInterface::drawLabeling ( QgsRenderContext context)
pure virtual

called when the map is drawn and labels should be placed

Implemented in QgsPalLabeling.

Referenced by QgsMapRenderer::render().

virtual void QgsLabelingEngineInterface::exit ( )
pure virtual

called when we're done with rendering

Implemented in QgsPalLabeling.

Referenced by QgsMapRenderer::render().

virtual void QgsLabelingEngineInterface::init ( QgsMapRenderer mp)
pure virtual

called when we're going to start with rendering

Implemented in QgsPalLabeling.

Referenced by QgsMapRenderer::render().

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

return infos about labels at a given (map) position

Note
: this method was added in version 1.7

Implemented in QgsPalLabeling.

virtual int QgsLabelingEngineInterface::prepareLayer ( QgsVectorLayer layer,
QSet< int > &  attrIndices,
QgsRenderContext ctx 
)
pure virtual

called when starting rendering of a layer

Note
: this method was added in version 1.6

Implemented in QgsPalLabeling.

Referenced by QgsVectorLayer::prepareLabelingAndDiagrams().

virtual void QgsLabelingEngineInterface::registerDiagramFeature ( QgsVectorLayer layer,
QgsFeature feat,
const QgsRenderContext context = QgsRenderContext() 
)
inlinevirtual

called for every diagram feature

Reimplemented in QgsPalLabeling.

Definition at line 81 of file qgsmaprenderer.h.

Referenced by QgsVectorLayer::draw(), QgsVectorLayer::drawRendererV2(), and QgsVectorLayer::drawRendererV2Levels().

virtual void QgsLabelingEngineInterface::registerFeature ( QgsVectorLayer layer,
QgsFeature feat,
const QgsRenderContext context = QgsRenderContext() 
)
pure virtual
virtual bool QgsLabelingEngineInterface::willUseLayer ( QgsVectorLayer layer)
pure virtual

called to find out whether the layer is used for labeling

Implemented in QgsPalLabeling.

Referenced by QgsMapRenderer::render().


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