mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-27 00:33:48 -05:00
21f03bc11c
Historically the configuration used to be stored in layer's custom properties, but that does not scale beyond simple rendering and so rule-based labeling introduced storage of configuration natively in XML elements. That left us with two different ways of reading/writing labeling configurations. This work makes all configuration to use native XML elements. To keep compatibility of 2.x projects, reading of configuration from custom properties is preserved. This commit also adds Python APIs for direct manipulation of labeling configuration through vector layer's setLabeling() and labeling() calls.
75 lines
2.8 KiB
Plaintext
75 lines
2.8 KiB
Plaintext
|
|
|
|
class QgsRuleBasedLabeling : QgsAbstractVectorLayerLabeling
|
|
{
|
|
%TypeHeaderCode
|
|
#include "qgsrulebasedlabeling.h"
|
|
%End
|
|
public:
|
|
typedef QList<QgsRuleBasedLabeling::Rule *> RuleList;
|
|
|
|
class Rule
|
|
{
|
|
%TypeHeaderCode
|
|
#include "qgsrulebasedlabeling.h"
|
|
%End
|
|
public:
|
|
Rule( QgsPalLayerSettings *settings /Transfer/, int scaleMinDenom = 0, int scaleMaxDenom = 0, const QString &filterExp = QString(), const QString &description = QString(), bool elseRule = false );
|
|
~Rule();
|
|
|
|
enum RegisterResult
|
|
{
|
|
Filtered,
|
|
Inactive,
|
|
Registered
|
|
};
|
|
|
|
QgsPalLayerSettings *settings() const;
|
|
bool dependsOnScale() const;
|
|
int scaleMinDenom() const;
|
|
int scaleMaxDenom() const;
|
|
QString filterExpression() const;
|
|
QString description() const;
|
|
bool active() const;
|
|
bool isElse() const;
|
|
QString ruleKey() const;
|
|
void setSettings( QgsPalLayerSettings *settings /Transfer/ );
|
|
void setScaleMinDenom( int scaleMinDenom );
|
|
void setScaleMaxDenom( int scaleMaxDenom );
|
|
void setFilterExpression( const QString &filterExp );
|
|
void setDescription( const QString &description );
|
|
void setActive( bool state );
|
|
void setIsElse( bool iselse );
|
|
void setRuleKey( const QString &key );
|
|
const QgsRuleBasedLabeling::RuleList &children() const;
|
|
QgsRuleBasedLabeling::RuleList descendants() const;
|
|
QgsRuleBasedLabeling::Rule *parent();
|
|
void appendChild( QgsRuleBasedLabeling::Rule *rule /Transfer/ );
|
|
void insertChild( int i, QgsRuleBasedLabeling::Rule *rule /Transfer/ );
|
|
void removeChildAt( int i );
|
|
const QgsRuleBasedLabeling::Rule *findRuleByKey( const QString &key ) const;
|
|
QgsRuleBasedLabeling::Rule *clone() const /Factory/;
|
|
static QgsRuleBasedLabeling::Rule *create( const QDomElement &ruleElem, const QgsReadWriteContext &context ) /Factory/;
|
|
QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) const;
|
|
bool requiresAdvancedEffects() const;
|
|
|
|
private:
|
|
Rule( const QgsRuleBasedLabeling::Rule &rh );
|
|
};
|
|
|
|
explicit QgsRuleBasedLabeling( QgsRuleBasedLabeling::Rule *root /Transfer/ );
|
|
~QgsRuleBasedLabeling();
|
|
|
|
QgsRuleBasedLabeling::Rule *rootRule();
|
|
|
|
static QgsRuleBasedLabeling *create( const QDomElement &element, const QgsReadWriteContext &context ) /Factory/;
|
|
|
|
virtual QString type() const;
|
|
virtual QgsRuleBasedLabeling *clone() const /Factory/;
|
|
virtual QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) const;
|
|
virtual QStringList subProviders() const;
|
|
virtual QgsPalLayerSettings settings( const QString &providerId = QString() ) const;
|
|
virtual bool requiresAdvancedEffects() const;
|
|
|
|
};
|