Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                               qgssvgannotation.h
       3                 :            :                               ------------------------
       4                 :            :   begin                : November, 2012
       5                 :            :   copyright            : (C) 2012 by Marco Hugentobler
       6                 :            :   email                : marco dot hugentobler at sourcepole dot ch
       7                 :            :  ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #ifndef QGSSVGANNOTATION_H
      19                 :            : #define QGSSVGANNOTATION_H
      20                 :            : 
      21                 :            : #include "qgsannotation.h"
      22                 :            : #include <QSvgRenderer>
      23                 :            : #include "qgis_core.h"
      24                 :            : 
      25                 :            : /**
      26                 :            :  * \class QgsSvgAnnotation
      27                 :            :  * \ingroup core
      28                 :            :  * \brief An annotation which renders the contents of an SVG file.
      29                 :            :  * \since QGIS 3.0
      30                 :            :  */
      31                 :            : class CORE_EXPORT QgsSvgAnnotation: public QgsAnnotation
      32                 :            : {
      33                 :            :     Q_OBJECT
      34                 :            : 
      35                 :            :   public:
      36                 :            : 
      37                 :            :     /**
      38                 :            :      * Constructor for QgsSvgAnnotation.
      39                 :            :      */
      40                 :            :     QgsSvgAnnotation( QObject *parent SIP_TRANSFERTHIS = nullptr );
      41                 :            : 
      42                 :            :     QgsSvgAnnotation *clone() const override SIP_FACTORY;
      43                 :            : 
      44                 :            :     void writeXml( QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context ) const override;
      45                 :            :     void readXml( const QDomElement &itemElem, const QgsReadWriteContext &context ) override;
      46                 :            : 
      47                 :            :     /**
      48                 :            :      * Sets the file path for the source SVG file.
      49                 :            :      * \see filePath()
      50                 :            :      */
      51                 :            :     void setFilePath( const QString &file );
      52                 :            : 
      53                 :            :     /**
      54                 :            :      * Returns the file path for the source SVG file.
      55                 :            :      * \see setFilePath()
      56                 :            :      */
      57                 :            :     QString filePath() const { return mFilePath; }
      58                 :            : 
      59                 :            :     /**
      60                 :            :      * Returns a new QgsSvgAnnotation object.
      61                 :            :      */
      62                 :          0 :     static QgsSvgAnnotation *create() SIP_FACTORY { return new QgsSvgAnnotation(); }
      63                 :            : 
      64                 :            :   protected:
      65                 :            : 
      66                 :            :     void renderAnnotation( QgsRenderContext &context, QSizeF size ) const override;
      67                 :            : 
      68                 :            :   private:
      69                 :            :     mutable QSvgRenderer mSvgRenderer; // QSvgRenderer::render methods are not const?
      70                 :            :     QString mFilePath;
      71                 :            : };
      72                 :            : 
      73                 :            : #endif // QGSSVGANNOTATION_H