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

Basic implementation of the labeling interface. More...

#include <qgsvectorlayerlabeling.h>

Inheritance diagram for QgsVectorLayerSimpleLabeling:
Inheritance graph
[legend]

Public Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from QgsAbstractVectorLayerLabeling
static QgsAbstractVectorLayerLabelingcreate (const QDomElement &element)
 Try to create instance of an implementation based on the XML data. More...
 

Detailed Description

Basic implementation of the labeling interface.

The configuration is kept in layer's custom properties for backward compatibility.

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 72 of file qgsvectorlayerlabeling.h.

Member Function Documentation

QgsVectorLayerLabelProvider * QgsVectorLayerSimpleLabeling::provider ( QgsVectorLayer layer) const
overridevirtual

Factory for label provider implementation.

Implements QgsAbstractVectorLayerLabeling.

Definition at line 39 of file qgsvectorlayerlabeling.cpp.

QDomElement QgsVectorLayerSimpleLabeling::save ( QDomDocument doc) const
overridevirtual

Return labeling configuration as XML element.

Implements QgsAbstractVectorLayerLabeling.

Definition at line 52 of file qgsvectorlayerlabeling.cpp.

QgsPalLayerSettings QgsVectorLayerSimpleLabeling::settings ( QgsVectorLayer layer,
const QString providerId = QString() 
) const
overridevirtual

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)

Implements QgsAbstractVectorLayerLabeling.

Definition at line 60 of file qgsvectorlayerlabeling.cpp.

QString QgsVectorLayerSimpleLabeling::type ( ) const
overridevirtual

Unique type string of the labeling configuration implementation.

Implements QgsAbstractVectorLayerLabeling.

Definition at line 47 of file qgsvectorlayerlabeling.cpp.


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