QgsRuleBasedLabeling Class Reference

#include <qgsrulebasedlabeling.h>

Inheritance diagram for QgsRuleBasedLabeling:

Classes
class	Rule

Public Types
typedef QList< Rule * >	RuleList
typedef QMap< Rule *, QgsVectorLayerLabelProvider * >	RuleToProviderMap

Public Member Functions
	QgsRuleBasedLabeling (QgsRuleBasedLabeling::Rule *root)
	Constructs the labeling from given tree of rules (takes ownership) More...
	QgsRuleBasedLabeling (const QgsRuleBasedLabeling &other)
	Copy constructor. More...
	~QgsRuleBasedLabeling ()
virtual QgsVectorLayerLabelProvider *	provider (QgsVectorLayer *layer) const override
	Factory for label provider implementation. More...
Rule *	rootRule ()
const Rule *	rootRule () const
virtual QDomElement	save (QDomDocument &doc) const override
	Return labeling configuration as XML element. More...
virtual QString	type () const override
	Unique type string of the labeling configuration implementation. More...
Public Member Functions inherited from QgsAbstractVectorLayerLabeling
virtual	~QgsAbstractVectorLayerLabeling ()

Static Public Member Functions
static QgsRuleBasedLabeling *	create (const QDomElement &element)
	Create the instance from a DOM element with saved configuration. More...
Static Public Member Functions inherited from QgsAbstractVectorLayerLabeling
static QgsAbstractVectorLayerLabeling *	create (const QDomElement &element)
	Try to create instance of an implementation based on the XML data. More...

Protected Attributes
Rule *	mRootRule

Detailed Description

Note

not available in Python bindings

this class is not a part of public API yet. See notes in QgsLabelingEngineV2

Definition at line 40 of file qgsrulebasedlabeling.h.

Member Typedef Documentation

RuleList

typedef QList<Rule*> QgsRuleBasedLabeling::RuleList

Definition at line 43 of file qgsrulebasedlabeling.h.

RuleToProviderMap

typedef QMap<Rule*, QgsVectorLayerLabelProvider*> QgsRuleBasedLabeling::RuleToProviderMap

Definition at line 45 of file qgsrulebasedlabeling.h.

Constructor & Destructor Documentation

QgsRuleBasedLabeling() [1/2]

QgsRuleBasedLabeling::QgsRuleBasedLabeling ( QgsRuleBasedLabeling::Rule *  root )

explicit

Constructs the labeling from given tree of rules (takes ownership)

Definition at line 333 of file qgsrulebasedlabeling.cpp.

QgsRuleBasedLabeling() [2/2]

QgsRuleBasedLabeling::QgsRuleBasedLabeling

(

const QgsRuleBasedLabeling &

other

)

Copy constructor.

Definition at line 339 of file qgsrulebasedlabeling.cpp.

~QgsRuleBasedLabeling()

QgsRuleBasedLabeling::~QgsRuleBasedLabeling

(

)

Definition at line 344 of file qgsrulebasedlabeling.cpp.

Member Function Documentation

create()

QgsRuleBasedLabeling * QgsRuleBasedLabeling::create ( const QDomElement &  element )

static

Create the instance from a DOM element with saved configuration.

Definition at line 349 of file qgsrulebasedlabeling.cpp.

provider()

QgsVectorLayerLabelProvider * QgsRuleBasedLabeling::provider ( QgsVectorLayer *  layer ) const

overridevirtual

Factory for label provider implementation.

Implements QgsAbstractVectorLayerLabeling.

Definition at line 378 of file qgsrulebasedlabeling.cpp.

rootRule() [1/2]

Rule* QgsRuleBasedLabeling::rootRule ( )

inline

Definition at line 279 of file qgsrulebasedlabeling.h.

rootRule() [2/2]

const Rule* QgsRuleBasedLabeling::rootRule ( ) const

inline

Definition at line 280 of file qgsrulebasedlabeling.h.

save()

QDomElement QgsRuleBasedLabeling::save ( QDomDocument &  doc ) const

overridevirtual

Return labeling configuration as XML element.

Implements QgsAbstractVectorLayerLabeling.

Definition at line 366 of file qgsrulebasedlabeling.cpp.

type()

QString QgsRuleBasedLabeling::type ( ) const

overridevirtual

Unique type string of the labeling configuration implementation.

Implements QgsAbstractVectorLayerLabeling.

Definition at line 361 of file qgsrulebasedlabeling.cpp.

Member Data Documentation

mRootRule

Rule* QgsRuleBasedLabeling::mRootRule

protected

Definition at line 292 of file qgsrulebasedlabeling.h.

---

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

• /build/qgis-2.14.11+dfsg/src/core/qgsrulebasedlabeling.h
• /build/qgis-2.14.11+dfsg/src/core/qgsrulebasedlabeling.cpp