QGIS API Documentation
4.3.0-Master (16eddb2670e)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
core
annotations
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 "qgis_core.h"
22
#include "
qgsannotation.h
"
23
#include "
qgsfeature.h
"
24
25
class
QgsWebPage
;
26
32
33
class
CORE_EXPORT
QgsHtmlAnnotation
:
public
QgsAnnotation
34
{
35
Q_OBJECT
36
public
:
40
QgsHtmlAnnotation
( QObject *parent
SIP_TRANSFERTHIS
=
nullptr
);
41
42
QgsHtmlAnnotation
*
clone
()
const
override
SIP_FACTORY
;
43
44
QSizeF
minimumFrameSize
()
const override
;
45
50
void
setSourceFile
(
const
QString &htmlFile );
51
56
QString
sourceFile
()
const
{
return
mHtmlFile; }
57
62
void
setHtmlSource(
const
QString &htmlSource );
63
67
QString
htmlSource
()
const
{
return
mHtmlSource; }
68
69
void
writeXml
( QDomElement &elem, QDomDocument &doc,
const
QgsReadWriteContext
&context )
const override
;
70
void
readXml
(
const
QDomElement &itemElem,
const
QgsReadWriteContext
&context )
override
;
71
72
void
setAssociatedFeature
(
const
QgsFeature
&feature )
override
;
73
77
static
QgsHtmlAnnotation
*
create
()
SIP_FACTORY
{
return
new
QgsHtmlAnnotation
(); }
78
79
protected
:
80
void
renderAnnotation
(
QgsRenderContext
&context, QSizeF size )
const override
;
81
82
private
slots:
83
84
void
javascript();
85
86
private
:
87
QgsWebPage
*mWebPage =
nullptr
;
88
QString mHtmlFile;
89
QString mHtmlSource;
90
};
91
92
#endif
// QGSHTMLANNOTATION_H
QgsAnnotation::renderAnnotation
virtual void renderAnnotation(QgsRenderContext &context, QSizeF size) const =0
Renders the annotation's contents to a target /a context at the specified /a size.
QgsAnnotation::setAssociatedFeature
virtual void setAssociatedFeature(const QgsFeature &feature)
Sets the feature associated with the annotation.
Definition
qgsannotation.cpp:197
QgsAnnotation::minimumFrameSize
virtual QSizeF minimumFrameSize() const
Returns the minimum frame size for the annotation.
Definition
qgsannotation.cpp:228
QgsAnnotation::readXml
virtual void readXml(const QDomElement &itemElem, const QgsReadWriteContext &context)=0
Restores the annotation's state from a DOM element.
QgsAnnotation::QgsAnnotation
QgsAnnotation(QObject *parent=nullptr)
Constructor for QgsAnnotation.
Definition
qgsannotation.cpp:38
QgsAnnotation::clone
virtual QgsAnnotation * clone() const =0
Clones the annotation, returning a new copy of the annotation reflecting the annotation's current sta...
QgsAnnotation::writeXml
virtual void writeXml(QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context) const =0
Writes the annotation state to a DOM element.
QgsFeature
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition
qgsfeature.h:60
QgsHtmlAnnotation::create
static QgsHtmlAnnotation * create()
Returns a new QgsHtmlAnnotation object.
Definition
qgshtmlannotation.h:77
QgsHtmlAnnotation::htmlSource
QString htmlSource() const
Returns html source text.
Definition
qgshtmlannotation.h:67
QgsHtmlAnnotation::QgsHtmlAnnotation
QgsHtmlAnnotation(QObject *parent=nullptr)
Constructor for QgsHtmlAnnotation.
Definition
qgshtmlannotation.cpp:48
QgsHtmlAnnotation::setSourceFile
void setSourceFile(const QString &htmlFile)
Sets the file path for the source HTML file.
Definition
qgshtmlannotation.cpp:72
QgsHtmlAnnotation::sourceFile
QString sourceFile() const
Returns the file path for the source HTML file.
Definition
qgshtmlannotation.h:56
QgsReadWriteContext
A container for the context for various read/write operations on objects.
Definition
qgsreadwritecontext.h:38
QgsRenderContext
Contains information about the context of a rendering operation.
Definition
qgsrendercontext.h:63
QgsWebPage
QWebPage subclass which redirects JavaScript errors and console output to the QGIS message log.
Definition
qgswebpage.h:175
SIP_TRANSFERTHIS
#define SIP_TRANSFERTHIS
Definition
qgis_sip.h:52
SIP_FACTORY
#define SIP_FACTORY
Definition
qgis_sip.h:83
qgsannotation.h
qgsfeature.h
Generated on
for QGIS API Documentation by
1.17.0