QGIS API Documentation 3.27.0-Master (95e00c50d2)
qgssinglesymbolrenderer.h
Go to the documentation of this file.
1/***************************************************************************
2 qgssinglesymbolrenderer.h
3 ---------------------
4 begin : November 2009
5 copyright : (C) 2009 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 QGSSINGLESYMBOLRENDERER_H
16#define QGSSINGLESYMBOLRENDERER_H
17
18#include "qgis_core.h"
19#include "qgis.h"
20#include "qgsrenderer.h"
21
23class QgsSymbol;
24
30{
31 public:
32
41
42 QgsSymbol *symbolForFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
43 QgsSymbol *originalSymbolForFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
44 void startRender( QgsRenderContext &context, const QgsFields &fields ) override;
45 void stopRender( QgsRenderContext &context ) override;
46 QSet<QString> usedAttributes( const QgsRenderContext &context ) const override;
47 bool accept( QgsStyleEntityVisitorInterface *visitor ) const override;
48
53 QgsSymbol *symbol() const;
54
60 void setSymbol( QgsSymbol *s SIP_TRANSFER );
61
62 QString dump() const override;
63
65
66 void toSld( QDomDocument &doc, QDomElement &element, const QVariantMap &props = QVariantMap() ) const override;
67
75 static QgsFeatureRenderer *createFromSld( QDomElement &element, QgsWkbTypes::GeometryType geomType ) SIP_FACTORY;
76
77 QgsFeatureRenderer::Capabilities capabilities() override { return SymbolLevels; }
78 QgsSymbolList symbols( QgsRenderContext &context ) const override;
79
85 static QgsFeatureRenderer *create( QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;
86
87 QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) override;
89 QSet< QString > legendKeysForFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
90 QString legendKeyToExpression( const QString &key, QgsVectorLayer *layer, bool &ok ) const override;
91 void setLegendSymbolItem( const QString &key, QgsSymbol *symbol SIP_TRANSFER ) override;
92
98 static QgsSingleSymbolRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ) SIP_FACTORY;
99
110 void setDataDefinedSizeLegend( QgsDataDefinedSizeLegend *settings SIP_TRANSFER );
111
117 QgsDataDefinedSizeLegend *dataDefinedSizeLegend() const;
118
119 protected:
120 std::unique_ptr<QgsSymbol> mSymbol;
121 std::unique_ptr<QgsDataDefinedSizeLegend> mDataDefinedSizeLegend;
122
123 private:
124#ifdef SIP_RUN
127#endif
128
129};
130
131
132#endif // QGSSINGLESYMBOLRENDERER_H
Object that keeps configuration of appearance of marker symbol's data-defined size in legend.
virtual QgsLegendSymbolList legendSymbolItems() const
Returns a list of symbology items for the legend.
virtual void setLegendSymbolItem(const QString &key, QgsSymbol *symbol)
Sets the symbol to be used for a legend symbol item.
virtual QgsSymbolList symbols(QgsRenderContext &context) const
Returns list of symbols used by the renderer.
virtual void stopRender(QgsRenderContext &context)
Must be called when a render cycle has finished, to allow the renderer to clean up.
virtual QSet< QString > legendKeysForFeature(const QgsFeature &feature, QgsRenderContext &context) const
Returns legend keys matching a specified feature.
Definition: qgsrenderer.cpp:89
virtual QDomElement save(QDomDocument &doc, const QgsReadWriteContext &context)
Stores renderer properties to an XML element.
virtual QString dump() const
Returns debug information about this renderer.
virtual QSet< QString > usedAttributes(const QgsRenderContext &context) const =0
Returns a list of attributes required by this renderer.
virtual QgsSymbol * symbolForFeature(const QgsFeature &feature, QgsRenderContext &context) const =0
To be overridden.
virtual QString legendKeyToExpression(const QString &key, QgsVectorLayer *layer, bool &ok) const
Attempts to convert the specified legend rule key to a QGIS expression matching the features displaye...
@ SymbolLevels
Rendering with symbol levels (i.e. implements symbols(), symbolForFeature())
Definition: qgsrenderer.h:263
virtual bool accept(QgsStyleEntityVisitorInterface *visitor) const
Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer...
virtual QgsSymbol * originalSymbolForFeature(const QgsFeature &feature, QgsRenderContext &context) const
Returns symbol for feature.
Definition: qgsrenderer.cpp:84
virtual void startRender(QgsRenderContext &context, const QgsFields &fields)
Must be called when a new render cycle is started.
Definition: qgsrenderer.cpp:96
virtual QgsFeatureRenderer * clone() const =0
Create a deep copy of this renderer.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition: qgsfeature.h:56
Container of fields for a vector layer.
Definition: qgsfields.h:45
The class is used as a container of context for various read/write operations on other objects.
Contains information about the context of a rendering operation.
std::unique_ptr< QgsSymbol > mSymbol
~QgsSingleSymbolRenderer() override
std::unique_ptr< QgsDataDefinedSizeLegend > mDataDefinedSizeLegend
An interface for classes which can visit style entity (e.g.
Abstract base class for all rendered symbols.
Definition: qgssymbol.h:93
Represents a vector layer which manages a vector based data sets.
Handles storage of information regarding WKB types and their properties.
Definition: qgswkbtypes.h:42
#define SIP_TRANSFER
Definition: qgis_sip.h:36
#define SIP_FACTORY
Definition: qgis_sip.h:76
QList< QgsLegendSymbolItem > QgsLegendSymbolList
QList< QgsSymbol * > QgsSymbolList
Definition: qgsrenderer.h:44