QGIS API Documentation
3.10.0-A Coruña (6c816b4204)
Main Page
Related Pages
Modules
+
Namespaces
Namespace List
+
Namespace Members
+
All
a
b
c
d
e
f
g
h
i
j
l
m
n
o
p
q
r
s
t
u
w
z
+
Functions
a
b
c
d
e
f
g
h
i
l
m
n
o
p
r
s
t
u
w
z
Variables
Typedefs
Enumerations
Enumerator
+
Classes
Class List
Class Index
Class Hierarchy
+
Class Members
+
All
2
3
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
~
+
Functions
2
3
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
~
+
Variables
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
+
Typedefs
a
c
e
f
g
h
k
l
m
o
p
r
s
t
u
v
w
+
Enumerations
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
z
+
Enumerator
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
+
Properties
a
b
c
d
e
f
g
h
i
l
m
n
o
p
r
s
t
u
v
w
x
y
z
+
Related Functions
a
c
d
e
f
g
i
l
m
n
o
p
q
r
s
t
v
+
Files
File List
+
File Members
+
All
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
y
z
+
Functions
_
a
b
c
d
e
f
g
h
i
j
l
m
n
o
p
q
r
s
u
v
w
z
+
Variables
a
b
c
d
e
g
h
i
l
n
o
p
q
r
s
t
u
w
+
Typedefs
a
c
d
e
f
g
h
i
l
m
n
o
p
q
r
s
t
u
v
w
Enumerations
Enumerator
+
Macros
a
b
c
d
e
f
g
h
i
k
l
m
n
o
p
q
r
s
t
w
y
•
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Properties
Friends
Macros
Modules
Pages
src
core
annotations
qgsannotationmanager.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgsannotationmanager.h
3
----------------------
4
Date : January 2017
5
Copyright : (C) 2017 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
16
#ifndef QGSANNOTATIONMANAGER_H
17
#define QGSANNOTATIONMANAGER_H
18
19
#include "qgis_core.h"
20
#include "
qgis.h
"
21
#include <QObject>
22
#include <QDomElement>
23
24
class
QgsReadWriteContext
;
25
class
QgsProject
;
26
class
QgsAnnotation
;
27
class
QgsStyleEntityVisitorInterface
;
28
44
class
CORE_EXPORT
QgsAnnotationManager
:
public
QObject
45
{
46
Q_OBJECT
47
48
public
:
49
54
explicit
QgsAnnotationManager
(
QgsProject
*project
SIP_TRANSFERTHIS
=
nullptr
);
55
56
~
QgsAnnotationManager
()
override
;
57
64
bool
addAnnotation(
QgsAnnotation
*annotation
SIP_TRANSFER
);
65
75
bool
removeAnnotation(
QgsAnnotation
*annotation );
76
81
void
clear();
82
87
QList< QgsAnnotation * > annotations()
const
;
88
95
QList< QgsAnnotation * > cloneAnnotations()
const
SIP_FACTORY
;
96
102
bool
readXml(
const
QDomElement &element,
const
QgsReadWriteContext
&context );
103
108
QDomElement writeXml( QDomDocument &doc,
const
QgsReadWriteContext
&context )
const
;
109
119
bool
accept(
QgsStyleEntityVisitorInterface
*visitor )
const
;
120
121
signals:
122
124
void
annotationAdded(
QgsAnnotation
*annotation );
125
127
void
annotationRemoved();
128
130
void
annotationAboutToBeRemoved(
QgsAnnotation
*annotation );
131
132
private
:
133
134
QgsProject
*mProject =
nullptr
;
135
136
QList< QgsAnnotation * > mAnnotations;
137
138
void
createAnnotationFromXml(
const
QDomElement &element,
const
QgsReadWriteContext
&context );
139
140
};
141
142
#endif // QGSANNOTATIONMANAGER_H
QgsReadWriteContext
The class is used as a container of context for various read/write operations on other objects...
Definition:
qgsreadwritecontext.h:34
SIP_TRANSFERTHIS
#define SIP_TRANSFERTHIS
Definition:
qgis_sip.h:53
QgsAnnotationManager
Manages storage of a set of QgsAnnotation annotation objects.
Definition:
qgsannotationmanager.h:44
QgsStyleEntityVisitorInterface
An interface for classes which can visit style entity (e.g.
Definition:
qgsstyleentityvisitor.h:33
QgsAnnotation
Abstract base class for annotation items which are drawn over a map.
Definition:
qgsannotation.h:49
SIP_TRANSFER
#define SIP_TRANSFER
Definition:
qgis_sip.h:36
QgsProject
Encapsulates a QGIS project, including sets of map layers and their styles, layouts, annotations, canvases, etc.
Definition:
qgsproject.h:89
SIP_FACTORY
#define SIP_FACTORY
Definition:
qgis_sip.h:76
qgis.h
Generated on Sun Oct 27 2019 00:43:28 for QGIS API Documentation by
1.8.13