QGIS API Documentation 3.43.0-Master (3ee7834ace6)
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 };
3779 Q_ENUM( FieldDomainMergePolicy )
3780
3781
3788 enum class FieldDuplicatePolicy : int
3789 {
3790 DefaultValue,
3791 Duplicate,
3792 UnsetField,
3793 };
3794 Q_ENUM( FieldDuplicatePolicy )
3795
3796
3801 enum class FieldDomainType : int
3802 {
3803 Coded,
3804 Range,
3805 Glob,
3806 };
3807 Q_ENUM( FieldDomainType )
3808
3809
3814 enum class TransactionMode : int
3815 {
3816 Disabled = 0,
3817 AutomaticGroups = 1,
3818 BufferedGroups = 2,
3819 };
3820 Q_ENUM( TransactionMode )
3821
3822
3827 enum class AltitudeClamping : int
3828 {
3829 Absolute,
3830 Relative,
3831 Terrain,
3832 };
3833 Q_ENUM( AltitudeClamping )
3834
3835
3840 enum class AltitudeBinding : int
3841 {
3842 Vertex,
3843 Centroid,
3844 };
3845 Q_ENUM( AltitudeBinding )
3846
3847
3852 enum class RangeLimits : int
3853 {
3854 IncludeBoth = 0,
3855 IncludeLowerExcludeUpper,
3856 ExcludeLowerIncludeUpper,
3857 ExcludeBoth,
3858 };
3859 Q_ENUM( RangeLimits )
3860
3861
3866 enum class RasterElevationMode : int
3867 {
3868 FixedElevationRange = 0,
3869 RepresentsElevationSurface = 1,
3870 FixedRangePerBand = 2,
3871 DynamicRangePerBand = 3,
3872 };
3873 Q_ENUM( RasterElevationMode )
3874
3875
3880 enum class MeshElevationMode : int
3881 {
3882 FixedElevationRange = 0,
3883 FromVertices = 1,
3884 FixedRangePerGroup = 2,
3885 };
3886 Q_ENUM( MeshElevationMode )
3887
3888
3894 {
3895 NoConstraint,
3896 Perpendicular,
3897 Parallel
3898 };
3899 Q_ENUM( BetweenLineConstraint )
3900
3901
3906 enum class LineExtensionSide : int
3907 {
3908 BeforeVertex,
3909 AfterVertex,
3910 NoVertex,
3911 };
3912 Q_ENUM( LineExtensionSide )
3913
3914
3915
3919 enum class CadConstraintType : int
3920 {
3921 Generic,
3922 Angle,
3923 Distance,
3924 XCoordinate,
3925 YCoordinate,
3926 ZValue,
3927 MValue,
3928 };
3929 Q_ENUM( CadConstraintType )
3930
3931
3932
3937 enum class ProjectFlag : int SIP_ENUM_BASETYPE( IntFlag )
3938 {
3939 EvaluateDefaultValuesOnProviderSide = 1 << 0,
3940 TrustStoredLayerStatistics = 1 << 1,
3941 RememberLayerEditStatusBetweenSessions = 1 << 2,
3942 RememberAttributeTableWindowsBetweenSessions = 1 << 3,
3943 };
3944 Q_ENUM( ProjectFlag )
3945 Q_DECLARE_FLAGS( ProjectFlags, ProjectFlag )
3946 Q_FLAG( ProjectFlags )
3947
3953 enum class PlotToolFlag : int SIP_ENUM_BASETYPE( IntFlag )
3954 {
3955 ShowContextMenu = 1 << 0,
3956 };
3957 Q_ENUM( PlotToolFlag )
3958 Q_DECLARE_FLAGS( PlotToolFlags, PlotToolFlag )
3959 Q_FLAG( PlotToolFlags )
3960
3961
3969 enum class Point3DShape : int
3970 {
3971 Cylinder,
3972 Sphere,
3973 Cone,
3974 Cube,
3975 Torus,
3976 Plane,
3977 ExtrudedText,
3978 Model,
3979 Billboard,
3980 };
3981 Q_ENUM( Point3DShape )
3982
3983
3988 enum class LightSourceType : int
3989 {
3990 Point,
3991 Directional,
3992 };
3993 Q_ENUM( LightSourceType )
3994
3995
4000 enum class NavigationMode : int
4001 {
4002 TerrainBased,
4003 Walk,
4004 GlobeTerrainBased
4005 };
4006 Q_ENUM( NavigationMode )
4007
4008
4013 enum class SceneMode : int
4014 {
4015 Local,
4016 Globe
4017 };
4018 Q_ENUM( SceneMode )
4019
4020
4025 enum class VerticalAxisInversion : int
4026 {
4027 Never,
4028 WhenDragging,
4029 Always,
4030 };
4031 Q_ENUM( VerticalAxisInversion )
4032
4033
4039 {
4040 Line,
4041 FillBelow,
4042 FillAbove,
4043 };
4045
4051 enum class VectorProfileType : int
4052 {
4053 IndividualFeatures,
4054 ContinuousSurface,
4055 };
4057
4063 enum class ProfileGeneratorFlag : int SIP_ENUM_BASETYPE( IntFlag )
4064 {
4065 RespectsMaximumErrorMapUnit = 1 << 0,
4066 RespectsDistanceRange = 1 << 1,
4067 RespectsElevationRange = 1 << 2,
4068 };
4069 Q_ENUM( ProfileGeneratorFlag )
4071 Q_FLAG( ProfileGeneratorFlags )
4072
4078 enum class ProfileExportType : int
4079 {
4080 Features3D,
4081 Profile2D,
4082 DistanceVsElevationTable,
4083 };
4085
4092 {
4093 Square,
4094 Circle,
4095 };
4096 Q_ENUM( PointCloudSymbol )
4097
4098
4104 {
4105 Default,
4106 BottomToTop,
4107 TopToBottom,
4108 };
4109 Q_ENUM( PointCloudDrawOrder )
4110
4111
4119 {
4120 AllowIntersections,
4121 AvoidIntersectionsCurrentLayer,
4122 AvoidIntersectionsLayers,
4123 };
4124 Q_ENUM( AvoidIntersectionsMode )
4125
4126
4134 {
4135 Qgz,
4136 Qgs,
4137 };
4138 Q_ENUM( ProjectFileFormat )
4139
4140
4148 {
4149 DontResolveLayers SIP_MONKEYPATCH_COMPAT_NAME( FlagDontResolveLayers ) = 1 << 0,
4150 DontLoadLayouts SIP_MONKEYPATCH_COMPAT_NAME( FlagDontLoadLayouts ) = 1 << 1,
4151 TrustLayerMetadata SIP_MONKEYPATCH_COMPAT_NAME( FlagTrustLayerMetadata ) = 1 << 2,
4152 DontStoreOriginalStyles SIP_MONKEYPATCH_COMPAT_NAME( FlagDontStoreOriginalStyles ) = 1 << 3,
4153 DontLoad3DViews SIP_MONKEYPATCH_COMPAT_NAME( FlagDontLoad3DViews ) = 1 << 4,
4154 DontLoadProjectStyles = 1 << 5,
4155 ForceReadOnlyLayers = 1 << 6,
4156 DontUpgradeAnnotations = 1 << 7,
4157 };
4158 Q_ENUM( ProjectReadFlag )
4159
4160
4168 Q_FLAG( ProjectReadFlags )
4169
4178 enum class ProjectCapability : int SIP_ENUM_BASETYPE( IntFlag )
4179 {
4180 ProjectStyles = 1 << 0,
4181 };
4182 Q_ENUM( ProjectCapability )
4183
4184
4190 Q_FLAG( ProjectCapabilities )
4191
4198 {
4199 Vector,
4200 Raster,
4201 RasterDem,
4202 GeoJson,
4203 Image,
4204 Video,
4205 Unknown,
4206 };
4207 Q_ENUM( MapBoxGlStyleSourceType )
4208
4209
4217 {
4218 FeatureServer SIP_MONKEYPATCH_COMPAT_NAME( FeatureService ),
4219 MapServer SIP_MONKEYPATCH_COMPAT_NAME( MapService ),
4220 ImageServer SIP_MONKEYPATCH_COMPAT_NAME( ImageService ),
4221 GlobeServer,
4222 GPServer,
4223 GeocodeServer,
4224 Unknown,
4225 };
4226 Q_ENUM( ArcGisRestServiceType )
4227
4228
4236 {
4237 Normal,
4238 Generated,
4239 };
4240 Q_ENUM( RelationshipType )
4241
4242
4250 {
4251 Association,
4252 Composition,
4253 };
4254 Q_ENUM( RelationshipStrength )
4255
4256
4262 {
4263 OneToOne,
4264 OneToMany,
4265 ManyToOne,
4266 ManyToMany,
4267 };
4268 Q_ENUM( RelationshipCardinality )
4269
4270
4275 enum class RelationshipCapability : int SIP_ENUM_BASETYPE( IntFlag )
4276 {
4277 MultipleFieldKeys = 1 << 0,
4278 ForwardPathLabel = 1 << 1,
4279 BackwardPathLabel = 1 << 2,
4280 };
4281 Q_ENUM( RelationshipCapability )
4282
4283
4289 Q_FLAG( RelationshipCapabilities )
4290
4296 enum class CoordinateDisplayType : int
4297 {
4298 MapCrs,
4299 MapGeographic,
4300 CustomCrs,
4301 };
4302 Q_ENUM( CoordinateDisplayType )
4303
4304
4309 enum class SettingsOrigin : int
4310 {
4311 Any,
4312 Global,
4313 Local,
4314 };
4315 Q_ENUM( SettingsOrigin )
4316
4317
4322 enum class ScriptLanguage : int
4323 {
4324 Css,
4325 QgisExpression,
4326 Html,
4327 JavaScript,
4328 Json,
4329 Python,
4330 R,
4331 Sql,
4332 Batch,
4333 Bash,
4334 Unknown,
4335 };
4336 Q_ENUM( ScriptLanguage )
4337
4338
4346 {
4347 Reformat = 1 << 0,
4348 CheckSyntax = 1 << 1,
4349 ToggleComment = 1 << 2,
4350 };
4351 Q_ENUM( ScriptLanguageCapability )
4352
4353
4360
4367 {
4368 AboveInsertionPoint,
4369 TopOfTree,
4370 OptimalInInsertionGroup,
4371 };
4372 Q_ENUM( LayerTreeInsertionMethod )
4373
4374
4379 enum class LayerTreeFilterFlag : int SIP_ENUM_BASETYPE( IntFlag )
4380 {
4381 SkipVisibilityCheck = 1 << 0,
4382 };
4383 Q_ENUM( LayerTreeFilterFlag )
4384
4385
4391 Q_FLAG( LayerTreeFilterFlags )
4392
4401 {
4402 Undefined,
4403 Hidden,
4404 Title,
4405 Group,
4406 Subgroup,
4407 Symbol,
4408 SymbolLabel,
4409 };
4410 Q_ENUM( LegendComponent )
4411
4412
4419 enum class LegendJsonRenderFlag : int SIP_ENUM_BASETYPE( IntFlag )
4420 {
4421 ShowRuleDetails = 1 << 0,
4422 };
4423 Q_ENUM( LegendJsonRenderFlag )
4425 Q_FLAG( LegendJsonRenderFlags )
4426
4434 enum class ActionType : int
4435 {
4436 Invalid,
4437 MapLayerAction,
4438 AttributeAction
4439 };
4440 Q_ENUM( ActionType )
4441
4442
4449 enum class MapLayerActionTarget : int SIP_ENUM_BASETYPE( IntFlag )
4450 {
4451 Layer = 1 << 0,
4452 SingleFeature = 1 << 1,
4453 MultipleFeatures = 1 << 2,
4454 AllActions = Layer | SingleFeature | MultipleFeatures
4455 };
4456 Q_ENUM( MapLayerActionTarget )
4457
4458
4466 Q_FLAG( MapLayerActionTargets )
4467
4475 enum class MapLayerActionFlag : int SIP_ENUM_BASETYPE( IntFlag )
4476 {
4477 EnabledOnlyWhenEditable = 1 << 1,
4478 EnableOnlyWhenHasGeometry = 1 << 2,
4479 };
4480 Q_ENUM( MapLayerActionFlag )
4481
4482
4490 Q_FLAG( MapLayerActionFlags )
4491
4500 {
4501 Generic,
4502 GenericPython,
4503 Mac,
4504 Windows,
4505 Unix,
4506 OpenUrl,
4507 SubmitUrlEncoded,
4508 SubmitUrlMultipart,
4509 };
4510 Q_ENUM( AttributeActionType )
4511
4512
4518 {
4519 Created,
4520 Published,
4521 Revised,
4522 Superseded,
4523 };
4524 Q_ENUM( MetadataDateType )
4525
4526
4537 {
4538 Undefined SIP_MONKEYPATCH_COMPAT_NAME( UndefinedColorInterpretation ) = 0,
4539 GrayIndex = 1,
4540 PaletteIndex = 2,
4541 RedBand = 3,
4542 GreenBand = 4,
4543 BlueBand = 5,
4544 AlphaBand = 6,
4545 HueBand = 7,
4546 SaturationBand = 8,
4547 LightnessBand = 9,
4548 CyanBand = 10,
4549 MagentaBand = 11,
4550 YellowBand = 12,
4551 BlackBand = 13,
4552 YCbCr_YBand = 14,
4553 YCbCr_CbBand = 15,
4554 YCbCr_CrBand = 16,
4555 ContinuousPalette = 17,
4556
4557 // Note: values between PanBand and SAR_P_Band match additions done in
4558 // GDAL 3.10, except that the numeric values of the constant don't match GDAL ones
4559
4560 PanBand = 18,
4561 CoastalBand = 19,
4562 RedEdgeBand = 20,
4563 NIRBand = 21,
4564 SWIRBand = 22,
4565 MWIRBand = 23,
4566 LWIRBand = 24,
4567 TIRBand = 25,
4568 OtherIRBand = 26,
4569 SAR_Ka_Band = 27,
4570 SAR_K_Band = 28,
4571 SAR_Ku_Band = 30,
4572 SAR_X_Band = 31,
4573 SAR_C_Band = 32,
4574 SAR_S_Band = 33,
4575 SAR_L_Band = 34,
4576 SAR_P_Band = 35,
4577 };
4578 Q_ENUM( RasterColorInterpretation )
4579
4580
4588 {
4589 GrayOrUndefined,
4590 Palette,
4591 MultiBand SIP_MONKEYPATCH_COMPAT_NAME( Multiband ),
4592 SingleBandColorData SIP_MONKEYPATCH_COMPAT_NAME( ColorLayer ),
4593 };
4594 Q_ENUM( RasterLayerType )
4595
4596
4604 {
4605 Undefined SIP_MONKEYPATCH_COMPAT_NAME( UndefinedDrawingStyle ),
4606 SingleBandGray,
4607 SingleBandPseudoColor,
4608 PalettedColor,
4609 PalettedSingleBandGray,
4610 PalettedSingleBandPseudoColor,
4611 PalettedMultiBandColor,
4612 MultiBandSingleBandGray,
4613 MultiBandSingleBandPseudoColor,
4614 MultiBandColor,
4615 SingleBandColorData SIP_MONKEYPATCH_COMPAT_NAME( SingleBandColorDataStyle ),
4616 };
4617 Q_ENUM( RasterDrawingStyle )
4618
4619
4626 enum class RasterPyramidFormat SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsRaster, RasterPyramidsFormat ) : int
4627 {
4628 GeoTiff SIP_MONKEYPATCH_COMPAT_NAME( PyramidsGTiff ) = 0,
4629 Internal SIP_MONKEYPATCH_COMPAT_NAME( PyramidsInternal ) = 1,
4630 Erdas SIP_MONKEYPATCH_COMPAT_NAME( PyramidsErdas ) = 2
4631 };
4632 Q_ENUM( RasterPyramidFormat )
4633
4634
4642 {
4643 No SIP_MONKEYPATCH_COMPAT_NAME( PyramidsFlagNo ) = 0,
4644 Yes SIP_MONKEYPATCH_COMPAT_NAME( PyramidsFlagYes ) = 1,
4645 CopyExisting SIP_MONKEYPATCH_COMPAT_NAME( PyramidsCopyExisting ) = 2
4646 };
4647 Q_ENUM( RasterBuildPyramidOption )
4648
4649
4657 {
4658 Undefined SIP_MONKEYPATCH_COMPAT_NAME( IdentifyFormatUndefined ) = 0,
4659 Value SIP_MONKEYPATCH_COMPAT_NAME( IdentifyFormatValue ) = 1,
4660 Text SIP_MONKEYPATCH_COMPAT_NAME( IdentifyFormatText ) = 1 << 1,
4661 Html SIP_MONKEYPATCH_COMPAT_NAME( IdentifyFormatHtml ) = 1 << 2,
4662 Feature SIP_MONKEYPATCH_COMPAT_NAME( IdentifyFormatFeature ) = 1 << 3,
4663 };
4664 Q_ENUM( RasterIdentifyFormat )
4665
4666 // TODO QGIS 4 -- remove NoCapabilities and rely on RasterInterfaceCapabilities() instead
4667 // remove deprecated members
4668 // Remove "Identify" member, and replace with combinations of IdentifyValue/IdentifyText/etc
4669
4670
4678 {
4679 NoCapabilities = 0,
4680 Size = 1 << 1,
4681 Create = 1 << 2,
4682 Remove = 1 << 3,
4683 BuildPyramids = 1 << 4,
4684 Identify = 1 << 5,
4685 IdentifyValue = 1 << 6,
4686 IdentifyText = 1 << 7,
4687 IdentifyHtml = 1 << 8,
4688 IdentifyFeature = 1 << 9,
4689 Prefetch = 1 << 10,
4690 };
4691 Q_ENUM( RasterInterfaceCapability )
4692
4693
4700
4701 // TODO QGIS 4 -- remove NoProviderCapabilities and rely on RasterProviderCapabilities() instead
4702
4711 {
4712 NoProviderCapabilities = 0,
4713 ReadLayerMetadata = 1 << 1,
4714 WriteLayerMetadata = 1 << 2,
4715 ProviderHintBenefitsFromResampling = 1 << 3,
4716 ProviderHintCanPerformProviderResampling = 1 << 4,
4717 ReloadData = 1 << 5,
4718 DpiDependentData = 1 << 6,
4719 NativeRasterAttributeTable = 1 << 7,
4720 BuildPyramids = 1 << 8,
4721 };
4722 Q_ENUM( RasterProviderCapability )
4723
4724
4733
4740 {
4741 HighestElevation,
4742 NewerElevation,
4743 };
4744 Q_ENUM( ElevationMapCombineMethod )
4745
4746
4755 {
4756 Normal SIP_MONKEYPATCH_COMPAT_NAME( BlendNormal ),
4757 Lighten SIP_MONKEYPATCH_COMPAT_NAME( BlendLighten ),
4758 Screen SIP_MONKEYPATCH_COMPAT_NAME( BlendScreen ),
4759 Dodge SIP_MONKEYPATCH_COMPAT_NAME( BlendDodge ),
4760 Addition SIP_MONKEYPATCH_COMPAT_NAME( BlendAddition ),
4761 Darken SIP_MONKEYPATCH_COMPAT_NAME( BlendDarken ),
4762 Multiply SIP_MONKEYPATCH_COMPAT_NAME( BlendMultiply ),
4763 Burn SIP_MONKEYPATCH_COMPAT_NAME( BlendBurn ),
4764 Overlay SIP_MONKEYPATCH_COMPAT_NAME( BlendOverlay ),
4765 SoftLight SIP_MONKEYPATCH_COMPAT_NAME( BlendSoftLight ),
4766 HardLight SIP_MONKEYPATCH_COMPAT_NAME( BlendHardLight ),
4767 Difference SIP_MONKEYPATCH_COMPAT_NAME( BlendDifference ),
4768 Subtract SIP_MONKEYPATCH_COMPAT_NAME( BlendSubtract ),
4769 Source SIP_MONKEYPATCH_COMPAT_NAME( BlendSource ),
4770 DestinationOver SIP_MONKEYPATCH_COMPAT_NAME( BlendDestinationOver ),
4771 Clear SIP_MONKEYPATCH_COMPAT_NAME( BlendClear ),
4772 Destination SIP_MONKEYPATCH_COMPAT_NAME( BlendDestination ),
4773 SourceIn SIP_MONKEYPATCH_COMPAT_NAME( BlendSourceIn ),
4774 DestinationIn SIP_MONKEYPATCH_COMPAT_NAME( BlendDestinationIn ),
4775 SourceOut SIP_MONKEYPATCH_COMPAT_NAME( BlendSourceOut ),
4776 DestinationOut SIP_MONKEYPATCH_COMPAT_NAME( BlendDestinationOut ),
4777 SourceAtop SIP_MONKEYPATCH_COMPAT_NAME( BlendSourceAtop ),
4778 DestinationAtop SIP_MONKEYPATCH_COMPAT_NAME( BlendDestinationAtop ),
4779 Xor SIP_MONKEYPATCH_COMPAT_NAME( BlendXor ),
4780 };
4781 Q_ENUM( BlendMode )
4782
4783
4791 {
4792 Unknown SIP_MONKEYPATCH_COMPAT_NAME( UnknownSystem ) = 0,
4793 Metric SIP_MONKEYPATCH_COMPAT_NAME( MetricSystem ),
4794 Imperial SIP_MONKEYPATCH_COMPAT_NAME( ImperialSystem ),
4795 USCS SIP_MONKEYPATCH_COMPAT_NAME( USCSSystem ),
4796 };
4797 Q_ENUM( SystemOfMeasurement )
4798
4799
4806 {
4807 Layer SIP_MONKEYPATCH_COMPAT_NAME( LayerUnits ),
4808 Pixels,
4809 Project SIP_MONKEYPATCH_COMPAT_NAME( ProjectUnits )
4810 };
4811 Q_ENUM( MapToolUnit )
4812
4813
4821 {
4822 Distance SIP_MONKEYPATCH_COMPAT_NAME( TypeDistance ) = 0,
4823 Area SIP_MONKEYPATCH_COMPAT_NAME( TypeArea ),
4824 Volume SIP_MONKEYPATCH_COMPAT_NAME( TypeVolume ),
4825 Unknown SIP_MONKEYPATCH_COMPAT_NAME( TypeUnknown ),
4826 Temporal SIP_MONKEYPATCH_COMPAT_NAME( TypeTemporal ),
4827 };
4828 Q_ENUM( UnitType )
4829
4830
4838 {
4839 Meters SIP_MONKEYPATCH_COMPAT_NAME( DistanceMeters ),
4840 Kilometers SIP_MONKEYPATCH_COMPAT_NAME( DistanceKilometers ),
4841 Feet SIP_MONKEYPATCH_COMPAT_NAME( DistanceFeet ),
4842 NauticalMiles SIP_MONKEYPATCH_COMPAT_NAME( DistanceNauticalMiles ),
4843 Yards SIP_MONKEYPATCH_COMPAT_NAME( DistanceYards ),
4844 Miles SIP_MONKEYPATCH_COMPAT_NAME( DistanceMiles ),
4845 Degrees SIP_MONKEYPATCH_COMPAT_NAME( DistanceDegrees ),
4846 Centimeters SIP_MONKEYPATCH_COMPAT_NAME( DistanceCentimeters ),
4847 Millimeters SIP_MONKEYPATCH_COMPAT_NAME( DistanceMillimeters ),
4848 Inches,
4849 ChainsInternational,
4850 ChainsBritishBenoit1895A,
4851 ChainsBritishBenoit1895B,
4852 ChainsBritishSears1922Truncated,
4853 ChainsBritishSears1922,
4854 ChainsClarkes,
4855 ChainsUSSurvey,
4856 FeetBritish1865,
4857 FeetBritish1936,
4858 FeetBritishBenoit1895A,
4859 FeetBritishBenoit1895B,
4860 FeetBritishSears1922Truncated,
4861 FeetBritishSears1922,
4862 FeetClarkes,
4863 FeetGoldCoast,
4864 FeetIndian,
4865 FeetIndian1937,
4866 FeetIndian1962,
4867 FeetIndian1975,
4868 FeetUSSurvey,
4869 LinksInternational,
4870 LinksBritishBenoit1895A,
4871 LinksBritishBenoit1895B,
4872 LinksBritishSears1922Truncated,
4873 LinksBritishSears1922,
4874 LinksClarkes,
4875 LinksUSSurvey,
4876 YardsBritishBenoit1895A,
4877 YardsBritishBenoit1895B,
4878 YardsBritishSears1922Truncated,
4879 YardsBritishSears1922,
4880 YardsClarkes,
4881 YardsIndian,
4882 YardsIndian1937,
4883 YardsIndian1962,
4884 YardsIndian1975,
4885 MilesUSSurvey,
4886 Fathoms,
4887 MetersGermanLegal,
4888 Unknown SIP_MONKEYPATCH_COMPAT_NAME( DistanceUnknownUnit ),
4889 };
4890 Q_ENUM( DistanceUnit )
4891
4892
4900 {
4901 Standard,
4902 Geographic,
4903 Unknown SIP_MONKEYPATCH_COMPAT_NAME( UnknownType ),
4904 };
4905 Q_ENUM( DistanceUnitType )
4906
4907
4915 {
4916 SquareMeters SIP_MONKEYPATCH_COMPAT_NAME( AreaSquareMeters ),
4917 SquareKilometers SIP_MONKEYPATCH_COMPAT_NAME( AreaSquareKilometers ),
4918 SquareFeet SIP_MONKEYPATCH_COMPAT_NAME( AreaSquareFeet ),
4919 SquareYards SIP_MONKEYPATCH_COMPAT_NAME( AreaSquareYards ),
4920 SquareMiles SIP_MONKEYPATCH_COMPAT_NAME( AreaSquareMiles ),
4921 Hectares SIP_MONKEYPATCH_COMPAT_NAME( AreaHectares ),
4922 Acres SIP_MONKEYPATCH_COMPAT_NAME( AreaAcres ),
4923 SquareNauticalMiles SIP_MONKEYPATCH_COMPAT_NAME( AreaSquareNauticalMiles ),
4924 SquareDegrees SIP_MONKEYPATCH_COMPAT_NAME( AreaSquareDegrees ),
4925 SquareCentimeters SIP_MONKEYPATCH_COMPAT_NAME( AreaSquareCentimeters ),
4926 SquareMillimeters SIP_MONKEYPATCH_COMPAT_NAME( AreaSquareMillimeters ),
4927 SquareInches,
4928 Unknown SIP_MONKEYPATCH_COMPAT_NAME( AreaUnknownUnit ),
4929 };
4930 Q_ENUM( AreaUnit )
4931
4932
4940 {
4941 CubicMeters SIP_MONKEYPATCH_COMPAT_NAME( VolumeCubicMeters ),
4942 CubicFeet SIP_MONKEYPATCH_COMPAT_NAME( VolumeCubicFeet ),
4943 CubicYards SIP_MONKEYPATCH_COMPAT_NAME( VolumeCubicYards ),
4944 Barrel SIP_MONKEYPATCH_COMPAT_NAME( VolumeBarrel ),
4945 CubicDecimeter SIP_MONKEYPATCH_COMPAT_NAME( VolumeCubicDecimeter ),
4946 Liters SIP_MONKEYPATCH_COMPAT_NAME( VolumeLiters ),
4947 GallonUS SIP_MONKEYPATCH_COMPAT_NAME( VolumeGallonUS ),
4948 CubicInch SIP_MONKEYPATCH_COMPAT_NAME( VolumeCubicInch ),
4949 CubicCentimeter SIP_MONKEYPATCH_COMPAT_NAME( VolumeCubicCentimeter ),
4950 CubicDegrees SIP_MONKEYPATCH_COMPAT_NAME( VolumeCubicDegrees ),
4951 Unknown SIP_MONKEYPATCH_COMPAT_NAME( VolumeUnknownUnit ),
4952 };
4953 Q_ENUM( VolumeUnit )
4954
4955
4963 {
4964 Degrees SIP_MONKEYPATCH_COMPAT_NAME( AngleDegrees ),
4965 Radians SIP_MONKEYPATCH_COMPAT_NAME( AngleRadians ),
4966 Gon SIP_MONKEYPATCH_COMPAT_NAME( AngleGon ),
4967 MinutesOfArc SIP_MONKEYPATCH_COMPAT_NAME( AngleMinutesOfArc ),
4968 SecondsOfArc SIP_MONKEYPATCH_COMPAT_NAME( AngleSecondsOfArc ),
4969 Turn SIP_MONKEYPATCH_COMPAT_NAME( AngleTurn ),
4970 MilliradiansSI SIP_MONKEYPATCH_COMPAT_NAME( AngleMilliradiansSI ),
4971 MilNATO SIP_MONKEYPATCH_COMPAT_NAME( AngleMilNATO ),
4972 Unknown SIP_MONKEYPATCH_COMPAT_NAME( AngleUnknownUnit ),
4973 };
4974 Q_ENUM( AngleUnit )
4975
4976
4984 {
4985 Milliseconds SIP_MONKEYPATCH_COMPAT_NAME( TemporalMilliseconds ),
4986 Seconds SIP_MONKEYPATCH_COMPAT_NAME( TemporalSeconds ),
4987 Minutes SIP_MONKEYPATCH_COMPAT_NAME( TemporalMinutes ),
4988 Hours SIP_MONKEYPATCH_COMPAT_NAME( TemporalHours ),
4989 Days SIP_MONKEYPATCH_COMPAT_NAME( TemporalDays ),
4990 Weeks SIP_MONKEYPATCH_COMPAT_NAME( TemporalWeeks ),
4991 Months SIP_MONKEYPATCH_COMPAT_NAME( TemporalMonths ),
4992 Years SIP_MONKEYPATCH_COMPAT_NAME( TemporalYears ),
4993 Decades SIP_MONKEYPATCH_COMPAT_NAME( TemporalDecades ),
4994 Centuries SIP_MONKEYPATCH_COMPAT_NAME( TemporalCenturies ),
4995 IrregularStep SIP_MONKEYPATCH_COMPAT_NAME( TemporalIrregularStep ),
4996 Unknown SIP_MONKEYPATCH_COMPAT_NAME( TemporalUnknownUnit )
4997 };
4998 Q_ENUM( TemporalUnit )
4999
5000
5008 {
5009 Millimeters SIP_MONKEYPATCH_COMPAT_NAME( RenderMillimeters ),
5010 MapUnits SIP_MONKEYPATCH_COMPAT_NAME( RenderMapUnits ),
5011 Pixels SIP_MONKEYPATCH_COMPAT_NAME( RenderPixels ),
5012 Percentage SIP_MONKEYPATCH_COMPAT_NAME( RenderPercentage ),
5013 Points SIP_MONKEYPATCH_COMPAT_NAME( RenderPoints ),
5014 Inches SIP_MONKEYPATCH_COMPAT_NAME( RenderInches ),
5015 Unknown SIP_MONKEYPATCH_COMPAT_NAME( RenderUnknownUnit ),
5016 MetersInMapUnits SIP_MONKEYPATCH_COMPAT_NAME( RenderMetersInMapUnits ),
5017 };
5018 Q_ENUM( RenderUnit )
5019
5020
5028 {
5029 Millimeters SIP_MONKEYPATCH_COMPAT_NAME( LayoutMillimeters ),
5030 Centimeters SIP_MONKEYPATCH_COMPAT_NAME( LayoutCentimeters ),
5031 Meters SIP_MONKEYPATCH_COMPAT_NAME( LayoutMeters ),
5032 Inches SIP_MONKEYPATCH_COMPAT_NAME( LayoutInches ),
5033 Feet SIP_MONKEYPATCH_COMPAT_NAME( LayoutFeet ),
5034 Points SIP_MONKEYPATCH_COMPAT_NAME( LayoutPoints ),
5035 Picas SIP_MONKEYPATCH_COMPAT_NAME( LayoutPicas ),
5036 Pixels SIP_MONKEYPATCH_COMPAT_NAME( LayoutPixels )
5037 };
5038 Q_ENUM( LayoutUnit )
5039
5040
5048 {
5049 PaperUnits SIP_MONKEYPATCH_COMPAT_NAME( LayoutPaperUnits ),
5050 ScreenUnits SIP_MONKEYPATCH_COMPAT_NAME( LayoutScreenUnits )
5051 };
5052 Q_ENUM( LayoutUnitType )
5053
5054
5062 {
5063 SVG SIP_MONKEYPATCH_COMPAT_NAME( FormatSVG ) = 0,
5064 Raster SIP_MONKEYPATCH_COMPAT_NAME( FormatRaster ),
5065 Unknown SIP_MONKEYPATCH_COMPAT_NAME( FormatUnknown ),
5066 };
5067 Q_ENUM( PictureFormat )
5068
5069
5074 enum class ScaleCalculationMethod : int
5075 {
5076 HorizontalTop = 0,
5077 HorizontalMiddle,
5078 HorizontalBottom,
5079 HorizontalAverage,
5080 };
5081 Q_ENUM( ScaleCalculationMethod )
5082
5083
5091 {
5092 Left SIP_MONKEYPATCH_COMPAT_NAME( AlignLeft ) = 0,
5093 Middle SIP_MONKEYPATCH_COMPAT_NAME( AlignMiddle ),
5094 Right SIP_MONKEYPATCH_COMPAT_NAME( AlignRight ),
5095 };
5096 Q_ENUM( ScaleBarAlignment )
5097
5098
5106 {
5107 Fixed SIP_MONKEYPATCH_COMPAT_NAME( SegmentSizeFixed ) = 0,
5108 FitWidth SIP_MONKEYPATCH_COMPAT_NAME( SegmentSizeFitWidth ) = 1
5109 };
5110 Q_ENUM( ScaleBarSegmentSizeMode )
5111
5112
5120 {
5121 AboveSegment SIP_MONKEYPATCH_COMPAT_NAME( LabelAboveSegment ) = 0,
5122 BelowSegment SIP_MONKEYPATCH_COMPAT_NAME( LabelBelowSegment ),
5123 };
5124 Q_ENUM( ScaleBarDistanceLabelVerticalPlacement )
5125
5126
5134 {
5135 CenteredEdge SIP_MONKEYPATCH_COMPAT_NAME( LabelCenteredEdge ) = 0,
5136 CenteredSegment SIP_MONKEYPATCH_COMPAT_NAME( LabelCenteredSegment ),
5137 };
5138 Q_ENUM( ScaleBarDistanceLabelHorizontalPlacement )
5139
5140
5145 enum class InputControllerType : int
5146 {
5147 Map2D,
5148 Map3D
5149 };
5151
5158 {
5159 NotSet,
5160 Unknown,
5161 OrdinaryTable,
5162 Index,
5163 Sequence,
5164 View,
5165 MaterializedView,
5166 CompositeType,
5167 ToastTable,
5168 ForeignTable,
5169 PartitionedTable,
5170 };
5171 Q_ENUM( PostgresRelKind )
5172
5173
5179 {
5180 SetFieldComment = 1 << 0,
5181 SetFieldAlias = 1 << 1,
5182 SetTableComment = 1 << 2,
5183 };
5184 Q_ENUM( DatabaseProviderConnectionCapability2 )
5187
5194 {
5195 SetGeometryColumnName = 1 << 0,
5196 SetPrimaryKeyName = 1 << 1,
5197 };
5198 Q_ENUM( DatabaseProviderTableImportCapability )
5201
5208 {
5209 SaveToDatabase = 1 << 1,
5210 LoadFromDatabase = 1 << 2,
5211 DeleteFromDatabase = 1 << 3
5212 };
5216
5217
5223 {
5224 LastProfile,
5225 DefaultProfile,
5226 AskUser,
5227 };
5228 Q_ENUM( UserProfileSelectionPolicy )
5229
5230
5238 {
5239 Container SIP_MONKEYPATCH_COMPAT_NAME( AeTypeContainer ),
5240 Field SIP_MONKEYPATCH_COMPAT_NAME( AeTypeField ),
5241 Relation SIP_MONKEYPATCH_COMPAT_NAME( AeTypeRelation ),
5242 QmlElement SIP_MONKEYPATCH_COMPAT_NAME( AeTypeQmlElement ),
5243 HtmlElement SIP_MONKEYPATCH_COMPAT_NAME( AeTypeHtmlElement ),
5244 Action SIP_MONKEYPATCH_COMPAT_NAME( AeTypeAction ),
5245 TextElement SIP_MONKEYPATCH_COMPAT_NAME( AeTypeTextElement ),
5246 SpacerElement SIP_MONKEYPATCH_COMPAT_NAME( AeTypeSpacerElement ),
5247 Invalid SIP_MONKEYPATCH_COMPAT_NAME( AeTypeInvalid ),
5248 };
5249 Q_ENUM( AttributeEditorType )
5250
5251
5257 {
5258 GroupBox,
5259 Tab,
5260 Row,
5261 };
5262 Q_ENUM( AttributeEditorContainerType )
5263
5264
5272 {
5273 AutoGenerated SIP_MONKEYPATCH_COMPAT_NAME( GeneratedLayout ) = 0,
5274 DragAndDrop SIP_MONKEYPATCH_COMPAT_NAME( TabLayout ) = 1,
5275 UiFile SIP_MONKEYPATCH_COMPAT_NAME( UiFileLayout ) = 2
5276 };
5277 Q_ENUM( AttributeFormLayout )
5278
5279
5287 {
5288 Default SIP_MONKEYPATCH_COMPAT_NAME( SuppressDefault ) = 0,
5289 On SIP_MONKEYPATCH_COMPAT_NAME( SuppressOn ) = 1,
5290 Off SIP_MONKEYPATCH_COMPAT_NAME( SuppressOff ) = 2
5291 };
5292 Q_ENUM( AttributeFormSuppression )
5293
5294
5302 {
5303 NoSource SIP_MONKEYPATCH_COMPAT_NAME( CodeSourceNone ) = 0,
5304 File SIP_MONKEYPATCH_COMPAT_NAME( CodeSourceFile ) = 1,
5305 Dialog SIP_MONKEYPATCH_COMPAT_NAME( CodeSourceDialog ) = 2,
5306 Environment SIP_MONKEYPATCH_COMPAT_NAME( CodeSourceEnvironment ) = 3
5307 };
5308 Q_ENUM( AttributeFormPythonInitCodeSource )
5309
5310
5316 {
5317 Qgis,
5318 PointCloud,
5319 RasterCalculator,
5320 };
5321 Q_ENUM( ExpressionType )
5322
5323
5331 {
5332 NoSymbology = 0,
5333 PerFeature SIP_MONKEYPATCH_COMPAT_NAME( FeatureSymbology ),
5334 PerSymbolLayer SIP_MONKEYPATCH_COMPAT_NAME( SymbolLayerSymbology )
5335 };
5336 Q_ENUM( FeatureSymbologyExport )
5337
5338
5343 enum class VectorTileProviderFlag : int SIP_ENUM_BASETYPE( IntFlag )
5344 {
5345 AlwaysUseTileMatrixSetFromProvider = 1 << 1,
5346 };
5347 Q_ENUM( VectorTileProviderFlag )
5348
5349
5355 Q_FLAG( VectorTileProviderFlags )
5356
5362 {
5363 ReadLayerMetadata = 1 << 1,
5364 };
5365 Q_ENUM( VectorTileProviderCapability )
5366
5367
5374
5381 {
5382 Available,
5383 NotAvailable,
5384 AvailableNoChildren,
5385 UseLowerZoomLevelTile,
5386 };
5387 Q_ENUM( TileAvailability )
5388
5389
5395 {
5396 ReadLayerMetadata = 1 << 1,
5397 };
5398 Q_ENUM( TiledSceneProviderCapability )
5399
5400
5407
5414 {
5415 Region,
5416 OrientedBox,
5417 Sphere,
5418 };
5419 Q_ENUM( TiledSceneBoundingVolumeType )
5420
5421
5430 {
5431 Replacement,
5432 Additive,
5433 };
5434 Q_ENUM( TileRefinementProcess )
5435
5436
5442 {
5443 NoChildren,
5444 Available,
5445 NeedFetching,
5446 };
5447 Q_ENUM( TileChildrenAvailability )
5448
5449
5454 enum class TiledSceneRequestFlag : int SIP_ENUM_BASETYPE( IntFlag )
5455 {
5456 NoHierarchyFetch = 1 << 0,
5457 };
5458 Q_ENUM( TiledSceneRequestFlag )
5459
5460
5466 Q_FLAG( TiledSceneRequestFlags )
5467
5473 enum class TiledSceneRendererFlag : int SIP_ENUM_BASETYPE( IntFlag )
5474 {
5475 RequiresTextures = 1 << 0,
5476 ForceRasterRender = 1 << 1,
5477 RendersTriangles = 1 << 2,
5478 RendersLines = 1 << 3,
5479 };
5480 Q_ENUM( TiledSceneRendererFlag )
5481
5482
5488 Q_FLAG( TiledSceneRendererFlags )
5489
5495 enum class GdalResampleAlgorithm : int
5496 {
5497 RA_NearestNeighbour = 0,
5498 RA_Bilinear = 1,
5499 RA_Cubic = 2,
5500 RA_CubicSpline = 3,
5501 RA_Lanczos = 4,
5502 RA_Average = 5,
5503 RA_Mode = 6,
5504 RA_Max = 8,
5505 RA_Min = 9,
5506 RA_Median = 10,
5507 RA_Q1 = 11,
5508 RA_Q3 = 12,
5509 };
5510 Q_ENUM( GdalResampleAlgorithm )
5511
5512
5517 enum class VsiHandlerType : int
5518 {
5519 Invalid,
5520 Archive,
5521 Network,
5522 Cloud,
5523 Memory,
5524 Other,
5525 };
5526 Q_ENUM( VsiHandlerType )
5527
5528 // TODO QGIS 4: make All include all values (we can't do this before 4.0, as we need to keep
5529 // compatibility with code which expects all these statistics to give numeric results)
5530
5531
5536 enum class ZonalStatistic : int SIP_ENUM_BASETYPE( IntFlag )
5537 {
5538 Count = 1 << 0,
5539 Sum = 1 << 1,
5540 Mean = 1 << 2,
5541 Median = 1 << 3,
5542 StDev = 1 << 4,
5543 Min = 1 << 5,
5544 Max = 1 << 6,
5545 Range = 1 << 7,
5546 Minority = 1 << 8,
5547 Majority = 1 << 9,
5548 Variety = 1 << 10,
5549 Variance = 1 << 11,
5550 MinimumPoint = 1 << 12,
5551 MaximumPoint = 1 << 13,
5552 All = Count | Sum | Mean | Median | StDev | Max | Min | Range | Minority | Majority | Variety | Variance,
5553 AllNumeric = Count | Sum | Mean | Median | StDev | Max | Min | Range | Minority | Majority | Variety | Variance,
5554 Default = Count | Sum | Mean,
5555 };
5556 Q_ENUM( ZonalStatistic )
5557
5558
5564 Q_FLAG( ZonalStatistics )
5565
5571 enum class ZonalStatisticResult : int
5572 {
5573 Success = 0,
5574 LayerTypeWrong = 1,
5575 LayerInvalid,
5576 RasterInvalid,
5577 RasterBandInvalid,
5578 FailedToCreateField = 8,
5579 Canceled = 9
5580 };
5581 Q_ENUM( ZonalStatisticResult )
5582
5583
5590 {
5591 Count,
5592 CountDistinct,
5593 CountMissing,
5594 Min,
5595 Max,
5596 Sum,
5597 Mean,
5598 Median,
5599 StDev,
5600 StDevSample,
5601 Range,
5602 Minority,
5603 Majority,
5604 FirstQuartile,
5605 ThirdQuartile,
5606 InterQuartileRange,
5607 StringMinimumLength,
5608 StringMaximumLength,
5609 StringConcatenate,
5610 GeometryCollect,
5611 ArrayAggregate,
5612 StringConcatenateUnique
5613 };
5614 Q_ENUM( Aggregate )
5615
5616
5622 {
5623 Count = 1 << 0,
5624 CountMissing = 1 << 15,
5625 Sum = 1 << 1,
5626 Mean = 1 << 2,
5627 Median = 1 << 3,
5628 StDev = 1 << 4,
5629 StDevSample = 1 << 5,
5630 Min = 1 << 6,
5631 Max = 1 << 7,
5632 Range = 1 << 8,
5633 Minority = 1 << 9,
5634 Majority = 1 << 10,
5635 Variety = 1 << 11,
5636 FirstQuartile = 1 << 12,
5637 ThirdQuartile = 1 << 13,
5638 InterQuartileRange = 1 << 14,
5639 First = 1 << 16,
5640 Last = 1 << 17,
5641 All = Count | CountMissing | Sum | Mean | Median | StDev | Max | Min | Range | Minority | Majority | Variety | FirstQuartile | ThirdQuartile | InterQuartileRange | First | Last
5642 };
5643 Q_ENUM( Statistic )
5644
5645
5651 Q_FLAG( Statistics )
5652
5659 {
5660 Count = 1,
5661 CountDistinct = 2,
5662 CountMissing = 4,
5663 Min = 8,
5664 Max = 16,
5665 Range = 32,
5666 All = Count | CountDistinct | CountMissing | Min | Max | Range,
5667 };
5668 Q_ENUM( DateTimeStatistic )
5669
5670
5676 Q_FLAG( DateTimeStatistics )
5677
5684 {
5685 Count = 1,
5686 CountDistinct = 2,
5687 CountMissing = 4,
5688 Min = 8,
5689 Max = 16,
5690 MinimumLength = 32,
5691 MaximumLength = 64,
5692 MeanLength = 128,
5693 Minority = 256,
5694 Majority = 512,
5695 All = Count | CountDistinct | CountMissing | Min | Max | MinimumLength | MaximumLength | MeanLength | Minority | Majority,
5696 };
5697 Q_ENUM( StringStatistic )
5698
5699
5705 Q_FLAG( StringStatistics )
5706
5713 {
5714 NoStatistic = 0,
5715 Min = 1,
5716 Max = 1 << 1,
5717 Range = 1 << 2,
5718 Sum = 1 << 3,
5719 Mean = 1 << 4,
5720 StdDev = 1 << 5,
5721 SumOfSquares = 1 << 6,
5722 All = Min | Max | Range | Sum | Mean | StdDev | SumOfSquares
5723 };
5724 Q_ENUM( RasterBandStatistic )
5725
5726
5732 Q_FLAG( RasterBandStatistics )
5733
5739 enum class SensorThingsEntity : int
5740 {
5741 Invalid,
5742 Thing,
5743 Location,
5744 HistoricalLocation,
5745 Datastream,
5746 Sensor,
5747 ObservedProperty,
5748 Observation,
5749 FeatureOfInterest,
5750 MultiDatastream,
5751 };
5752 Q_ENUM( SensorThingsEntity )
5753
5754
5759 enum class ColorModel : int
5760 {
5761 Rgb,
5762 Cmyk,
5763 };
5764 Q_ENUM( ColorModel )
5765
5766
5771 enum class DocumentationApi : int
5772 {
5773 PyQgis,
5774 PyQgisSearch,
5775 CppQgis,
5776 Qt,
5777 };
5778 Q_ENUM( DocumentationApi )
5779
5780
5785 enum class DocumentationBrowser : int
5786 {
5787 DeveloperToolsPanel,
5788 SystemWebBrowser,
5789 };
5790 Q_ENUM( DocumentationBrowser )
5791
5792
5797 enum class MouseHandlesAction : int
5798 {
5799 MoveItem,
5800 ResizeUp,
5801 ResizeDown,
5802 ResizeLeft,
5803 ResizeRight,
5804 ResizeLeftUp,
5805 ResizeRightUp,
5806 ResizeLeftDown,
5807 ResizeRightDown,
5808 SelectItem,
5809 NoAction
5810 };
5811 Q_ENUM( MouseHandlesAction )
5812
5813
5817 enum class MeshRangeLimit : int
5818 {
5819 NotSet,
5820 MinimumMaximum,
5821 };
5822 Q_ENUM( MeshRangeLimit )
5823
5824
5829 enum class MeshRangeExtent : int
5830 {
5831 WholeMesh,
5832 FixedCanvas,
5833 UpdatedCanvas,
5834 };
5835 Q_ENUM( MeshRangeExtent )
5836
5837
5843 enum class PointCloudAccessType : int
5844 {
5845 Local,
5846 Remote
5847 };
5848 Q_ENUM( PointCloudAccessType )
5849
5850
5855 {
5856 RenderExtents,
5857 RenderOverview,
5858 RenderOverviewAndExtents
5859 };
5860 Q_ENUM( PointCloudZoomOutRenderBehavior )
5861
5862
5867 {
5868 Standard = 0,
5869 Adaptive,
5870 AreaError,
5871 ConstantDensity
5872 };
5873 Q_ENUM( SegmentCalculationMethod )
5874
5875
5878 static const double DEFAULT_SEARCH_RADIUS_MM;
5879
5881 static const float DEFAULT_MAPTOPIXEL_THRESHOLD;
5882
5888 static const QColor DEFAULT_HIGHLIGHT_COLOR;
5889
5893 static const double DEFAULT_HIGHLIGHT_BUFFER_MM;
5894
5898 static const double DEFAULT_HIGHLIGHT_MIN_WIDTH_MM;
5899
5907 Q_DECL_DEPRECATED static const double SCALE_PRECISION;
5908
5913 static const double DEFAULT_Z_COORDINATE;
5914
5920 static const double DEFAULT_M_COORDINATE;
5921
5926 static const double UI_SCALE_FACTOR;
5927
5931 static const double DEFAULT_SNAP_TOLERANCE;
5932
5936 static const Qgis::MapToolUnit DEFAULT_SNAP_UNITS;
5937
5943 static QString defaultProjectScales();
5944
5950 static int geosVersionInt();
5951
5957 static int geosVersionMajor();
5958
5964 static int geosVersionMinor();
5965
5971 static int geosVersionPatch();
5972
5978 static QString geosVersion();
5979};
5980
5983
6066
6067// hack to workaround warnings when casting void pointers
6068// retrieved from QLibrary::resolve to function pointers.
6069// It's assumed that this works on all systems supporting
6070// QLibrary
6071#define cast_to_fptr(f) f
6072
6073
6081// based on Boojum's code from http://stackoverflow.com/questions/3556687/prevent-firing-signals-in-qt
6082template<class Object> class QgsSignalBlocker SIP_SKIP SIP_SKIP // clazy:exclude=rule-of-three
6083{
6084 public:
6085
6090 explicit QgsSignalBlocker( Object *object )
6091 : mObject( object )
6092 , mPreviousState( object->blockSignals( true ) )
6093 {}
6094
6096 {
6097 mObject->blockSignals( mPreviousState );
6098 }
6099
6101 Object *operator->() { return mObject; }
6102
6103 private:
6104
6105 Object *mObject = nullptr;
6106 bool mPreviousState;
6107
6108};
6109
6122// based on Boojum's code from http://stackoverflow.com/questions/3556687/prevent-firing-signals-in-qt
6123template<class Object> inline QgsSignalBlocker<Object> whileBlocking( Object *object ) SIP_SKIP SIP_SKIP
6124{
6125 return QgsSignalBlocker<Object>( object );
6126}
6127
6129CORE_EXPORT uint qHash( const QVariant &variant );
6130
6136inline QString qgsDoubleToString( double a, int precision = 17 )
6137{
6138 QString str;
6139 if ( precision )
6140 {
6141 if ( precision < 0 )
6142 {
6143 const double roundFactor = std::pow( 10, -precision );
6144 str = QString::number( static_cast< long long >( std::round( a / roundFactor ) * roundFactor ) );
6145 }
6146 else
6147 {
6148 str = QString::number( a, 'f', precision );
6149 if ( str.contains( QLatin1Char( '.' ) ) )
6150 {
6151 // remove ending 0s
6152 int idx = str.length() - 1;
6153 while ( str.at( idx ) == '0' && idx > 1 )
6154 {
6155 idx--;
6156 }
6157 if ( idx < str.length() - 1 )
6158 str.truncate( str.at( idx ) == '.' ? idx : idx + 1 );
6159 }
6160 }
6161 }
6162 else
6163 {
6164 str = QString::number( a, 'f', precision );
6165 }
6166 // avoid printing -0
6167 // see https://bugreports.qt.io/browse/QTBUG-71439
6168 if ( str == QLatin1String( "-0" ) )
6169 {
6170 return QLatin1String( "0" );
6171 }
6172 return str;
6173}
6174
6181inline bool qgsNanCompatibleEquals( double a, double b )
6182{
6183 const bool aIsNan = std::isnan( a );
6184 const bool bIsNan = std::isnan( b );
6185 if ( aIsNan || bIsNan )
6186 return aIsNan && bIsNan;
6187
6188 return a == b;
6189}
6190
6191#ifndef SIP_RUN
6192
6200template<typename T>
6201inline bool qgsNumberNear( T a, T b, T epsilon = std::numeric_limits<T>::epsilon() * 4 )
6202{
6203 const bool aIsNan = std::isnan( a );
6204 const bool bIsNan = std::isnan( b );
6205 if ( aIsNan || bIsNan )
6206 return aIsNan && bIsNan;
6207
6208 const T diff = a - b;
6209 return diff >= -epsilon && diff <= epsilon;
6210}
6211#endif
6212
6219inline bool qgsDoubleNear( double a, double b, double epsilon = 4 * std::numeric_limits<double>::epsilon() )
6220{
6221 return qgsNumberNear<double>( a, b, epsilon );
6222}
6223
6230inline bool qgsFloatNear( float a, float b, float epsilon = 4 * FLT_EPSILON )
6231{
6232 return qgsNumberNear<float>( a, b, epsilon );
6233}
6234
6236inline bool qgsDoubleNearSig( double a, double b, int significantDigits = 10 )
6237{
6238 const bool aIsNan = std::isnan( a );
6239 const bool bIsNan = std::isnan( b );
6240 if ( aIsNan || bIsNan )
6241 return aIsNan && bIsNan;
6242
6243 // The most simple would be to print numbers as %.xe and compare as strings
6244 // but that is probably too costly
6245 // Then the fastest would be to set some bits directly, but little/big endian
6246 // has to be considered (maybe TODO)
6247 // Is there a better way?
6248 int aexp, bexp;
6249 const double ar = std::frexp( a, &aexp );
6250 const double br = std::frexp( b, &bexp );
6251
6252 return aexp == bexp &&
6253 std::round( ar * std::pow( 10.0, significantDigits ) ) == std::round( br * std::pow( 10.0, significantDigits ) );
6254}
6255
6260inline double qgsRound( double number, int places )
6261{
6262 const double m = ( number < 0.0 ) ? -1.0 : 1.0;
6263 const double scaleFactor = std::pow( 10.0, places );
6264 return ( std::round( number * m * scaleFactor ) / scaleFactor ) * m;
6265}
6266
6267#ifndef SIP_RUN
6268
6275template<class Key, class Value>
6276QString qgsMapJoinKeys( const QMap<Key, Value> &map, const QString &separator )
6277{
6278 QString result;
6279 for ( auto it = map.constBegin(); it != map.constEnd(); it++ )
6280 result += QString( "%1%2" ).arg( it.key() ).arg( separator );
6281
6282 result.chop( separator.size() );
6283 return result;
6284}
6285
6292template<class Key, class Value>
6293QString qgsMapJoinValues( const QMap<Key, Value> &map, const QString &separator )
6294{
6295 QString result;
6296 for ( auto it = map.constBegin(); it != map.constEnd(); it++ )
6297 result += QString( "%1%2" ).arg( it.value() ).arg( separator );
6298
6299 result.chop( separator.size() );
6300 return result;
6301}
6302
6309template<class T>
6310QString qgsSetJoin( const QSet<T> &set, const QString &separator )
6311{
6312 QString result;
6313 for ( auto it = set.constBegin(); it != set.constEnd(); it++ )
6314 result += QString( "%1%2" ).arg( *it ).arg( separator );
6315
6316 result.chop( separator.size() );
6317 return result;
6318}
6319
6321
6331namespace qgis
6332{
6333
6346 template<typename To, typename From> inline To down_cast( From *f )
6347 {
6348 static_assert(
6349 ( std::is_base_of<From,
6350 typename std::remove_pointer<To>::type>::value ),
6351 "target type not derived from source type" );
6352 Q_ASSERT( f == nullptr || dynamic_cast<To>( f ) != nullptr );
6353 return static_cast<To>( f );
6354 }
6355
6356 template<class T>
6357 QSet<T> listToSet( const QList<T> &list )
6358 {
6359 return QSet<T>( list.begin(), list.end() );
6360 }
6361
6362 template<class T>
6363 QList<T> setToList( const QSet<T> &set )
6364 {
6365 return QList<T>( set.begin(), set.end() );
6366 }
6367}
6368
6370#endif
6371
6376template<class T> const QList<T> qgsEnumList() SIP_SKIP
6377{
6378 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
6379 Q_ASSERT( metaEnum.isValid() );
6380 QList<T> enumList;
6381 for ( int idx = 0; idx < metaEnum.keyCount(); ++idx )
6382 {
6383 enumList.append( static_cast<T>( metaEnum.value( idx ) ) );
6384 }
6385 return enumList;
6386}
6387
6393template<class T> const QMap<T, QString> qgsEnumMap() SIP_SKIP
6394{
6395 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
6396 Q_ASSERT( metaEnum.isValid() );
6397 QMap<T, QString> enumMap;
6398 for ( int idx = 0; idx < metaEnum.keyCount(); ++idx )
6399 {
6400 enumMap.insert( static_cast<T>( metaEnum.value( idx ) ), QString( metaEnum.key( idx ) ) );
6401 }
6402 return enumMap;
6403}
6404
6410template<class T> QString qgsEnumValueToKey( const T &value, bool *returnOk = nullptr ) SIP_SKIP
6411{
6412 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
6413 Q_ASSERT( metaEnum.isValid() );
6414 const char *key = metaEnum.valueToKey( static_cast<int>( value ) );
6415 if ( returnOk )
6416 {
6417 *returnOk = key ? true : false;
6418 }
6419 return QString::fromUtf8( key );
6420}
6421
6429template<class T> T qgsEnumKeyToValue( const QString &key, const T &defaultValue, bool tryValueAsKey = true, bool *returnOk = nullptr ) SIP_SKIP
6430{
6431 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
6432 Q_ASSERT( metaEnum.isValid() );
6433 bool ok = false;
6434 T v = static_cast<T>( metaEnum.keyToValue( key.toUtf8().data(), &ok ) );
6435 if ( returnOk )
6436 {
6437 *returnOk = ok;
6438 }
6439 if ( ok )
6440 {
6441 return v;
6442 }
6443 else
6444 {
6445 // if conversion has failed, try with conversion from int value
6446 if ( tryValueAsKey )
6447 {
6448 bool canConvert = false;
6449 const int intValue = key.toInt( &canConvert );
6450 if ( canConvert && metaEnum.valueToKey( intValue ) )
6451 {
6452 if ( returnOk )
6453 {
6454 *returnOk = true;
6455 }
6456 return static_cast<T>( intValue );
6457 }
6458 }
6459 }
6460 return defaultValue;
6461}
6462
6468template<class T> QString qgsFlagValueToKeys( const T &value, bool *returnOk = nullptr ) SIP_SKIP
6469{
6470 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
6471 Q_ASSERT( metaEnum.isValid() );
6472 int intValue = static_cast<int>( value );
6473 const QByteArray ba = metaEnum.valueToKeys( intValue );
6474 // check that the int value does correspond to a flag
6475 // see https://stackoverflow.com/a/68495949/1548052
6476 const int intValueCheck = metaEnum.keysToValue( ba );
6477 bool ok = intValue == intValueCheck;
6478 if ( returnOk )
6479 *returnOk = ok;
6480 return ok ? QString::fromUtf8( ba ) : QString();
6481}
6482
6490template<class T> T qgsFlagKeysToValue( const QString &keys, const T &defaultValue, bool tryValueAsKey = true, bool *returnOk = nullptr ) SIP_SKIP
6491{
6492 if ( keys.isEmpty() )
6493 {
6494 if ( returnOk )
6495 {
6496 *returnOk = false;
6497 }
6498 return defaultValue;
6499 }
6500 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
6501 Q_ASSERT( metaEnum.isValid() );
6502 bool ok = false;
6503 T v = static_cast<T>( metaEnum.keysToValue( keys.toUtf8().constData(), &ok ) );
6504 if ( returnOk )
6505 {
6506 *returnOk = ok;
6507 }
6508 if ( ok )
6509 {
6510 return v;
6511 }
6512 else
6513 {
6514 // if conversion has failed, try with conversion from int value
6515 if ( tryValueAsKey )
6516 {
6517 bool canConvert = false;
6518 const int intValue = keys.toInt( &canConvert );
6519 if ( canConvert )
6520 {
6521 const QByteArray keys = metaEnum.valueToKeys( intValue );
6522 const int intValueCheck = metaEnum.keysToValue( keys );
6523 if ( intValue == intValueCheck )
6524 {
6525 if ( returnOk )
6526 {
6527 *returnOk = true;
6528 }
6529 return T( intValue );
6530 }
6531 }
6532 }
6533 }
6534 return defaultValue;
6535}
6536
6537
6546CORE_EXPORT double qgsPermissiveToDouble( QString string, bool &ok );
6547
6556CORE_EXPORT int qgsPermissiveToInt( QString string, bool &ok );
6557
6567CORE_EXPORT qlonglong qgsPermissiveToLongLong( QString string, bool &ok );
6568
6578CORE_EXPORT bool qgsVariantLessThan( const QVariant &lhs, const QVariant &rhs );
6579
6588CORE_EXPORT bool qgsVariantEqual( const QVariant &lhs, const QVariant &rhs );
6589
6596CORE_EXPORT bool qgsVariantGreaterThan( const QVariant &lhs, const QVariant &rhs );
6597
6598#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
6599
6606inline bool operator> ( const QVariant &v1, const QVariant &v2 )
6607{
6608 return qgsVariantGreaterThan( v1, v2 );
6609}
6610
6620inline bool operator< ( const QVariant &v1, const QVariant &v2 )
6621{
6622 return qgsVariantLessThan( v1, v2 );
6623}
6624#endif
6625
6626
6627#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
6628
6632template<> CORE_EXPORT bool qMapLessThanKey<QVariantList>( const QVariantList &key1, const QVariantList &key2 ) SIP_SKIP;
6633#endif
6634
6635CORE_EXPORT QString qgsVsiPrefix( const QString &path );
6636
6642void CORE_EXPORT *qgsMalloc( size_t size ) SIP_SKIP;
6643
6648void CORE_EXPORT qgsFree( void *ptr ) SIP_SKIP;
6649
6650#ifndef SIP_RUN
6651
6652#ifdef _MSC_VER
6653#define CONSTLATIN1STRING inline const QLatin1String
6654#else
6655#define CONSTLATIN1STRING constexpr QLatin1String
6656#endif
6657
6659class ScopedIntIncrementor
6660{
6661 public:
6662
6663 ScopedIntIncrementor( int *variable )
6664 : mVariable( variable )
6665 {
6666 ( *mVariable )++;
6667 }
6668
6669 ScopedIntIncrementor( const ScopedIntIncrementor &other ) = delete;
6670 ScopedIntIncrementor &operator=( const ScopedIntIncrementor &other ) = delete;
6671
6672 void release()
6673 {
6674 if ( mVariable )
6675 ( *mVariable )--;
6676
6677 mVariable = nullptr;
6678 }
6679
6680 ~ScopedIntIncrementor()
6681 {
6682 release();
6683 }
6684
6685 private:
6686 int *mVariable = nullptr;
6687};
6689
6695{
6696 return QLatin1String(
6697 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]] )"""
6698 );
6699}
6700
6703{
6704 return QLatin1String( "+proj=longlat +datum=WGS84 +no_defs" );
6705}
6706
6709{
6710 return QLatin1String( "EPSG:4326" );
6711}
6712
6715{
6716 return QLatin1String( "NONE" );
6717}
6718
6720
6722const int PREVIEW_JOB_DELAY_MS = 250;
6723
6725const int MAXIMUM_LAYER_PREVIEW_TIME_MS = 250;
6726
6728
6729#endif
6730
6732const long GEOSRID = 4326;
6733
6735const long GEOCRS_ID = 3452;
6736
6738const long GEO_EPSG_CRS_ID = 4326;
6739
6744const int USER_CRS_START_ID = 100000;
6745
6746//
6747// Constants for point symbols
6748//
6749
6751const double DEFAULT_POINT_SIZE = 2.0;
6752const double DEFAULT_LINE_WIDTH = 0.26;
6753
6755const double DEFAULT_SEGMENT_EPSILON = 1e-8;
6756
6757typedef QMap<QString, QString> QgsStringMap SIP_SKIP;
6758
6767typedef unsigned long long qgssize;
6768
6769#ifndef SIP_RUN
6770#if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6)) || defined(__clang__)
6771
6772#define Q_NOWARN_DEPRECATED_PUSH \
6773 _Pragma("GCC diagnostic push") \
6774 _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"");
6775#define Q_NOWARN_DEPRECATED_POP \
6776 _Pragma("GCC diagnostic pop");
6777#define Q_NOWARN_UNREACHABLE_PUSH
6778#define Q_NOWARN_UNREACHABLE_POP
6779
6780#elif defined(_MSC_VER)
6781
6782#define Q_NOWARN_DEPRECATED_PUSH \
6783 __pragma(warning(push)) \
6784 __pragma(warning(disable:4996))
6785#define Q_NOWARN_DEPRECATED_POP \
6786 __pragma(warning(pop))
6787#define Q_NOWARN_UNREACHABLE_PUSH \
6788 __pragma(warning(push)) \
6789 __pragma(warning(disable:4702))
6790#define Q_NOWARN_UNREACHABLE_POP \
6791 __pragma(warning(pop))
6792
6793#else
6794
6795#define Q_NOWARN_DEPRECATED_PUSH
6796#define Q_NOWARN_DEPRECATED_POP
6797#define Q_NOWARN_UNREACHABLE_PUSH
6798#define Q_NOWARN_UNREACHABLE_POP
6799
6800#endif
6801#endif
6802
6803#ifndef QGISEXTERN
6804#ifdef Q_OS_WIN
6805# define QGISEXTERN extern "C" __declspec( dllexport )
6806#else
6807# if defined(__GNUC__) || defined(__clang__)
6808# define QGISEXTERN extern "C" __attribute__ ((visibility ("default")))
6809# else
6810# define QGISEXTERN extern "C"
6811# endif
6812#endif
6813#endif
6814#endif
6815
6816// see https://infektor.net/posts/2017-01-19-using-cpp17-attributes-today.html#using-the-nodiscard-attribute
6817#if __cplusplus >= 201703L
6818#define NODISCARD [[nodiscard]]
6819#elif defined(__clang__)
6820#define NODISCARD [[nodiscard]]
6821#elif defined(_MSC_VER)
6822#define NODISCARD // no support
6823#elif defined(__has_cpp_attribute)
6824#if __has_cpp_attribute(nodiscard)
6825#define NODISCARD [[nodiscard]]
6826#elif __has_cpp_attribute(gnu::warn_unused_result)
6827#define NODISCARD [[gnu::warn_unused_result]]
6828#else
6829#define NODISCARD Q_REQUIRED_RESULT
6830#endif
6831#else
6832#define NODISCARD Q_REQUIRED_RESULT
6833#endif
6834
6835#if __cplusplus >= 201703L
6836#define MAYBE_UNUSED [[maybe_unused]]
6837#elif defined(__clang__)
6838#define MAYBE_UNUSED [[maybe_unused]]
6839#elif defined(_MSC_VER)
6840#define MAYBE_UNUSED // no support
6841#elif defined(__has_cpp_attribute)
6842#if __has_cpp_attribute(gnu::unused)
6843#define MAYBE_UNUSED [[gnu::unused]]
6844#else
6845#define MAYBE_UNUSED
6846#endif
6847#else
6848#define MAYBE_UNUSED
6849#endif
6850
6851#ifndef FINAL
6852#define FINAL final
6853#endif
6854
6855#ifndef SIP_RUN
6856#ifdef _MSC_VER
6857#define BUILTIN_UNREACHABLE \
6858 __assume(false);
6859#elif defined(__GNUC__) && !defined(__clang__)
6860// Workaround a GCC bug where a -Wreturn-type warning is emitted in constructs
6861// like:
6862// switch( mVariableThatCanOnlyBeXorY )
6863// {
6864// case X:
6865// return "foo";
6866// case Y:
6867// return "foo";
6868// }
6869// See https://gcc.gnu.org/bugzilla/show_bug.cgi?id=87951
6870#define BUILTIN_UNREACHABLE \
6871 __builtin_unreachable();
6872#else
6873#define BUILTIN_UNREACHABLE
6874#endif
6875#endif // SIP_RUN
6876
6877#ifdef SIP_RUN
6878
6883QString CORE_EXPORT geoWkt();
6884
6886QString CORE_EXPORT geoProj4();
6887
6889QString CORE_EXPORT geoEpsgCrsAuthId();
6890
6892QString CORE_EXPORT geoNone();
6893
6894#endif
The Qgis class provides global constants for use throughout the application.
Definition qgis.h:54
DistanceUnitType
Types of distance units.
Definition qgis.h:4900
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:4064
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:4148
QFlags< DatabaseProviderTableImportCapability > DatabaseProviderTableImportCapabilities
Definition qgis.h:5199
QFlags< BabelCommandFlag > BabelCommandFlags
Babel command flags.
Definition qgis.h:1980
MapToolUnit
Type of unit of tolerance value from settings.
Definition qgis.h:4806
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:5134
PointCloudSymbol
Rendering symbols for point cloud points.
Definition qgis.h:4092
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:4731
ExpressionType
Expression types.
Definition qgis.h:5316
MapLayerActionFlag
Map layer action flags.
Definition qgis.h:4476
ScaleBarDistanceLabelVerticalPlacement
Scale bar distance label vertical placement.
Definition qgis.h:5120
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:4465
VectorTileProviderCapability
Enumeration with capabilities that vector tile data providers might implement.
Definition qgis.h:5362
AltitudeClamping
Altitude clamping.
Definition qgis.h:3828
VectorTileProviderFlag
Flags for vector tile data providers.
Definition qgis.h:5344
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:4189
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:4297
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:4821
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:5028
Q_ENUM(GpsFixStatus)
RelationshipStrength
Relationship strength.
Definition qgis.h:4250
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:4167
LegendComponent
Component of legends which can be styled.
Definition qgis.h:4401
Point3DShape
3D point shape types.
Definition qgis.h:3970
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:5704
BrowserItemState
Browser item states.
Definition qgis.h:902
AttributeEditorContainerType
Attribute editor container types.
Definition qgis.h:5257
QFlags< TiledSceneProviderCapability > TiledSceneProviderCapabilities
Tiled scene data provider capabilities.
Definition qgis.h:5405
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:5622
SymbolRenderHint
Flags controlling behavior of symbols during rendering.
Definition qgis.h:733
AngleUnit
Units of angles.
Definition qgis.h:4963
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:5287
QFlags< AuthConfigurationStorageCapability > AuthConfigurationStorageCapabilities
Authentication configuration storage capabilities.
Definition qgis.h:145
QFlags< LayerTreeFilterFlag > LayerTreeFilterFlags
Layer tree filter flags.
Definition qgis.h:4390
LayerTreeInsertionMethod
Layer tree insertion methods.
Definition qgis.h:4367
RasterProviderCapability
Raster data provider capabilities.
Definition qgis.h:4711
DatabaseProviderTableImportCapability
Represents capabilities of a database provider connection when importing table data.
Definition qgis.h:5194
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:5518
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:5179
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:4070
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:4588
QFlags< VectorLayerTypeFlag > VectorLayerTypeFlags
Vector layer type flags.
Definition qgis.h:395
ScaleBarAlignment
Scalebar alignment.
Definition qgis.h:5091
RasterPyramidFormat
Raster pyramid formats.
Definition qgis.h:4627
VectorExportResult
Vector layer export result codes.
Definition qgis.h:1016
DistanceUnit
Units of distance.
Definition qgis.h:4838
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:5818
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:3920
AttributeFormPythonInitCodeSource
The Python init code source for attribute forms.
Definition qgis.h:5302
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:4380
AttributeFormLayout
Available form types for layout of the attribute form editor.
Definition qgis.h:5272
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:5496
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:3815
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:4740
RasterDrawingStyle
Raster drawing styles.
Definition qgis.h:4604
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:5830
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:4179
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:4698
Q_ENUM(VectorProfileType)
AttributeActionType
Attribute action types.
Definition qgis.h:4500
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:4915
StringStatistic
Available string statistics.
Definition qgis.h:5684
FieldDomainMergePolicy
Merge policy for field domains.
Definition qgis.h:3774
ZonalStatistic
Statistics to be calculated during a zonal statistics operation.
Definition qgis.h:5537
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
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:5414
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:5740
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:4217
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:4435
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:5208
AvoidIntersectionsMode
Flags which control how intersections of pre-existing feature are handled when digitizing new feature...
Definition qgis.h:4119
MarkerShape
Marker shapes.
Definition qgis.h:2974
LegendJsonRenderFlag
Legend JSON export flags.
Definition qgis.h:4420
BlendMode
Blending modes defining the available composition modes that can be used when painting.
Definition qgis.h:4755
RasterElevationMode
Raster layer elevation modes.
Definition qgis.h:3867
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:5062
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:3958
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:4984
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:5381
ProjectFlag
Flags which control the behavior of QgsProjects.
Definition qgis.h:3938
FeatureRendererFlag
Flags controlling behavior of vector feature renderers.
Definition qgis.h:792
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:4236
ScriptLanguageCapability
Script language capabilities.
Definition qgis.h:4346
RasterInterfaceCapability
Raster interface capabilities.
Definition qgis.h:4678
JoinStyle
Join styles for buffers.
Definition qgis.h:2084
PointCloudDrawOrder
Pointcloud rendering order for 2d views.
Definition qgis.h:4104
QFlags< RasterBandStatistic > RasterBandStatistics
Statistics to be calculated for raster bands.
Definition qgis.h:5731
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:3789
UserProfileSelectionPolicy
User profile selection policy.
Definition qgis.h:5223
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:3841
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:5474
MapLayerActionTarget
Map layer action targets.
Definition qgis.h:4450
ShaderClassificationMethod
Color ramp shader classification methods.
Definition qgis.h:1403
ZonalStatisticResult
Zonal statistics result codes.
Definition qgis.h:5572
ScriptLanguage
Scripting languages.
Definition qgis.h:4323
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:5395
LabelMultiLineAlignment
Text alignment for multi-line labels.
Definition qgis.h:1302
RasterBandStatistic
Available raster band statistics.
Definition qgis.h:5713
QFlags< VectorTileProviderCapability > VectorTileProviderCapabilities
Vector tile data provider capabilities.
Definition qgis.h:5372
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:5563
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:5786
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:4791
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:4026
QFlags< CoordinateTransformationFlag > CoordinateTransformationFlags
Coordinate transformation flags.
Definition qgis.h:2642
RelationshipCapability
Relationship capabilities.
Definition qgis.h:4276
RasterBuildPyramidOption
Raster pyramid building options.
Definition qgis.h:4642
QFlags< VectorProviderCapability > VectorProviderCapabilities
Vector data provider capabilities.
Definition qgis.h:500
NavigationMode
The navigation mode used by 3D cameras.
Definition qgis.h:4001
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:5442
PointCloudZoomOutRenderBehavior
Point cloud zoom out options.
Definition qgis.h:5855
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:5650
PlotToolFlag
Flags that control the way the QgsPlotTools operate.
Definition qgis.h:3954
RenderUnit
Rendering size units.
Definition qgis.h:5008
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:5075
QFlags< TiledSceneRequestFlag > TiledSceneRequestFlags
Flags which control how tiled scene requests behave.
Definition qgis.h:5465
QFlags< MapLayerActionFlag > MapLayerActionFlags
Map layer action flags.
Definition qgis.h:4489
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:3802
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:5106
Aggregate
Available aggregates to calculate.
Definition qgis.h:5590
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:4198
LayoutUnitType
Types of layout units.
Definition qgis.h:5048
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:5455
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:4262
GradientType
Gradient types.
Definition qgis.h:3086
QFlags< ScriptLanguageCapability > ScriptLanguageCapabilities
Script language capabilities.
Definition qgis.h:4358
VectorProfileType
Types of elevation profiles to generate for vector sources.
Definition qgis.h:4052
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:3853
QFlags< ProjectFlag > ProjectFlags
Definition qgis.h:3945
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:4288
QFlags< SymbolRenderHint > SymbolRenderHints
Symbol render hints.
Definition qgis.h:741
VolumeUnit
Units of volume.
Definition qgis.h:4940
AttributeEditorType
Attribute editor types.
Definition qgis.h:5238
QFlags< LegendJsonRenderFlag > LegendJsonRenderFlags
Definition qgis.h:4424
QFlags< ProviderStyleStorageCapability > ProviderStyleStorageCapabilities
Definition qgis.h:5214
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:5844
ProfileExportType
Types of export for elevation profiles.
Definition qgis.h:4079
MeshElevationMode
Mesh layer elevation modes.
Definition qgis.h:3881
ProjectFileFormat
Flags which control project read behavior.
Definition qgis.h:4134
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:4537
ProfileSurfaceSymbology
Surface symbology type for elevation profile plots.
Definition qgis.h:4039
LabelPlacementEngineVersion
Labeling placement engine version.
Definition qgis.h:2787
Q_ENUM(ProcessingAlgorithmFlag)
ColorModel
Color model types.
Definition qgis.h:5760
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:5158
SegmentCalculationMethod
brief Method used to calculate the number of segments for circle approximation
Definition qgis.h:5867
GpsConnectionType
GPS connection types.
Definition qgis.h:1823
Q_ENUM(InputControllerType)
QFlags< DatabaseProviderConnectionCapability2 > DatabaseProviderConnectionCapabilities2
Definition qgis.h:5185
MouseHandlesAction
Action to be performed by the mouse handles.
Definition qgis.h:5798
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:3894
QFlags< VectorTileProviderFlag > VectorTileProviderFlags
Vector tile data provider flags.
Definition qgis.h:5354
MetadataDateType
Date types for metadata.
Definition qgis.h:4518
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:4657
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:3907
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:5430
QFlags< DateTimeStatistic > DateTimeStatistics
Statistics to be calculated for date/time values.
Definition qgis.h:5675
SelectionRenderingMode
Specifies how a selection should be rendered.
Definition qgis.h:1721
InputControllerType
Input controller types.
Definition qgis.h:5146
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:5487
DocumentationApi
Documentation API.
Definition qgis.h:5772
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:4014
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:4310
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:5331
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:5659
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:3989
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.
This is 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.
This class represents a coordinate reference system (CRS).
Class for doing transforms between two map 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.
This class 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
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.
The QgsMapLayerProxyModel class provides an easy to use model to display the list of layers in widget...
Base class for all map layer types.
Definition qgsmaplayer.h:76
The QgsMapSettings class contains configuration for rendering of the map.
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.
This class describes the origin of min/max values.
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.
The QgsScaleBarSettings class stores the appearance and layout settings for scalebar drawing with Qgs...
Represent settings entry and provides methods for reading and writing settings values.
RAII signal blocking class.
Definition qgis.h:6083
Object * operator->()
Returns pointer to blocked QObject.
Definition qgis.h:6101
QgsSignalBlocker(Object *object)
Constructor for QgsSignalBlocker.
Definition qgis.h:6090
Abstract base class for simple marker symbol layers.
This is a container for configuration of the snapping of 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 ...
This is the class is providing tolerance value in map unit values.
Helper functions for various unit types.
Implementation of data provider temporal properties for QgsVectorDataProviders.
This is the 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 data sets.
This class contains information how to simplify 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
void * qgsMalloc(size_t size)
Allocates size bytes and returns a pointer to the allocated memory.
Definition qgis.cpp:94
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:87
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:248
uint qHash(const QVariant &variant)
Hash for QVariant.
Definition qgis.cpp:199
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:73
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:80
void qgsFree(void *ptr)
Frees the memory space pointed to by ptr.
Definition qgis.cpp:116
QString qgsVsiPrefix(const QString &path)
Definition qgis.cpp:194
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:121
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:189
CONSTLATIN1STRING geoNone()
Constant that holds the string representation for "No ellips/No CRS".
Definition qgis.h:6714
const double DEFAULT_LINE_WIDTH
Definition qgis.h:6752
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:6606
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:6429
QString qgsDoubleToString(double a, int precision=17)
Returns a string representation of a double.
Definition qgis.h:6136
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:6293
QString qgsEnumValueToKey(const T &value, bool *returnOk=nullptr)
Returns the value for the given key of an enum.
Definition qgis.h:6410
QString qgsFlagValueToKeys(const T &value, bool *returnOk=nullptr)
Returns the value for the given keys of a flag.
Definition qgis.h:6468
const long GEO_EPSG_CRS_ID
Magic number for a geographic coord sys in EpsgCrsId ID format.
Definition qgis.h:6738
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:6276
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:6490
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:6767
const QMap< T, QString > qgsEnumMap()
Returns a map of all enum entries.
Definition qgis.h:6393
bool qgsFloatNear(float a, float b, float epsilon=4 *FLT_EPSILON)
Compare two floats (but allow some difference)
Definition qgis.h:6230
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:6310
const QList< T > qgsEnumList()
Returns a list all enum entries.
Definition qgis.h:6376
double qgsRound(double number, int places)
Returns a double number, rounded (as close as possible) to the specified number of places.
Definition qgis.h:6260
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference)
Definition qgis.h:6219
CONSTLATIN1STRING geoProj4()
PROJ4 string that represents a geographic coord sys.
Definition qgis.h:6702
bool qgsNanCompatibleEquals(double a, double b)
Compare two doubles, treating nan values as equal.
Definition qgis.h:6181
QgsSignalBlocker< Object > whileBlocking(Object *object)
Temporarily blocks signals from a QObject while calling a single method from the object.
Definition qgis.h:6123
const double DEFAULT_SEGMENT_EPSILON
Default snapping tolerance for segments.
Definition qgis.h:6755
QMap< QString, QString > QgsStringMap
Definition qgis.h:6757
#define CONSTLATIN1STRING
Definition qgis.h:6655
CONSTLATIN1STRING geoWkt()
Wkt string that represents a geographic coord sys.
Definition qgis.h:6694
bool qgsDoubleNearSig(double a, double b, int significantDigits=10)
Compare two doubles using specified number of significant digits.
Definition qgis.h:6236
const int USER_CRS_START_ID
Magick number that determines whether a projection crsid is a system (srs.db) or user (~/....
Definition qgis.h:6744
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:6201
const long GEOSRID
Magic number for a geographic coord sys in POSTGIS SRID.
Definition qgis.h:6732
#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:6620
CONSTLATIN1STRING geoEpsgCrsAuthId()
Geographic coord sys from EPSG authority.
Definition qgis.h:6708
const long GEOCRS_ID
Magic number for a geographic coord sys in QGIS srs.db tbl_srs.srs_id.
Definition qgis.h:6735
const double DEFAULT_POINT_SIZE
Magic number that determines the default point size for point symbols.
Definition qgis.h:6751
#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