QGIS API Documentation  2.18.3-Las Palmas (77b8c3d)
Public Member Functions | Static Public Member Functions | List of all members
QgsAbstractVectorLayerLabeling Class Referenceabstract

Abstract base class - its implementations define different approaches to the labeling of a vector layer. More...

#include <qgsvectorlayerlabeling.h>

Inheritance diagram for QgsAbstractVectorLayerLabeling:
Inheritance graph
[legend]

Public Member Functions

virtual ~QgsAbstractVectorLayerLabeling ()
 
virtual QgsVectorLayerLabelProviderprovider (QgsVectorLayer *layer) const =0
 Factory for label provider implementation. More...
 
virtual QDomElement save (QDomDocument &doc) const =0
 Return labeling configuration as XML element. More...
 
virtual QgsPalLayerSettings settings (QgsVectorLayer *layer, const QString &providerId=QString()) const =0
 Get associated label settings. More...
 
virtual QStringList subProviders () const
 Get list of sub-providers within the layer's labeling. More...
 
virtual QString type () const =0
 Unique type string of the labeling configuration implementation. More...
 

Static Public Member Functions

static QgsAbstractVectorLayerLabelingcreate (const QDomElement &element)
 Try to create instance of an implementation based on the XML data. More...
 

Detailed Description

Abstract base class - its implementations define different approaches to the labeling of a vector layer.

Note
added in 2.12
not available in Python bindings
this class is not a part of public API yet. See notes in QgsLabelingEngineV2

Definition at line 35 of file qgsvectorlayerlabeling.h.

Constructor & Destructor Documentation

QgsAbstractVectorLayerLabeling::~QgsAbstractVectorLayerLabeling ( )
virtual

Definition at line 22 of file qgsvectorlayerlabeling.cpp.

Member Function Documentation

QgsAbstractVectorLayerLabeling * QgsAbstractVectorLayerLabeling::create ( const QDomElement element)
static

Try to create instance of an implementation based on the XML data.

Definition at line 26 of file qgsvectorlayerlabeling.cpp.

virtual QgsVectorLayerLabelProvider* QgsAbstractVectorLayerLabeling::provider ( QgsVectorLayer layer) const
pure virtual

Factory for label provider implementation.

Implemented in QgsRuleBasedLabeling, and QgsVectorLayerSimpleLabeling.

virtual QDomElement QgsAbstractVectorLayerLabeling::save ( QDomDocument doc) const
pure virtual

Return labeling configuration as XML element.

Implemented in QgsRuleBasedLabeling, and QgsVectorLayerSimpleLabeling.

virtual QgsPalLayerSettings QgsAbstractVectorLayerLabeling::settings ( QgsVectorLayer layer,
const QString providerId = QString() 
) const
pure virtual

Get associated label settings.

In case of multiple sub-providers with different settings, they are identified by their ID (e.g. in case of rule-based labeling, provider ID == rule key)

Implemented in QgsRuleBasedLabeling, and QgsVectorLayerSimpleLabeling.

virtual QStringList QgsAbstractVectorLayerLabeling::subProviders ( ) const
inlinevirtual

Get list of sub-providers within the layer's labeling.

Reimplemented in QgsRuleBasedLabeling.

Definition at line 51 of file qgsvectorlayerlabeling.h.

virtual QString QgsAbstractVectorLayerLabeling::type ( ) const
pure virtual

Unique type string of the labeling configuration implementation.

Implemented in QgsRuleBasedLabeling, and QgsVectorLayerSimpleLabeling.


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