QGIS API Documentation 3.29.0-Master (53715c36dc)
qgsnullsymbolrenderer.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsnullsymbolrenderer.h
3 ---------------------
4 begin : November 2014
5 copyright : (C) 2014 by Nyall Dawson
6 email : nyall dot dawson 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 QGSNULLSYMBOLRENDERER_H
16#define QGSNULLSYMBOLRENDERER_H
17
18#include "qgis_core.h"
19#include "qgis.h"
20#include "qgsrenderer.h"
21
22class QgsSymbol;
23
31class CORE_EXPORT QgsNullSymbolRenderer : public QgsFeatureRenderer
32{
33 public:
34
37
38 QgsSymbol *symbolForFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
39 QgsSymbol *originalSymbolForFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
40
41 bool renderFeature( const QgsFeature &feature, QgsRenderContext &context, int layer = -1, bool selected = false, bool drawVertexMarker = false ) override SIP_THROW( QgsCsException );
42 void stopRender( QgsRenderContext &context ) override;
43 bool willRenderFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
44
45 QSet<QString> usedAttributes( const QgsRenderContext &context ) const override;
46 QString dump() const override;
47 QgsFeatureRenderer *clone() const override SIP_FACTORY;
48 QgsSymbolList symbols( QgsRenderContext &context ) const override;
49
56 static QgsFeatureRenderer *create( QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;
57
58 QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) override;
59
65 static QgsNullSymbolRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ) SIP_FACTORY;
66
67 private:
68
70 std::unique_ptr<QgsSymbol> mSymbol;
71
72};
73
74#endif // QGSNULLSYMBOLRENDERER_H
Custom exception class for Coordinate Reference System related exceptions.
Definition: qgsexception.h:66
virtual QgsSymbol * symbolForFeature(const QgsFeature &feature, QgsRenderContext &context) const =0
To be overridden.
virtual QgsSymbol * originalSymbolForFeature(const QgsFeature &feature, QgsRenderContext &context) const
Returns symbol for feature.
Definition: qgsrenderer.cpp:84
virtual bool renderFeature(const QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false) SIP_THROW(QgsCsException)
Render a feature using this renderer in the given context.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition: qgsfeature.h:56
Null symbol renderer.
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.
Abstract base class for all rendered symbols.
Definition: qgssymbol.h:93
std::unique_ptr< GEOSGeometry, GeosDeleter > unique_ptr
Scoped GEOS pointer.
Definition: qgsgeos.h:74
#define SIP_FACTORY
Definition: qgis_sip.h:76
#define SIP_THROW(name,...)
Definition: qgis_sip.h:198
QList< QgsSymbol * > QgsSymbolList
Definition: qgsrenderer.h:44