/
qgis.sip.in
592 lines (429 loc) · 11.9 KB
/
qgis.sip.in
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgis.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
%ModuleHeaderCode
#include <qgis.h>
%End
%ModuleCode
int QgisEvent = QEvent::User + 1;
%End
enum class QgsMapLayerType
{
VectorLayer,
RasterLayer,
PluginLayer,
MeshLayer,
VectorTileLayer,
AnnotationLayer,
PointCloudLayer,
};
class Qgis
{
%Docstring(signature="appended")
The Qgis class provides global constants for use throughout the application.
%End
%TypeHeaderCode
#include "qgis.h"
%End
public:
static const QMetaObject staticMetaObject;
public:
static QString version();
%Docstring
Version string.
.. versionadded:: 3.12
%End
static int versionInt();
%Docstring
Version number used for comparing versions using the "Check QGIS Version" function
.. versionadded:: 3.12
%End
static QString releaseName();
%Docstring
Release name
.. versionadded:: 3.12
%End
static const char *QGIS_DEV_VERSION;
static QString devVersion();
%Docstring
The development version
.. versionadded:: 3.12
%End
enum MessageLevel
{
Info,
Warning,
Critical,
Success,
NoLevel,
};
enum class DataType
{
UnknownDataType,
Byte,
UInt16,
Int16,
UInt32,
Int32,
Float32,
Float64,
CInt16,
CInt32,
CFloat32,
CFloat64,
ARGB32,
ARGB32_Premultiplied
};
enum class PythonMacroMode
{
Never,
Ask,
SessionOnly,
Always,
NotForThisSession,
};
enum class FeatureCountState
{
Uncounted,
UnknownCount,
};
enum class SymbolType
{
Marker,
Line,
Fill,
Hybrid
};
enum class ScaleMethod
{
ScaleArea,
ScaleDiameter
};
enum class SymbolRenderHint
{
DynamicRotation,
};
typedef QFlags<Qgis::SymbolRenderHint> SymbolRenderHints;
enum class SymbolFlag
{
RendererShouldUseSymbolLevels,
};
typedef QFlags<Qgis::SymbolFlag> SymbolFlags;
enum class SymbolPreviewFlag
{
FlagIncludeCrosshairsForMarkerSymbols,
};
typedef QFlags<Qgis::SymbolPreviewFlag> SymbolPreviewFlags;
enum class BrowserItemType
{
Collection,
Directory,
Layer,
Error,
Favorites,
Project,
Custom,
Fields,
Field,
};
enum class BrowserItemState
{
NotPopulated,
Populating,
Populated,
};
enum class BrowserItemCapability
{
NoCapabilities,
SetCrs,
Fertile,
Fast,
Collapse,
Rename,
Delete,
};
typedef QFlags<Qgis::BrowserItemCapability> BrowserItemCapabilities;
enum class BrowserLayerType
{
NoType,
Vector,
Raster,
Point,
Line,
Polygon,
TableLayer,
Database,
Table,
Plugin,
Mesh,
VectorTile,
PointCloud
};
enum class BrowserDirectoryMonitoring
{
Default,
NeverMonitor,
AlwaysMonitor,
};
enum class VectorExportResult
{
Success,
ErrorCreatingDataSource,
ErrorCreatingLayer,
ErrorAttributeTypeUnsupported,
ErrorAttributeCreationFailed,
ErrorProjectingFeatures,
ErrorFeatureWriteFailed,
ErrorInvalidLayer,
ErrorInvalidProvider,
ErrorProviderUnsupportedFeature,
ErrorConnectionFailed,
UserCanceled,
};
enum class SqlLayerDefinitionCapability
{
SubsetStringFilter,
GeometryColumn,
PrimaryKeys,
UnstableFeatureIds
};
typedef QFlags<Qgis::SqlLayerDefinitionCapability> SqlLayerDefinitionCapabilities;
enum class SqlKeywordCategory
{
Keyword,
Constant,
Function,
Geospatial,
Operator,
Math,
Aggregate,
String,
Identifier
};
enum class DriveType
{
Unknown,
Invalid,
Removable,
Fixed,
Remote,
CdRom,
RamDisk,
};
enum class UnplacedLabelVisibility
{
FollowEngineSetting,
NeverShow,
};
enum class SublayerQueryFlag
{
FastScan,
ResolveGeometryType,
CountFeatures,
};
typedef QFlags<Qgis::SublayerQueryFlag> SublayerQueryFlags;
enum class RasterPipeInterfaceRole
{
Unknown,
Provider,
Renderer,
Brightness,
Resampler,
Projector,
Nuller,
HueSaturation,
};
enum class RasterResamplingStage
{
//! Resampling occurs in ResamplingFilter
ResampleFilter,
//! Resampling occurs in Provider
Provider
};
enum class MeshEditingErrorType
{
NoError,
InvalidFace,
FlatFace,
UniqueSharedVertex,
InvalidVertex,
};
enum class FilePathType
{
Absolute,
Relative,
};
static const double DEFAULT_SEARCH_RADIUS_MM;
static const float DEFAULT_MAPTOPIXEL_THRESHOLD;
static const QColor DEFAULT_HIGHLIGHT_COLOR;
static const double DEFAULT_HIGHLIGHT_BUFFER_MM;
static const double DEFAULT_HIGHLIGHT_MIN_WIDTH_MM;
static const double SCALE_PRECISION;
static const double DEFAULT_Z_COORDINATE;
static const double DEFAULT_M_COORDINATE;
static const double UI_SCALE_FACTOR;
static const double DEFAULT_SNAP_TOLERANCE;
static const QgsTolerance::UnitType DEFAULT_SNAP_UNITS;
static QString defaultProjectScales();
%Docstring
A string with default project scales.
.. versionadded:: 3.12
%End
static int geosVersionInt();
%Docstring
GEOS version number linked
.. versionadded:: 3.20
%End
static int geosVersionMajor();
%Docstring
GEOS Major version number linked
.. versionadded:: 3.20
%End
static int geosVersionMinor();
%Docstring
GEOS Minor version number linked
.. versionadded:: 3.20
%End
static int geosVersionPatch();
%Docstring
GEOS Patch version number linked
.. versionadded:: 3.20
%End
static QString geosVersion();
%Docstring
GEOS string version linked
.. versionadded:: 3.20
%End
};
QFlags<Qgis::SymbolRenderHint> operator|(Qgis::SymbolRenderHint f1, QFlags<Qgis::SymbolRenderHint> f2);
QFlags<Qgis::SymbolFlag> operator|(Qgis::SymbolFlag f1, QFlags<Qgis::SymbolFlag> f2);
QFlags<Qgis::SymbolPreviewFlag> operator|(Qgis::SymbolPreviewFlag f1, QFlags<Qgis::SymbolPreviewFlag> f2);
QFlags<Qgis::BrowserItemCapability> operator|(Qgis::BrowserItemCapability f1, QFlags<Qgis::BrowserItemCapability> f2);
QFlags<Qgis::SublayerQueryFlag> operator|(Qgis::SublayerQueryFlag f1, QFlags<Qgis::SublayerQueryFlag> f2);
QFlags<Qgis::SqlLayerDefinitionCapability> operator|(Qgis::SqlLayerDefinitionCapability f1, QFlags<Qgis::SqlLayerDefinitionCapability> f2);
uint qHash( const QVariant &variant );
%Docstring
Hash for QVariant
%End
QString qgsDoubleToString( double a, int precision = 17 );
%Docstring
Returns a string representation of a double
:param a: double value
:param precision: number of decimal places to retain
%End
bool qgsNanCompatibleEquals( double a, double b );
%Docstring
Compare two doubles, treating nan values as equal
:param a: first double
:param b: second double
.. versionadded:: 3.20
%End
bool qgsDoubleNear( double a, double b, double epsilon = 4 * DBL_EPSILON );
%Docstring
Compare two doubles (but allow some difference)
:param a: first double
:param b: second double
:param epsilon: maximum difference allowable between doubles
%End
bool qgsFloatNear( float a, float b, float epsilon = 4 * FLT_EPSILON );
%Docstring
Compare two floats (but allow some difference)
:param a: first float
:param b: second float
:param epsilon: maximum difference allowable between floats
%End
bool qgsDoubleNearSig( double a, double b, int significantDigits = 10 );
%Docstring
Compare two doubles using specified number of significant digits
%End
double qgsRound( double number, int places );
%Docstring
Returns a double ``number``, rounded (as close as possible) to the specified number of ``places``.
.. versionadded:: 3.0
%End
double qgsPermissiveToDouble( QString string, bool &ok );
%Docstring
Converts a string to a double in a permissive way, e.g., allowing for incorrect
numbers of digits between thousand separators
:param string: string to convert
:param ok: will be set to ``True`` if conversion was successful
:return: string converted to double if possible
.. seealso:: :py:func:`permissiveToInt`
.. versionadded:: 2.9
%End
int qgsPermissiveToInt( QString string, bool &ok );
%Docstring
Converts a string to an integer in a permissive way, e.g., allowing for incorrect
numbers of digits between thousand separators
:param string: string to convert
:param ok: will be set to ``True`` if conversion was successful
:return: string converted to int if possible
.. seealso:: :py:func:`permissiveToDouble`
.. versionadded:: 2.9
%End
qlonglong qgsPermissiveToLongLong( QString string, bool &ok );
%Docstring
Converts a string to an qlonglong in a permissive way, e.g., allowing for incorrect
numbers of digits between thousand separators
:param string: string to convert
:param ok: will be set to ``True`` if conversion was successful
:return: string converted to int if possible
.. seealso:: :py:func:`permissiveToInt`
.. versionadded:: 3.4
%End
bool qgsVariantLessThan( const QVariant &lhs, const QVariant &rhs );
%Docstring
Compares two QVariant values and returns whether the first is less than the second.
Useful for sorting lists of variants, correctly handling sorting of the various
QVariant data types (such as strings, numeric values, dates and times)
Invalid < NULL < Values
.. seealso:: :py:func:`qgsVariantGreaterThan`
%End
bool qgsVariantEqual( const QVariant &lhs, const QVariant &rhs );
%Docstring
Compares two QVariant values and returns whether they are equal, two NULL values are
always treated as equal and 0 is not treated as equal with NULL
:param lhs: first value
:param rhs: second value
:return: ``True`` if values are equal
%End
bool qgsVariantGreaterThan( const QVariant &lhs, const QVariant &rhs );
%Docstring
Compares two QVariant values and returns whether the first is greater than the second.
Useful for sorting lists of variants, correctly handling sorting of the various
QVariant data types (such as strings, numeric values, dates and times)
.. seealso:: :py:func:`qgsVariantLessThan`
%End
bool operator> ( const QVariant &v1, const QVariant &v2 );
bool operator< ( const QVariant &v1, const QVariant &v2 );
QString qgsVsiPrefix( const QString &path );
const long GEOSRID;
const long GEOCRS_ID;
const long GEO_EPSG_CRS_ID;
const int USER_CRS_START_ID;
const double DEFAULT_POINT_SIZE;
const double DEFAULT_LINE_WIDTH;
const double DEFAULT_SEGMENT_EPSILON;
typedef unsigned long long qgssize;
QString geoWkt();
%Docstring
Wkt string that represents a geographic coord sys
\since QGIS GEOWkt
%End
//! PROJ4 string that represents a geographic coord sys
QString geoProj4();
//! Geographic coord sys from EPSG authority
QString geoEpsgCrsAuthId();
//! Constant that holds the string representation for "No ellips/No CRS"
QString geoNone();
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgis.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/