QGIS API Documentation 3.99.0-Master (21b3aa880ba)
Loading...
Searching...
No Matches
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 <cfloat>
23#include <cmath>
24#include <memory>
25
26#include "qgis_core.h"
27#include "qgis_sip.h"
28
29#include <QMetaEnum>
30#include <QTimeZone>
31
32#ifdef SIP_RUN
33% ModuleHeaderCode
34#include <qgis.h>
35% End
36
37% ModuleCode
38int QgisEvent = QEvent::User + 1;
39% End
40#endif
41
42#ifndef SIP_RUN
43// qHash implementation for scoped enum type
44// https://gitlab.com/frostasm/programming-knowledge-base/-/snippets/20120
45#define QHASH_FOR_CLASS_ENUM(T) \
46 inline uint qHash(const T &t, uint seed) { \
47 return ::qHash(static_cast<typename std::underlying_type<T>::type>(t), seed); \
48 }
49#endif
50
55class CORE_EXPORT Qgis
56{
57 Q_GADGET
58 Q_CLASSINFO( "RegisterEnumClassesUnscoped", "false" )
59
60 public:
61
67 static QString version();
68
74 static int versionInt();
75
81 static QString releaseName();
82
84 static const char *QGIS_DEV_VERSION;
85
91 static QString devVersion();
92
93 // Enumerations
94 //
95
102 {
103 ClearStorage = 1 << 0,
104
105 ReadConfiguration = 1 << 1,
106 UpdateConfiguration = 1 << 2,
107 DeleteConfiguration = 1 << 3,
108 CreateConfiguration = 1 << 4,
109
110 ReadCertificateIdentity = 1 << 5,
111 UpdateCertificateIdentity = 1 << 6,
112 DeleteCertificateIdentity = 1 << 7,
113 CreateCertificateIdentity = 1 << 8,
114
115 ReadSslCertificateCustomConfig = 1 << 9,
116 UpdateSslCertificateCustomConfig = 1 << 10,
117 DeleteSslCertificateCustomConfig = 1 << 11,
118 CreateSslCertificateCustomConfig = 1 << 12,
119
120 ReadCertificateAuthority = 1 << 13,
121 UpdateCertificateAuthority = 1 << 14,
122 DeleteCertificateAuthority = 1 << 15,
123 CreateCertificateAuthority = 1 << 16,
124
125 ReadCertificateTrustPolicy = 1 << 17,
126 UpdateCertificateTrustPolicy = 1 << 18,
127 DeleteCertificateTrustPolicy = 1 << 19,
128 CreateCertificateTrustPolicy = 1 << 20,
129
130 ReadMasterPassword = 1 << 21,
131 UpdateMasterPassword = 1 << 22,
132 DeleteMasterPassword = 1 << 23,
133 CreateMasterPassword = 1 << 24,
134
135 ReadSetting = 1 << 25,
136 UpdateSetting = 1 << 26,
137 DeleteSetting = 1 << 27,
138 CreateSetting = 1 << 28,
139
140 };
141 Q_ENUM( AuthConfigurationStorageCapability )
142
143
149
150
156 {
157 Info = 0,
162 };
163 Q_ENUM( MessageLevel )
164
165
170 enum class NetworkRequestFlag : int SIP_ENUM_BASETYPE( IntFlag )
171 {
172 DisableMessageLogging = 1 << 0,
173 };
174 Q_ENUM( NetworkRequestFlag )
175
176
182 Q_FLAG( NetworkRequestFlags )
183
190 {
191 Vector SIP_MONKEYPATCH_COMPAT_NAME( VectorLayer ),
192 Raster SIP_MONKEYPATCH_COMPAT_NAME( RasterLayer ),
193 Plugin SIP_MONKEYPATCH_COMPAT_NAME( PluginLayer ),
194 Mesh SIP_MONKEYPATCH_COMPAT_NAME( MeshLayer ),
195 VectorTile SIP_MONKEYPATCH_COMPAT_NAME( VectorTileLayer ),
196 Annotation SIP_MONKEYPATCH_COMPAT_NAME( AnnotationLayer ),
197 PointCloud SIP_MONKEYPATCH_COMPAT_NAME( PointCloudLayer ),
198 Group SIP_MONKEYPATCH_COMPAT_NAME( GroupLayer ),
199 TiledScene,
200 };
201 Q_ENUM( LayerType )
202
203
209 {
210 RasterLayer = 1,
211 NoGeometry = 2,
212 PointLayer = 4,
213 LineLayer = 8,
214 PolygonLayer = 16,
215 HasGeometry = PointLayer | LineLayer | PolygonLayer,
216 VectorLayer = NoGeometry | HasGeometry,
217 PluginLayer = 32,
218 WritableLayer = 64,
219 MeshLayer = 128,
220 VectorTileLayer = 256,
221 PointCloudLayer = 512,
222 AnnotationLayer = 1024,
223 TiledSceneLayer = 2048,
224 All = RasterLayer | VectorLayer | PluginLayer | MeshLayer | VectorTileLayer | PointCloudLayer | AnnotationLayer | TiledSceneLayer,
225 SpatialLayer = RasterLayer | HasGeometry | PluginLayer | MeshLayer | VectorTileLayer | PointCloudLayer | AnnotationLayer | TiledSceneLayer
226 };
227 Q_DECLARE_FLAGS( LayerFilters, LayerFilter )
228 Q_FLAG( LayerFilters )
229
230
235 enum class LoadStyleFlag : int SIP_ENUM_BASETYPE( IntFlag )
236 {
237 IgnoreMissingStyleErrors = 1 << 0,
238 };
239 Q_ENUM( LoadStyleFlag )
240
241
246 Q_DECLARE_FLAGS( LoadStyleFlags, LoadStyleFlag )
247 Q_FLAG( LoadStyleFlags )
248
277 {
278 Unknown = 0,
279 Point = 1,
280 LineString = 2,
281 Polygon = 3,
282 Triangle = 17,
283 MultiPoint = 4,
284 MultiLineString = 5,
285 MultiPolygon = 6,
286 GeometryCollection = 7,
287 CircularString = 8,
288 CompoundCurve = 9,
289 CurvePolygon = 10,
290 MultiCurve = 11,
291 MultiSurface = 12,
292 PolyhedralSurface = 15,
293 TIN = 16,
294 NoGeometry = 100,
295 PointZ = 1001,
296 LineStringZ = 1002,
297 PolygonZ = 1003,
298 TriangleZ = 1017,
299 MultiPointZ = 1004,
300 MultiLineStringZ = 1005,
301 MultiPolygonZ = 1006,
302 GeometryCollectionZ = 1007,
303 CircularStringZ = 1008,
304 CompoundCurveZ = 1009,
305 CurvePolygonZ = 1010,
306 MultiCurveZ = 1011,
307 MultiSurfaceZ = 1012,
308 PolyhedralSurfaceZ = 1015,
309 TINZ = 1016,
310 PointM = 2001,
311 LineStringM = 2002,
312 PolygonM = 2003,
313 TriangleM = 2017,
314 MultiPointM = 2004,
315 MultiLineStringM = 2005,
316 MultiPolygonM = 2006,
317 GeometryCollectionM = 2007,
318 CircularStringM = 2008,
319 CompoundCurveM = 2009,
320 CurvePolygonM = 2010,
321 MultiCurveM = 2011,
322 MultiSurfaceM = 2012,
323 PolyhedralSurfaceM = 2015,
324 TINM = 2016,
325 PointZM = 3001,
326 LineStringZM = 3002,
327 PolygonZM = 3003,
328 MultiPointZM = 3004,
329 MultiLineStringZM = 3005,
330 MultiPolygonZM = 3006,
331 GeometryCollectionZM = 3007,
332 CircularStringZM = 3008,
333 CompoundCurveZM = 3009,
334 CurvePolygonZM = 3010,
335 MultiCurveZM = 3011,
336 MultiSurfaceZM = 3012,
337 PolyhedralSurfaceZM = 3015,
338 TINZM = 3016,
339 TriangleZM = 3017,
340 Point25D = 0x80000001,
341 LineString25D,
342 Polygon25D,
343 MultiPoint25D,
344 MultiLineString25D,
345 MultiPolygon25D
346 };
347 Q_ENUM( WkbType )
348
349
358 {
359 Point SIP_MONKEYPATCH_COMPAT_NAME( PointGeometry ),
360 Line SIP_MONKEYPATCH_COMPAT_NAME( LineGeometry ),
361 Polygon SIP_MONKEYPATCH_COMPAT_NAME( PolygonGeometry ),
362 Unknown SIP_MONKEYPATCH_COMPAT_NAME( UnknownGeometry ),
363 Null SIP_MONKEYPATCH_COMPAT_NAME( NullGeometry ),
364 };
365 Q_ENUM( GeometryType )
366
367
372 {
373 UnknownDataType = 0,
374 Byte = 1,
375 Int8 = 14,
376 UInt16 = 2,
377 Int16 = 3,
378 UInt32 = 4,
379 Int32 = 5,
380 Float32 = 6,
381 Float64 = 7,
382 CInt16 = 8,
383 CInt32 = 9,
384 CFloat32 = 10,
385 CFloat64 = 11,
386 ARGB32 = 12,
387 ARGB32_Premultiplied = 13
388 };
389 Q_ENUM( DataType )
390
391
396 enum class CaptureTechnique : int
397 {
398 StraightSegments,
399 CircularString,
400 Streaming,
401 Shape,
402 };
403 Q_ENUM( CaptureTechnique )
404
405
410 enum class VectorLayerTypeFlag : int SIP_ENUM_BASETYPE( IntFlag )
411 {
412 SqlQuery = 1 << 0
413 };
414 Q_ENUM( VectorLayerTypeFlag )
417 Q_FLAG( VectorLayerTypeFlags )
418
423 enum class EmbeddedScriptMode SIP_MONKEYPATCH_SCOPEENUM_UNNEST( Qgis, PythonMacroMode ) : int
424 {
425 Never = 0,
426 Ask = 1,
427 SessionOnly = 2,
428 Always = 3,
429 NotForThisSession = 4,
430 NeverAsk = 5,
431 };
432 Q_ENUM( EmbeddedScriptMode )
433
434
438 enum class EmbeddedScriptType : int
439 {
440 Macro = 0,
441 ExpressionFunction = 1,
442 Action = 2,
443 FormInitCode = 3,
444 };
445 Q_ENUM( EmbeddedScriptType )
446
447
451 enum class ProjectTrustStatus : int
452 {
453 Undetermined = 0,
454 Trusted = 1,
455 Untrusted = 2,
456 };
457 Q_ENUM( ProjectTrustStatus )
458
459
467 {
468 TrustDataSource SIP_MONKEYPATCH_COMPAT_NAME( FlagTrustDataSource ) = 1 << 0,
469 SkipFeatureCount = 1 << 1,
470 LoadDefaultStyle SIP_MONKEYPATCH_COMPAT_NAME( FlagLoadDefaultStyle ) = 1 << 2,
471 SkipGetExtent = 1 << 3,
472 SkipFullScan = 1 << 4,
473 ForceReadOnly = 1 << 5,
474 SkipCredentialsRequest = 1 << 6,
475 ParallelThreadLoading = 1 << 7,
476 };
477 Q_ENUM( DataProviderReadFlag )
478
479
487 Q_FLAG( DataProviderReadFlags )
488
489 // TODO QGIS 4 -- remove NoCapabilities and rely on VectorProviderCapabilities() instead
490
499 {
500 NoCapabilities = 0,
501 AddFeatures = 1,
502 DeleteFeatures = 1 << 1,
503 ChangeAttributeValues = 1 << 2,
504 AddAttributes = 1 << 3,
505 DeleteAttributes = 1 << 4,
506 CreateSpatialIndex = 1 << 6,
507 SelectAtId = 1 << 7,
508 ChangeGeometries = 1 << 8,
509 SelectEncoding = 1 << 13,
510 CreateAttributeIndex = 1 << 12,
511 SimplifyGeometries = 1 << 14,
512 SimplifyGeometriesWithTopologicalValidation = 1 << 15,
513 TransactionSupport = 1 << 16,
514 CircularGeometries = 1 << 17,
515 ChangeFeatures = 1 << 18,
516 RenameAttributes = 1 << 19,
517 FastTruncate = 1 << 20,
518 ReadLayerMetadata = 1 << 21,
519 WriteLayerMetadata = 1 << 22,
520 CancelSupport = 1 << 23,
521 CreateRenderer = 1 << 24,
522 CreateLabeling = 1 << 25,
523 ReloadData = 1 << 26,
524 FeatureSymbology = 1 << 27,
525 EditingCapabilities = AddFeatures | DeleteFeatures | ChangeAttributeValues | ChangeGeometries | AddAttributes | DeleteAttributes | RenameAttributes,
526 };
527 Q_ENUM( VectorProviderCapability )
528
529
538
545 {
546 Uncounted = -2,
547 UnknownCount = -1,
548 };
549 Q_ENUM( FeatureCountState )
550
551
558 {
559 Unknown SIP_MONKEYPATCH_COMPAT_NAME( SpatialIndexUnknown ) = 0,
560 NotPresent SIP_MONKEYPATCH_COMPAT_NAME( SpatialIndexNotPresent ) = 1,
561 Present SIP_MONKEYPATCH_COMPAT_NAME( SpatialIndexPresent ) = 2,
562 };
563 Q_ENUM( SpatialIndexPresence )
564
565
577 {
578 NoFeaturesAvailable = 0,
579 FeaturesAvailable,
580 FeaturesMaybeAvailable
581 };
582 Q_ENUM( FeatureAvailability )
583
584
590 {
591 EditAlias = 1 << 0,
592 EditComment = 1 << 1,
593 };
594
595 Q_ENUM( VectorDataProviderAttributeEditCapability )
596
597
604
610 {
611 Marker,
612 Line,
613 Fill,
614 Hybrid
615 };
616 Q_ENUM( SymbolType )
617
618
624 {
625 ScaleArea,
626 ScaleDiameter
627 };
628 Q_ENUM( ScaleMethod )
629
630
635 {
636 Custom,
637 Variant,
638 String,
639 StringList,
640 VariantMap,
641 Bool,
642 Integer,
643 Double,
644 EnumFlag,
645 Color
646 };
647 Q_ENUM( SettingsType )
648
649
654 {
655 Root,
656 Standard,
657 NamedList,
658 };
659 Q_ENUM( SettingsTreeNodeType )
660
661
665 enum class SettingsTreeNodeOption : int SIP_ENUM_BASETYPE( IntFlag )
666 {
667 NamedListSelectedItemSetting = 1 << 0,
668 };
669
670 Q_ENUM( SettingsTreeNodeOption )
673
682 {
683 Invalid SIP_MONKEYPATCH_COMPAT_NAME( InvalidProperty ),
684 Static SIP_MONKEYPATCH_COMPAT_NAME( StaticProperty ),
685 Field SIP_MONKEYPATCH_COMPAT_NAME( FieldBasedProperty ),
686 Expression SIP_MONKEYPATCH_COMPAT_NAME( ExpressionBasedProperty ),
687 };
688 Q_ENUM( PropertyType )
689
690
695 enum class SldExportOption : int SIP_ENUM_BASETYPE( IntFlag )
696 {
697 NoOptions = 0,
698 Svg = 1 << 0,
699 Png = 1 << 1,
700 };
701 Q_ENUM( SldExportOption )
703 Q_FLAG( SldExportOptions )
704
710 enum class SldExportVendorExtension : int SIP_ENUM_BASETYPE( IntFlag )
711 {
712 NoVendorExtension = 0,
713 GeoServerVendorExtension = 1 << 1,
714 DeegreeVendorExtension = 1 << 2,
715 };
716 Q_ENUM( SldExportVendorExtension )
717
718
719
723 enum class SettingsOption : int SIP_ENUM_BASETYPE( IntFlag )
724 {
725 SaveFormerValue = 1 << 1,
726 SaveEnumFlagAsInt = 1 << 2,
727 };
728 Q_ENUM( SettingsOption )
729 Q_DECLARE_FLAGS( SettingsOptions, SettingsOption )
730 Q_FLAG( SettingsOptions )
731
737 {
738 ActiveLayer = 1,
739 AllLayers = 2,
740 AdvancedConfiguration = 3,
741 };
742 Q_ENUM( SnappingMode )
743
744
749 {
750 NoSnap SIP_MONKEYPATCH_COMPAT_NAME( NoSnapFlag ) = 0,
751 Vertex SIP_MONKEYPATCH_COMPAT_NAME( VertexFlag ) = 1 << 0,
752 Segment SIP_MONKEYPATCH_COMPAT_NAME( SegmentFlag ) = 1 << 1,
753 Area SIP_MONKEYPATCH_COMPAT_NAME( AreaFlag ) = 1 << 2,
754 Centroid SIP_MONKEYPATCH_COMPAT_NAME( CentroidFlag ) = 1 << 3,
755 MiddleOfSegment SIP_MONKEYPATCH_COMPAT_NAME( MiddleOfSegmentFlag ) = 1 << 4,
756 LineEndpoint SIP_MONKEYPATCH_COMPAT_NAME( LineEndpointFlag ) = 1 << 5,
757 };
758 Q_ENUM( SnappingType )
761 Q_FLAG( SnappingTypes )
762
769 {
770 DynamicRotation = 1 << 1,
771 IsSymbolLayerSubSymbol = 1 << 2,
772 ForceVectorRendering = 1 << 3,
773 ExcludeSymbolBuffers = 1 << 4,
774 };
775 Q_ENUM( SymbolRenderHint )
778 Q_FLAG( SymbolRenderHints )
779
785 enum class SymbolRotationMode : int
786 {
787 RespectMapRotation,
788 IgnoreMapRotation,
789 };
790 Q_ENUM( SymbolRotationMode )
791
792
793
805 Q_ENUM( HorizontalAnchorPoint )
806
807
820 Q_ENUM( VerticalAnchorPoint )
821
822
827 enum class FeatureRendererFlag : int SIP_ENUM_BASETYPE( IntFlag )
828 {
829 AffectsLabeling = 1 << 0,
830 };
831 Q_ENUM( FeatureRendererFlag )
832
833
839 Q_FLAG( FeatureRendererFlags )
840
846 enum class SymbolFlag : int SIP_ENUM_BASETYPE( IntFlag )
847 {
848 RendererShouldUseSymbolLevels = 1 << 0,
849 AffectsLabeling = 1 << 1,
850 };
851 Q_ENUM( SymbolFlag )
853 Q_DECLARE_FLAGS( SymbolFlags, SymbolFlag )
854 Q_FLAG( SymbolFlags )
855
862 {
863 FlagIncludeCrosshairsForMarkerSymbols = 1 << 0,
864 };
865 Q_ENUM( SymbolPreviewFlag )
868 Q_FLAG( SymbolPreviewFlags )
869
879 enum class SymbolLayerFlag : int SIP_ENUM_BASETYPE( IntFlag )
880 {
881 DisableFeatureClipping = 1 << 0,
882 CanCalculateMaskGeometryPerFeature = 1 << 1,
883 AffectsLabeling = 1 << 2,
884 };
885 Q_ENUM( SymbolLayerFlag )
888 Q_FLAG( SymbolLayerFlags )
889
899 enum class SymbolLayerUserFlag : int SIP_ENUM_BASETYPE( IntFlag )
900 {
901 DisableSelectionRecoloring = 1 << 0,
902 };
903 Q_ENUM( SymbolLayerUserFlag )
904
905
911 Q_FLAG( SymbolLayerUserFlags )
912
919 {
920 Collection,
921 Directory,
922 Layer,
923 Error,
924 Favorites,
925 Project,
926 Custom,
927 Fields,
928 Field,
929 };
930 Q_ENUM( BrowserItemType )
931
932
938 {
939 NotPopulated,
940 Populating,
941 Populated,
942 };
943 Q_ENUM( BrowserItemState )
944
945
951 {
952 NoCapabilities = 0,
953 SetCrs = 1 << 0,
954 Fertile = 1 << 1,
955 Fast = 1 << 2,
956 Collapse = 1 << 3,
957 Rename = 1 << 4,
958 Delete = 1 << 5,
959 ItemRepresentsFile = 1 << 6,
960 RefreshChildrenWhenItemIsRefreshed = 1 << 7,
961 ReadOnly = 1 << 8,
962 };
963 Q_ENUM( BrowserItemCapability )
967
976 {
977 NoCapabilities SIP_MONKEYPATCH_COMPAT_NAME( NoDataCapabilities ) = 0,
978 Files SIP_MONKEYPATCH_COMPAT_NAME( File ) = 1,
979 Directories SIP_MONKEYPATCH_COMPAT_NAME( Dir ) = 1 << 1,
980 Databases SIP_MONKEYPATCH_COMPAT_NAME( Database ) = 1 << 2,
981 NetworkSources SIP_MONKEYPATCH_COMPAT_NAME( Net ) = 1 << 3,
982 };
983 Q_ENUM( DataItemProviderCapability )
984
985
994
1001 {
1002 NoType,
1003 Vector,
1004 Raster,
1005 Point,
1006 Line,
1007 Polygon,
1008 TableLayer,
1009 Database,
1010 Table,
1011 Plugin,
1012 Mesh,
1013 VectorTile,
1014 PointCloud,
1015 TiledScene,
1016 };
1017 Q_ENUM( BrowserLayerType )
1018
1019
1025 {
1026 Default,
1027 NeverMonitor,
1028 AlwaysMonitor,
1029 };
1030 Q_ENUM( BrowserDirectoryMonitoring )
1031
1032
1036 enum class HttpMethod : int
1037 {
1038 Get = 0,
1039 Post = 1,
1040 Head,
1041 Put,
1042 Delete,
1043 };
1044 Q_ENUM( HttpMethod )
1045
1046
1052 {
1054 ErrorCreatingDataSource SIP_MONKEYPATCH_COMPAT_NAME( ErrCreateDataSource ),
1055 ErrorCreatingLayer SIP_MONKEYPATCH_COMPAT_NAME( ErrCreateLayer ),
1056 ErrorAttributeTypeUnsupported SIP_MONKEYPATCH_COMPAT_NAME( ErrAttributeTypeUnsupported ),
1057 ErrorAttributeCreationFailed SIP_MONKEYPATCH_COMPAT_NAME( ErrAttributeCreationFailed ),
1058 ErrorProjectingFeatures SIP_MONKEYPATCH_COMPAT_NAME( ErrProjection ),
1059 ErrorFeatureWriteFailed SIP_MONKEYPATCH_COMPAT_NAME( ErrFeatureWriteFailed ),
1060 ErrorInvalidLayer SIP_MONKEYPATCH_COMPAT_NAME( ErrInvalidLayer ),
1061 ErrorInvalidProvider SIP_MONKEYPATCH_COMPAT_NAME( ErrInvalidProvider ),
1062 ErrorProviderUnsupportedFeature SIP_MONKEYPATCH_COMPAT_NAME( ErrProviderUnsupportedFeature ),
1063 ErrorConnectionFailed SIP_MONKEYPATCH_COMPAT_NAME( ErrConnectionFailed ),
1064 UserCanceled SIP_MONKEYPATCH_COMPAT_NAME( ErrUserCanceled ),
1065 };
1066 Q_ENUM( VectorExportResult )
1067
1068
1073 {
1074 FieldAliases = 1 << 0,
1075 FieldComments = 1 << 2,
1076 };
1077 Q_ENUM( VectorFileWriterCapability )
1078
1079
1085
1091 {
1092 SubsetStringFilter = 1 << 1,
1093 GeometryColumn = 1 << 2,
1094 PrimaryKeys = 1 << 3,
1095 UnstableFeatureIds = 1 << 4
1096 };
1097 Q_ENUM( SqlLayerDefinitionCapability )
1101
1107 enum class SqlKeywordCategory : int
1108 {
1109 Keyword,
1110 Constant,
1111 Function,
1112 Geospatial,
1113 Operator,
1114 Math,
1116 String,
1117 Identifier
1118 };
1119 Q_ENUM( SqlKeywordCategory )
1120
1121
1125 enum class DriveType : int
1126 {
1127 Unknown,
1128 Invalid,
1129 Removable,
1130 Fixed,
1131 Remote,
1132 CdRom,
1133 RamDisk,
1134 Cloud,
1135 };
1136 Q_ENUM( DriveType )
1137
1138
1143 {
1144 Deferred SIP_MONKEYPATCH_COMPAT_NAME( DownloadLater ),
1145 Immediate SIP_MONKEYPATCH_COMPAT_NAME( DownloadImmediately ),
1146 };
1147 Q_ENUM( ActionStart )
1148
1149
1155 {
1156 FollowEngineSetting,
1157 NeverShow,
1158 };
1159 Q_ENUM( UnplacedLabelVisibility )
1160
1161
1166 enum class LabelOverlapHandling : int
1167 {
1168 PreventOverlap,
1169 AllowOverlapIfRequired,
1170 AllowOverlapAtNoCost,
1171 };
1172 Q_ENUM( LabelOverlapHandling )
1173
1174
1179 enum class LabelPrioritization : int
1180 {
1181 PreferCloser,
1182 PreferPositionOrdering,
1183 };
1184 Q_ENUM( LabelPrioritization )
1185
1186
1194 {
1195 AroundPoint,
1196 OverPoint,
1197 Line,
1198 Curved,
1199 Horizontal,
1200 Free,
1201 OrderedPositionsAroundPoint,
1202 PerimeterCurved,
1203 OutsidePolygons,
1204 };
1205 Q_ENUM( LabelPlacement )
1206
1207
1215 {
1216 TopLeft,
1217 TopSlightlyLeft,
1218 TopMiddle,
1219 TopSlightlyRight,
1220 TopRight,
1221 MiddleLeft,
1222 MiddleRight,
1223 BottomLeft,
1224 BottomSlightlyLeft,
1225 BottomMiddle,
1226 BottomSlightlyRight,
1227 BottomRight,
1228 OverPoint,
1229 };
1230 Q_ENUM( LabelPredefinedPointPosition )
1231
1232
1241 {
1242 FromPoint,
1243 FromSymbolBounds,
1244 };
1245 Q_ENUM( LabelOffsetType )
1246
1247
1255 {
1256 AboveLeft SIP_MONKEYPATCH_COMPAT_NAME( QuadrantAboveLeft ),
1257 Above SIP_MONKEYPATCH_COMPAT_NAME( QuadrantAbove ),
1258 AboveRight SIP_MONKEYPATCH_COMPAT_NAME( QuadrantAboveRight ),
1260 Over SIP_MONKEYPATCH_COMPAT_NAME( QuadrantOver ),
1262 BelowLeft SIP_MONKEYPATCH_COMPAT_NAME( QuadrantBelowLeft ),
1263 Below SIP_MONKEYPATCH_COMPAT_NAME( QuadrantBelow ),
1264 BelowRight SIP_MONKEYPATCH_COMPAT_NAME( QuadrantBelowRight ),
1265 };
1266 Q_ENUM( LabelQuadrantPosition )
1267
1268
1275 {
1276 OnLine = 1,
1277 AboveLine = 2,
1278 BelowLine = 4,
1279 MapOrientation = 8,
1280 };
1281 Q_ENUM( LabelLinePlacementFlag )
1282
1283
1291 Q_FLAG( LabelLinePlacementFlags )
1292
1300 {
1301 AllowPlacementOutsideOfPolygon = 1 << 0,
1302 AllowPlacementInsideOfPolygon = 1 << 1,
1303 };
1304 Q_ENUM( LabelPolygonPlacementFlag )
1305
1306
1314
1323 {
1324 FlipUpsideDownLabels SIP_MONKEYPATCH_COMPAT_NAME( Upright ),
1325 AllowUpsideDownWhenRotationIsDefined SIP_MONKEYPATCH_COMPAT_NAME( ShowDefined ),
1326 AlwaysAllowUpsideDown SIP_MONKEYPATCH_COMPAT_NAME( ShowAll )
1327 };
1328 Q_ENUM( UpsideDownLabelHandling )
1329
1330
1338 {
1340 Center SIP_MONKEYPATCH_COMPAT_NAME( MultiCenter ),
1342 FollowPlacement SIP_MONKEYPATCH_COMPAT_NAME( MultiFollowPlacement ),
1343 Justify SIP_MONKEYPATCH_COMPAT_NAME( MultiJustify ),
1344 };
1345 Q_ENUM( LabelMultiLineAlignment )
1346
1347
1354 {
1355 Vector SIP_MONKEYPATCH_COMPAT_NAME( FilterVector ) = 1,
1356 Raster SIP_MONKEYPATCH_COMPAT_NAME( FilterRaster ),
1357 Mesh SIP_MONKEYPATCH_COMPAT_NAME( FilterMesh ),
1358 MeshDataset SIP_MONKEYPATCH_COMPAT_NAME( FilterMeshDataset ),
1359 PointCloud SIP_MONKEYPATCH_COMPAT_NAME( FilterPointCloud ),
1360 VectorTile,
1361 TiledScene,
1362 };
1363 Q_ENUM( FileFilterType )
1364
1365
1370 enum class UriCleaningFlag : int SIP_ENUM_BASETYPE( IntFlag )
1371 {
1372 RemoveCredentials = 1 << 0,
1373 RedactCredentials = 1 << 1,
1374 };
1375 Q_ENUM( UriCleaningFlag )
1376
1377
1383 Q_FLAG( UriCleaningFlags )
1384
1390 enum class SublayerQueryFlag : int SIP_ENUM_BASETYPE( IntFlag )
1391 {
1392 FastScan = 1 << 0,
1393 ResolveGeometryType = 1 << 1,
1394 CountFeatures = 1 << 2,
1395 IncludeSystemTables = 1 << 3,
1396 OpenLayersToResolveDescriptions = 1 << 4,
1397 };
1398
1401 Q_FLAG( SublayerQueryFlags )
1402
1403
1408 enum class SublayerFlag : int SIP_ENUM_BASETYPE( IntFlag )
1409 {
1410 SystemTable = 1 << 0,
1411 };
1412
1413 Q_DECLARE_FLAGS( SublayerFlags, SublayerFlag )
1415 Q_FLAG( SublayerFlags )
1416
1417
1425 {
1426 Linear SIP_MONKEYPATCH_COMPAT_NAME( Interpolated ) = 0,
1427 Discrete = 1,
1428 Exact = 2,
1429 };
1430 Q_ENUM( ShaderInterpolationMethod )
1431
1432
1440 {
1441 Continuous = 1,
1442 EqualInterval = 2,
1443 Quantile = 3,
1444 };
1445 Q_ENUM( ShaderClassificationMethod )
1446
1447
1453 {
1454 Unknown SIP_MONKEYPATCH_COMPAT_NAME( UnknownRole ) = 0,
1455 Provider SIP_MONKEYPATCH_COMPAT_NAME( ProviderRole ) = 1,
1456 Renderer SIP_MONKEYPATCH_COMPAT_NAME( RendererRole ) = 2,
1457 Brightness SIP_MONKEYPATCH_COMPAT_NAME( BrightnessRole ) = 3,
1458 Resampler SIP_MONKEYPATCH_COMPAT_NAME( ResamplerRole ) = 4,
1459 Projector SIP_MONKEYPATCH_COMPAT_NAME( ProjectorRole ) = 5,
1460 Nuller SIP_MONKEYPATCH_COMPAT_NAME( NullerRole ) = 6,
1461 HueSaturation SIP_MONKEYPATCH_COMPAT_NAME( HueSaturationRole ) = 7,
1462 };
1463 Q_ENUM( RasterPipeInterfaceRole )
1464
1465
1470 {
1471 ResampleFilter,
1472 Provider,
1473 };
1474 Q_ENUM( RasterResamplingStage )
1475
1476
1484 {
1485 Nearest,
1486 Bilinear,
1487 Cubic,
1488 CubicSpline,
1489 Lanczos,
1490 Average,
1491 Mode,
1492 Gauss
1493 };
1494 Q_ENUM( RasterResamplingMethod )
1495
1496
1501 enum class RasterRendererFlag : int SIP_ENUM_BASETYPE( IntFlag )
1502 {
1503 InternalLayerOpacityHandling = 1 << 0,
1504 UseNoDataForOutOfRangePixels = 1 << 1,
1505 };
1506
1513
1515 Q_FLAG( RasterRendererFlags )
1516
1517
1523 {
1524 UsesMultipleBands = 1 << 0,
1525 };
1526 Q_ENUM( RasterRendererCapability )
1527
1528
1535
1544 {
1546 MinimumMaximum SIP_MONKEYPATCH_COMPAT_NAME( MinMax ),
1547 StdDev,
1548 CumulativeCut
1549 };
1550 Q_ENUM( RasterRangeLimit )
1551
1552
1560 {
1561 WholeRaster SIP_MONKEYPATCH_COMPAT_NAME( None_ ),
1562 FixedCanvas SIP_MONKEYPATCH_COMPAT_NAME( CurrentCanvas ),
1563 UpdatedCanvas,
1564 };
1565 Q_ENUM( RasterRangeExtent )
1566
1567
1575 {
1576 Exact,
1577 Estimated,
1578 };
1579 Q_ENUM( RasterRangeAccuracy )
1580
1581
1587 {
1588 Generic = 0,
1589 PixelCount = 1,
1590 Name = 2,
1591 Min = 3,
1592 Max = 4,
1593 MinMax = 5,
1594 Red = 6,
1595 Green = 7,
1596 Blue = 8,
1597 Alpha = 9,
1598 RedMin = 10,
1599 GreenMin = 11,
1600 BlueMin = 12,
1601 AlphaMin = 13,
1602 RedMax = 14,
1603 GreenMax = 15,
1604 BlueMax = 16,
1605 AlphaMax = 17,
1606 MaxCount
1607 };
1608 Q_ENUM( RasterAttributeTableFieldUsage )
1609
1610
1616 {
1617 Thematic = 0,
1618 Athematic = 1
1619 };
1620 Q_ENUM( RasterAttributeTableType )
1621
1622
1629 {
1630 Raw = 0,
1631 RenderedImage SIP_MONKEYPATCH_COMPAT_NAME( Image ) = 1
1632 };
1633 Q_ENUM( RasterExportType )
1634
1635
1642 {
1644 SourceProviderError = 1,
1645 DestinationProviderError SIP_MONKEYPATCH_COMPAT_NAME( DestProviderError ) = 2,
1646 CreateDatasourceError = 3,
1647 WriteError = 4,
1648 NoDataConflict = 5,
1649 Canceled SIP_MONKEYPATCH_COMPAT_NAME( WriteCanceled ) = 6,
1650 };
1651 Q_ENUM( RasterFileWriterResult )
1652
1653
1658 enum class MeshEditingErrorType : int
1659 {
1660 NoError,
1661 InvalidFace,
1662 TooManyVerticesInFace,
1663 FlatFace,
1664 UniqueSharedVertex,
1665 InvalidVertex,
1666 ManifoldFace,
1667 };
1668 Q_ENUM( MeshEditingErrorType )
1669
1670
1675 enum class FilePathType : int
1676 {
1677 Absolute,
1678 Relative,
1679 };
1680 Q_ENUM( FilePathType )
1681
1682
1687 enum class SublayerPromptMode : int
1688 {
1689 AlwaysAsk,
1690 AskExcludingRasterBands,
1691 NeverAskSkip,
1692 NeverAskLoadAll,
1693 };
1694 Q_ENUM( SublayerPromptMode )
1695
1696
1704 {
1705 Unknown SIP_MONKEYPATCH_COMPAT_NAME( OriginUnknown ),
1706 Provider SIP_MONKEYPATCH_COMPAT_NAME( OriginProvider ),
1707 Join SIP_MONKEYPATCH_COMPAT_NAME( OriginJoin ),
1708 Edit SIP_MONKEYPATCH_COMPAT_NAME( OriginEdit ),
1709 Expression SIP_MONKEYPATCH_COMPAT_NAME( OriginExpression )
1710 };
1711 Q_ENUM( FieldOrigin )
1712
1713
1720 enum class FieldConfigurationFlag : int SIP_ENUM_BASETYPE( IntFlag )
1721 {
1722 NoFlag = 0,
1723 NotSearchable = 1 << 1,
1724 HideFromWms = 1 << 2,
1725 HideFromWfs = 1 << 3,
1726 };
1727 Q_ENUM( FieldConfigurationFlag )
1728
1729
1737 Q_FLAG( FieldConfigurationFlags )
1738
1744 enum class FieldMetadataProperty : int
1745 {
1746 GeometryCrs = 0x1000,
1747 GeometryWkbType = 0x1001,
1748 CustomProperty = 0x100000,
1749 };
1750 Q_ENUM( FieldMetadataProperty )
1751
1752
1757 enum class SelectionRenderingMode : int
1758 {
1759 Default,
1760 CustomColor,
1761 CustomSymbol,
1762 };
1763 Q_ENUM( SelectionRenderingMode )
1764
1765
1771 {
1772 SetSelection,
1773 AddToSelection,
1774 IntersectSelection,
1775 RemoveFromSelection,
1776 };
1777 Q_ENUM( SelectBehavior )
1778
1779
1785 {
1786 Intersect,
1787 Within,
1788 };
1789 Q_ENUM( SelectGeometryRelationship )
1790
1791
1796 enum class SelectionFlag : int SIP_ENUM_BASETYPE( IntFlag )
1797 {
1798 SingleFeatureSelection = 1 << 0,
1799 ToggleSelection = 1 << 1,
1800 };
1801
1807 Q_DECLARE_FLAGS( SelectionFlags, SelectionFlag )
1808
1810 Q_FLAG( SelectionFlags )
1811
1812
1818 {
1820 EmptyGeometry = 1,
1821 EditFailed = 2,
1822 FetchFeatureFailed = 3,
1823 InvalidLayer = 4,
1824 };
1825 Q_ENUM( VectorEditResult )
1826
1827
1833 {
1834 SemiTransparentCircle,
1835 Cross,
1836 NoMarker,
1837 };
1838 Q_ENUM( VertexMarkerType )
1839
1840
1844 enum class ContentStatus : int
1845 {
1846 NotStarted,
1847 Running,
1848 Finished,
1849 Failed,
1850 Canceled,
1851 };
1852 Q_ENUM( ContentStatus )
1853
1854
1859 enum class GpsConnectionType : int
1860 {
1861 Automatic,
1862 Internal,
1863 Serial,
1864 Gpsd,
1865 };
1866 Q_ENUM( GpsConnectionType )
1867
1868
1873 enum class DeviceConnectionStatus SIP_MONKEYPATCH_SCOPEENUM_UNNEST( Qgis, GpsConnectionStatus ) : int
1874 {
1875 Disconnected,
1876 Connecting,
1877 Connected,
1878 };
1879 Q_ENUM( DeviceConnectionStatus )
1880
1881
1889 {
1890 NoData,
1891 NoFix,
1892 Fix2D,
1893 Fix3D
1894 };
1896
1897
1904 {
1905 Unknown,
1906 Gps,
1907 Glonass,
1908 Galileo,
1909 BeiDou,
1910 Qzss,
1911 Navic,
1912 Sbas,
1913 };
1915
1922 {
1923 Unknown = -1,
1924 Invalid,
1925 GPS,
1926 DGPS,
1927 PPS,
1928 RTK,
1929 FloatRTK,
1930 Estimated,
1931 Manual,
1932 Simulation,
1933 };
1934 Q_ENUM( GpsQualityIndicator )
1935
1936
1941 enum class GpsNavigationStatus : int
1942 {
1943 NotValid,
1944 Safe,
1945 Caution,
1946 Unsafe,
1947 };
1949
1955 enum class GpsInformationComponent : int SIP_ENUM_BASETYPE( IntFlag )
1956 {
1957 Location = 1 << 0,
1958 Altitude = 1 << 1,
1959 GroundSpeed = 1 << 2,
1960 Bearing = 1 << 3,
1961 TotalTrackLength = 1 << 4,
1962 TrackDistanceFromStart = 1 << 5,
1963 Pdop = 1 << 6,
1964 Hdop = 1 << 7,
1965 Vdop = 1 << 8,
1966 HorizontalAccuracy = 1 << 9,
1967 VerticalAccuracy = 1 << 10,
1968 HvAccuracy = 1 << 11,
1969 SatellitesUsed = 1 << 12,
1970 Timestamp = 1 << 13,
1971 TrackStartTime = 1 << 14,
1972 TrackEndTime = 1 << 15,
1973 TrackDistanceSinceLastPoint = 1 << 16,
1974 TrackTimeSinceLastPoint = 1 << 17,
1975 GeoidalSeparation = 1 << 18,
1976 EllipsoidAltitude = 1 << 19,
1977 };
1978
1986 Q_FLAG( GpsInformationComponents )
1987
1988
1993 enum class BabelFormatCapability : int SIP_ENUM_BASETYPE( IntFlag )
1994 {
1995 Import = 1 << 0,
1996 Export = 1 << 1,
1997 Waypoints = 1 << 2,
1998 Routes = 1 << 3,
1999 Tracks = 1 << 4,
2000 };
2001
2004 Q_FLAG( BabelFormatCapabilities )
2005
2006
2012 enum class BabelCommandFlag : int SIP_ENUM_BASETYPE( IntFlag )
2013 {
2014 QuoteFilePaths = 1 << 0,
2015 };
2016
2019 Q_FLAG( BabelCommandFlags )
2020
2021
2026 enum class GpsFeatureType : int
2027 {
2028 Waypoint,
2029 Route,
2030 Track,
2031 };
2032 Q_ENUM( GpsFeatureType )
2033
2034
2042 {
2044 NothingHappened = 1000,
2045 InvalidBaseGeometry,
2046 InvalidInputGeometryType,
2047 SelectionIsEmpty,
2048 SelectionIsGreaterThanOne,
2049 GeometryEngineError,
2050 LayerNotEditable,
2051 // Add part issues
2052 AddPartSelectedGeometryNotFound,
2053 AddPartNotMultiGeometry,
2054 // Add ring issues
2055 AddRingNotClosed,
2056 AddRingNotValid,
2057 AddRingCrossesExistingRings,
2058 AddRingNotInExistingFeature,
2059 // Split features
2060 SplitCannotSplitPoint,
2061 GeometryTypeHasChanged,
2062 };
2063 Q_ENUM( GeometryOperationResult )
2064
2065
2071 {
2072 AllowSelfTouchingHoles SIP_MONKEYPATCH_COMPAT_NAME( FlagAllowSelfTouchingHoles ) = 1 << 0,
2073 };
2074
2077 Q_FLAG( GeometryValidityFlags )
2078
2079
2084 {
2085 QgisInternal SIP_MONKEYPATCH_COMPAT_NAME( ValidatorQgisInternal ),
2086 Geos SIP_MONKEYPATCH_COMPAT_NAME( ValidatorGeos ),
2087 };
2088 Q_ENUM( GeometryValidationEngine )
2089
2090
2100 Q_ENUM( BufferSide )
2101
2102
2113 Q_ENUM( EndCapStyle )
2114
2115
2121 {
2122 Round SIP_MONKEYPATCH_COMPAT_NAME( JoinStyleRound ) = 1,
2123 Miter SIP_MONKEYPATCH_COMPAT_NAME( JoinStyleMiter ),
2124 Bevel SIP_MONKEYPATCH_COMPAT_NAME( JoinStyleBevel ),
2125 };
2126 Q_ENUM( JoinStyle )
2127
2128
2133 enum class JoinStyle3D : int
2134 {
2135 Round = 1,
2136 Flat,
2137 CylindersAndSpheres,
2138 };
2139 Q_ENUM( JoinStyle3D )
2140
2141
2146 enum class GeosCreationFlag : int SIP_ENUM_BASETYPE( IntFlag )
2147 {
2148 RejectOnInvalidSubGeometry = 1 << 0,
2149 SkipEmptyInteriorRings = 1 << 1,
2150 };
2151 Q_ENUM( GeosCreationFlag )
2152
2153
2159 Q_FLAG( GeosCreationFlags )
2160
2166 enum class CoverageValidityResult : int
2167 {
2168 Invalid = 0,
2169 Valid = 1,
2170 Error = 2,
2171 };
2172 Q_ENUM( CoverageValidityResult )
2173
2174
2179 enum class MakeValidMethod : int
2180 {
2181 Linework = 0,
2182 Structure = 1,
2183 };
2184 Q_ENUM( MakeValidMethod )
2185
2186
2194 {
2195 NoFlags = 0,
2196 NoGeometry = 1,
2197 SubsetOfAttributes = 2,
2198 ExactIntersect = 4,
2199 IgnoreStaticNodesDuringExpressionCompilation = 8,
2200 EmbeddedSymbols = 16,
2201 };
2202 Q_ENUM( FeatureRequestFlag )
2203
2204
2212 Q_FLAG( FeatureRequestFlags )
2213
2222 {
2223 NoFilter SIP_MONKEYPATCH_COMPAT_NAME( FilterNone ),
2225 Expression SIP_MONKEYPATCH_COMPAT_NAME( FilterExpression ),
2227 };
2228 Q_ENUM( FeatureRequestFilterType )
2229
2230
2238 {
2239 NoCheck SIP_MONKEYPATCH_COMPAT_NAME( GeometryNoCheck ) = 0,
2240 SkipInvalid SIP_MONKEYPATCH_COMPAT_NAME( GeometrySkipInvalid ) = 1,
2241 AbortOnInvalid SIP_MONKEYPATCH_COMPAT_NAME( GeometryAbortOnInvalid ) = 2,
2242 };
2243 Q_ENUM( InvalidGeometryCheck )
2244
2245
2250 enum class SpatialFilterType : int
2251 {
2252 NoFilter,
2253 BoundingBox,
2254 DistanceWithin,
2255 };
2256 Q_ENUM( SpatialFilterType )
2257
2258
2263 enum class FileOperationFlag : int SIP_ENUM_BASETYPE( IntFlag )
2264 {
2265 IncludeMetadataFile = 1 << 0,
2266 IncludeStyleFile = 1 << 1,
2267 };
2268
2271 Q_FLAG( FileOperationFlags )
2272
2273
2278 enum class MapLayerProperty : int SIP_ENUM_BASETYPE( IntFlag )
2279 {
2280 UsersCannotToggleEditing = 1 << 0,
2281 IsBasemapLayer = 1 << 1,
2282 Is3DBasemapLayer = 1 << 2,
2283 };
2284
2287 Q_FLAG( MapLayerProperties )
2288
2289
2294 enum class AutoRefreshMode : int
2295 {
2296 Disabled = 0,
2297 ReloadData = 1,
2298 RedrawOnly = 2,
2299 };
2300 Q_ENUM( AutoRefreshMode )
2301
2302
2307 enum class DataProviderFlag : int SIP_ENUM_BASETYPE( IntFlag )
2308 {
2309 IsBasemapSource = 1 << 1,
2310 FastExtent2D = 1 << 2,
2311 FastExtent3D = 1 << 3,
2312 Is3DBasemapSource = 1 << 4,
2313 };
2314
2317 Q_FLAG( DataProviderFlags )
2318
2319
2326 enum class CrsType : int
2327 {
2328 Unknown,
2329 Geodetic,
2330 Geocentric,
2331 Geographic2d,
2332 Geographic3d,
2333 Vertical,
2334 Projected,
2335 Compound,
2336 Temporal,
2337 Engineering,
2338 Bound,
2339 Other,
2340 DerivedProjected,
2341 };
2342 Q_ENUM( CrsType )
2343
2344
2351 enum class CrsAxisDirection : int
2352 {
2353 North,
2354 NorthNorthEast,
2355 NorthEast,
2356 EastNorthEast,
2357 East,
2358 EastSouthEast,
2359 SouthEast,
2360 SouthSouthEast,
2361 South,
2362 SouthSouthWest,
2363 SouthWest,
2364 WestSouthWest,
2365 West,
2366 WestNorthWest,
2367 NorthWest,
2368 NorthNorthWest,
2369 GeocentricX,
2370 GeocentricY,
2371 GeocentricZ,
2374 Forward,
2375 Aft,
2376 Port,
2377 Starboard,
2378 Clockwise,
2379 CounterClockwise,
2380 ColumnPositive,
2381 ColumnNegative,
2382 RowPositive,
2383 RowNegative,
2384 DisplayRight,
2385 DisplayLeft,
2386 DisplayUp,
2387 DisplayDown,
2388 Future,
2389 Past,
2390 Towards,
2391 AwayFrom,
2392 Unspecified,
2393 };
2394 Q_ENUM( CrsAxisDirection )
2395
2396
2401 enum class CoordinateOrder : int
2402 {
2403 Default,
2404 XY,
2405 YX,
2406 };
2407 Q_ENUM( CoordinateOrder )
2408
2409
2417 {
2418 ShortString,
2419 MediumString,
2420 FullString,
2421 };
2422 Q_ENUM( CrsIdentifierType )
2423
2424
2432 {
2433 Wkt1Gdal SIP_MONKEYPATCH_COMPAT_NAME( WKT1_GDAL ),
2434 Wkt1Esri SIP_MONKEYPATCH_COMPAT_NAME( WKT1_ESRI ),
2435 Wkt2_2015 SIP_MONKEYPATCH_COMPAT_NAME( WKT2_2015 ),
2436 Wkt2_2015Simplified SIP_MONKEYPATCH_COMPAT_NAME( WKT2_2015_SIMPLIFIED ),
2437 Wkt2_2019 SIP_MONKEYPATCH_COMPAT_NAME( WKT2_2019 ),
2438 Wkt2_2019Simplified SIP_MONKEYPATCH_COMPAT_NAME( WKT2_2019_SIMPLIFIED ),
2439 Preferred SIP_MONKEYPATCH_COMPAT_NAME( WKT_PREFERRED ) = Wkt2_2019,
2440 PreferredSimplified SIP_MONKEYPATCH_COMPAT_NAME( WKT_PREFERRED_SIMPLIFIED ) = Wkt2_2019Simplified,
2441 PreferredGdal SIP_MONKEYPATCH_COMPAT_NAME( WKT_PREFERRED_GDAL ) = Wkt2_2019,
2442 };
2443 Q_ENUM( CrsWktVariant )
2444
2445
2450 enum class Axis : int
2451 {
2452 X,
2453 Y,
2455 };
2456 Q_ENUM( Axis )
2457
2458
2463 enum class AnnotationItemFlag : int SIP_ENUM_BASETYPE( IntFlag )
2464 {
2465 ScaleDependentBoundingBox = 1 << 0,
2466 SupportsReferenceScale = 1 << 1,
2467 SupportsCallouts = 1 << 2,
2468 };
2469
2472 Q_FLAG( AnnotationItemFlags )
2473
2474
2480 {
2481 SpatialBounds = 0,
2482 FixedSize,
2483 RelativeToMapFrame,
2484 };
2485 Q_ENUM( AnnotationPlacementMode )
2486
2487
2492 enum class AnnotationItemGuiFlag : int SIP_ENUM_BASETYPE( IntFlag )
2493 {
2494 FlagNoCreationTools = 1 << 0,
2495 };
2496
2499 Q_FLAG( AnnotationItemGuiFlags )
2500
2501
2506 enum class AnnotationItemNodeType : int
2507 {
2508 VertexHandle,
2509 CalloutHandle,
2510 };
2511 Q_ENUM( AnnotationItemNodeType )
2512
2513
2519 {
2521 Invalid,
2522 ItemCleared,
2523 };
2524 Q_ENUM( AnnotationItemEditOperationResult )
2525
2526
2534 {
2535 Disabled SIP_MONKEYPATCH_COMPAT_NAME( NavigationOff ),
2536 Animated,
2537 FixedRange,
2538 Movie,
2539 };
2540 Q_ENUM( TemporalNavigationMode )
2541
2542
2555 Q_ENUM( AnimationState )
2556
2557
2562 enum class PlaybackOperation : int
2563 {
2564 SkipToStart,
2565 PreviousFrame,
2566 PlayReverse,
2567 Pause,
2568 PlayForward,
2569 NextFrame,
2570 SkipToEnd,
2571 };
2572 Q_ENUM( PlaybackOperation )
2573
2574
2580 {
2581 FixedTemporalRange SIP_MONKEYPATCH_COMPAT_NAME( ModeFixedTemporalRange ) = 0,
2582 FeatureDateTimeInstantFromField SIP_MONKEYPATCH_COMPAT_NAME( ModeFeatureDateTimeInstantFromField ),
2583 FeatureDateTimeStartAndEndFromFields SIP_MONKEYPATCH_COMPAT_NAME( ModeFeatureDateTimeStartAndEndFromFields ),
2584 FeatureDateTimeStartAndDurationFromFields SIP_MONKEYPATCH_COMPAT_NAME( ModeFeatureDateTimeStartAndDurationFromFields ),
2585 FeatureDateTimeStartAndEndFromExpressions SIP_MONKEYPATCH_COMPAT_NAME( ModeFeatureDateTimeStartAndEndFromExpressions ),
2586 RedrawLayerOnly SIP_MONKEYPATCH_COMPAT_NAME( ModeRedrawLayerOnly ),
2587 };
2588 Q_ENUM( VectorTemporalMode )
2589
2590
2596 {
2597 IncludeBeginExcludeEnd = 0,
2598 IncludeBeginIncludeEnd,
2599 };
2600 Q_ENUM( VectorTemporalLimitMode )
2601
2602
2608 {
2609 HasFixedTemporalRange SIP_MONKEYPATCH_COMPAT_NAME( ProviderHasFixedTemporalRange ) = 0,
2610 StoresFeatureDateTimeInstantInField SIP_MONKEYPATCH_COMPAT_NAME( ProviderStoresFeatureDateTimeInstantInField ),
2611 StoresFeatureDateTimeStartAndEndInSeparateFields SIP_MONKEYPATCH_COMPAT_NAME( ProviderStoresFeatureDateTimeStartAndEndInSeparateFields ),
2612 };
2613 Q_ENUM( VectorDataProviderTemporalMode )
2614
2615
2621 {
2622 FixedTemporalRange SIP_MONKEYPATCH_COMPAT_NAME( ModeFixedTemporalRange ) = 0,
2623 TemporalRangeFromDataProvider SIP_MONKEYPATCH_COMPAT_NAME( ModeTemporalRangeFromDataProvider ) = 1,
2624 RedrawLayerOnly SIP_MONKEYPATCH_COMPAT_NAME( ModeRedrawLayerOnly ) = 2,
2625 FixedRangePerBand = 3,
2626 RepresentsTemporalValues = 4,
2627 FixedDateTime = 5,
2628 };
2629 Q_ENUM( RasterTemporalMode )
2630
2631
2637 {
2638 MatchUsingWholeRange,
2639 MatchExactUsingStartOfRange,
2640 MatchExactUsingEndOfRange,
2641 FindClosestMatchToStartOfRange,
2642 FindClosestMatchToEndOfRange
2643 };
2644 Q_ENUM( TemporalIntervalMatchMethod )
2645
2646
2652 {
2653 RequestedTimesMustExactlyMatchAllAvailableTemporalRanges = 1 << 0,
2654 };
2655 Q_ENUM( RasterTemporalCapabilityFlag )
2656
2657
2664
2675 Q_ENUM( TransformDirection )
2676
2677
2683 {
2684 BallparkTransformsAreAppropriate = 1 << 0,
2685 IgnoreImpossibleTransformations = 1 << 1,
2686 };
2687 Q_ENUM( CoordinateTransformationFlag )
2688
2689
2696
2703 {
2704 Default,
2705 PreferVector,
2706 ForceVector,
2707 };
2708 Q_ENUM( RasterizedRenderingPolicy )
2709
2710
2716 {
2717 Antialiasing = 0x01,
2718 DrawEditingInfo = 0x02,
2719 ForceVectorOutput = 0x04,
2720 UseAdvancedEffects = 0x08,
2721 DrawLabeling = 0x10,
2722 UseRenderingOptimization = 0x20,
2723 DrawSelection = 0x40,
2724 DrawSymbolBounds = 0x80,
2725 RenderMapTile = 0x100,
2726 RenderPartialOutput = 0x200,
2727 RenderPreviewJob = 0x400,
2728 RenderBlocking = 0x800,
2729 LosslessImageRendering = 0x1000,
2730 Render3DMap = 0x2000,
2731 HighQualityImageTransforms = 0x4000,
2732 SkipSymbolRendering = 0x8000,
2733 ForceRasterMasks = 0x10000,
2734 RecordProfile = 0x20000,
2735 AlwaysUseGlobalMasks = 0x40000,
2736 };
2737
2740 Q_FLAG( MapSettingsFlags )
2741
2742
2748 {
2749 DrawEditingInfo = 0x01,
2750 ForceVectorOutput = 0x02,
2751 UseAdvancedEffects = 0x04,
2752 UseRenderingOptimization = 0x08,
2753 DrawSelection = 0x10,
2754 DrawSymbolBounds = 0x20,
2755 RenderMapTile = 0x40,
2756 Antialiasing = 0x80,
2757 RenderPartialOutput = 0x100,
2758 RenderPreviewJob = 0x200,
2759 RenderBlocking = 0x400,
2760 RenderSymbolPreview = 0x800,
2761 LosslessImageRendering = 0x1000,
2762 ApplyScalingWorkaroundForTextRendering = 0x2000,
2763 Render3DMap = 0x4000,
2764 ApplyClipAfterReprojection = 0x8000,
2765 RenderingSubSymbol = 0x10000,
2766 HighQualityImageTransforms = 0x20000,
2767 SkipSymbolRendering = 0x40000,
2768 RecordProfile = 0x80000,
2769 AlwaysUseGlobalMasks = 0x100000,
2770 DisableSymbolClippingToExtent = 0x200000,
2771 RenderLayerTree = 0x400000
2772 };
2773
2776 Q_FLAG( RenderContextFlags )
2777
2778
2783 enum class MapLayerRendererFlag : int SIP_ENUM_BASETYPE( IntFlag )
2784 {
2785 RenderPartialOutputs = 1 << 0,
2786 RenderPartialOutputOverPreviousCachedImage = 1 << 1,
2787 AffectsLabeling = 1 << 2,
2788 };
2789 Q_ENUM( MapLayerRendererFlag )
2790
2791
2797 Q_FLAG( MapLayerRendererFlags )
2798
2804 enum class PaintEffectFlag : int SIP_ENUM_BASETYPE( IntFlag )
2805 {
2806 RequiresRasterization = 1 << 0,
2807 };
2808 Q_ENUM( PaintEffectFlag )
2809
2810
2816 Q_FLAG( PaintEffectFlags )
2817
2818 // refs for below dox: https://github.com/qgis/QGIS/pull/1286#issuecomment-39806854
2819 // https://github.com/qgis/QGIS/pull/8573#issuecomment-445585826
2820
2826 {
2827 AlwaysOutlines SIP_MONKEYPATCH_COMPAT_NAME( TextFormatAlwaysOutlines ),
2828 AlwaysText SIP_MONKEYPATCH_COMPAT_NAME( TextFormatAlwaysText ),
2829 PreferText,
2830 };
2831 Q_ENUM( TextRenderFormat )
2832
2833
2841 {
2842 UseAllLabels = 1 << 1,
2843 UsePartialCandidates = 1 << 2,
2844 // TODO QGIS 4.0: remove
2845 RenderOutlineLabels = 1 << 3,
2846 DrawLabelRectOnly = 1 << 4,
2847 DrawCandidates = 1 << 5,
2848 DrawUnplacedLabels = 1 << 6,
2849 CollectUnplacedLabels = 1 << 7,
2850 DrawLabelMetrics = 1 << 8,
2851 };
2852 Q_ENUM( LabelingFlag )
2853
2854
2862 Q_FLAG( LabelingFlags )
2863
2872 {
2873 Version1 SIP_MONKEYPATCH_COMPAT_NAME( PlacementEngineVersion1 ),
2874 Version2 SIP_MONKEYPATCH_COMPAT_NAME( PlacementEngineVersion2 ),
2875 };
2876 Q_ENUM( LabelPlacementEngineVersion )
2877
2878
2886 {
2887 Horizontal SIP_MONKEYPATCH_COMPAT_NAME( HorizontalOrientation ),
2888 Vertical SIP_MONKEYPATCH_COMPAT_NAME( VerticalOrientation ),
2889 RotationBased SIP_MONKEYPATCH_COMPAT_NAME( RotationBasedOrientation ),
2890 };
2891 Q_ENUM( TextOrientation )
2892
2893
2901 {
2903 Point,
2905 RectangleCapHeightBased,
2906 RectangleAscentBased,
2907 };
2908 Q_ENUM( TextLayoutMode )
2909
2910
2918 {
2919 Text = 1 << 0,
2920 Buffer = 1 << 1,
2921 Background = 1 << 2,
2922 Shadow = 1 << 3,
2923 };
2924 Q_ENUM( TextComponent )
2925
2926
2931 Q_DECLARE_FLAGS( TextComponents, TextComponent )
2932 Q_FLAG( TextComponents )
2933
2948 Q_ENUM( TextHorizontalAlignment )
2949
2950
2961 {
2963 VerticalCenter SIP_MONKEYPATCH_COMPAT_NAME( AlignVCenter ),
2964 Bottom SIP_MONKEYPATCH_COMPAT_NAME( AlignBottom ),
2965 };
2966 Q_ENUM( TextVerticalAlignment )
2967
2968
2977 {
2978 Normal,
2979 SuperScript,
2980 SubScript,
2981 };
2982 Q_ENUM( TextCharacterVerticalAlignment )
2983
2984
2990 {
2991 TruncateStringWhenLineIsTooShort = 1 << 0,
2992 UseBaselinePlacement = 1 << 1,
2993 UprightCharactersOnly = 1 << 2,
2994 ExtendLineToFitText = 1 << 3,
2995 };
2996 Q_ENUM( CurvedTextFlag )
2997
2998
3004
3013 {
3014 Distance = 0,
3015 SnapToGrid = 1,
3016 Visvalingam = 2,
3017 SnappedToGridGlobal = 3,
3018 };
3019 Q_ENUM( VectorSimplificationAlgorithm )
3020
3021
3029 {
3030 NoSimplification = 0,
3031 GeometrySimplification = 1,
3032 AntialiasingSimplification = 2,
3033 FullSimplification = 3,
3034 };
3035 Q_ENUM( VectorRenderingSimplificationFlag )
3036
3037
3046
3053 {
3054 Generic,
3055 ShadowOffset,
3056 BlurSize,
3057 GlowSpread,
3058 };
3059 Q_ENUM( RenderSubcomponentProperty )
3060
3061
3066 {
3067 Segment SIP_MONKEYPATCH_COMPAT_NAME( SegmentVertex ) = 1,
3068 Curve SIP_MONKEYPATCH_COMPAT_NAME( CurveVertex ) = 2,
3069 };
3070 Q_ENUM( VertexType )
3071
3072
3080 {
3081 Square,
3082 Diamond,
3083 Pentagon,
3084 Hexagon,
3085 Triangle,
3086 EquilateralTriangle,
3087 Star,
3088 Arrow,
3089 Circle,
3090 Cross,
3091 CrossFill,
3092 Cross2,
3093 Line,
3094 ArrowHead,
3095 ArrowHeadFilled,
3096 SemiCircle,
3097 ThirdCircle,
3098 QuarterCircle,
3099 QuarterSquare,
3100 HalfSquare,
3101 DiagonalHalfSquare,
3102 RightHalfTriangle,
3103 LeftHalfTriangle,
3104 Octagon,
3105 SquareWithCorners,
3106 AsteriskFill,
3107 HalfArc,
3108 ThirdArc,
3109 QuarterArc,
3110 ParallelogramRight,
3111 ParallelogramLeft,
3112 Trapezoid,
3113 Shield,
3114 DiamondStar,
3115 Heart,
3116 Decagon,
3117 RoundedSquare,
3118 };
3119 Q_ENUM( MarkerShape )
3120
3121
3129 {
3130 Interval = 1 << 0,
3131 Vertex = 1 << 1,
3132 LastVertex = 1 << 2,
3133 FirstVertex = 1 << 3,
3134 CentralPoint = 1 << 4,
3135 CurvePoint = 1 << 5,
3136 SegmentCenter = 1 << 6,
3137 InnerVertices = 1 << 7,
3138 };
3139 Q_ENUM( MarkerLinePlacement )
3141 Q_FLAG( MarkerLinePlacements )
3142
3149 {
3150 IntervalCartesian2D = 1 << 0,
3151 IntervalZ = 1 << 1,
3152 IntervalM = 1 << 2,
3153 Vertex = 1 << 3,
3154 };
3155 Q_ENUM( LinearReferencingPlacement )
3156
3157
3163 {
3164 CartesianDistance2D,
3165 Z,
3166 M,
3167 };
3168 Q_ENUM( LinearReferencingLabelSource )
3169
3170
3178 {
3179 SimpleTwoColor,
3180 ColorRamp,
3181 };
3182 Q_ENUM( GradientColorSource )
3183
3184
3197 Q_ENUM( GradientType )
3198
3199
3207 {
3208 Feature,
3209 Viewport,
3210 };
3211 Q_ENUM( SymbolCoordinateReference )
3212
3213
3227 Q_ENUM( GradientSpread )
3228
3229
3237 {
3238 Absolute SIP_MONKEYPATCH_COMPAT_NAME( AbsoluteCount ),
3239 DensityBased SIP_MONKEYPATCH_COMPAT_NAME( DensityBasedCount ),
3240 };
3241 Q_ENUM( PointCountMethod )
3242
3243
3248 enum class MarkerClipMode : int
3249 {
3250 NoClipping,
3251 Shape,
3252 CentroidWithin,
3253 CompletelyWithin,
3254 };
3255 Q_ENUM( MarkerClipMode )
3256
3257
3262 enum class LineClipMode : int
3263 {
3264 ClipPainterOnly,
3265 ClipToIntersection,
3266 NoClipping,
3267 };
3268 Q_ENUM( LineClipMode )
3269
3270
3276 {
3277 NoRule,
3278 FullDash,
3279 HalfDash,
3280 FullGap,
3281 HalfGap,
3282 };
3283 Q_ENUM( DashPatternLineEndingRule )
3284
3285
3291 {
3292 ScaleBothDashAndGap,
3293 ScaleDashOnly,
3294 ScaleGapOnly,
3295 };
3296 Q_ENUM( DashPatternSizeAdjustment )
3297
3298
3310 Q_ENUM( GraduatedMethod )
3311
3312
3318 {
3319 NoLabels,
3320 EveryLabel,
3321 FirstLabel,
3322 LastLabel,
3323 FirstAndLastLabels,
3324 };
3325 Q_ENUM( PlotAxisSuffixPlacement )
3326
3327
3328
3333 enum class PlotAxisType
3334 {
3335 Interval,
3336 Categorical,
3337 };
3338 Q_ENUM( PlotAxisType )
3339
3340
3345 enum class PieChartLabelType : int
3346 {
3347 NoLabels,
3348 Categories,
3349 Values,
3350 };
3351 Q_ENUM( PieChartLabelType )
3352
3353
3357 enum class DpiMode
3358 {
3359 All = 7,
3360 Off = 0,
3361 QGIS = 1,
3362 UMN = 2,
3363 GeoServer = 4,
3364 };
3365 Q_ENUM( DpiMode )
3366
3367
3372 {
3373 Undefined = 0,
3374 StandardDpi = 1,
3375 HighDpi = 2,
3376 };
3377 Q_ENUM( TilePixelRatio )
3378
3379 // NOTE -- the hardcoded numbers here must match QFont::Capitalization!
3380
3381
3389 {
3390 MixedCase = 0,
3391 AllUppercase = 1,
3392 AllLowercase = 2,
3393 ForceFirstLetterToCapital = 4,
3394 SmallCaps = 5,
3395 TitleCase = 1004,
3396 UpperCamelCase = 1005,
3397 AllSmallCaps = 1006,
3398 };
3399 Q_ENUM( Capitalization )
3400
3401
3406 enum class TextRendererFlag : int SIP_ENUM_BASETYPE( IntFlag )
3407 {
3408 WrapLines = 1 << 0,
3409 };
3410 Q_ENUM( TextRendererFlag )
3412 Q_FLAG( TextRendererFlags )
3413
3420 {
3421 MapBox,
3422 Esri,
3423 };
3425
3432 {
3433 Clockwise,
3434 CounterClockwise,
3435 NoOrientation,
3436 };
3437 Q_ENUM( AngularDirection )
3438
3439
3444 enum class RendererUsage : int
3445 {
3446 View,
3447 Export,
3448 Unknown,
3449 };
3450 Q_ENUM( RendererUsage )
3451
3452
3457 enum class MapCanvasFlag : int SIP_ENUM_BASETYPE( IntFlag )
3458 {
3459 ShowMainAnnotationLayer = 1 << 0,
3460 };
3461 Q_ENUM( MapCanvasFlag )
3462
3463
3468 Q_DECLARE_FLAGS( MapCanvasFlags, MapCanvasFlag )
3469 Q_FLAG( MapCanvasFlags )
3470
3476 enum class ViewSyncModeFlag : int SIP_ENUM_BASETYPE( IntFlag )
3477 {
3478 Sync3DTo2D = 1 << 0,
3479 Sync2DTo3D = 1 << 1,
3480 };
3481 Q_ENUM( ViewSyncModeFlag )
3483
3490 {
3491 Always,
3492 WhenOutsideVisibleExtent,
3493 Never,
3494 };
3495 Q_ENUM( MapRecenteringMode )
3496
3497
3502 enum class HistoryProviderBackend : int SIP_ENUM_BASETYPE( IntFlag )
3503 {
3504 LocalProfile = 1 << 0,
3505// Project = 1 << 1, //!< QGIS Project (not yet implemented)
3506 };
3507 Q_ENUM( HistoryProviderBackend )
3509 Q_FLAG( HistoryProviderBackends )
3510
3516 enum class QueryStorageBackend : int
3517 {
3518 LocalProfile,
3519 CurrentProject,
3520 };
3521 Q_ENUM( QueryStorageBackend )
3522
3523
3531 {
3532 MapLayer SIP_MONKEYPATCH_COMPAT_NAME( TypeMapLayer ) = -2,
3533 VectorAnyGeometry SIP_MONKEYPATCH_COMPAT_NAME( TypeVectorAnyGeometry ) = -1,
3534 VectorPoint SIP_MONKEYPATCH_COMPAT_NAME( TypeVectorPoint ) = 0,
3535 VectorLine SIP_MONKEYPATCH_COMPAT_NAME( TypeVectorLine ) = 1,
3536 VectorPolygon SIP_MONKEYPATCH_COMPAT_NAME( TypeVectorPolygon ) = 2,
3537 Raster SIP_MONKEYPATCH_COMPAT_NAME( TypeRaster ) = 3,
3538 File SIP_MONKEYPATCH_COMPAT_NAME( TypeFile ) = 4,
3539 Vector SIP_MONKEYPATCH_COMPAT_NAME( TypeVector ) = 5,
3540 Mesh SIP_MONKEYPATCH_COMPAT_NAME( TypeMesh ) = 6,
3541 Plugin SIP_MONKEYPATCH_COMPAT_NAME( TypePlugin ) = 7,
3542 PointCloud SIP_MONKEYPATCH_COMPAT_NAME( TypePointCloud ) = 8,
3543 Annotation SIP_MONKEYPATCH_COMPAT_NAME( TypeAnnotation ) = 9,
3544 VectorTile SIP_MONKEYPATCH_COMPAT_NAME( TypeVectorTile ) = 10,
3545 TiledScene = 11
3546 };
3547 Q_ENUM( ProcessingSourceType )
3548
3549
3550
3558 {
3559 DeemphasiseSearchResults SIP_MONKEYPATCH_COMPAT_NAME( FlagDeemphasiseSearchResults ) = 1 << 1,
3560 CompatibleWithVirtualRaster SIP_MONKEYPATCH_COMPAT_NAME( FlagCompatibleWithVirtualRaster ) = 1 << 2,
3561 };
3563
3572 Q_FLAG( ProcessingProviderFlags )
3573
3574
3582 {
3583 HideFromToolbox SIP_MONKEYPATCH_COMPAT_NAME( FlagHideFromToolbox ) = 1 << 1,
3584 HideFromModeler SIP_MONKEYPATCH_COMPAT_NAME( FlagHideFromModeler ) = 1 << 2,
3585 SupportsBatch SIP_MONKEYPATCH_COMPAT_NAME( FlagSupportsBatch ) = 1 << 3,
3586 CanCancel SIP_MONKEYPATCH_COMPAT_NAME( FlagCanCancel ) = 1 << 4,
3587 RequiresMatchingCrs SIP_MONKEYPATCH_COMPAT_NAME( FlagRequiresMatchingCrs ) = 1 << 5,
3588 NoThreading SIP_MONKEYPATCH_COMPAT_NAME( FlagNoThreading ) = 1 << 6,
3589 DisplayNameIsLiteral SIP_MONKEYPATCH_COMPAT_NAME( FlagDisplayNameIsLiteral ) = 1 << 7,
3590 SupportsInPlaceEdits SIP_MONKEYPATCH_COMPAT_NAME( FlagSupportsInPlaceEdits ) = 1 << 8,
3591 KnownIssues SIP_MONKEYPATCH_COMPAT_NAME( FlagKnownIssues ) = 1 << 9,
3592 CustomException SIP_MONKEYPATCH_COMPAT_NAME( FlagCustomException ) = 1 << 10,
3593 PruneModelBranchesBasedOnAlgorithmResults SIP_MONKEYPATCH_COMPAT_NAME( FlagPruneModelBranchesBasedOnAlgorithmResults ) = 1 << 11,
3594 SkipGenericModelLogging SIP_MONKEYPATCH_COMPAT_NAME( FlagSkipGenericModelLogging ) = 1 << 12,
3595 NotAvailableInStandaloneTool SIP_MONKEYPATCH_COMPAT_NAME( FlagNotAvailableInStandaloneTool ) = 1 << 13,
3596 RequiresProject SIP_MONKEYPATCH_COMPAT_NAME( FlagRequiresProject ) = 1 << 14,
3597 SecurityRisk = 1 << 15,
3598 Deprecated SIP_MONKEYPATCH_COMPAT_NAME( FlagDeprecated ) = HideFromToolbox | HideFromModeler,
3599 };
3601
3610 Q_FLAG( ProcessingAlgorithmFlags )
3611
3612
3618 {
3619 RegeneratesPrimaryKey = 1 << 0,
3620 RegeneratesPrimaryKeyInSomeScenarios = 1 << 1,
3621 RespectsEllipsoid = 1 << 2,
3622 };
3623 Q_ENUM( ProcessingAlgorithmDocumentationFlag )
3624
3625
3632
3642 {
3643 NotAvailable,
3644 Available,
3645 };
3646 Q_ENUM( ProcessingPropertyAvailability )
3647
3648
3656 {
3657 DefaultLevel = 0,
3658 Verbose,
3659 ModelDebug,
3660 };
3661 Q_ENUM( ProcessingLogLevel )
3662
3663
3671 {
3672 Standard,
3673 Batch,
3674 Modeler,
3675 };
3676 Q_ENUM( ProcessingMode )
3677
3678
3686 {
3687 OverrideDefaultGeometryCheck SIP_MONKEYPATCH_COMPAT_NAME( FlagOverrideDefaultGeometryCheck ) = 1 << 0,
3688 CreateIndividualOutputPerInputFeature SIP_MONKEYPATCH_COMPAT_NAME( FlagCreateIndividualOutputPerInputFeature ) = 1 << 1,
3689 };
3690 Q_ENUM( ProcessingFeatureSourceDefinitionFlag )
3691
3692
3701
3710 {
3711 SkipGeometryValidityChecks SIP_MONKEYPATCH_COMPAT_NAME( FlagSkipGeometryValidityChecks ) = 1 << 1,
3712 };
3713 Q_ENUM( ProcessingFeatureSourceFlag )
3714
3715
3724
3736 {
3737 ExposeToModeler = 1
3738 };
3739 Q_ENUM( ProcessingParameterTypeFlag )
3740
3741
3753
3762 {
3763 Advanced SIP_MONKEYPATCH_COMPAT_NAME( FlagAdvanced ) = 1 << 1,
3764 Hidden SIP_MONKEYPATCH_COMPAT_NAME( FlagHidden ) = 1 << 2,
3765 Optional SIP_MONKEYPATCH_COMPAT_NAME( FlagOptional ) = 1 << 3,
3766 IsModelOutput SIP_MONKEYPATCH_COMPAT_NAME( FlagIsModelOutput ) = 1 << 4,
3767 };
3768 Q_ENUM( ProcessingParameterFlag )
3769
3770
3778 Q_FLAG( ProcessingParameterFlags )
3779
3792 Q_ENUM( ProcessingFileParameterBehavior )
3793
3794
3806 Q_ENUM( ProcessingNumberParameterType )
3807
3808
3816 {
3817 Any = -1,
3818 Numeric = 0,
3819 String = 1,
3820 DateTime = 2,
3821 Binary = 3,
3822 Boolean = 4,
3823 };
3824 Q_ENUM( ProcessingFieldParameterDataType )
3825
3826
3839 Q_ENUM( ProcessingDateTimeParameterDataType )
3840
3841
3847 {
3848 ModelParameter,
3849 ChildOutput,
3850 StaticValue,
3851 Expression,
3852 ExpressionText,
3853 ModelOutput,
3854 };
3855 Q_ENUM( ProcessingModelChildParameterSource )
3856
3857
3863 {
3864 NotExecuted,
3866 Failed,
3867 };
3868 Q_ENUM( ProcessingModelChildAlgorithmExecutionStatus )
3869
3870
3878 {
3879 Vertices,
3880 StructureLines,
3881 BreakLines
3882 };
3883 Q_ENUM( ProcessingTinInputLayerType )
3884
3885
3895 Q_ENUM( CrsDefinitionFormat )
3896
3897
3905 enum class FieldDomainSplitPolicy : int
3906 {
3907 DefaultValue,
3908 Duplicate,
3909 GeometryRatio,
3910 UnsetField,
3911 };
3912 Q_ENUM( FieldDomainSplitPolicy )
3913
3914
3922 enum class FieldDomainMergePolicy : int
3923 {
3924 DefaultValue,
3925 Sum,
3926 GeometryWeighted,
3927 UnsetField,
3928 LargestGeometry,
3929 MinimumValue,
3930 MaximumValue,
3931 SetToNull,
3932 };
3933 Q_ENUM( FieldDomainMergePolicy )
3934
3935
3942 enum class FieldDuplicatePolicy : int
3943 {
3944 DefaultValue,
3945 Duplicate,
3946 UnsetField,
3947 };
3948 Q_ENUM( FieldDuplicatePolicy )
3949
3950
3955 enum class FieldDomainType : int
3956 {
3957 Coded,
3958 Range,
3959 Glob,
3960 };
3961 Q_ENUM( FieldDomainType )
3962
3963
3968 enum class TransactionMode : int
3969 {
3970 Disabled = 0,
3971 AutomaticGroups = 1,
3972 BufferedGroups = 2,
3973 };
3974 Q_ENUM( TransactionMode )
3975
3976
3981 enum class AltitudeClamping : int
3982 {
3983 Absolute,
3984 Relative,
3985 Terrain,
3986 };
3987 Q_ENUM( AltitudeClamping )
3988
3989
3994 enum class AltitudeBinding : int
3995 {
3996 Vertex,
3997 Centroid,
3998 };
3999 Q_ENUM( AltitudeBinding )
4000
4001
4006 enum class RangeLimits : int
4007 {
4008 IncludeBoth = 0,
4009 IncludeLowerExcludeUpper,
4010 ExcludeLowerIncludeUpper,
4011 ExcludeBoth,
4012 };
4013 Q_ENUM( RangeLimits )
4014
4015
4020 enum class RasterElevationMode : int
4021 {
4022 FixedElevationRange = 0,
4023 RepresentsElevationSurface = 1,
4024 FixedRangePerBand = 2,
4025 DynamicRangePerBand = 3,
4026 };
4027 Q_ENUM( RasterElevationMode )
4028
4029
4034 enum class MeshElevationMode : int
4035 {
4036 FixedElevationRange = 0,
4037 FromVertices = 1,
4038 FixedRangePerGroup = 2,
4039 };
4040 Q_ENUM( MeshElevationMode )
4041
4042
4048 {
4049 NoConstraint,
4050 Perpendicular,
4051 Parallel
4052 };
4053 Q_ENUM( BetweenLineConstraint )
4054
4055
4060 enum class LineExtensionSide : int
4061 {
4062 BeforeVertex,
4063 AfterVertex,
4064 NoVertex,
4065 };
4066 Q_ENUM( LineExtensionSide )
4067
4068
4069
4073 enum class CadConstraintType : int
4074 {
4075 Generic,
4076 Angle,
4077 Distance,
4078 XCoordinate,
4079 YCoordinate,
4080 ZValue,
4081 MValue,
4082 };
4083 Q_ENUM( CadConstraintType )
4084
4085
4086
4091 enum class ProjectFlag : int SIP_ENUM_BASETYPE( IntFlag )
4092 {
4093 EvaluateDefaultValuesOnProviderSide = 1 << 0,
4094 TrustStoredLayerStatistics = 1 << 1,
4095 RememberLayerEditStatusBetweenSessions = 1 << 2,
4096 RememberAttributeTableWindowsBetweenSessions = 1 << 3,
4097 };
4098 Q_ENUM( ProjectFlag )
4099 Q_DECLARE_FLAGS( ProjectFlags, ProjectFlag )
4100 Q_FLAG( ProjectFlags )
4101
4107 enum class PlotToolFlag : int SIP_ENUM_BASETYPE( IntFlag )
4108 {
4109 ShowContextMenu = 1 << 0,
4110 };
4111 Q_ENUM( PlotToolFlag )
4112 Q_DECLARE_FLAGS( PlotToolFlags, PlotToolFlag )
4113 Q_FLAG( PlotToolFlags )
4114
4115
4123 enum class Point3DShape : int
4124 {
4125 Cylinder,
4126 Sphere,
4127 Cone,
4128 Cube,
4129 Torus,
4130 Plane,
4131 ExtrudedText,
4132 Model,
4133 Billboard,
4134 };
4135 Q_ENUM( Point3DShape )
4136
4137
4142 enum class LightSourceType : int
4143 {
4144 Point,
4145 Directional,
4146 };
4147 Q_ENUM( LightSourceType )
4148
4149
4154 enum class NavigationMode : int
4155 {
4156 TerrainBased,
4157 Walk,
4158 GlobeTerrainBased
4159 };
4160 Q_ENUM( NavigationMode )
4161
4162
4167 enum class SceneMode : int
4168 {
4169 Local,
4170 Globe
4171 };
4172 Q_ENUM( SceneMode )
4173
4174
4179 enum class VerticalAxisInversion : int
4180 {
4181 Never,
4182 WhenDragging,
4183 Always,
4184 };
4185 Q_ENUM( VerticalAxisInversion )
4186
4187
4193 {
4194 Line,
4195 FillBelow,
4196 FillAbove,
4197 };
4199
4205 enum class VectorProfileType : int
4206 {
4207 IndividualFeatures,
4208 ContinuousSurface,
4209 };
4211
4217 enum class ProfileGeneratorFlag : int SIP_ENUM_BASETYPE( IntFlag )
4218 {
4219 RespectsMaximumErrorMapUnit = 1 << 0,
4220 RespectsDistanceRange = 1 << 1,
4221 RespectsElevationRange = 1 << 2,
4222 };
4223 Q_ENUM( ProfileGeneratorFlag )
4225 Q_FLAG( ProfileGeneratorFlags )
4226
4232 enum class ProfileExportType : int
4233 {
4234 Features3D,
4235 Profile2D,
4236 DistanceVsElevationTable,
4237 };
4239
4246 {
4247 Square,
4248 Circle,
4249 };
4250 Q_ENUM( PointCloudSymbol )
4251
4252
4258 {
4259 Default,
4260 BottomToTop,
4261 TopToBottom,
4262 };
4263 Q_ENUM( PointCloudDrawOrder )
4264
4265
4273 {
4274 AllowIntersections,
4275 AvoidIntersectionsCurrentLayer,
4276 AvoidIntersectionsLayers,
4277 };
4278 Q_ENUM( AvoidIntersectionsMode )
4279
4280
4288 {
4289 Qgz,
4290 Qgs,
4291 };
4292 Q_ENUM( ProjectFileFormat )
4293
4294
4302 {
4303 DontResolveLayers SIP_MONKEYPATCH_COMPAT_NAME( FlagDontResolveLayers ) = 1 << 0,
4304 DontLoadLayouts SIP_MONKEYPATCH_COMPAT_NAME( FlagDontLoadLayouts ) = 1 << 1,
4305 TrustLayerMetadata SIP_MONKEYPATCH_COMPAT_NAME( FlagTrustLayerMetadata ) = 1 << 2,
4306 DontStoreOriginalStyles SIP_MONKEYPATCH_COMPAT_NAME( FlagDontStoreOriginalStyles ) = 1 << 3,
4307 DontLoad3DViews SIP_MONKEYPATCH_COMPAT_NAME( FlagDontLoad3DViews ) = 1 << 4,
4308 DontLoadProjectStyles = 1 << 5,
4309 ForceReadOnlyLayers = 1 << 6,
4310 DontUpgradeAnnotations = 1 << 7,
4311 };
4312 Q_ENUM( ProjectReadFlag )
4313
4314
4322 Q_FLAG( ProjectReadFlags )
4323
4332 enum class ProjectCapability : int SIP_ENUM_BASETYPE( IntFlag )
4333 {
4334 ProjectStyles = 1 << 0,
4335 };
4336 Q_ENUM( ProjectCapability )
4337
4338
4344 Q_FLAG( ProjectCapabilities )
4345
4352 {
4353 Vector,
4354 Raster,
4355 RasterDem,
4356 GeoJson,
4357 Image,
4358 Video,
4359 Unknown,
4360 };
4361 Q_ENUM( MapBoxGlStyleSourceType )
4362
4363
4371 {
4372 FeatureServer SIP_MONKEYPATCH_COMPAT_NAME( FeatureService ),
4373 MapServer SIP_MONKEYPATCH_COMPAT_NAME( MapService ),
4374 ImageServer SIP_MONKEYPATCH_COMPAT_NAME( ImageService ),
4375 GlobeServer,
4376 GPServer,
4377 GeocodeServer,
4378 Unknown,
4379 SceneServer,
4380 };
4381 Q_ENUM( ArcGisRestServiceType )
4382
4383
4391 {
4392 Normal,
4393 Generated,
4394 };
4395 Q_ENUM( RelationshipType )
4396
4397
4405 {
4406 Association,
4407 Composition,
4408 };
4409 Q_ENUM( RelationshipStrength )
4410
4411
4417 {
4418 OneToOne,
4419 OneToMany,
4420 ManyToOne,
4421 ManyToMany,
4422 };
4423 Q_ENUM( RelationshipCardinality )
4424
4425
4430 enum class RelationshipCapability : int SIP_ENUM_BASETYPE( IntFlag )
4431 {
4432 MultipleFieldKeys = 1 << 0,
4433 ForwardPathLabel = 1 << 1,
4434 BackwardPathLabel = 1 << 2,
4435 };
4436 Q_ENUM( RelationshipCapability )
4437
4438
4444 Q_FLAG( RelationshipCapabilities )
4445
4451 enum class CoordinateDisplayType : int
4452 {
4453 MapCrs,
4454 MapGeographic,
4455 CustomCrs,
4456 };
4457 Q_ENUM( CoordinateDisplayType )
4458
4459
4464 enum class SettingsOrigin : int
4465 {
4466 Any,
4467 Global,
4468 Local,
4469 };
4470 Q_ENUM( SettingsOrigin )
4471
4472
4477 enum class ScriptLanguage : int
4478 {
4479 Css,
4480 QgisExpression,
4481 Html,
4482 JavaScript,
4483 Json,
4484 Python,
4485 R,
4486 Sql,
4487 Batch,
4488 Bash,
4489 Unknown,
4490 };
4491 Q_ENUM( ScriptLanguage )
4492
4493
4501 {
4502 Reformat = 1 << 0,
4503 CheckSyntax = 1 << 1,
4504 ToggleComment = 1 << 2,
4505 };
4506 Q_ENUM( ScriptLanguageCapability )
4507
4508
4515
4522 {
4523 AboveInsertionPoint,
4524 TopOfTree,
4525 OptimalInInsertionGroup,
4526 };
4527 Q_ENUM( LayerTreeInsertionMethod )
4528
4529
4534 enum class LayerTreeFilterFlag : int SIP_ENUM_BASETYPE( IntFlag )
4535 {
4536 SkipVisibilityCheck = 1 << 0,
4537 };
4538 Q_ENUM( LayerTreeFilterFlag )
4539
4540
4546 Q_FLAG( LayerTreeFilterFlags )
4547
4553 enum class MapLayerLegendFlag : int SIP_ENUM_BASETYPE( IntFlag )
4554 {
4555 ExcludeByDefault = 1 << 0,
4556 };
4557 Q_ENUM( MapLayerLegendFlag )
4558
4559
4565 Q_FLAG( MapLayerLegendFlags )
4566
4575 {
4576 Undefined,
4577 Hidden,
4578 Title,
4579 Group,
4580 Subgroup,
4581 Symbol,
4582 SymbolLabel,
4583 };
4584 // !!! WARNING: If adding new values to this enum, make sure you update QgsLegendSettings constructor accordingly!!
4585 Q_ENUM( LegendComponent )
4586
4587
4594 enum class LegendJsonRenderFlag : int SIP_ENUM_BASETYPE( IntFlag )
4595 {
4596 ShowRuleDetails = 1 << 0,
4597 };
4598 Q_ENUM( LegendJsonRenderFlag )
4600 Q_FLAG( LegendJsonRenderFlags )
4601
4609 enum class ActionType : int
4610 {
4611 Invalid,
4612 MapLayerAction,
4613 AttributeAction
4614 };
4615 Q_ENUM( ActionType )
4616
4617
4624 enum class MapLayerActionTarget : int SIP_ENUM_BASETYPE( IntFlag )
4625 {
4626 Layer = 1 << 0,
4627 SingleFeature = 1 << 1,
4628 MultipleFeatures = 1 << 2,
4629 AllActions = Layer | SingleFeature | MultipleFeatures
4630 };
4631 Q_ENUM( MapLayerActionTarget )
4632
4633
4641 Q_FLAG( MapLayerActionTargets )
4642
4650 enum class MapLayerActionFlag : int SIP_ENUM_BASETYPE( IntFlag )
4651 {
4652 EnabledOnlyWhenEditable = 1 << 1,
4653 EnableOnlyWhenHasGeometry = 1 << 2,
4654 };
4655 Q_ENUM( MapLayerActionFlag )
4656
4657
4665 Q_FLAG( MapLayerActionFlags )
4666
4675 {
4676 Generic,
4677 GenericPython,
4678 Mac,
4679 Windows,
4680 Unix,
4681 OpenUrl,
4682 SubmitUrlEncoded,
4683 SubmitUrlMultipart,
4684 };
4685 Q_ENUM( AttributeActionType )
4686
4687
4693 {
4694 Created,
4695 Published,
4696 Revised,
4697 Superseded,
4698 };
4699 Q_ENUM( MetadataDateType )
4700
4701
4710
4712 {
4713 Undefined SIP_MONKEYPATCH_COMPAT_NAME( UndefinedColorInterpretation ) = 0,
4714 GrayIndex = 1,
4715 PaletteIndex = 2,
4716 RedBand = 3,
4717 GreenBand = 4,
4718 BlueBand = 5,
4719 AlphaBand = 6,
4720 HueBand = 7,
4721 SaturationBand = 8,
4722 LightnessBand = 9,
4723 CyanBand = 10,
4724 MagentaBand = 11,
4725 YellowBand = 12,
4726 BlackBand = 13,
4727 YCbCr_YBand = 14,
4728 YCbCr_CbBand = 15,
4729 YCbCr_CrBand = 16,
4730 ContinuousPalette = 17,
4731
4732 // Note: values between PanBand and SAR_P_Band match additions done in
4733 // GDAL 3.10, except that the numeric values of the constant don't match GDAL ones
4734
4735 PanBand = 18,
4736 CoastalBand = 19,
4737 RedEdgeBand = 20,
4738 NIRBand = 21,
4739 SWIRBand = 22,
4740 MWIRBand = 23,
4741 LWIRBand = 24,
4742 TIRBand = 25,
4743 OtherIRBand = 26,
4744 SAR_Ka_Band = 27,
4745 SAR_K_Band = 28,
4746 SAR_Ku_Band = 30,
4747 SAR_X_Band = 31,
4748 SAR_C_Band = 32,
4749 SAR_S_Band = 33,
4750 SAR_L_Band = 34,
4751 SAR_P_Band = 35,
4752 };
4753 Q_ENUM( RasterColorInterpretation )
4754
4755
4763 {
4764 GrayOrUndefined,
4765 Palette,
4766 MultiBand SIP_MONKEYPATCH_COMPAT_NAME( Multiband ),
4767 SingleBandColorData SIP_MONKEYPATCH_COMPAT_NAME( ColorLayer ),
4768 };
4769 Q_ENUM( RasterLayerType )
4770
4771
4779 {
4780 Undefined SIP_MONKEYPATCH_COMPAT_NAME( UndefinedDrawingStyle ),
4781 SingleBandGray,
4782 SingleBandPseudoColor,
4783 PalettedColor,
4784 PalettedSingleBandGray,
4785 PalettedSingleBandPseudoColor,
4786 PalettedMultiBandColor,
4787 MultiBandSingleBandGray,
4788 MultiBandSingleBandPseudoColor,
4789 MultiBandColor,
4790 SingleBandColorData SIP_MONKEYPATCH_COMPAT_NAME( SingleBandColorDataStyle ),
4791 };
4792 Q_ENUM( RasterDrawingStyle )
4793
4794
4801 enum class RasterPyramidFormat SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsRaster, RasterPyramidsFormat ) : int
4802 {
4803 GeoTiff SIP_MONKEYPATCH_COMPAT_NAME( PyramidsGTiff ) = 0,
4804 Internal SIP_MONKEYPATCH_COMPAT_NAME( PyramidsInternal ) = 1,
4805 Erdas SIP_MONKEYPATCH_COMPAT_NAME( PyramidsErdas ) = 2
4806 };
4807 Q_ENUM( RasterPyramidFormat )
4808
4809
4817 {
4818 No SIP_MONKEYPATCH_COMPAT_NAME( PyramidsFlagNo ) = 0,
4819 Yes SIP_MONKEYPATCH_COMPAT_NAME( PyramidsFlagYes ) = 1,
4820 CopyExisting SIP_MONKEYPATCH_COMPAT_NAME( PyramidsCopyExisting ) = 2
4821 };
4822 Q_ENUM( RasterBuildPyramidOption )
4823
4824
4832 {
4833 Undefined SIP_MONKEYPATCH_COMPAT_NAME( IdentifyFormatUndefined ) = 0,
4834 Value SIP_MONKEYPATCH_COMPAT_NAME( IdentifyFormatValue ) = 1,
4835 Text SIP_MONKEYPATCH_COMPAT_NAME( IdentifyFormatText ) = 1 << 1,
4836 Html SIP_MONKEYPATCH_COMPAT_NAME( IdentifyFormatHtml ) = 1 << 2,
4837 Feature SIP_MONKEYPATCH_COMPAT_NAME( IdentifyFormatFeature ) = 1 << 3,
4838 };
4839 Q_ENUM( RasterIdentifyFormat )
4840
4841 // TODO QGIS 4 -- remove NoCapabilities and rely on RasterInterfaceCapabilities() instead
4842 // remove deprecated members
4843 // Remove "Identify" member, and replace with combinations of IdentifyValue/IdentifyText/etc
4844
4845
4853 {
4854 NoCapabilities = 0,
4855 Size = 1 << 1,
4856 Create = 1 << 2,
4857 Remove = 1 << 3,
4858 BuildPyramids = 1 << 4,
4859 Identify = 1 << 5,
4860 IdentifyValue = 1 << 6,
4861 IdentifyText = 1 << 7,
4862 IdentifyHtml = 1 << 8,
4863 IdentifyFeature = 1 << 9,
4864 Prefetch = 1 << 10,
4865 };
4866 Q_ENUM( RasterInterfaceCapability )
4867
4868
4875
4876 // TODO QGIS 4 -- remove NoProviderCapabilities and rely on RasterProviderCapabilities() instead
4877
4886 {
4887 NoProviderCapabilities = 0,
4888 ReadLayerMetadata = 1 << 1,
4889 WriteLayerMetadata = 1 << 2,
4890 ProviderHintBenefitsFromResampling = 1 << 3,
4891 ProviderHintCanPerformProviderResampling = 1 << 4,
4892 ReloadData = 1 << 5,
4893 DpiDependentData = 1 << 6,
4894 NativeRasterAttributeTable = 1 << 7,
4895 BuildPyramids = 1 << 8,
4896 };
4897 Q_ENUM( RasterProviderCapability )
4898
4899
4908
4915 {
4916 HighestElevation,
4917 NewerElevation,
4918 };
4919 Q_ENUM( ElevationMapCombineMethod )
4920
4921
4930 {
4931 Normal SIP_MONKEYPATCH_COMPAT_NAME( BlendNormal ),
4932 Lighten SIP_MONKEYPATCH_COMPAT_NAME( BlendLighten ),
4933 Screen SIP_MONKEYPATCH_COMPAT_NAME( BlendScreen ),
4934 Dodge SIP_MONKEYPATCH_COMPAT_NAME( BlendDodge ),
4935 Addition SIP_MONKEYPATCH_COMPAT_NAME( BlendAddition ),
4936 Darken SIP_MONKEYPATCH_COMPAT_NAME( BlendDarken ),
4937 Multiply SIP_MONKEYPATCH_COMPAT_NAME( BlendMultiply ),
4939 Overlay SIP_MONKEYPATCH_COMPAT_NAME( BlendOverlay ),
4940 SoftLight SIP_MONKEYPATCH_COMPAT_NAME( BlendSoftLight ),
4941 HardLight SIP_MONKEYPATCH_COMPAT_NAME( BlendHardLight ),
4942 Difference SIP_MONKEYPATCH_COMPAT_NAME( BlendDifference ),
4943 Subtract SIP_MONKEYPATCH_COMPAT_NAME( BlendSubtract ),
4944 Source SIP_MONKEYPATCH_COMPAT_NAME( BlendSource ),
4945 DestinationOver SIP_MONKEYPATCH_COMPAT_NAME( BlendDestinationOver ),
4946 Clear SIP_MONKEYPATCH_COMPAT_NAME( BlendClear ),
4947 Destination SIP_MONKEYPATCH_COMPAT_NAME( BlendDestination ),
4948 SourceIn SIP_MONKEYPATCH_COMPAT_NAME( BlendSourceIn ),
4949 DestinationIn SIP_MONKEYPATCH_COMPAT_NAME( BlendDestinationIn ),
4950 SourceOut SIP_MONKEYPATCH_COMPAT_NAME( BlendSourceOut ),
4951 DestinationOut SIP_MONKEYPATCH_COMPAT_NAME( BlendDestinationOut ),
4952 SourceAtop SIP_MONKEYPATCH_COMPAT_NAME( BlendSourceAtop ),
4953 DestinationAtop SIP_MONKEYPATCH_COMPAT_NAME( BlendDestinationAtop ),
4955 };
4956 Q_ENUM( BlendMode )
4957
4958
4966 {
4967 Unknown SIP_MONKEYPATCH_COMPAT_NAME( UnknownSystem ) = 0,
4968 Metric SIP_MONKEYPATCH_COMPAT_NAME( MetricSystem ),
4969 Imperial SIP_MONKEYPATCH_COMPAT_NAME( ImperialSystem ),
4970 USCS SIP_MONKEYPATCH_COMPAT_NAME( USCSSystem ),
4971 };
4972 Q_ENUM( SystemOfMeasurement )
4973
4974
4981 {
4982 Layer SIP_MONKEYPATCH_COMPAT_NAME( LayerUnits ),
4983 Pixels,
4984 Project SIP_MONKEYPATCH_COMPAT_NAME( ProjectUnits )
4985 };
4986 Q_ENUM( MapToolUnit )
4987
4988
4996 {
4997 Distance SIP_MONKEYPATCH_COMPAT_NAME( TypeDistance ) = 0,
4999 Volume SIP_MONKEYPATCH_COMPAT_NAME( TypeVolume ),
5000 Unknown SIP_MONKEYPATCH_COMPAT_NAME( TypeUnknown ),
5001 Temporal SIP_MONKEYPATCH_COMPAT_NAME( TypeTemporal ),
5002 };
5003 Q_ENUM( UnitType )
5004
5005
5013 {
5014 Meters SIP_MONKEYPATCH_COMPAT_NAME( DistanceMeters ),
5015 Kilometers SIP_MONKEYPATCH_COMPAT_NAME( DistanceKilometers ),
5016 Feet SIP_MONKEYPATCH_COMPAT_NAME( DistanceFeet ),
5017 NauticalMiles SIP_MONKEYPATCH_COMPAT_NAME( DistanceNauticalMiles ),
5018 Yards SIP_MONKEYPATCH_COMPAT_NAME( DistanceYards ),
5019 Miles SIP_MONKEYPATCH_COMPAT_NAME( DistanceMiles ),
5020 Degrees SIP_MONKEYPATCH_COMPAT_NAME( DistanceDegrees ),
5021 Centimeters SIP_MONKEYPATCH_COMPAT_NAME( DistanceCentimeters ),
5022 Millimeters SIP_MONKEYPATCH_COMPAT_NAME( DistanceMillimeters ),
5023 Inches,
5024 ChainsInternational,
5025 ChainsBritishBenoit1895A,
5026 ChainsBritishBenoit1895B,
5027 ChainsBritishSears1922Truncated,
5028 ChainsBritishSears1922,
5029 ChainsClarkes,
5030 ChainsUSSurvey,
5031 FeetBritish1865,
5032 FeetBritish1936,
5033 FeetBritishBenoit1895A,
5034 FeetBritishBenoit1895B,
5035 FeetBritishSears1922Truncated,
5036 FeetBritishSears1922,
5037 FeetClarkes,
5038 FeetGoldCoast,
5039 FeetIndian,
5040 FeetIndian1937,
5041 FeetIndian1962,
5042 FeetIndian1975,
5043 FeetUSSurvey,
5044 LinksInternational,
5045 LinksBritishBenoit1895A,
5046 LinksBritishBenoit1895B,
5047 LinksBritishSears1922Truncated,
5048 LinksBritishSears1922,
5049 LinksClarkes,
5050 LinksUSSurvey,
5051 YardsBritishBenoit1895A,
5052 YardsBritishBenoit1895B,
5053 YardsBritishSears1922Truncated,
5054 YardsBritishSears1922,
5055 YardsClarkes,
5056 YardsIndian,
5057 YardsIndian1937,
5058 YardsIndian1962,
5059 YardsIndian1975,
5060 MilesUSSurvey,
5061 Fathoms,
5062 MetersGermanLegal,
5063 Unknown SIP_MONKEYPATCH_COMPAT_NAME( DistanceUnknownUnit ),
5064 };
5065 Q_ENUM( DistanceUnit )
5066
5067
5075 {
5076 Standard,
5077 Geographic,
5078 Unknown SIP_MONKEYPATCH_COMPAT_NAME( UnknownType ),
5079 };
5080 Q_ENUM( DistanceUnitType )
5081
5082
5090 {
5091 SquareMeters SIP_MONKEYPATCH_COMPAT_NAME( AreaSquareMeters ),
5092 SquareKilometers SIP_MONKEYPATCH_COMPAT_NAME( AreaSquareKilometers ),
5093 SquareFeet SIP_MONKEYPATCH_COMPAT_NAME( AreaSquareFeet ),
5094 SquareYards SIP_MONKEYPATCH_COMPAT_NAME( AreaSquareYards ),
5095 SquareMiles SIP_MONKEYPATCH_COMPAT_NAME( AreaSquareMiles ),
5096 Hectares SIP_MONKEYPATCH_COMPAT_NAME( AreaHectares ),
5097 Acres SIP_MONKEYPATCH_COMPAT_NAME( AreaAcres ),
5098 SquareNauticalMiles SIP_MONKEYPATCH_COMPAT_NAME( AreaSquareNauticalMiles ),
5099 SquareDegrees SIP_MONKEYPATCH_COMPAT_NAME( AreaSquareDegrees ),
5100 SquareCentimeters SIP_MONKEYPATCH_COMPAT_NAME( AreaSquareCentimeters ),
5101 SquareMillimeters SIP_MONKEYPATCH_COMPAT_NAME( AreaSquareMillimeters ),
5102 SquareInches,
5103 Unknown SIP_MONKEYPATCH_COMPAT_NAME( AreaUnknownUnit ),
5104 };
5105 Q_ENUM( AreaUnit )
5106
5107
5115 {
5116 CubicMeters SIP_MONKEYPATCH_COMPAT_NAME( VolumeCubicMeters ),
5117 CubicFeet SIP_MONKEYPATCH_COMPAT_NAME( VolumeCubicFeet ),
5118 CubicYards SIP_MONKEYPATCH_COMPAT_NAME( VolumeCubicYards ),
5119 Barrel SIP_MONKEYPATCH_COMPAT_NAME( VolumeBarrel ),
5120 CubicDecimeter SIP_MONKEYPATCH_COMPAT_NAME( VolumeCubicDecimeter ),
5121 Liters SIP_MONKEYPATCH_COMPAT_NAME( VolumeLiters ),
5122 GallonUS SIP_MONKEYPATCH_COMPAT_NAME( VolumeGallonUS ),
5123 CubicInch SIP_MONKEYPATCH_COMPAT_NAME( VolumeCubicInch ),
5124 CubicCentimeter SIP_MONKEYPATCH_COMPAT_NAME( VolumeCubicCentimeter ),
5125 CubicDegrees SIP_MONKEYPATCH_COMPAT_NAME( VolumeCubicDegrees ),
5126 Unknown SIP_MONKEYPATCH_COMPAT_NAME( VolumeUnknownUnit ),
5127 };
5128 Q_ENUM( VolumeUnit )
5129
5130
5138 {
5139 Degrees SIP_MONKEYPATCH_COMPAT_NAME( AngleDegrees ),
5140 Radians SIP_MONKEYPATCH_COMPAT_NAME( AngleRadians ),
5142 MinutesOfArc SIP_MONKEYPATCH_COMPAT_NAME( AngleMinutesOfArc ),
5143 SecondsOfArc SIP_MONKEYPATCH_COMPAT_NAME( AngleSecondsOfArc ),
5145 MilliradiansSI SIP_MONKEYPATCH_COMPAT_NAME( AngleMilliradiansSI ),
5146 MilNATO SIP_MONKEYPATCH_COMPAT_NAME( AngleMilNATO ),
5147 Unknown SIP_MONKEYPATCH_COMPAT_NAME( AngleUnknownUnit ),
5148 };
5149 Q_ENUM( AngleUnit )
5150
5151
5159 {
5160 Milliseconds SIP_MONKEYPATCH_COMPAT_NAME( TemporalMilliseconds ),
5161 Seconds SIP_MONKEYPATCH_COMPAT_NAME( TemporalSeconds ),
5162 Minutes SIP_MONKEYPATCH_COMPAT_NAME( TemporalMinutes ),
5163 Hours SIP_MONKEYPATCH_COMPAT_NAME( TemporalHours ),
5164 Days SIP_MONKEYPATCH_COMPAT_NAME( TemporalDays ),
5165 Weeks SIP_MONKEYPATCH_COMPAT_NAME( TemporalWeeks ),
5166 Months SIP_MONKEYPATCH_COMPAT_NAME( TemporalMonths ),
5167 Years SIP_MONKEYPATCH_COMPAT_NAME( TemporalYears ),
5168 Decades SIP_MONKEYPATCH_COMPAT_NAME( TemporalDecades ),
5169 Centuries SIP_MONKEYPATCH_COMPAT_NAME( TemporalCenturies ),
5170 IrregularStep SIP_MONKEYPATCH_COMPAT_NAME( TemporalIrregularStep ),
5171 Unknown SIP_MONKEYPATCH_COMPAT_NAME( TemporalUnknownUnit )
5172 };
5173 Q_ENUM( TemporalUnit )
5174
5175
5183 {
5184 Millimeters SIP_MONKEYPATCH_COMPAT_NAME( RenderMillimeters ),
5185 MapUnits SIP_MONKEYPATCH_COMPAT_NAME( RenderMapUnits ),
5186 Pixels SIP_MONKEYPATCH_COMPAT_NAME( RenderPixels ),
5187 Percentage SIP_MONKEYPATCH_COMPAT_NAME( RenderPercentage ),
5189 Inches SIP_MONKEYPATCH_COMPAT_NAME( RenderInches ),
5190 Unknown SIP_MONKEYPATCH_COMPAT_NAME( RenderUnknownUnit ),
5191 MetersInMapUnits SIP_MONKEYPATCH_COMPAT_NAME( RenderMetersInMapUnits ),
5192 };
5193 Q_ENUM( RenderUnit )
5194
5195
5203 {
5204 Millimeters SIP_MONKEYPATCH_COMPAT_NAME( LayoutMillimeters ),
5205 Centimeters SIP_MONKEYPATCH_COMPAT_NAME( LayoutCentimeters ),
5206 Meters SIP_MONKEYPATCH_COMPAT_NAME( LayoutMeters ),
5207 Inches SIP_MONKEYPATCH_COMPAT_NAME( LayoutInches ),
5208 Feet SIP_MONKEYPATCH_COMPAT_NAME( LayoutFeet ),
5210 Picas SIP_MONKEYPATCH_COMPAT_NAME( LayoutPicas ),
5211 Pixels SIP_MONKEYPATCH_COMPAT_NAME( LayoutPixels )
5212 };
5213 Q_ENUM( LayoutUnit )
5214
5215
5223 {
5224 PaperUnits SIP_MONKEYPATCH_COMPAT_NAME( LayoutPaperUnits ),
5225 ScreenUnits SIP_MONKEYPATCH_COMPAT_NAME( LayoutScreenUnits )
5226 };
5227 Q_ENUM( LayoutUnitType )
5228
5229
5237 {
5238 Debug SIP_MONKEYPATCH_COMPAT_NAME( FlagDebug ) = 1 << 1,
5239 OutlineOnly SIP_MONKEYPATCH_COMPAT_NAME( FlagOutlineOnly ) = 1 << 2,
5240 Antialiasing SIP_MONKEYPATCH_COMPAT_NAME( FlagAntialiasing ) = 1 << 3,
5241 UseAdvancedEffects SIP_MONKEYPATCH_COMPAT_NAME( FlagUseAdvancedEffects ) = 1 << 4,
5242 ForceVectorOutput SIP_MONKEYPATCH_COMPAT_NAME( FlagForceVectorOutput ) = 1 << 5,
5243 HideCoverageLayer SIP_MONKEYPATCH_COMPAT_NAME( FlagHideCoverageLayer ) = 1 << 6,
5244 DrawSelection SIP_MONKEYPATCH_COMPAT_NAME( FlagDrawSelection ) = 1 << 7,
5245 DisableTiledRasterLayerRenders SIP_MONKEYPATCH_COMPAT_NAME( FlagDisableTiledRasterLayerRenders ) = 1 << 8,
5246 RenderLabelsByMapLayer SIP_MONKEYPATCH_COMPAT_NAME( FlagRenderLabelsByMapLayer ) = 1 << 9,
5247 LosslessImageRendering SIP_MONKEYPATCH_COMPAT_NAME( FlagLosslessImageRendering ) = 1 << 10,
5248 SynchronousLegendGraphics SIP_MONKEYPATCH_COMPAT_NAME( FlagSynchronousLegendGraphics ) = 1 << 11,
5249 AlwaysUseGlobalMasks SIP_MONKEYPATCH_COMPAT_NAME( FlagAlwaysUseGlobalMasks ) = 1 << 12,
5250 LimitCoverageLayerRenderToCurrentFeature = 1 << 13,
5251 };
5252 Q_ENUM( LayoutRenderFlag )
5253
5254
5262 Q_FLAG( LayoutRenderFlags )
5263
5272 {
5273 SVG SIP_MONKEYPATCH_COMPAT_NAME( FormatSVG ) = 0,
5274 Raster SIP_MONKEYPATCH_COMPAT_NAME( FormatRaster ),
5275 Unknown SIP_MONKEYPATCH_COMPAT_NAME( FormatUnknown ),
5276 };
5277 Q_ENUM( PictureFormat )
5278
5279
5284 enum class ScaleCalculationMethod : int
5285 {
5286 HorizontalTop = 0,
5287 HorizontalMiddle,
5288 HorizontalBottom,
5289 HorizontalAverage,
5290 AtEquator,
5291 };
5292 Q_ENUM( ScaleCalculationMethod )
5293
5294
5307 Q_ENUM( ScaleBarAlignment )
5308
5309
5317 {
5318 Fixed SIP_MONKEYPATCH_COMPAT_NAME( SegmentSizeFixed ) = 0,
5319 FitWidth SIP_MONKEYPATCH_COMPAT_NAME( SegmentSizeFitWidth ) = 1
5320 };
5321 Q_ENUM( ScaleBarSegmentSizeMode )
5322
5323
5331 {
5332 AboveSegment SIP_MONKEYPATCH_COMPAT_NAME( LabelAboveSegment ) = 0,
5333 BelowSegment SIP_MONKEYPATCH_COMPAT_NAME( LabelBelowSegment ),
5334 };
5335 Q_ENUM( ScaleBarDistanceLabelVerticalPlacement )
5336
5337
5345 {
5346 CenteredEdge SIP_MONKEYPATCH_COMPAT_NAME( LabelCenteredEdge ) = 0,
5347 CenteredSegment SIP_MONKEYPATCH_COMPAT_NAME( LabelCenteredSegment ),
5348 };
5349 Q_ENUM( ScaleBarDistanceLabelHorizontalPlacement )
5350
5351
5356 enum class InputControllerType : int
5357 {
5358 Map2D,
5359 Map3D
5360 };
5362
5369 {
5370 NotSet,
5371 Unknown,
5372 OrdinaryTable,
5373 Index,
5374 Sequence,
5375 View,
5376 MaterializedView,
5377 CompositeType,
5378 ToastTable,
5379 ForeignTable,
5380 PartitionedTable,
5381 };
5382 Q_ENUM( PostgresRelKind )
5383
5384
5390 {
5391 SetFieldComment = 1 << 0,
5392 SetFieldAlias = 1 << 1,
5393 SetTableComment = 1 << 2,
5394 EditFieldDomain = 1 << 3,
5395 DeleteFieldDomain = 1 << 4,
5396 };
5397 Q_ENUM( DatabaseProviderConnectionCapability2 )
5400
5407 {
5408 SetGeometryColumnName = 1 << 0,
5409 SetPrimaryKeyName = 1 << 1,
5410 };
5411 Q_ENUM( DatabaseProviderTableImportCapability )
5414
5421 {
5422 SaveToDatabase = 1 << 1,
5423 LoadFromDatabase = 1 << 2,
5424 DeleteFromDatabase = 1 << 3
5425 };
5429
5430
5436 {
5437 LastProfile,
5438 DefaultProfile,
5439 AskUser,
5440 };
5441 Q_ENUM( UserProfileSelectionPolicy )
5442
5443
5451 {
5452 Container SIP_MONKEYPATCH_COMPAT_NAME( AeTypeContainer ),
5453 Field SIP_MONKEYPATCH_COMPAT_NAME( AeTypeField ),
5454 Relation SIP_MONKEYPATCH_COMPAT_NAME( AeTypeRelation ),
5455 QmlElement SIP_MONKEYPATCH_COMPAT_NAME( AeTypeQmlElement ),
5456 HtmlElement SIP_MONKEYPATCH_COMPAT_NAME( AeTypeHtmlElement ),
5457 Action SIP_MONKEYPATCH_COMPAT_NAME( AeTypeAction ),
5458 TextElement SIP_MONKEYPATCH_COMPAT_NAME( AeTypeTextElement ),
5459 SpacerElement SIP_MONKEYPATCH_COMPAT_NAME( AeTypeSpacerElement ),
5460 Invalid SIP_MONKEYPATCH_COMPAT_NAME( AeTypeInvalid ),
5461 };
5462 Q_ENUM( AttributeEditorType )
5463
5464
5470 {
5471 GroupBox,
5472 Tab,
5473 Row,
5474 };
5475 Q_ENUM( AttributeEditorContainerType )
5476
5477
5485 {
5486 AutoGenerated SIP_MONKEYPATCH_COMPAT_NAME( GeneratedLayout ) = 0,
5487 DragAndDrop SIP_MONKEYPATCH_COMPAT_NAME( TabLayout ) = 1,
5488 UiFile SIP_MONKEYPATCH_COMPAT_NAME( UiFileLayout ) = 2
5489 };
5490 Q_ENUM( AttributeFormLayout )
5491
5492
5500 {
5501 Default SIP_MONKEYPATCH_COMPAT_NAME( SuppressDefault ) = 0,
5502 On SIP_MONKEYPATCH_COMPAT_NAME( SuppressOn ) = 1,
5503 Off SIP_MONKEYPATCH_COMPAT_NAME( SuppressOff ) = 2
5504 };
5505 Q_ENUM( AttributeFormSuppression )
5506
5507
5515 {
5516 NoSource SIP_MONKEYPATCH_COMPAT_NAME( CodeSourceNone ) = 0,
5517 File SIP_MONKEYPATCH_COMPAT_NAME( CodeSourceFile ) = 1,
5518 Dialog SIP_MONKEYPATCH_COMPAT_NAME( CodeSourceDialog ) = 2,
5519 Environment SIP_MONKEYPATCH_COMPAT_NAME( CodeSourceEnvironment ) = 3
5520 };
5521 Q_ENUM( AttributeFormPythonInitCodeSource )
5522
5523
5529 {
5530 NotAllowed = 0,
5531 AllowedDefaultOn = 1,
5532 AllowedDefaultOff = 2,
5533 };
5534 Q_ENUM( AttributeFormReuseLastValuePolicy )
5535
5536
5542 {
5544 PointCloud,
5545 RasterCalculator,
5546 };
5547 Q_ENUM( ExpressionType )
5548
5549
5557 {
5558 NoSymbology = 0,
5559 PerFeature SIP_MONKEYPATCH_COMPAT_NAME( FeatureSymbology ),
5560 PerSymbolLayer SIP_MONKEYPATCH_COMPAT_NAME( SymbolLayerSymbology )
5561 };
5562 Q_ENUM( FeatureSymbologyExport )
5563
5564
5569 enum class VectorTileProviderFlag : int SIP_ENUM_BASETYPE( IntFlag )
5570 {
5571 AlwaysUseTileMatrixSetFromProvider = 1 << 1,
5572 };
5573 Q_ENUM( VectorTileProviderFlag )
5574
5575
5581 Q_FLAG( VectorTileProviderFlags )
5582
5588 {
5589 ReadLayerMetadata = 1 << 1,
5590 };
5591 Q_ENUM( VectorTileProviderCapability )
5592
5593
5600
5607 {
5608 Available,
5609 NotAvailable,
5610 AvailableNoChildren,
5611 UseLowerZoomLevelTile,
5612 };
5613 Q_ENUM( TileAvailability )
5614
5615
5621 {
5622 ReadLayerMetadata = 1 << 1,
5623 };
5624 Q_ENUM( TiledSceneProviderCapability )
5625
5626
5633
5640 {
5641 Region,
5642 OrientedBox,
5643 Sphere,
5644 };
5645 Q_ENUM( TiledSceneBoundingVolumeType )
5646
5647
5656 {
5657 Replacement,
5658 Additive,
5659 };
5660 Q_ENUM( TileRefinementProcess )
5661
5662
5668 {
5669 NoChildren,
5670 Available,
5671 NeedFetching,
5672 };
5673 Q_ENUM( TileChildrenAvailability )
5674
5675
5680 enum class TiledSceneRequestFlag : int SIP_ENUM_BASETYPE( IntFlag )
5681 {
5682 NoHierarchyFetch = 1 << 0,
5683 };
5684 Q_ENUM( TiledSceneRequestFlag )
5685
5686
5692 Q_FLAG( TiledSceneRequestFlags )
5693
5699 enum class TiledSceneRendererFlag : int SIP_ENUM_BASETYPE( IntFlag )
5700 {
5701 RequiresTextures = 1 << 0,
5702 ForceRasterRender = 1 << 1,
5703 RendersTriangles = 1 << 2,
5704 RendersLines = 1 << 3,
5705 };
5706 Q_ENUM( TiledSceneRendererFlag )
5707
5708
5714 Q_FLAG( TiledSceneRendererFlags )
5715
5721 enum class GdalResampleAlgorithm : int
5722 {
5723 RA_NearestNeighbour = 0,
5724 RA_Bilinear = 1,
5725 RA_Cubic = 2,
5726 RA_CubicSpline = 3,
5727 RA_Lanczos = 4,
5728 RA_Average = 5,
5729 RA_Mode = 6,
5730 RA_Max = 8,
5731 RA_Min = 9,
5732 RA_Median = 10,
5733 RA_Q1 = 11,
5734 RA_Q3 = 12,
5735 };
5736 Q_ENUM( GdalResampleAlgorithm )
5737
5738
5743 enum class VsiHandlerType : int
5744 {
5745 Invalid,
5746 Archive,
5747 Network,
5748 Cloud,
5749 Memory,
5750 Other,
5751 };
5752 Q_ENUM( VsiHandlerType )
5753
5754 // TODO QGIS 4: make All include all values (we can't do this before 4.0, as we need to keep
5755 // compatibility with code which expects all these statistics to give numeric results)
5756
5757
5762 enum class ZonalStatistic : int SIP_ENUM_BASETYPE( IntFlag )
5763 {
5764 Count = 1 << 0,
5765 Sum = 1 << 1,
5766 Mean = 1 << 2,
5767 Median = 1 << 3,
5768 StDev = 1 << 4,
5769 Min = 1 << 5,
5770 Max = 1 << 6,
5771 Range = 1 << 7,
5772 Minority = 1 << 8,
5773 Majority = 1 << 9,
5774 Variety = 1 << 10,
5775 Variance = 1 << 11,
5776 MinimumPoint = 1 << 12,
5777 MaximumPoint = 1 << 13,
5778 All = Count | Sum | Mean | Median | StDev | Max | Min | Range | Minority | Majority | Variety | Variance,
5779 AllNumeric = Count | Sum | Mean | Median | StDev | Max | Min | Range | Minority | Majority | Variety | Variance,
5780 Default = Count | Sum | Mean,
5781 };
5782 Q_ENUM( ZonalStatistic )
5783
5784
5790 Q_FLAG( ZonalStatistics )
5791
5797 enum class ZonalStatisticResult : int
5798 {
5800 LayerTypeWrong = 1,
5801 LayerInvalid,
5802 RasterInvalid,
5803 RasterBandInvalid,
5804 FailedToCreateField = 8,
5805 Canceled = 9
5806 };
5807 Q_ENUM( ZonalStatisticResult )
5808
5809
5816 {
5817 Count,
5818 CountDistinct,
5819 CountMissing,
5820 Min,
5821 Max,
5822 Sum,
5823 Mean,
5824 Median,
5825 StDev,
5826 StDevSample,
5827 Range,
5828 Minority,
5829 Majority,
5830 FirstQuartile,
5831 ThirdQuartile,
5832 InterQuartileRange,
5833 StringMinimumLength,
5834 StringMaximumLength,
5835 StringConcatenate,
5836 GeometryCollect,
5837 ArrayAggregate,
5838 StringConcatenateUnique
5839 };
5840 Q_ENUM( Aggregate )
5841
5842
5848 {
5849 Count = 1 << 0,
5850 CountMissing = 1 << 15,
5851 Sum = 1 << 1,
5852 Mean = 1 << 2,
5853 Median = 1 << 3,
5854 StDev = 1 << 4,
5855 StDevSample = 1 << 5,
5856 Min = 1 << 6,
5857 Max = 1 << 7,
5858 Range = 1 << 8,
5859 Minority = 1 << 9,
5860 Majority = 1 << 10,
5861 Variety = 1 << 11,
5862 FirstQuartile = 1 << 12,
5863 ThirdQuartile = 1 << 13,
5864 InterQuartileRange = 1 << 14,
5865 First = 1 << 16,
5866 Last = 1 << 17,
5867 All = Count | CountMissing | Sum | Mean | Median | StDev | Max | Min | Range | Minority | Majority | Variety | FirstQuartile | ThirdQuartile | InterQuartileRange | First | Last
5868 };
5869 Q_ENUM( Statistic )
5870
5871
5877 Q_FLAG( Statistics )
5878
5885 {
5886 Count = 1,
5887 CountDistinct = 2,
5888 CountMissing = 4,
5889 Min = 8,
5890 Max = 16,
5891 Range = 32,
5892 All = Count | CountDistinct | CountMissing | Min | Max | Range,
5893 };
5894 Q_ENUM( DateTimeStatistic )
5895
5896
5902 Q_FLAG( DateTimeStatistics )
5903
5910 {
5911 Count = 1,
5912 CountDistinct = 2,
5913 CountMissing = 4,
5914 Min = 8,
5915 Max = 16,
5916 MinimumLength = 32,
5917 MaximumLength = 64,
5918 MeanLength = 128,
5919 Minority = 256,
5920 Majority = 512,
5921 All = Count | CountDistinct | CountMissing | Min | Max | MinimumLength | MaximumLength | MeanLength | Minority | Majority,
5922 };
5923 Q_ENUM( StringStatistic )
5924
5925
5931 Q_FLAG( StringStatistics )
5932
5939 {
5940 NoStatistic = 0,
5941 Min = 1,
5942 Max = 1 << 1,
5943 Range = 1 << 2,
5944 Sum = 1 << 3,
5945 Mean = 1 << 4,
5946 StdDev = 1 << 5,
5947 SumOfSquares = 1 << 6,
5948 All = Min | Max | Range | Sum | Mean | StdDev | SumOfSquares
5949 };
5950 Q_ENUM( RasterBandStatistic )
5951
5952
5958 Q_FLAG( RasterBandStatistics )
5959
5965 enum class SensorThingsEntity : int
5966 {
5967 Invalid,
5968 Thing,
5969 Location,
5970 HistoricalLocation,
5971 Datastream,
5972 Sensor,
5973 ObservedProperty,
5974 Observation,
5975 FeatureOfInterest,
5976 MultiDatastream,
5977 };
5978 Q_ENUM( SensorThingsEntity )
5979
5980
5985 enum class ColorModel : int
5986 {
5987 Rgb,
5988 Cmyk,
5989 };
5990 Q_ENUM( ColorModel )
5991
5992
5997 enum class DocumentationApi : int
5998 {
5999 PyQgis,
6000 PyQgisSearch,
6001 CppQgis,
6002 Qt,
6003 };
6004 Q_ENUM( DocumentationApi )
6005
6006
6011 enum class DocumentationBrowser : int
6012 {
6013 DeveloperToolsPanel,
6014 SystemWebBrowser,
6015 };
6016 Q_ENUM( DocumentationBrowser )
6017
6018
6023 enum class MouseHandlesAction : int
6024 {
6025 MoveItem,
6026 ResizeUp,
6027 ResizeDown,
6028 ResizeLeft,
6029 ResizeRight,
6030 ResizeLeftUp,
6031 ResizeRightUp,
6032 ResizeLeftDown,
6033 ResizeRightDown,
6034 RotateTopLeft,
6035 RotateTopRight,
6036 RotateBottomLeft,
6037 RotateBottomRight,
6038 SelectItem,
6039 NoAction
6040 };
6041 Q_ENUM( MouseHandlesAction )
6042
6043
6047 enum class MeshRangeLimit : int
6048 {
6049 NotSet,
6050 MinimumMaximum,
6051 };
6052 Q_ENUM( MeshRangeLimit )
6053
6054
6059 enum class MeshRangeExtent : int
6060 {
6061 WholeMesh,
6062 FixedCanvas,
6063 UpdatedCanvas,
6064 };
6065 Q_ENUM( MeshRangeExtent )
6066
6067
6073 enum class PointCloudAccessType : int
6074 {
6075 Local,
6076 Remote
6077 };
6078 Q_ENUM( PointCloudAccessType )
6079
6080
6085 {
6086 RenderExtents,
6087 RenderOverview,
6088 RenderOverviewAndExtents
6089 };
6090 Q_ENUM( PointCloudZoomOutRenderBehavior )
6091
6092
6097 {
6098 Standard = 0,
6099 Adaptive,
6100 AreaError,
6101 ConstantDensity
6102 };
6103 Q_ENUM( SegmentCalculationMethod )
6104
6105
6109 enum class StacObjectType : int
6110 {
6111 Unknown,
6112 Catalog,
6113 Collection,
6114 Item,
6115 };
6116 Q_ENUM( StacObjectType )
6117
6118
6123 {
6124 WmsScale = 1 << 0,
6125 WmsDpi = 1 << 1,
6126 };
6127 Q_ENUM( RasterProcessingParameterCapability )
6128
6129
6135
6141 {
6142 Status = Qt::UserRole + 1,
6143 Id,
6144 ElapsedTime,
6145 MaximumTime,
6146 Sort,
6147 };
6148 Q_ENUM( DevToolsNodeRole )
6149
6150
6155 enum class ExtrusionFace : int SIP_ENUM_BASETYPE( IntFlag )
6156 {
6157 NoFace = 0,
6158 Walls = 1 << 0,
6159 Roof = 1 << 1,
6160 Floor = 1 << 2
6161 };
6162 Q_ENUM( ExtrusionFace )
6163
6164
6168 Q_DECLARE_FLAGS( ExtrusionFaces, ExtrusionFace )
6169 Q_FLAG( ExtrusionFaces )
6170
6174 static const double DEFAULT_SEARCH_RADIUS_MM;
6175
6178
6184 static const QColor DEFAULT_HIGHLIGHT_COLOR;
6185
6189 static const double DEFAULT_HIGHLIGHT_BUFFER_MM;
6190
6195
6203 Q_DECL_DEPRECATED static const double SCALE_PRECISION;
6204
6209 static const double DEFAULT_Z_COORDINATE;
6210
6216 static const double DEFAULT_M_COORDINATE;
6217
6222 static const double UI_SCALE_FACTOR;
6223
6227 static const double DEFAULT_SNAP_TOLERANCE;
6228
6233
6237 static const int USER_CRS_START_ID;
6238
6240 static const double DEFAULT_POINT_SIZE;
6241
6243 static const double DEFAULT_LINE_WIDTH;
6244
6246 static const double DEFAULT_SEGMENT_EPSILON;
6247
6250
6253
6259 static QString defaultProjectScales();
6260
6266 static int geosVersionInt();
6267
6273 static int geosVersionMajor();
6274
6280 static int geosVersionMinor();
6281
6287 static int geosVersionPatch();
6288
6294 static QString geosVersion();
6295
6301 static bool hasSfcgal();
6302
6309 static int sfcgalVersionInt();
6310
6316 static bool hasQtWebkit();
6317
6323 static QString geoNone()
6324 {
6325 return QStringLiteral( "NONE" );
6326 }
6327
6333 static QString geographicCrsAuthId()
6334 {
6335 return QStringLiteral( "EPSG:4326" );
6336 }
6337
6342 Q_DECL_DEPRECATED static QString geoWkt()
6343 {
6344 return QStringLiteral(
6345 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]] )"""
6346 );
6347 }
6348
6353 Q_DECL_DEPRECATED static QString geoProj4()
6354 {
6355 return QStringLiteral( "+proj=longlat +datum=WGS84 +no_defs" );
6356 }
6357
6358};
6359
6362
6453Q_DECLARE_METATYPE( QTimeZone )
6454
6455// hack to workaround warnings when casting void pointers
6456// retrieved from QLibrary::resolve to function pointers.
6457// It's assumed that this works on all systems supporting
6458// QLibrary
6459#define cast_to_fptr(f) f
6460
6461
6469// based on Boojum's code from http://stackoverflow.com/questions/3556687/prevent-firing-signals-in-qt
6470template<class Object> class QgsSignalBlocker SIP_SKIP SIP_SKIP // clazy:exclude=rule-of-three
6471{
6472 public:
6473
6478 explicit QgsSignalBlocker( Object *object )
6479 : mObject( object )
6480 , mPreviousState( object->blockSignals( true ) )
6481 {}
6482
6484 {
6485 mObject->blockSignals( mPreviousState );
6486 }
6487
6489 Object *operator->() { return mObject; }
6490
6491 private:
6492
6493 Object *mObject = nullptr;
6494 bool mPreviousState;
6495
6496};
6497
6510// based on Boojum's code from http://stackoverflow.com/questions/3556687/prevent-firing-signals-in-qt
6511template<class Object> inline QgsSignalBlocker<Object> whileBlocking( Object *object ) SIP_SKIP SIP_SKIP
6512{
6513 return QgsSignalBlocker<Object>( object );
6514}
6515
6517CORE_EXPORT uint qHash( const QVariant &variant );
6518
6524inline QString qgsDoubleToString( double a, int precision = 17 )
6525{
6526 QString str;
6527 if ( precision )
6528 {
6529 if ( precision < 0 )
6530 {
6531 const double roundFactor = std::pow( 10, -precision );
6532 str = QString::number( static_cast< long long >( std::round( a / roundFactor ) * roundFactor ) );
6533 }
6534 else
6535 {
6536 str = QString::number( a, 'f', precision );
6537 if ( str.contains( QLatin1Char( '.' ) ) )
6538 {
6539 // remove ending 0s
6540 int idx = str.length() - 1;
6541 while ( str.at( idx ) == '0' && idx > 1 )
6542 {
6543 idx--;
6544 }
6545 if ( idx < str.length() - 1 )
6546 str.truncate( str.at( idx ) == '.' ? idx : idx + 1 );
6547 }
6548 }
6549 }
6550 else
6551 {
6552 str = QString::number( a, 'f', precision );
6553 }
6554 // avoid printing -0
6555 // see https://bugreports.qt.io/browse/QTBUG-71439
6556 if ( str == QLatin1String( "-0" ) )
6557 {
6558 return QLatin1String( "0" );
6559 }
6560 return str;
6561}
6562
6569inline bool qgsNanCompatibleEquals( double a, double b )
6570{
6571 const bool aIsNan = std::isnan( a );
6572 const bool bIsNan = std::isnan( b );
6573 if ( aIsNan || bIsNan )
6574 return aIsNan && bIsNan;
6575
6576 return a == b;
6577}
6578
6579#ifndef SIP_RUN
6580
6588template<typename T>
6589inline bool qgsNumberNear( T a, T b, T epsilon = std::numeric_limits<T>::epsilon() * 4 )
6590{
6591 const bool aIsNan = std::isnan( a );
6592 const bool bIsNan = std::isnan( b );
6593 if ( aIsNan || bIsNan )
6594 return aIsNan && bIsNan;
6595
6596 const T diff = a - b;
6597 return diff >= -epsilon && diff <= epsilon;
6598}
6599#endif
6600
6607inline bool qgsDoubleNear( double a, double b, double epsilon = 4 * std::numeric_limits<double>::epsilon() )
6608{
6609 return qgsNumberNear<double>( a, b, epsilon );
6610}
6611
6618inline bool qgsFloatNear( float a, float b, float epsilon = 4 * FLT_EPSILON )
6619{
6620 return qgsNumberNear<float>( a, b, epsilon );
6621}
6622
6624inline bool qgsDoubleNearSig( double a, double b, int significantDigits = 10 )
6625{
6626 const bool aIsNan = std::isnan( a );
6627 const bool bIsNan = std::isnan( b );
6628 if ( aIsNan || bIsNan )
6629 return aIsNan && bIsNan;
6630
6631 // The most simple would be to print numbers as %.xe and compare as strings
6632 // but that is probably too costly
6633 // Then the fastest would be to set some bits directly, but little/big endian
6634 // has to be considered (maybe TODO)
6635 // Is there a better way?
6636 int aexp, bexp;
6637 const double ar = std::frexp( a, &aexp );
6638 const double br = std::frexp( b, &bexp );
6639
6640 return aexp == bexp &&
6641 std::round( ar * std::pow( 10.0, significantDigits ) ) == std::round( br * std::pow( 10.0, significantDigits ) );
6642}
6643
6648inline double qgsRound( double number, int places )
6649{
6650 const double m = ( number < 0.0 ) ? -1.0 : 1.0;
6651 const double scaleFactor = std::pow( 10.0, places );
6652 return ( std::round( number * m * scaleFactor ) / scaleFactor ) * m;
6653}
6654
6655#ifndef SIP_RUN
6656
6663template<class Key, class Value>
6664QString qgsMapJoinKeys( const QMap<Key, Value> &map, const QString &separator )
6665{
6666 QString result;
6667 for ( auto it = map.constBegin(); it != map.constEnd(); it++ )
6668 result += QString( "%1%2" ).arg( it.key() ).arg( separator );
6669
6670 result.chop( separator.size() );
6671 return result;
6672}
6673
6680template<class Key, class Value>
6681QString qgsMapJoinValues( const QMap<Key, Value> &map, const QString &separator )
6682{
6683 QString result;
6684 for ( auto it = map.constBegin(); it != map.constEnd(); it++ )
6685 result += QString( "%1%2" ).arg( it.value() ).arg( separator );
6686
6687 result.chop( separator.size() );
6688 return result;
6689}
6690
6697template<class T>
6698QString qgsSetJoin( const QSet<T> &set, const QString &separator )
6699{
6700 QString result;
6701 for ( auto it = set.constBegin(); it != set.constEnd(); it++ )
6702 result += QString( "%1%2" ).arg( *it ).arg( separator );
6703
6704 result.chop( separator.size() );
6705 return result;
6706}
6707
6709
6719namespace qgis
6720{
6721
6734 template<typename To, typename From> inline To down_cast( From *f )
6735 {
6736 static_assert(
6737 ( std::is_base_of<From,
6738 typename std::remove_pointer<To>::type>::value ),
6739 "target type not derived from source type" );
6740 Q_ASSERT( f == nullptr || dynamic_cast<To>( f ) != nullptr );
6741 return static_cast<To>( f );
6742 }
6743
6744 template<class T>
6745 QSet<T> listToSet( const QList<T> &list )
6746 {
6747 return QSet<T>( list.begin(), list.end() );
6748 }
6749
6750 template<class T>
6751 QList<T> setToList( const QSet<T> &set )
6752 {
6753 return QList<T>( set.begin(), set.end() );
6754 }
6755}
6756
6758#endif
6759
6764template<class T> const QList<T> qgsEnumList() SIP_SKIP
6765{
6766 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
6767 Q_ASSERT( metaEnum.isValid() );
6768 QList<T> enumList;
6769 for ( int idx = 0; idx < metaEnum.keyCount(); ++idx )
6770 {
6771 enumList.append( static_cast<T>( metaEnum.value( idx ) ) );
6772 }
6773 return enumList;
6774}
6775
6781template<class T> const QMap<T, QString> qgsEnumMap() SIP_SKIP
6782{
6783 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
6784 Q_ASSERT( metaEnum.isValid() );
6785 QMap<T, QString> enumMap;
6786 for ( int idx = 0; idx < metaEnum.keyCount(); ++idx )
6787 {
6788 enumMap.insert( static_cast<T>( metaEnum.value( idx ) ), QString( metaEnum.key( idx ) ) );
6789 }
6790 return enumMap;
6791}
6792
6798template<class T> QString qgsEnumValueToKey( const T &value, bool *returnOk = nullptr ) SIP_SKIP
6799{
6800 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
6801 Q_ASSERT( metaEnum.isValid() );
6802 const char *key = metaEnum.valueToKey( static_cast<int>( value ) );
6803 if ( returnOk )
6804 {
6805 *returnOk = key ? true : false;
6806 }
6807 return QString::fromUtf8( key );
6808}
6809
6817template<class T> T qgsEnumKeyToValue( const QString &key, const T &defaultValue, bool tryValueAsKey = true, bool *returnOk = nullptr ) SIP_SKIP
6818{
6819 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
6820 Q_ASSERT( metaEnum.isValid() );
6821 bool ok = false;
6822 T v = static_cast<T>( metaEnum.keyToValue( key.toUtf8().data(), &ok ) );
6823 if ( returnOk )
6824 {
6825 *returnOk = ok;
6826 }
6827 if ( ok )
6828 {
6829 return v;
6830 }
6831 else
6832 {
6833 // if conversion has failed, try with conversion from int value
6834 if ( tryValueAsKey )
6835 {
6836 bool canConvert = false;
6837 const int intValue = key.toInt( &canConvert );
6838 if ( canConvert && metaEnum.valueToKey( intValue ) )
6839 {
6840 if ( returnOk )
6841 {
6842 *returnOk = true;
6843 }
6844 return static_cast<T>( intValue );
6845 }
6846 }
6847 }
6848 return defaultValue;
6849}
6850
6856template<class T> QString qgsFlagValueToKeys( const T &value, bool *returnOk = nullptr ) SIP_SKIP
6857{
6858 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
6859 Q_ASSERT( metaEnum.isValid() );
6860 int intValue = static_cast<int>( value );
6861 const QByteArray ba = metaEnum.valueToKeys( intValue );
6862 // check that the int value does correspond to a flag
6863 // see https://stackoverflow.com/a/68495949/1548052
6864 const int intValueCheck = metaEnum.keysToValue( ba );
6865 bool ok = intValue == intValueCheck;
6866 if ( returnOk )
6867 *returnOk = ok;
6868 return ok ? QString::fromUtf8( ba ) : QString();
6869}
6870
6878template<class T> T qgsFlagKeysToValue( const QString &keys, const T &defaultValue, bool tryValueAsKey = true, bool *returnOk = nullptr ) SIP_SKIP
6879{
6880 if ( keys.isEmpty() )
6881 {
6882 if ( returnOk )
6883 {
6884 *returnOk = false;
6885 }
6886 return defaultValue;
6887 }
6888 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
6889 Q_ASSERT( metaEnum.isValid() );
6890 bool ok = false;
6891 T v = static_cast<T>( metaEnum.keysToValue( keys.toUtf8().constData(), &ok ) );
6892 if ( returnOk )
6893 {
6894 *returnOk = ok;
6895 }
6896 if ( ok )
6897 {
6898 return v;
6899 }
6900 else
6901 {
6902 // if conversion has failed, try with conversion from int value
6903 if ( tryValueAsKey )
6904 {
6905 bool canConvert = false;
6906 const int intValue = keys.toInt( &canConvert );
6907 if ( canConvert )
6908 {
6909 const QByteArray keyArray = metaEnum.valueToKeys( intValue );
6910 const int intValueCheck = metaEnum.keysToValue( keyArray );
6911 if ( !keyArray.isEmpty() && intValue == intValueCheck )
6912 {
6913 if ( returnOk )
6914 {
6915 *returnOk = true;
6916 }
6917 return T( intValue );
6918 }
6919 }
6920 }
6921 }
6922 return defaultValue;
6923}
6924
6925
6934CORE_EXPORT double qgsPermissiveToDouble( QString string, bool &ok );
6935
6944CORE_EXPORT int qgsPermissiveToInt( QString string, bool &ok );
6945
6955CORE_EXPORT qlonglong qgsPermissiveToLongLong( QString string, bool &ok );
6956
6976CORE_EXPORT int qgsVariantCompare( const QVariant &lhs, const QVariant &rhs, bool strictTypeCheck = false );
6977
6988CORE_EXPORT bool qgsVariantLessThan( const QVariant &lhs, const QVariant &rhs );
6989
6998CORE_EXPORT bool qgsVariantEqual( const QVariant &lhs, const QVariant &rhs );
6999
7008CORE_EXPORT bool qgsVariantGreaterThan( const QVariant &lhs, const QVariant &rhs );
7009
7010#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
7011
7023inline bool operator> ( const QVariant &v1, const QVariant &v2 )
7024{
7025 return qgsVariantCompare( v1, v2, true ) > 0;
7026}
7027
7039inline bool operator< ( const QVariant &v1, const QVariant &v2 )
7040{
7041 return qgsVariantCompare( v1, v2, true ) < 0;
7042}
7043#endif
7044
7045
7046#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
7047
7051template<> CORE_EXPORT bool qMapLessThanKey<QVariantList>( const QVariantList &key1, const QVariantList &key2 ) SIP_SKIP;
7052#endif
7053
7060Q_DECL_DEPRECATED CORE_EXPORT QString qgsVsiPrefix( const QString &path ) SIP_DEPRECATED;
7061
7067void CORE_EXPORT *qgsMalloc( size_t size ) SIP_SKIP;
7068
7073void CORE_EXPORT qgsFree( void *ptr ) SIP_SKIP;
7074
7075#ifndef SIP_RUN
7076
7078class ScopedIntIncrementor
7079{
7080 public:
7081
7082 ScopedIntIncrementor( int *variable )
7083 : mVariable( variable )
7084 {
7085 ( *mVariable )++;
7086 }
7087
7088 ScopedIntIncrementor( const ScopedIntIncrementor &other ) = delete;
7089 ScopedIntIncrementor &operator=( const ScopedIntIncrementor &other ) = delete;
7090
7091 void release()
7092 {
7093 if ( mVariable )
7094 ( *mVariable )--;
7095
7096 mVariable = nullptr;
7097 }
7098
7099 ~ScopedIntIncrementor()
7100 {
7101 release();
7102 }
7103
7104 private:
7105 int *mVariable = nullptr;
7106};
7108
7109#endif
7110
7116Q_DECL_DEPRECATED const long GEOSRID = 4326;
7117
7123Q_DECL_DEPRECATED const long GEOCRS_ID = 3452;
7124
7130Q_DECL_DEPRECATED const long GEO_EPSG_CRS_ID = 4326;
7131
7132typedef QMap<QString, QString> QgsStringMap SIP_SKIP;
7133
7142typedef unsigned long long qgssize;
7143
7144#ifndef SIP_RUN
7145#if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6)) || defined(__clang__)
7146
7147#define Q_NOWARN_DEPRECATED_PUSH \
7148 _Pragma("GCC diagnostic push") \
7149 _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"");
7150#define Q_NOWARN_DEPRECATED_POP \
7151 _Pragma("GCC diagnostic pop");
7152#define Q_NOWARN_UNREACHABLE_PUSH
7153#define Q_NOWARN_UNREACHABLE_POP
7154
7155#elif defined(_MSC_VER)
7156
7157#define Q_NOWARN_DEPRECATED_PUSH \
7158 __pragma(warning(push)) \
7159 __pragma(warning(disable:4996))
7160#define Q_NOWARN_DEPRECATED_POP \
7161 __pragma(warning(pop))
7162#define Q_NOWARN_UNREACHABLE_PUSH \
7163 __pragma(warning(push)) \
7164 __pragma(warning(disable:4702))
7165#define Q_NOWARN_UNREACHABLE_POP \
7166 __pragma(warning(pop))
7167#else
7168
7169#define Q_NOWARN_DEPRECATED_PUSH
7170#define Q_NOWARN_DEPRECATED_POP
7171#define Q_NOWARN_UNREACHABLE_PUSH
7172#define Q_NOWARN_UNREACHABLE_POP
7173
7174#endif
7175#endif
7176
7177#ifndef QGISEXTERN
7178#ifdef Q_OS_WIN
7179# define QGISEXTERN extern "C" __declspec( dllexport )
7180#else
7181# if defined(__GNUC__) || defined(__clang__)
7182# define QGISEXTERN extern "C" __attribute__ ((visibility ("default")))
7183# else
7184# define QGISEXTERN extern "C"
7185# endif
7186#endif
7187#endif
7188#endif
7189
7190#ifndef SIP_RUN
7191#ifdef _MSC_VER
7192#define BUILTIN_UNREACHABLE \
7193 __assume(false);
7194#elif defined(__GNUC__) && !defined(__clang__)
7195// Workaround a GCC bug where a -Wreturn-type warning is emitted in constructs
7196// like:
7197// switch( mVariableThatCanOnlyBeXorY )
7198// {
7199// case X:
7200// return "foo";
7201// case Y:
7202// return "foo";
7203// }
7204// See https://gcc.gnu.org/bugzilla/show_bug.cgi?id=87951
7205#define BUILTIN_UNREACHABLE \
7206 __builtin_unreachable();
7207#else
7208#define BUILTIN_UNREACHABLE
7209#endif
7210#endif // SIP_RUN
Provides global constants and enumerations for use throughout the application.
Definition qgis.h:56
DistanceUnitType
Types of distance units.
Definition qgis.h:5075
PieChartLabelType
Pie chart label types.
Definition qgis.h:3346
GnssConstellation
GNSS constellation.
Definition qgis.h:1904
SettingsOption
Settings options.
Definition qgis.h:724
EmbeddedScriptType
Type of Python Embedded in projects.
Definition qgis.h:439
ProfileGeneratorFlag
Flags that control the way the QgsAbstractProfileGenerator operate.
Definition qgis.h:4218
ProcessingSourceType
Processing data source types.
Definition qgis.h:3531
static const Qgis::MapToolUnit DEFAULT_SNAP_UNITS
Default snapping distance units.
Definition qgis.h:6232
GpsQualityIndicator
GPS signal quality indicator.
Definition qgis.h:1922
DataItemProviderCapability
Capabilities for data item providers.
Definition qgis.h:976
ProcessingFileParameterBehavior
Flags which dictate the behavior of QgsProcessingParameterFile.
Definition qgis.h:3788
RasterizedRenderingPolicy
Policies controlling when rasterisation of content during renders is permitted.
Definition qgis.h:2703
QFlags< MapLayerRendererFlag > MapLayerRendererFlags
Flags which control how map layer renderers behave.
Definition qgis.h:2796
ProjectReadFlag
Flags which control project read behavior.
Definition qgis.h:4302
QFlags< DatabaseProviderTableImportCapability > DatabaseProviderTableImportCapabilities
Definition qgis.h:5412
QFlags< BabelCommandFlag > BabelCommandFlags
Babel command flags.
Definition qgis.h:2017
MapToolUnit
Type of unit of tolerance value from settings.
Definition qgis.h:4981
PlotAxisSuffixPlacement
Placement options for suffixes in the labels for axis of plots.
Definition qgis.h:3318
static const double DEFAULT_LINE_WIDTH
The default width (in millimeters) for line symbols.
Definition qgis.h:6243
ProcessingModelChildAlgorithmExecutionStatus
Reflects the status of a child algorithm in a Processing model.
Definition qgis.h:3863
QFlags< GpsInformationComponent > GpsInformationComponents
GPS information component.
Definition qgis.h:1984
ScaleBarDistanceLabelHorizontalPlacement
Scale bar distance label horizontal placement.
Definition qgis.h:5345
PointCloudSymbol
Rendering symbols for point cloud points.
Definition qgis.h:4246
SymbolRotationMode
Modes for handling how symbol and text entity rotation is handled when maps are rotated.
Definition qgis.h:786
static const double DEFAULT_HIGHLIGHT_MIN_WIDTH_MM
Default highlight line/stroke minimum width in mm.
Definition qgis.h:6194
static QString version()
Version string.
Definition qgis.cpp:677
GeometryValidityFlag
Geometry validity check flags.
Definition qgis.h:2071
QFlags< RasterProviderCapability > RasterProviderCapabilities
Raster data provider capabilities.
Definition qgis.h:4906
ExpressionType
Expression types.
Definition qgis.h:5542
MapLayerActionFlag
Map layer action flags.
Definition qgis.h:4651
ScaleBarDistanceLabelVerticalPlacement
Scale bar distance label vertical placement.
Definition qgis.h:5331
MapLayerProperty
Generic map layer properties.
Definition qgis.h:2279
VectorProviderCapability
Vector data provider capabilities.
Definition qgis.h:499
RasterProcessingParameterCapability
Capabilities of a raster layer processing parameter.
Definition qgis.h:6123
BufferSide
Side of line to buffer.
Definition qgis.h:2096
RasterResamplingStage
Stage at which raster resampling occurs.
Definition qgis.h:1470
QFlags< MapLayerActionTarget > MapLayerActionTargets
Map layer action targets.
Definition qgis.h:4640
VectorTileProviderCapability
Enumeration with capabilities that vector tile data providers might implement.
Definition qgis.h:5588
ProjectTrustStatus
Project trust status.
Definition qgis.h:452
AltitudeClamping
Altitude clamping.
Definition qgis.h:3982
static const int PREVIEW_JOB_DELAY_MS
Delay between the scheduling of 2 preview jobs.
Definition qgis.h:6249
VectorTileProviderFlag
Flags for vector tile data providers.
Definition qgis.h:5570
VectorTemporalMode
Vector layer temporal feature modes.
Definition qgis.h:2580
SublayerFlag
Flags which reflect the properties of sublayers in a dataset.
Definition qgis.h:1409
QFlags< ProjectCapability > ProjectCapabilities
Flags which control project capabilities.
Definition qgis.h:4343
LabelLinePlacementFlag
Line placement flags, which control how candidates are generated for a linear feature.
Definition qgis.h:1275
QFlags< UriCleaningFlag > UriCleaningFlags
Flags for cleaning layer URIs.
Definition qgis.h:1382
CoordinateDisplayType
Formats for displaying coordinates.
Definition qgis.h:4452
ProcessingParameterTypeFlag
Flags which dictate the behavior of Processing parameter types.
Definition qgis.h:3736
QFlags< VectorRenderingSimplificationFlag > VectorRenderingSimplificationFlags
Simplification flags for vector feature rendering.
Definition qgis.h:3044
DashPatternSizeAdjustment
Dash pattern size adjustment options.
Definition qgis.h:3291
static const double DEFAULT_Z_COORDINATE
Default Z coordinate value.
Definition qgis.h:6209
GpsFixStatus
GPS fix status.
Definition qgis.h:1889
AnnotationItemNodeType
Annotation item node types.
Definition qgis.h:2507
static const char * QGIS_DEV_VERSION
The development version.
Definition qgis.h:84
VectorFileWriterCapability
Capabilities supported by a QgsVectorFileWriter object.
Definition qgis.h:1073
QFlags< MapSettingsFlag > MapSettingsFlags
Map settings flags.
Definition qgis.h:2738
CrsIdentifierType
Available identifier string types for representing coordinate reference systems.
Definition qgis.h:2417
QFlags< RasterRendererFlag > RasterRendererFlags
Flags which control behavior of raster renderers.
Definition qgis.h:1512
AngularDirection
Angular directions.
Definition qgis.h:3432
DriveType
Drive types.
Definition qgis.h:1126
UnitType
Unit types.
Definition qgis.h:4996
ContentStatus
Status for fetched or stored content.
Definition qgis.h:1845
QFlags< SelectionFlag > SelectionFlags
Flags which control feature selection behavior.
Definition qgis.h:1807
SnappingType
SnappingTypeFlag defines on what object the snapping is performed.
Definition qgis.h:749
LayoutUnit
Layout measurement units.
Definition qgis.h:5203
Q_ENUM(GpsFixStatus)
RelationshipStrength
Relationship strength.
Definition qgis.h:4405
Q_ENUM(GnssConstellation)
PaintEffectFlag
Flags which control how paint effects behave.
Definition qgis.h:2805
MarkerLinePlacement
Defines how/where the symbols should be placed on a line.
Definition qgis.h:3129
QFlags< ProjectReadFlag > ProjectReadFlags
Project load flags.
Definition qgis.h:4321
LegendComponent
Component of legends which can be styled.
Definition qgis.h:4575
Point3DShape
3D point shape types.
Definition qgis.h:4124
GeometryOperationResult
Success or failure of a geometry operation.
Definition qgis.h:2042
QFlags< StringStatistic > StringStatistics
Statistics to be calculated for string values.
Definition qgis.h:5930
BrowserItemState
Browser item states.
Definition qgis.h:938
AttributeEditorContainerType
Attribute editor container types.
Definition qgis.h:5470
QFlags< TiledSceneProviderCapability > TiledSceneProviderCapabilities
Tiled scene data provider capabilities.
Definition qgis.h:5631
FeatureRequestFilterType
Types of feature request filters.
Definition qgis.h:2222
MarkerClipMode
Marker clipping modes.
Definition qgis.h:3249
GpsNavigationStatus
GPS navigation status.
Definition qgis.h:1942
AnnotationItemFlag
Flags for annotation items.
Definition qgis.h:2464
AttributeFormReuseLastValuePolicy
Attribute form policy for reusing last entered values.
Definition qgis.h:5529
RenderSubcomponentProperty
Rendering subcomponent properties.
Definition qgis.h:3053
ProcessingTinInputLayerType
Defines the type of input layer for a Processing TIN input.
Definition qgis.h:3878
QFlags< DataProviderFlag > DataProviderFlags
Data provider flags.
Definition qgis.h:2315
Statistic
Available generic statistics.
Definition qgis.h:5848
SymbolRenderHint
Flags controlling behavior of symbols during rendering.
Definition qgis.h:769
AngleUnit
Units of angles.
Definition qgis.h:5138
CaptureTechnique
Capture technique.
Definition qgis.h:397
static QString geosVersion()
GEOS string version linked.
Definition qgis.cpp:699
SpatialIndexPresence
Enumeration of spatial index presence states.
Definition qgis.h:558
BrowserItemCapability
Browser item capabilities.
Definition qgis.h:951
AttributeFormSuppression
Available form types for layout of the attribute form editor.
Definition qgis.h:5500
QFlags< AuthConfigurationStorageCapability > AuthConfigurationStorageCapabilities
Authentication configuration storage capabilities.
Definition qgis.h:147
QFlags< LayerTreeFilterFlag > LayerTreeFilterFlags
Layer tree filter flags.
Definition qgis.h:4545
LayerTreeInsertionMethod
Layer tree insertion methods.
Definition qgis.h:4522
RasterProviderCapability
Raster data provider capabilities.
Definition qgis.h:4886
DatabaseProviderTableImportCapability
Represents capabilities of a database provider connection when importing table data.
Definition qgis.h:5407
LineClipMode
Line clipping modes.
Definition qgis.h:3263
static const double DEFAULT_SNAP_TOLERANCE
Default snapping distance tolerance.
Definition qgis.h:6227
VectorRenderingSimplificationFlag
Simplification flags for vector feature rendering.
Definition qgis.h:3029
QFlags< GeometryValidityFlag > GeometryValidityFlags
Geometry validity flags.
Definition qgis.h:2075
BrowserDirectoryMonitoring
Browser directory item monitoring switches.
Definition qgis.h:1025
VsiHandlerType
GDAL VSI handler types.
Definition qgis.h:5744
NetworkRequestFlag
Flags controlling behavior of network requests.
Definition qgis.h:171
SettingsTreeNodeType
Type of tree node.
Definition qgis.h:654
TilePixelRatio
DpiMode enum.
Definition qgis.h:3372
DatabaseProviderConnectionCapability2
The Capability enum represents the extended operations supported by the connection.
Definition qgis.h:5390
QFlags< PaintEffectFlag > PaintEffectFlags
Flags which control how paint effects behave.
Definition qgis.h:2815
LabelOffsetType
Behavior modifier for label offset and distance, only applies in some label placement modes.
Definition qgis.h:1241
QFlags< ProfileGeneratorFlag > ProfileGeneratorFlags
Definition qgis.h:4224
QFlags< MapLayerLegendFlag > MapLayerLegendFlags
Map layer legend flags.
Definition qgis.h:4564
LabelPrioritization
Label prioritization.
Definition qgis.h:1180
GradientColorSource
Gradient color sources.
Definition qgis.h:3178
FileFilterType
Type of file filters.
Definition qgis.h:1354
LabelPlacement
Placement modes which determine how label candidates are generated for a feature.
Definition qgis.h:1194
RasterLayerType
Raster layer types.
Definition qgis.h:4763
static const double DEFAULT_M_COORDINATE
Default M coordinate value.
Definition qgis.h:6216
QFlags< VectorLayerTypeFlag > VectorLayerTypeFlags
Vector layer type flags.
Definition qgis.h:416
ScaleBarAlignment
Scalebar alignment.
Definition qgis.h:5302
RasterPyramidFormat
Raster pyramid formats.
Definition qgis.h:4802
ProcessingMode
Types of modes which Processing widgets can be created for.
Definition qgis.h:3671
VectorExportResult
Vector layer export result codes.
Definition qgis.h:1052
DistanceUnit
Units of distance.
Definition qgis.h:5013
RasterTemporalCapabilityFlag
Flags for raster layer temporal capabilities.
Definition qgis.h:2652
SymbolLayerFlag
Flags controlling behavior of symbol layers.
Definition qgis.h:880
MeshRangeLimit
Describes the limits used to compute mesh ranges (min/max values).
Definition qgis.h:6048
GradientSpread
Gradient spread options, which control how gradients are rendered outside of their start and end poin...
Definition qgis.h:3222
QFlags< AnnotationItemGuiFlag > AnnotationItemGuiFlags
Annotation item GUI flags.
Definition qgis.h:2497
LabelPolygonPlacementFlag
Polygon placement flags, which control how candidates are generated for a polygon feature.
Definition qgis.h:1300
RasterRangeLimit
Describes the limits used to compute raster ranges (min/max values).
Definition qgis.h:1544
ScaleMethod
Scale methods.
Definition qgis.h:624
QFlags< RasterProcessingParameterCapability > RasterProcessingParameterCapabilities
Raster layer processing parameter capabilities.
Definition qgis.h:6133
SldExportOption
SLD export options.
Definition qgis.h:696
VectorSimplificationAlgorithm
Simplification algorithms for vector features.
Definition qgis.h:3013
FilePathType
File path types.
Definition qgis.h:1676
CadConstraintType
Advanced digitizing constraint type.
Definition qgis.h:4074
AttributeFormPythonInitCodeSource
The Python init code source for attribute forms.
Definition qgis.h:5515
PointCountMethod
Methods which define the number of points randomly filling a polygon.
Definition qgis.h:3237
SldExportVendorExtension
SLD export vendor extensions, allow the use of vendor extensions when exporting to SLD.
Definition qgis.h:711
static const double DEFAULT_HIGHLIGHT_BUFFER_MM
Default highlight buffer in mm.
Definition qgis.h:6189
MapCanvasFlag
Flags controlling behavior of map canvases.
Definition qgis.h:3458
LayerTreeFilterFlag
Layer tree filter flags.
Definition qgis.h:4535
ExtrusionFace
Extrusion face types for the QgsTessellator.
Definition qgis.h:6156
AttributeFormLayout
Available form types for layout of the attribute form editor.
Definition qgis.h:5485
FeatureRequestFlag
Flags for controlling feature requests.
Definition qgis.h:2194
VertexType
Types of vertex.
Definition qgis.h:3066
ShaderInterpolationMethod
Color ramp shader interpolation methods.
Definition qgis.h:1425
JoinStyle3D
Join styles for 3D buffers.
Definition qgis.h:2134
DataProviderFlag
Generic data provider flags.
Definition qgis.h:2308
Q_ENUM(GpsNavigationStatus)
GdalResampleAlgorithm
Resampling algorithm to be used (equivalent to GDAL's enum GDALResampleAlg).
Definition qgis.h:5722
RasterResamplingMethod
Resampling method for raster provider-level resampling.
Definition qgis.h:1484
GeometryValidationEngine
Available engines for validating geometries.
Definition qgis.h:2084
static int geosVersionPatch()
GEOS Patch version number linked.
Definition qgis.cpp:751
TransactionMode
Transaction mode.
Definition qgis.h:3969
Q_ENUM(ScaleToTileZoomLevelMethod)
QFlags< FeatureRendererFlag > FeatureRendererFlags
Flags controlling behavior of vector feature renderers.
Definition qgis.h:838
static const QColor DEFAULT_HIGHLIGHT_COLOR
Default highlight color.
Definition qgis.h:6184
ElevationMapCombineMethod
Methods used to select the elevation when two elevation maps are combined.
Definition qgis.h:4915
static Q_DECL_DEPRECATED const double SCALE_PRECISION
Fudge factor used to compare two scales.
Definition qgis.h:6203
RasterDrawingStyle
Raster drawing styles.
Definition qgis.h:4779
GeosCreationFlag
Flags which control geos geometry creation behavior.
Definition qgis.h:2147
static const int MAXIMUM_LAYER_PREVIEW_TIME_MS
Maximum rendering time for a layer of a preview job.
Definition qgis.h:6252
MeshRangeExtent
Describes the extent used to compute mesh ranges (min/max values).
Definition qgis.h:6060
GpsInformationComponent
GPS information component.
Definition qgis.h:1956
ViewSyncModeFlag
Synchronization of 2D map canvas and 3D view.
Definition qgis.h:3477
ProcessingProviderFlag
Flags indicating how and when an processing provider operates and should be exposed to users.
Definition qgis.h:3558
FileOperationFlag
File operation flags.
Definition qgis.h:2264
QFlags< DataItemProviderCapability > DataItemProviderCapabilities
Capabilities for data item providers.
Definition qgis.h:992
ProjectCapability
Flags which control project capabilities.
Definition qgis.h:4333
QFlags< BabelFormatCapability > BabelFormatCapabilities
Babel GPS format capabilities.
Definition qgis.h:2002
QFlags< SymbolLayerFlag > SymbolLayerFlags
Symbol layer flags.
Definition qgis.h:887
QFlags< RasterInterfaceCapability > RasterInterfaceCapabilities
Raster interface capabilities.
Definition qgis.h:4873
Q_ENUM(VectorProfileType)
AttributeActionType
Attribute action types.
Definition qgis.h:4675
TemporalNavigationMode
Temporal navigation modes.
Definition qgis.h:2534
ProcessingFieldParameterDataType
Processing field parameter data types.
Definition qgis.h:3816
AreaUnit
Units of area.
Definition qgis.h:5090
StringStatistic
Available string statistics.
Definition qgis.h:5910
FieldDomainMergePolicy
Merge policy for field domains.
Definition qgis.h:3923
ZonalStatistic
Statistics to be calculated during a zonal statistics operation.
Definition qgis.h:5763
MessageLevel
Level for messages This will be used both for message log and message bar in application.
Definition qgis.h:156
@ NoLevel
No level.
Definition qgis.h:161
@ Warning
Warning message.
Definition qgis.h:158
@ Critical
Critical/error message.
Definition qgis.h:159
@ Info
Information message.
Definition qgis.h:157
@ Success
Used for reporting a successful operation.
Definition qgis.h:160
SqlKeywordCategory
SqlKeywordCategory enum represents the categories of the SQL keywords used by the SQL query editor.
Definition qgis.h:1108
QFlags< SnappingType > SnappingTypes
Snapping types.
Definition qgis.h:760
static Q_DECL_DEPRECATED QString geoWkt()
WKT string that represents a geographic coord system.
Definition qgis.h:6342
static bool hasQtWebkit()
Returns true if the QGIS build contains QtWebkit.
Definition qgis.cpp:722
GraduatedMethod
Methods for modifying symbols by range in a graduated symbol renderer.
Definition qgis.h:3306
QFlags< LabelLinePlacementFlag > LabelLinePlacementFlags
Line placement flags, which control how candidates are generated for a linear feature.
Definition qgis.h:1290
TiledSceneBoundingVolumeType
Tiled scene bounding volume types.
Definition qgis.h:5640
TextLayoutMode
Text layout modes.
Definition qgis.h:2901
PropertyType
Property types.
Definition qgis.h:682
QFlags< RenderContextFlag > RenderContextFlags
Render context flags.
Definition qgis.h:2774
LayerFilter
Filter for layers.
Definition qgis.h:209
Q_ENUM(ProviderStyleStorageCapability)
QFlags< SublayerFlag > SublayerFlags
Sublayer flags.
Definition qgis.h:1413
RasterRendererFlag
Flags which control behavior of raster renderers.
Definition qgis.h:1502
QFlags< ExtrusionFace > ExtrusionFaces
Tessellator extrusion face types.
Definition qgis.h:6168
static QString devVersion()
The development version.
Definition qgis.cpp:694
CrsType
Coordinate reference system types.
Definition qgis.h:2327
QFlags< GeosCreationFlag > GeosCreationFlags
Geos geometry creation behavior flags.
Definition qgis.h:2158
SensorThingsEntity
OGC SensorThings API entity types.
Definition qgis.h:5966
MeshEditingErrorType
Type of error that can occur during mesh frame editing.
Definition qgis.h:1659
FieldDomainSplitPolicy
Split policy for field domains.
Definition qgis.h:3906
ArcGisRestServiceType
Available ArcGIS REST service types.
Definition qgis.h:4371
UriCleaningFlag
Flags for cleaning layer URIs.
Definition qgis.h:1371
RasterFileWriterResult
Raster file export results.
Definition qgis.h:1642
AnnotationItemEditOperationResult
Results from an edit operation on an annotation item.
Definition qgis.h:2519
ProcessingPropertyAvailability
Property availability, used for QgsProcessingAlgorithm::VectorProperties in order to determine if pro...
Definition qgis.h:3642
MapRecenteringMode
Modes for recentering map canvases.
Definition qgis.h:3490
RasterRangeAccuracy
Describes the accuracy used to compute raster ranges (min/max values).
Definition qgis.h:1575
ActionType
Action types.
Definition qgis.h:4610
ActionStart
Enum to determine when an operation would begin.
Definition qgis.h:1143
PlaybackOperation
Media playback operations.
Definition qgis.h:2563
QFlags< SymbolLayerUserFlag > SymbolLayerUserFlags
Symbol layer user flags.
Definition qgis.h:910
QFlags< TextRendererFlag > TextRendererFlags
Definition qgis.h:3411
QueryStorageBackend
Stored query storage backends.
Definition qgis.h:3517
ProviderStyleStorageCapability
The StorageCapability enum represents the style storage operations supported by the provider.
Definition qgis.h:5421
AvoidIntersectionsMode
Flags which control how intersections of pre-existing feature are handled when digitizing new feature...
Definition qgis.h:4273
MarkerShape
Marker shapes.
Definition qgis.h:3080
StacObjectType
Available types of stac objects.
Definition qgis.h:6110
LegendJsonRenderFlag
Legend JSON export flags.
Definition qgis.h:4595
BlendMode
Blending modes defining the available composition modes that can be used when painting.
Definition qgis.h:4930
RasterElevationMode
Raster layer elevation modes.
Definition qgis.h:4021
Capitalization
String capitalization options.
Definition qgis.h:3389
TemporalIntervalMatchMethod
Method to use when resolving a temporal range to a data provider layer or band.
Definition qgis.h:2637
PictureFormat
Picture formats.
Definition qgis.h:5272
QFlags< LabelPolygonPlacementFlag > LabelPolygonPlacementFlags
Polygon placement flags, which control how candidates are generated for a polygon feature.
Definition qgis.h:1312
static QString releaseName()
Release name.
Definition qgis.cpp:689
LabelQuadrantPosition
Label quadrant positions.
Definition qgis.h:1255
QFlags< PlotToolFlag > PlotToolFlags
Definition qgis.h:4112
ScaleToTileZoomLevelMethod
Available methods for converting map scales to tile zoom levels.
Definition qgis.h:3420
SublayerQueryFlag
Flags which control how data providers will scan for sublayers in a dataset.
Definition qgis.h:1391
QFlags< VectorFileWriterCapability > VectorFileWriterCapabilities
Capabilities supported by a QgsVectorFileWriter object.
Definition qgis.h:1083
TextOrientation
Text orientations.
Definition qgis.h:2886
TemporalUnit
Temporal units.
Definition qgis.h:5159
QFlags< RasterRendererCapability > RasterRendererCapabilities
Raster renderer capabilities.
Definition qgis.h:1533
QFlags< SymbolPreviewFlag > SymbolPreviewFlags
Symbol preview flags.
Definition qgis.h:867
UnplacedLabelVisibility
Unplaced label visibility.
Definition qgis.h:1155
CrsDefinitionFormat
CRS definition formats.
Definition qgis.h:3891
SpatialFilterType
Feature request spatial filter types.
Definition qgis.h:2251
VerticalAnchorPoint
Marker symbol vertical anchor points.
Definition qgis.h:814
QFlags< LayoutRenderFlag > LayoutRenderFlags
Flags for controlling how a layout is rendered.
Definition qgis.h:5261
static QString defaultProjectScales()
A string with default project scales.
Definition qgis.cpp:671
QFlags< ProcessingParameterTypeFlag > ProcessingParameterTypeFlags
Flags which dictate the behavior of Processing parameter types.
Definition qgis.h:3751
TileAvailability
Possible availability states for a tile within a tile matrix.
Definition qgis.h:5607
ProjectFlag
Flags which control the behavior of QgsProjects.
Definition qgis.h:4092
FeatureRendererFlag
Flags controlling behavior of vector feature renderers.
Definition qgis.h:828
static Q_DECL_DEPRECATED QString geoProj4()
PROJ4 string that represents a geographic coord system.
Definition qgis.h:6353
BrowserItemType
Browser item types.
Definition qgis.h:919
QFlags< FeatureRequestFlag > FeatureRequestFlags
Flags for controlling feature requests.
Definition qgis.h:2211
SettingsType
Types of settings entries.
Definition qgis.h:635
QFlags< SettingsOption > SettingsOptions
Definition qgis.h:729
RasterTemporalMode
Raster layer temporal modes.
Definition qgis.h:2621
RasterAttributeTableType
The RasterAttributeTableType enum represents the type of RAT.
Definition qgis.h:1616
LabelingFlag
Various flags that affect drawing and placement of labels.
Definition qgis.h:2841
GeometryType
The geometry types are used to group Qgis::WkbType in a coarse way.
Definition qgis.h:358
RelationshipType
Relationship types.
Definition qgis.h:4391
ScriptLanguageCapability
Script language capabilities.
Definition qgis.h:4501
RasterInterfaceCapability
Raster interface capabilities.
Definition qgis.h:4853
JoinStyle
Join styles for buffers.
Definition qgis.h:2121
PointCloudDrawOrder
Pointcloud rendering order for 2d views.
Definition qgis.h:4258
QFlags< RasterBandStatistic > RasterBandStatistics
Statistics to be calculated for raster bands.
Definition qgis.h:5957
ProcessingAlgorithmDocumentationFlag
Flags describing algorithm behavior for documentation purposes.
Definition qgis.h:3618
TextCharacterVerticalAlignment
Text vertical alignment for characters.
Definition qgis.h:2977
FieldDuplicatePolicy
Duplicate policy for fields.
Definition qgis.h:3943
UserProfileSelectionPolicy
User profile selection policy.
Definition qgis.h:5436
static const float DEFAULT_MAPTOPIXEL_THRESHOLD
Default threshold between map coordinates and device coordinates for map2pixel simplification.
Definition qgis.h:6177
QFlags< FileOperationFlag > FileOperationFlags
File operation flags.
Definition qgis.h:2269
DpiMode
DpiMode enum.
Definition qgis.h:3358
Q_ENUM(ProfileExportType)
BrowserLayerType
Browser item layer types.
Definition qgis.h:1001
QFlags< ProcessingAlgorithmFlag > ProcessingAlgorithmFlags
Flags indicating how and when an algorithm operates and should be exposed to users.
Definition qgis.h:3609
AltitudeBinding
Altitude binding.
Definition qgis.h:3995
QFlags< DataProviderReadFlag > DataProviderReadFlags
Flags which control data provider construction.
Definition qgis.h:486
Q_ENUM(ProcessingProviderFlag)
TiledSceneRendererFlag
Flags which control how tiled scene 2D renderers behave.
Definition qgis.h:5700
MapLayerActionTarget
Map layer action targets.
Definition qgis.h:4625
ShaderClassificationMethod
Color ramp shader classification methods.
Definition qgis.h:1440
MapLayerLegendFlag
Map layer legend flags.
Definition qgis.h:4554
ZonalStatisticResult
Zonal statistics result codes.
Definition qgis.h:5798
ScriptLanguage
Scripting languages.
Definition qgis.h:4478
QFlags< BrowserItemCapability > BrowserItemCapabilities
Browser item capabilities.
Definition qgis.h:965
QFlags< NetworkRequestFlag > NetworkRequestFlags
Flags controlling behavior of network requests.
Definition qgis.h:181
FeatureAvailability
Possible return value for QgsFeatureSource::hasFeatures() to determine if a source is empty.
Definition qgis.h:577
PlotAxisType
Plots axis types.
Definition qgis.h:3334
TiledSceneProviderCapability
Tiled scene data provider capabilities.
Definition qgis.h:5621
LabelMultiLineAlignment
Text alignment for multi-line labels.
Definition qgis.h:1338
RasterBandStatistic
Available raster band statistics.
Definition qgis.h:5939
QFlags< VectorTileProviderCapability > VectorTileProviderCapabilities
Vector tile data provider capabilities.
Definition qgis.h:5598
AuthConfigurationStorageCapability
Authentication configuration storage capabilities.
Definition qgis.h:102
QFlags< ZonalStatistic > ZonalStatistics
Statistics to be calculated during a zonal statistics operation.
Definition qgis.h:5789
VectorDataProviderTemporalMode
Vector data provider temporal handling modes.
Definition qgis.h:2608
TextRenderFormat
Options for rendering text.
Definition qgis.h:2826
DocumentationBrowser
Documentation API browser.
Definition qgis.h:6012
DataType
Raster data types.
Definition qgis.h:372
Q_ENUM(ProfileSurfaceSymbology)
QFlags< ViewSyncModeFlag > ViewSyncModeFlags
Definition qgis.h:3482
QFlags< SublayerQueryFlag > SublayerQueryFlags
Sublayer query flags.
Definition qgis.h:1399
SystemOfMeasurement
Systems of unit measurement.
Definition qgis.h:4966
RasterAttributeTableFieldUsage
The RasterAttributeTableFieldUsage enum represents the usage of a Raster Attribute Table field.
Definition qgis.h:1587
VerticalAxisInversion
Vertical axis inversion options for 3D views.
Definition qgis.h:4180
QFlags< CoordinateTransformationFlag > CoordinateTransformationFlags
Coordinate transformation flags.
Definition qgis.h:2694
RelationshipCapability
Relationship capabilities.
Definition qgis.h:4431
RasterBuildPyramidOption
Raster pyramid building options.
Definition qgis.h:4817
QFlags< VectorProviderCapability > VectorProviderCapabilities
Vector data provider capabilities.
Definition qgis.h:536
NavigationMode
The navigation mode used by 3D cameras.
Definition qgis.h:4155
static int geosVersionMajor()
GEOS Major version number linked.
Definition qgis.cpp:741
LinearReferencingPlacement
Defines how/where the labels should be placed in a linear referencing symbol layer.
Definition qgis.h:3149
TileChildrenAvailability
Possible availability states for a tile's children.
Definition qgis.h:5668
PointCloudZoomOutRenderBehavior
Point cloud zoom out options.
Definition qgis.h:6085
LayerType
Types of layers that can be added to a map.
Definition qgis.h:190
QFlags< AnnotationItemFlag > AnnotationItemFlags
Annotation item flags.
Definition qgis.h:2470
FieldOrigin
Field origin.
Definition qgis.h:1704
LinearReferencingLabelSource
Defines what quantity to use for the labels shown in a linear referencing symbol layer.
Definition qgis.h:3163
RasterRangeExtent
Describes the extent used to compute raster ranges (min/max values).
Definition qgis.h:1560
QFlags< Statistic > Statistics
Statistics to be calculated for generic values.
Definition qgis.h:5876
PlotToolFlag
Flags that control the way the QgsPlotTools operate.
Definition qgis.h:4108
RenderUnit
Rendering size units.
Definition qgis.h:5183
static QString geographicCrsAuthId()
Geographic coordinate system auth:id string for a default geographic CRS (EPSG:4326).
Definition qgis.h:6333
CoordinateOrder
Order of coordinates.
Definition qgis.h:2402
SelectionFlag
Flags which control feature selection behavior.
Definition qgis.h:1797
QFlags< SettingsTreeNodeOption > SettingsTreeNodeOptions
Definition qgis.h:671
EndCapStyle
End cap styles for buffers.
Definition qgis.h:2108
ScaleCalculationMethod
Scale calculation logic.
Definition qgis.h:5285
QFlags< TiledSceneRequestFlag > TiledSceneRequestFlags
Flags which control how tiled scene requests behave.
Definition qgis.h:5691
static bool hasSfcgal()
Returns true if the QGIS build contains SFCGAL.
Definition qgis.cpp:704
QFlags< MapLayerActionFlag > MapLayerActionFlags
Map layer action flags.
Definition qgis.h:4664
QFlags< MapLayerProperty > MapLayerProperties
Map layer properties.
Definition qgis.h:2285
QFlags< LoadStyleFlag > LoadStyleFlags
Flags for loading layer styles.
Definition qgis.h:246
BabelCommandFlag
Babel command flags, which control how commands and arguments are generated for executing GPSBabel pr...
Definition qgis.h:2013
QFlags< LabelingFlag > LabelingFlags
Flags that affect drawing and placement of labels.
Definition qgis.h:2861
FieldDomainType
Types of field domain.
Definition qgis.h:3956
MapLayerRendererFlag
Flags which control how map layer renderers behave.
Definition qgis.h:2784
RenderContextFlag
Flags which affect rendering operations.
Definition qgis.h:2748
RasterPipeInterfaceRole
Raster pipe interface roles.
Definition qgis.h:1453
CoverageValidityResult
Coverage validity results.
Definition qgis.h:2167
DataProviderReadFlag
Flags which control data provider construction.
Definition qgis.h:467
ScaleBarSegmentSizeMode
Modes for setting size for scale bar segments.
Definition qgis.h:5317
Aggregate
Available aggregates to calculate.
Definition qgis.h:5816
static int sfcgalVersionInt()
Returns the version of the SFCGAL library if QGIS is built with SFCGAL.
Definition qgis.cpp:713
SymbolPreviewFlag
Flags for controlling how symbol preview images are generated.
Definition qgis.h:862
static const double DEFAULT_SEARCH_RADIUS_MM
Identify search radius in mm.
Definition qgis.h:6174
AnnotationItemGuiFlag
Flags for controlling how an annotation item behaves in the GUI.
Definition qgis.h:2493
MapBoxGlStyleSourceType
Available MapBox GL style source types.
Definition qgis.h:4352
LayoutUnitType
Types of layout units.
Definition qgis.h:5223
VectorDataProviderAttributeEditCapability
Attribute editing capabilities which may be supported by vector data providers.
Definition qgis.h:590
DashPatternLineEndingRule
Dash pattern line ending rules.
Definition qgis.h:3276
FieldMetadataProperty
Standard field metadata values.
Definition qgis.h:1745
TiledSceneRequestFlag
Flags which control how tiled scene requests behave.
Definition qgis.h:5681
RasterRendererCapability
Raster renderer capabilities.
Definition qgis.h:1523
VertexMarkerType
Editing vertex markers, used for showing vertices during a edit operation.
Definition qgis.h:1833
HistoryProviderBackend
History provider backends.
Definition qgis.h:3503
static const double DEFAULT_SEGMENT_EPSILON
Default snapping tolerance for segments.
Definition qgis.h:6246
RasterExportType
Raster file export types.
Definition qgis.h:1629
SublayerPromptMode
Specifies how to handle layer sources with multiple sublayers.
Definition qgis.h:1688
TextVerticalAlignment
Text vertical alignment.
Definition qgis.h:2961
RelationshipCardinality
Relationship cardinality.
Definition qgis.h:4417
GradientType
Gradient types.
Definition qgis.h:3192
QFlags< ScriptLanguageCapability > ScriptLanguageCapabilities
Script language capabilities.
Definition qgis.h:4513
VectorProfileType
Types of elevation profiles to generate for vector sources.
Definition qgis.h:4206
GpsFeatureType
GPS feature types.
Definition qgis.h:2027
VectorLayerTypeFlag
Vector layer type flags.
Definition qgis.h:411
MakeValidMethod
Algorithms to use when repairing invalid geometries.
Definition qgis.h:2180
RangeLimits
Describes how the limits of a range are handled.
Definition qgis.h:4007
QFlags< ProjectFlag > ProjectFlags
Definition qgis.h:4099
VectorTemporalLimitMode
Mode for the handling of the limits of the filtering timeframe for vector features.
Definition qgis.h:2596
QFlags< ProcessingParameterFlag > ProcessingParameterFlags
Flags which dictate the behavior of Processing parameters.
Definition qgis.h:3777
SqlLayerDefinitionCapability
SqlLayerDefinitionCapability enum lists the arguments supported by the provider when creating SQL que...
Definition qgis.h:1091
static int versionInt()
Version number used for comparing versions using the "Check QGIS Version" function.
Definition qgis.cpp:682
VectorEditResult
Specifies the result of a vector layer edit operation.
Definition qgis.h:1818
QFlags< VectorDataProviderAttributeEditCapability > VectorDataProviderAttributeEditCapabilities
Attribute editing capabilities which may be supported by vector data providers.
Definition qgis.h:602
Axis
Cartesian axes.
Definition qgis.h:2451
QFlags< ProcessingAlgorithmDocumentationFlag > ProcessingAlgorithmDocumentationFlags
Flags describing algorithm behavior for documentation purposes.
Definition qgis.h:3630
QFlags< RelationshipCapability > RelationshipCapabilities
Relationship capabilities.
Definition qgis.h:4443
QFlags< SymbolRenderHint > SymbolRenderHints
Symbol render hints.
Definition qgis.h:777
VolumeUnit
Units of volume.
Definition qgis.h:5115
CurvedTextFlag
Flags controlling behavior of curved text generation.
Definition qgis.h:2990
AttributeEditorType
Attribute editor types.
Definition qgis.h:5451
QFlags< LegendJsonRenderFlag > LegendJsonRenderFlags
Definition qgis.h:4599
QFlags< ProviderStyleStorageCapability > ProviderStyleStorageCapabilities
Definition qgis.h:5427
EmbeddedScriptMode
Authorisation to run script embedded in projects.
Definition qgis.h:424
SymbolLayerUserFlag
User-specified flags controlling behavior of symbol layers.
Definition qgis.h:900
InvalidGeometryCheck
Methods for handling of features with invalid geometries.
Definition qgis.h:2238
QFlags< SymbolFlag > SymbolFlags
Symbol flags.
Definition qgis.h:853
QFlags< ProcessingFeatureSourceDefinitionFlag > ProcessingFeatureSourceDefinitionFlags
Flags which control behavior for a Processing feature source.
Definition qgis.h:3699
PointCloudAccessType
The access type of the data, local is for local files and remote for remote files (over HTTP).
Definition qgis.h:6074
ProfileExportType
Types of export for elevation profiles.
Definition qgis.h:4233
MeshElevationMode
Mesh layer elevation modes.
Definition qgis.h:4035
ProjectFileFormat
Flags which control project read behavior.
Definition qgis.h:4288
SnappingMode
SnappingMode defines on which layer the snapping is performed.
Definition qgis.h:737
SymbolType
Symbol types.
Definition qgis.h:610
RasterColorInterpretation
Raster color interpretation.
Definition qgis.h:4712
static const int USER_CRS_START_ID
Minimum ID number for a user-defined projection.
Definition qgis.h:6237
ProfileSurfaceSymbology
Surface symbology type for elevation profile plots.
Definition qgis.h:4193
LabelPlacementEngineVersion
Labeling placement engine version.
Definition qgis.h:2872
Q_ENUM(ProcessingAlgorithmFlag)
static int geosVersionMinor()
GEOS Minor version number linked.
Definition qgis.cpp:746
ColorModel
Color model types.
Definition qgis.h:5986
RendererUsage
Usage of the renderer.
Definition qgis.h:3445
SettingsTreeNodeOption
Options for named list nodes.
Definition qgis.h:666
BabelFormatCapability
Babel GPS format capabilities.
Definition qgis.h:1994
PostgresRelKind
Postgres database relkind options.
Definition qgis.h:5369
SegmentCalculationMethod
brief Method used to calculate the number of segments for circle approximation
Definition qgis.h:6097
GpsConnectionType
GPS connection types.
Definition qgis.h:1860
Q_ENUM(InputControllerType)
QFlags< DatabaseProviderConnectionCapability2 > DatabaseProviderConnectionCapabilities2
Definition qgis.h:5398
MouseHandlesAction
Action to be performed by the mouse handles.
Definition qgis.h:6024
ProcessingFeatureSourceDefinitionFlag
Flags which control behavior for a Processing feature source.
Definition qgis.h:3686
QFlags< TextComponent > TextComponents
Text components.
Definition qgis.h:2931
static QString geoNone()
Constant that holds the string representation for "No ellipse/No CRS".
Definition qgis.h:6323
DevToolsNodeRole
Dev tools node custom data roles.
Definition qgis.h:6141
LoadStyleFlag
Flags for loading layer styles.
Definition qgis.h:236
BetweenLineConstraint
Between line constraints which can be enabled.
Definition qgis.h:4048
QFlags< VectorTileProviderFlag > VectorTileProviderFlags
Vector tile data provider flags.
Definition qgis.h:5580
MetadataDateType
Date types for metadata.
Definition qgis.h:4693
QFlags< RasterTemporalCapabilityFlag > RasterTemporalCapabilityFlags
Flags for raster layer temporal capabilities.
Definition qgis.h:2662
ProcessingFeatureSourceFlag
Flags which control how QgsProcessingFeatureSource fetches features.
Definition qgis.h:3710
RasterIdentifyFormat
Raster identify formats.
Definition qgis.h:4832
TextHorizontalAlignment
Text horizontal alignment.
Definition qgis.h:2942
SymbolFlag
Flags controlling behavior of symbols.
Definition qgis.h:847
LineExtensionSide
Designates whether the line extension constraint is currently soft locked with the previous or next v...
Definition qgis.h:4061
HttpMethod
Different methods of HTTP requests.
Definition qgis.h:1037
WkbType
The WKB type describes the number of dimensions a geometry has.
Definition qgis.h:277
QFlags< SldExportOption > SldExportOptions
Definition qgis.h:702
SymbolCoordinateReference
Symbol coordinate reference modes.
Definition qgis.h:3207
QFlags< ProcessingProviderFlag > ProcessingProviderFlags
Flags indicating how and when an processing provider operates and should be exposed to users.
Definition qgis.h:3571
TileRefinementProcess
Tiled scene tile refinement processes.
Definition qgis.h:5656
QFlags< DateTimeStatistic > DateTimeStatistics
Statistics to be calculated for date/time values.
Definition qgis.h:5901
SelectionRenderingMode
Specifies how a selection should be rendered.
Definition qgis.h:1758
InputControllerType
Input controller types.
Definition qgis.h:5357
TextRendererFlag
Flags which control the behavior of rendering text.
Definition qgis.h:3407
SelectGeometryRelationship
Geometry relationship test to apply for selecting features.
Definition qgis.h:1785
CrsAxisDirection
Coordinate reference system axis directions.
Definition qgis.h:2352
ProcessingModelChildParameterSource
Processing model child parameter sources.
Definition qgis.h:3847
static int geosVersionInt()
GEOS version number linked.
Definition qgis.cpp:731
QFlags< MarkerLinePlacement > MarkerLinePlacements
Definition qgis.h:3140
QFlags< MapCanvasFlag > MapCanvasFlags
Flags controlling behavior of map canvases.
Definition qgis.h:3468
CrsWktVariant
Coordinate reference system WKT formatting variants.
Definition qgis.h:2432
QFlags< TiledSceneRendererFlag > TiledSceneRendererFlags
Flags which control how tiled scene 2D renderers behave.
Definition qgis.h:5713
DocumentationApi
Documentation API.
Definition qgis.h:5998
AutoRefreshMode
Map layer automatic refresh modes.
Definition qgis.h:2295
AnnotationPlacementMode
Annotation item placement modes.
Definition qgis.h:2480
ProcessingAlgorithmFlag
Flags indicating how and when an algorithm operates and should be exposed to users.
Definition qgis.h:3582
SceneMode
The 3D scene mode used in 3D map views.
Definition qgis.h:4168
FieldConfigurationFlag
Configuration flags for fields These flags are meant to be user-configurable and are not describing a...
Definition qgis.h:1721
SettingsOrigin
The setting origin describes where a setting is stored.
Definition qgis.h:4465
HorizontalAnchorPoint
Marker symbol horizontal anchor points.
Definition qgis.h:800
QFlags< CurvedTextFlag > CurvedTextFlags
Flags controlling behavior of curved text generation.
Definition qgis.h:3003
ProcessingParameterFlag
Flags which dictate the behavior of Processing parameters.
Definition qgis.h:3762
LabelOverlapHandling
Label overlap handling.
Definition qgis.h:1167
static const double UI_SCALE_FACTOR
UI scaling factor.
Definition qgis.h:6222
FeatureSymbologyExport
Options for exporting features considering their symbology.
Definition qgis.h:5557
QFlags< LayerFilter > LayerFilters
Definition qgis.h:227
ProcessingDateTimeParameterDataType
Processing date time parameter data types.
Definition qgis.h:3834
CoordinateTransformationFlag
Flags which adjust the coordinate transformations behave.
Definition qgis.h:2683
TextComponent
Text components.
Definition qgis.h:2918
DateTimeStatistic
Available date/time statistics.
Definition qgis.h:5885
AnimationState
Animation states.
Definition qgis.h:2550
TransformDirection
Indicates the direction (forward or inverse) of a transform.
Definition qgis.h:2671
LightSourceType
Light source types for 3D scenes.
Definition qgis.h:4143
QFlags< ProcessingFeatureSourceFlag > ProcessingFeatureSourceFlags
Flags which control how QgsProcessingFeatureSource fetches features.
Definition qgis.h:3722
QFlags< HistoryProviderBackend > HistoryProviderBackends
Definition qgis.h:3508
LabelPredefinedPointPosition
Positions for labels when using the Qgis::LabelPlacement::OrderedPositionsAroundPoint placement mode.
Definition qgis.h:1215
QFlags< FieldConfigurationFlag > FieldConfigurationFlags
Configuration flags for fields These flags are meant to be user-configurable and are not describing a...
Definition qgis.h:1736
UpsideDownLabelHandling
Handling techniques for upside down labels.
Definition qgis.h:1323
static const double DEFAULT_POINT_SIZE
The default size (in millimeters) for point marker symbols.
Definition qgis.h:6240
DeviceConnectionStatus
GPS connection status.
Definition qgis.h:1874
ProcessingNumberParameterType
Processing numeric parameter data types.
Definition qgis.h:3802
MapSettingsFlag
Flags which adjust the way maps are rendered.
Definition qgis.h:2716
QFlags< SqlLayerDefinitionCapability > SqlLayerDefinitionCapabilities
SQL layer definition capabilities.
Definition qgis.h:1099
ProcessingLogLevel
Logging level for algorithms to use when pushing feedback messages.
Definition qgis.h:3656
SelectBehavior
Specifies how a selection should be applied.
Definition qgis.h:1771
LayoutRenderFlag
Flags for controlling how a layout is rendered.
Definition qgis.h:5237
Utility class that encapsulates an action based on vector attributes.
Definition qgsaction.h:37
Utility class for calculating aggregates for a field (or expression) over the features from a vector ...
Utility functions for working with ArcGIS REST services.
An abstract base class for any elements of a drag and drop form.
A ramp shader will color a raster pixel based on a list of values ranges in a ramp.
Represents a coordinate reference system (CRS).
Handles coordinate transforms between two coordinate systems.
Abstract base class for curved geometry type.
Definition qgscurve.h:36
Base class for all items in the model.
Definition qgsdataitem.h:47
Abstract base class for spatial data provider implementations.
Calculator for summary statistics and aggregates for a list of datetimes.
Contains configuration settings for an editor form.
Wraps a request for features to a vector layer (or directly its vector data provider).
An interface for objects which provide features via a getFeatures method.
Container of fields for a vector layer.
Definition qgsfields.h:46
A geometry is the spatial representation of a feature.
Encapsulates information relating to a GPS position fix.
A fill symbol layer which draws a smooth color gradient over a polygon.
A vector feature renderer which uses numeric attributes to classify features into different ranges.
Stores global configuration for labeling engine.
Contains constants and enums relating to labeling.
Definition qgslabeling.h:33
A browser item that represents a layer that can be opened with one of the providers.
A layout item subclass that displays SVG files or raster format images (jpg, png, ....
Stores information relating to the current rendering settings for a layout.
Contains detailed styling information relating to how a layout legend should be rendered.
A proxy model which provides an easy to use model to display the list of layers in widgets.
Base class for all map layer types.
Definition qgsmaplayer.h:80
Contains configuration for rendering maps.
Abstract base class for marker symbol layers.
Registry for temporary fetched files.
Contains miscellaneous painting utility functions.
Definition qgspainting.h:32
Contains settings for how a map layer will be labeled.
Abstract base class for 2d point cloud renderers.
Abstract base class for processing algorithms.
Contains information about the context in which a processing algorithm is executed.
Encapsulates settings relating to a feature source input to a processing algorithm.
QgsFeatureSource subclass which proxies methods to an underlying QgsFeatureSource,...
A datetime (or pure date or time) parameter for processing algorithms.
Base class for the definition of processing parameters.
A vector layer or feature source field parameter for processing algorithms.
An input file or folder parameter for processing algorithms.
A numeric parameter for processing algorithms.
A parameter for processing algorithms that need a list of input vector layers to construct a TIN.
Makes metadata of processing parameters available.
Abstract base class for processing providers.
Contains enumerations and other constants for use in processing algorithms and parameters.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition qgsproject.h:109
A store for object properties.
Holds data provider key, description, and associated shared library file or function pointer informat...
A fill symbol layer which places markers at random locations within polygons.
The RasterBandStats struct is a container for statistics about a single raster band.
Implementation of data provider temporal properties for QgsRasterDataProviders.
Base class for raster data providers.
The raster file writer which allows you to save a raster to a new file.
Base class for processing filters like renderers, reprojector, resampler etc.
Implementation of map layer temporal properties for raster layers.
Represents a raster layer.
Describes the origin of minimum and maximum values in a raster.
Contains a pipeline of raster interfaces for sequential raster processing.
Raster namespace.
Definition qgsraster.h:32
Represents a relationship between two vector layers.
Definition qgsrelation.h:42
Contains information about the context of a rendering operation.
Stores the appearance and layout settings for scalebar drawing with QgsScaleBarRenderer.
Represents a settings entry and provides methods for reading and writing settings values.
RAII signal blocking class.
Definition qgis.h:6471
Object * operator->()
Returns pointer to blocked QObject.
Definition qgis.h:6489
QgsSignalBlocker(Object *object)
Constructor for QgsSignalBlocker.
Definition qgis.h:6478
Abstract base class for simple marker symbol layers.
Stores configuration of snapping settings for the project.
Calculator for summary statistics for a list of doubles.
Calculator for summary statistics and aggregates for a list of strings.
Utility functions for working with strings.
Contains utility functions for working with symbols and symbol layers.
Abstract base class for all rendered symbols.
Definition qgssymbol.h:231
Base class for templated line symbols, e.g.
Implements a temporal controller based on a frame by frame navigation and animation.
Container for all settings relating to text rendering.
Utility functions for text rendering.
Handles rendering text using rich formatting options, including drop shadows, buffers and background ...
Provides calculations for tolerance values in map units.
Helper functions for various unit types.
Implementation of data provider temporal properties for QgsVectorDataProviders.
Base class for vector data providers.
A convenience class for writing vector layers to disk based formats (e.g.
A convenience class for exporting vector layers to a destination data provider.
Implementation of map layer temporal properties for vector layers.
Represents a vector layer which manages a vector based dataset.
Contains settings for simplifying geometries fetched from a vector layer.
Handles storage of information regarding WKB types and their properties.
Definition qgswkbtypes.h:42
FeatureCountState
Enumeration of feature count states.
Definition qgis.h:545
@ Points
Point based rendering, requires point data.
As part of the API refactoring and improvements which landed in QGIS
Q_DECL_DEPRECATED const long GEOCRS_ID
Numeric ID for the EPSG:4326 geographic coordinate system in QGIS internal srs database.
Definition qgis.h:7123
Q_DECL_DEPRECATED CORE_EXPORT QString qgsVsiPrefix(const QString &path)
Returns a the vsi prefix which corresponds to a file path, or an empty string if the path is not asso...
Definition qgis.cpp:598
CORE_EXPORT uint qHash(const QVariant &variant)
Hash for QVariant.
Definition qgis.cpp:603
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:7023
CORE_EXPORT bool qgsVariantEqual(const QVariant &lhs, const QVariant &rhs)
Compares two QVariant values and returns whether they are equal, two NULL values are always treated a...
Definition qgis.cpp:652
Q_DECL_DEPRECATED const long GEOSRID
Numeric ID for the EPSG:4326 geographic coordinate system.
Definition qgis.h:7116
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:6817
QString qgsDoubleToString(double a, int precision=17)
Returns a string representation of a double.
Definition qgis.h:6524
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:6681
QString qgsEnumValueToKey(const T &value, bool *returnOk=nullptr)
Returns the value for the given key of an enum.
Definition qgis.h:6798
QString qgsFlagValueToKeys(const T &value, bool *returnOk=nullptr)
Returns the value for the given keys of a flag.
Definition qgis.h:6856
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:6664
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:6878
CORE_EXPORT bool qgsVariantGreaterThan(const QVariant &lhs, const QVariant &rhs)
Compares two QVariant values and returns whether the first is greater than the second.
Definition qgis.cpp:593
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:7142
const QMap< T, QString > qgsEnumMap()
Returns a map of all enum entries.
Definition qgis.h:6781
bool qgsFloatNear(float a, float b, float epsilon=4 *FLT_EPSILON)
Compare two floats (but allow some difference).
Definition qgis.h:6618
CORE_EXPORT int qgsVariantCompare(const QVariant &lhs, const QVariant &rhs, bool strictTypeCheck=false)
Compares two QVariant values.
Definition qgis.cpp:131
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:6698
CORE_EXPORT double qgsPermissiveToDouble(QString string, bool &ok)
Converts a string to a double in a permissive way, e.g., allowing for incorrect numbers of digits bet...
Definition qgis.cpp:83
const QList< T > qgsEnumList()
Returns a list all enum entries.
Definition qgis.h:6764
double qgsRound(double number, int places)
Returns a double number, rounded (as close as possible) to the specified number of places.
Definition qgis.h:6648
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference).
Definition qgis.h:6607
bool qgsNanCompatibleEquals(double a, double b)
Compare two doubles, treating nan values as equal.
Definition qgis.h:6569
QgsSignalBlocker< Object > whileBlocking(Object *object)
Temporarily blocks signals from a QObject while calling a single method from the object.
Definition qgis.h:6511
void CORE_EXPORT * qgsMalloc(size_t size)
Allocates size bytes and returns a pointer to the allocated memory.
Definition qgis.cpp:104
QMap< QString, QString > QgsStringMap
Definition qgis.h:7132
Q_DECL_DEPRECATED const long GEO_EPSG_CRS_ID
Numeric ID for the EPSG:4326 geographic coordinate system.
Definition qgis.h:7130
bool qgsDoubleNearSig(double a, double b, int significantDigits=10)
Compare two doubles using specified number of significant digits.
Definition qgis.h:6624
void CORE_EXPORT qgsFree(void *ptr)
Frees the memory space pointed to by ptr.
Definition qgis.cpp:126
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:6589
CORE_EXPORT qlonglong qgsPermissiveToLongLong(QString string, bool &ok)
Converts a string to an qlonglong in a permissive way, e.g., allowing for incorrect numbers of digits...
Definition qgis.cpp:97
CORE_EXPORT int qgsPermissiveToInt(QString string, bool &ok)
Converts a string to an integer in a permissive way, e.g., allowing for incorrect numbers of digits b...
Definition qgis.cpp:90
CORE_EXPORT bool qgsVariantLessThan(const QVariant &lhs, const QVariant &rhs)
Compares two QVariant values and returns whether the first is less than the second.
Definition qgis.cpp:588
#define QHASH_FOR_CLASS_ENUM(T)
Definition qgis.h:45
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:7039
#define SIP_DEPRECATED
Definition qgis_sip.h:114
#define SIP_ENUM_BASETYPE(type)
Definition qgis_sip.h:275
#define SIP_SKIP
Definition qgis_sip.h:134
#define SIP_MONKEYPATCH_SCOPEENUM_UNNEST(OUTSIDE_CLASS, FORMERNAME)
Definition qgis_sip.h:268
#define SIP_MONKEYPATCH_FLAGS_UNNEST(OUTSIDE_CLASS, FORMERNAME)
Definition qgis_sip.h:269
#define SIP_MONKEYPATCH_SCOPEENUM
Definition qgis_sip.h:267
#define SIP_MONKEYPATCH_COMPAT_NAME(FORMERNAME)
Definition qgis_sip.h:270
Q_DECLARE_METATYPE(QgsDatabaseQueryLogEntry)
Q_DECLARE_OPERATORS_FOR_FLAGS(QgsProjectionSelectionWidget::CrsOptions)
Utility class for identifying a unique vertex within a geometry.
Definition qgsvertexid.h:30