1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/annotations/qgsannotationitemregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsAnnotationItemAbstractMetadata
{
%Docstring(signature="appended")
Stores metadata about one annotation item class.
A companion class, :py:class:`QgsAnnotationItemAbstractGuiMetadata`,
handles the GUI behavior of :py:class:`QgsAnnotationItems`.
.. note::
In C++ you can use :py:class:`QgsAnnotationItemMetadata` convenience class.
.. versionadded:: 3.16
%End
%TypeHeaderCode
#include "qgsannotationitemregistry.h"
%End
public:
QgsAnnotationItemAbstractMetadata( const QString &type, const QString &visibleName, const QString &visiblePluralName = QString() );
%Docstring
Constructor for QgsAnnotationItemAbstractMetadata with the specified
class ``type`` and ``visibleName``.
The optional ``visiblePluralName`` argument can be used to specify a
plural variant of the item type.
%End
virtual ~QgsAnnotationItemAbstractMetadata();
QString type() const;
%Docstring
Returns the unique item type string for the annotation item class.
%End
QString visibleName() const;
%Docstring
Returns a translated, user visible name for the annotation item class.
.. seealso:: :py:func:`visiblePluralName`
%End
QString visiblePluralName() const;
%Docstring
Returns a translated, user visible name for plurals of the annotation
item class (e.g. "Labels" for a "Label" item).
%End
virtual QgsAnnotationItem *createItem() = 0 /Factory/;
%Docstring
Creates a new, default, annotation item of this class.
%End
};
class QgsAnnotationItemRegistry : QObject
{
%Docstring(signature="appended")
Registry of available annotation item types.
:py:class:`QgsAnnotationItemRegistry` is not usually directly created,
but rather accessed through
:py:func:`QgsApplication.annotationItemRegistry()`.
A companion class, :py:class:`QgsAnnotationItemGuiRegistry`, handles the
GUI behavior of annotation items.
.. versionadded:: 3.16
%End
%TypeHeaderCode
#include "qgsannotationitemregistry.h"
%End
public:
QgsAnnotationItemRegistry( QObject *parent = 0 );
%Docstring
Creates a new empty item registry.
QgsAnnotationItemRegistry is not usually directly created, but rather
accessed through :py:func:`QgsApplication.annotationItemRegistry()`.
.. seealso:: :py:func:`populate`
%End
~QgsAnnotationItemRegistry();
bool populate();
%Docstring
Populates the registry with standard item types. If called on a
non-empty registry then this will have no effect and will return
``False``.
%End
QgsAnnotationItemAbstractMetadata *itemMetadata( const QString &type ) const;
%Docstring
Returns the metadata for the specified item ``type``. Returns ``None``
if a corresponding type was not found in the registry.
%End
bool addItemType( QgsAnnotationItemAbstractMetadata *metadata /Transfer/ );
%Docstring
Registers a new annotation item type. Takes ownership of the metadata
instance.
%End
QgsAnnotationItem *createItem( const QString &type ) const /Factory/;
%Docstring
Creates a new instance of a annotation item given the item ``type``.
%End
QMap< QString, QString> itemTypes() const;
%Docstring
Returns a map of available item types to translated name.
%End
signals:
void typeAdded( const QString &type, const QString &name );
%Docstring
Emitted whenever a new item type is added to the registry, with the
specified ``type`` and visible ``name``.
%End
private:
QgsAnnotationItemRegistry( const QgsAnnotationItemRegistry &rh );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/annotations/qgsannotationitemregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
