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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/metadata/qgsabstractlayermetadataprovider.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
struct QgsMetadataSearchContext
{
QgsCoordinateTransformContext transformContext;
};
class QgsLayerMetadataProviderResult: QgsLayerMetadata
{
%Docstring(signature="appended")
Result record of layer metadata provider search. The result contains
QGIS metadata information and all information that is required by QGIS
to load the layer and to filter the results.
The class extends :py:class:`QgsLayerMetadata` by adding information
taken directly from the provider which is required for filtering
(geographic extent) or because the actual values may be different by
those stored in the metadata (CRS authid) or totally missing from the
metadata (data provider name and layer type).
.. versionadded:: 3.28
%End
%TypeHeaderCode
#include "qgsabstractlayermetadataprovider.h"
%End
public:
QgsLayerMetadataProviderResult( const QgsLayerMetadata &metadata );
%Docstring
Constructor for QgsLayerMetadataProviderResult.
:param metadata: layer metadata.
%End
QgsLayerMetadataProviderResult( );
const QgsPolygon &geographicExtent() const;
%Docstring
Returns the layer extent in EPSG:4326
%End
void setGeographicExtent( const QgsPolygon &geographicExtent );
%Docstring
Sets the layer extent in EPSG:4326 to ``geographicExtent``
%End
Qgis::GeometryType geometryType() const;
%Docstring
Returns the layer geometry type.
%End
void setGeometryType( Qgis::GeometryType geometryType );
%Docstring
Sets the layer geometry type to ``geometryType``.
%End
const QString &authid() const;
%Docstring
Returns the layer CRS authid.
%End
void setAuthid( const QString &authid );
%Docstring
Sets the layer ``authid``.
%End
const QString &uri() const;
%Docstring
Returns the layer data source URI.
%End
void setUri( const QString &Uri );
%Docstring
Sets the layer data source URI to ``Uri``.
%End
const QString &dataProviderName() const;
%Docstring
Returns the data provider name.
%End
void setDataProviderName( const QString &dataProviderName );
%Docstring
Sets the data provider name to ``dataProviderName``.
%End
Qgis::LayerType layerType() const;
%Docstring
Returns the layer type.
%End
void setLayerType( Qgis::LayerType layerType );
%Docstring
Sets the layer type to ``layerType``.
%End
const QString &standardUri() const;
%Docstring
Returns the metadata standard URI (usually "http://mrcc.com/qgis.dtd")
%End
void setStandardUri( const QString &standardUri );
%Docstring
Sets the metadata standard URI to ``standardUri``.
%End
};
class QgsLayerMetadataSearchResults
{
%Docstring(signature="appended")
Container of result records from a layer metadata search.
Contains the records of the layer metadata provider that matched the
search criteria and the list of the errors that occurred while searching
for metadata.
.. versionadded:: 3.28
%End
%TypeHeaderCode
#include "qgsabstractlayermetadataprovider.h"
%End
public:
QList<QgsLayerMetadataProviderResult> metadata() const;
%Docstring
Returns the list of metadata results.
%End
void addMetadata( const QgsLayerMetadataProviderResult &metadata );
%Docstring
Adds a ``Metadata`` record to the list of results.
%End
QStringList errors() const;
%Docstring
Returns the list of errors occurred during a metadata search.
%End
void addError( const QString &error );
%Docstring
Adds a ``error`` to the list of errors.
%End
};
class QgsAbstractLayerMetadataProvider
{
%Docstring(signature="appended")
Layer metadata provider backend interface.
.. versionadded:: 3.28
%End
%TypeHeaderCode
#include "qgsabstractlayermetadataprovider.h"
%End
public:
virtual ~QgsAbstractLayerMetadataProvider();
virtual QString id() const = 0;
%Docstring
Returns the id of the layer metadata provider implementation, usually
the name of the data provider but it may be another unique identifier.
%End
virtual QgsLayerMetadataSearchResults search( const QgsMetadataSearchContext &searchContext, const QString &searchString = QString(), const QgsRectangle &geographicExtent = QgsRectangle(), QgsFeedback *feedback = 0 ) const = 0;
%Docstring
Searches for metadata optionally filtering by search string and
geographic extent.
:param searchContext: context for the metadata search.
:param searchString: defines a filter to limit the results to the
records where the search string appears in the
"identifier", "title" or "abstract" metadata
fields, a case-insensitive comparison is used for
the match.
:param geographicExtent: defines a filter where the spatial extent
matches the given extent in EPSG:4326
:param feedback: can be used to monitor and control the search process.
:return: a :py:class:`QgsLayerMetadataSearchResult` object with a list
of metadata and errors
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/metadata/qgsabstractlayermetadataprovider.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
