QGIS API Documentation
3.0.2-Girona (307d082)
|
Basic implementation of the labeling interface. More...
#include <qgsvectorlayerlabeling.h>
Public Member Functions | |
QgsVectorLayerSimpleLabeling (const QgsPalLayerSettings &settings) | |
Constructs simple labeling configuration with given initial settings. More... | |
QgsAbstractVectorLayerLabeling * | clone () const override |
Return a new copy of the object. More... | |
QgsVectorLayerLabelProvider * | provider (QgsVectorLayer *layer) const override |
bool | requiresAdvancedEffects () const override |
Returns true if drawing labels requires advanced effects like composition modes, which could prevent it being used as an isolated cached image or exported to a vector format. More... | |
QDomElement | save (QDomDocument &doc, const QgsReadWriteContext &context) const override |
Return labeling configuration as XML element. More... | |
void | setSettings (QgsPalLayerSettings *settings, const QString &providerId=QString()) override |
Set pal settings (takes ownership). More... | |
QgsPalLayerSettings | settings (const QString &providerId=QString()) const override |
Get associated label settings. More... | |
void | toSld (QDomNode &parent, const QgsStringMap &props) const override |
Writes the SE 1.1 TextSymbolizer element based on the current layer labeling settings. More... | |
QString | type () const override |
Unique type string of the labeling configuration implementation. More... | |
Public Member Functions inherited from QgsAbstractVectorLayerLabeling | |
QgsAbstractVectorLayerLabeling ()=default | |
Default constructor. More... | |
virtual | ~QgsAbstractVectorLayerLabeling ()=default |
virtual QStringList | subProviders () const |
Get list of sub-providers within the layer's labeling. More... | |
Static Public Member Functions | |
static QgsVectorLayerSimpleLabeling * | create (const QDomElement &element, const QgsReadWriteContext &context) |
Create the instance from a DOM element with saved configuration. More... | |
Static Public Member Functions inherited from QgsAbstractVectorLayerLabeling | |
static QgsAbstractVectorLayerLabeling * | create (const QDomElement &element, const QgsReadWriteContext &context) |
Try to create instance of an implementation based on the XML data. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from QgsAbstractVectorLayerLabeling | |
virtual void | writeTextSymbolizer (QDomNode &parent, QgsPalLayerSettings &settings, const QgsStringMap &props) const |
Writes a TextSymbolizer element contents based on the provided labeling settings. More... | |
Basic implementation of the labeling interface.
The configuration is kept in layer's custom properties for backward compatibility.
Definition at line 144 of file qgsvectorlayerlabeling.h.
|
explicit |
Constructs simple labeling configuration with given initial settings.
Definition at line 48 of file qgsvectorlayerlabeling.cpp.
|
overridevirtual |
Return a new copy of the object.
Implements QgsAbstractVectorLayerLabeling.
Definition at line 59 of file qgsvectorlayerlabeling.cpp.
|
static |
Create the instance from a DOM element with saved configuration.
Definition at line 83 of file qgsvectorlayerlabeling.cpp.
|
overridevirtual |
Reimplemented from QgsAbstractVectorLayerLabeling.
Definition at line 43 of file qgsvectorlayerlabeling.cpp.
|
overridevirtual |
Returns true if drawing labels requires advanced effects like composition modes, which could prevent it being used as an isolated cached image or exported to a vector format.
Implements QgsAbstractVectorLayerLabeling.
Definition at line 78 of file qgsvectorlayerlabeling.cpp.
|
overridevirtual |
Return labeling configuration as XML element.
Implements QgsAbstractVectorLayerLabeling.
Definition at line 64 of file qgsvectorlayerlabeling.cpp.
|
overridevirtual |
Set pal settings (takes ownership).
settings | Pal layer settings |
providerId | Unused parameter |
Implements QgsAbstractVectorLayerLabeling.
Definition at line 559 of file qgsvectorlayerlabeling.cpp.
|
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 72 of file qgsvectorlayerlabeling.cpp.
|
overridevirtual |
Writes the SE 1.1 TextSymbolizer element based on the current layer labeling settings.
Reimplemented from QgsAbstractVectorLayerLabeling.
Definition at line 532 of file qgsvectorlayerlabeling.cpp.
|
overridevirtual |
Unique type string of the labeling configuration implementation.
Implements QgsAbstractVectorLayerLabeling.
Definition at line 54 of file qgsvectorlayerlabeling.cpp.