QGIS API Documentation  3.37.0-Master (a5b4d9743e8)
qgssvgannotation.h
Go to the documentation of this file.
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 
30 class CORE_EXPORT QgsSvgAnnotation: public QgsAnnotation
31 {
32  Q_OBJECT
33 
34  public:
35 
39  QgsSvgAnnotation( QObject *parent SIP_TRANSFERTHIS = nullptr );
40 
41  QgsSvgAnnotation *clone() const override SIP_FACTORY;
42 
43  void writeXml( QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context ) const override;
44  void readXml( const QDomElement &itemElem, const QgsReadWriteContext &context ) override;
45 
50  void setFilePath( const QString &file );
51 
56  QString filePath() const { return mFilePath; }
57 
62 
63  protected:
64 
65  void renderAnnotation( QgsRenderContext &context, QSizeF size ) const override;
66 
67  private:
68  mutable QSvgRenderer mSvgRenderer; // QSvgRenderer::render methods are not const?
69  QString mFilePath;
70 };
71 
72 #endif // QGSSVGANNOTATION_H
Abstract base class for annotation items which are drawn over a map.
Definition: qgsannotation.h:53
virtual void renderAnnotation(QgsRenderContext &context, QSizeF size) const =0
Renders the annotation's contents to a target /a context at the specified /a size.
virtual QgsAnnotation * clone() const =0
Clones the annotation, returning a new copy of the annotation reflecting the annotation's current sta...
virtual void readXml(const QDomElement &itemElem, const QgsReadWriteContext &context)=0
Restores the annotation's state from a DOM element.
virtual void writeXml(QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context) const =0
Writes the annotation state to a DOM element.
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.
An annotation which renders the contents of an SVG file.
QString filePath() const
Returns the file path for the source SVG file.
static QgsSvgAnnotation * create()
Returns a new QgsSvgAnnotation object.
#define SIP_TRANSFERTHIS
Definition: qgis_sip.h:53
#define SIP_FACTORY
Definition: qgis_sip.h:76