Branch data     Line data    Source code

       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                 :            : #include "qgssymbol.h"
      22                 :            : 
      23                 :            : /**
      24                 :            :  * \ingroup core
      25                 :            :  * \class QgsNullSymbolRenderer
      26                 :            :  * \brief Null symbol renderer. Renderer which draws no symbols for features by default, but allows for labeling
      27                 :            :  * and diagrams for the layer. Selected features will also be drawn with a default symbol.
      28                 :            :  * \since QGIS 2.16
      29                 :            :  */
      30                 :            : 
      31                 :          0 : class CORE_EXPORT QgsNullSymbolRenderer : public QgsFeatureRenderer
      32                 :            : {
      33                 :            :   public:
      34                 :            : 
      35                 :            :     QgsNullSymbolRenderer();
      36                 :            : 
      37                 :            :     QgsSymbol *symbolForFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
      38                 :            :     QgsSymbol *originalSymbolForFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
      39                 :            : 
      40                 :            :     bool renderFeature( const QgsFeature &feature, QgsRenderContext &context, int layer = -1, bool selected = false, bool drawVertexMarker = false ) override SIP_THROW( QgsCsException );
      41                 :            :     void stopRender( QgsRenderContext &context ) override;
      42                 :            :     bool willRenderFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
      43                 :            : 
      44                 :            :     QSet<QString> usedAttributes( const QgsRenderContext &context ) const override;
      45                 :            :     QString dump() const override;
      46                 :            :     QgsFeatureRenderer *clone() const override SIP_FACTORY;
      47                 :            :     QgsSymbolList symbols( QgsRenderContext &context ) const override;
      48                 :            : 
      49                 :            :     /**
      50                 :            :      * Creates a null renderer from XML element.
      51                 :            :      * \param element DOM element
      52                 :            :      * \param context reading context
      53                 :            :      * \returns new null symbol renderer
      54                 :            :      */
      55                 :            :     static QgsFeatureRenderer *create( QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;
      56                 :            : 
      57                 :            :     QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) override;
      58                 :            : 
      59                 :            :     /**
      60                 :            :      * Creates a QgsNullSymbolRenderer from an existing renderer.
      61                 :            :      * \param renderer renderer to convert from
      62                 :            :      * \returns a new renderer if the conversion was possible, otherwise NULLPTR.
      63                 :            :      */
      64                 :            :     static QgsNullSymbolRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ) SIP_FACTORY;
      65                 :            : 
      66                 :            :   private:
      67                 :            : 
      68                 :            :     //! Symbol to use for rendering selected features
      69                 :            :     std::unique_ptr<QgsSymbol> mSymbol;
      70                 :            : 
      71                 :            : };
      72                 :            : 
      73                 :            : #endif // QGSNULLSYMBOLRENDERER_H