QGIS API Documentation  2.18.3-Las Palmas (77b8c3d)
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
QgsRuleBasedLabeling Class Reference

#include <qgsrulebasedlabeling.h>

Inheritance diagram for QgsRuleBasedLabeling:
Inheritance graph
[legend]

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 QgsVectorLayerLabelProviderprovider (QgsVectorLayer *layer) const override
 Factory for label provider implementation. More...
 
RulerootRule ()
 
const RulerootRule () const
 
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 QStringList subProviders () const override
 Get list of sub-providers within the layer's labeling. 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 QgsRuleBasedLabelingcreate (const QDomElement &element)
 Create the instance from a DOM element with saved configuration. More...
 
- 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...
 

Protected Attributes

RulemRootRule
 

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

Definition at line 43 of file qgsrulebasedlabeling.h.

Definition at line 45 of file qgsrulebasedlabeling.h.

Constructor & Destructor Documentation

QgsRuleBasedLabeling::QgsRuleBasedLabeling ( QgsRuleBasedLabeling::Rule root)
explicit

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

Definition at line 364 of file qgsrulebasedlabeling.cpp.

QgsRuleBasedLabeling::QgsRuleBasedLabeling ( const QgsRuleBasedLabeling other)

Copy constructor.

Definition at line 370 of file qgsrulebasedlabeling.cpp.

QgsRuleBasedLabeling::~QgsRuleBasedLabeling ( )

Definition at line 384 of file qgsrulebasedlabeling.cpp.

Member Function Documentation

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

Create the instance from a DOM element with saved configuration.

Definition at line 390 of file qgsrulebasedlabeling.cpp.

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

Factory for label provider implementation.

Implements QgsAbstractVectorLayerLabeling.

Definition at line 419 of file qgsrulebasedlabeling.cpp.

Rule* QgsRuleBasedLabeling::rootRule ( )
inline

Definition at line 301 of file qgsrulebasedlabeling.h.

const Rule* QgsRuleBasedLabeling::rootRule ( ) const
inline

Definition at line 302 of file qgsrulebasedlabeling.h.

QDomElement QgsRuleBasedLabeling::save ( QDomDocument doc) const
overridevirtual

Return labeling configuration as XML element.

Implements QgsAbstractVectorLayerLabeling.

Definition at line 407 of file qgsrulebasedlabeling.cpp.

QgsPalLayerSettings QgsRuleBasedLabeling::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 431 of file qgsrulebasedlabeling.cpp.

QStringList QgsRuleBasedLabeling::subProviders ( ) const
overridevirtual

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

Reimplemented from QgsAbstractVectorLayerLabeling.

Definition at line 424 of file qgsrulebasedlabeling.cpp.

QString QgsRuleBasedLabeling::type ( ) const
overridevirtual

Unique type string of the labeling configuration implementation.

Implements QgsAbstractVectorLayerLabeling.

Definition at line 402 of file qgsrulebasedlabeling.cpp.

Member Data Documentation

Rule* QgsRuleBasedLabeling::mRootRule
protected

Definition at line 316 of file qgsrulebasedlabeling.h.


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