QGIS API Documentation  3.17.0-Master (df2c9ff931)
qgshtmlannotation.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgshtmlannotation.h
3  ------------------------
4  begin : February 9, 2010
5  copyright : (C) 2010 by Marco Hugentobler
6  email : marco dot hugentobler at hugis dot net
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 QGSHTMLANNOTATION_H
19 #define QGSHTMLANNOTATION_H
20 
21 #include "qgsannotation.h"
22 #include "qgsfeature.h"
23 
24 #include "qgis_core.h"
25 
26 class QgsWebPage;
27 
35 class CORE_EXPORT QgsHtmlAnnotation: public QgsAnnotation
36 {
37  Q_OBJECT
38  public:
39 
43  QgsHtmlAnnotation( QObject *parent SIP_TRANSFERTHIS = nullptr );
44 
45  QgsHtmlAnnotation *clone() const override SIP_FACTORY;
46 
47  QSizeF minimumFrameSize() const override;
48 
53  void setSourceFile( const QString &htmlFile );
54 
59  QString sourceFile() const { return mHtmlFile; }
60 
61  void writeXml( QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context ) const override;
62  void readXml( const QDomElement &itemElem, const QgsReadWriteContext &context ) override;
63 
64  void setAssociatedFeature( const QgsFeature &feature ) override;
65 
69  static QgsHtmlAnnotation *create() SIP_FACTORY { return new QgsHtmlAnnotation(); }
70 
71  protected:
72 
73  void renderAnnotation( QgsRenderContext &context, QSizeF size ) const override;
74 
75  private slots:
76 
77  void javascript();
78 
79  private:
80  QgsWebPage *mWebPage = nullptr;
81  QString mHtmlFile;
82  QString mHtmlSource;
83 
84 };
85 
86 #endif // QGSHTMLANNOTATION_H
The class is used as a container of context for various read/write operations on other objects...
#define SIP_TRANSFERTHIS
Definition: qgis_sip.h:53
virtual void writeXml(QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context) const =0
Writes the annotation state to a DOM element.
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:55
An annotation item that embeds HTML content.
Abstract base class for annotation items which are drawn over a map.
Definition: qgsannotation.h:49
QString sourceFile() const
Returns the file path for the source HTML file.
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 void readXml(const QDomElement &itemElem, const QgsReadWriteContext &context)=0
Restores the annotation's state from a DOM element.
#define SIP_FACTORY
Definition: qgis_sip.h:76
virtual QSizeF minimumFrameSize() const
Returns the minimum frame size for the annotation.
Contains information about the context of a rendering operation.
virtual QgsAnnotation * clone() const =0
Clones the annotation, returning a new copy of the annotation reflecting the annotation's current sta...
static QgsHtmlAnnotation * create()
Returns a new QgsHtmlAnnotation object.
virtual void setAssociatedFeature(const QgsFeature &feature)
Sets the feature associated with the annotation.
QWebPage subclass which redirects JavaScript errors and console output to the QGIS message log...
Definition: qgswebpage.h:216