QGIS API Documentation  3.17.0-Master (a035f434f4)
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 
23 class QgsSymbol;
24 
29 class CORE_EXPORT QgsSingleSymbolRenderer : public QgsFeatureRenderer
30 {
31  public:
32 
40  ~QgsSingleSymbolRenderer() override;
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 
64  QgsSingleSymbolRenderer *clone() const override SIP_FACTORY;
65 
66  void toSld( QDomDocument &doc, QDomElement &element, const QgsStringMap &props = QgsStringMap() ) 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;
88  QgsLegendSymbolList legendSymbolItems() const override;
89  QSet< QString > legendKeysForFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
90  void setLegendSymbolItem( const QString &key, QgsSymbol *symbol SIP_TRANSFER ) override;
91 
97  static QgsSingleSymbolRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ) SIP_FACTORY;
98 
109  void setDataDefinedSizeLegend( QgsDataDefinedSizeLegend *settings SIP_TRANSFER );
110 
116  QgsDataDefinedSizeLegend *dataDefinedSizeLegend() const;
117 
118  protected:
119  std::unique_ptr<QgsSymbol> mSymbol;
120  std::unique_ptr<QgsDataDefinedSizeLegend> mDataDefinedSizeLegend;
121 
122  private:
123 #ifdef SIP_RUN
125  QgsSingleSymbolRenderer &operator=( const QgsSingleSymbolRenderer & );
126 #endif
127 
128 };
129 
130 
131 #endif // QGSSINGLESYMBOLRENDERER_H
The class is used as a container of context for various read/write operations on other objects...
virtual QgsLegendSymbolList legendSymbolItems() const
Returns a list of symbology items for the legend.
QList< QgsLegendSymbolItem > QgsLegendSymbolList
Abstract base class for all rendered symbols.
Definition: qgssymbol.h:64
virtual void toSld(QDomDocument &doc, QDomElement &element, const QgsStringMap &props=QgsStringMap()) const
used from subclasses to create SLD Rule elements following SLD v1.1 specs
Definition: qgsrenderer.h:312
virtual QDomElement save(QDomDocument &doc, const QgsReadWriteContext &context)
store renderer info to XML element
Container of fields for a vector layer.
Definition: qgsfields.h:44
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:55
An interface for classes which can visit style entity (e.g.
std::unique_ptr< QgsDataDefinedSizeLegend > mDataDefinedSizeLegend
QMap< QString, QString > QgsStringMap
Definition: qgis.h:759
virtual QgsSymbol * symbolForFeature(const QgsFeature &feature, QgsRenderContext &context) const =0
To be overridden.
virtual QSet< QString > usedAttributes(const QgsRenderContext &context) const =0
Returns a list of attributes required by this renderer.
QList< QgsSymbol * > QgsSymbolList
Definition: qgsrenderer.h:45
virtual QgsSymbol * originalSymbolForFeature(const QgsFeature &feature, QgsRenderContext &context) const
Returns symbol for feature.
Definition: qgsrenderer.cpp:81
#define SIP_TRANSFER
Definition: qgis_sip.h:36
QgsFeatureRenderer::Capabilities capabilities() override
Returns details about internals of this renderer.
#define SIP_FACTORY
Definition: qgis_sip.h:76
virtual void setLegendSymbolItem(const QString &key, QgsSymbol *symbol)
Sets the symbol to be used for a legend symbol item.
Rendering with symbol levels (i.e. implements symbols(), symbolForFeature())
Definition: qgsrenderer.h:254
virtual bool accept(QgsStyleEntityVisitorInterface *visitor) const
Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer...
GeometryType
The geometry types are used to group QgsWkbTypes::Type in a coarse way.
Definition: qgswkbtypes.h:140
Contains information about the context of a rendering operation.
virtual QgsSymbolList symbols(QgsRenderContext &context) const
Returns list of symbols used by the renderer.
virtual void startRender(QgsRenderContext &context, const QgsFields &fields)
Must be called when a new render cycle is started.
Definition: qgsrenderer.cpp:93
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:86
Object that keeps configuration of appearance of marker symbol&#39;s data-defined size in legend...
std::unique_ptr< QgsSymbol > mSymbol
virtual QgsFeatureRenderer * clone() const =0
Create a deep copy of this renderer.
virtual QString dump() const
Returns debug information about this renderer.