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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/callouts/qgscalloutsregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsCalloutWidget /External/;
class QgsCalloutAbstractMetadata
{
%Docstring(signature="appended")
Stores metadata about one callout renderer class.
.. note::
It's necessary to implement :py:func:`~createCallout` function.
In C++ you can use :py:class:`QgsCalloutMetadata` convenience class.
.. versionadded:: 3.10
%End
%TypeHeaderCode
#include "qgscalloutsregistry.h"
%End
public:
QgsCalloutAbstractMetadata( const QString &name, const QString &visibleName, const QIcon &icon = QIcon() );
%Docstring
Constructor for QgsCalloutAbstractMetadata, with the specified ``name``.
The ``visibleName`` argument gives a translated, user friendly string
identifying the callout type.
The ``icon`` argument can be used to specify an icon representing the
callout.
%End
virtual ~QgsCalloutAbstractMetadata();
QString name() const;
%Docstring
Returns the unique name of the callout type. This value is not
translated.
.. seealso:: :py:func:`visibleName`
%End
QString visibleName() const;
%Docstring
Returns a friendly display name of the callout type. This value is
translated.
.. seealso:: :py:func:`name`
%End
QIcon icon() const;
%Docstring
Returns an icon representing the callout.
.. seealso:: :py:func:`setIcon`
%End
void setIcon( const QIcon &icon );
%Docstring
Sets an ``icon`` representing the callout.
.. seealso:: :py:func:`icon`
%End
virtual QgsCallout *createCallout( const QVariantMap &properties, const QgsReadWriteContext &context ) = 0 /Factory/;
%Docstring
Create a callout of this type given the map of ``properties``.
Ownership of the callout is transferred to the caller.
%End
virtual QgsCalloutWidget *createCalloutWidget( QgsMapLayer * );
%Docstring
Creates a widget for configuring callouts of this type. Can return
``None`` if there's no GUI required.
Ownership of the widget is transferred to the caller.
%End
protected:
};
class QgsCalloutMetadata : QgsCalloutAbstractMetadata
{
%Docstring(signature="appended")
Convenience metadata class that uses static functions to create callouts
and their widgets.
.. versionadded:: 3.10
%End
%TypeHeaderCode
#include "qgscalloutsregistry.h"
%End
public:
virtual QgsCallout *createCallout( const QVariantMap &properties, const QgsReadWriteContext &context ) /Factory/;
virtual QgsCalloutWidget *createCalloutWidget( QgsMapLayer *vl ) /Factory/;
protected:
private:
QgsCalloutMetadata();
};
class QgsCalloutRegistry
{
%Docstring(signature="appended")
Registry of available callout classes.
:py:class:`QgsCalloutRegistry` is not usually directly created, but
rather accessed through :py:func:`QgsApplication.calloutRegistry()`.
.. versionadded:: 3.10
%End
%TypeHeaderCode
#include "qgscalloutsregistry.h"
%End
public:
QgsCalloutRegistry();
~QgsCalloutRegistry();
QgsCalloutAbstractMetadata *calloutMetadata( const QString &type ) const;
%Docstring
Returns the metadata for specified the specified callout ``type``.
Returns ``None`` if no matching callout style was found.
%End
bool addCalloutType( QgsCalloutAbstractMetadata *metadata /Transfer/ );
%Docstring
Registers a new callout type.
Ownership of ``metadata`` is transferred to the registry.
%End
QgsCallout *createCallout( const QString &type, const QVariantMap &properties = QVariantMap(), const QgsReadWriteContext &context = QgsReadWriteContext() ) const /Factory/;
%Docstring
Creates a new instance of a callout, given the callout ``type`` and
``properties``.
The caller takes ownership of the callout.
%End
QgsCallout *createCallout( const QString &type, const QDomElement &element, const QgsReadWriteContext &context ) const /Factory/;
%Docstring
Creates a new instance of a callout of the specified ``type``, using the
properties from a DOM ``element``.
The caller takes ownership of the callout.
%End
QStringList calloutTypes() const;
%Docstring
Returns a list of all available callout types.
%End
static QgsCallout *defaultCallout() /Factory/;
%Docstring
Create a new instance of a callout with default settings.
The caller takes ownership of the callout.
%End
private:
QgsCalloutRegistry( const QgsCalloutRegistry &rh );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/callouts/qgscalloutsregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
