/
qgis.sip
258 lines (201 loc) · 6.56 KB
/
qgis.sip
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
/************************************************************************
* 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;
%Docstring
Version string
%End
static const int QGIS_VERSION_INT;
%Docstring
Version number used for comparing versions using the "Check QGIS Version" function
%End
static const QString QGIS_RELEASE_NAME;
%Docstring
Release name
%End
static const char *QGIS_DEV_VERSION;
%Docstring
The development version
%End
enum DataType
{
UnknownDataType,
Byte,
UInt16,
Int16,
UInt32,
Int32,
Float32,
Float64,
CInt16,
CInt32,
CFloat32,
CFloat64,
ARGB32,
ARGB32_Premultiplied
};
static const double DEFAULT_SEARCH_RADIUS_MM;
%Docstring
Identify search radius in mm
.. versionadded:: 2.3
%End
static const float DEFAULT_MAPTOPIXEL_THRESHOLD;
%Docstring
Default threshold between map coordinates and device coordinates for map2pixel simplification
%End
static const QColor DEFAULT_HIGHLIGHT_COLOR;
%Docstring
Default highlight color. The transparency is expected to only be applied to polygon
fill. Lines and outlines are rendered opaque.
.. versionadded:: 2.3
%End
static const double DEFAULT_HIGHLIGHT_BUFFER_MM;
%Docstring
Default highlight buffer in mm.
.. versionadded:: 2.3
%End
static const double DEFAULT_HIGHLIGHT_MIN_WIDTH_MM;
%Docstring
Default highlight line/stroke minimum width in mm.
.. versionadded:: 2.3
%End
static const double SCALE_PRECISION;
%Docstring
Fudge factor used to compare two scales. The code is often going from scale to scale
denominator. So it looses precision and, when a limit is inclusive, can lead to errors.
To avoid that, use this factor instead of using <= or >=.
.. versionadded:: 2.15
%End
static const double DEFAULT_Z_COORDINATE;
%Docstring
Default Z coordinate value for 2.5d geometry
This value have to be assigned to the Z coordinate for the new 2.5d geometry vertex.
.. versionadded:: 3.0
%End
static const double UI_SCALE_FACTOR;
%Docstring
UI scaling factor. This should be applied to all widget sizes obtained from font metrics,
to account for differences in the default font sizes across different platforms.
.. versionadded:: 3.0
%End
};
uint qHash( const QVariant &variant );
%Docstring
Hash for QVariant
:rtype: uint
%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
:rtype: str
%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
:rtype: bool
%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
:rtype: bool
%End
bool qgsDoubleNearSig( double a, double b, int significantDigits = 10 );
%Docstring
Compare two doubles using specified number of significant digits
:rtype: bool
%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
:rtype: float
%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:: permissiveToInt
:rtype: float
%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:: permissiveToDouble
:rtype: int
%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:: qgsVariantGreaterThan()
:rtype: bool
%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:: qgsVariantLessThan()
:rtype: bool
%End
QString qgsVsiPrefix( const QString &path );
%Docstring
:rtype: str
%End
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 *
************************************************************************/