QGIS API Documentation 3.39.0-Master (e8f1b343c48)
Loading...
Searching...
No Matches
qgsvectorlayerlabeling.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsvectorlayerlabeling.h
3 ---------------------
4 begin : September 2015
5 copyright : (C) 2015 by Martin Dobias
6 email : wonder dot sk at gmail dot com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15#ifndef QGSVECTORLAYERLABELING_H
16#define QGSVECTORLAYERLABELING_H
17
18#include <memory>
19
20#include <QString>
21#include <QStringList>
22#include <QDomNode>
23
24#include "qgis.h"
25
26class QDomDocument;
27class QDomElement;
28
31class QgsVectorLayer;
34
41{
42
43#ifdef SIP_RUN
45 if ( sipCpp->type() == "simple" )
46 sipType = sipType_QgsVectorLayerSimpleLabeling;
47 else if ( sipCpp->type() == "rule-based" )
48 sipType = sipType_QgsRuleBasedLabeling;
49 else
50 sipType = 0;
52#endif
53
54 public:
55
58
60 virtual QString type() const = 0;
61
64
69 virtual QgsVectorLayerLabelProvider *provider( QgsVectorLayer *layer ) const SIP_SKIP { Q_UNUSED( layer ) return nullptr; }
70
72 virtual QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) const = 0;
73
75 virtual QStringList subProviders() const { return QStringList( QString() ); }
76
81 virtual QgsPalLayerSettings settings( const QString &providerId = QString() ) const = 0;
82
90 virtual void setSettings( QgsPalLayerSettings *settings SIP_TRANSFER, const QString &providerId = QString() ) = 0;
91
97 virtual bool requiresAdvancedEffects() const = 0;
98
107 virtual void multiplyOpacity( double opacityFactor ) { Q_UNUSED( opacityFactor ); };
108
109
110 // static stuff
111
113 static QgsAbstractVectorLayerLabeling *create( const QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;
114
118 virtual void toSld( QDomNode &parent, const QVariantMap &props ) const
119 {
120 Q_UNUSED( parent )
121 Q_UNUSED( props )
122 QDomDocument doc = parent.ownerDocument();
123 parent.appendChild( doc.createComment( QStringLiteral( "SE Export for %1 not implemented yet" ).arg( type() ) ) );
124 }
125
135 virtual bool accept( QgsStyleEntityVisitorInterface *visitor ) const;
136
142 static QgsPalLayerSettings defaultSettingsForLayer( const QgsVectorLayer *layer );
143
144 protected:
145
152 virtual void writeTextSymbolizer( QDomNode &parent, QgsPalLayerSettings &settings, const QVariantMap &props ) const;
153
154 private:
155 Q_DISABLE_COPY( QgsAbstractVectorLayerLabeling )
156
157#ifdef SIP_RUN
159#endif
160
161};
162
171{
172 public:
174 explicit QgsVectorLayerSimpleLabeling( const QgsPalLayerSettings &settings );
175
176 QString type() const override;
177 QgsAbstractVectorLayerLabeling *clone() const override SIP_FACTORY;
179 QgsVectorLayerLabelProvider *provider( QgsVectorLayer *layer ) const override SIP_SKIP;
180 QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) const override;
181 QgsPalLayerSettings settings( const QString &providerId = QString() ) const override;
182 bool accept( QgsStyleEntityVisitorInterface *visitor ) const override;
183
191 void setSettings( QgsPalLayerSettings *settings SIP_TRANSFER, const QString &providerId = QString() ) override;
192
193 bool requiresAdvancedEffects() const override;
194 void toSld( QDomNode &parent, const QVariantMap &props ) const override;
195 void multiplyOpacity( double opacityFactor ) override;
197 static QgsVectorLayerSimpleLabeling *create( const QDomElement &element, const QgsReadWriteContext &context );
198
199 private:
200 std::unique_ptr<QgsPalLayerSettings> mSettings;
201};
202
203#endif // QGSVECTORLAYERLABELING_H
Abstract base class - its implementations define different approaches to the labeling of a vector lay...
virtual void toSld(QDomNode &parent, const QVariantMap &props) const
Writes the SE 1.1 TextSymbolizer element based on the current layer labeling settings.
virtual QStringList subProviders() const
Gets list of sub-providers within the layer's labeling.
virtual void setSettings(QgsPalLayerSettings *settings, const QString &providerId=QString())=0
Set pal settings for a specific provider (takes ownership).
virtual ~QgsAbstractVectorLayerLabeling()=default
virtual QgsPalLayerSettings settings(const QString &providerId=QString()) const =0
Gets associated label settings.
virtual bool requiresAdvancedEffects() const =0
Returns true if drawing labels requires advanced effects like composition modes, which could prevent ...
virtual QString type() const =0
Unique type string of the labeling configuration implementation.
virtual QgsVectorLayerLabelProvider * provider(QgsVectorLayer *layer) const
Factory for label provider implementation.
virtual QDomElement save(QDomDocument &doc, const QgsReadWriteContext &context) const =0
Returns labeling configuration as XML element.
virtual void multiplyOpacity(double opacityFactor)
Multiply opacity by opacityFactor.
virtual QgsAbstractVectorLayerLabeling * clone() const =0
Returns a new copy of the object.
Contains settings for how a map layer will be labeled.
The class is used as a container of context for various read/write operations on other objects.
An interface for classes which can visit style entity (e.g.
The QgsVectorLayerLabelProvider class implements a label provider for vector layers.
Basic implementation of the labeling interface.
Represents a vector layer which manages a vector based data sets.
#define SIP_CONVERT_TO_SUBCLASS_CODE(code)
Definition qgis_sip.h:191
#define SIP_SKIP
Definition qgis_sip.h:126
#define SIP_TRANSFER
Definition qgis_sip.h:36
#define SIP_FACTORY
Definition qgis_sip.h:76
#define SIP_END
Definition qgis_sip.h:208