/
qgis.sip.in
222 lines (150 loc) · 5.3 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
/************************************************************************
* 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
class Qgis
{
%Docstring
The Qgis class provides global constants for use throughout the application.
%End
%TypeHeaderCode
#include "qgis.h"
%End
public:
static const QString QGIS_VERSION;
static const int QGIS_VERSION_INT;
static const QString QGIS_RELEASE_NAME;
static const char *QGIS_DEV_VERSION;
enum MessageLevel
{
Info,
Warning,
Critical,
Success,
None
};
enum DataType
{
UnknownDataType,
Byte,
UInt16,
Int16,
UInt32,
Int32,
Float32,
Float64,
CInt16,
CInt32,
CFloat32,
CFloat64,
ARGB32,
ARGB32_Premultiplied
};
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 UI_SCALE_FACTOR;
static const double DEFAULT_SNAP_TOLERANCE;
static const QgsTolerance::UnitType DEFAULT_SNAP_UNITS;
};
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 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, double 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
.. versionadded:: 2.9
.. seealso:: :py:func:`permissiveToInt`
%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
.. versionadded:: 2.9
.. seealso:: :py:func:`permissiveToDouble`
%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)
.. seealso:: :py:func:`qgsVariantGreaterThan`
%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
QString qgsVsiPrefix( const QString &path );
const QString GEOWKT;
const QString PROJECT_SCALES;
const QString GEOPROJ4;
const long GEOSRID;
const long GEOCRS_ID;
const long GEO_EPSG_CRS_ID;
const QString GEO_EPSG_CRS_AUTHID;
const int USER_CRS_START_ID;
const QString GEO_NONE;
const double DEFAULT_POINT_SIZE;
const double DEFAULT_LINE_WIDTH;
const double DEFAULT_SEGMENT_EPSILON;
typedef unsigned long long qgssize;
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgis.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/