QGIS API Documentation 3.43.0-Master (0bee5d6404c)
qgis.h
Go to the documentation of this file.
1/***************************************************************************
2 qgis.h - QGIS namespace
3 -------------------
4 begin : Sat Jun 30 2002
5 copyright : (C) 2002 by Gary E.Sherman
6 email : sherman at mrcc.com
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
18#ifndef QGIS_H
19#define QGIS_H
20
21
22#include <QMetaEnum>
23#include <cfloat>
24#include <memory>
25#include <cmath>
26
27#include "qgis_core.h"
28#include "qgis_sip.h"
29
30#ifdef SIP_RUN
31% ModuleHeaderCode
32#include <qgis.h>
33% End
34
35% ModuleCode
36int QgisEvent = QEvent::User + 1;
37% End
38#endif
39
40#ifndef SIP_RUN
41// qHash implementation for scoped enum type
42// https://gitlab.com/frostasm/programming-knowledge-base/-/snippets/20120
43#define QHASH_FOR_CLASS_ENUM(T) \
44 inline uint qHash(const T &t, uint seed) { \
45 return ::qHash(static_cast<typename std::underlying_type<T>::type>(t), seed); \
46 }
47#endif
48
53class CORE_EXPORT Qgis
54{
55 Q_GADGET
56 Q_CLASSINFO( "RegisterEnumClassesUnscoped", "false" )
57
58 public:
59
65 static QString version();
66
72 static int versionInt();
73
79 static QString releaseName();
80
82 static const char *QGIS_DEV_VERSION;
83
89 static QString devVersion();
90
91 // Enumerations
92 //
93
100 {
101 ClearStorage = 1 << 0,
102
103 ReadConfiguration = 1 << 1,
104 UpdateConfiguration = 1 << 2,
105 DeleteConfiguration = 1 << 3,
106 CreateConfiguration = 1 << 4,
107
108 ReadCertificateIdentity = 1 << 5,
109 UpdateCertificateIdentity = 1 << 6,
110 DeleteCertificateIdentity = 1 << 7,
111 CreateCertificateIdentity = 1 << 8,
112
113 ReadSslCertificateCustomConfig = 1 << 9,
114 UpdateSslCertificateCustomConfig = 1 << 10,
115 DeleteSslCertificateCustomConfig = 1 << 11,
116 CreateSslCertificateCustomConfig = 1 << 12,
117
118 ReadCertificateAuthority = 1 << 13,
119 UpdateCertificateAuthority = 1 << 14,
120 DeleteCertificateAuthority = 1 << 15,
121 CreateCertificateAuthority = 1 << 16,
122
123 ReadCertificateTrustPolicy = 1 << 17,
124 UpdateCertificateTrustPolicy = 1 << 18,
125 DeleteCertificateTrustPolicy = 1 << 19,
126 CreateCertificateTrustPolicy = 1 << 20,
127
128 ReadMasterPassword = 1 << 21,
129 UpdateMasterPassword = 1 << 22,
130 DeleteMasterPassword = 1 << 23,
131 CreateMasterPassword = 1 << 24,
132
133 ReadSetting = 1 << 25,
134 UpdateSetting = 1 << 26,
135 DeleteSetting = 1 << 27,
136 CreateSetting = 1 << 28,
137
138 };
139 Q_ENUM( AuthConfigurationStorageCapability )
140
141
147
148
154 {
155 Info = 0,
156 Warning = 1,
157 Critical = 2,
158 Success = 3,
159 NoLevel = 4,
160 };
161 Q_ENUM( MessageLevel )
162
163
169 {
170 Vector SIP_MONKEYPATCH_COMPAT_NAME( VectorLayer ),
171 Raster SIP_MONKEYPATCH_COMPAT_NAME( RasterLayer ),
172 Plugin SIP_MONKEYPATCH_COMPAT_NAME( PluginLayer ),
173 Mesh SIP_MONKEYPATCH_COMPAT_NAME( MeshLayer ),
174 VectorTile SIP_MONKEYPATCH_COMPAT_NAME( VectorTileLayer ),
175 Annotation SIP_MONKEYPATCH_COMPAT_NAME( AnnotationLayer ),
176 PointCloud SIP_MONKEYPATCH_COMPAT_NAME( PointCloudLayer ),
177 Group SIP_MONKEYPATCH_COMPAT_NAME( GroupLayer ),
178 TiledScene,
179 };
180 Q_ENUM( LayerType )
181
182
188 {
189 RasterLayer = 1,
190 NoGeometry = 2,
191 PointLayer = 4,
192 LineLayer = 8,
193 PolygonLayer = 16,
194 HasGeometry = PointLayer | LineLayer | PolygonLayer,
195 VectorLayer = NoGeometry | HasGeometry,
196 PluginLayer = 32,
197 WritableLayer = 64,
198 MeshLayer = 128,
199 VectorTileLayer = 256,
200 PointCloudLayer = 512,
201 AnnotationLayer = 1024,
202 TiledSceneLayer = 2048,
203 All = RasterLayer | VectorLayer | PluginLayer | MeshLayer | VectorTileLayer | PointCloudLayer | AnnotationLayer | TiledSceneLayer,
204 SpatialLayer = RasterLayer | HasGeometry | PluginLayer | MeshLayer | VectorTileLayer | PointCloudLayer | AnnotationLayer | TiledSceneLayer
205 };
206 Q_DECLARE_FLAGS( LayerFilters, LayerFilter )
207 Q_FLAG( LayerFilters )
208
209
214 enum class LoadStyleFlag : int SIP_ENUM_BASETYPE( IntFlag )
215 {
216 IgnoreMissingStyleErrors = 1 << 0,
217 };
218 Q_ENUM( LoadStyleFlag )
219
220
225 Q_DECLARE_FLAGS( LoadStyleFlags, LoadStyleFlag )
226 Q_FLAG( LoadStyleFlags )
227
256 {
257 Unknown = 0,
258 Point = 1,
259 LineString = 2,
260 Polygon = 3,
261 Triangle = 17,
262 MultiPoint = 4,
263 MultiLineString = 5,
264 MultiPolygon = 6,
265 GeometryCollection = 7,
266 CircularString = 8,
267 CompoundCurve = 9,
268 CurvePolygon = 10,
269 MultiCurve = 11,
270 MultiSurface = 12,
271 PolyhedralSurface = 15,
272 TIN = 16,
273 NoGeometry = 100,
274 PointZ = 1001,
275 LineStringZ = 1002,
276 PolygonZ = 1003,
277 TriangleZ = 1017,
278 MultiPointZ = 1004,
279 MultiLineStringZ = 1005,
280 MultiPolygonZ = 1006,
281 GeometryCollectionZ = 1007,
282 CircularStringZ = 1008,
283 CompoundCurveZ = 1009,
284 CurvePolygonZ = 1010,
285 MultiCurveZ = 1011,
286 MultiSurfaceZ = 1012,
287 PolyhedralSurfaceZ = 1015,
288 TINZ = 1016,
289 PointM = 2001,
290 LineStringM = 2002,
291 PolygonM = 2003,
292 TriangleM = 2017,
293 MultiPointM = 2004,
294 MultiLineStringM = 2005,
295 MultiPolygonM = 2006,
296 GeometryCollectionM = 2007,
297 CircularStringM = 2008,
298 CompoundCurveM = 2009,
299 CurvePolygonM = 2010,
300 MultiCurveM = 2011,
301 MultiSurfaceM = 2012,
302 PolyhedralSurfaceM = 2015,
303 TINM = 2016,
304 PointZM = 3001,
305 LineStringZM = 3002,
306 PolygonZM = 3003,
307 MultiPointZM = 3004,
308 MultiLineStringZM = 3005,
309 MultiPolygonZM = 3006,
310 GeometryCollectionZM = 3007,
311 CircularStringZM = 3008,
312 CompoundCurveZM = 3009,
313 CurvePolygonZM = 3010,
314 MultiCurveZM = 3011,
315 MultiSurfaceZM = 3012,
316 PolyhedralSurfaceZM = 3015,
317 TINZM = 3016,
318 TriangleZM = 3017,
319 Point25D = 0x80000001,
320 LineString25D,
321 Polygon25D,
322 MultiPoint25D,
323 MultiLineString25D,
324 MultiPolygon25D
325 };
326 Q_ENUM( WkbType )
327
328
337 {
338 Point SIP_MONKEYPATCH_COMPAT_NAME( PointGeometry ),
339 Line SIP_MONKEYPATCH_COMPAT_NAME( LineGeometry ),
340 Polygon SIP_MONKEYPATCH_COMPAT_NAME( PolygonGeometry ),
341 Unknown SIP_MONKEYPATCH_COMPAT_NAME( UnknownGeometry ),
342 Null SIP_MONKEYPATCH_COMPAT_NAME( NullGeometry ),
343 };
344 Q_ENUM( GeometryType )
345
346
351 {
352 UnknownDataType = 0,
353 Byte = 1,
354 Int8 = 14,
355 UInt16 = 2,
356 Int16 = 3,
357 UInt32 = 4,
358 Int32 = 5,
359 Float32 = 6,
360 Float64 = 7,
361 CInt16 = 8,
362 CInt32 = 9,
363 CFloat32 = 10,
364 CFloat64 = 11,
365 ARGB32 = 12,
366 ARGB32_Premultiplied = 13
367 };
368 Q_ENUM( DataType )
369
370
375 enum class CaptureTechnique : int
376 {
377 StraightSegments,
378 CircularString,
379 Streaming,
380 Shape,
381 };
382 Q_ENUM( CaptureTechnique )
383
384
389 enum class VectorLayerTypeFlag : int SIP_ENUM_BASETYPE( IntFlag )
390 {
391 SqlQuery = 1 << 0
392 };
393 Q_ENUM( VectorLayerTypeFlag )
396 Q_FLAG( VectorLayerTypeFlags )
397
402 enum class PythonEmbeddedMode SIP_MONKEYPATCH_SCOPEENUM_UNNEST( Qgis, PythonMacroMode ) : int
403 {
404 Never = 0,
405 Ask = 1,
406 SessionOnly = 2,
407 Always = 3,
408 NotForThisSession,
409 };
410 Q_ENUM( PythonEmbeddedMode )
411
412
416 enum class PythonEmbeddedType : int
417 {
418 Macro = 0,
419 ExpressionFunction = 1,
420 };
421 Q_ENUM( PythonEmbeddedType )
422
423
431 {
432 TrustDataSource SIP_MONKEYPATCH_COMPAT_NAME( FlagTrustDataSource ) = 1 << 0,
433 SkipFeatureCount = 1 << 1,
434 LoadDefaultStyle SIP_MONKEYPATCH_COMPAT_NAME( FlagLoadDefaultStyle ) = 1 << 2,
435 SkipGetExtent = 1 << 3,
436 SkipFullScan = 1 << 4,
437 ForceReadOnly = 1 << 5,
438 SkipCredentialsRequest = 1 << 6,
439 ParallelThreadLoading = 1 << 7,
440 };
441 Q_ENUM( DataProviderReadFlag )
442
443
451 Q_FLAG( DataProviderReadFlags )
452
453 // TODO QGIS 4 -- remove NoCapabilities and rely on VectorProviderCapabilities() instead
454
463 {
464 NoCapabilities = 0,
465 AddFeatures = 1,
466 DeleteFeatures = 1 << 1,
467 ChangeAttributeValues = 1 << 2,
468 AddAttributes = 1 << 3,
469 DeleteAttributes = 1 << 4,
470 CreateSpatialIndex = 1 << 6,
471 SelectAtId = 1 << 7,
472 ChangeGeometries = 1 << 8,
473 SelectEncoding = 1 << 13,
474 CreateAttributeIndex = 1 << 12,
475 SimplifyGeometries = 1 << 14,
476 SimplifyGeometriesWithTopologicalValidation = 1 << 15,
477 TransactionSupport = 1 << 16,
478 CircularGeometries = 1 << 17,
479 ChangeFeatures = 1 << 18,
480 RenameAttributes = 1 << 19,
481 FastTruncate = 1 << 20,
482 ReadLayerMetadata = 1 << 21,
483 WriteLayerMetadata = 1 << 22,
484 CancelSupport = 1 << 23,
485 CreateRenderer = 1 << 24,
486 CreateLabeling = 1 << 25,
487 ReloadData = 1 << 26,
488 FeatureSymbology = 1 << 27,
489 EditingCapabilities = AddFeatures | DeleteFeatures | ChangeAttributeValues | ChangeGeometries | AddAttributes | DeleteAttributes | RenameAttributes,
490 };
491 Q_ENUM( VectorProviderCapability )
492
493
502
509 {
510 Uncounted = -2,
511 UnknownCount = -1,
512 };
513 Q_ENUM( FeatureCountState )
514
515
522 {
523 Unknown SIP_MONKEYPATCH_COMPAT_NAME( SpatialIndexUnknown ) = 0,
524 NotPresent SIP_MONKEYPATCH_COMPAT_NAME( SpatialIndexNotPresent ) = 1,
525 Present SIP_MONKEYPATCH_COMPAT_NAME( SpatialIndexPresent ) = 2,
526 };
527 Q_ENUM( SpatialIndexPresence )
528
529
541 {
542 NoFeaturesAvailable = 0,
543 FeaturesAvailable,
544 FeaturesMaybeAvailable
545 };
546 Q_ENUM( FeatureAvailability )
547
548
554 {
555 EditAlias = 1 << 0,
556 EditComment = 1 << 1,
557 };
558
559 Q_ENUM( VectorDataProviderAttributeEditCapability )
560
561
568
574 {
575 Marker,
576 Line,
577 Fill,
578 Hybrid
579 };
580 Q_ENUM( SymbolType )
581
582
588 {
589 ScaleArea,
590 ScaleDiameter
591 };
592 Q_ENUM( ScaleMethod )
593
594
599 {
600 Custom,
601 Variant,
602 String,
603 StringList,
604 VariantMap,
605 Bool,
606 Integer,
607 Double,
608 EnumFlag,
609 Color
610 };
611 Q_ENUM( SettingsType )
612
613
618 {
619 Root,
620 Standard,
621 NamedList,
622 };
623 Q_ENUM( SettingsTreeNodeType )
624
625
629 enum class SettingsTreeNodeOption : int SIP_ENUM_BASETYPE( IntFlag )
630 {
631 NamedListSelectedItemSetting = 1 << 0,
632 };
633
634 Q_ENUM( SettingsTreeNodeOption )
637
646 {
647 Invalid SIP_MONKEYPATCH_COMPAT_NAME( InvalidProperty ),
648 Static SIP_MONKEYPATCH_COMPAT_NAME( StaticProperty ),
649 Field SIP_MONKEYPATCH_COMPAT_NAME( FieldBasedProperty ),
650 Expression SIP_MONKEYPATCH_COMPAT_NAME( ExpressionBasedProperty ),
651 };
652 Q_ENUM( PropertyType )
653
654
659 enum class SldExportOption : int SIP_ENUM_BASETYPE( IntFlag )
660 {
661 NoOptions = 0,
662 Svg = 1 << 0,
663 Png = 1 << 1,
664 };
665 Q_ENUM( SldExportOption )
667 Q_FLAG( SldExportOptions )
668
674 enum class SldExportVendorExtension : int SIP_ENUM_BASETYPE( IntFlag )
675 {
676 NoVendorExtension = 0,
677 GeoServerVendorExtension = 1 << 1,
678 DeegreeVendorExtension = 1 << 2,
679 };
680 Q_ENUM( SldExportVendorExtension )
681
682
683
687 enum class SettingsOption : int SIP_ENUM_BASETYPE( IntFlag )
688 {
689 SaveFormerValue = 1 << 1,
690 SaveEnumFlagAsInt = 1 << 2,
691 };
692 Q_ENUM( SettingsOption )
693 Q_DECLARE_FLAGS( SettingsOptions, SettingsOption )
694 Q_FLAG( SettingsOptions )
695
701 {
702 ActiveLayer = 1,
703 AllLayers = 2,
704 AdvancedConfiguration = 3,
705 };
706 Q_ENUM( SnappingMode )
707
708
713 {
714 NoSnap SIP_MONKEYPATCH_COMPAT_NAME( NoSnapFlag ) = 0,
715 Vertex SIP_MONKEYPATCH_COMPAT_NAME( VertexFlag ) = 1 << 0,
716 Segment SIP_MONKEYPATCH_COMPAT_NAME( SegmentFlag ) = 1 << 1,
717 Area SIP_MONKEYPATCH_COMPAT_NAME( AreaFlag ) = 1 << 2,
718 Centroid SIP_MONKEYPATCH_COMPAT_NAME( CentroidFlag ) = 1 << 3,
719 MiddleOfSegment SIP_MONKEYPATCH_COMPAT_NAME( MiddleOfSegmentFlag ) = 1 << 4,
720 LineEndpoint SIP_MONKEYPATCH_COMPAT_NAME( LineEndpointFlag ) = 1 << 5,
721 };
722 Q_ENUM( SnappingType )
725 Q_FLAG( SnappingTypes )
726
733 {
734 DynamicRotation = 1 << 1,
735 IsSymbolLayerSubSymbol = 1 << 2,
736 ForceVectorRendering = 1 << 3,
737 ExcludeSymbolBuffers = 1 << 4,
738 };
739 Q_ENUM( SymbolRenderHint )
742 Q_FLAG( SymbolRenderHints )
743
749 enum class SymbolRotationMode : int
750 {
751 RespectMapRotation,
752 IgnoreMapRotation,
753 };
754 Q_ENUM( SymbolRotationMode )
755
756
757
769 Q_ENUM( HorizontalAnchorPoint )
770
771
778 {
779 Top,
780 Center SIP_MONKEYPATCH_COMPAT_NAME( VCenter ),
781 Bottom,
782 Baseline,
783 };
784 Q_ENUM( VerticalAnchorPoint )
785
786
791 enum class FeatureRendererFlag : int SIP_ENUM_BASETYPE( IntFlag )
792 {
793 AffectsLabeling = 1 << 0,
794 };
795 Q_ENUM( FeatureRendererFlag )
796
797
803 Q_FLAG( FeatureRendererFlags )
804
810 enum class SymbolFlag : int SIP_ENUM_BASETYPE( IntFlag )
811 {
812 RendererShouldUseSymbolLevels = 1 << 0,
813 AffectsLabeling = 1 << 1,
814 };
815 Q_ENUM( SymbolFlag )
817 Q_DECLARE_FLAGS( SymbolFlags, SymbolFlag )
818 Q_FLAG( SymbolFlags )
819
826 {
827 FlagIncludeCrosshairsForMarkerSymbols = 1 << 0,
828 };
829 Q_ENUM( SymbolPreviewFlag )
832 Q_FLAG( SymbolPreviewFlags )
833
843 enum class SymbolLayerFlag : int SIP_ENUM_BASETYPE( IntFlag )
844 {
845 DisableFeatureClipping = 1 << 0,
846 CanCalculateMaskGeometryPerFeature = 1 << 1,
847 AffectsLabeling = 1 << 2,
848 };
849 Q_ENUM( SymbolLayerFlag )
852 Q_FLAG( SymbolLayerFlags )
853
863 enum class SymbolLayerUserFlag : int SIP_ENUM_BASETYPE( IntFlag )
864 {
865 DisableSelectionRecoloring = 1 << 0,
866 };
867 Q_ENUM( SymbolLayerUserFlag )
868
869
875 Q_FLAG( SymbolLayerUserFlags )
876
883 {
884 Collection,
885 Directory,
886 Layer,
887 Error,
888 Favorites,
889 Project,
890 Custom,
891 Fields,
892 Field,
893 };
894 Q_ENUM( BrowserItemType )
895
896
902 {
903 NotPopulated,
904 Populating,
905 Populated,
906 };
907 Q_ENUM( BrowserItemState )
908
909
915 {
916 NoCapabilities = 0,
917 SetCrs = 1 << 0,
918 Fertile = 1 << 1,
919 Fast = 1 << 2,
920 Collapse = 1 << 3,
921 Rename = 1 << 4,
922 Delete = 1 << 5,
923 ItemRepresentsFile = 1 << 6,
924 RefreshChildrenWhenItemIsRefreshed = 1 << 7,
925 ReadOnly = 1 << 8,
926 };
927 Q_ENUM( BrowserItemCapability )
931
940 {
941 NoCapabilities SIP_MONKEYPATCH_COMPAT_NAME( NoDataCapabilities ) = 0,
942 Files SIP_MONKEYPATCH_COMPAT_NAME( File ) = 1,
943 Directories SIP_MONKEYPATCH_COMPAT_NAME( Dir ) = 1 << 1,
944 Databases SIP_MONKEYPATCH_COMPAT_NAME( Database ) = 1 << 2,
945 NetworkSources SIP_MONKEYPATCH_COMPAT_NAME( Net ) = 1 << 3,
946 };
947 Q_ENUM( DataItemProviderCapability )
948
949
958
965 {
966 NoType,
967 Vector,
968 Raster,
969 Point,
970 Line,
971 Polygon,
972 TableLayer,
973 Database,
974 Table,
975 Plugin,
976 Mesh,
977 VectorTile,
978 PointCloud,
979 TiledScene,
980 };
981 Q_ENUM( BrowserLayerType )
982
983
989 {
990 Default,
991 NeverMonitor,
992 AlwaysMonitor,
993 };
994 Q_ENUM( BrowserDirectoryMonitoring )
995
996
1000 enum class HttpMethod : int
1001 {
1002 Get = 0,
1003 Post = 1,
1004 Head,
1005 Put,
1006 Delete,
1007 };
1008 Q_ENUM( HttpMethod )
1009
1010
1016 {
1017 Success SIP_MONKEYPATCH_COMPAT_NAME( NoError ) = 0,
1018 ErrorCreatingDataSource SIP_MONKEYPATCH_COMPAT_NAME( ErrCreateDataSource ),
1019 ErrorCreatingLayer SIP_MONKEYPATCH_COMPAT_NAME( ErrCreateLayer ),
1020 ErrorAttributeTypeUnsupported SIP_MONKEYPATCH_COMPAT_NAME( ErrAttributeTypeUnsupported ),
1021 ErrorAttributeCreationFailed SIP_MONKEYPATCH_COMPAT_NAME( ErrAttributeCreationFailed ),
1022 ErrorProjectingFeatures SIP_MONKEYPATCH_COMPAT_NAME( ErrProjection ),
1023 ErrorFeatureWriteFailed SIP_MONKEYPATCH_COMPAT_NAME( ErrFeatureWriteFailed ),
1024 ErrorInvalidLayer SIP_MONKEYPATCH_COMPAT_NAME( ErrInvalidLayer ),
1025 ErrorInvalidProvider SIP_MONKEYPATCH_COMPAT_NAME( ErrInvalidProvider ),
1026 ErrorProviderUnsupportedFeature SIP_MONKEYPATCH_COMPAT_NAME( ErrProviderUnsupportedFeature ),
1027 ErrorConnectionFailed SIP_MONKEYPATCH_COMPAT_NAME( ErrConnectionFailed ),
1028 UserCanceled SIP_MONKEYPATCH_COMPAT_NAME( ErrUserCanceled ),
1029 };
1030 Q_ENUM( VectorExportResult )
1031
1032
1037 {
1038 FieldAliases = 1 << 0,
1039 FieldComments = 1 << 2,
1040 };
1041 Q_ENUM( VectorFileWriterCapability )
1042
1043
1049
1055 {
1056 SubsetStringFilter = 1 << 1,
1057 GeometryColumn = 1 << 2,
1058 PrimaryKeys = 1 << 3,
1059 UnstableFeatureIds = 1 << 4
1060 };
1061 Q_ENUM( SqlLayerDefinitionCapability )
1065
1071 enum class SqlKeywordCategory : int
1072 {
1073 Keyword,
1074 Constant,
1075 Function,
1076 Geospatial,
1077 Operator,
1078 Math,
1079 Aggregate,
1080 String,
1081 Identifier
1082 };
1083 Q_ENUM( SqlKeywordCategory )
1084
1085
1089 enum class DriveType : int
1090 {
1091 Unknown,
1092 Invalid,
1093 Removable,
1094 Fixed,
1095 Remote,
1096 CdRom,
1097 RamDisk,
1098 Cloud,
1099 };
1100 Q_ENUM( DriveType )
1101
1102
1107 {
1108 Deferred SIP_MONKEYPATCH_COMPAT_NAME( DownloadLater ),
1109 Immediate SIP_MONKEYPATCH_COMPAT_NAME( DownloadImmediately ),
1110 };
1111 Q_ENUM( ActionStart )
1112
1113
1119 {
1120 FollowEngineSetting,
1121 NeverShow,
1122 };
1123 Q_ENUM( UnplacedLabelVisibility )
1124
1125
1130 enum class LabelOverlapHandling : int
1131 {
1132 PreventOverlap,
1133 AllowOverlapIfRequired,
1134 AllowOverlapAtNoCost,
1135 };
1136 Q_ENUM( LabelOverlapHandling )
1137
1138
1143 enum class LabelPrioritization : int
1144 {
1145 PreferCloser,
1146 PreferPositionOrdering,
1147 };
1148 Q_ENUM( LabelPrioritization )
1149
1150
1158 {
1159 AroundPoint,
1160 OverPoint,
1161 Line,
1162 Curved,
1163 Horizontal,
1164 Free,
1165 OrderedPositionsAroundPoint,
1166 PerimeterCurved,
1167 OutsidePolygons,
1168 };
1169 Q_ENUM( LabelPlacement )
1170
1171
1179 {
1180 TopLeft,
1181 TopSlightlyLeft,
1182 TopMiddle,
1183 TopSlightlyRight,
1184 TopRight,
1185 MiddleLeft,
1186 MiddleRight,
1187 BottomLeft,
1188 BottomSlightlyLeft,
1189 BottomMiddle,
1190 BottomSlightlyRight,
1191 BottomRight,
1192 OverPoint,
1193 };
1194 Q_ENUM( LabelPredefinedPointPosition )
1195
1196
1205 {
1206 FromPoint,
1207 FromSymbolBounds,
1208 };
1209 Q_ENUM( LabelOffsetType )
1210
1211
1219 {
1220 AboveLeft SIP_MONKEYPATCH_COMPAT_NAME( QuadrantAboveLeft ),
1221 Above SIP_MONKEYPATCH_COMPAT_NAME( QuadrantAbove ),
1222 AboveRight SIP_MONKEYPATCH_COMPAT_NAME( QuadrantAboveRight ),
1223 Left SIP_MONKEYPATCH_COMPAT_NAME( QuadrantLeft ),
1224 Over SIP_MONKEYPATCH_COMPAT_NAME( QuadrantOver ),
1225 Right SIP_MONKEYPATCH_COMPAT_NAME( QuadrantRight ),
1226 BelowLeft SIP_MONKEYPATCH_COMPAT_NAME( QuadrantBelowLeft ),
1227 Below SIP_MONKEYPATCH_COMPAT_NAME( QuadrantBelow ),
1228 BelowRight SIP_MONKEYPATCH_COMPAT_NAME( QuadrantBelowRight ),
1229 };
1230 Q_ENUM( LabelQuadrantPosition )
1231
1232
1239 {
1240 OnLine = 1,
1241 AboveLine = 2,
1242 BelowLine = 4,
1243 MapOrientation = 8,
1244 };
1245 Q_ENUM( LabelLinePlacementFlag )
1246
1247
1255 Q_FLAG( LabelLinePlacementFlags )
1256
1264 {
1265 AllowPlacementOutsideOfPolygon = 1 << 0,
1266 AllowPlacementInsideOfPolygon = 1 << 1,
1267 };
1268 Q_ENUM( LabelPolygonPlacementFlag )
1269
1270
1278
1287 {
1288 FlipUpsideDownLabels SIP_MONKEYPATCH_COMPAT_NAME( Upright ),
1289 AllowUpsideDownWhenRotationIsDefined SIP_MONKEYPATCH_COMPAT_NAME( ShowDefined ),
1290 AlwaysAllowUpsideDown SIP_MONKEYPATCH_COMPAT_NAME( ShowAll )
1291 };
1292 Q_ENUM( UpsideDownLabelHandling )
1293
1294
1302 {
1303 Left SIP_MONKEYPATCH_COMPAT_NAME( MultiLeft ) = 0,
1304 Center SIP_MONKEYPATCH_COMPAT_NAME( MultiCenter ),
1305 Right SIP_MONKEYPATCH_COMPAT_NAME( MultiRight ),
1306 FollowPlacement SIP_MONKEYPATCH_COMPAT_NAME( MultiFollowPlacement ),
1307 Justify SIP_MONKEYPATCH_COMPAT_NAME( MultiJustify ),
1308 };
1309 Q_ENUM( LabelMultiLineAlignment )
1310
1311
1318 {
1319 Vector SIP_MONKEYPATCH_COMPAT_NAME( FilterVector ) = 1,
1320 Raster SIP_MONKEYPATCH_COMPAT_NAME( FilterRaster ),
1321 Mesh SIP_MONKEYPATCH_COMPAT_NAME( FilterMesh ),
1322 MeshDataset SIP_MONKEYPATCH_COMPAT_NAME( FilterMeshDataset ),
1323 PointCloud SIP_MONKEYPATCH_COMPAT_NAME( FilterPointCloud ),
1324 VectorTile,
1325 TiledScene,
1326 };
1327 Q_ENUM( FileFilterType )
1328
1329
1334 enum class UriCleaningFlag : int SIP_ENUM_BASETYPE( IntFlag )
1335 {
1336 RemoveCredentials = 1 << 0,
1337 RedactCredentials = 1 << 1,
1338 };
1339 Q_ENUM( UriCleaningFlag )
1340
1341
1347 Q_FLAG( UriCleaningFlags )
1348
1354 enum class SublayerQueryFlag : int SIP_ENUM_BASETYPE( IntFlag )
1355 {
1356 FastScan = 1 << 0,
1357 ResolveGeometryType = 1 << 1,
1358 CountFeatures = 1 << 2,
1359 IncludeSystemTables = 1 << 3,
1360 };
1363 Q_ENUM( SublayerQueryFlag )
1364 Q_FLAG( SublayerQueryFlags )
1365
1366
1371 enum class SublayerFlag : int SIP_ENUM_BASETYPE( IntFlag )
1372 {
1373 SystemTable = 1 << 0,
1374 };
1376 Q_DECLARE_FLAGS( SublayerFlags, SublayerFlag )
1377 Q_ENUM( SublayerFlag )
1378 Q_FLAG( SublayerFlags )
1379
1380
1388 {
1389 Linear SIP_MONKEYPATCH_COMPAT_NAME( Interpolated ) = 0,
1390 Discrete = 1,
1391 Exact = 2,
1392 };
1393 Q_ENUM( ShaderInterpolationMethod )
1394
1395
1403 {
1404 Continuous = 1,
1405 EqualInterval = 2,
1406 Quantile = 3,
1407 };
1408 Q_ENUM( ShaderClassificationMethod )
1409
1410
1416 {
1417 Unknown SIP_MONKEYPATCH_COMPAT_NAME( UnknownRole ) = 0,
1418 Provider SIP_MONKEYPATCH_COMPAT_NAME( ProviderRole ) = 1,
1419 Renderer SIP_MONKEYPATCH_COMPAT_NAME( RendererRole ) = 2,
1420 Brightness SIP_MONKEYPATCH_COMPAT_NAME( BrightnessRole ) = 3,
1421 Resampler SIP_MONKEYPATCH_COMPAT_NAME( ResamplerRole ) = 4,
1422 Projector SIP_MONKEYPATCH_COMPAT_NAME( ProjectorRole ) = 5,
1423 Nuller SIP_MONKEYPATCH_COMPAT_NAME( NullerRole ) = 6,
1424 HueSaturation SIP_MONKEYPATCH_COMPAT_NAME( HueSaturationRole ) = 7,
1425 };
1426 Q_ENUM( RasterPipeInterfaceRole )
1427
1428
1433 {
1434 ResampleFilter,
1435 Provider,
1436 };
1437 Q_ENUM( RasterResamplingStage )
1438
1439
1447 {
1448 Nearest,
1449 Bilinear,
1450 Cubic,
1451 CubicSpline,
1452 Lanczos,
1453 Average,
1454 Mode,
1455 Gauss
1456 };
1457 Q_ENUM( RasterResamplingMethod )
1458
1459
1464 enum class RasterRendererFlag : int SIP_ENUM_BASETYPE( IntFlag )
1465 {
1466 InternalLayerOpacityHandling = 1 << 0,
1467 UseNoDataForOutOfRangePixels = 1 << 1,
1468 };
1469
1476
1477 Q_ENUM( RasterRendererFlag )
1478 Q_FLAG( RasterRendererFlags )
1479
1480
1486 {
1487 UsesMultipleBands = 1 << 0,
1488 };
1489 Q_ENUM( RasterRendererCapability )
1490
1491
1498
1507 {
1508 NotSet SIP_MONKEYPATCH_COMPAT_NAME( None_ ),
1509 MinimumMaximum SIP_MONKEYPATCH_COMPAT_NAME( MinMax ),
1510 StdDev,
1511 CumulativeCut
1512 };
1513 Q_ENUM( RasterRangeLimit )
1514
1515
1523 {
1524 WholeRaster SIP_MONKEYPATCH_COMPAT_NAME( None_ ),
1525 FixedCanvas SIP_MONKEYPATCH_COMPAT_NAME( CurrentCanvas ),
1526 UpdatedCanvas,
1527 };
1528 Q_ENUM( RasterRangeExtent )
1529
1530
1538 {
1539 Exact,
1540 Estimated,
1541 };
1542 Q_ENUM( RasterRangeAccuracy )
1543
1544
1550 {
1551 Generic = 0,
1552 PixelCount = 1,
1553 Name = 2,
1554 Min = 3,
1555 Max = 4,
1556 MinMax = 5,
1557 Red = 6,
1558 Green = 7,
1559 Blue = 8,
1560 Alpha = 9,
1561 RedMin = 10,
1562 GreenMin = 11,
1563 BlueMin = 12,
1564 AlphaMin = 13,
1565 RedMax = 14,
1566 GreenMax = 15,
1567 BlueMax = 16,
1568 AlphaMax = 17,
1569 MaxCount
1570 };
1571 Q_ENUM( RasterAttributeTableFieldUsage )
1572
1573
1579 {
1580 Thematic = 0,
1581 Athematic = 1
1582 };
1583 Q_ENUM( RasterAttributeTableType )
1584
1585
1592 {
1593 Raw = 0,
1594 RenderedImage SIP_MONKEYPATCH_COMPAT_NAME( Image ) = 1
1595 };
1596 Q_ENUM( RasterExportType )
1597
1598
1605 {
1606 Success SIP_MONKEYPATCH_COMPAT_NAME( NoError ) = 0,
1607 SourceProviderError = 1,
1608 DestinationProviderError SIP_MONKEYPATCH_COMPAT_NAME( DestProviderError ) = 2,
1609 CreateDatasourceError = 3,
1610 WriteError = 4,
1611 NoDataConflict = 5,
1612 Canceled SIP_MONKEYPATCH_COMPAT_NAME( WriteCanceled ) = 6,
1613 };
1614 Q_ENUM( RasterFileWriterResult )
1615
1616
1621 enum class MeshEditingErrorType : int
1622 {
1623 NoError,
1624 InvalidFace,
1625 TooManyVerticesInFace,
1626 FlatFace,
1627 UniqueSharedVertex,
1628 InvalidVertex,
1629 ManifoldFace,
1630 };
1631 Q_ENUM( MeshEditingErrorType )
1632
1633
1638 enum class FilePathType : int
1639 {
1640 Absolute,
1641 Relative,
1642 };
1643 Q_ENUM( FilePathType )
1644
1645
1650 enum class SublayerPromptMode : int
1651 {
1652 AlwaysAsk,
1653 AskExcludingRasterBands,
1654 NeverAskSkip,
1655 NeverAskLoadAll,
1656 };
1657 Q_ENUM( SublayerPromptMode )
1658
1659
1667 {
1668 Unknown SIP_MONKEYPATCH_COMPAT_NAME( OriginUnknown ),
1669 Provider SIP_MONKEYPATCH_COMPAT_NAME( OriginProvider ),
1670 Join SIP_MONKEYPATCH_COMPAT_NAME( OriginJoin ),
1671 Edit SIP_MONKEYPATCH_COMPAT_NAME( OriginEdit ),
1672 Expression SIP_MONKEYPATCH_COMPAT_NAME( OriginExpression )
1673 };
1674 Q_ENUM( FieldOrigin )
1675
1676
1683 enum class FieldConfigurationFlag : int SIP_ENUM_BASETYPE( IntFlag )
1684 {
1685 NoFlag = 0,
1686 NotSearchable = 1 << 1,
1687 HideFromWms = 1 << 2,
1688 HideFromWfs = 1 << 3,
1689 };
1690 Q_ENUM( FieldConfigurationFlag )
1691
1692
1700 Q_FLAG( FieldConfigurationFlags )
1701
1707 enum class FieldMetadataProperty : int
1708 {
1709 GeometryCrs = 0x1000,
1710 GeometryWkbType = 0x1001,
1711 CustomProperty = 0x100000,
1712 };
1713 Q_ENUM( FieldMetadataProperty )
1714
1715
1720 enum class SelectionRenderingMode : int
1721 {
1722 Default,
1723 CustomColor,
1724 CustomSymbol,
1725 };
1726 Q_ENUM( SelectionRenderingMode )
1727
1728
1734 {
1735 SetSelection,
1736 AddToSelection,
1737 IntersectSelection,
1738 RemoveFromSelection,
1739 };
1740 Q_ENUM( SelectBehavior )
1741
1742
1748 {
1749 Intersect,
1750 Within,
1751 };
1752 Q_ENUM( SelectGeometryRelationship )
1753
1754
1759 enum class SelectionFlag : int SIP_ENUM_BASETYPE( IntFlag )
1760 {
1761 SingleFeatureSelection = 1 << 0,
1762 ToggleSelection = 1 << 1,
1763 };
1764
1770 Q_DECLARE_FLAGS( SelectionFlags, SelectionFlag )
1771
1772 Q_ENUM( SelectionFlag )
1773 Q_FLAG( SelectionFlags )
1774
1775
1781 {
1782 Success = 0,
1783 EmptyGeometry = 1,
1784 EditFailed = 2,
1785 FetchFeatureFailed = 3,
1786 InvalidLayer = 4,
1787 };
1788 Q_ENUM( VectorEditResult )
1789
1790
1796 {
1797 SemiTransparentCircle,
1798 Cross,
1799 NoMarker,
1800 };
1801 Q_ENUM( VertexMarkerType )
1802
1803
1807 enum class ContentStatus : int
1808 {
1809 NotStarted,
1810 Running,
1811 Finished,
1812 Failed,
1813 Canceled,
1814 };
1815 Q_ENUM( ContentStatus )
1816
1817
1822 enum class GpsConnectionType : int
1823 {
1824 Automatic,
1825 Internal,
1826 Serial,
1827 Gpsd,
1828 };
1829 Q_ENUM( GpsConnectionType )
1830
1831
1836 enum class DeviceConnectionStatus SIP_MONKEYPATCH_SCOPEENUM_UNNEST( Qgis, GpsConnectionStatus ) : int
1837 {
1838 Disconnected,
1839 Connecting,
1840 Connected,
1841 };
1842 Q_ENUM( DeviceConnectionStatus )
1843
1844
1852 {
1853 NoData,
1854 NoFix,
1855 Fix2D,
1856 Fix3D
1857 };
1859
1860
1867 {
1868 Unknown,
1869 Gps,
1870 Glonass,
1871 Galileo,
1872 BeiDou,
1873 Qzss,
1874 Navic,
1875 Sbas,
1876 };
1878
1885 {
1886 Unknown = -1,
1887 Invalid,
1888 GPS,
1889 DGPS,
1890 PPS,
1891 RTK,
1892 FloatRTK,
1893 Estimated,
1894 Manual,
1895 Simulation,
1896 };
1897 Q_ENUM( GpsQualityIndicator )
1898
1899
1904 enum class GpsNavigationStatus : int
1905 {
1906 NotValid,
1907 Safe,
1908 Caution,
1909 Unsafe,
1910 };
1912
1918 enum class GpsInformationComponent : int SIP_ENUM_BASETYPE( IntFlag )
1919 {
1920 Location = 1 << 0,
1921 Altitude = 1 << 1,
1922 GroundSpeed = 1 << 2,
1923 Bearing = 1 << 3,
1924 TotalTrackLength = 1 << 4,
1925 TrackDistanceFromStart = 1 << 5,
1926 Pdop = 1 << 6,
1927 Hdop = 1 << 7,
1928 Vdop = 1 << 8,
1929 HorizontalAccuracy = 1 << 9,
1930 VerticalAccuracy = 1 << 10,
1931 HvAccuracy = 1 << 11,
1932 SatellitesUsed = 1 << 12,
1933 Timestamp = 1 << 13,
1934 TrackStartTime = 1 << 14,
1935 TrackEndTime = 1 << 15,
1936 TrackDistanceSinceLastPoint = 1 << 16,
1937 TrackTimeSinceLastPoint = 1 << 17,
1938 GeoidalSeparation = 1 << 18,
1939 EllipsoidAltitude = 1 << 19,
1940 };
1941
1948 Q_ENUM( GpsInformationComponent )
1949 Q_FLAG( GpsInformationComponents )
1950
1951
1956 enum class BabelFormatCapability : int SIP_ENUM_BASETYPE( IntFlag )
1957 {
1958 Import = 1 << 0,
1959 Export = 1 << 1,
1960 Waypoints = 1 << 2,
1961 Routes = 1 << 3,
1962 Tracks = 1 << 4,
1963 };
1966 Q_ENUM( BabelFormatCapability )
1967 Q_FLAG( BabelFormatCapabilities )
1968
1969
1975 enum class BabelCommandFlag : int SIP_ENUM_BASETYPE( IntFlag )
1976 {
1977 QuoteFilePaths = 1 << 0,
1978 };
1981 Q_ENUM( BabelCommandFlag )
1982 Q_FLAG( BabelCommandFlags )
1983
1984
1989 enum class GpsFeatureType : int
1990 {
1991 Waypoint,
1992 Route,
1993 Track,
1994 };
1995 Q_ENUM( GpsFeatureType )
1996
1997
2005 {
2006 Success = 0,
2007 NothingHappened = 1000,
2008 InvalidBaseGeometry,
2009 InvalidInputGeometryType,
2010 SelectionIsEmpty,
2011 SelectionIsGreaterThanOne,
2012 GeometryEngineError,
2013 LayerNotEditable,
2014 // Add part issues
2015 AddPartSelectedGeometryNotFound,
2016 AddPartNotMultiGeometry,
2017 // Add ring issues
2018 AddRingNotClosed,
2019 AddRingNotValid,
2020 AddRingCrossesExistingRings,
2021 AddRingNotInExistingFeature,
2022 // Split features
2023 SplitCannotSplitPoint,
2024 GeometryTypeHasChanged,
2025 };
2026 Q_ENUM( GeometryOperationResult )
2027
2028
2034 {
2035 AllowSelfTouchingHoles SIP_MONKEYPATCH_COMPAT_NAME( FlagAllowSelfTouchingHoles ) = 1 << 0,
2036 };
2039 Q_ENUM( GeometryValidityFlag )
2040 Q_FLAG( GeometryValidityFlags )
2041
2042
2047 {
2048 QgisInternal SIP_MONKEYPATCH_COMPAT_NAME( ValidatorQgisInternal ),
2049 Geos SIP_MONKEYPATCH_COMPAT_NAME( ValidatorGeos ),
2050 };
2051 Q_ENUM( GeometryValidationEngine )
2052
2053
2063 Q_ENUM( BufferSide )
2064
2065
2071 {
2072 Round SIP_MONKEYPATCH_COMPAT_NAME( CapRound ) = 1,
2073 Flat SIP_MONKEYPATCH_COMPAT_NAME( CapFlat ),
2074 Square SIP_MONKEYPATCH_COMPAT_NAME( CapSquare ),
2075 };
2076 Q_ENUM( EndCapStyle )
2077
2078
2084 {
2085 Round SIP_MONKEYPATCH_COMPAT_NAME( JoinStyleRound ) = 1,
2086 Miter SIP_MONKEYPATCH_COMPAT_NAME( JoinStyleMiter ),
2087 Bevel SIP_MONKEYPATCH_COMPAT_NAME( JoinStyleBevel ),
2088 };
2089 Q_ENUM( JoinStyle )
2090
2091
2096 enum class GeosCreationFlag : int SIP_ENUM_BASETYPE( IntFlag )
2097 {
2098 RejectOnInvalidSubGeometry = 1 << 0,
2099 SkipEmptyInteriorRings = 1 << 1,
2100 };
2101 Q_ENUM( GeosCreationFlag )
2102
2103
2109 Q_FLAG( GeosCreationFlags )
2110
2116 enum class CoverageValidityResult : int
2117 {
2118 Invalid = 0,
2119 Valid = 1,
2120 Error = 2,
2121 };
2122 Q_ENUM( CoverageValidityResult )
2123
2124
2129 enum class MakeValidMethod : int
2130 {
2131 Linework = 0,
2132 Structure = 1,
2133 };
2134 Q_ENUM( MakeValidMethod )
2135
2136
2144 {
2145 NoFlags = 0,
2146 NoGeometry = 1,
2147 SubsetOfAttributes = 2,
2148 ExactIntersect = 4,
2149 IgnoreStaticNodesDuringExpressionCompilation = 8,
2150 EmbeddedSymbols = 16,
2151 };
2152 Q_ENUM( FeatureRequestFlag )
2153
2154
2162 Q_FLAG( FeatureRequestFlags )
2163
2172 {
2173 NoFilter SIP_MONKEYPATCH_COMPAT_NAME( FilterNone ),
2174 Fid SIP_MONKEYPATCH_COMPAT_NAME( FilterFid ),
2175 Expression SIP_MONKEYPATCH_COMPAT_NAME( FilterExpression ),
2176 Fids SIP_MONKEYPATCH_COMPAT_NAME( FilterFids )
2177 };
2178 Q_ENUM( FeatureRequestFilterType )
2179
2180
2188 {
2189 NoCheck SIP_MONKEYPATCH_COMPAT_NAME( GeometryNoCheck ) = 0,
2190 SkipInvalid SIP_MONKEYPATCH_COMPAT_NAME( GeometrySkipInvalid ) = 1,
2191 AbortOnInvalid SIP_MONKEYPATCH_COMPAT_NAME( GeometryAbortOnInvalid ) = 2,
2192 };
2193 Q_ENUM( InvalidGeometryCheck )
2194
2195
2200 enum class SpatialFilterType : int
2201 {
2202 NoFilter,
2203 BoundingBox,
2204 DistanceWithin,
2205 };
2206 Q_ENUM( SpatialFilterType )
2207
2208
2213 enum class FileOperationFlag : int SIP_ENUM_BASETYPE( IntFlag )
2214 {
2215 IncludeMetadataFile = 1 << 0,
2216 IncludeStyleFile = 1 << 1,
2217 };
2220 Q_ENUM( FileOperationFlag )
2221 Q_FLAG( FileOperationFlags )
2222
2223
2228 enum class MapLayerProperty : int SIP_ENUM_BASETYPE( IntFlag )
2229 {
2230 UsersCannotToggleEditing = 1 << 0,
2231 IsBasemapLayer = 1 << 1,
2232 };
2235 Q_ENUM( MapLayerProperty )
2236 Q_FLAG( MapLayerProperties )
2237
2238
2243 enum class AutoRefreshMode : int
2244 {
2245 Disabled = 0,
2246 ReloadData = 1,
2247 RedrawOnly = 2,
2248 };
2249 Q_ENUM( AutoRefreshMode )
2250
2251
2256 enum class DataProviderFlag : int SIP_ENUM_BASETYPE( IntFlag )
2257 {
2258 IsBasemapSource = 1 << 1,
2259 FastExtent2D = 1 << 2,
2260 FastExtent3D = 1 << 3,
2261 };
2264 Q_ENUM( DataProviderFlag )
2265 Q_FLAG( DataProviderFlags )
2266
2267
2274 enum class CrsType : int
2275 {
2276 Unknown,
2277 Geodetic,
2278 Geocentric,
2279 Geographic2d,
2280 Geographic3d,
2281 Vertical,
2282 Projected,
2283 Compound,
2284 Temporal,
2285 Engineering,
2286 Bound,
2287 Other,
2288 DerivedProjected,
2289 };
2290 Q_ENUM( CrsType )
2291
2292
2299 enum class CrsAxisDirection : int
2300 {
2301 North,
2302 NorthNorthEast,
2303 NorthEast,
2304 EastNorthEast,
2305 East,
2306 EastSouthEast,
2307 SouthEast,
2308 SouthSouthEast,
2309 South,
2310 SouthSouthWest,
2311 SouthWest,
2312 WestSouthWest,
2313 West,
2314 WestNorthWest,
2315 NorthWest,
2316 NorthNorthWest,
2317 GeocentricX,
2318 GeocentricY,
2319 GeocentricZ,
2320 Up,
2321 Down,
2322 Forward,
2323 Aft,
2324 Port,
2325 Starboard,
2326 Clockwise,
2327 CounterClockwise,
2328 ColumnPositive,
2329 ColumnNegative,
2330 RowPositive,
2331 RowNegative,
2332 DisplayRight,
2333 DisplayLeft,
2334 DisplayUp,
2335 DisplayDown,
2336 Future,
2337 Past,
2338 Towards,
2339 AwayFrom,
2340 Unspecified,
2341 };
2342 Q_ENUM( CrsAxisDirection )
2343
2344
2349 enum class CoordinateOrder : int
2350 {
2351 Default,
2352 XY,
2353 YX,
2354 };
2355 Q_ENUM( CoordinateOrder )
2356
2357
2365 {
2366 ShortString,
2367 MediumString,
2368 FullString,
2369 };
2370 Q_ENUM( CrsIdentifierType )
2371
2372
2380 {
2381 Wkt1Gdal SIP_MONKEYPATCH_COMPAT_NAME( WKT1_GDAL ),
2382 Wkt1Esri SIP_MONKEYPATCH_COMPAT_NAME( WKT1_ESRI ),
2383 Wkt2_2015 SIP_MONKEYPATCH_COMPAT_NAME( WKT2_2015 ),
2384 Wkt2_2015Simplified SIP_MONKEYPATCH_COMPAT_NAME( WKT2_2015_SIMPLIFIED ),
2385 Wkt2_2019 SIP_MONKEYPATCH_COMPAT_NAME( WKT2_2019 ),
2386 Wkt2_2019Simplified SIP_MONKEYPATCH_COMPAT_NAME( WKT2_2019_SIMPLIFIED ),
2387 Preferred SIP_MONKEYPATCH_COMPAT_NAME( WKT_PREFERRED ) = Wkt2_2019,
2388 PreferredSimplified SIP_MONKEYPATCH_COMPAT_NAME( WKT_PREFERRED_SIMPLIFIED ) = Wkt2_2019Simplified,
2389 PreferredGdal SIP_MONKEYPATCH_COMPAT_NAME( WKT_PREFERRED_GDAL ) = Wkt2_2019,
2390 };
2391 Q_ENUM( CrsWktVariant )
2392
2393
2398 enum class Axis : int
2399 {
2400 X,
2401 Y,
2402 Z
2403 };
2404 Q_ENUM( Axis )
2405
2406
2411 enum class AnnotationItemFlag : int SIP_ENUM_BASETYPE( IntFlag )
2412 {
2413 ScaleDependentBoundingBox = 1 << 0,
2414 SupportsReferenceScale = 1 << 1,
2415 SupportsCallouts = 1 << 2,
2416 };
2419 Q_ENUM( AnnotationItemFlag )
2420 Q_FLAG( AnnotationItemFlags )
2421
2422
2428 {
2429 SpatialBounds = 0,
2430 FixedSize,
2431 RelativeToMapFrame,
2432 };
2433 Q_ENUM( AnnotationPlacementMode )
2434
2435
2440 enum class AnnotationItemGuiFlag : int SIP_ENUM_BASETYPE( IntFlag )
2441 {
2442 FlagNoCreationTools = 1 << 0,
2443 };
2446 Q_ENUM( AnnotationItemGuiFlag )
2447 Q_FLAG( AnnotationItemGuiFlags )
2448
2449
2454 enum class AnnotationItemNodeType : int
2455 {
2456 VertexHandle,
2457 CalloutHandle,
2458 };
2459 Q_ENUM( AnnotationItemNodeType )
2460
2461
2467 {
2468 Success,
2469 Invalid,
2470 ItemCleared,
2471 };
2472 Q_ENUM( AnnotationItemEditOperationResult )
2473
2474
2482 {
2483 Disabled SIP_MONKEYPATCH_COMPAT_NAME( NavigationOff ),
2484 Animated,
2485 FixedRange,
2486 Movie,
2487 };
2488 Q_ENUM( TemporalNavigationMode )
2489
2490
2498 {
2499 Forward,
2500 Reverse,
2501 Idle,
2502 };
2503 Q_ENUM( AnimationState )
2504
2505
2510 enum class PlaybackOperation : int
2511 {
2512 SkipToStart,
2513 PreviousFrame,
2514 PlayReverse,
2515 Pause,
2516 PlayForward,
2517 NextFrame,
2518 SkipToEnd,
2519 };
2520 Q_ENUM( PlaybackOperation )
2521
2522
2528 {
2529 FixedTemporalRange SIP_MONKEYPATCH_COMPAT_NAME( ModeFixedTemporalRange ) = 0,
2530 FeatureDateTimeInstantFromField SIP_MONKEYPATCH_COMPAT_NAME( ModeFeatureDateTimeInstantFromField ),
2531 FeatureDateTimeStartAndEndFromFields SIP_MONKEYPATCH_COMPAT_NAME( ModeFeatureDateTimeStartAndEndFromFields ),
2532 FeatureDateTimeStartAndDurationFromFields SIP_MONKEYPATCH_COMPAT_NAME( ModeFeatureDateTimeStartAndDurationFromFields ),
2533 FeatureDateTimeStartAndEndFromExpressions SIP_MONKEYPATCH_COMPAT_NAME( ModeFeatureDateTimeStartAndEndFromExpressions ),
2534 RedrawLayerOnly SIP_MONKEYPATCH_COMPAT_NAME( ModeRedrawLayerOnly ),
2535 };
2536 Q_ENUM( VectorTemporalMode )
2537
2538
2544 {
2545 IncludeBeginExcludeEnd = 0,
2546 IncludeBeginIncludeEnd,
2547 };
2548 Q_ENUM( VectorTemporalLimitMode )
2549
2550
2556 {
2557 HasFixedTemporalRange SIP_MONKEYPATCH_COMPAT_NAME( ProviderHasFixedTemporalRange ) = 0,
2558 StoresFeatureDateTimeInstantInField SIP_MONKEYPATCH_COMPAT_NAME( ProviderStoresFeatureDateTimeInstantInField ),
2559 StoresFeatureDateTimeStartAndEndInSeparateFields SIP_MONKEYPATCH_COMPAT_NAME( ProviderStoresFeatureDateTimeStartAndEndInSeparateFields ),
2560 };
2561 Q_ENUM( VectorDataProviderTemporalMode )
2562
2563
2569 {
2570 FixedTemporalRange SIP_MONKEYPATCH_COMPAT_NAME( ModeFixedTemporalRange ) = 0,
2571 TemporalRangeFromDataProvider SIP_MONKEYPATCH_COMPAT_NAME( ModeTemporalRangeFromDataProvider ) = 1,
2572 RedrawLayerOnly SIP_MONKEYPATCH_COMPAT_NAME( ModeRedrawLayerOnly ) = 2,
2573 FixedRangePerBand = 3,
2574 RepresentsTemporalValues = 4,
2575 FixedDateTime = 5,
2576 };
2577 Q_ENUM( RasterTemporalMode )
2578
2579
2585 {
2586 MatchUsingWholeRange,
2587 MatchExactUsingStartOfRange,
2588 MatchExactUsingEndOfRange,
2589 FindClosestMatchToStartOfRange,
2590 FindClosestMatchToEndOfRange
2591 };
2592 Q_ENUM( TemporalIntervalMatchMethod )
2593
2594
2600 {
2601 RequestedTimesMustExactlyMatchAllAvailableTemporalRanges = 1 << 0,
2602 };
2603 Q_ENUM( RasterTemporalCapabilityFlag )
2604
2605
2612
2619 {
2620 Forward SIP_MONKEYPATCH_COMPAT_NAME( ForwardTransform ),
2621 Reverse SIP_MONKEYPATCH_COMPAT_NAME( ReverseTransform )
2622 };
2623 Q_ENUM( TransformDirection )
2624
2625
2631 {
2632 BallparkTransformsAreAppropriate = 1 << 0,
2633 IgnoreImpossibleTransformations = 1 << 1,
2634 };
2635 Q_ENUM( CoordinateTransformationFlag )
2636
2637
2644
2651 {
2652 Antialiasing = 0x01,
2653 DrawEditingInfo = 0x02,
2654 ForceVectorOutput = 0x04,
2655 UseAdvancedEffects = 0x08,
2656 DrawLabeling = 0x10,
2657 UseRenderingOptimization = 0x20,
2658 DrawSelection = 0x40,
2659 DrawSymbolBounds = 0x80,
2660 RenderMapTile = 0x100,
2661 RenderPartialOutput = 0x200,
2662 RenderPreviewJob = 0x400,
2663 RenderBlocking = 0x800,
2664 LosslessImageRendering = 0x1000,
2665 Render3DMap = 0x2000,
2666 HighQualityImageTransforms = 0x4000,
2667 SkipSymbolRendering = 0x8000,
2668 ForceRasterMasks = 0x10000,
2669 RecordProfile = 0x20000,
2670 AlwaysUseGlobalMasks = 0x40000,
2671 };
2674 Q_ENUM( MapSettingsFlag )
2675 Q_FLAG( MapSettingsFlags )
2676
2677
2683 {
2684 DrawEditingInfo = 0x01,
2685 ForceVectorOutput = 0x02,
2686 UseAdvancedEffects = 0x04,
2687 UseRenderingOptimization = 0x08,
2688 DrawSelection = 0x10,
2689 DrawSymbolBounds = 0x20,
2690 RenderMapTile = 0x40,
2691 Antialiasing = 0x80,
2692 RenderPartialOutput = 0x100,
2693 RenderPreviewJob = 0x200,
2694 RenderBlocking = 0x400,
2695 RenderSymbolPreview = 0x800,
2696 LosslessImageRendering = 0x1000,
2697 ApplyScalingWorkaroundForTextRendering = 0x2000,
2698 Render3DMap = 0x4000,
2699 ApplyClipAfterReprojection = 0x8000,
2700 RenderingSubSymbol = 0x10000,
2701 HighQualityImageTransforms = 0x20000,
2702 SkipSymbolRendering = 0x40000,
2703 RecordProfile = 0x80000,
2704 AlwaysUseGlobalMasks = 0x100000,
2705 DisableSymbolClippingToExtent = 0x200000,
2706 };
2709 Q_ENUM( RenderContextFlag )
2710 Q_FLAG( RenderContextFlags )
2711
2712
2717 enum class MapLayerRendererFlag : int SIP_ENUM_BASETYPE( IntFlag )
2718 {
2719 RenderPartialOutputs = 1 << 0,
2720 RenderPartialOutputOverPreviousCachedImage = 1 << 1,
2721 AffectsLabeling = 1 << 2,
2722 };
2723 Q_ENUM( MapLayerRendererFlag )
2724
2725
2731 Q_FLAG( MapLayerRendererFlags )
2732
2733 // refs for below dox: https://github.com/qgis/QGIS/pull/1286#issuecomment-39806854
2734 // https://github.com/qgis/QGIS/pull/8573#issuecomment-445585826
2735
2741 {
2742 AlwaysOutlines SIP_MONKEYPATCH_COMPAT_NAME( TextFormatAlwaysOutlines ),
2743 AlwaysText SIP_MONKEYPATCH_COMPAT_NAME( TextFormatAlwaysText ),
2744 PreferText,
2745 };
2746 Q_ENUM( TextRenderFormat )
2747
2748
2756 {
2757 UseAllLabels = 1 << 1,
2758 UsePartialCandidates = 1 << 2,
2759 // TODO QGIS 4.0: remove
2760 RenderOutlineLabels = 1 << 3,
2761 DrawLabelRectOnly = 1 << 4,
2762 DrawCandidates = 1 << 5,
2763 DrawUnplacedLabels = 1 << 6,
2764 CollectUnplacedLabels = 1 << 7,
2765 DrawLabelMetrics = 1 << 8,
2766 };
2767 Q_ENUM( LabelingFlag )
2768
2769
2777 Q_FLAG( LabelingFlags )
2778
2787 {
2788 Version1 SIP_MONKEYPATCH_COMPAT_NAME( PlacementEngineVersion1 ),
2789 Version2 SIP_MONKEYPATCH_COMPAT_NAME( PlacementEngineVersion2 ),
2790 };
2791 Q_ENUM( LabelPlacementEngineVersion )
2792
2793
2801 {
2802 Horizontal SIP_MONKEYPATCH_COMPAT_NAME( HorizontalOrientation ),
2803 Vertical SIP_MONKEYPATCH_COMPAT_NAME( VerticalOrientation ),
2804 RotationBased SIP_MONKEYPATCH_COMPAT_NAME( RotationBasedOrientation ),
2805 };
2806 Q_ENUM( TextOrientation )
2807
2808
2816 {
2817 Rectangle SIP_MONKEYPATCH_COMPAT_NAME( Rect ),
2818 Point,
2819 Labeling SIP_MONKEYPATCH_COMPAT_NAME( Label ),
2820 RectangleCapHeightBased,
2821 RectangleAscentBased,
2822 };
2823 Q_ENUM( TextLayoutMode )
2824
2825
2833 {
2834 Text = 1 << 0,
2835 Buffer = 1 << 1,
2836 Background = 1 << 2,
2837 Shadow = 1 << 3,
2838 };
2839 Q_ENUM( TextComponent )
2840
2841
2846 Q_DECLARE_FLAGS( TextComponents, TextComponent )
2847 Q_FLAG( TextComponents )
2848
2857 {
2858 Left SIP_MONKEYPATCH_COMPAT_NAME( AlignLeft ),
2859 Center SIP_MONKEYPATCH_COMPAT_NAME( AlignCenter ),
2860 Right SIP_MONKEYPATCH_COMPAT_NAME( AlignRight ),
2861 Justify SIP_MONKEYPATCH_COMPAT_NAME( AlignJustify ),
2862 };
2863 Q_ENUM( TextHorizontalAlignment )
2864
2865
2876 {
2877 Top SIP_MONKEYPATCH_COMPAT_NAME( AlignTop ),
2878 VerticalCenter SIP_MONKEYPATCH_COMPAT_NAME( AlignVCenter ),
2879 Bottom SIP_MONKEYPATCH_COMPAT_NAME( AlignBottom ),
2880 };
2881 Q_ENUM( TextVerticalAlignment )
2882
2883
2892 {
2893 Normal,
2894 SuperScript,
2895 SubScript,
2896 };
2897 Q_ENUM( TextCharacterVerticalAlignment )
2898
2899
2907 {
2908 Distance = 0,
2909 SnapToGrid = 1,
2910 Visvalingam = 2,
2911 SnappedToGridGlobal = 3,
2912 };
2913 Q_ENUM( VectorSimplificationAlgorithm )
2914
2915
2923 {
2924 NoSimplification = 0,
2925 GeometrySimplification = 1,
2926 AntialiasingSimplification = 2,
2927 FullSimplification = 3,
2928 };
2929 Q_ENUM( VectorRenderingSimplificationFlag )
2930
2931
2940
2947 {
2948 Generic,
2949 ShadowOffset,
2950 BlurSize,
2951 GlowSpread,
2952 };
2953 Q_ENUM( RenderSubcomponentProperty )
2954
2955
2960 {
2961 Segment SIP_MONKEYPATCH_COMPAT_NAME( SegmentVertex ) = 1,
2962 Curve SIP_MONKEYPATCH_COMPAT_NAME( CurveVertex ) = 2,
2963 };
2964 Q_ENUM( VertexType )
2965
2966
2974 {
2975 Square,
2976 Diamond,
2977 Pentagon,
2978 Hexagon,
2979 Triangle,
2980 EquilateralTriangle,
2981 Star,
2982 Arrow,
2983 Circle,
2984 Cross,
2985 CrossFill,
2986 Cross2,
2987 Line,
2988 ArrowHead,
2989 ArrowHeadFilled,
2990 SemiCircle,
2991 ThirdCircle,
2992 QuarterCircle,
2993 QuarterSquare,
2994 HalfSquare,
2995 DiagonalHalfSquare,
2996 RightHalfTriangle,
2997 LeftHalfTriangle,
2998 Octagon,
2999 SquareWithCorners,
3000 AsteriskFill,
3001 HalfArc,
3002 ThirdArc,
3003 QuarterArc,
3004 ParallelogramRight,
3005 ParallelogramLeft,
3006 Trapezoid,
3007 Shield,
3008 DiamondStar,
3009 Heart,
3010 Decagon,
3011 RoundedSquare,
3012 };
3013 Q_ENUM( MarkerShape )
3014
3015
3023 {
3024 Interval = 1 << 0,
3025 Vertex = 1 << 1,
3026 LastVertex = 1 << 2,
3027 FirstVertex = 1 << 3,
3028 CentralPoint = 1 << 4,
3029 CurvePoint = 1 << 5,
3030 SegmentCenter = 1 << 6,
3031 InnerVertices = 1 << 7,
3032 };
3033 Q_ENUM( MarkerLinePlacement )
3035 Q_FLAG( MarkerLinePlacements )
3036
3043 {
3044 IntervalCartesian2D = 1 << 0,
3045 IntervalZ = 1 << 1,
3046 IntervalM = 1 << 2,
3047 Vertex = 1 << 3,
3048 };
3049 Q_ENUM( LinearReferencingPlacement )
3050
3051
3057 {
3058 CartesianDistance2D,
3059 Z,
3060 M,
3061 };
3062 Q_ENUM( LinearReferencingLabelSource )
3063
3064
3072 {
3073 SimpleTwoColor,
3074 ColorRamp,
3075 };
3076 Q_ENUM( GradientColorSource )
3077
3078
3086 {
3087 Linear,
3088 Radial,
3089 Conical,
3090 };
3091 Q_ENUM( GradientType )
3092
3093
3101 {
3102 Feature,
3103 Viewport,
3104 };
3105 Q_ENUM( SymbolCoordinateReference )
3106
3107
3116 {
3117 Pad,
3118 Reflect,
3119 Repeat,
3120 };
3121 Q_ENUM( GradientSpread )
3122
3123
3131 {
3132 Absolute SIP_MONKEYPATCH_COMPAT_NAME( AbsoluteCount ),
3133 DensityBased SIP_MONKEYPATCH_COMPAT_NAME( DensityBasedCount ),
3134 };
3135 Q_ENUM( PointCountMethod )
3136
3137
3142 enum class MarkerClipMode : int
3143 {
3144 NoClipping,
3145 Shape,
3146 CentroidWithin,
3147 CompletelyWithin,
3148 };
3149 Q_ENUM( MarkerClipMode )
3150
3151
3156 enum class LineClipMode : int
3157 {
3158 ClipPainterOnly,
3159 ClipToIntersection,
3160 NoClipping,
3161 };
3162 Q_ENUM( LineClipMode )
3163
3164
3170 {
3171 NoRule,
3172 FullDash,
3173 HalfDash,
3174 FullGap,
3175 HalfGap,
3176 };
3177 Q_ENUM( DashPatternLineEndingRule )
3178
3179
3185 {
3186 ScaleBothDashAndGap,
3187 ScaleDashOnly,
3188 ScaleGapOnly,
3189 };
3190 Q_ENUM( DashPatternSizeAdjustment )
3191
3192
3200 {
3201 Color SIP_MONKEYPATCH_COMPAT_NAME( GraduatedColor ),
3202 Size SIP_MONKEYPATCH_COMPAT_NAME( GraduatedSize ),
3203 };
3204 Q_ENUM( GraduatedMethod )
3205
3206
3212 {
3213 NoLabels,
3214 EveryLabel,
3215 FirstLabel,
3216 LastLabel,
3217 FirstAndLastLabels,
3218 };
3219 Q_ENUM( PlotAxisSuffixPlacement )
3220
3221
3225 enum class DpiMode
3226 {
3227 All = 7,
3228 Off = 0,
3229 QGIS = 1,
3230 UMN = 2,
3231 GeoServer = 4,
3232 };
3233 Q_ENUM( DpiMode )
3234
3235
3240 {
3241 Undefined = 0,
3242 StandardDpi = 1,
3243 HighDpi = 2,
3244 };
3245 Q_ENUM( TilePixelRatio )
3246
3247 // NOTE -- the hardcoded numbers here must match QFont::Capitalization!
3248
3249
3257 {
3258 MixedCase = 0,
3259 AllUppercase = 1,
3260 AllLowercase = 2,
3261 ForceFirstLetterToCapital = 4,
3262 SmallCaps = 5,
3263 TitleCase = 1004,
3264 UpperCamelCase = 1005,
3265 AllSmallCaps = 1006,
3266 };
3267 Q_ENUM( Capitalization )
3268
3269
3274 enum class TextRendererFlag : int SIP_ENUM_BASETYPE( IntFlag )
3275 {
3276 WrapLines = 1 << 0,
3277 };
3278 Q_ENUM( TextRendererFlag )
3280 Q_FLAG( TextRendererFlags )
3281
3288 {
3289 MapBox,
3290 Esri,
3291 };
3293
3300 {
3301 Clockwise,
3302 CounterClockwise,
3303 NoOrientation,
3304 };
3305 Q_ENUM( AngularDirection )
3306
3307
3312 enum class RendererUsage : int
3313 {
3314 View,
3315 Export,
3316 Unknown,
3317 };
3318 Q_ENUM( RendererUsage )
3319
3320
3325 enum class MapCanvasFlag : int SIP_ENUM_BASETYPE( IntFlag )
3326 {
3327 ShowMainAnnotationLayer = 1 << 0,
3328 };
3329 Q_ENUM( MapCanvasFlag )
3330
3331
3336 Q_DECLARE_FLAGS( MapCanvasFlags, MapCanvasFlag )
3337 Q_FLAG( MapCanvasFlags )
3338
3344 enum class ViewSyncModeFlag : int SIP_ENUM_BASETYPE( IntFlag )
3345 {
3346 Sync3DTo2D = 1 << 0,
3347 Sync2DTo3D = 1 << 1,
3348 };
3349 Q_ENUM( ViewSyncModeFlag )
3351
3358 {
3359 Always,
3360 WhenOutsideVisibleExtent,
3361 Never,
3362 };
3363 Q_ENUM( MapRecenteringMode )
3364
3365
3370 enum class HistoryProviderBackend : int SIP_ENUM_BASETYPE( IntFlag )
3371 {
3372 LocalProfile = 1 << 0,
3373// Project = 1 << 1, //!< QGIS Project (not yet implemented)
3374 };
3375 Q_ENUM( HistoryProviderBackend )
3377 Q_FLAG( HistoryProviderBackends )
3378
3384 enum class QueryStorageBackend : int
3385 {
3386 LocalProfile,
3387 CurrentProject,
3388 };
3389 Q_ENUM( QueryStorageBackend )
3390
3391
3399 {
3400 MapLayer SIP_MONKEYPATCH_COMPAT_NAME( TypeMapLayer ) = -2,
3401 VectorAnyGeometry SIP_MONKEYPATCH_COMPAT_NAME( TypeVectorAnyGeometry ) = -1,
3402 VectorPoint SIP_MONKEYPATCH_COMPAT_NAME( TypeVectorPoint ) = 0,
3403 VectorLine SIP_MONKEYPATCH_COMPAT_NAME( TypeVectorLine ) = 1,
3404 VectorPolygon SIP_MONKEYPATCH_COMPAT_NAME( TypeVectorPolygon ) = 2,
3405 Raster SIP_MONKEYPATCH_COMPAT_NAME( TypeRaster ) = 3,
3406 File SIP_MONKEYPATCH_COMPAT_NAME( TypeFile ) = 4,
3407 Vector SIP_MONKEYPATCH_COMPAT_NAME( TypeVector ) = 5,
3408 Mesh SIP_MONKEYPATCH_COMPAT_NAME( TypeMesh ) = 6,
3409 Plugin SIP_MONKEYPATCH_COMPAT_NAME( TypePlugin ) = 7,
3410 PointCloud SIP_MONKEYPATCH_COMPAT_NAME( TypePointCloud ) = 8,
3411 Annotation SIP_MONKEYPATCH_COMPAT_NAME( TypeAnnotation ) = 9,
3412 VectorTile SIP_MONKEYPATCH_COMPAT_NAME( TypeVectorTile ) = 10
3413 };
3414 Q_ENUM( ProcessingSourceType )
3415
3416
3417
3425 {
3426 DeemphasiseSearchResults SIP_MONKEYPATCH_COMPAT_NAME( FlagDeemphasiseSearchResults ) = 1 << 1,
3427 CompatibleWithVirtualRaster SIP_MONKEYPATCH_COMPAT_NAME( FlagCompatibleWithVirtualRaster ) = 1 << 2,
3428 };
3430
3439 Q_FLAG( ProcessingProviderFlags )
3440
3441
3449 {
3450 HideFromToolbox SIP_MONKEYPATCH_COMPAT_NAME( FlagHideFromToolbox ) = 1 << 1,
3451 HideFromModeler SIP_MONKEYPATCH_COMPAT_NAME( FlagHideFromModeler ) = 1 << 2,
3452 SupportsBatch SIP_MONKEYPATCH_COMPAT_NAME( FlagSupportsBatch ) = 1 << 3,
3453 CanCancel SIP_MONKEYPATCH_COMPAT_NAME( FlagCanCancel ) = 1 << 4,
3454 RequiresMatchingCrs SIP_MONKEYPATCH_COMPAT_NAME( FlagRequiresMatchingCrs ) = 1 << 5,
3455 NoThreading SIP_MONKEYPATCH_COMPAT_NAME( FlagNoThreading ) = 1 << 6,
3456 DisplayNameIsLiteral SIP_MONKEYPATCH_COMPAT_NAME( FlagDisplayNameIsLiteral ) = 1 << 7,
3457 SupportsInPlaceEdits SIP_MONKEYPATCH_COMPAT_NAME( FlagSupportsInPlaceEdits ) = 1 << 8,
3458 KnownIssues SIP_MONKEYPATCH_COMPAT_NAME( FlagKnownIssues ) = 1 << 9,
3459 CustomException SIP_MONKEYPATCH_COMPAT_NAME( FlagCustomException ) = 1 << 10,
3460 PruneModelBranchesBasedOnAlgorithmResults SIP_MONKEYPATCH_COMPAT_NAME( FlagPruneModelBranchesBasedOnAlgorithmResults ) = 1 << 11,
3461 SkipGenericModelLogging SIP_MONKEYPATCH_COMPAT_NAME( FlagSkipGenericModelLogging ) = 1 << 12,
3462 NotAvailableInStandaloneTool SIP_MONKEYPATCH_COMPAT_NAME( FlagNotAvailableInStandaloneTool ) = 1 << 13,
3463 RequiresProject SIP_MONKEYPATCH_COMPAT_NAME( FlagRequiresProject ) = 1 << 14,
3464 SecurityRisk = 1 << 15,
3465 Deprecated SIP_MONKEYPATCH_COMPAT_NAME( FlagDeprecated ) = HideFromToolbox | HideFromModeler,
3466 };
3468
3477 Q_FLAG( ProcessingAlgorithmFlags )
3478
3479
3485 {
3486 RegeneratesPrimaryKey = 1 << 0,
3487 RegeneratesPrimaryKeyInSomeScenarios = 1 << 1,
3488 };
3489 Q_ENUM( ProcessingAlgorithmDocumentationFlag )
3490
3491
3498
3508 {
3509 NotAvailable,
3510 Available,
3511 };
3512 Q_ENUM( ProcessingPropertyAvailability )
3513
3514
3522 {
3523 DefaultLevel = 0,
3524 Verbose,
3525 ModelDebug,
3526 };
3527 Q_ENUM( ProcessingLogLevel )
3528
3529
3537 {
3538 OverrideDefaultGeometryCheck SIP_MONKEYPATCH_COMPAT_NAME( FlagOverrideDefaultGeometryCheck ) = 1 << 0,
3539 CreateIndividualOutputPerInputFeature SIP_MONKEYPATCH_COMPAT_NAME( FlagCreateIndividualOutputPerInputFeature ) = 1 << 1,
3540 };
3541 Q_ENUM( ProcessingFeatureSourceDefinitionFlag )
3542
3543
3552
3561 {
3562 SkipGeometryValidityChecks SIP_MONKEYPATCH_COMPAT_NAME( FlagSkipGeometryValidityChecks ) = 1 << 1,
3563 };
3564 Q_ENUM( ProcessingFeatureSourceFlag )
3565
3566
3575
3587 {
3588 ExposeToModeler = 1
3589 };
3590 Q_ENUM( ProcessingParameterTypeFlag )
3591
3592
3604
3613 {
3614 Advanced SIP_MONKEYPATCH_COMPAT_NAME( FlagAdvanced ) = 1 << 1,
3615 Hidden SIP_MONKEYPATCH_COMPAT_NAME( FlagHidden ) = 1 << 2,
3616 Optional SIP_MONKEYPATCH_COMPAT_NAME( FlagOptional ) = 1 << 3,
3617 IsModelOutput SIP_MONKEYPATCH_COMPAT_NAME( FlagIsModelOutput ) = 1 << 4,
3618 };
3619 Q_ENUM( ProcessingParameterFlag )
3620
3621
3629 Q_FLAG( ProcessingParameterFlags )
3630
3639 {
3640 File = 0,
3641 Folder,
3642 };
3643 Q_ENUM( ProcessingFileParameterBehavior )
3644
3645
3653 {
3654 Integer,
3655 Double,
3656 };
3657 Q_ENUM( ProcessingNumberParameterType )
3658
3659
3667 {
3668 Any = -1,
3669 Numeric = 0,
3670 String = 1,
3671 DateTime = 2,
3672 Binary = 3,
3673 Boolean = 4,
3674 };
3675 Q_ENUM( ProcessingFieldParameterDataType )
3676
3677
3685 {
3686 DateTime,
3687 Date,
3688 Time,
3689 };
3690 Q_ENUM( ProcessingDateTimeParameterDataType )
3691
3692
3698 {
3699 ModelParameter,
3700 ChildOutput,
3701 StaticValue,
3702 Expression,
3703 ExpressionText,
3704 ModelOutput,
3705 };
3706 Q_ENUM( ProcessingModelChildParameterSource )
3707
3708
3714 {
3715 NotExecuted,
3716 Success,
3717 Failed,
3718 };
3719 Q_ENUM( ProcessingModelChildAlgorithmExecutionStatus )
3720
3721
3729 {
3730 Vertices,
3731 StructureLines,
3732 BreakLines
3733 };
3734 Q_ENUM( ProcessingTinInputLayerType )
3735
3736
3742 {
3743 Wkt SIP_MONKEYPATCH_COMPAT_NAME( FormatWkt ),
3744 Proj SIP_MONKEYPATCH_COMPAT_NAME( FormatProj ),
3745 };
3746 Q_ENUM( CrsDefinitionFormat )
3747
3748
3756 enum class FieldDomainSplitPolicy : int
3757 {
3758 DefaultValue,
3759 Duplicate,
3760 GeometryRatio,
3761 UnsetField,
3762 };
3763 Q_ENUM( FieldDomainSplitPolicy )
3764
3765
3773 enum class FieldDomainMergePolicy : int
3774 {
3775 DefaultValue,
3776 Sum,
3777 GeometryWeighted,
3778 UnsetField,
3779 LargestGeometry,
3780 MinimumValue,
3781 MaximumValue,
3782 SetToNull,
3783 };
3784 Q_ENUM( FieldDomainMergePolicy )
3785
3786
3793 enum class FieldDuplicatePolicy : int
3794 {
3795 DefaultValue,
3796 Duplicate,
3797 UnsetField,
3798 };
3799 Q_ENUM( FieldDuplicatePolicy )
3800
3801
3806 enum class FieldDomainType : int
3807 {
3808 Coded,
3809 Range,
3810 Glob,
3811 };
3812 Q_ENUM( FieldDomainType )
3813
3814
3819 enum class TransactionMode : int
3820 {
3821 Disabled = 0,
3822 AutomaticGroups = 1,
3823 BufferedGroups = 2,
3824 };
3825 Q_ENUM( TransactionMode )
3826
3827
3832 enum class AltitudeClamping : int
3833 {
3834 Absolute,
3835 Relative,
3836 Terrain,
3837 };
3838 Q_ENUM( AltitudeClamping )
3839
3840
3845 enum class AltitudeBinding : int
3846 {
3847 Vertex,
3848 Centroid,
3849 };
3850 Q_ENUM( AltitudeBinding )
3851
3852
3857 enum class RangeLimits : int
3858 {
3859 IncludeBoth = 0,
3860 IncludeLowerExcludeUpper,
3861 ExcludeLowerIncludeUpper,
3862 ExcludeBoth,
3863 };
3864 Q_ENUM( RangeLimits )
3865
3866
3871 enum class RasterElevationMode : int
3872 {
3873 FixedElevationRange = 0,
3874 RepresentsElevationSurface = 1,
3875 FixedRangePerBand = 2,
3876 DynamicRangePerBand = 3,
3877 };
3878 Q_ENUM( RasterElevationMode )
3879
3880
3885 enum class MeshElevationMode : int
3886 {
3887 FixedElevationRange = 0,
3888 FromVertices = 1,
3889 FixedRangePerGroup = 2,
3890 };
3891 Q_ENUM( MeshElevationMode )
3892
3893
3899 {
3900 NoConstraint,
3901 Perpendicular,
3902 Parallel
3903 };
3904 Q_ENUM( BetweenLineConstraint )
3905
3906
3911 enum class LineExtensionSide : int
3912 {
3913 BeforeVertex,
3914 AfterVertex,
3915 NoVertex,
3916 };
3917 Q_ENUM( LineExtensionSide )
3918
3919
3920
3924 enum class CadConstraintType : int
3925 {
3926 Generic,
3927 Angle,
3928 Distance,
3929 XCoordinate,
3930 YCoordinate,
3931 ZValue,
3932 MValue,
3933 };
3934 Q_ENUM( CadConstraintType )
3935
3936
3937
3942 enum class ProjectFlag : int SIP_ENUM_BASETYPE( IntFlag )
3943 {
3944 EvaluateDefaultValuesOnProviderSide = 1 << 0,
3945 TrustStoredLayerStatistics = 1 << 1,
3946 RememberLayerEditStatusBetweenSessions = 1 << 2,
3947 RememberAttributeTableWindowsBetweenSessions = 1 << 3,
3948 };
3949 Q_ENUM( ProjectFlag )
3950 Q_DECLARE_FLAGS( ProjectFlags, ProjectFlag )
3951 Q_FLAG( ProjectFlags )
3952
3958 enum class PlotToolFlag : int SIP_ENUM_BASETYPE( IntFlag )
3959 {
3960 ShowContextMenu = 1 << 0,
3961 };
3962 Q_ENUM( PlotToolFlag )
3963 Q_DECLARE_FLAGS( PlotToolFlags, PlotToolFlag )
3964 Q_FLAG( PlotToolFlags )
3965
3966
3974 enum class Point3DShape : int
3975 {
3976 Cylinder,
3977 Sphere,
3978 Cone,
3979 Cube,
3980 Torus,
3981 Plane,
3982 ExtrudedText,
3983 Model,
3984 Billboard,
3985 };
3986 Q_ENUM( Point3DShape )
3987
3988
3993 enum class LightSourceType : int
3994 {
3995 Point,
3996 Directional,
3997 };
3998 Q_ENUM( LightSourceType )
3999
4000
4005 enum class NavigationMode : int
4006 {
4007 TerrainBased,
4008 Walk,
4009 GlobeTerrainBased
4010 };
4011 Q_ENUM( NavigationMode )
4012
4013
4018 enum class SceneMode : int
4019 {
4020 Local,
4021 Globe
4022 };
4023 Q_ENUM( SceneMode )
4024
4025
4030 enum class VerticalAxisInversion : int
4031 {
4032 Never,
4033 WhenDragging,
4034 Always,
4035 };
4036 Q_ENUM( VerticalAxisInversion )
4037
4038
4044 {
4045 Line,
4046 FillBelow,
4047 FillAbove,
4048 };
4050
4056 enum class VectorProfileType : int
4057 {
4058 IndividualFeatures,
4059 ContinuousSurface,
4060 };
4062
4068 enum class ProfileGeneratorFlag : int SIP_ENUM_BASETYPE( IntFlag )
4069 {
4070 RespectsMaximumErrorMapUnit = 1 << 0,
4071 RespectsDistanceRange = 1 << 1,
4072 RespectsElevationRange = 1 << 2,
4073 };
4074 Q_ENUM( ProfileGeneratorFlag )
4076 Q_FLAG( ProfileGeneratorFlags )
4077
4083 enum class ProfileExportType : int
4084 {
4085 Features3D,
4086 Profile2D,
4087 DistanceVsElevationTable,
4088 };
4090
4097 {
4098 Square,
4099 Circle,
4100 };
4101 Q_ENUM( PointCloudSymbol )
4102
4103
4109 {
4110 Default,
4111 BottomToTop,
4112 TopToBottom,
4113 };
4114 Q_ENUM( PointCloudDrawOrder )
4115
4116
4124 {
4125 AllowIntersections,
4126 AvoidIntersectionsCurrentLayer,
4127 AvoidIntersectionsLayers,
4128 };
4129 Q_ENUM( AvoidIntersectionsMode )
4130
4131
4139 {
4140 Qgz,
4141 Qgs,
4142 };
4143 Q_ENUM( ProjectFileFormat )
4144
4145
4153 {
4154 DontResolveLayers SIP_MONKEYPATCH_COMPAT_NAME( FlagDontResolveLayers ) = 1 << 0,
4155 DontLoadLayouts SIP_MONKEYPATCH_COMPAT_NAME( FlagDontLoadLayouts ) = 1 << 1,
4156 TrustLayerMetadata SIP_MONKEYPATCH_COMPAT_NAME( FlagTrustLayerMetadata ) = 1 << 2,
4157 DontStoreOriginalStyles SIP_MONKEYPATCH_COMPAT_NAME( FlagDontStoreOriginalStyles ) = 1 << 3,
4158 DontLoad3DViews SIP_MONKEYPATCH_COMPAT_NAME( FlagDontLoad3DViews ) = 1 << 4,
4159 DontLoadProjectStyles = 1 << 5,
4160 ForceReadOnlyLayers = 1 << 6,
4161 DontUpgradeAnnotations = 1 << 7,
4162 };
4163 Q_ENUM( ProjectReadFlag )
4164
4165
4173 Q_FLAG( ProjectReadFlags )
4174
4183 enum class ProjectCapability : int SIP_ENUM_BASETYPE( IntFlag )
4184 {
4185 ProjectStyles = 1 << 0,
4186 };
4187 Q_ENUM( ProjectCapability )
4188
4189
4195 Q_FLAG( ProjectCapabilities )
4196
4203 {
4204 Vector,
4205 Raster,
4206 RasterDem,
4207 GeoJson,
4208 Image,
4209 Video,
4210 Unknown,
4211 };
4212 Q_ENUM( MapBoxGlStyleSourceType )
4213
4214
4222 {
4223 FeatureServer SIP_MONKEYPATCH_COMPAT_NAME( FeatureService ),
4224 MapServer SIP_MONKEYPATCH_COMPAT_NAME( MapService ),
4225 ImageServer SIP_MONKEYPATCH_COMPAT_NAME( ImageService ),
4226 GlobeServer,
4227 GPServer,
4228 GeocodeServer,
4229 Unknown,
4230 };
4231 Q_ENUM( ArcGisRestServiceType )
4232
4233
4241 {
4242 Normal,
4243 Generated,
4244 };
4245 Q_ENUM( RelationshipType )
4246
4247
4255 {
4256 Association,
4257 Composition,
4258 };
4259 Q_ENUM( RelationshipStrength )
4260
4261
4267 {
4268 OneToOne,
4269 OneToMany,
4270 ManyToOne,
4271 ManyToMany,
4272 };
4273 Q_ENUM( RelationshipCardinality )
4274
4275
4280 enum class RelationshipCapability : int SIP_ENUM_BASETYPE( IntFlag )
4281 {
4282 MultipleFieldKeys = 1 << 0,
4283 ForwardPathLabel = 1 << 1,
4284 BackwardPathLabel = 1 << 2,
4285 };
4286 Q_ENUM( RelationshipCapability )
4287
4288
4294 Q_FLAG( RelationshipCapabilities )
4295
4301 enum class CoordinateDisplayType : int
4302 {
4303 MapCrs,
4304 MapGeographic,
4305 CustomCrs,
4306 };
4307 Q_ENUM( CoordinateDisplayType )
4308
4309
4314 enum class SettingsOrigin : int
4315 {
4316 Any,
4317 Global,
4318 Local,
4319 };
4320 Q_ENUM( SettingsOrigin )
4321
4322
4327 enum class ScriptLanguage : int
4328 {
4329 Css,
4330 QgisExpression,
4331 Html,
4332 JavaScript,
4333 Json,
4334 Python,
4335 R,
4336 Sql,
4337 Batch,
4338 Bash,
4339 Unknown,
4340 };
4341 Q_ENUM( ScriptLanguage )
4342
4343
4351 {
4352 Reformat = 1 << 0,
4353 CheckSyntax = 1 << 1,
4354 ToggleComment = 1 << 2,
4355 };
4356 Q_ENUM( ScriptLanguageCapability )
4357
4358
4365
4372 {
4373 AboveInsertionPoint,
4374 TopOfTree,
4375 OptimalInInsertionGroup,
4376 };
4377 Q_ENUM( LayerTreeInsertionMethod )
4378
4379
4384 enum class LayerTreeFilterFlag : int SIP_ENUM_BASETYPE( IntFlag )
4385 {
4386 SkipVisibilityCheck = 1 << 0,
4387 };
4388 Q_ENUM( LayerTreeFilterFlag )
4389
4390
4396 Q_FLAG( LayerTreeFilterFlags )
4397
4406 {
4407 Undefined,
4408 Hidden,
4409 Title,
4410 Group,
4411 Subgroup,
4412 Symbol,
4413 SymbolLabel,
4414 };
4415 // !!! WARNING: If adding new values to this enum, make sure you update QgsLegendSettings constructor accordingly!!
4416 Q_ENUM( LegendComponent )
4417
4418
4425 enum class LegendJsonRenderFlag : int SIP_ENUM_BASETYPE( IntFlag )
4426 {
4427 ShowRuleDetails = 1 << 0,
4428 };
4429 Q_ENUM( LegendJsonRenderFlag )
4431 Q_FLAG( LegendJsonRenderFlags )
4432
4440 enum class ActionType : int
4441 {
4442 Invalid,
4443 MapLayerAction,
4444 AttributeAction
4445 };
4446 Q_ENUM( ActionType )
4447
4448
4455 enum class MapLayerActionTarget : int SIP_ENUM_BASETYPE( IntFlag )
4456 {
4457 Layer = 1 << 0,
4458 SingleFeature = 1 << 1,
4459 MultipleFeatures = 1 << 2,
4460 AllActions = Layer | SingleFeature | MultipleFeatures
4461 };
4462 Q_ENUM( MapLayerActionTarget )
4463
4464
4472 Q_FLAG( MapLayerActionTargets )
4473
4481 enum class MapLayerActionFlag : int SIP_ENUM_BASETYPE( IntFlag )
4482 {
4483 EnabledOnlyWhenEditable = 1 << 1,
4484 EnableOnlyWhenHasGeometry = 1 << 2,
4485 };
4486 Q_ENUM( MapLayerActionFlag )
4487
4488
4496 Q_FLAG( MapLayerActionFlags )
4497
4506 {
4507 Generic,
4508 GenericPython,
4509 Mac,
4510 Windows,
4511 Unix,
4512 OpenUrl,
4513 SubmitUrlEncoded,
4514 SubmitUrlMultipart,
4515 };
4516 Q_ENUM( AttributeActionType )
4517
4518
4524 {
4525 Created,
4526 Published,
4527 Revised,
4528 Superseded,
4529 };
4530 Q_ENUM( MetadataDateType )
4531
4532
4543 {
4544 Undefined SIP_MONKEYPATCH_COMPAT_NAME( UndefinedColorInterpretation ) = 0,
4545 GrayIndex = 1,
4546 PaletteIndex = 2,
4547 RedBand = 3,
4548 GreenBand = 4,
4549 BlueBand = 5,
4550 AlphaBand = 6,
4551 HueBand = 7,
4552 SaturationBand = 8,
4553 LightnessBand = 9,
4554 CyanBand = 10,
4555 MagentaBand = 11,
4556 YellowBand = 12,
4557 BlackBand = 13,
4558 YCbCr_YBand = 14,
4559 YCbCr_CbBand = 15,
4560 YCbCr_CrBand = 16,
4561 ContinuousPalette = 17,
4562
4563 // Note: values between PanBand and SAR_P_Band match additions done in
4564 // GDAL 3.10, except that the numeric values of the constant don't match GDAL ones
4565
4566 PanBand = 18,
4567 CoastalBand = 19,
4568 RedEdgeBand = 20,
4569 NIRBand = 21,
4570 SWIRBand = 22,
4571 MWIRBand = 23,
4572 LWIRBand = 24,
4573 TIRBand = 25,
4574 OtherIRBand = 26,
4575 SAR_Ka_Band = 27,
4576 SAR_K_Band = 28,
4577 SAR_Ku_Band = 30,
4578 SAR_X_Band = 31,
4579 SAR_C_Band = 32,
4580 SAR_S_Band = 33,
4581 SAR_L_Band = 34,
4582 SAR_P_Band = 35,
4583 };
4584 Q_ENUM( RasterColorInterpretation )
4585
4586
4594 {
4595 GrayOrUndefined,
4596 Palette,
4597 MultiBand SIP_MONKEYPATCH_COMPAT_NAME( Multiband ),
4598 SingleBandColorData SIP_MONKEYPATCH_COMPAT_NAME( ColorLayer ),
4599 };
4600 Q_ENUM( RasterLayerType )
4601
4602
4610 {
4611 Undefined SIP_MONKEYPATCH_COMPAT_NAME( UndefinedDrawingStyle ),
4612 SingleBandGray,
4613 SingleBandPseudoColor,
4614 PalettedColor,
4615 PalettedSingleBandGray,
4616 PalettedSingleBandPseudoColor,
4617 PalettedMultiBandColor,
4618 MultiBandSingleBandGray,
4619 MultiBandSingleBandPseudoColor,
4620 MultiBandColor,
4621 SingleBandColorData SIP_MONKEYPATCH_COMPAT_NAME( SingleBandColorDataStyle ),
4622 };
4623 Q_ENUM( RasterDrawingStyle )
4624
4625
4632 enum class RasterPyramidFormat SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsRaster, RasterPyramidsFormat ) : int
4633 {
4634 GeoTiff SIP_MONKEYPATCH_COMPAT_NAME( PyramidsGTiff ) = 0,
4635 Internal SIP_MONKEYPATCH_COMPAT_NAME( PyramidsInternal ) = 1,
4636 Erdas SIP_MONKEYPATCH_COMPAT_NAME( PyramidsErdas ) = 2
4637 };
4638 Q_ENUM( RasterPyramidFormat )
4639
4640
4648 {
4649 No SIP_MONKEYPATCH_COMPAT_NAME( PyramidsFlagNo ) = 0,
4650 Yes SIP_MONKEYPATCH_COMPAT_NAME( PyramidsFlagYes ) = 1,
4651 CopyExisting SIP_MONKEYPATCH_COMPAT_NAME( PyramidsCopyExisting ) = 2
4652 };
4653 Q_ENUM( RasterBuildPyramidOption )
4654
4655
4663 {
4664 Undefined SIP_MONKEYPATCH_COMPAT_NAME( IdentifyFormatUndefined ) = 0,
4665 Value SIP_MONKEYPATCH_COMPAT_NAME( IdentifyFormatValue ) = 1,
4666 Text SIP_MONKEYPATCH_COMPAT_NAME( IdentifyFormatText ) = 1 << 1,
4667 Html SIP_MONKEYPATCH_COMPAT_NAME( IdentifyFormatHtml ) = 1 << 2,
4668 Feature SIP_MONKEYPATCH_COMPAT_NAME( IdentifyFormatFeature ) = 1 << 3,
4669 };
4670 Q_ENUM( RasterIdentifyFormat )
4671
4672 // TODO QGIS 4 -- remove NoCapabilities and rely on RasterInterfaceCapabilities() instead
4673 // remove deprecated members
4674 // Remove "Identify" member, and replace with combinations of IdentifyValue/IdentifyText/etc
4675
4676
4684 {
4685 NoCapabilities = 0,
4686 Size = 1 << 1,
4687 Create = 1 << 2,
4688 Remove = 1 << 3,
4689 BuildPyramids = 1 << 4,
4690 Identify = 1 << 5,
4691 IdentifyValue = 1 << 6,
4692 IdentifyText = 1 << 7,
4693 IdentifyHtml = 1 << 8,
4694 IdentifyFeature = 1 << 9,
4695 Prefetch = 1 << 10,
4696 };
4697 Q_ENUM( RasterInterfaceCapability )
4698
4699
4706
4707 // TODO QGIS 4 -- remove NoProviderCapabilities and rely on RasterProviderCapabilities() instead
4708
4717 {
4718 NoProviderCapabilities = 0,
4719 ReadLayerMetadata = 1 << 1,
4720 WriteLayerMetadata = 1 << 2,
4721 ProviderHintBenefitsFromResampling = 1 << 3,
4722 ProviderHintCanPerformProviderResampling = 1 << 4,
4723 ReloadData = 1 << 5,
4724 DpiDependentData = 1 << 6,
4725 NativeRasterAttributeTable = 1 << 7,
4726 BuildPyramids = 1 << 8,
4727 };
4728 Q_ENUM( RasterProviderCapability )
4729
4730
4739
4746 {
4747 HighestElevation,
4748 NewerElevation,
4749 };
4750 Q_ENUM( ElevationMapCombineMethod )
4751
4752
4761 {
4762 Normal SIP_MONKEYPATCH_COMPAT_NAME( BlendNormal ),
4763 Lighten SIP_MONKEYPATCH_COMPAT_NAME( BlendLighten ),
4764 Screen SIP_MONKEYPATCH_COMPAT_NAME( BlendScreen ),
4765 Dodge SIP_MONKEYPATCH_COMPAT_NAME( BlendDodge ),
4766 Addition SIP_MONKEYPATCH_COMPAT_NAME( BlendAddition ),
4767 Darken SIP_MONKEYPATCH_COMPAT_NAME( BlendDarken ),
4768 Multiply SIP_MONKEYPATCH_COMPAT_NAME( BlendMultiply ),
4769 Burn SIP_MONKEYPATCH_COMPAT_NAME( BlendBurn ),
4770 Overlay SIP_MONKEYPATCH_COMPAT_NAME( BlendOverlay ),
4771 SoftLight SIP_MONKEYPATCH_COMPAT_NAME( BlendSoftLight ),
4772 HardLight SIP_MONKEYPATCH_COMPAT_NAME( BlendHardLight ),
4773 Difference SIP_MONKEYPATCH_COMPAT_NAME( BlendDifference ),
4774 Subtract SIP_MONKEYPATCH_COMPAT_NAME( BlendSubtract ),
4775 Source SIP_MONKEYPATCH_COMPAT_NAME( BlendSource ),
4776 DestinationOver SIP_MONKEYPATCH_COMPAT_NAME( BlendDestinationOver ),
4777 Clear SIP_MONKEYPATCH_COMPAT_NAME( BlendClear ),
4778 Destination SIP_MONKEYPATCH_COMPAT_NAME( BlendDestination ),
4779 SourceIn SIP_MONKEYPATCH_COMPAT_NAME( BlendSourceIn ),
4780 DestinationIn SIP_MONKEYPATCH_COMPAT_NAME( BlendDestinationIn ),
4781 SourceOut SIP_MONKEYPATCH_COMPAT_NAME( BlendSourceOut ),
4782 DestinationOut SIP_MONKEYPATCH_COMPAT_NAME( BlendDestinationOut ),
4783 SourceAtop SIP_MONKEYPATCH_COMPAT_NAME( BlendSourceAtop ),
4784 DestinationAtop SIP_MONKEYPATCH_COMPAT_NAME( BlendDestinationAtop ),
4785 Xor SIP_MONKEYPATCH_COMPAT_NAME( BlendXor ),
4786 };
4787 Q_ENUM( BlendMode )
4788
4789
4797 {
4798 Unknown SIP_MONKEYPATCH_COMPAT_NAME( UnknownSystem ) = 0,
4799 Metric SIP_MONKEYPATCH_COMPAT_NAME( MetricSystem ),
4800 Imperial SIP_MONKEYPATCH_COMPAT_NAME( ImperialSystem ),
4801 USCS SIP_MONKEYPATCH_COMPAT_NAME( USCSSystem ),
4802 };
4803 Q_ENUM( SystemOfMeasurement )
4804
4805
4812 {
4813 Layer SIP_MONKEYPATCH_COMPAT_NAME( LayerUnits ),
4814 Pixels,
4815 Project SIP_MONKEYPATCH_COMPAT_NAME( ProjectUnits )
4816 };
4817 Q_ENUM( MapToolUnit )
4818
4819
4827 {
4828 Distance SIP_MONKEYPATCH_COMPAT_NAME( TypeDistance ) = 0,
4829 Area SIP_MONKEYPATCH_COMPAT_NAME( TypeArea ),
4830 Volume SIP_MONKEYPATCH_COMPAT_NAME( TypeVolume ),
4831 Unknown SIP_MONKEYPATCH_COMPAT_NAME( TypeUnknown ),
4832 Temporal SIP_MONKEYPATCH_COMPAT_NAME( TypeTemporal ),
4833 };
4834 Q_ENUM( UnitType )
4835
4836
4844 {
4845 Meters SIP_MONKEYPATCH_COMPAT_NAME( DistanceMeters ),
4846 Kilometers SIP_MONKEYPATCH_COMPAT_NAME( DistanceKilometers ),
4847 Feet SIP_MONKEYPATCH_COMPAT_NAME( DistanceFeet ),
4848 NauticalMiles SIP_MONKEYPATCH_COMPAT_NAME( DistanceNauticalMiles ),
4849 Yards SIP_MONKEYPATCH_COMPAT_NAME( DistanceYards ),
4850 Miles SIP_MONKEYPATCH_COMPAT_NAME( DistanceMiles ),
4851 Degrees SIP_MONKEYPATCH_COMPAT_NAME( DistanceDegrees ),
4852 Centimeters SIP_MONKEYPATCH_COMPAT_NAME( DistanceCentimeters ),
4853 Millimeters SIP_MONKEYPATCH_COMPAT_NAME( DistanceMillimeters ),
4854 Inches,
4855 ChainsInternational,
4856 ChainsBritishBenoit1895A,
4857 ChainsBritishBenoit1895B,
4858 ChainsBritishSears1922Truncated,
4859 ChainsBritishSears1922,
4860 ChainsClarkes,
4861 ChainsUSSurvey,
4862 FeetBritish1865,
4863 FeetBritish1936,
4864 FeetBritishBenoit1895A,
4865 FeetBritishBenoit1895B,
4866 FeetBritishSears1922Truncated,
4867 FeetBritishSears1922,
4868 FeetClarkes,
4869 FeetGoldCoast,
4870 FeetIndian,
4871 FeetIndian1937,
4872 FeetIndian1962,
4873 FeetIndian1975,
4874 FeetUSSurvey,
4875 LinksInternational,
4876 LinksBritishBenoit1895A,
4877 LinksBritishBenoit1895B,
4878 LinksBritishSears1922Truncated,
4879 LinksBritishSears1922,
4880 LinksClarkes,
4881 LinksUSSurvey,
4882 YardsBritishBenoit1895A,
4883 YardsBritishBenoit1895B,
4884 YardsBritishSears1922Truncated,
4885 YardsBritishSears1922,
4886 YardsClarkes,
4887 YardsIndian,
4888 YardsIndian1937,
4889 YardsIndian1962,
4890 YardsIndian1975,
4891 MilesUSSurvey,
4892 Fathoms,
4893 MetersGermanLegal,
4894 Unknown SIP_MONKEYPATCH_COMPAT_NAME( DistanceUnknownUnit ),
4895 };
4896 Q_ENUM( DistanceUnit )
4897
4898
4906 {
4907 Standard,
4908 Geographic,
4909 Unknown SIP_MONKEYPATCH_COMPAT_NAME( UnknownType ),
4910 };
4911 Q_ENUM( DistanceUnitType )
4912
4913
4921 {
4922 SquareMeters SIP_MONKEYPATCH_COMPAT_NAME( AreaSquareMeters ),
4923 SquareKilometers SIP_MONKEYPATCH_COMPAT_NAME( AreaSquareKilometers ),
4924 SquareFeet SIP_MONKEYPATCH_COMPAT_NAME( AreaSquareFeet ),
4925 SquareYards SIP_MONKEYPATCH_COMPAT_NAME( AreaSquareYards ),
4926 SquareMiles SIP_MONKEYPATCH_COMPAT_NAME( AreaSquareMiles ),
4927 Hectares SIP_MONKEYPATCH_COMPAT_NAME( AreaHectares ),
4928 Acres SIP_MONKEYPATCH_COMPAT_NAME( AreaAcres ),
4929 SquareNauticalMiles SIP_MONKEYPATCH_COMPAT_NAME( AreaSquareNauticalMiles ),
4930 SquareDegrees SIP_MONKEYPATCH_COMPAT_NAME( AreaSquareDegrees ),
4931 SquareCentimeters SIP_MONKEYPATCH_COMPAT_NAME( AreaSquareCentimeters ),
4932 SquareMillimeters SIP_MONKEYPATCH_COMPAT_NAME( AreaSquareMillimeters ),
4933 SquareInches,
4934 Unknown SIP_MONKEYPATCH_COMPAT_NAME( AreaUnknownUnit ),
4935 };
4936 Q_ENUM( AreaUnit )
4937
4938
4946 {
4947 CubicMeters SIP_MONKEYPATCH_COMPAT_NAME( VolumeCubicMeters ),
4948 CubicFeet SIP_MONKEYPATCH_COMPAT_NAME( VolumeCubicFeet ),
4949 CubicYards SIP_MONKEYPATCH_COMPAT_NAME( VolumeCubicYards ),
4950 Barrel SIP_MONKEYPATCH_COMPAT_NAME( VolumeBarrel ),
4951 CubicDecimeter SIP_MONKEYPATCH_COMPAT_NAME( VolumeCubicDecimeter ),
4952 Liters SIP_MONKEYPATCH_COMPAT_NAME( VolumeLiters ),
4953 GallonUS SIP_MONKEYPATCH_COMPAT_NAME( VolumeGallonUS ),
4954 CubicInch SIP_MONKEYPATCH_COMPAT_NAME( VolumeCubicInch ),
4955 CubicCentimeter SIP_MONKEYPATCH_COMPAT_NAME( VolumeCubicCentimeter ),
4956 CubicDegrees SIP_MONKEYPATCH_COMPAT_NAME( VolumeCubicDegrees ),
4957 Unknown SIP_MONKEYPATCH_COMPAT_NAME( VolumeUnknownUnit ),
4958 };
4959 Q_ENUM( VolumeUnit )
4960
4961
4969 {
4970 Degrees SIP_MONKEYPATCH_COMPAT_NAME( AngleDegrees ),
4971 Radians SIP_MONKEYPATCH_COMPAT_NAME( AngleRadians ),
4972 Gon SIP_MONKEYPATCH_COMPAT_NAME( AngleGon ),
4973 MinutesOfArc SIP_MONKEYPATCH_COMPAT_NAME( AngleMinutesOfArc ),
4974 SecondsOfArc SIP_MONKEYPATCH_COMPAT_NAME( AngleSecondsOfArc ),
4975 Turn SIP_MONKEYPATCH_COMPAT_NAME( AngleTurn ),
4976 MilliradiansSI SIP_MONKEYPATCH_COMPAT_NAME( AngleMilliradiansSI ),
4977 MilNATO SIP_MONKEYPATCH_COMPAT_NAME( AngleMilNATO ),
4978 Unknown SIP_MONKEYPATCH_COMPAT_NAME( AngleUnknownUnit ),
4979 };
4980 Q_ENUM( AngleUnit )
4981
4982
4990 {
4991 Milliseconds SIP_MONKEYPATCH_COMPAT_NAME( TemporalMilliseconds ),
4992 Seconds SIP_MONKEYPATCH_COMPAT_NAME( TemporalSeconds ),
4993 Minutes SIP_MONKEYPATCH_COMPAT_NAME( TemporalMinutes ),
4994 Hours SIP_MONKEYPATCH_COMPAT_NAME( TemporalHours ),
4995 Days SIP_MONKEYPATCH_COMPAT_NAME( TemporalDays ),
4996 Weeks SIP_MONKEYPATCH_COMPAT_NAME( TemporalWeeks ),
4997 Months SIP_MONKEYPATCH_COMPAT_NAME( TemporalMonths ),
4998 Years SIP_MONKEYPATCH_COMPAT_NAME( TemporalYears ),
4999 Decades SIP_MONKEYPATCH_COMPAT_NAME( TemporalDecades ),
5000 Centuries SIP_MONKEYPATCH_COMPAT_NAME( TemporalCenturies ),
5001 IrregularStep SIP_MONKEYPATCH_COMPAT_NAME( TemporalIrregularStep ),
5002 Unknown SIP_MONKEYPATCH_COMPAT_NAME( TemporalUnknownUnit )
5003 };
5004 Q_ENUM( TemporalUnit )
5005
5006
5014 {
5015 Millimeters SIP_MONKEYPATCH_COMPAT_NAME( RenderMillimeters ),
5016 MapUnits SIP_MONKEYPATCH_COMPAT_NAME( RenderMapUnits ),
5017 Pixels SIP_MONKEYPATCH_COMPAT_NAME( RenderPixels ),
5018 Percentage SIP_MONKEYPATCH_COMPAT_NAME( RenderPercentage ),
5019 Points SIP_MONKEYPATCH_COMPAT_NAME( RenderPoints ),
5020 Inches SIP_MONKEYPATCH_COMPAT_NAME( RenderInches ),
5021 Unknown SIP_MONKEYPATCH_COMPAT_NAME( RenderUnknownUnit ),
5022 MetersInMapUnits SIP_MONKEYPATCH_COMPAT_NAME( RenderMetersInMapUnits ),
5023 };
5024 Q_ENUM( RenderUnit )
5025
5026
5034 {
5035 Millimeters SIP_MONKEYPATCH_COMPAT_NAME( LayoutMillimeters ),
5036 Centimeters SIP_MONKEYPATCH_COMPAT_NAME( LayoutCentimeters ),
5037 Meters SIP_MONKEYPATCH_COMPAT_NAME( LayoutMeters ),
5038 Inches SIP_MONKEYPATCH_COMPAT_NAME( LayoutInches ),
5039 Feet SIP_MONKEYPATCH_COMPAT_NAME( LayoutFeet ),
5040 Points SIP_MONKEYPATCH_COMPAT_NAME( LayoutPoints ),
5041 Picas SIP_MONKEYPATCH_COMPAT_NAME( LayoutPicas ),
5042 Pixels SIP_MONKEYPATCH_COMPAT_NAME( LayoutPixels )
5043 };
5044 Q_ENUM( LayoutUnit )
5045
5046
5054 {
5055 PaperUnits SIP_MONKEYPATCH_COMPAT_NAME( LayoutPaperUnits ),
5056 ScreenUnits SIP_MONKEYPATCH_COMPAT_NAME( LayoutScreenUnits )
5057 };
5058 Q_ENUM( LayoutUnitType )
5059
5060
5068 {
5069 SVG SIP_MONKEYPATCH_COMPAT_NAME( FormatSVG ) = 0,
5070 Raster SIP_MONKEYPATCH_COMPAT_NAME( FormatRaster ),
5071 Unknown SIP_MONKEYPATCH_COMPAT_NAME( FormatUnknown ),
5072 };
5073 Q_ENUM( PictureFormat )
5074
5075
5080 enum class ScaleCalculationMethod : int
5081 {
5082 HorizontalTop = 0,
5083 HorizontalMiddle,
5084 HorizontalBottom,
5085 HorizontalAverage,
5086 AtEquator,
5087 };
5088 Q_ENUM( ScaleCalculationMethod )
5089
5090
5098 {
5099 Left SIP_MONKEYPATCH_COMPAT_NAME( AlignLeft ) = 0,
5100 Middle SIP_MONKEYPATCH_COMPAT_NAME( AlignMiddle ),
5101 Right SIP_MONKEYPATCH_COMPAT_NAME( AlignRight ),
5102 };
5103 Q_ENUM( ScaleBarAlignment )
5104
5105
5113 {
5114 Fixed SIP_MONKEYPATCH_COMPAT_NAME( SegmentSizeFixed ) = 0,
5115 FitWidth SIP_MONKEYPATCH_COMPAT_NAME( SegmentSizeFitWidth ) = 1
5116 };
5117 Q_ENUM( ScaleBarSegmentSizeMode )
5118
5119
5127 {
5128 AboveSegment SIP_MONKEYPATCH_COMPAT_NAME( LabelAboveSegment ) = 0,
5129 BelowSegment SIP_MONKEYPATCH_COMPAT_NAME( LabelBelowSegment ),
5130 };
5131 Q_ENUM( ScaleBarDistanceLabelVerticalPlacement )
5132
5133
5141 {
5142 CenteredEdge SIP_MONKEYPATCH_COMPAT_NAME( LabelCenteredEdge ) = 0,
5143 CenteredSegment SIP_MONKEYPATCH_COMPAT_NAME( LabelCenteredSegment ),
5144 };
5145 Q_ENUM( ScaleBarDistanceLabelHorizontalPlacement )
5146
5147
5152 enum class InputControllerType : int
5153 {
5154 Map2D,
5155 Map3D
5156 };
5158
5165 {
5166 NotSet,
5167 Unknown,
5168 OrdinaryTable,
5169 Index,
5170 Sequence,
5171 View,
5172 MaterializedView,
5173 CompositeType,
5174 ToastTable,
5175 ForeignTable,
5176 PartitionedTable,
5177 };
5178 Q_ENUM( PostgresRelKind )
5179
5180
5186 {
5187 SetFieldComment = 1 << 0,
5188 SetFieldAlias = 1 << 1,
5189 SetTableComment = 1 << 2,
5190 };
5191 Q_ENUM( DatabaseProviderConnectionCapability2 )
5194
5201 {
5202 SetGeometryColumnName = 1 << 0,
5203 SetPrimaryKeyName = 1 << 1,
5204 };
5205 Q_ENUM( DatabaseProviderTableImportCapability )
5208
5215 {
5216 SaveToDatabase = 1 << 1,
5217 LoadFromDatabase = 1 << 2,
5218 DeleteFromDatabase = 1 << 3
5219 };
5223
5224
5230 {
5231 LastProfile,
5232 DefaultProfile,
5233 AskUser,
5234 };
5235 Q_ENUM( UserProfileSelectionPolicy )
5236
5237
5245 {
5246 Container SIP_MONKEYPATCH_COMPAT_NAME( AeTypeContainer ),
5247 Field SIP_MONKEYPATCH_COMPAT_NAME( AeTypeField ),
5248 Relation SIP_MONKEYPATCH_COMPAT_NAME( AeTypeRelation ),
5249 QmlElement SIP_MONKEYPATCH_COMPAT_NAME( AeTypeQmlElement ),
5250 HtmlElement SIP_MONKEYPATCH_COMPAT_NAME( AeTypeHtmlElement ),
5251 Action SIP_MONKEYPATCH_COMPAT_NAME( AeTypeAction ),
5252 TextElement SIP_MONKEYPATCH_COMPAT_NAME( AeTypeTextElement ),
5253 SpacerElement SIP_MONKEYPATCH_COMPAT_NAME( AeTypeSpacerElement ),
5254 Invalid SIP_MONKEYPATCH_COMPAT_NAME( AeTypeInvalid ),
5255 };
5256 Q_ENUM( AttributeEditorType )
5257
5258
5264 {
5265 GroupBox,
5266 Tab,
5267 Row,
5268 };
5269 Q_ENUM( AttributeEditorContainerType )
5270
5271
5279 {
5280 AutoGenerated SIP_MONKEYPATCH_COMPAT_NAME( GeneratedLayout ) = 0,
5281 DragAndDrop SIP_MONKEYPATCH_COMPAT_NAME( TabLayout ) = 1,
5282 UiFile SIP_MONKEYPATCH_COMPAT_NAME( UiFileLayout ) = 2
5283 };
5284 Q_ENUM( AttributeFormLayout )
5285
5286
5294 {
5295 Default SIP_MONKEYPATCH_COMPAT_NAME( SuppressDefault ) = 0,
5296 On SIP_MONKEYPATCH_COMPAT_NAME( SuppressOn ) = 1,
5297 Off SIP_MONKEYPATCH_COMPAT_NAME( SuppressOff ) = 2
5298 };
5299 Q_ENUM( AttributeFormSuppression )
5300
5301
5309 {
5310 NoSource SIP_MONKEYPATCH_COMPAT_NAME( CodeSourceNone ) = 0,
5311 File SIP_MONKEYPATCH_COMPAT_NAME( CodeSourceFile ) = 1,
5312 Dialog SIP_MONKEYPATCH_COMPAT_NAME( CodeSourceDialog ) = 2,
5313 Environment SIP_MONKEYPATCH_COMPAT_NAME( CodeSourceEnvironment ) = 3
5314 };
5315 Q_ENUM( AttributeFormPythonInitCodeSource )
5316
5317
5323 {
5324 Qgis,
5325 PointCloud,
5326 RasterCalculator,
5327 };
5328 Q_ENUM( ExpressionType )
5329
5330
5338 {
5339 NoSymbology = 0,
5340 PerFeature SIP_MONKEYPATCH_COMPAT_NAME( FeatureSymbology ),
5341 PerSymbolLayer SIP_MONKEYPATCH_COMPAT_NAME( SymbolLayerSymbology )
5342 };
5343 Q_ENUM( FeatureSymbologyExport )
5344
5345
5350 enum class VectorTileProviderFlag : int SIP_ENUM_BASETYPE( IntFlag )
5351 {
5352 AlwaysUseTileMatrixSetFromProvider = 1 << 1,
5353 };
5354 Q_ENUM( VectorTileProviderFlag )
5355
5356
5362 Q_FLAG( VectorTileProviderFlags )
5363
5369 {
5370 ReadLayerMetadata = 1 << 1,
5371 };
5372 Q_ENUM( VectorTileProviderCapability )
5373
5374
5381
5388 {
5389 Available,
5390 NotAvailable,
5391 AvailableNoChildren,
5392 UseLowerZoomLevelTile,
5393 };
5394 Q_ENUM( TileAvailability )
5395
5396
5402 {
5403 ReadLayerMetadata = 1 << 1,
5404 };
5405 Q_ENUM( TiledSceneProviderCapability )
5406
5407
5414
5421 {
5422 Region,
5423 OrientedBox,
5424 Sphere,
5425 };
5426 Q_ENUM( TiledSceneBoundingVolumeType )
5427
5428
5437 {
5438 Replacement,
5439 Additive,
5440 };
5441 Q_ENUM( TileRefinementProcess )
5442
5443
5449 {
5450 NoChildren,
5451 Available,
5452 NeedFetching,
5453 };
5454 Q_ENUM( TileChildrenAvailability )
5455
5456
5461 enum class TiledSceneRequestFlag : int SIP_ENUM_BASETYPE( IntFlag )
5462 {
5463 NoHierarchyFetch = 1 << 0,
5464 };
5465 Q_ENUM( TiledSceneRequestFlag )
5466
5467
5473 Q_FLAG( TiledSceneRequestFlags )
5474
5480 enum class TiledSceneRendererFlag : int SIP_ENUM_BASETYPE( IntFlag )
5481 {
5482 RequiresTextures = 1 << 0,
5483 ForceRasterRender = 1 << 1,
5484 RendersTriangles = 1 << 2,
5485 RendersLines = 1 << 3,
5486 };
5487 Q_ENUM( TiledSceneRendererFlag )
5488
5489
5495 Q_FLAG( TiledSceneRendererFlags )
5496
5502 enum class GdalResampleAlgorithm : int
5503 {
5504 RA_NearestNeighbour = 0,
5505 RA_Bilinear = 1,
5506 RA_Cubic = 2,
5507 RA_CubicSpline = 3,
5508 RA_Lanczos = 4,
5509 RA_Average = 5,
5510 RA_Mode = 6,
5511 RA_Max = 8,
5512 RA_Min = 9,
5513 RA_Median = 10,
5514 RA_Q1 = 11,
5515 RA_Q3 = 12,
5516 };
5517 Q_ENUM( GdalResampleAlgorithm )
5518
5519
5524 enum class VsiHandlerType : int
5525 {
5526 Invalid,
5527 Archive,
5528 Network,
5529 Cloud,
5530 Memory,
5531 Other,
5532 };
5533 Q_ENUM( VsiHandlerType )
5534
5535 // TODO QGIS 4: make All include all values (we can't do this before 4.0, as we need to keep
5536 // compatibility with code which expects all these statistics to give numeric results)
5537
5538
5543 enum class ZonalStatistic : int SIP_ENUM_BASETYPE( IntFlag )
5544 {
5545 Count = 1 << 0,
5546 Sum = 1 << 1,
5547 Mean = 1 << 2,
5548 Median = 1 << 3,
5549 StDev = 1 << 4,
5550 Min = 1 << 5,
5551 Max = 1 << 6,
5552 Range = 1 << 7,
5553 Minority = 1 << 8,
5554 Majority = 1 << 9,
5555 Variety = 1 << 10,
5556 Variance = 1 << 11,
5557 MinimumPoint = 1 << 12,
5558 MaximumPoint = 1 << 13,
5559 All = Count | Sum | Mean | Median | StDev | Max | Min | Range | Minority | Majority | Variety | Variance,
5560 AllNumeric = Count | Sum | Mean | Median | StDev | Max | Min | Range | Minority | Majority | Variety | Variance,
5561 Default = Count | Sum | Mean,
5562 };
5563 Q_ENUM( ZonalStatistic )
5564
5565
5571 Q_FLAG( ZonalStatistics )
5572
5578 enum class ZonalStatisticResult : int
5579 {
5580 Success = 0,
5581 LayerTypeWrong = 1,
5582 LayerInvalid,
5583 RasterInvalid,
5584 RasterBandInvalid,
5585 FailedToCreateField = 8,
5586 Canceled = 9
5587 };
5588 Q_ENUM( ZonalStatisticResult )
5589
5590
5597 {
5598 Count,
5599 CountDistinct,
5600 CountMissing,
5601 Min,
5602 Max,
5603 Sum,
5604 Mean,
5605 Median,
5606 StDev,
5607 StDevSample,
5608 Range,
5609 Minority,
5610 Majority,
5611 FirstQuartile,
5612 ThirdQuartile,
5613 InterQuartileRange,
5614 StringMinimumLength,
5615 StringMaximumLength,
5616 StringConcatenate,
5617 GeometryCollect,
5618 ArrayAggregate,
5619 StringConcatenateUnique
5620 };
5621 Q_ENUM( Aggregate )
5622
5623
5629 {
5630 Count = 1 << 0,
5631 CountMissing = 1 << 15,
5632 Sum = 1 << 1,
5633 Mean = 1 << 2,
5634 Median = 1 << 3,
5635 StDev = 1 << 4,
5636 StDevSample = 1 << 5,
5637 Min = 1 << 6,
5638 Max = 1 << 7,
5639 Range = 1 << 8,
5640 Minority = 1 << 9,
5641 Majority = 1 << 10,
5642 Variety = 1 << 11,
5643 FirstQuartile = 1 << 12,
5644 ThirdQuartile = 1 << 13,
5645 InterQuartileRange = 1 << 14,
5646 First = 1 << 16,
5647 Last = 1 << 17,
5648 All = Count | CountMissing | Sum | Mean | Median | StDev | Max | Min | Range | Minority | Majority | Variety | FirstQuartile | ThirdQuartile | InterQuartileRange | First | Last
5649 };
5650 Q_ENUM( Statistic )
5651
5652
5658 Q_FLAG( Statistics )
5659
5666 {
5667 Count = 1,
5668 CountDistinct = 2,
5669 CountMissing = 4,
5670 Min = 8,
5671 Max = 16,
5672 Range = 32,
5673 All = Count | CountDistinct | CountMissing | Min | Max | Range,
5674 };
5675 Q_ENUM( DateTimeStatistic )
5676
5677
5683 Q_FLAG( DateTimeStatistics )
5684
5691 {
5692 Count = 1,
5693 CountDistinct = 2,
5694 CountMissing = 4,
5695 Min = 8,
5696 Max = 16,
5697 MinimumLength = 32,
5698 MaximumLength = 64,
5699 MeanLength = 128,
5700 Minority = 256,
5701 Majority = 512,
5702 All = Count | CountDistinct | CountMissing | Min | Max | MinimumLength | MaximumLength | MeanLength | Minority | Majority,
5703 };
5704 Q_ENUM( StringStatistic )
5705
5706
5712 Q_FLAG( StringStatistics )
5713
5720 {
5721 NoStatistic = 0,
5722 Min = 1,
5723 Max = 1 << 1,
5724 Range = 1 << 2,
5725 Sum = 1 << 3,
5726 Mean = 1 << 4,
5727 StdDev = 1 << 5,
5728 SumOfSquares = 1 << 6,
5729 All = Min | Max | Range | Sum | Mean | StdDev | SumOfSquares
5730 };
5731 Q_ENUM( RasterBandStatistic )
5732
5733
5739 Q_FLAG( RasterBandStatistics )
5740
5746 enum class SensorThingsEntity : int
5747 {
5748 Invalid,
5749 Thing,
5750 Location,
5751 HistoricalLocation,
5752 Datastream,
5753 Sensor,
5754 ObservedProperty,
5755 Observation,
5756 FeatureOfInterest,
5757 MultiDatastream,
5758 };
5759 Q_ENUM( SensorThingsEntity )
5760
5761
5766 enum class ColorModel : int
5767 {
5768 Rgb,
5769 Cmyk,
5770 };
5771 Q_ENUM( ColorModel )
5772
5773
5778 enum class DocumentationApi : int
5779 {
5780 PyQgis,
5781 PyQgisSearch,
5782 CppQgis,
5783 Qt,
5784 };
5785 Q_ENUM( DocumentationApi )
5786
5787
5792 enum class DocumentationBrowser : int
5793 {
5794 DeveloperToolsPanel,
5795 SystemWebBrowser,
5796 };
5797 Q_ENUM( DocumentationBrowser )
5798
5799
5804 enum class MouseHandlesAction : int
5805 {
5806 MoveItem,
5807 ResizeUp,
5808 ResizeDown,
5809 ResizeLeft,
5810 ResizeRight,
5811 ResizeLeftUp,
5812 ResizeRightUp,
5813 ResizeLeftDown,
5814 ResizeRightDown,
5815 SelectItem,
5816 NoAction
5817 };
5818 Q_ENUM( MouseHandlesAction )
5819
5820
5824 enum class MeshRangeLimit : int
5825 {
5826 NotSet,
5827 MinimumMaximum,
5828 };
5829 Q_ENUM( MeshRangeLimit )
5830
5831
5836 enum class MeshRangeExtent : int
5837 {
5838 WholeMesh,
5839 FixedCanvas,
5840 UpdatedCanvas,
5841 };
5842 Q_ENUM( MeshRangeExtent )
5843
5844
5850 enum class PointCloudAccessType : int
5851 {
5852 Local,
5853 Remote
5854 };
5855 Q_ENUM( PointCloudAccessType )
5856
5857
5862 {
5863 RenderExtents,
5864 RenderOverview,
5865 RenderOverviewAndExtents
5866 };
5867 Q_ENUM( PointCloudZoomOutRenderBehavior )
5868
5869
5874 {
5875 Standard = 0,
5876 Adaptive,
5877 AreaError,
5878 ConstantDensity
5879 };
5880 Q_ENUM( SegmentCalculationMethod )
5881
5882
5885 static const double DEFAULT_SEARCH_RADIUS_MM;
5886
5888 static const float DEFAULT_MAPTOPIXEL_THRESHOLD;
5889
5895 static const QColor DEFAULT_HIGHLIGHT_COLOR;
5896
5900 static const double DEFAULT_HIGHLIGHT_BUFFER_MM;
5901
5905 static const double DEFAULT_HIGHLIGHT_MIN_WIDTH_MM;
5906
5914 Q_DECL_DEPRECATED static const double SCALE_PRECISION;
5915
5920 static const double DEFAULT_Z_COORDINATE;
5921
5927 static const double DEFAULT_M_COORDINATE;
5928
5933 static const double UI_SCALE_FACTOR;
5934
5938 static const double DEFAULT_SNAP_TOLERANCE;
5939
5943 static const Qgis::MapToolUnit DEFAULT_SNAP_UNITS;
5944
5948 static const int USER_CRS_START_ID;
5949
5951 static const double DEFAULT_POINT_SIZE;
5952
5954 static const double DEFAULT_LINE_WIDTH;
5955
5957 static const double DEFAULT_SEGMENT_EPSILON;
5958
5960 SIP_SKIP static const int PREVIEW_JOB_DELAY_MS;
5961
5963 SIP_SKIP static const int MAXIMUM_LAYER_PREVIEW_TIME_MS;
5964
5970 static QString defaultProjectScales();
5971
5977 static int geosVersionInt();
5978
5984 static int geosVersionMajor();
5985
5991 static int geosVersionMinor();
5992
5998 static int geosVersionPatch();
5999
6005 static QString geosVersion();
6006
6012 static QString geoNone()
6013 {
6014 return QStringLiteral( "NONE" );
6015 }
6016
6022 static QString geographicCrsAuthId()
6023 {
6024 return QStringLiteral( "EPSG:4326" );
6025 }
6026
6031 Q_DECL_DEPRECATED static QString geoWkt()
6032 {
6033 return QStringLiteral(
6034 R"""(GEOGCRS["WGS 84",DATUM["World Geodetic System 1984",ELLIPSOID["WGS 84",6378137,298.257223563,LENGTHUNIT["metre",1]]],PRIMEM["Greenwich",0,ANGLEUNIT["degree",0.0174532925199433]],CS[ellipsoidal,2],AXIS["geodetic latitude (Lat)",north,ORDER[1],ANGLEUNIT["degree",0.0174532925199433]],AXIS["geodetic longitude (Lon)",east,ORDER[2],ANGLEUNIT["degree",0.0174532925199433]],USAGE[SCOPE["unknown"],AREA["World"],BBOX[-90,-180,90,180]],ID["EPSG",4326]] )"""
6035 );
6036 }
6037
6042 Q_DECL_DEPRECATED static QString geoProj4()
6043 {
6044 return QStringLiteral( "+proj=longlat +datum=WGS84 +no_defs" );
6045 }
6046
6047};
6048
6051
6134
6135// hack to workaround warnings when casting void pointers
6136// retrieved from QLibrary::resolve to function pointers.
6137// It's assumed that this works on all systems supporting
6138// QLibrary
6139#define cast_to_fptr(f) f
6140
6141
6149// based on Boojum's code from http://stackoverflow.com/questions/3556687/prevent-firing-signals-in-qt
6150template<class Object> class QgsSignalBlocker SIP_SKIP SIP_SKIP // clazy:exclude=rule-of-three
6151{
6152 public:
6153
6158 explicit QgsSignalBlocker( Object *object )
6159 : mObject( object )
6160 , mPreviousState( object->blockSignals( true ) )
6161 {}
6162
6164 {
6165 mObject->blockSignals( mPreviousState );
6166 }
6167
6169 Object *operator->() { return mObject; }
6170
6171 private:
6172
6173 Object *mObject = nullptr;
6174 bool mPreviousState;
6175
6176};
6177
6190// based on Boojum's code from http://stackoverflow.com/questions/3556687/prevent-firing-signals-in-qt
6191template<class Object> inline QgsSignalBlocker<Object> whileBlocking( Object *object ) SIP_SKIP SIP_SKIP
6192{
6193 return QgsSignalBlocker<Object>( object );
6194}
6195
6197CORE_EXPORT uint qHash( const QVariant &variant );
6198
6204inline QString qgsDoubleToString( double a, int precision = 17 )
6205{
6206 QString str;
6207 if ( precision )
6208 {
6209 if ( precision < 0 )
6210 {
6211 const double roundFactor = std::pow( 10, -precision );
6212 str = QString::number( static_cast< long long >( std::round( a / roundFactor ) * roundFactor ) );
6213 }
6214 else
6215 {
6216 str = QString::number( a, 'f', precision );
6217 if ( str.contains( QLatin1Char( '.' ) ) )
6218 {
6219 // remove ending 0s
6220 int idx = str.length() - 1;
6221 while ( str.at( idx ) == '0' && idx > 1 )
6222 {
6223 idx--;
6224 }
6225 if ( idx < str.length() - 1 )
6226 str.truncate( str.at( idx ) == '.' ? idx : idx + 1 );
6227 }
6228 }
6229 }
6230 else
6231 {
6232 str = QString::number( a, 'f', precision );
6233 }
6234 // avoid printing -0
6235 // see https://bugreports.qt.io/browse/QTBUG-71439
6236 if ( str == QLatin1String( "-0" ) )
6237 {
6238 return QLatin1String( "0" );
6239 }
6240 return str;
6241}
6242
6249inline bool qgsNanCompatibleEquals( double a, double b )
6250{
6251 const bool aIsNan = std::isnan( a );
6252 const bool bIsNan = std::isnan( b );
6253 if ( aIsNan || bIsNan )
6254 return aIsNan && bIsNan;
6255
6256 return a == b;
6257}
6258
6259#ifndef SIP_RUN
6260
6268template<typename T>
6269inline bool qgsNumberNear( T a, T b, T epsilon = std::numeric_limits<T>::epsilon() * 4 )
6270{
6271 const bool aIsNan = std::isnan( a );
6272 const bool bIsNan = std::isnan( b );
6273 if ( aIsNan || bIsNan )
6274 return aIsNan && bIsNan;
6275
6276 const T diff = a - b;
6277 return diff >= -epsilon && diff <= epsilon;
6278}
6279#endif
6280
6287inline bool qgsDoubleNear( double a, double b, double epsilon = 4 * std::numeric_limits<double>::epsilon() )
6288{
6289 return qgsNumberNear<double>( a, b, epsilon );
6290}
6291
6298inline bool qgsFloatNear( float a, float b, float epsilon = 4 * FLT_EPSILON )
6299{
6300 return qgsNumberNear<float>( a, b, epsilon );
6301}
6302
6304inline bool qgsDoubleNearSig( double a, double b, int significantDigits = 10 )
6305{
6306 const bool aIsNan = std::isnan( a );
6307 const bool bIsNan = std::isnan( b );
6308 if ( aIsNan || bIsNan )
6309 return aIsNan && bIsNan;
6310
6311 // The most simple would be to print numbers as %.xe and compare as strings
6312 // but that is probably too costly
6313 // Then the fastest would be to set some bits directly, but little/big endian
6314 // has to be considered (maybe TODO)
6315 // Is there a better way?
6316 int aexp, bexp;
6317 const double ar = std::frexp( a, &aexp );
6318 const double br = std::frexp( b, &bexp );
6319
6320 return aexp == bexp &&
6321 std::round( ar * std::pow( 10.0, significantDigits ) ) == std::round( br * std::pow( 10.0, significantDigits ) );
6322}
6323
6328inline double qgsRound( double number, int places )
6329{
6330 const double m = ( number < 0.0 ) ? -1.0 : 1.0;
6331 const double scaleFactor = std::pow( 10.0, places );
6332 return ( std::round( number * m * scaleFactor ) / scaleFactor ) * m;
6333}
6334
6335#ifndef SIP_RUN
6336
6343template<class Key, class Value>
6344QString qgsMapJoinKeys( const QMap<Key, Value> &map, const QString &separator )
6345{
6346 QString result;
6347 for ( auto it = map.constBegin(); it != map.constEnd(); it++ )
6348 result += QString( "%1%2" ).arg( it.key() ).arg( separator );
6349
6350 result.chop( separator.size() );
6351 return result;
6352}
6353
6360template<class Key, class Value>
6361QString qgsMapJoinValues( const QMap<Key, Value> &map, const QString &separator )
6362{
6363 QString result;
6364 for ( auto it = map.constBegin(); it != map.constEnd(); it++ )
6365 result += QString( "%1%2" ).arg( it.value() ).arg( separator );
6366
6367 result.chop( separator.size() );
6368 return result;
6369}
6370
6377template<class T>
6378QString qgsSetJoin( const QSet<T> &set, const QString &separator )
6379{
6380 QString result;
6381 for ( auto it = set.constBegin(); it != set.constEnd(); it++ )
6382 result += QString( "%1%2" ).arg( *it ).arg( separator );
6383
6384 result.chop( separator.size() );
6385 return result;
6386}
6387
6389
6399namespace qgis
6400{
6401
6414 template<typename To, typename From> inline To down_cast( From *f )
6415 {
6416 static_assert(
6417 ( std::is_base_of<From,
6418 typename std::remove_pointer<To>::type>::value ),
6419 "target type not derived from source type" );
6420 Q_ASSERT( f == nullptr || dynamic_cast<To>( f ) != nullptr );
6421 return static_cast<To>( f );
6422 }
6423
6424 template<class T>
6425 QSet<T> listToSet( const QList<T> &list )
6426 {
6427 return QSet<T>( list.begin(), list.end() );
6428 }
6429
6430 template<class T>
6431 QList<T> setToList( const QSet<T> &set )
6432 {
6433 return QList<T>( set.begin(), set.end() );
6434 }
6435}
6436
6438#endif
6439
6444template<class T> const QList<T> qgsEnumList() SIP_SKIP
6445{
6446 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
6447 Q_ASSERT( metaEnum.isValid() );
6448 QList<T> enumList;
6449 for ( int idx = 0; idx < metaEnum.keyCount(); ++idx )
6450 {
6451 enumList.append( static_cast<T>( metaEnum.value( idx ) ) );
6452 }
6453 return enumList;
6454}
6455
6461template<class T> const QMap<T, QString> qgsEnumMap() SIP_SKIP
6462{
6463 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
6464 Q_ASSERT( metaEnum.isValid() );
6465 QMap<T, QString> enumMap;
6466 for ( int idx = 0; idx < metaEnum.keyCount(); ++idx )
6467 {
6468 enumMap.insert( static_cast<T>( metaEnum.value( idx ) ), QString( metaEnum.key( idx ) ) );
6469 }
6470 return enumMap;
6471}
6472
6478template<class T> QString qgsEnumValueToKey( const T &value, bool *returnOk = nullptr ) SIP_SKIP
6479{
6480 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
6481 Q_ASSERT( metaEnum.isValid() );
6482 const char *key = metaEnum.valueToKey( static_cast<int>( value ) );
6483 if ( returnOk )
6484 {
6485 *returnOk = key ? true : false;
6486 }
6487 return QString::fromUtf8( key );
6488}
6489
6497template<class T> T qgsEnumKeyToValue( const QString &key, const T &defaultValue, bool tryValueAsKey = true, bool *returnOk = nullptr ) SIP_SKIP
6498{
6499 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
6500 Q_ASSERT( metaEnum.isValid() );
6501 bool ok = false;
6502 T v = static_cast<T>( metaEnum.keyToValue( key.toUtf8().data(), &ok ) );
6503 if ( returnOk )
6504 {
6505 *returnOk = ok;
6506 }
6507 if ( ok )
6508 {
6509 return v;
6510 }
6511 else
6512 {
6513 // if conversion has failed, try with conversion from int value
6514 if ( tryValueAsKey )
6515 {
6516 bool canConvert = false;
6517 const int intValue = key.toInt( &canConvert );
6518 if ( canConvert && metaEnum.valueToKey( intValue ) )
6519 {
6520 if ( returnOk )
6521 {
6522 *returnOk = true;
6523 }
6524 return static_cast<T>( intValue );
6525 }
6526 }
6527 }
6528 return defaultValue;
6529}
6530
6536template<class T> QString qgsFlagValueToKeys( const T &value, bool *returnOk = nullptr ) SIP_SKIP
6537{
6538 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
6539 Q_ASSERT( metaEnum.isValid() );
6540 int intValue = static_cast<int>( value );
6541 const QByteArray ba = metaEnum.valueToKeys( intValue );
6542 // check that the int value does correspond to a flag
6543 // see https://stackoverflow.com/a/68495949/1548052
6544 const int intValueCheck = metaEnum.keysToValue( ba );
6545 bool ok = intValue == intValueCheck;
6546 if ( returnOk )
6547 *returnOk = ok;
6548 return ok ? QString::fromUtf8( ba ) : QString();
6549}
6550
6558template<class T> T qgsFlagKeysToValue( const QString &keys, const T &defaultValue, bool tryValueAsKey = true, bool *returnOk = nullptr ) SIP_SKIP
6559{
6560 if ( keys.isEmpty() )
6561 {
6562 if ( returnOk )
6563 {
6564 *returnOk = false;
6565 }
6566 return defaultValue;
6567 }
6568 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
6569 Q_ASSERT( metaEnum.isValid() );
6570 bool ok = false;
6571 T v = static_cast<T>( metaEnum.keysToValue( keys.toUtf8().constData(), &ok ) );
6572 if ( returnOk )
6573 {
6574 *returnOk = ok;
6575 }
6576 if ( ok )
6577 {
6578 return v;
6579 }
6580 else
6581 {
6582 // if conversion has failed, try with conversion from int value
6583 if ( tryValueAsKey )
6584 {
6585 bool canConvert = false;
6586 const int intValue = keys.toInt( &canConvert );
6587 if ( canConvert )
6588 {
6589 const QByteArray keys = metaEnum.valueToKeys( intValue );
6590 const int intValueCheck = metaEnum.keysToValue( keys );
6591 if ( intValue == intValueCheck )
6592 {
6593 if ( returnOk )
6594 {
6595 *returnOk = true;
6596 }
6597 return T( intValue );
6598 }
6599 }
6600 }
6601 }
6602 return defaultValue;
6603}
6604
6605
6614CORE_EXPORT double qgsPermissiveToDouble( QString string, bool &ok );
6615
6624CORE_EXPORT int qgsPermissiveToInt( QString string, bool &ok );
6625
6635CORE_EXPORT qlonglong qgsPermissiveToLongLong( QString string, bool &ok );
6636
6646CORE_EXPORT bool qgsVariantLessThan( const QVariant &lhs, const QVariant &rhs );
6647
6656CORE_EXPORT bool qgsVariantEqual( const QVariant &lhs, const QVariant &rhs );
6657
6664CORE_EXPORT bool qgsVariantGreaterThan( const QVariant &lhs, const QVariant &rhs );
6665
6666#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
6667
6674inline bool operator> ( const QVariant &v1, const QVariant &v2 )
6675{
6676 return qgsVariantGreaterThan( v1, v2 );
6677}
6678
6688inline bool operator< ( const QVariant &v1, const QVariant &v2 )
6689{
6690 return qgsVariantLessThan( v1, v2 );
6691}
6692#endif
6693
6694
6695#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
6696
6700template<> CORE_EXPORT bool qMapLessThanKey<QVariantList>( const QVariantList &key1, const QVariantList &key2 ) SIP_SKIP;
6701#endif
6702
6709Q_DECL_DEPRECATED CORE_EXPORT QString qgsVsiPrefix( const QString &path ) SIP_DEPRECATED;
6710
6716void CORE_EXPORT *qgsMalloc( size_t size ) SIP_SKIP;
6717
6722void CORE_EXPORT qgsFree( void *ptr ) SIP_SKIP;
6723
6724#ifndef SIP_RUN
6725
6727class ScopedIntIncrementor
6728{
6729 public:
6730
6731 ScopedIntIncrementor( int *variable )
6732 : mVariable( variable )
6733 {
6734 ( *mVariable )++;
6735 }
6736
6737 ScopedIntIncrementor( const ScopedIntIncrementor &other ) = delete;
6738 ScopedIntIncrementor &operator=( const ScopedIntIncrementor &other ) = delete;
6739
6740 void release()
6741 {
6742 if ( mVariable )
6743 ( *mVariable )--;
6744
6745 mVariable = nullptr;
6746 }
6747
6748 ~ScopedIntIncrementor()
6749 {
6750 release();
6751 }
6752
6753 private:
6754 int *mVariable = nullptr;
6755};
6757
6758#endif
6759
6765Q_DECL_DEPRECATED const long GEOSRID = 4326;
6766
6772Q_DECL_DEPRECATED const long GEOCRS_ID = 3452;
6773
6779Q_DECL_DEPRECATED const long GEO_EPSG_CRS_ID = 4326;
6780
6781typedef QMap<QString, QString> QgsStringMap SIP_SKIP;
6782
6791typedef unsigned long long qgssize;
6792
6793#ifndef SIP_RUN
6794#if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6)) || defined(__clang__)
6795
6796#define Q_NOWARN_DEPRECATED_PUSH \
6797 _Pragma("GCC diagnostic push") \
6798 _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"");
6799#define Q_NOWARN_DEPRECATED_POP \
6800 _Pragma("GCC diagnostic pop");
6801#define Q_NOWARN_UNREACHABLE_PUSH
6802#define Q_NOWARN_UNREACHABLE_POP
6803
6804#elif defined(_MSC_VER)
6805
6806#define Q_NOWARN_DEPRECATED_PUSH \
6807 __pragma(warning(push)) \
6808 __pragma(warning(disable:4996))
6809#define Q_NOWARN_DEPRECATED_POP \
6810 __pragma(warning(pop))
6811#define Q_NOWARN_UNREACHABLE_PUSH \
6812 __pragma(warning(push)) \
6813 __pragma(warning(disable:4702))
6814#define Q_NOWARN_UNREACHABLE_POP \
6815 __pragma(warning(pop))
6816
6817#else
6818
6819#define Q_NOWARN_DEPRECATED_PUSH
6820#define Q_NOWARN_DEPRECATED_POP
6821#define Q_NOWARN_UNREACHABLE_PUSH
6822#define Q_NOWARN_UNREACHABLE_POP
6823
6824#endif
6825#endif
6826
6827#ifndef QGISEXTERN
6828#ifdef Q_OS_WIN
6829# define QGISEXTERN extern "C" __declspec( dllexport )
6830#else
6831# if defined(__GNUC__) || defined(__clang__)
6832# define QGISEXTERN extern "C" __attribute__ ((visibility ("default")))
6833# else
6834# define QGISEXTERN extern "C"
6835# endif
6836#endif
6837#endif
6838#endif
6839
6840// see https://infektor.net/posts/2017-01-19-using-cpp17-attributes-today.html#using-the-nodiscard-attribute
6841#if __cplusplus >= 201703L
6842#define NODISCARD [[nodiscard]]
6843#elif defined(__clang__)
6844#define NODISCARD [[nodiscard]]
6845#elif defined(_MSC_VER)
6846#define NODISCARD // no support
6847#elif defined(__has_cpp_attribute)
6848#if __has_cpp_attribute(nodiscard)
6849#define NODISCARD [[nodiscard]]
6850#elif __has_cpp_attribute(gnu::warn_unused_result)
6851#define NODISCARD [[gnu::warn_unused_result]]
6852#else
6853#define NODISCARD Q_REQUIRED_RESULT
6854#endif
6855#else
6856#define NODISCARD Q_REQUIRED_RESULT
6857#endif
6858
6859#if __cplusplus >= 201703L
6860#define MAYBE_UNUSED [[maybe_unused]]
6861#elif defined(__clang__)
6862#define MAYBE_UNUSED [[maybe_unused]]
6863#elif defined(_MSC_VER)
6864#define MAYBE_UNUSED // no support
6865#elif defined(__has_cpp_attribute)
6866#if __has_cpp_attribute(gnu::unused)
6867#define MAYBE_UNUSED [[gnu::unused]]
6868#else
6869#define MAYBE_UNUSED
6870#endif
6871#else
6872#define MAYBE_UNUSED
6873#endif
6874
6875#ifndef FINAL
6876#define FINAL final
6877#endif
6878
6879#ifndef SIP_RUN
6880#ifdef _MSC_VER
6881#define BUILTIN_UNREACHABLE \
6882 __assume(false);
6883#elif defined(__GNUC__) && !defined(__clang__)
6884// Workaround a GCC bug where a -Wreturn-type warning is emitted in constructs
6885// like:
6886// switch( mVariableThatCanOnlyBeXorY )
6887// {
6888// case X:
6889// return "foo";
6890// case Y:
6891// return "foo";
6892// }
6893// See https://gcc.gnu.org/bugzilla/show_bug.cgi?id=87951
6894#define BUILTIN_UNREACHABLE \
6895 __builtin_unreachable();
6896#else
6897#define BUILTIN_UNREACHABLE
6898#endif
6899#endif // SIP_RUN
Provides global constants and enumerations for use throughout the application.
Definition qgis.h:54
DistanceUnitType
Types of distance units.
Definition qgis.h:4906
GnssConstellation
GNSS constellation.
Definition qgis.h:1867
SettingsOption
Settings options.
Definition qgis.h:688
ProfileGeneratorFlag
Flags that control the way the QgsAbstractProfileGenerator operate.
Definition qgis.h:4069
ProcessingSourceType
Processing data source types.
Definition qgis.h:3399
GpsQualityIndicator
GPS signal quality indicator.
Definition qgis.h:1885
DataItemProviderCapability
Capabilities for data item providers.
Definition qgis.h:940
ProcessingFileParameterBehavior
Flags which dictate the behavior of QgsProcessingParameterFile.
Definition qgis.h:3639
QFlags< MapLayerRendererFlag > MapLayerRendererFlags
Flags which control how map layer renderers behave.
Definition qgis.h:2730
ProjectReadFlag
Flags which control project read behavior.
Definition qgis.h:4153
QFlags< DatabaseProviderTableImportCapability > DatabaseProviderTableImportCapabilities
Definition qgis.h:5206
QFlags< BabelCommandFlag > BabelCommandFlags
Babel command flags.
Definition qgis.h:1980
MapToolUnit
Type of unit of tolerance value from settings.
Definition qgis.h:4812
PlotAxisSuffixPlacement
Placement options for suffixes in the labels for axis of plots.
Definition qgis.h:3212
ProcessingModelChildAlgorithmExecutionStatus
Reflects the status of a child algorithm in a Processing model.
Definition qgis.h:3714
QFlags< GpsInformationComponent > GpsInformationComponents
GPS information component.
Definition qgis.h:1947
ScaleBarDistanceLabelHorizontalPlacement
Scale bar distance label horizontal placement.
Definition qgis.h:5141
PointCloudSymbol
Rendering symbols for point cloud points.
Definition qgis.h:4097
SymbolRotationMode
Modes for handling how symbol and text entity rotation is handled when maps are rotated.
Definition qgis.h:750
GeometryValidityFlag
Geometry validity check flags.
Definition qgis.h:2034
QFlags< RasterProviderCapability > RasterProviderCapabilities
Raster data provider capabilities.
Definition qgis.h:4737
ExpressionType
Expression types.
Definition qgis.h:5323
MapLayerActionFlag
Map layer action flags.
Definition qgis.h:4482
ScaleBarDistanceLabelVerticalPlacement
Scale bar distance label vertical placement.
Definition qgis.h:5127
MapLayerProperty
Generic map layer properties.
Definition qgis.h:2229
VectorProviderCapability
Vector data provider capabilities.
Definition qgis.h:463
BufferSide
Side of line to buffer.
Definition qgis.h:2059
RasterResamplingStage
Stage at which raster resampling occurs.
Definition qgis.h:1433
QFlags< MapLayerActionTarget > MapLayerActionTargets
Map layer action targets.
Definition qgis.h:4471
VectorTileProviderCapability
Enumeration with capabilities that vector tile data providers might implement.
Definition qgis.h:5369
AltitudeClamping
Altitude clamping.
Definition qgis.h:3833
VectorTileProviderFlag
Flags for vector tile data providers.
Definition qgis.h:5351
VectorTemporalMode
Vector layer temporal feature modes.
Definition qgis.h:2528
SublayerFlag
Flags which reflect the properties of sublayers in a dataset.
Definition qgis.h:1372
QFlags< ProjectCapability > ProjectCapabilities
Flags which control project capabilities.
Definition qgis.h:4194
LabelLinePlacementFlag
Line placement flags, which control how candidates are generated for a linear feature.
Definition qgis.h:1239
QFlags< UriCleaningFlag > UriCleaningFlags
Flags for cleaning layer URIs.
Definition qgis.h:1346
CoordinateDisplayType
Formats for displaying coordinates.
Definition qgis.h:4302
ProcessingParameterTypeFlag
Flags which dictate the behavior of Processing parameter types.
Definition qgis.h:3587
QFlags< VectorRenderingSimplificationFlag > VectorRenderingSimplificationFlags
Simplification flags for vector feature rendering.
Definition qgis.h:2938
DashPatternSizeAdjustment
Dash pattern size adjustment options.
Definition qgis.h:3185
GpsFixStatus
GPS fix status.
Definition qgis.h:1852
AnnotationItemNodeType
Annotation item node types.
Definition qgis.h:2455
static const char * QGIS_DEV_VERSION
The development version.
Definition qgis.h:82
VectorFileWriterCapability
Capabilities supported by a QgsVectorFileWriter object.
Definition qgis.h:1037
QFlags< MapSettingsFlag > MapSettingsFlags
Map settings flags.
Definition qgis.h:2673
CrsIdentifierType
Available identifier string types for representing coordinate reference systems.
Definition qgis.h:2365
QFlags< RasterRendererFlag > RasterRendererFlags
Flags which control behavior of raster renderers.
Definition qgis.h:1475
AngularDirection
Angular directions.
Definition qgis.h:3300
DriveType
Drive types.
Definition qgis.h:1090
UnitType
Unit types.
Definition qgis.h:4827
ContentStatus
Status for fetched or stored content.
Definition qgis.h:1808
QFlags< SelectionFlag > SelectionFlags
Flags which control feature selection behavior.
Definition qgis.h:1770
SnappingType
SnappingTypeFlag defines on what object the snapping is performed.
Definition qgis.h:713
LayoutUnit
Layout measurement units.
Definition qgis.h:5034
Q_ENUM(GpsFixStatus)
RelationshipStrength
Relationship strength.
Definition qgis.h:4255
Q_ENUM(GnssConstellation)
MarkerLinePlacement
Defines how/where the symbols should be placed on a line.
Definition qgis.h:3023
QFlags< ProjectReadFlag > ProjectReadFlags
Project load flags.
Definition qgis.h:4172
LegendComponent
Component of legends which can be styled.
Definition qgis.h:4406
Point3DShape
3D point shape types.
Definition qgis.h:3975
GeometryOperationResult
Success or failure of a geometry operation.
Definition qgis.h:2005
QFlags< StringStatistic > StringStatistics
Statistics to be calculated for string values.
Definition qgis.h:5711
BrowserItemState
Browser item states.
Definition qgis.h:902
AttributeEditorContainerType
Attribute editor container types.
Definition qgis.h:5264
QFlags< TiledSceneProviderCapability > TiledSceneProviderCapabilities
Tiled scene data provider capabilities.
Definition qgis.h:5412
FeatureRequestFilterType
Types of feature request filters.
Definition qgis.h:2172
MarkerClipMode
Marker clipping modes.
Definition qgis.h:3143
GpsNavigationStatus
GPS navigation status.
Definition qgis.h:1905
AnnotationItemFlag
Flags for annotation items.
Definition qgis.h:2412
RenderSubcomponentProperty
Rendering subcomponent properties.
Definition qgis.h:2947
ProcessingTinInputLayerType
Defines the type of input layer for a Processing TIN input.
Definition qgis.h:3729
QFlags< DataProviderFlag > DataProviderFlags
Data provider flags.
Definition qgis.h:2263
Statistic
Available generic statistics.
Definition qgis.h:5629
SymbolRenderHint
Flags controlling behavior of symbols during rendering.
Definition qgis.h:733
AngleUnit
Units of angles.
Definition qgis.h:4969
CaptureTechnique
Capture technique.
Definition qgis.h:376
SpatialIndexPresence
Enumeration of spatial index presence states.
Definition qgis.h:522
BrowserItemCapability
Browser item capabilities.
Definition qgis.h:915
AttributeFormSuppression
Available form types for layout of the attribute form editor.
Definition qgis.h:5294
QFlags< AuthConfigurationStorageCapability > AuthConfigurationStorageCapabilities
Authentication configuration storage capabilities.
Definition qgis.h:145
QFlags< LayerTreeFilterFlag > LayerTreeFilterFlags
Layer tree filter flags.
Definition qgis.h:4395
LayerTreeInsertionMethod
Layer tree insertion methods.
Definition qgis.h:4372
RasterProviderCapability
Raster data provider capabilities.
Definition qgis.h:4717
DatabaseProviderTableImportCapability
Represents capabilities of a database provider connection when importing table data.
Definition qgis.h:5201
LineClipMode
Line clipping modes.
Definition qgis.h:3157
VectorRenderingSimplificationFlag
Simplification flags for vector feature rendering.
Definition qgis.h:2923
QFlags< GeometryValidityFlag > GeometryValidityFlags
Geometry validity flags.
Definition qgis.h:2038
BrowserDirectoryMonitoring
Browser directory item monitoring switches.
Definition qgis.h:989
VsiHandlerType
GDAL VSI handler types.
Definition qgis.h:5525
SettingsTreeNodeType
Type of tree node.
Definition qgis.h:618
TilePixelRatio
DpiMode enum.
Definition qgis.h:3240
DatabaseProviderConnectionCapability2
The Capability enum represents the extended operations supported by the connection.
Definition qgis.h:5186
LabelOffsetType
Behavior modifier for label offset and distance, only applies in some label placement modes.
Definition qgis.h:1205
QFlags< ProfileGeneratorFlag > ProfileGeneratorFlags
Definition qgis.h:4075
LabelPrioritization
Label prioritization.
Definition qgis.h:1144
GradientColorSource
Gradient color sources.
Definition qgis.h:3072
FileFilterType
Type of file filters.
Definition qgis.h:1318
LabelPlacement
Placement modes which determine how label candidates are generated for a feature.
Definition qgis.h:1158
RasterLayerType
Raster layer types.
Definition qgis.h:4594
QFlags< VectorLayerTypeFlag > VectorLayerTypeFlags
Vector layer type flags.
Definition qgis.h:395
ScaleBarAlignment
Scalebar alignment.
Definition qgis.h:5098
RasterPyramidFormat
Raster pyramid formats.
Definition qgis.h:4633
VectorExportResult
Vector layer export result codes.
Definition qgis.h:1016
DistanceUnit
Units of distance.
Definition qgis.h:4844
RasterTemporalCapabilityFlag
Flags for raster layer temporal capabilities.
Definition qgis.h:2600
SymbolLayerFlag
Flags controlling behavior of symbol layers.
Definition qgis.h:844
MeshRangeLimit
Describes the limits used to compute mesh ranges (min/max values).
Definition qgis.h:5825
GradientSpread
Gradient spread options, which control how gradients are rendered outside of their start and end poin...
Definition qgis.h:3116
QFlags< AnnotationItemGuiFlag > AnnotationItemGuiFlags
Annotation item GUI flags.
Definition qgis.h:2445
LabelPolygonPlacementFlag
Polygon placement flags, which control how candidates are generated for a polygon feature.
Definition qgis.h:1264
RasterRangeLimit
Describes the limits used to compute raster ranges (min/max values).
Definition qgis.h:1507
ScaleMethod
Scale methods.
Definition qgis.h:588
SldExportOption
SLD export options.
Definition qgis.h:660
VectorSimplificationAlgorithm
Simplification algorithms for vector features.
Definition qgis.h:2907
FilePathType
File path types.
Definition qgis.h:1639
CadConstraintType
Advanced digitizing constraint type.
Definition qgis.h:3925
AttributeFormPythonInitCodeSource
The Python init code source for attribute forms.
Definition qgis.h:5309
PointCountMethod
Methods which define the number of points randomly filling a polygon.
Definition qgis.h:3131
SldExportVendorExtension
SLD export vendor extensions, allow the use of vendor extensions when exporting to SLD.
Definition qgis.h:675
MapCanvasFlag
Flags controlling behavior of map canvases.
Definition qgis.h:3326
LayerTreeFilterFlag
Layer tree filter flags.
Definition qgis.h:4385
AttributeFormLayout
Available form types for layout of the attribute form editor.
Definition qgis.h:5279
FeatureRequestFlag
Flags for controlling feature requests.
Definition qgis.h:2144
VertexType
Types of vertex.
Definition qgis.h:2960
ShaderInterpolationMethod
Color ramp shader interpolation methods.
Definition qgis.h:1388
DataProviderFlag
Generic data provider flags.
Definition qgis.h:2257
Q_ENUM(GpsNavigationStatus)
GdalResampleAlgorithm
Resampling algorithm to be used (equivalent to GDAL's enum GDALResampleAlg)
Definition qgis.h:5503
RasterResamplingMethod
Resampling method for raster provider-level resampling.
Definition qgis.h:1447
GeometryValidationEngine
Available engines for validating geometries.
Definition qgis.h:2047
TransactionMode
Transaction mode.
Definition qgis.h:3820
Q_ENUM(ScaleToTileZoomLevelMethod)
QFlags< FeatureRendererFlag > FeatureRendererFlags
Flags controlling behavior of vector feature renderers.
Definition qgis.h:802
ElevationMapCombineMethod
Methods used to select the elevation when two elevation maps are combined.
Definition qgis.h:4746
RasterDrawingStyle
Raster drawing styles.
Definition qgis.h:4610
GeosCreationFlag
Flags which control geos geometry creation behavior.
Definition qgis.h:2097
MeshRangeExtent
Describes the extent used to compute mesh ranges (min/max values).
Definition qgis.h:5837
GpsInformationComponent
GPS information component.
Definition qgis.h:1919
ViewSyncModeFlag
Synchronization of 2D map canvas and 3D view.
Definition qgis.h:3345
ProcessingProviderFlag
Flags indicating how and when an processing provider operates and should be exposed to users.
Definition qgis.h:3425
FileOperationFlag
File operation flags.
Definition qgis.h:2214
QFlags< DataItemProviderCapability > DataItemProviderCapabilities
Capabilities for data item providers.
Definition qgis.h:956
ProjectCapability
Flags which control project capabilities.
Definition qgis.h:4184
QFlags< BabelFormatCapability > BabelFormatCapabilities
Babel GPS format capabilities.
Definition qgis.h:1965
QFlags< SymbolLayerFlag > SymbolLayerFlags
Symbol layer flags.
Definition qgis.h:851
QFlags< RasterInterfaceCapability > RasterInterfaceCapabilities
Raster interface capabilities.
Definition qgis.h:4704
Q_ENUM(VectorProfileType)
AttributeActionType
Attribute action types.
Definition qgis.h:4506
TemporalNavigationMode
Temporal navigation modes.
Definition qgis.h:2482
ProcessingFieldParameterDataType
Processing field parameter data types.
Definition qgis.h:3667
AreaUnit
Units of area.
Definition qgis.h:4921
StringStatistic
Available string statistics.
Definition qgis.h:5691
FieldDomainMergePolicy
Merge policy for field domains.
Definition qgis.h:3774
ZonalStatistic
Statistics to be calculated during a zonal statistics operation.
Definition qgis.h:5544
MessageLevel
Level for messages This will be used both for message log and message bar in application.
Definition qgis.h:154
SqlKeywordCategory
SqlKeywordCategory enum represents the categories of the SQL keywords used by the SQL query editor.
Definition qgis.h:1072
QFlags< SnappingType > SnappingTypes
Snapping types.
Definition qgis.h:724
static Q_DECL_DEPRECATED QString geoWkt()
WKT string that represents a geographic coord system.
Definition qgis.h:6031
GraduatedMethod
Methods for modifying symbols by range in a graduated symbol renderer.
Definition qgis.h:3200
QFlags< LabelLinePlacementFlag > LabelLinePlacementFlags
Line placement flags, which control how candidates are generated for a linear feature.
Definition qgis.h:1254
TiledSceneBoundingVolumeType
Tiled scene bounding volume types.
Definition qgis.h:5421
TextLayoutMode
Text layout modes.
Definition qgis.h:2816
PropertyType
Property types.
Definition qgis.h:646
QFlags< RenderContextFlag > RenderContextFlags
Render context flags.
Definition qgis.h:2708
LayerFilter
Filter for layers.
Definition qgis.h:188
Q_ENUM(ProviderStyleStorageCapability)
QFlags< SublayerFlag > SublayerFlags
Sublayer flags.
Definition qgis.h:1376
RasterRendererFlag
Flags which control behavior of raster renderers.
Definition qgis.h:1465
PythonEmbeddedMode
Authorisation to run Python Embedded in projects.
Definition qgis.h:403
CrsType
Coordinate reference system types.
Definition qgis.h:2275
QFlags< GeosCreationFlag > GeosCreationFlags
Geos geometry creation behavior flags.
Definition qgis.h:2108
SensorThingsEntity
OGC SensorThings API entity types.
Definition qgis.h:5747
MeshEditingErrorType
Type of error that can occur during mesh frame editing.
Definition qgis.h:1622
FieldDomainSplitPolicy
Split policy for field domains.
Definition qgis.h:3757
ArcGisRestServiceType
Available ArcGIS REST service types.
Definition qgis.h:4222
UriCleaningFlag
Flags for cleaning layer URIs.
Definition qgis.h:1335
RasterFileWriterResult
Raster file export results.
Definition qgis.h:1605
AnnotationItemEditOperationResult
Results from an edit operation on an annotation item.
Definition qgis.h:2467
ProcessingPropertyAvailability
Property availability, used for QgsProcessingAlgorithm::VectorProperties in order to determine if pro...
Definition qgis.h:3508
MapRecenteringMode
Modes for recentering map canvases.
Definition qgis.h:3358
RasterRangeAccuracy
Describes the accuracy used to compute raster ranges (min/max values).
Definition qgis.h:1538
ActionType
Action types.
Definition qgis.h:4441
ActionStart
Enum to determine when an operation would begin.
Definition qgis.h:1107
PlaybackOperation
Media playback operations.
Definition qgis.h:2511
QFlags< SymbolLayerUserFlag > SymbolLayerUserFlags
Symbol layer user flags.
Definition qgis.h:874
QFlags< TextRendererFlag > TextRendererFlags
Definition qgis.h:3279
QueryStorageBackend
Stored query storage backends.
Definition qgis.h:3385
ProviderStyleStorageCapability
The StorageCapability enum represents the style storage operations supported by the provider.
Definition qgis.h:5215
AvoidIntersectionsMode
Flags which control how intersections of pre-existing feature are handled when digitizing new feature...
Definition qgis.h:4124
MarkerShape
Marker shapes.
Definition qgis.h:2974
LegendJsonRenderFlag
Legend JSON export flags.
Definition qgis.h:4426
BlendMode
Blending modes defining the available composition modes that can be used when painting.
Definition qgis.h:4761
RasterElevationMode
Raster layer elevation modes.
Definition qgis.h:3872
Capitalization
String capitalization options.
Definition qgis.h:3257
TemporalIntervalMatchMethod
Method to use when resolving a temporal range to a data provider layer or band.
Definition qgis.h:2585
PictureFormat
Picture formats.
Definition qgis.h:5068
QFlags< LabelPolygonPlacementFlag > LabelPolygonPlacementFlags
Polygon placement flags, which control how candidates are generated for a polygon feature.
Definition qgis.h:1276
LabelQuadrantPosition
Label quadrant positions.
Definition qgis.h:1219
QFlags< PlotToolFlag > PlotToolFlags
Definition qgis.h:3963
ScaleToTileZoomLevelMethod
Available methods for converting map scales to tile zoom levels.
Definition qgis.h:3288
SublayerQueryFlag
Flags which control how data providers will scan for sublayers in a dataset.
Definition qgis.h:1355
QFlags< VectorFileWriterCapability > VectorFileWriterCapabilities
Capabilities supported by a QgsVectorFileWriter object.
Definition qgis.h:1047
TextOrientation
Text orientations.
Definition qgis.h:2801
TemporalUnit
Temporal units.
Definition qgis.h:4990
QFlags< RasterRendererCapability > RasterRendererCapabilities
Raster renderer capabilities.
Definition qgis.h:1496
QFlags< SymbolPreviewFlag > SymbolPreviewFlags
Symbol preview flags.
Definition qgis.h:831
UnplacedLabelVisibility
Unplaced label visibility.
Definition qgis.h:1119
CrsDefinitionFormat
CRS definition formats.
Definition qgis.h:3742
SpatialFilterType
Feature request spatial filter types.
Definition qgis.h:2201
VerticalAnchorPoint
Marker symbol vertical anchor points.
Definition qgis.h:778
QFlags< ProcessingParameterTypeFlag > ProcessingParameterTypeFlags
Flags which dictate the behavior of Processing parameter types.
Definition qgis.h:3602
TileAvailability
Possible availability states for a tile within a tile matrix.
Definition qgis.h:5388
ProjectFlag
Flags which control the behavior of QgsProjects.
Definition qgis.h:3943
FeatureRendererFlag
Flags controlling behavior of vector feature renderers.
Definition qgis.h:792
static Q_DECL_DEPRECATED QString geoProj4()
PROJ4 string that represents a geographic coord system.
Definition qgis.h:6042
BrowserItemType
Browser item types.
Definition qgis.h:883
QFlags< FeatureRequestFlag > FeatureRequestFlags
Flags for controlling feature requests.
Definition qgis.h:2161
SettingsType
Types of settings entries.
Definition qgis.h:599
QFlags< SettingsOption > SettingsOptions
Definition qgis.h:693
RasterTemporalMode
Raster layer temporal modes.
Definition qgis.h:2569
RasterAttributeTableType
The RasterAttributeTableType enum represents the type of RAT.
Definition qgis.h:1579
LabelingFlag
Various flags that affect drawing and placement of labels.
Definition qgis.h:2756
GeometryType
The geometry types are used to group Qgis::WkbType in a coarse way.
Definition qgis.h:337
RelationshipType
Relationship types.
Definition qgis.h:4241
ScriptLanguageCapability
Script language capabilities.
Definition qgis.h:4351
RasterInterfaceCapability
Raster interface capabilities.
Definition qgis.h:4684
JoinStyle
Join styles for buffers.
Definition qgis.h:2084
PointCloudDrawOrder
Pointcloud rendering order for 2d views.
Definition qgis.h:4109
QFlags< RasterBandStatistic > RasterBandStatistics
Statistics to be calculated for raster bands.
Definition qgis.h:5738
ProcessingAlgorithmDocumentationFlag
Flags describing algorithm behavior for documentation purposes.
Definition qgis.h:3485
TextCharacterVerticalAlignment
Text vertical alignment for characters.
Definition qgis.h:2892
FieldDuplicatePolicy
Duplicate policy for fields.
Definition qgis.h:3794
UserProfileSelectionPolicy
User profile selection policy.
Definition qgis.h:5230
QFlags< FileOperationFlag > FileOperationFlags
File operation flags.
Definition qgis.h:2219
DpiMode
DpiMode enum.
Definition qgis.h:3226
Q_ENUM(ProfileExportType)
BrowserLayerType
Browser item layer types.
Definition qgis.h:965
QFlags< ProcessingAlgorithmFlag > ProcessingAlgorithmFlags
Flags indicating how and when an algorithm operates and should be exposed to users.
Definition qgis.h:3476
AltitudeBinding
Altitude binding.
Definition qgis.h:3846
QFlags< DataProviderReadFlag > DataProviderReadFlags
Flags which control data provider construction.
Definition qgis.h:450
Q_ENUM(ProcessingProviderFlag)
TiledSceneRendererFlag
Flags which control how tiled scene 2D renderers behave.
Definition qgis.h:5481
MapLayerActionTarget
Map layer action targets.
Definition qgis.h:4456
ShaderClassificationMethod
Color ramp shader classification methods.
Definition qgis.h:1403
ZonalStatisticResult
Zonal statistics result codes.
Definition qgis.h:5579
ScriptLanguage
Scripting languages.
Definition qgis.h:4328
QFlags< BrowserItemCapability > BrowserItemCapabilities
Browser item capabilities.
Definition qgis.h:929
FeatureAvailability
Possible return value for QgsFeatureSource::hasFeatures() to determine if a source is empty.
Definition qgis.h:541
TiledSceneProviderCapability
Tiled scene data provider capabilities.
Definition qgis.h:5402
LabelMultiLineAlignment
Text alignment for multi-line labels.
Definition qgis.h:1302
RasterBandStatistic
Available raster band statistics.
Definition qgis.h:5720
QFlags< VectorTileProviderCapability > VectorTileProviderCapabilities
Vector tile data provider capabilities.
Definition qgis.h:5379
AuthConfigurationStorageCapability
Authentication configuration storage capabilities.
Definition qgis.h:100
PythonEmbeddedType
Type of Python Embedded in projects.
Definition qgis.h:417
QFlags< ZonalStatistic > ZonalStatistics
Statistics to be calculated during a zonal statistics operation.
Definition qgis.h:5570
VectorDataProviderTemporalMode
Vector data provider temporal handling modes.
Definition qgis.h:2556
TextRenderFormat
Options for rendering text.
Definition qgis.h:2741
DocumentationBrowser
Documentation API browser.
Definition qgis.h:5793
DataType
Raster data types.
Definition qgis.h:351
Q_ENUM(ProfileSurfaceSymbology)
QFlags< ViewSyncModeFlag > ViewSyncModeFlags
Definition qgis.h:3350
QFlags< SublayerQueryFlag > SublayerQueryFlags
Sublayer query flags.
Definition qgis.h:1362
SystemOfMeasurement
Systems of unit measurement.
Definition qgis.h:4797
RasterAttributeTableFieldUsage
The RasterAttributeTableFieldUsage enum represents the usage of a Raster Attribute Table field.
Definition qgis.h:1550
VerticalAxisInversion
Vertical axis inversion options for 3D views.
Definition qgis.h:4031
QFlags< CoordinateTransformationFlag > CoordinateTransformationFlags
Coordinate transformation flags.
Definition qgis.h:2642
RelationshipCapability
Relationship capabilities.
Definition qgis.h:4281
RasterBuildPyramidOption
Raster pyramid building options.
Definition qgis.h:4648
QFlags< VectorProviderCapability > VectorProviderCapabilities
Vector data provider capabilities.
Definition qgis.h:500
NavigationMode
The navigation mode used by 3D cameras.
Definition qgis.h:4006
LinearReferencingPlacement
Defines how/where the labels should be placed in a linear referencing symbol layer.
Definition qgis.h:3043
TileChildrenAvailability
Possible availability states for a tile's children.
Definition qgis.h:5449
PointCloudZoomOutRenderBehavior
Point cloud zoom out options.
Definition qgis.h:5862
LayerType
Types of layers that can be added to a map.
Definition qgis.h:169
QFlags< AnnotationItemFlag > AnnotationItemFlags
Annotation item flags.
Definition qgis.h:2418
FieldOrigin
Field origin.
Definition qgis.h:1667
LinearReferencingLabelSource
Defines what quantity to use for the labels shown in a linear referencing symbol layer.
Definition qgis.h:3057
RasterRangeExtent
Describes the extent used to compute raster ranges (min/max values).
Definition qgis.h:1523
QFlags< Statistic > Statistics
Statistics to be calculated for generic values.
Definition qgis.h:5657
PlotToolFlag
Flags that control the way the QgsPlotTools operate.
Definition qgis.h:3959
RenderUnit
Rendering size units.
Definition qgis.h:5014
static QString geographicCrsAuthId()
Geographic coordinate system auth:id string for a default geographic CRS (EPSG:4326).
Definition qgis.h:6022
CoordinateOrder
Order of coordinates.
Definition qgis.h:2350
SelectionFlag
Flags which control feature selection behavior.
Definition qgis.h:1760
QFlags< SettingsTreeNodeOption > SettingsTreeNodeOptions
Definition qgis.h:635
EndCapStyle
End cap styles for buffers.
Definition qgis.h:2071
ScaleCalculationMethod
Scale calculation logic.
Definition qgis.h:5081
QFlags< TiledSceneRequestFlag > TiledSceneRequestFlags
Flags which control how tiled scene requests behave.
Definition qgis.h:5472
QFlags< MapLayerActionFlag > MapLayerActionFlags
Map layer action flags.
Definition qgis.h:4495
QFlags< MapLayerProperty > MapLayerProperties
Map layer properties.
Definition qgis.h:2234
QFlags< LoadStyleFlag > LoadStyleFlags
Flags for loading layer styles.
Definition qgis.h:225
BabelCommandFlag
Babel command flags, which control how commands and arguments are generated for executing GPSBabel pr...
Definition qgis.h:1976
QFlags< LabelingFlag > LabelingFlags
Flags that affect drawing and placement of labels.
Definition qgis.h:2776
FieldDomainType
Types of field domain.
Definition qgis.h:3807
MapLayerRendererFlag
Flags which control how map layer renderers behave.
Definition qgis.h:2718
RenderContextFlag
Flags which affect rendering operations.
Definition qgis.h:2683
RasterPipeInterfaceRole
Raster pipe interface roles.
Definition qgis.h:1416
CoverageValidityResult
Coverage validity results.
Definition qgis.h:2117
DataProviderReadFlag
Flags which control data provider construction.
Definition qgis.h:431
ScaleBarSegmentSizeMode
Modes for setting size for scale bar segments.
Definition qgis.h:5113
Aggregate
Available aggregates to calculate.
Definition qgis.h:5597
SymbolPreviewFlag
Flags for controlling how symbol preview images are generated.
Definition qgis.h:826
AnnotationItemGuiFlag
Flags for controlling how an annotation item behaves in the GUI.
Definition qgis.h:2441
MapBoxGlStyleSourceType
Available MapBox GL style source types.
Definition qgis.h:4203
LayoutUnitType
Types of layout units.
Definition qgis.h:5054
VectorDataProviderAttributeEditCapability
Attribute editing capabilities which may be supported by vector data providers.
Definition qgis.h:554
DashPatternLineEndingRule
Dash pattern line ending rules.
Definition qgis.h:3170
FieldMetadataProperty
Standard field metadata values.
Definition qgis.h:1708
TiledSceneRequestFlag
Flags which control how tiled scene requests behave.
Definition qgis.h:5462
RasterRendererCapability
Raster renderer capabilities.
Definition qgis.h:1486
VertexMarkerType
Editing vertex markers, used for showing vertices during a edit operation.
Definition qgis.h:1796
HistoryProviderBackend
History provider backends.
Definition qgis.h:3371
RasterExportType
Raster file export types.
Definition qgis.h:1592
SublayerPromptMode
Specifies how to handle layer sources with multiple sublayers.
Definition qgis.h:1651
TextVerticalAlignment
Text vertical alignment.
Definition qgis.h:2876
RelationshipCardinality
Relationship cardinality.
Definition qgis.h:4267
GradientType
Gradient types.
Definition qgis.h:3086
QFlags< ScriptLanguageCapability > ScriptLanguageCapabilities
Script language capabilities.
Definition qgis.h:4363
VectorProfileType
Types of elevation profiles to generate for vector sources.
Definition qgis.h:4057
GpsFeatureType
GPS feature types.
Definition qgis.h:1990
VectorLayerTypeFlag
Vector layer type flags.
Definition qgis.h:390
MakeValidMethod
Algorithms to use when repairing invalid geometries.
Definition qgis.h:2130
RangeLimits
Describes how the limits of a range are handled.
Definition qgis.h:3858
QFlags< ProjectFlag > ProjectFlags
Definition qgis.h:3950
VectorTemporalLimitMode
Mode for the handling of the limits of the filtering timeframe for vector features.
Definition qgis.h:2544
QFlags< ProcessingParameterFlag > ProcessingParameterFlags
Flags which dictate the behavior of Processing parameters.
Definition qgis.h:3628
SqlLayerDefinitionCapability
SqlLayerDefinitionCapability enum lists the arguments supported by the provider when creating SQL que...
Definition qgis.h:1055
VectorEditResult
Specifies the result of a vector layer edit operation.
Definition qgis.h:1781
QFlags< VectorDataProviderAttributeEditCapability > VectorDataProviderAttributeEditCapabilities
Attribute editing capabilities which may be supported by vector data providers.
Definition qgis.h:566
Axis
Cartesian axes.
Definition qgis.h:2399
QFlags< ProcessingAlgorithmDocumentationFlag > ProcessingAlgorithmDocumentationFlags
Flags describing algorithm behavior for documentation purposes.
Definition qgis.h:3496
QFlags< RelationshipCapability > RelationshipCapabilities
Relationship capabilities.
Definition qgis.h:4293
QFlags< SymbolRenderHint > SymbolRenderHints
Symbol render hints.
Definition qgis.h:741
VolumeUnit
Units of volume.
Definition qgis.h:4946
AttributeEditorType
Attribute editor types.
Definition qgis.h:5245
QFlags< LegendJsonRenderFlag > LegendJsonRenderFlags
Definition qgis.h:4430
QFlags< ProviderStyleStorageCapability > ProviderStyleStorageCapabilities
Definition qgis.h:5221
SymbolLayerUserFlag
User-specified flags controlling behavior of symbol layers.
Definition qgis.h:864
InvalidGeometryCheck
Methods for handling of features with invalid geometries.
Definition qgis.h:2188
QFlags< SymbolFlag > SymbolFlags
Symbol flags.
Definition qgis.h:817
QFlags< ProcessingFeatureSourceDefinitionFlag > ProcessingFeatureSourceDefinitionFlags
Flags which control behavior for a Processing feature source.
Definition qgis.h:3550
PointCloudAccessType
The access type of the data, local is for local files and remote for remote files (over HTTP).
Definition qgis.h:5851
ProfileExportType
Types of export for elevation profiles.
Definition qgis.h:4084
MeshElevationMode
Mesh layer elevation modes.
Definition qgis.h:3886
ProjectFileFormat
Flags which control project read behavior.
Definition qgis.h:4139
SnappingMode
SnappingMode defines on which layer the snapping is performed.
Definition qgis.h:701
SymbolType
Symbol types.
Definition qgis.h:574
RasterColorInterpretation
Raster color interpretation.
Definition qgis.h:4543
ProfileSurfaceSymbology
Surface symbology type for elevation profile plots.
Definition qgis.h:4044
LabelPlacementEngineVersion
Labeling placement engine version.
Definition qgis.h:2787
Q_ENUM(ProcessingAlgorithmFlag)
ColorModel
Color model types.
Definition qgis.h:5767
RendererUsage
Usage of the renderer.
Definition qgis.h:3313
SettingsTreeNodeOption
Options for named list nodes.
Definition qgis.h:630
BabelFormatCapability
Babel GPS format capabilities.
Definition qgis.h:1957
PostgresRelKind
Postgres database relkind options.
Definition qgis.h:5165
SegmentCalculationMethod
brief Method used to calculate the number of segments for circle approximation
Definition qgis.h:5874
GpsConnectionType
GPS connection types.
Definition qgis.h:1823
Q_ENUM(InputControllerType)
QFlags< DatabaseProviderConnectionCapability2 > DatabaseProviderConnectionCapabilities2
Definition qgis.h:5192
MouseHandlesAction
Action to be performed by the mouse handles.
Definition qgis.h:5805
ProcessingFeatureSourceDefinitionFlag
Flags which control behavior for a Processing feature source.
Definition qgis.h:3537
QFlags< TextComponent > TextComponents
Text components.
Definition qgis.h:2846
LoadStyleFlag
Flags for loading layer styles.
Definition qgis.h:215
BetweenLineConstraint
Between line constraints which can be enabled.
Definition qgis.h:3899
QFlags< VectorTileProviderFlag > VectorTileProviderFlags
Vector tile data provider flags.
Definition qgis.h:5361
MetadataDateType
Date types for metadata.
Definition qgis.h:4524
QFlags< RasterTemporalCapabilityFlag > RasterTemporalCapabilityFlags
Flags for raster layer temporal capabilities.
Definition qgis.h:2610
ProcessingFeatureSourceFlag
Flags which control how QgsProcessingFeatureSource fetches features.
Definition qgis.h:3561
RasterIdentifyFormat
Raster identify formats.
Definition qgis.h:4663
TextHorizontalAlignment
Text horizontal alignment.
Definition qgis.h:2857
SymbolFlag
Flags controlling behavior of symbols.
Definition qgis.h:811
LineExtensionSide
Designates whether the line extension constraint is currently soft locked with the previous or next v...
Definition qgis.h:3912
HttpMethod
Different methods of HTTP requests.
Definition qgis.h:1001
WkbType
The WKB type describes the number of dimensions a geometry has.
Definition qgis.h:256
QFlags< SldExportOption > SldExportOptions
Definition qgis.h:666
SymbolCoordinateReference
Symbol coordinate reference modes.
Definition qgis.h:3101
QFlags< ProcessingProviderFlag > ProcessingProviderFlags
Flags indicating how and when an processing provider operates and should be exposed to users.
Definition qgis.h:3438
TileRefinementProcess
Tiled scene tile refinement processes.
Definition qgis.h:5437
QFlags< DateTimeStatistic > DateTimeStatistics
Statistics to be calculated for date/time values.
Definition qgis.h:5682
SelectionRenderingMode
Specifies how a selection should be rendered.
Definition qgis.h:1721
InputControllerType
Input controller types.
Definition qgis.h:5153
TextRendererFlag
Flags which control the behavior of rendering text.
Definition qgis.h:3275
SelectGeometryRelationship
Geometry relationship test to apply for selecting features.
Definition qgis.h:1748
CrsAxisDirection
Coordinate reference system axis directions.
Definition qgis.h:2300
ProcessingModelChildParameterSource
Processing model child parameter sources.
Definition qgis.h:3698
QFlags< MarkerLinePlacement > MarkerLinePlacements
Definition qgis.h:3034
QFlags< MapCanvasFlag > MapCanvasFlags
Flags controlling behavior of map canvases.
Definition qgis.h:3336
CrsWktVariant
Coordinate reference system WKT formatting variants.
Definition qgis.h:2380
QFlags< TiledSceneRendererFlag > TiledSceneRendererFlags
Flags which control how tiled scene 2D renderers behave.
Definition qgis.h:5494
DocumentationApi
Documentation API.
Definition qgis.h:5779
AutoRefreshMode
Map layer automatic refresh modes.
Definition qgis.h:2244
AnnotationPlacementMode
Annotation item placement modes.
Definition qgis.h:2428
ProcessingAlgorithmFlag
Flags indicating how and when an algorithm operates and should be exposed to users.
Definition qgis.h:3449
SceneMode
The 3D scene mode used in 3D map views.
Definition qgis.h:4019
FieldConfigurationFlag
Configuration flags for fields These flags are meant to be user-configurable and are not describing a...
Definition qgis.h:1684
SettingsOrigin
The setting origin describes where a setting is stored.
Definition qgis.h:4315
HorizontalAnchorPoint
Marker symbol horizontal anchor points.
Definition qgis.h:764
ProcessingParameterFlag
Flags which dictate the behavior of Processing parameters.
Definition qgis.h:3613
LabelOverlapHandling
Label overlap handling.
Definition qgis.h:1131
FeatureSymbologyExport
Options for exporting features considering their symbology.
Definition qgis.h:5338
QFlags< LayerFilter > LayerFilters
Definition qgis.h:206
ProcessingDateTimeParameterDataType
Processing date time parameter data types.
Definition qgis.h:3685
CoordinateTransformationFlag
Flags which adjust the coordinate transformations behave.
Definition qgis.h:2631
TextComponent
Text components.
Definition qgis.h:2833
DateTimeStatistic
Available date/time statistics.
Definition qgis.h:5666
AnimationState
Animation states.
Definition qgis.h:2498
TransformDirection
Indicates the direction (forward or inverse) of a transform.
Definition qgis.h:2619
LightSourceType
Light source types for 3D scenes.
Definition qgis.h:3994
QFlags< ProcessingFeatureSourceFlag > ProcessingFeatureSourceFlags
Flags which control how QgsProcessingFeatureSource fetches features.
Definition qgis.h:3573
QFlags< HistoryProviderBackend > HistoryProviderBackends
Definition qgis.h:3376
LabelPredefinedPointPosition
Positions for labels when using the Qgis::LabelPlacement::OrderedPositionsAroundPoint placement mode.
Definition qgis.h:1179
QFlags< FieldConfigurationFlag > FieldConfigurationFlags
Configuration flags for fields These flags are meant to be user-configurable and are not describing a...
Definition qgis.h:1699
UpsideDownLabelHandling
Handling techniques for upside down labels.
Definition qgis.h:1287
DeviceConnectionStatus
GPS connection status.
Definition qgis.h:1837
ProcessingNumberParameterType
Processing numeric parameter data types.
Definition qgis.h:3653
MapSettingsFlag
Flags which adjust the way maps are rendered.
Definition qgis.h:2651
QFlags< SqlLayerDefinitionCapability > SqlLayerDefinitionCapabilities
SQL layer definition capabilities.
Definition qgis.h:1063
ProcessingLogLevel
Logging level for algorithms to use when pushing feedback messages.
Definition qgis.h:3522
SelectBehavior
Specifies how a selection should be applied.
Definition qgis.h:1734
Utility class that encapsulates an action based on vector attributes.
Definition qgsaction.h:37
Utility class for calculating aggregates for a field (or expression) over the features from a vector ...
Utility functions for working with ArcGIS REST services.
An abstract base class for any elements of a drag and drop form.
A ramp shader will color a raster pixel based on a list of values ranges in a ramp.
Represents a coordinate reference system (CRS).
Handles coordinate transforms between two coordinate systems.
Abstract base class for curved geometry type.
Definition qgscurve.h:35
Base class for all items in the model.
Definition qgsdataitem.h:46
Abstract base class for spatial data provider implementations.
Calculator for summary statistics and aggregates for a list of datetimes.
Contains configuration settings for an editor form.
Wraps a request for features to a vector layer (or directly its vector data provider).
An interface for objects which provide features via a getFeatures method.
Container of fields for a vector layer.
Definition qgsfields.h:46
A geometry is the spatial representation of a feature.
Encapsulates information relating to a GPS position fix.
A fill symbol layer which draws a smooth color gradient over a polygon.
A vector feature renderer which uses numeric attributes to classify features into different ranges.
Stores global configuration for labeling engine.
Contains constants and enums relating to labeling.
Definition qgslabeling.h:32
A browser item that represents a layer that can be opened with one of the providers.
A layout item subclass that displays SVG files or raster format images (jpg, png, ....
Contains detailed styling information relating to how a layout legend should be rendered.
A proxy model which provides an easy to use model to display the list of layers in widgets.
Base class for all map layer types.
Definition qgsmaplayer.h:77
Contains configuration for rendering maps.
Abstract base class for marker symbol layers.
Registry for temporary fetched files.
Contains miscellaneous painting utility functions.
Definition qgspainting.h:32
Contains settings for how a map layer will be labeled.
Abstract base class for 2d point cloud renderers.
Abstract base class for processing algorithms.
Contains information about the context in which a processing algorithm is executed.
Encapsulates settings relating to a feature source input to a processing algorithm.
QgsFeatureSource subclass which proxies methods to an underlying QgsFeatureSource,...
A datetime (or pure date or time) parameter for processing algorithms.
Base class for the definition of processing parameters.
A vector layer or feature source field parameter for processing algorithms.
An input file or folder parameter for processing algorithms.
A numeric parameter for processing algorithms.
A parameter for processing algorithms that need a list of input vector layers to construct a TIN.
Makes metadata of processing parameters available.
Abstract base class for processing providers.
Contains enumerations and other constants for use in processing algorithms and parameters.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition qgsproject.h:107
A store for object properties.
Holds data provider key, description, and associated shared library file or function pointer informat...
A fill symbol layer which places markers at random locations within polygons.
The RasterBandStats struct is a container for statistics about a single raster band.
Implementation of data provider temporal properties for QgsRasterDataProviders.
Base class for raster data providers.
The raster file writer which allows you to save a raster to a new file.
Base class for processing filters like renderers, reprojector, resampler etc.
Implementation of map layer temporal properties for raster layers.
Represents a raster layer.
Describes the origin of minimum and maximum values in a raster.
Contains a pipeline of raster interfaces for sequential raster processing.
Raster namespace.
Definition qgsraster.h:32
Represents a relationship between two vector layers.
Definition qgsrelation.h:44
Contains information about the context of a rendering operation.
Stores the appearance and layout settings for scalebar drawing with QgsScaleBarRenderer.
Represents a settings entry and provides methods for reading and writing settings values.
RAII signal blocking class.
Definition qgis.h:6151
Object * operator->()
Returns pointer to blocked QObject.
Definition qgis.h:6169
QgsSignalBlocker(Object *object)
Constructor for QgsSignalBlocker.
Definition qgis.h:6158
Abstract base class for simple marker symbol layers.
Stores configuration of snapping settings for the project.
Calculator for summary statistics for a list of doubles.
Calculator for summary statistics and aggregates for a list of strings.
Utility functions for working with strings.
Contains utility functions for working with symbols and symbol layers.
Abstract base class for all rendered symbols.
Definition qgssymbol.h:231
Base class for templated line symbols, e.g.
Implements a temporal controller based on a frame by frame navigation and animation.
Container for all settings relating to text rendering.
Handles rendering text using rich formatting options, including drop shadows, buffers and background ...
Provides calculations for tolerance values in map units.
Helper functions for various unit types.
Implementation of data provider temporal properties for QgsVectorDataProviders.
Base class for vector data providers.
A convenience class for writing vector layers to disk based formats (e.g.
A convenience class for exporting vector layers to a destination data provider.
Implementation of map layer temporal properties for vector layers.
Represents a vector layer which manages a vector based dataset.
Contains settings for simplifying geometries fetched from a vector layer.
Handles storage of information regarding WKB types and their properties.
Definition qgswkbtypes.h:42
FeatureCountState
Enumeration of feature count states.
Definition qgis.h:509
@ Points
Point based rendering, requires point data.
As part of the API refactoring and improvements which landed in QGIS
Q_DECL_DEPRECATED const long GEOCRS_ID
Numeric ID for the EPSG:4326 geographic coordinate system in QGIS internal srs database.
Definition qgis.h:6772
Q_DECL_DEPRECATED CORE_EXPORT QString qgsVsiPrefix(const QString &path)
Returns a the vsi prefix which corresponds to a file path, or an empty string if the path is not asso...
Definition qgis.cpp:202
CORE_EXPORT uint qHash(const QVariant &variant)
Hash for QVariant.
Definition qgis.cpp:207
bool operator>(const QVariant &v1, const QVariant &v2)
Compares two QVariant values and returns whether the first is greater than the second.
Definition qgis.h:6674
CORE_EXPORT bool qgsVariantEqual(const QVariant &lhs, const QVariant &rhs)
Compares two QVariant values and returns whether they are equal, two NULL values are always treated a...
Definition qgis.cpp:256
Q_DECL_DEPRECATED const long GEOSRID
Numeric ID for the EPSG:4326 geographic coordinate system.
Definition qgis.h:6765
T qgsEnumKeyToValue(const QString &key, const T &defaultValue, bool tryValueAsKey=true, bool *returnOk=nullptr)
Returns the value corresponding to the given key of an enum.
Definition qgis.h:6497
QString qgsDoubleToString(double a, int precision=17)
Returns a string representation of a double.
Definition qgis.h:6204
QString qgsMapJoinValues(const QMap< Key, Value > &map, const QString &separator)
Joins all the map values into a single string with each element separated by the given separator.
Definition qgis.h:6361
QString qgsEnumValueToKey(const T &value, bool *returnOk=nullptr)
Returns the value for the given key of an enum.
Definition qgis.h:6478
QString qgsFlagValueToKeys(const T &value, bool *returnOk=nullptr)
Returns the value for the given keys of a flag.
Definition qgis.h:6536
QString qgsMapJoinKeys(const QMap< Key, Value > &map, const QString &separator)
Joins all the map keys into a single string with each element separated by the given separator.
Definition qgis.h:6344
T qgsFlagKeysToValue(const QString &keys, const T &defaultValue, bool tryValueAsKey=true, bool *returnOk=nullptr)
Returns the value corresponding to the given keys of a flag.
Definition qgis.h:6558
CORE_EXPORT bool qgsVariantGreaterThan(const QVariant &lhs, const QVariant &rhs)
Compares two QVariant values and returns whether the first is greater than the second.
Definition qgis.cpp:197
unsigned long long qgssize
Qgssize is used instead of size_t, because size_t is stdlib type, unknown by SIP, and it would be har...
Definition qgis.h:6791
const QMap< T, QString > qgsEnumMap()
Returns a map of all enum entries.
Definition qgis.h:6461
bool qgsFloatNear(float a, float b, float epsilon=4 *FLT_EPSILON)
Compare two floats (but allow some difference)
Definition qgis.h:6298
QString qgsSetJoin(const QSet< T > &set, const QString &separator)
Joins all the set values into a single string with each element separated by the given separator.
Definition qgis.h:6378
CORE_EXPORT double qgsPermissiveToDouble(QString string, bool &ok)
Converts a string to a double in a permissive way, e.g., allowing for incorrect numbers of digits bet...
Definition qgis.cpp:81
const QList< T > qgsEnumList()
Returns a list all enum entries.
Definition qgis.h:6444
double qgsRound(double number, int places)
Returns a double number, rounded (as close as possible) to the specified number of places.
Definition qgis.h:6328
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference)
Definition qgis.h:6287
bool qgsNanCompatibleEquals(double a, double b)
Compare two doubles, treating nan values as equal.
Definition qgis.h:6249
QgsSignalBlocker< Object > whileBlocking(Object *object)
Temporarily blocks signals from a QObject while calling a single method from the object.
Definition qgis.h:6191
void CORE_EXPORT * qgsMalloc(size_t size)
Allocates size bytes and returns a pointer to the allocated memory.
Definition qgis.cpp:102
QMap< QString, QString > QgsStringMap
Definition qgis.h:6781
Q_DECL_DEPRECATED const long GEO_EPSG_CRS_ID
Numeric ID for the EPSG:4326 geographic coordinate system.
Definition qgis.h:6779
bool qgsDoubleNearSig(double a, double b, int significantDigits=10)
Compare two doubles using specified number of significant digits.
Definition qgis.h:6304
void CORE_EXPORT qgsFree(void *ptr)
Frees the memory space pointed to by ptr.
Definition qgis.cpp:124
bool qgsNumberNear(T a, T b, T epsilon=std::numeric_limits< T >::epsilon() *4)
Compare two numbers of type T (but allow some difference)
Definition qgis.h:6269
CORE_EXPORT qlonglong qgsPermissiveToLongLong(QString string, bool &ok)
Converts a string to an qlonglong in a permissive way, e.g., allowing for incorrect numbers of digits...
Definition qgis.cpp:95
CORE_EXPORT int qgsPermissiveToInt(QString string, bool &ok)
Converts a string to an integer in a permissive way, e.g., allowing for incorrect numbers of digits b...
Definition qgis.cpp:88
CORE_EXPORT bool qgsVariantLessThan(const QVariant &lhs, const QVariant &rhs)
Compares two QVariant values and returns whether the first is less than the second.
Definition qgis.cpp:129
#define QHASH_FOR_CLASS_ENUM(T)
Definition qgis.h:43
bool operator<(const QVariant &v1, const QVariant &v2)
Compares two QVariant values and returns whether the first is less than the second.
Definition qgis.h:6688
#define SIP_DEPRECATED
Definition qgis_sip.h:106
#define SIP_ENUM_BASETYPE(type)
Definition qgis_sip.h:278
#define SIP_SKIP
Definition qgis_sip.h:126
#define SIP_MONKEYPATCH_SCOPEENUM_UNNEST(OUTSIDE_CLASS, FORMERNAME)
Definition qgis_sip.h:271
#define SIP_MONKEYPATCH_FLAGS_UNNEST(OUTSIDE_CLASS, FORMERNAME)
Definition qgis_sip.h:272
#define SIP_MONKEYPATCH_SCOPEENUM
Definition qgis_sip.h:270
#define SIP_MONKEYPATCH_COMPAT_NAME(FORMERNAME)
Definition qgis_sip.h:273
Q_DECLARE_OPERATORS_FOR_FLAGS(QgsTextRendererUtils::CurvedTextFlags)
int precision
Utility class for identifying a unique vertex within a geometry.
Definition qgsvertexid.h:30