QGIS API Documentation  2.12.0-Lyon
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 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

Definition at line 18 of file qgsrulebasedlabeling.h.

Member Typedef Documentation

Definition at line 21 of file qgsrulebasedlabeling.h.

Definition at line 23 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 316 of file qgsrulebasedlabeling.cpp.

QgsRuleBasedLabeling::QgsRuleBasedLabeling ( const QgsRuleBasedLabeling &  other)

Copy constructor.

Definition at line 322 of file qgsrulebasedlabeling.cpp.

QgsRuleBasedLabeling::~QgsRuleBasedLabeling ( )

Definition at line 327 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 332 of file qgsrulebasedlabeling.cpp.

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

Factory for label provider implementation.

Implements QgsAbstractVectorLayerLabeling.

Definition at line 361 of file qgsrulebasedlabeling.cpp.

Rule* QgsRuleBasedLabeling::rootRule ( )
inline

Definition at line 217 of file qgsrulebasedlabeling.h.

const Rule* QgsRuleBasedLabeling::rootRule ( ) const
inline

Definition at line 218 of file qgsrulebasedlabeling.h.

QDomElement QgsRuleBasedLabeling::save ( QDomDocument &  doc) const
overridevirtual

Return labeling configuration as XML element.

Implements QgsAbstractVectorLayerLabeling.

Definition at line 349 of file qgsrulebasedlabeling.cpp.

QString QgsRuleBasedLabeling::type ( ) const
overridevirtual

Unique type string of the labeling configuration implementation.

Implements QgsAbstractVectorLayerLabeling.

Definition at line 344 of file qgsrulebasedlabeling.cpp.

Member Data Documentation

Rule* QgsRuleBasedLabeling::mRootRule
protected

Definition at line 230 of file qgsrulebasedlabeling.h.


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