Qgis Class Reference

The Qgis class provides global constants for use throughout the application. More...

#include <qgis.h>

Public Types
enum class	ActionStart : int { Deferred , Immediate }
	Enum to determine when an operation would begin. More...
enum class	ActionType : int { Invalid , MapLayerAction , AttributeAction }
	Action types. More...
enum class	Aggregate : int {   Count , CountDistinct , CountMissing , Min ,   Max , Sum , Mean , Median ,   StDev , StDevSample , Range , Minority ,   Majority , FirstQuartile , ThirdQuartile , InterQuartileRange ,   StringMinimumLength , StringMaximumLength , StringConcatenate , GeometryCollect ,   ArrayAggregate , StringConcatenateUnique }
	Available aggregates to calculate. More...
enum class	AltitudeBinding : int { Vertex , Centroid }
	Altitude binding. More...
enum class	AltitudeClamping : int { Absolute , Relative , Terrain }
	Altitude clamping. More...
enum class	AngleUnit : int {   Degrees , Radians , Gon , MinutesOfArc ,   SecondsOfArc , Turn , MilliradiansSI , MilNATO ,   Unknown }
	Units of angles. More...
enum class	AngularDirection : int { Clockwise , CounterClockwise , NoOrientation }
	Angular directions. More...
enum class	AnimationState : int { Forward , Reverse , Idle }
	Animation states. More...
enum class	AnnotationItemEditOperationResult : int { Success , Invalid , ItemCleared }
	Results from an edit operation on an annotation item. More...
enum class	AnnotationItemFlag : int { ScaleDependentBoundingBox = 1 << 0 }
	Flags for annotation items. More...
typedef QFlags< AnnotationItemFlag >	AnnotationItemFlags
	Annotation item flags.
enum class	AnnotationItemGuiFlag : int { FlagNoCreationTools = 1 << 0 }
	Flags for controlling how an annotation item behaves in the GUI. More...
typedef QFlags< AnnotationItemGuiFlag >	AnnotationItemGuiFlags
	Annotation item GUI flags.
enum class	AnnotationItemNodeType : int { VertexHandle }
	Annotation item node types. More...
enum class	ArcGisRestServiceType : int {   FeatureServer , MapServer , ImageServer , GlobeServer ,   GPServer , GeocodeServer , Unknown }
	Available ArcGIS REST service types. More...
enum class	AreaUnit : int {   SquareMeters , SquareKilometers , SquareFeet , SquareYards ,   SquareMiles , Hectares , Acres , SquareNauticalMiles ,   SquareDegrees , SquareCentimeters , SquareMillimeters , SquareInches ,   Unknown }
	Units of area. More...
enum class	AttributeActionType : int {   Generic , GenericPython , Mac , Windows ,   Unix , OpenUrl , SubmitUrlEncoded , SubmitUrlMultipart }
	Attribute action types. More...
enum class	AttributeEditorContainerType : int { GroupBox , Tab , Row }
	Attribute editor container types. More...
enum class	AttributeEditorType : int {   Container , Field , Relation , QmlElement ,   HtmlElement , Action , TextElement , SpacerElement ,   Invalid }
	Attribute editor types. More...
enum class	AttributeFormLayout : int { AutoGenerated = 0 , DragAndDrop = 1 , UiFile = 2 }
	Available form types for layout of the attribute form editor. More...
enum class	AttributeFormPythonInitCodeSource : int { NoSource = 0 , File = 1 , Dialog = 2 , Environment = 3 }
	The Python init code source for attribute forms. More...
enum class	AttributeFormSuppression : int { Default = 0 , On = 1 , Off = 2 }
	Available form types for layout of the attribute form editor. More...
enum class	AutoRefreshMode : int { Disabled = 0 , ReloadData = 1 , RedrawOnly = 2 }
	Map layer automatic refresh modes. More...
enum class	AvoidIntersectionsMode : int { AllowIntersections , AvoidIntersectionsCurrentLayer , AvoidIntersectionsLayers }
	Flags which control how intersections of pre-existing feature are handled when digitizing new features. More...
enum class	Axis : int { X , Y , Z }
	Cartesian axes. More...
enum class	BabelCommandFlag : int { QuoteFilePaths = 1 << 0 }
	Babel command flags, which control how commands and arguments are generated for executing GPSBabel processes. More...
typedef QFlags< BabelCommandFlag >	BabelCommandFlags
	Babel command flags.
typedef QFlags< BabelFormatCapability >	BabelFormatCapabilities
	Babel GPS format capabilities.
enum class	BabelFormatCapability : int {   Import = 1 << 0 , Export = 1 << 1 , Waypoints = 1 << 2 , Routes = 1 << 3 ,   Tracks = 1 << 4 }
	Babel GPS format capabilities. More...
enum class	BetweenLineConstraint : int { NoConstraint , Perpendicular , Parallel }
	Between line constraints which can be enabled. More...
enum class	BlendMode : int {   Normal , Lighten , Screen , Dodge ,   Addition , Darken , Multiply , Burn ,   Overlay , SoftLight , HardLight , Difference ,   Subtract , Source , DestinationOver , Clear ,   Destination , SourceIn , DestinationIn , SourceOut ,   DestinationOut , SourceAtop , DestinationAtop , Xor }
	Blending modes defining the available composition modes that can be used when painting. More...
enum class	BrowserDirectoryMonitoring : int { Default , NeverMonitor , AlwaysMonitor }
	Browser directory item monitoring switches. More...
typedef QFlags< BrowserItemCapability >	BrowserItemCapabilities
	Browser item capabilities.
enum class	BrowserItemCapability : int {   NoCapabilities = 0 , SetCrs = 1 << 0 , Fertile = 1 << 1 , Fast = 1 << 2 ,   Collapse = 1 << 3 , Rename = 1 << 4 , Delete = 1 << 5 , ItemRepresentsFile = 1 << 6 ,   RefreshChildrenWhenItemIsRefreshed = 1 << 7 }
	Browser item capabilities. More...
enum class	BrowserItemState : int { NotPopulated , Populating , Populated }
	Browser item states. More...
enum class	BrowserItemType : int {   Collection , Directory , Layer , Error ,   Favorites , Project , Custom , Fields ,   Field }
	Browser item types. More...
enum class	BrowserLayerType : int {   NoType , Vector , Raster , Point ,   Line , Polygon , TableLayer , Database ,   Table , Plugin , Mesh , VectorTile ,   PointCloud , TiledScene }
	Browser item layer types. More...
enum class	BufferSide : int { Left = 0 , Right }
	Side of line to buffer. More...
enum class	CadConstraintType : int {   Generic , Angle , Distance , XCoordinate ,   YCoordinate , ZValue , MValue }
	Advanced digitizing constraint type. More...
enum class	Capitalization : int {   MixedCase = 0 , AllUppercase = 1 , AllLowercase = 2 , ForceFirstLetterToCapital = 4 ,   SmallCaps = 5 , TitleCase = 1004 , UpperCamelCase = 1005 , AllSmallCaps = 1006 }
	String capitalization options. More...
enum class	CaptureTechnique : int { StraightSegments , CircularString , Streaming , Shape }
	Capture technique. More...
enum class	ContentStatus : int {   NotStarted , Running , Finished , Failed ,   Canceled }
	Status for fetched or stored content. More...
enum class	CoordinateDisplayType : int { MapCrs , MapGeographic , CustomCrs }
	Formats for displaying coordinates. More...
enum class	CoordinateOrder : int { Default , XY , YX }
	Order of coordinates. More...
enum class	CoordinateTransformationFlag : int { BallparkTransformsAreAppropriate = 1 << 0 , IgnoreImpossibleTransformations = 1 << 1 }
	Flags which adjust the coordinate transformations behave. More...
typedef QFlags< CoordinateTransformationFlag >	CoordinateTransformationFlags
	Coordinate transformation flags.
enum class	CoverageValidityResult : int { Invalid = 0 , Valid = 1 , Error = 2 }
	Coverage validity results. More...
enum class	CrsAxisDirection : int {   North , NorthNorthEast , NorthEast , EastNorthEast ,   East , EastSouthEast , SouthEast , SouthSouthEast ,   South , SouthSouthWest , SouthWest , WestSouthWest ,   West , WestNorthWest , NorthWest , NorthNorthWest ,   GeocentricX , GeocentricY , GeocentricZ , Up ,   Down , Forward , Aft , Port ,   Starboard , Clockwise , CounterClockwise , ColumnPositive ,   ColumnNegative , RowPositive , RowNegative , DisplayRight ,   DisplayLeft , DisplayUp , DisplayDown , Future ,   Past , Towards , AwayFrom , Unspecified }
	Coordinate reference system axis directions. More...
enum class	CrsDefinitionFormat : int { Wkt , Proj }
	CRS definition formats. More...
enum class	CrsIdentifierType : int { ShortString , MediumString , FullString }
	Available identifier string types for representing coordinate reference systems. More...
enum class	CrsType : int {   Unknown , Geodetic , Geocentric , Geographic2d ,   Geographic3d , Vertical , Projected , Compound ,   Temporal , Engineering , Bound , Other ,   DerivedProjected }
	Coordinate reference system types. More...
enum class	CrsWktVariant : int {   Wkt1Gdal , Wkt1Esri , Wkt2_2015 , Wkt2_2015Simplified ,   Wkt2_2019 , Wkt2_2019Simplified , Preferred = Wkt2_2019 , PreferredSimplified = Wkt2_2019Simplified ,   PreferredGdal = Wkt2_2019 }
	Coordinate reference system WKT formatting variants. More...
enum class	DashPatternLineEndingRule : int {   NoRule , FullDash , HalfDash , FullGap ,   HalfGap }
	Dash pattern line ending rules. More...
enum class	DashPatternSizeAdjustment : int { ScaleBothDashAndGap , ScaleDashOnly , ScaleGapOnly }
	Dash pattern size adjustment options. More...
typedef QFlags< DatabaseProviderConnectionCapability2 >	DatabaseProviderConnectionCapabilities2
enum class	DatabaseProviderConnectionCapability2 : int { SetFieldComment = 1 << 0 , SetFieldAlias = 1 << 1 }
	The Capability enum represents the extended operations supported by the connection. More...
typedef QFlags< DataItemProviderCapability >	DataItemProviderCapabilities
	Capabilities for data item providers.
enum class	DataItemProviderCapability : int {   NoCapabilities = 0 , Files = 1 , Directories = 1 << 1 , Databases = 1 << 2 ,   NetworkSources = 1 << 3 }
	Capabilities for data item providers. More...
enum class	DataProviderFlag : int { IsBasemapSource = 1 << 1 , FastExtent2D = 1 << 2 , FastExtent3D = 1 << 3 }
	Generic data provider flags. More...
typedef QFlags< DataProviderFlag >	DataProviderFlags
	Data provider flags.
enum class	DataType : int {   UnknownDataType = 0 , Byte = 1 , Int8 = 14 , UInt16 = 2 ,   Int16 = 3 , UInt32 = 4 , Int32 = 5 , Float32 = 6 ,   Float64 = 7 , CInt16 = 8 , CInt32 = 9 , CFloat32 = 10 ,   CFloat64 = 11 , ARGB32 = 12 , ARGB32_Premultiplied = 13 }
	Raster data types. More...
enum class	DateTimeStatistic : int {   Count = 1 , CountDistinct = 2 , CountMissing = 4 , Min = 8 ,   Max = 16 , Range = 32 , All = Count | CountDistinct | CountMissing | Min | Max | Range }
	Available date/time statistics. More...
typedef QFlags< DateTimeStatistic >	DateTimeStatistics
	Statistics to be calculated for date/time values.
enum class	DeviceConnectionStatus : int { Disconnected , Connecting , Connected }
	GPS connection status. More...
enum class	DistanceUnit : int {   Meters , Kilometers , Feet , NauticalMiles ,   Yards , Miles , Degrees , Centimeters ,   Millimeters , Inches , Unknown }
	Units of distance. More...
enum class	DistanceUnitType : int { Standard , Geographic , Unknown }
	Types of distance units. More...
enum class	DpiMode {   All = 7 , Off = 0 , QGIS = 1 , UMN = 2 ,   GeoServer = 4 }
	DpiMode enum. More...
enum class	DriveType : int {   Unknown , Invalid , Removable , Fixed ,   Remote , CdRom , RamDisk , Cloud }
	Drive types. More...
enum class	ElevationMapCombineMethod : int { HighestElevation , NewerElevation }
	Methods used to select the elevation when two elevation maps are combined. More...
enum class	EndCapStyle : int { Round = 1 , Flat , Square }
	End cap styles for buffers. More...
enum class	ExpressionType { Qgis , PointCloud , RasterCalculator }
	Expression types. More...
enum class	FeatureAvailability : int { NoFeaturesAvailable = 0 , FeaturesAvailable , FeaturesMaybeAvailable }
	Possible return value for QgsFeatureSource::hasFeatures() to determine if a source is empty. More...
enum class	FeatureCountState : int { FeatureCountState::Uncounted = -2 , FeatureCountState::UnknownCount = -1 }
	Enumeration of feature count states. More...
enum class	FeatureRequestFilterType : int { NoFilter , Fid , Expression , Fids }
	Types of feature request filters. More...
enum class	FeatureRequestFlag : int {   NoFlags = 0 , NoGeometry = 1 , SubsetOfAttributes = 2 , ExactIntersect = 4 ,   IgnoreStaticNodesDuringExpressionCompilation = 8 , EmbeddedSymbols = 16 }
	Flags for controlling feature requests. More...
typedef QFlags< FeatureRequestFlag >	FeatureRequestFlags
	Flags for controlling feature requests.
enum class	FeatureSymbologyExport : int { NoSymbology = 0 , PerFeature , PerSymbolLayer }
	Options for exporting features considering their symbology. More...
enum class	FieldConfigurationFlag : int { NoFlag = 0 , NotSearchable = 1 << 1 , HideFromWms = 1 << 2 , HideFromWfs = 1 << 3 }
	Configuration flags for fields These flags are meant to be user-configurable and are not describing any information from the data provider. More...
typedef QFlags< FieldConfigurationFlag >	FieldConfigurationFlags
	Configuration flags for fields These flags are meant to be user-configurable and are not describing any information from the data provider.
enum class	FieldDomainMergePolicy : int { DefaultValue , Sum , GeometryWeighted }
	Merge policy for field domains. More...
enum class	FieldDomainSplitPolicy : int { DefaultValue , Duplicate , GeometryRatio , UnsetField }
	Split policy for field domains. More...
enum class	FieldDomainType : int { Coded , Range , Glob }
	Types of field domain. More...
enum class	FieldDuplicatePolicy : int { DefaultValue , Duplicate , UnsetField }
	Duplicate policy for fields. More...
enum class	FieldMetadataProperty : int { GeometryCrs = 0x1000 , GeometryWkbType = 0x1001 , CustomProperty = 0x100000 }
	Standard field metadata values. More...
enum class	FieldOrigin : int {   Unknown , Provider , Join , Edit ,   Expression }
	Field origin. More...
enum class	FileFilterType : int {   Vector = 1 , Raster , Mesh , MeshDataset ,   PointCloud , VectorTile , TiledScene }
	Type of file filters. More...
enum class	FileOperationFlag : int { IncludeMetadataFile = 1 << 0 , IncludeStyleFile = 1 << 1 }
	File operation flags. More...
typedef QFlags< FileOperationFlag >	FileOperationFlags
	File operation flags.
enum class	FilePathType : int { Absolute , Relative }
	File path types. More...
enum class	GdalResampleAlgorithm : int {   RA_NearestNeighbour = 0 , RA_Bilinear = 1 , RA_Cubic = 2 , RA_CubicSpline = 3 ,   RA_Lanczos = 4 , RA_Average = 5 , RA_Mode = 6 , RA_Max = 8 ,   RA_Min = 9 , RA_Median = 10 , RA_Q1 = 11 , RA_Q3 = 12 }
	Resampling algorithm to be used (equivalent to GDAL's enum GDALResampleAlg) More...
enum class	GeometryOperationResult : int {   Success = 0 , NothingHappened = 1000 , InvalidBaseGeometry , InvalidInputGeometryType ,   SelectionIsEmpty , SelectionIsGreaterThanOne , GeometryEngineError , LayerNotEditable ,   AddPartSelectedGeometryNotFound , AddPartNotMultiGeometry , AddRingNotClosed , AddRingNotValid ,   AddRingCrossesExistingRings , AddRingNotInExistingFeature , SplitCannotSplitPoint , GeometryTypeHasChanged }
	Success or failure of a geometry operation. More...
enum class	GeometryType : int {   Point , Line , Polygon , Unknown ,   Null }
	The geometry types are used to group Qgis::WkbType in a coarse way. More...
enum class	GeometryValidationEngine : int { QgisInternal , Geos }
	Available engines for validating geometries. More...
enum class	GeometryValidityFlag : int { AllowSelfTouchingHoles = 1 << 0 }
	Geometry validity check flags. More...
typedef QFlags< GeometryValidityFlag >	GeometryValidityFlags
	Geometry validity flags.
enum class	GnssConstellation {   Unknown , Gps , Glonass , Galileo ,   BeiDou , Qzss , Navic , Sbas }
	GNSS constellation. More...
enum class	GpsConnectionType : int { Automatic , Internal , Serial , Gpsd }
	GPS connection types. More...
enum class	GpsFeatureType : int { Waypoint , Route , Track }
	GPS feature types. More...
enum class	GpsFixStatus : int { NoData , NoFix , Fix2D , Fix3D }
	GPS fix status. More...
enum class	GpsInformationComponent : int {   Location = 1 << 0 , Altitude = 1 << 1 , GroundSpeed = 1 << 2 , Bearing = 1 << 3 ,   TotalTrackLength = 1 << 4 , TrackDistanceFromStart = 1 << 5 , Pdop = 1 << 6 , Hdop = 1 << 7 ,   Vdop = 1 << 8 , HorizontalAccuracy = 1 << 9 , VerticalAccuracy = 1 << 10 , HvAccuracy = 1 << 11 ,   SatellitesUsed = 1 << 12 , Timestamp = 1 << 13 , TrackStartTime = 1 << 14 , TrackEndTime = 1 << 15 ,   TrackDistanceSinceLastPoint = 1 << 16 , TrackTimeSinceLastPoint = 1 << 17 , GeoidalSeparation = 1 << 18 , EllipsoidAltitude = 1 << 19 }
	GPS information component. More...
typedef QFlags< GpsInformationComponent >	GpsInformationComponents
	GPS information component.
enum class	GpsNavigationStatus : int { NotValid , Safe , Caution , Unsafe }
	GPS navigation status. More...
enum class	GpsQualityIndicator {   Unknown = -1 , Invalid , GPS , DGPS ,   PPS , RTK , FloatRTK , Estimated ,   Manual , Simulation }
	GPS signal quality indicator. More...
enum class	GradientColorSource : int { SimpleTwoColor , ColorRamp }
	Gradient color sources. More...
enum class	GradientSpread : int { Pad , Reflect , Repeat }
	Gradient spread options, which control how gradients are rendered outside of their start and end points. More...
enum class	GradientType : int { Linear , Radial , Conical }
	Gradient types. More...
enum class	GraduatedMethod : int { Color , Size }
	Methods for modifying symbols by range in a graduated symbol renderer. More...
enum class	HistoryProviderBackend : int { LocalProfile = 1 << 0 }
	History provider backends. More...
typedef QFlags< HistoryProviderBackend >	HistoryProviderBackends
enum class	HttpMethod : int { Get = 0 , Post = 1 }
	Different methods of HTTP requests. More...
enum class	InputControllerType : int { Map2D , Map3D }
	Input controller types. More...
enum class	InvalidGeometryCheck : int { NoCheck = 0 , SkipInvalid = 1 , AbortOnInvalid = 2 }
	Methods for handling of features with invalid geometries. More...
enum class	JoinStyle : int { Round = 1 , Miter , Bevel }
	Join styles for buffers. More...
enum class	LabelingFlag : int {   UseAllLabels = 1 << 1 , UsePartialCandidates = 1 << 2 , RenderOutlineLabels = 1 << 3 , DrawLabelRectOnly = 1 << 4 ,   DrawCandidates = 1 << 5 , DrawUnplacedLabels = 1 << 6 , CollectUnplacedLabels = 1 << 7 , DrawLabelMetrics = 1 << 8 }
	Various flags that affect drawing and placement of labels. More...
typedef QFlags< LabelingFlag >	LabelingFlags
	Flags that affect drawing and placement of labels.
enum class	LabelLinePlacementFlag : int { OnLine = 1 , AboveLine = 2 , BelowLine = 4 , MapOrientation = 8 }
	Line placement flags, which control how candidates are generated for a linear feature. More...
typedef QFlags< LabelLinePlacementFlag >	LabelLinePlacementFlags
	Line placement flags, which control how candidates are generated for a linear feature.
enum class	LabelMultiLineAlignment : int {   Left = 0 , Center , Right , FollowPlacement ,   Justify }
	Text alignment for multi-line labels. More...
enum class	LabelOffsetType : int { FromPoint , FromSymbolBounds }
	Behavior modifier for label offset and distance, only applies in some label placement modes. More...
enum class	LabelOverlapHandling : int { PreventOverlap , AllowOverlapIfRequired , AllowOverlapAtNoCost }
	Label overlap handling. More...
enum class	LabelPlacement : int {   AroundPoint , OverPoint , Line , Curved ,   Horizontal , Free , OrderedPositionsAroundPoint , PerimeterCurved ,   OutsidePolygons }
	Placement modes which determine how label candidates are generated for a feature. More...
enum class	LabelPlacementEngineVersion : int { Version1 , Version2 }
	Labeling placement engine version. More...
enum class	LabelPolygonPlacementFlag : int { AllowPlacementOutsideOfPolygon = 1 << 0 , AllowPlacementInsideOfPolygon = 1 << 1 }
	Polygon placement flags, which control how candidates are generated for a polygon feature. More...
typedef QFlags< LabelPolygonPlacementFlag >	LabelPolygonPlacementFlags
	Polygon placement flags, which control how candidates are generated for a polygon feature.
enum class	LabelPredefinedPointPosition : int {   TopLeft , TopSlightlyLeft , TopMiddle , TopSlightlyRight ,   TopRight , MiddleLeft , MiddleRight , BottomLeft ,   BottomSlightlyLeft , BottomMiddle , BottomSlightlyRight , BottomRight ,   OverPoint }
	Positions for labels when using the Qgis::LabelPlacement::OrderedPositionsAroundPoint placement mode. More...
enum class	LabelPrioritization : int { PreferCloser , PreferPositionOrdering }
	Label prioritization. More...
enum class	LabelQuadrantPosition : int {   AboveLeft , Above , AboveRight , Left ,   Over , Right , BelowLeft , Below ,   BelowRight }
	Label quadrant positions. More...
enum class	LayerFilter : int {   RasterLayer = 1 , NoGeometry = 2 , PointLayer = 4 , LineLayer = 8 ,   PolygonLayer = 16 , HasGeometry = PointLayer | LineLayer | PolygonLayer , VectorLayer = NoGeometry | HasGeometry , PluginLayer = 32 ,   WritableLayer = 64 , MeshLayer = 128 , VectorTileLayer = 256 , PointCloudLayer = 512 ,   AnnotationLayer = 1024 , TiledSceneLayer = 2048 , All = RasterLayer | VectorLayer | PluginLayer | MeshLayer | VectorTileLayer | PointCloudLayer | AnnotationLayer | TiledSceneLayer , SpatialLayer = RasterLayer | HasGeometry | PluginLayer | MeshLayer | VectorTileLayer | PointCloudLayer | AnnotationLayer | TiledSceneLayer }
	Filter for layers. More...
typedef QFlags< LayerFilter >	LayerFilters
enum class	LayerTreeFilterFlag : int { SkipVisibilityCheck = 1 << 0 }
	Layer tree filter flags. More...
typedef QFlags< LayerTreeFilterFlag >	LayerTreeFilterFlags
	Layer tree filter flags.
enum class	LayerTreeInsertionMethod : int { AboveInsertionPoint , TopOfTree , OptimalInInsertionGroup }
	Layer tree insertion methods. More...
enum class	LayerType : int {   Vector , Raster , Plugin , Mesh ,   VectorTile , Annotation , PointCloud , Group ,   TiledScene }
	Types of layers that can be added to a map. More...
enum class	LayoutUnit : int {   Millimeters , Centimeters , Meters , Inches ,   Feet , Points , Picas , Pixels }
	Layout measurement units. More...
enum class	LayoutUnitType : int { PaperUnits , ScreenUnits }
	Types of layout units. More...
enum class	LegendJsonRenderFlag : int { ShowRuleDetails = 1 << 0 }
	Legend JSON export flags. More...
typedef QFlags< LegendJsonRenderFlag >	LegendJsonRenderFlags
enum class	LightSourceType : int { Point , Directional }
	Light source types for 3D scenes. More...
enum class	LineClipMode : int { ClipPainterOnly , ClipToIntersection , NoClipping }
	Line clipping modes. More...
enum class	LineExtensionSide : int { BeforeVertex , AfterVertex , NoVertex }
	Designates whether the line extension constraint is currently soft locked with the previous or next vertex of the locked one. More...
enum class	LoadStyleFlag : int { IgnoreMissingStyleErrors = 1 << 0 }
	Flags for loading layer styles. More...
typedef QFlags< LoadStyleFlag >	LoadStyleFlags
	Flags for loading layer styles.
enum class	MakeValidMethod : int { Linework = 0 , Structure = 1 }
	Algorithms to use when repairing invalid geometries. More...
enum class	MapBoxGlStyleSourceType : int {   Vector , Raster , RasterDem , GeoJson ,   Image , Video , Unknown }
	Available MapBox GL style source types. More...
enum class	MapLayerActionFlag : int { EnabledOnlyWhenEditable = 1 << 1 }
	Map layer action flags. More...
typedef QFlags< MapLayerActionFlag >	MapLayerActionFlags
	Map layer action flags.
enum class	MapLayerActionTarget : int { Layer = 1 << 0 , SingleFeature = 1 << 1 , MultipleFeatures = 1 << 2 , AllActions = Layer | SingleFeature | MultipleFeatures }
	Map layer action targets. More...
typedef QFlags< MapLayerActionTarget >	MapLayerActionTargets
	Map layer action targets.
typedef QFlags< MapLayerProperty >	MapLayerProperties
	Map layer properties.
enum class	MapLayerProperty : int { UsersCannotToggleEditing = 1 << 0 , IsBasemapLayer = 1 << 1 }
	Generic map layer properties. More...
enum class	MapLayerRendererFlag : int { RenderPartialOutputs = 1 << 0 , RenderPartialOutputOverPreviousCachedImage = 1 << 1 }
	Flags which control how map layer renderers behave. More...
typedef QFlags< MapLayerRendererFlag >	MapLayerRendererFlags
	Flags which control how map layer renderers behave.
enum class	MapRecenteringMode { Always , WhenOutsideVisibleExtent , Never }
	Modes for recentering map canvases. More...
enum class	MapSettingsFlag : int {   Antialiasing = 0x01 , DrawEditingInfo = 0x02 , ForceVectorOutput = 0x04 , UseAdvancedEffects = 0x08 ,   DrawLabeling = 0x10 , UseRenderingOptimization = 0x20 , DrawSelection = 0x40 , DrawSymbolBounds = 0x80 ,   RenderMapTile = 0x100 , RenderPartialOutput = 0x200 , RenderPreviewJob = 0x400 , RenderBlocking = 0x800 ,   LosslessImageRendering = 0x1000 , Render3DMap = 0x2000 , HighQualityImageTransforms = 0x4000 , SkipSymbolRendering = 0x8000 ,   ForceRasterMasks = 0x10000 , RecordProfile = 0x20000 }
	Flags which adjust the way maps are rendered. More...
typedef QFlags< MapSettingsFlag >	MapSettingsFlags
	Map settings flags.
enum class	MapToolUnit : int { Layer , Pixels , Project }
	Type of unit of tolerance value from settings. More...
enum class	MarkerClipMode : int { NoClipping , Shape , CentroidWithin , CompletelyWithin }
	Marker clipping modes. More...
enum class	MarkerLinePlacement : int {   Interval = 1 << 0 , Vertex = 1 << 1 , LastVertex = 1 << 2 , FirstVertex = 1 << 3 ,   CentralPoint = 1 << 4 , CurvePoint = 1 << 5 , SegmentCenter = 1 << 6 , InnerVertices = 1 << 7 }
	Defines how/where the symbols should be placed on a line. More...
typedef QFlags< MarkerLinePlacement >	MarkerLinePlacements
enum class	MarkerShape : int {   Square , Diamond , Pentagon , Hexagon ,   Triangle , EquilateralTriangle , Star , Arrow ,   Circle , Cross , CrossFill , Cross2 ,   Line , ArrowHead , ArrowHeadFilled , SemiCircle ,   ThirdCircle , QuarterCircle , QuarterSquare , HalfSquare ,   DiagonalHalfSquare , RightHalfTriangle , LeftHalfTriangle , Octagon ,   SquareWithCorners , AsteriskFill , HalfArc , ThirdArc ,   QuarterArc , ParallelogramRight , ParallelogramLeft , Trapezoid ,   Shield , DiamondStar , Heart , Decagon ,   RoundedSquare }
	Marker shapes. More...
enum class	MeshEditingErrorType : int {   NoError , InvalidFace , TooManyVerticesInFace , FlatFace ,   UniqueSharedVertex , InvalidVertex , ManifoldFace }
	Type of error that can occur during mesh frame editing. More...
enum class	MeshElevationMode : int { FixedElevationRange = 0 , FromVertices = 1 , FixedRangePerGroup = 2 }
	Mesh layer elevation modes. More...
enum	MessageLevel {   Info = 0 , Warning = 1 , Critical = 2 , Success = 3 ,   NoLevel = 4 }
	Level for messages This will be used both for message log and message bar in application. More...
enum class	MetadataDateType { Created , Published , Revised , Superseded }
	Date types for metadata. More...
enum class	NavigationMode : int { TerrainBased , Walk }
	The navigation mode used by 3D cameras. More...
enum class	PlaybackOperation : int {   SkipToStart , PreviousFrame , PlayReverse , Pause ,   PlayForward , NextFrame , SkipToEnd }
	Media playback operations. More...
enum class	PlotAxisSuffixPlacement {   NoLabels , EveryLabel , FirstLabel , LastLabel ,   FirstAndLastLabels }
	Placement options for suffixes in the labels for axis of plots. More...
enum class	PlotToolFlag : int { ShowContextMenu = 1 << 0 }
	Flags that control the way the QgsPlotTools operate. More...
typedef QFlags< PlotToolFlag >	PlotToolFlags
enum class	Point3DShape : int {   Cylinder , Sphere , Cone , Cube ,   Torus , Plane , ExtrudedText , Model ,   Billboard }
	3D point shape types. More...
enum class	PointCloudDrawOrder : int { Default , BottomToTop , TopToBottom }
	Pointcloud rendering order for 2d views. More...
enum class	PointCloudSymbol : int { Square , Circle }
	Rendering symbols for point cloud points. More...
enum class	PointCountMethod : int { Absolute , DensityBased }
	Methods which define the number of points randomly filling a polygon. More...
enum class	PostgresRelKind {   NotSet , Unknown , OrdinaryTable , Index ,   Sequence , View , MaterializedView , CompositeType ,   ToastTable , ForeignTable , PartitionedTable }
	Postgres database relkind options. More...
enum class	ProcessingAlgorithmFlag : int {   HideFromToolbox = 1 << 1 , HideFromModeler = 1 << 2 , SupportsBatch = 1 << 3 , CanCancel = 1 << 4 ,   RequiresMatchingCrs = 1 << 5 , NoThreading = 1 << 6 , DisplayNameIsLiteral = 1 << 7 , SupportsInPlaceEdits = 1 << 8 ,   KnownIssues = 1 << 9 , CustomException = 1 << 10 , PruneModelBranchesBasedOnAlgorithmResults = 1 << 11 , SkipGenericModelLogging = 1 << 12 ,   NotAvailableInStandaloneTool = 1 << 13 , RequiresProject = 1 << 14 , Deprecated = HideFromToolbox | HideFromModeler }
	Flags indicating how and when an algorithm operates and should be exposed to users. More...
typedef QFlags< ProcessingAlgorithmFlag >	ProcessingAlgorithmFlags
	Flags indicating how and when an algorithm operates and should be exposed to users.
enum class	ProcessingDateTimeParameterDataType : int { DateTime , Date , Time }
	Processing date time parameter data types. More...
enum class	ProcessingFeatureSourceDefinitionFlag : int { OverrideDefaultGeometryCheck = 1 << 0 , CreateIndividualOutputPerInputFeature = 1 << 1 }
	Flags which control behavior for a Processing feature source. More...
typedef QFlags< ProcessingFeatureSourceDefinitionFlag >	ProcessingFeatureSourceDefinitionFlags
	Flags which control behavior for a Processing feature source.
enum class	ProcessingFeatureSourceFlag : int { SkipGeometryValidityChecks = 1 << 1 }
	Flags which control how QgsProcessingFeatureSource fetches features. More...
typedef QFlags< ProcessingFeatureSourceFlag >	ProcessingFeatureSourceFlags
	Flags which control how QgsProcessingFeatureSource fetches features.
enum class	ProcessingFieldParameterDataType : int {   Any = -1 , Numeric = 0 , String = 1 , DateTime = 2 ,   Binary = 3 , Boolean = 4 }
	Processing field parameter data types. More...
enum class	ProcessingFileParameterBehavior : int { File = 0 , Folder }
	Flags which dictate the behavior of QgsProcessingParameterFile. More...
enum class	ProcessingLogLevel : int { DefaultLevel = 0 , Verbose , ModelDebug }
	Logging level for algorithms to use when pushing feedback messages. More...
enum class	ProcessingModelChildAlgorithmExecutionStatus : int { NotExecuted , Success , Failed }
	Reflects the status of a child algorithm in a Processing model. More...
enum class	ProcessingModelChildParameterSource : int {   ModelParameter , ChildOutput , StaticValue , Expression ,   ExpressionText , ModelOutput }
	Processing model child parameter sources. More...
enum class	ProcessingNumberParameterType : int { Integer , Double }
	Processing numeric parameter data types. More...
enum class	ProcessingParameterFlag : int { Advanced = 1 << 1 , Hidden = 1 << 2 , Optional = 1 << 3 , IsModelOutput = 1 << 4 }
	Flags which dictate the behavior of Processing parameters. More...
typedef QFlags< ProcessingParameterFlag >	ProcessingParameterFlags
	Flags which dictate the behavior of Processing parameters.
enum class	ProcessingParameterTypeFlag : int { ExposeToModeler = 1 }
	Flags which dictate the behavior of Processing parameter types. More...
typedef QFlags< ProcessingParameterTypeFlag >	ProcessingParameterTypeFlags
	Flags which dictate the behavior of Processing parameter types.
enum class	ProcessingPropertyAvailability : int { NotAvailable , Available }
	Property availability, used for QgsProcessingAlgorithm::VectorProperties in order to determine if properties are available or not. More...
enum class	ProcessingProviderFlag : int { DeemphasiseSearchResults = 1 << 1 , CompatibleWithVirtualRaster = 1 << 2 }
	Flags indicating how and when an processing provider operates and should be exposed to users. More...
typedef QFlags< ProcessingProviderFlag >	ProcessingProviderFlags
	Flags indicating how and when an processing provider operates and should be exposed to users.
enum class	ProcessingSourceType : int {   MapLayer = -2 , VectorAnyGeometry = -1 , VectorPoint = 0 , VectorLine = 1 ,   VectorPolygon = 2 , Raster = 3 , File = 4 , Vector = 5 ,   Mesh = 6 , Plugin = 7 , PointCloud = 8 , Annotation = 9 ,   VectorTile = 10 }
	Processing data source types. More...
enum class	ProcessingTinInputLayerType : int { Vertices , StructureLines , BreakLines }
	Defines the type of input layer for a Processing TIN input. More...
enum class	ProfileExportType : int { Features3D , Profile2D , DistanceVsElevationTable }
	Types of export for elevation profiles. More...
enum class	ProfileGeneratorFlag : int { RespectsMaximumErrorMapUnit = 1 << 0 , RespectsDistanceRange = 1 << 1 , RespectsElevationRange = 1 << 2 }
	Flags that control the way the QgsAbstractProfileGenerator operate. More...
typedef QFlags< ProfileGeneratorFlag >	ProfileGeneratorFlags
enum class	ProfileSurfaceSymbology : int { Line , FillBelow , FillAbove }
	Surface symbology type for elevation profile plots. More...
typedef QFlags< ProjectCapability >	ProjectCapabilities
	Flags which control project capabilities.
enum class	ProjectCapability : int { ProjectStyles = 1 << 0 }
	Flags which control project capabilities. More...
enum class	ProjectFileFormat : int { Qgz , Qgs }
	Flags which control project read behavior. More...
enum class	ProjectFlag : int { EvaluateDefaultValuesOnProviderSide = 1 << 0 , TrustStoredLayerStatistics = 1 << 1 , RememberLayerEditStatusBetweenSessions = 1 << 2 , RememberAttributeTableWindowsBetweenSessions = 1 << 3 }
	Flags which control the behavior of QgsProjects. More...
typedef QFlags< ProjectFlag >	ProjectFlags
enum class	ProjectReadFlag : int {   DontResolveLayers = 1 << 0 , DontLoadLayouts = 1 << 1 , TrustLayerMetadata = 1 << 2 , DontStoreOriginalStyles = 1 << 3 ,   DontLoad3DViews = 1 << 4 , DontLoadProjectStyles = 1 << 5 , ForceReadOnlyLayers = 1 << 6 }
	Flags which control project read behavior. More...
typedef QFlags< ProjectReadFlag >	ProjectReadFlags
	Project load flags.
enum class	PropertyType : int { Invalid , Static , Field , Expression }
	Property types. More...
typedef QFlags< ProviderStyleStorageCapability >	ProviderStyleStorageCapabilities
enum class	ProviderStyleStorageCapability : int { SaveToDatabase = 1 << 1 , LoadFromDatabase = 1 << 2 , DeleteFromDatabase = 1 << 3 }
	The StorageCapability enum represents the style storage operations supported by the provider. More...
enum class	PythonMacroMode : int {   Never = 0 , Ask = 1 , SessionOnly = 2 , Always = 3 ,   NotForThisSession }
	Authorisation to run Python Macros. More...
enum class	RangeLimits : int { IncludeBoth = 0 , IncludeLowerExcludeUpper , ExcludeLowerIncludeUpper , ExcludeBoth }
	Describes how the limits of a range are handled. More...
enum class	RasterAttributeTableFieldUsage : int {   Generic = 0 , PixelCount = 1 , Name = 2 , Min = 3 ,   Max = 4 , MinMax = 5 , Red = 6 , Green = 7 ,   Blue = 8 , Alpha = 9 , RedMin = 10 , GreenMin = 11 ,   BlueMin = 12 , AlphaMin = 13 , RedMax = 14 , GreenMax = 15 ,   BlueMax = 16 , AlphaMax = 17 , MaxCount }
	The RasterAttributeTableFieldUsage enum represents the usage of a Raster Attribute Table field. More...
enum class	RasterAttributeTableType : int { Thematic = 0 , Athematic = 1 }
	The RasterAttributeTableType enum represents the type of RAT. More...
enum class	RasterBandStatistic : int {   NoStatistic = 0 , Min = 1 , Max = 1 << 1 , Range = 1 << 2 ,   Sum = 1 << 3 , Mean = 1 << 4 , StdDev = 1 << 5 , SumOfSquares = 1 << 6 ,   All = Min | Max | Range | Sum | Mean | StdDev | SumOfSquares }
	Available raster band statistics. More...
typedef QFlags< RasterBandStatistic >	RasterBandStatistics
	Statistics to be calculated for raster bands.
enum class	RasterBuildPyramidOption : int { No = 0 , Yes = 1 , CopyExisting = 2 }
	Raster pyramid building options. More...
enum class	RasterColorInterpretation : int {   Undefined = 0 , GrayIndex = 1 , PaletteIndex = 2 , RedBand = 3 ,   GreenBand = 4 , BlueBand = 5 , AlphaBand = 6 , HueBand = 7 ,   SaturationBand = 8 , LightnessBand = 9 , CyanBand = 10 , MagentaBand = 11 ,   YellowBand = 12 , BlackBand = 13 , YCbCr_YBand = 14 , YCbCr_CbBand = 15 ,   YCbCr_CrBand = 16 , ContinuousPalette = 17 }
	Raster color interpretation. More...
enum class	RasterDrawingStyle : int {   Undefined , SingleBandGray , SingleBandPseudoColor , PalettedColor ,   PalettedSingleBandGray , PalettedSingleBandPseudoColor , PalettedMultiBandColor , MultiBandSingleBandGray ,   MultiBandSingleBandPseudoColor , MultiBandColor , SingleBandColorData }
	Raster drawing styles. More...
enum class	RasterElevationMode : int { FixedElevationRange = 0 , RepresentsElevationSurface = 1 , FixedRangePerBand = 2 , DynamicRangePerBand = 3 }
	Raster layer elevation modes. More...
enum class	RasterExportType : int { Raw = 0 , RenderedImage = 1 }
	Raster file export types. More...
enum class	RasterFileWriterResult : int {   Success = 0 , SourceProviderError = 1 , DestinationProviderError = 2 , CreateDatasourceError = 3 ,   WriteError = 4 , NoDataConflict = 5 , Canceled = 6 }
	Raster file export results. More...
enum class	RasterIdentifyFormat : int {   Undefined = 0 , Value = 1 , Text = 1 << 1 , Html = 1 << 2 ,   Feature = 1 << 3 }
	Raster identify formats. More...
typedef QFlags< RasterInterfaceCapability >	RasterInterfaceCapabilities
	Raster interface capabilities.
enum class	RasterInterfaceCapability : int {   NoCapabilities = 0 , Size = 1 << 1 , Create = 1 << 2 , Remove = 1 << 3 ,   BuildPyramids = 1 << 4 , Identify = 1 << 5 , IdentifyValue = 1 << 6 , IdentifyText = 1 << 7 ,   IdentifyHtml = 1 << 8 , IdentifyFeature = 1 << 9 , Prefetch = 1 << 10 }
	Raster interface capabilities. More...
enum class	RasterLayerType : int { GrayOrUndefined , Palette , MultiBand , SingleBandColorData }
	Raster layer types. More...
enum class	RasterPipeInterfaceRole : int {   Unknown = 0 , Provider = 1 , Renderer = 2 , Brightness = 3 ,   Resampler = 4 , Projector = 5 , Nuller = 6 , HueSaturation = 7 }
	Raster pipe interface roles. More...
typedef QFlags< RasterProviderCapability >	RasterProviderCapabilities
	Raster data provider capabilities.
enum class	RasterProviderCapability : int {   NoProviderCapabilities = 0 , ReadLayerMetadata = 1 << 1 , WriteLayerMetadata = 1 << 2 , ProviderHintBenefitsFromResampling = 1 << 3 ,   ProviderHintCanPerformProviderResampling = 1 << 4 , ReloadData = 1 << 5 , DpiDependentData = 1 << 6 , NativeRasterAttributeTable = 1 << 7 ,   BuildPyramids = 1 << 8 }
	Raster data provider capabilities. More...
enum class	RasterPyramidFormat : int { GeoTiff = 0 , Internal = 1 , Erdas = 2 }
	Raster pyramid formats. More...
typedef QFlags< RasterRendererCapability >	RasterRendererCapabilities
	Raster renderer capabilities.
enum class	RasterRendererCapability : int { UsesMultipleBands = 1 << 0 }
	Raster renderer capabilities. More...
enum class	RasterRendererFlag : int { InternalLayerOpacityHandling = 1 << 0 , UseNoDataForOutOfRangePixels = 1 << 1 }
	Flags which control behavior of raster renderers. More...
typedef QFlags< RasterRendererFlag >	RasterRendererFlags
	Flags which control behavior of raster renderers.
enum class	RasterResamplingStage : int { ResampleFilter , Provider }
	Stage at which raster resampling occurs. More...
enum class	RasterTemporalCapabilityFlag : int { RequestedTimesMustExactlyMatchAllAvailableTemporalRanges = 1 << 0 }
	Flags for raster layer temporal capabilities. More...
typedef QFlags< RasterTemporalCapabilityFlag >	RasterTemporalCapabilityFlags
	Flags for raster layer temporal capabilities.
enum class	RasterTemporalMode : int {   FixedTemporalRange = 0 , TemporalRangeFromDataProvider = 1 , RedrawLayerOnly = 2 , FixedRangePerBand = 3 ,   RepresentsTemporalValues = 4 }
	Raster layer temporal modes. More...
typedef QFlags< RelationshipCapability >	RelationshipCapabilities
	Relationship capabilities.
enum class	RelationshipCapability : int { MultipleFieldKeys = 1 << 0 , ForwardPathLabel = 1 << 1 , BackwardPathLabel = 1 << 2 }
	Relationship capabilities. More...
enum class	RelationshipCardinality : int { OneToOne , OneToMany , ManyToOne , ManyToMany }
	Relationship cardinality. More...
enum class	RelationshipStrength : int { Association , Composition }
	Relationship strength. More...
enum class	RelationshipType : int { Normal , Generated }
	Relationship types. More...
enum class	RenderContextFlag : int {   DrawEditingInfo = 0x01 , ForceVectorOutput = 0x02 , UseAdvancedEffects = 0x04 , UseRenderingOptimization = 0x08 ,   DrawSelection = 0x10 , DrawSymbolBounds = 0x20 , RenderMapTile = 0x40 , Antialiasing = 0x80 ,   RenderPartialOutput = 0x100 , RenderPreviewJob = 0x200 , RenderBlocking = 0x400 , RenderSymbolPreview = 0x800 ,   LosslessImageRendering = 0x1000 , ApplyScalingWorkaroundForTextRendering = 0x2000 , Render3DMap = 0x4000 , ApplyClipAfterReprojection = 0x8000 ,   RenderingSubSymbol = 0x10000 , HighQualityImageTransforms = 0x20000 , SkipSymbolRendering = 0x40000 , RecordProfile = 0x80000 }
	Flags which affect rendering operations. More...
typedef QFlags< RenderContextFlag >	RenderContextFlags
	Render context flags.
enum class	RendererUsage : int { View , Export , Unknown }
	Usage of the renderer. More...
enum class	RenderSubcomponentProperty : int { Generic , ShadowOffset , BlurSize , GlowSpread }
	Rendering subcomponent properties. More...
enum class	RenderUnit : int {   Millimeters , MapUnits , Pixels , Percentage ,   Points , Inches , Unknown , MetersInMapUnits }
	Rendering size units. More...
enum class	ScaleMethod : int { ScaleArea , ScaleDiameter }
	Scale methods. More...
enum class	ScaleToTileZoomLevelMethod : int { MapBox , Esri }
	Available methods for converting map scales to tile zoom levels. More...
enum class	ScriptLanguage : int {   Css , QgisExpression , Html , JavaScript ,   Json , Python , R , Sql ,   Batch , Bash , Unknown }
	Scripting languages. More...
typedef QFlags< ScriptLanguageCapability >	ScriptLanguageCapabilities
	Script language capabilities.
enum class	ScriptLanguageCapability : int { Reformat = 1 << 0 , CheckSyntax = 1 << 1 , ToggleComment = 1 << 2 }
	Script language capabilities. More...
enum class	SelectBehavior : int { SetSelection , AddToSelection , IntersectSelection , RemoveFromSelection }
	Specifies how a selection should be applied. More...
enum class	SelectGeometryRelationship : int { Intersect , Within }
	Geometry relationship test to apply for selecting features. More...
enum class	SelectionFlag : int { SingleFeatureSelection = 1 << 0 , ToggleSelection = 1 << 1 }
	Flags which control feature selection behavior. More...
typedef QFlags< SelectionFlag >	SelectionFlags
	Flags which control feature selection behavior.
enum class	SelectionRenderingMode : int { Default , CustomColor , CustomSymbol }
	Specifies how a selection should be rendered. More...
enum class	SensorThingsEntity : int {   Invalid , Thing , Location , HistoricalLocation ,   Datastream , Sensor , ObservedProperty , Observation ,   FeatureOfInterest , MultiDatastream }
	OGC SensorThings API entity types. More...
enum class	SettingsOption : int { SaveFormerValue = 1 << 1 , SaveEnumFlagAsInt = 1 << 2 }
	Settings options. More...
typedef QFlags< SettingsOption >	SettingsOptions
enum class	SettingsOrigin : int { Any , Global , Local }
	The setting origin describes where a setting is stored. More...
enum class	SettingsTreeNodeOption : int { NamedListSelectedItemSetting = 1 << 0 }
	Options for named list nodes. More...
typedef QFlags< SettingsTreeNodeOption >	SettingsTreeNodeOptions
enum class	SettingsTreeNodeType { Root , Standard , NamedList }
	Type of tree node. More...
enum class	SettingsType : int {   Custom , Variant , String , StringList ,   VariantMap , Bool , Integer , Double ,   EnumFlag , Color }
	Types of settings entries. More...
enum class	ShaderClassificationMethod : int { Continuous = 1 , EqualInterval = 2 , Quantile = 3 }
	Color ramp shader classification methods. More...
enum class	ShaderInterpolationMethod : int { Linear = 0 , Discrete = 1 , Exact = 2 }
	Color ramp shader interpolation methods. More...
enum class	SldExportOption : int { NoOptions = 0 , Svg = 1 << 0 , Png = 1 << 1 }
	SLD export options. More...
typedef QFlags< SldExportOption >	SldExportOptions
enum class	SldExportVendorExtension : int { NoVendorExtension = 0 , GeoServerVendorExtension = 1 << 1 , DeegreeVendorExtension = 1 << 2 }
	SLD export vendor extensions, allow the use of vendor extensions when exporting to SLD. More...
enum class	SnappingMode : int { ActiveLayer = 1 , AllLayers = 2 , AdvancedConfiguration = 3 }
	SnappingMode defines on which layer the snapping is performed. More...
enum class	SnappingType : int {   NoSnap = 0 , Vertex = 1 << 0 , Segment = 1 << 1 , Area = 1 << 2 ,   Centroid = 1 << 3 , MiddleOfSegment = 1 << 4 , LineEndpoint = 1 << 5 }
	SnappingTypeFlag defines on what object the snapping is performed. More...
typedef QFlags< SnappingType >	SnappingTypes
	Snapping types.
enum class	SpatialFilterType : int { NoFilter , BoundingBox , DistanceWithin }
	Feature request spatial filter types. More...
enum class	SpatialIndexPresence : int { Unknown = 0 , NotPresent = 1 , Present = 2 }
	Enumeration of spatial index presence states. More...
enum class	SqlKeywordCategory : int {   Keyword , Constant , Function , Geospatial ,   Operator , Math , Aggregate , String ,   Identifier }
	SqlKeywordCategory enum represents the categories of the SQL keywords used by the SQL query editor. More...
typedef QFlags< SqlLayerDefinitionCapability >	SqlLayerDefinitionCapabilities
	SQL layer definition capabilities.
enum class	SqlLayerDefinitionCapability : int { SubsetStringFilter = 1 << 1 , GeometryColumn = 1 << 2 , PrimaryKeys = 1 << 3 , UnstableFeatureIds = 1 << 4 }
	SqlLayerDefinitionCapability enum lists the arguments supported by the provider when creating SQL query layers. More...
enum class	Statistic : int {   Count = 1 << 0 , CountMissing = 1 << 15 , Sum = 1 << 1 , Mean = 1 << 2 ,   Median = 1 << 3 , StDev = 1 << 4 , StDevSample = 1 << 5 , Min = 1 << 6 ,   Max = 1 << 7 , Range = 1 << 8 , Minority = 1 << 9 , Majority = 1 << 10 ,   Variety = 1 << 11 , FirstQuartile = 1 << 12 , ThirdQuartile = 1 << 13 , InterQuartileRange = 1 << 14 ,   First = 1 << 16 , Last = 1 << 17 , All = Count | CountMissing | Sum | Mean | Median | StDev | Max | Min | Range | Minority | Majority | Variety | FirstQuartile | ThirdQuartile | InterQuartileRange | First | Last }
	Available generic statistics. More...
typedef QFlags< Statistic >	Statistics
	Statistics to be calculated for generic values.
enum class	StringStatistic : int {   Count = 1 , CountDistinct = 2 , CountMissing = 4 , Min = 8 ,   Max = 16 , MinimumLength = 32 , MaximumLength = 64 , MeanLength = 128 ,   Minority = 256 , Majority = 512 , All = Count | CountDistinct | CountMissing | Min | Max | MinimumLength | MaximumLength | MeanLength | Minority | Majority }
	Available string statistics. More...
typedef QFlags< StringStatistic >	StringStatistics
	Statistics to be calculated for string values.
enum class	SublayerFlag : int { SystemTable = 1 << 0 }
	Flags which reflect the properties of sublayers in a dataset. More...
typedef QFlags< SublayerFlag >	SublayerFlags
	Sublayer flags.
enum class	SublayerPromptMode : int { AlwaysAsk , AskExcludingRasterBands , NeverAskSkip , NeverAskLoadAll }
	Specifies how to handle layer sources with multiple sublayers. More...
enum class	SublayerQueryFlag : int { FastScan = 1 << 0 , ResolveGeometryType = 1 << 1 , CountFeatures = 1 << 2 , IncludeSystemTables = 1 << 3 }
	Flags which control how data providers will scan for sublayers in a dataset. More...
typedef QFlags< SublayerQueryFlag >	SublayerQueryFlags
	Sublayer query flags.
enum class	SymbolCoordinateReference : int { Feature , Viewport }
	Symbol coordinate reference modes. More...
enum class	SymbolFlag : int { RendererShouldUseSymbolLevels = 1 << 0 }
	Flags controlling behavior of symbols. More...
typedef QFlags< SymbolFlag >	SymbolFlags
	Symbol flags.
enum class	SymbolLayerFlag : int { DisableFeatureClipping = 1 << 0 }
	Flags controlling behavior of symbol layers. More...
typedef QFlags< SymbolLayerFlag >	SymbolLayerFlags
	Symbol layer flags.
enum class	SymbolLayerUserFlag : int { DisableSelectionRecoloring = 1 << 0 }
	User-specified flags controlling behavior of symbol layers. More...
typedef QFlags< SymbolLayerUserFlag >	SymbolLayerUserFlags
	Symbol layer user flags.
enum class	SymbolPreviewFlag : int { FlagIncludeCrosshairsForMarkerSymbols = 1 << 0 }
	Flags for controlling how symbol preview images are generated. More...
typedef QFlags< SymbolPreviewFlag >	SymbolPreviewFlags
	Symbol preview flags.
enum class	SymbolRenderHint : int { DynamicRotation = 2 }
	Flags controlling behavior of symbols during rendering. More...
typedef QFlags< SymbolRenderHint >	SymbolRenderHints
	Symbol render hints.
enum class	SymbolRotationMode : int { RespectMapRotation , IgnoreMapRotation }
	Modes for handling how symbol and text entity rotation is handled when maps are rotated. More...
enum class	SymbolType : int { Marker , Line , Fill , Hybrid }
	Symbol types. More...
enum class	SystemOfMeasurement : int { Unknown = 0 , Metric , Imperial , USCS }
	Systems of unit measurement. More...
enum class	TemporalIntervalMatchMethod : int {   MatchUsingWholeRange , MatchExactUsingStartOfRange , MatchExactUsingEndOfRange , FindClosestMatchToStartOfRange ,   FindClosestMatchToEndOfRange }
	Method to use when resolving a temporal range to a data provider layer or band. More...
enum class	TemporalNavigationMode : int { Disabled , Animated , FixedRange , Movie }
	Temporal navigation modes. More...
enum class	TemporalUnit : int {   Milliseconds , Seconds , Minutes , Hours ,   Days , Weeks , Months , Years ,   Decades , Centuries , IrregularStep , Unknown }
	Temporal units. More...
enum class	TextCharacterVerticalAlignment : int { Normal , SuperScript , SubScript }
	Text vertical alignment for characters. More...
enum class	TextComponent : int { Text , Buffer , Background , Shadow }
	Text components. More...
enum class	TextHorizontalAlignment : int { Left , Center , Right , Justify }
	Text horizontal alignment. More...
enum class	TextLayoutMode : int {   Rectangle , Point , Labeling , RectangleCapHeightBased ,   RectangleAscentBased }
	Text layout modes. More...
enum class	TextOrientation : int { Horizontal , Vertical , RotationBased }
	Text orientations. More...
enum class	TextRendererFlag : int { WrapLines = 1 << 0 }
	Flags which control the behavior of rendering text. More...
typedef QFlags< TextRendererFlag >	TextRendererFlags
enum class	TextRenderFormat : int { AlwaysOutlines , AlwaysText }
	Options for rendering text. More...
enum class	TextVerticalAlignment : int { Top , VerticalCenter , Bottom }
	Text vertical alignment. More...
enum class	TileAvailability { Available , NotAvailable , AvailableNoChildren , UseLowerZoomLevelTile }
	Possible availability states for a tile within a tile matrix. More...
enum class	TileChildrenAvailability { NoChildren , Available , NeedFetching }
	Possible availability states for a tile's children. More...
enum class	TiledSceneBoundingVolumeType { Region , OrientedBox , Sphere }
	Tiled scene bounding volume types. More...
typedef QFlags< TiledSceneProviderCapability >	TiledSceneProviderCapabilities
	Tiled scene data provider capabilities.
enum class	TiledSceneProviderCapability : int { ReadLayerMetadata = 1 << 1 }
	Tiled scene data provider capabilities. More...
enum class	TiledSceneRendererFlag : int { RequiresTextures = 1 << 0 , ForceRasterRender = 1 << 1 , RendersTriangles = 1 << 2 , RendersLines = 1 << 3 }
	Flags which control how tiled scene 2D renderers behave. More...
typedef QFlags< TiledSceneRendererFlag >	TiledSceneRendererFlags
	Flags which control how tiled scene 2D renderers behave.
enum class	TiledSceneRequestFlag : int { NoHierarchyFetch = 1 << 0 }
	Flags which control how tiled scene requests behave. More...
typedef QFlags< TiledSceneRequestFlag >	TiledSceneRequestFlags
	Flags which control how tiled scene requests behave.
enum class	TilePixelRatio { Undefined = 0 , StandardDpi = 1 , HighDpi = 2 }
	DpiMode enum. More...
enum class	TileRefinementProcess { Replacement , Additive }
	Tiled scene tile refinement processes. More...
enum class	TransactionMode : int { Disabled = 0 , AutomaticGroups = 1 , BufferedGroups = 2 }
	Transaction mode. More...
enum class	TransformDirection : int { Forward , Reverse }
	Indicates the direction (forward or inverse) of a transform. More...
enum class	UnitType : int {   Distance = 0 , Area , Volume , Unknown ,   Temporal }
	Unit types. More...
enum class	UnplacedLabelVisibility : int { FollowEngineSetting , NeverShow }
	Unplaced label visibility. More...
enum class	UpsideDownLabelHandling : int { FlipUpsideDownLabels , AllowUpsideDownWhenRotationIsDefined , AlwaysAllowUpsideDown }
	Handling techniques for upside down labels. More...
enum class	UserProfileSelectionPolicy : int { LastProfile , DefaultProfile , AskUser }
	User profile selection policy. More...
typedef QFlags< VectorDataProviderAttributeEditCapability >	VectorDataProviderAttributeEditCapabilities
	Attribute editing capabilities which may be supported by vector data providers.
enum class	VectorDataProviderAttributeEditCapability : int { EditAlias = 1 << 0 , EditComment = 1 << 1 }
	Attribute editing capabilities which may be supported by vector data providers. More...
enum class	VectorDataProviderTemporalMode : int { HasFixedTemporalRange = 0 , StoresFeatureDateTimeInstantInField , StoresFeatureDateTimeStartAndEndInSeparateFields }
	Vector data provider temporal handling modes. More...
enum class	VectorEditResult : int {   Success = 0 , EmptyGeometry = 1 , EditFailed = 2 , FetchFeatureFailed = 3 ,   InvalidLayer = 4 }
	Specifies the result of a vector layer edit operation. More...
enum class	VectorExportResult : int {   Success = 0 , ErrorCreatingDataSource , ErrorCreatingLayer , ErrorAttributeTypeUnsupported ,   ErrorAttributeCreationFailed , ErrorProjectingFeatures , ErrorFeatureWriteFailed , ErrorInvalidLayer ,   ErrorInvalidProvider , ErrorProviderUnsupportedFeature , ErrorConnectionFailed , UserCanceled }
	Vector layer export result codes. More...
typedef QFlags< VectorFileWriterCapability >	VectorFileWriterCapabilities
	Capabilities supported by a QgsVectorFileWriter object.
enum class	VectorFileWriterCapability : int { FieldAliases = 1 << 0 , FieldComments = 1 << 2 }
	Capabilities supported by a QgsVectorFileWriter object. More...
enum class	VectorLayerTypeFlag : int { SqlQuery = 1 << 0 }
	Vector layer type flags. More...
typedef QFlags< VectorLayerTypeFlag >	VectorLayerTypeFlags
	Vector layer type flags.
enum class	VectorProfileType : int { IndividualFeatures , ContinuousSurface }
	Types of elevation profiles to generate for vector sources. More...
enum class	VectorRenderingSimplificationFlag : int { NoSimplification = 0 , GeometrySimplification = 1 , AntialiasingSimplification = 2 , FullSimplification = 3 }
	Simplification flags for vector feature rendering. More...
typedef QFlags< VectorRenderingSimplificationFlag >	VectorRenderingSimplificationFlags
	Simplification flags for vector feature rendering.
enum class	VectorSimplificationAlgorithm : int { Distance = 0 , SnapToGrid = 1 , Visvalingam = 2 , SnappedToGridGlobal = 3 }
	Simplification algorithms for vector features. More...
enum class	VectorTemporalLimitMode : int { IncludeBeginExcludeEnd = 0 , IncludeBeginIncludeEnd }
	Mode for the handling of the limits of the filtering timeframe for vector features. More...
enum class	VectorTemporalMode : int {   FixedTemporalRange = 0 , FeatureDateTimeInstantFromField , FeatureDateTimeStartAndEndFromFields , FeatureDateTimeStartAndDurationFromFields ,   FeatureDateTimeStartAndEndFromExpressions , RedrawLayerOnly }
	Vector layer temporal feature modes. More...
typedef QFlags< VectorTileProviderCapability >	VectorTileProviderCapabilities
	Vector tile data provider capabilities.
enum class	VectorTileProviderCapability : int { ReadLayerMetadata = 1 << 1 }
	Enumeration with capabilities that vector tile data providers might implement. More...
enum class	VectorTileProviderFlag : int { AlwaysUseTileMatrixSetFromProvider = 1 << 1 }
	Flags for vector tile data providers. More...
typedef QFlags< VectorTileProviderFlag >	VectorTileProviderFlags
	Vector tile data provider flags.
enum class	VertexMarkerType : int { SemiTransparentCircle , Cross , NoMarker }
	Editing vertex markers, used for showing vertices during a edit operation. More...
enum class	VertexType : int { Segment = 1 , Curve = 2 }
	Types of vertex. More...
enum class	VerticalAxisInversion : int { Never , WhenDragging , Always }
	Vertical axis inversion options for 3D views. More...
enum class	ViewSyncModeFlag : int { Sync3DTo2D = 1 << 0 , Sync2DTo3D = 1 << 1 }
	Synchronization of 2D map canvas and 3D view. More...
typedef QFlags< ViewSyncModeFlag >	ViewSyncModeFlags
enum class	VolumeUnit : int {   CubicMeters , CubicFeet , CubicYards , Barrel ,   CubicDecimeter , Liters , GallonUS , CubicInch ,   CubicCentimeter , CubicDegrees , Unknown }
	Units of volume. More...
enum class	WkbType : quint32 {   Unknown = 0 , Point = 1 , LineString = 2 , Polygon = 3 ,   Triangle = 17 , MultiPoint = 4 , MultiLineString = 5 , MultiPolygon = 6 ,   GeometryCollection = 7 , CircularString = 8 , CompoundCurve = 9 , CurvePolygon = 10 ,   MultiCurve = 11 , MultiSurface = 12 , NoGeometry = 100 , PointZ = 1001 ,   LineStringZ = 1002 , PolygonZ = 1003 , TriangleZ = 1017 , MultiPointZ = 1004 ,   MultiLineStringZ = 1005 , MultiPolygonZ = 1006 , GeometryCollectionZ = 1007 , CircularStringZ = 1008 ,   CompoundCurveZ = 1009 , CurvePolygonZ = 1010 , MultiCurveZ = 1011 , MultiSurfaceZ = 1012 ,   PointM = 2001 , LineStringM = 2002 , PolygonM = 2003 , TriangleM = 2017 ,   MultiPointM = 2004 , MultiLineStringM = 2005 , MultiPolygonM = 2006 , GeometryCollectionM = 2007 ,   CircularStringM = 2008 , CompoundCurveM = 2009 , CurvePolygonM = 2010 , MultiCurveM = 2011 ,   MultiSurfaceM = 2012 , PointZM = 3001 , LineStringZM = 3002 , PolygonZM = 3003 ,   MultiPointZM = 3004 , MultiLineStringZM = 3005 , MultiPolygonZM = 3006 , GeometryCollectionZM = 3007 ,   CircularStringZM = 3008 , CompoundCurveZM = 3009 , CurvePolygonZM = 3010 , MultiCurveZM = 3011 ,   MultiSurfaceZM = 3012 , TriangleZM = 3017 , Point25D = 0x80000001 , LineString25D ,   Polygon25D , MultiPoint25D , MultiLineString25D , MultiPolygon25D }
	The WKB type describes the number of dimensions a geometry has. More...
enum class	ZonalStatistic : int {   Count = 1 , Sum = 2 , Mean = 4 , Median = 8 ,   StDev = 16 , Min = 32 , Max = 64 , Range = 128 ,   Minority = 256 , Majority = 512 , Variety = 1024 , Variance = 2048 ,   All = Count | Sum | Mean | Median | StDev | Max | Min | Range | Minority | Majority | Variety | Variance , Default = Count | Sum | Mean }
	Statistics to be calculated during a zonal statistics operation. More...
enum class	ZonalStatisticResult : int {   Success = 0 , LayerTypeWrong = 1 , LayerInvalid , RasterInvalid ,   RasterBandInvalid , FailedToCreateField = 8 , Canceled = 9 }
	Zonal statistics result codes. More...
typedef QFlags< ZonalStatistic >	ZonalStatistics
	Statistics to be calculated during a zonal statistics operation.

Public Member Functions
	Q_ENUM (GnssConstellation)
	Q_ENUM (GpsFixStatus)
	Q_ENUM (GpsNavigationStatus)
	Q_ENUM (InputControllerType)
	Q_ENUM (ProcessingAlgorithmFlag)
	Q_ENUM (ProcessingProviderFlag)
	Q_ENUM (ProfileExportType)
	Q_ENUM (ProfileSurfaceSymbology)
	Q_ENUM (ProviderStyleStorageCapability)
	Q_ENUM (ScaleToTileZoomLevelMethod)
	Q_ENUM (VectorProfileType)

Static Public Member Functions
static QString	defaultProjectScales ()
	A string with default project scales.
static QString	devVersion ()
	The development version.
static QString	geosVersion ()
	GEOS string version linked.
static int	geosVersionInt ()
	GEOS version number linked.
static int	geosVersionMajor ()
	GEOS Major version number linked.
static int	geosVersionMinor ()
	GEOS Minor version number linked.
static int	geosVersionPatch ()
	GEOS Patch version number linked.
static QString	releaseName ()
	Release name.
static QString	version ()
	Version string.
static int	versionInt ()
	Version number used for comparing versions using the "Check QGIS Version" function.

Static Public Attributes
static const double	DEFAULT_HIGHLIGHT_BUFFER_MM = 0.5
	Default highlight buffer in mm.
static const QColor	DEFAULT_HIGHLIGHT_COLOR = QColor( 255, 0, 0, 128 )
	Default highlight color.
static const double	DEFAULT_HIGHLIGHT_MIN_WIDTH_MM = 1.0
	Default highlight line/stroke minimum width in mm.
static const double	DEFAULT_M_COORDINATE = 0.0
	Default M coordinate value.
static const float	DEFAULT_MAPTOPIXEL_THRESHOLD = 1.0f
	Default threshold between map coordinates and device coordinates for map2pixel simplification.
static const double	DEFAULT_SEARCH_RADIUS_MM = 2.
	Identify search radius in mm.
static const double	DEFAULT_SNAP_TOLERANCE = 12.0
	Default snapping distance tolerance.
static const Qgis::MapToolUnit	DEFAULT_SNAP_UNITS = Qgis::MapToolUnit::Pixels
	Default snapping distance units.
static const double	DEFAULT_Z_COORDINATE = 0.0
	Default Z coordinate value.
static const char *	QGIS_DEV_VERSION = QGSVERSION
	The development version.
static const double	SCALE_PRECISION = 0.9999999999
	Fudge factor used to compare two scales.
static const double	UI_SCALE_FACTOR = 1
	UI scaling factor.

Detailed Description

The Qgis class provides global constants for use throughout the application.

Definition at line 53 of file qgis.h.

Member Typedef Documentation

AnnotationItemFlags

typedef QFlags< AnnotationItemFlag > Qgis::AnnotationItemFlags

Annotation item flags.

Definition at line 2100 of file qgis.h.

AnnotationItemGuiFlags

typedef QFlags< AnnotationItemGuiFlag > Qgis::AnnotationItemGuiFlags

Annotation item GUI flags.

Definition at line 2114 of file qgis.h.

BabelCommandFlags

typedef QFlags< BabelCommandFlag > Qgis::BabelCommandFlags

Babel command flags.

Definition at line 1684 of file qgis.h.

BabelFormatCapabilities

typedef QFlags< BabelFormatCapability > Qgis::BabelFormatCapabilities

Babel GPS format capabilities.

Definition at line 1669 of file qgis.h.

BrowserItemCapabilities

typedef QFlags< BrowserItemCapability > Qgis::BrowserItemCapabilities

Browser item capabilities.

Definition at line 719 of file qgis.h.

CoordinateTransformationFlags

typedef QFlags< CoordinateTransformationFlag > Qgis::CoordinateTransformationFlags

Coordinate transformation flags.

Since

QGIS 3.26

Definition at line 2309 of file qgis.h.

DatabaseProviderConnectionCapabilities2

typedef QFlags< DatabaseProviderConnectionCapability2 > Qgis::DatabaseProviderConnectionCapabilities2

Definition at line 4579 of file qgis.h.

DataItemProviderCapabilities

typedef QFlags< DataItemProviderCapability > Qgis::DataItemProviderCapabilities

Capabilities for data item providers.

Note

Prior to QGIS 3.36 this was available as QgsDataProvider::DataCapabilities

Since

QGIS 3.36

Definition at line 746 of file qgis.h.

DataProviderFlags

typedef QFlags< DataProviderFlag > Qgis::DataProviderFlags

Data provider flags.

Definition at line 1947 of file qgis.h.

DateTimeStatistics

typedef QFlags< DateTimeStatistic > Qgis::DateTimeStatistics

Statistics to be calculated for date/time values.

Since

QGIS 3.36. Prior to 3.36 this was available as QgsDateTimeStatisticalSummary::Statistic.

Definition at line 5034 of file qgis.h.

FeatureRequestFlags

typedef QFlags< FeatureRequestFlag > Qgis::FeatureRequestFlags

Flags for controlling feature requests.

Note

Prior to QGIS 3.36 this was available as QgsFeatureRequest::Flags

Since

QGIS 3.36

Definition at line 1845 of file qgis.h.

FieldConfigurationFlags

typedef QFlags< FieldConfigurationFlag > Qgis::FieldConfigurationFlags

Configuration flags for fields These flags are meant to be user-configurable and are not describing any information from the data provider.

Note

FieldConfigurationFlag are expressed in the negative forms so that default flags is NoFlag.

Since

QGIS 3.34

Definition at line 1403 of file qgis.h.

FileOperationFlags

typedef QFlags< FileOperationFlag > Qgis::FileOperationFlags

File operation flags.

Definition at line 1903 of file qgis.h.

GeometryValidityFlags

typedef QFlags< GeometryValidityFlag > Qgis::GeometryValidityFlags

Geometry validity flags.

Definition at line 1742 of file qgis.h.

GpsInformationComponents

typedef QFlags< GpsInformationComponent > Qgis::GpsInformationComponents

GPS information component.

Since

QGIS 3.30

Definition at line 1651 of file qgis.h.

HistoryProviderBackends

typedef QFlags< HistoryProviderBackend > Qgis::HistoryProviderBackends

Definition at line 2984 of file qgis.h.

LabelingFlags

typedef QFlags< LabelingFlag > Qgis::LabelingFlags

Flags that affect drawing and placement of labels.

Prior to QGIS 3.30 this was available as QgsLabelingEngineSettings::Flags

Since

QGIS 3.30

Definition at line 2438 of file qgis.h.

LabelLinePlacementFlags

typedef QFlags< LabelLinePlacementFlag > Qgis::LabelLinePlacementFlags

Line placement flags, which control how candidates are generated for a linear feature.

Note

Prior to QGIS 3.32 this was available as QgsLabeling::LinePlacementFlags

Since

QGIS 3.32

Definition at line 1041 of file qgis.h.

LabelPolygonPlacementFlags

typedef QFlags< LabelPolygonPlacementFlag > Qgis::LabelPolygonPlacementFlags

Polygon placement flags, which control how candidates are generated for a polygon feature.

Note

Prior to QGIS 3.32 this was available as QgsLabeling::PolygonPlacementFlags

Since

QGIS 3.32

Definition at line 1063 of file qgis.h.

LayerFilters

typedef QFlags< LayerFilter > Qgis::LayerFilters

Definition at line 151 of file qgis.h.

LayerTreeFilterFlags

typedef QFlags< LayerTreeFilterFlag > Qgis::LayerTreeFilterFlags

Layer tree filter flags.

Since

QGIS 3.32

Definition at line 3951 of file qgis.h.

LegendJsonRenderFlags

typedef QFlags< LegendJsonRenderFlag > Qgis::LegendJsonRenderFlags

Definition at line 3967 of file qgis.h.

LoadStyleFlags

typedef QFlags< LoadStyleFlag > Qgis::LoadStyleFlags

Flags for loading layer styles.

Since

QGIS 3.38

Definition at line 170 of file qgis.h.

MapLayerActionFlags

typedef QFlags< MapLayerActionFlag > Qgis::MapLayerActionFlags

Map layer action flags.

Prior to QGIS 3.30 this was available as QgsMapLayerAction::Flags

Since

QGIS 3.30

Definition at line 4031 of file qgis.h.

MapLayerActionTargets

typedef QFlags< MapLayerActionTarget > Qgis::MapLayerActionTargets

Map layer action targets.

Prior to QGIS 3.30 this was available as QgsMapLayerAction::Targets

Since

QGIS 3.30

Definition at line 4008 of file qgis.h.

MapLayerProperties

typedef QFlags< MapLayerProperty > Qgis::MapLayerProperties

Map layer properties.

Definition at line 1918 of file qgis.h.

MapLayerRendererFlags

typedef QFlags< MapLayerRendererFlag > Qgis::MapLayerRendererFlags

Flags which control how map layer renderers behave.

Since

QGIS 3.34

Definition at line 2393 of file qgis.h.

MapSettingsFlags

typedef QFlags< MapSettingsFlag > Qgis::MapSettingsFlags

Map settings flags.

Definition at line 2339 of file qgis.h.

MarkerLinePlacements

typedef QFlags< MarkerLinePlacement > Qgis::MarkerLinePlacements

Definition at line 2688 of file qgis.h.

PlotToolFlags

typedef QFlags< PlotToolFlag > Qgis::PlotToolFlags

Definition at line 3533 of file qgis.h.

ProcessingAlgorithmFlags

typedef QFlags< ProcessingAlgorithmFlag > Qgis::ProcessingAlgorithmFlags

Flags indicating how and when an algorithm operates and should be exposed to users.

Note

Prior to QGIS 3.36 this was available as QgsProcessingAlgorithm::Flags

Since

QGIS 3.36

Definition at line 3071 of file qgis.h.

ProcessingFeatureSourceDefinitionFlags

typedef QFlags< ProcessingFeatureSourceDefinitionFlag > Qgis::ProcessingFeatureSourceDefinitionFlags

Flags which control behavior for a Processing feature source.

Note

Prior to QGIS 3.36 this was available as QgsProcessingFeatureSourceDefinition::Flags

Since

QGIS 3.36

Definition at line 3125 of file qgis.h.

ProcessingFeatureSourceFlags

typedef QFlags< ProcessingFeatureSourceFlag > Qgis::ProcessingFeatureSourceFlags

Flags which control how QgsProcessingFeatureSource fetches features.

Note

Prior to QGIS 3.36 this was available as QgsProcessingFeatureSource::Flags

Since

QGIS 3.36

Definition at line 3148 of file qgis.h.

ProcessingParameterFlags

typedef QFlags< ProcessingParameterFlag > Qgis::ProcessingParameterFlags

Flags which dictate the behavior of Processing parameters.

Note

Prior to QGIS 3.36 this was available as QgsProcessingParameterDefinition::Flags

Since

QGIS 3.36

Definition at line 3203 of file qgis.h.

ProcessingParameterTypeFlags

typedef QFlags< ProcessingParameterTypeFlag > Qgis::ProcessingParameterTypeFlags

Flags which dictate the behavior of Processing parameter types.

Each parameter type can offer a number of additional flags to fine tune its behavior and capabilities.

Note

Prior to QGIS 3.36 this was available as QgsProcessingParameterType::ParameterFlags

Since

QGIS 3.36

Definition at line 3177 of file qgis.h.

ProcessingProviderFlags

typedef QFlags< ProcessingProviderFlag > Qgis::ProcessingProviderFlags

Flags indicating how and when an processing provider operates and should be exposed to users.

Note

Prior to QGIS 3.36 this was available as QgsProcessingProvider::Flags

Since

QGIS 3.36

Definition at line 3034 of file qgis.h.

ProfileGeneratorFlags

typedef QFlags< ProfileGeneratorFlag > Qgis::ProfileGeneratorFlags

Definition at line 3632 of file qgis.h.

ProjectCapabilities

typedef QFlags< ProjectCapability > Qgis::ProjectCapabilities

Flags which control project capabilities.

Since

QGIS 3.26.1

Definition at line 3750 of file qgis.h.

ProjectFlags

typedef QFlags< ProjectFlag > Qgis::ProjectFlags

Definition at line 3520 of file qgis.h.

ProjectReadFlags

typedef QFlags< ProjectReadFlag > Qgis::ProjectReadFlags

Project load flags.

Note

Prior to QGIS 3.26 this was available as QgsProject::ReadFlags.

Since

QGIS 3.26

Definition at line 3728 of file qgis.h.

ProviderStyleStorageCapabilities

typedef QFlags< ProviderStyleStorageCapability > Qgis::ProviderStyleStorageCapabilities

Definition at line 4594 of file qgis.h.

RasterBandStatistics

typedef QFlags< RasterBandStatistic > Qgis::RasterBandStatistics

Statistics to be calculated for raster bands.

Since

QGIS 3.36. Prior to 3.36 this was available as QgsRasterBandStats::Stats.

Definition at line 5090 of file qgis.h.

RasterInterfaceCapabilities

typedef QFlags< RasterInterfaceCapability > Qgis::RasterInterfaceCapabilities

Raster interface capabilities.

Since

QGIS 3.38

Definition at line 4218 of file qgis.h.

RasterProviderCapabilities

typedef QFlags< RasterProviderCapability > Qgis::RasterProviderCapabilities

Raster data provider capabilities.

Note

Prior to QGIS 3.38 this was available as QgsRasterDataProvider::ProviderCapabilities

Since

QGIS 3.38

Definition at line 4251 of file qgis.h.

RasterRendererCapabilities

typedef QFlags< RasterRendererCapability > Qgis::RasterRendererCapabilities

Raster renderer capabilities.

Since

QGIS 3.38

Definition at line 1245 of file qgis.h.

RasterRendererFlags

typedef QFlags< RasterRendererFlag > Qgis::RasterRendererFlags

Flags which control behavior of raster renderers.

Since

QGIS 3.28

Definition at line 1224 of file qgis.h.

RasterTemporalCapabilityFlags

typedef QFlags< RasterTemporalCapabilityFlag > Qgis::RasterTemporalCapabilityFlags

Flags for raster layer temporal capabilities.

Since

QGIS 3.28

Definition at line 2277 of file qgis.h.

RelationshipCapabilities

typedef QFlags< RelationshipCapability > Qgis::RelationshipCapabilities

Relationship capabilities.

Since

QGIS 3.30

Definition at line 3849 of file qgis.h.

RenderContextFlags

typedef QFlags< RenderContextFlag > Qgis::RenderContextFlags

Render context flags.

Definition at line 2372 of file qgis.h.

ScriptLanguageCapabilities

typedef QFlags< ScriptLanguageCapability > Qgis::ScriptLanguageCapabilities

Script language capabilities.

Since

QGIS 3.32

Definition at line 3919 of file qgis.h.

SelectionFlags

typedef QFlags< SelectionFlag > Qgis::SelectionFlags

Flags which control feature selection behavior.

Since

QGIS 3.28

Definition at line 1474 of file qgis.h.

SettingsOptions

typedef QFlags< SettingsOption > Qgis::SettingsOptions

Definition at line 539 of file qgis.h.

SettingsTreeNodeOptions

typedef QFlags< SettingsTreeNodeOption > Qgis::SettingsTreeNodeOptions

Definition at line 481 of file qgis.h.

SldExportOptions

typedef QFlags< SldExportOption > Qgis::SldExportOptions

Definition at line 512 of file qgis.h.

SnappingTypes

typedef QFlags< SnappingType > Qgis::SnappingTypes

Snapping types.

Definition at line 570 of file qgis.h.

SqlLayerDefinitionCapabilities

typedef QFlags< SqlLayerDefinitionCapability > Qgis::SqlLayerDefinitionCapabilities

SQL layer definition capabilities.

Definition at line 850 of file qgis.h.

Statistics

typedef QFlags< Statistic > Qgis::Statistics

Statistics to be calculated for generic values.

Since

QGIS 3.36. Prior to 3.36 this was available as QgsStatisticalSummary::Statistics.

Definition at line 5009 of file qgis.h.

StringStatistics

typedef QFlags< StringStatistic > Qgis::StringStatistics

Statistics to be calculated for string values.

Since

QGIS 3.36. Prior to 3.36 this was available as QgsStringStatisticalSummary::Statistic.

Definition at line 5063 of file qgis.h.

SublayerFlags

typedef QFlags< SublayerFlag > Qgis::SublayerFlags

Sublayer flags.

Definition at line 1143 of file qgis.h.

SublayerQueryFlags

typedef QFlags< SublayerQueryFlag > Qgis::SublayerQueryFlags

Sublayer query flags.

Definition at line 1129 of file qgis.h.

SymbolFlags

typedef QFlags< SymbolFlag > Qgis::SymbolFlags

Symbol flags.

Definition at line 610 of file qgis.h.

SymbolLayerFlags

typedef QFlags< SymbolLayerFlag > Qgis::SymbolLayerFlags

Symbol layer flags.

Definition at line 642 of file qgis.h.

SymbolLayerUserFlags

typedef QFlags< SymbolLayerUserFlag > Qgis::SymbolLayerUserFlags

Symbol layer user flags.

Since

QGIS 3.34

Definition at line 665 of file qgis.h.

SymbolPreviewFlags

typedef QFlags< SymbolPreviewFlag > Qgis::SymbolPreviewFlags

Symbol preview flags.

Definition at line 624 of file qgis.h.

SymbolRenderHints

typedef QFlags< SymbolRenderHint > Qgis::SymbolRenderHints

Symbol render hints.

Definition at line 584 of file qgis.h.

TextRendererFlags

typedef QFlags< TextRendererFlag > Qgis::TextRendererFlags

Definition at line 2906 of file qgis.h.

TiledSceneProviderCapabilities

typedef QFlags< TiledSceneProviderCapability > Qgis::TiledSceneProviderCapabilities

Tiled scene data provider capabilities.

Since

QGIS 3.34

Definition at line 4785 of file qgis.h.

TiledSceneRendererFlags

typedef QFlags< TiledSceneRendererFlag > Qgis::TiledSceneRendererFlags

Flags which control how tiled scene 2D renderers behave.

Since

QGIS 3.34

Definition at line 4867 of file qgis.h.

TiledSceneRequestFlags

typedef QFlags< TiledSceneRequestFlag > Qgis::TiledSceneRequestFlags

Flags which control how tiled scene requests behave.

Since

QGIS 3.34

Definition at line 4845 of file qgis.h.

VectorDataProviderAttributeEditCapabilities

typedef QFlags< VectorDataProviderAttributeEditCapability > Qgis::VectorDataProviderAttributeEditCapabilities

Attribute editing capabilities which may be supported by vector data providers.

Since

QGIS 3.32

Definition at line 412 of file qgis.h.

VectorFileWriterCapabilities

typedef QFlags< VectorFileWriterCapability > Qgis::VectorFileWriterCapabilities

Capabilities supported by a QgsVectorFileWriter object.

Since

QGIS 3.32

Definition at line 834 of file qgis.h.

VectorLayerTypeFlags

typedef QFlags< VectorLayerTypeFlag > Qgis::VectorLayerTypeFlags

Vector layer type flags.

Definition at line 332 of file qgis.h.

VectorRenderingSimplificationFlags

typedef QFlags< VectorRenderingSimplificationFlag > Qgis::VectorRenderingSimplificationFlags

Simplification flags for vector feature rendering.

Note

Prior to QGIS 3.38 this was available as QgsVectorSimplifyMethod::SimplifyHints

Since

QGIS 3.38

Definition at line 2592 of file qgis.h.

VectorTileProviderCapabilities

typedef QFlags< VectorTileProviderCapability > Qgis::VectorTileProviderCapabilities

Vector tile data provider capabilities.

Since

QGIS 3.32

Definition at line 4752 of file qgis.h.

VectorTileProviderFlags

typedef QFlags< VectorTileProviderFlag > Qgis::VectorTileProviderFlags

Vector tile data provider flags.

Since

QGIS 3.32

Definition at line 4734 of file qgis.h.

ViewSyncModeFlags

typedef QFlags< ViewSyncModeFlag > Qgis::ViewSyncModeFlags

Definition at line 2958 of file qgis.h.

ZonalStatistics

typedef QFlags< ZonalStatistic > Qgis::ZonalStatistics

Statistics to be calculated during a zonal statistics operation.

Since

QGIS 3.36. Prior to 3.36 this was available as QgsZonalStatistics::Statistic.

Definition at line 4922 of file qgis.h.

Member Enumeration Documentation

ActionStart

enum class Qgis::ActionStart : int

strong

Enum to determine when an operation would begin.

Since

QGIS 3.22

Enumerator
Deferred	Do not start immediately the action.
Immediate	Action will start immediately.

Definition at line 893 of file qgis.h.

ActionType

enum class Qgis::ActionType : int

strong

Action types.

Prior to QGIS 3.30 this was available as QgsActionMenu::ActionType

Since

QGIS 3.30

Enumerator
Invalid	Invalid.
MapLayerAction	Standard actions (defined by core or plugins), corresponds to QgsMapLayerAction class.
AttributeAction	Custom actions (manually defined in layer properties), corresponds to QgsAction class.

Definition at line 3977 of file qgis.h.

Aggregate

enum class Qgis::Aggregate : int

strong

Available aggregates to calculate.

Not all aggregates are available for all field types.

Since

QGIS 3.36. Prior to 3.36 this was available as QgsAggregateCalculator::Aggregate.

Enumerator
Count	Count.
CountDistinct	Number of distinct values.
CountMissing	Number of missing (null) values.
Min	Min of values.
Max	Max of values.
Sum	Sum of values.
Mean	Mean of values (numeric fields only)
Median	Median of values (numeric fields only)
StDev	Standard deviation of values (numeric fields only)
StDevSample	Sample standard deviation of values (numeric fields only)
Range	Range of values (max - min) (numeric and datetime fields only)
Minority	Minority of values.
Majority	Majority of values.
FirstQuartile	First quartile (numeric fields only)
ThirdQuartile	Third quartile (numeric fields only)
InterQuartileRange	Inter quartile range (IQR) (numeric fields only)
StringMinimumLength	Minimum length of string (string fields only)
StringMaximumLength	Maximum length of string (string fields only)
StringConcatenate	Concatenate values with a joining string (string fields only). Specify the delimiter using setDelimiter().
GeometryCollect	Create a multipart geometry from aggregated geometries.
ArrayAggregate	Create an array of values.
StringConcatenateUnique	Concatenate unique values with a joining string (string fields only). Specify the delimiter using setDelimiter().

Definition at line 4948 of file qgis.h.

AltitudeBinding

enum class Qgis::AltitudeBinding : int

strong

Altitude binding.

Since

QGIS 3.26

Enumerator
Vertex	Clamp every vertex of feature.
Centroid	Clamp just centroid of feature.

Definition at line 3415 of file qgis.h.

AltitudeClamping

enum class Qgis::AltitudeClamping : int

strong

Altitude clamping.

Since

QGIS 3.26

Enumerator
Absolute	Elevation is taken directly from feature and is independent of terrain height (final elevation = feature elevation)
Relative	Elevation is relative to terrain height (final elevation = terrain elevation + feature elevation)
Terrain	Elevation is clamped to terrain (final elevation = terrain elevation)

Definition at line 3402 of file qgis.h.

AngleUnit

enum class Qgis::AngleUnit : int

strong

Units of angles.

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes::AngleUnit.

Since

QGIS 3.30

Enumerator
Degrees	Degrees.
Radians	Square kilometers.
Gon	Gon/gradian.
MinutesOfArc	Minutes of arc.
SecondsOfArc	Seconds of arc.
Turn	Turn/revolutions.
MilliradiansSI	Angular milliradians (SI definition, 1/1000 of radian)
MilNATO	Angular mil (NATO definition, 6400 mil = 2PI radians)
Unknown	Unknown angle unit.

Definition at line 4443 of file qgis.h.

AngularDirection

enum class Qgis::AngularDirection : int

strong

Angular directions.

Since

QGIS 3.24

Enumerator
Clockwise	Clockwise direction.
CounterClockwise	Counter-clockwise direction.
NoOrientation	Unknown orientation or sentinel value.

Definition at line 2926 of file qgis.h.

AnimationState

enum class Qgis::AnimationState : int

strong

Animation states.

Note

Prior to QGIS 3.36 this was available as QgsTemporalNavigationObject::AnimationState

Since

QGIS 3.36

Enumerator
Forward	Animation is playing forward.
Reverse	Animation is playing in reverse.
Idle	Animation is paused.

Definition at line 2165 of file qgis.h.

AnnotationItemEditOperationResult

enum class Qgis::AnnotationItemEditOperationResult : int

strong

Results from an edit operation on an annotation item.

Since

QGIS 3.22

Enumerator
Success	Item was modified successfully.
Invalid	Operation has invalid parameters for the item, no change occurred.
ItemCleared	The operation results in the item being cleared, and the item should be removed from the layer as a result.

Definition at line 2134 of file qgis.h.

AnnotationItemFlag

enum class Qgis::AnnotationItemFlag : int

strong

Flags for annotation items.

Since

QGIS 3.22

Enumerator
ScaleDependentBoundingBox	Item's bounding box will vary depending on map scale.

Definition at line 2095 of file qgis.h.

AnnotationItemGuiFlag

enum class Qgis::AnnotationItemGuiFlag : int

strong

Flags for controlling how an annotation item behaves in the GUI.

Since

QGIS 3.22

Enumerator
FlagNoCreationTools	Do not show item creation tools for the item type.

Definition at line 2109 of file qgis.h.

AnnotationItemNodeType

enum class Qgis::AnnotationItemNodeType : int

strong

Annotation item node types.

Since

QGIS 3.22

Enumerator
VertexHandle	Node is a handle for manipulating vertices.

Definition at line 2123 of file qgis.h.

ArcGisRestServiceType

enum class Qgis::ArcGisRestServiceType : int

strong

Available ArcGIS REST service types.

Note

Prior to QGIS 3.26 this was available as QgsArcGisPortalUtils::ItemType.

Since

QGIS 3.28

Enumerator
FeatureServer	FeatureServer.
MapServer	MapServer.
ImageServer	ImageServer.
GlobeServer	GlobeServer.
GPServer	GPServer.
GeocodeServer	GeocodeServer.
Unknown	Other unknown/unsupported type.

Definition at line 3777 of file qgis.h.

AreaUnit

enum class Qgis::AreaUnit : int

strong

Units of area.

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes::AreaUnit.

Since

QGIS 3.30

Enumerator
SquareMeters	Square meters.
SquareKilometers	Square kilometers.
SquareFeet	Square feet.
SquareYards	Square yards.
SquareMiles	Square miles.
Hectares	Hectares.
Acres	Acres.
SquareNauticalMiles	Square nautical miles.
SquareDegrees	Square degrees, for planar geographic CRS area measurements.
SquareCentimeters	Square centimeters.
SquareMillimeters	Square millimeters.
SquareInches	Square inches (since QGIS 3.32)
Unknown	Unknown areal unit.

Definition at line 4395 of file qgis.h.

AttributeActionType

enum class Qgis::AttributeActionType : int

strong

Attribute action types.

Prior to QGIS 3.30 this was available as QgsAction::ActionType

Since

QGIS 3.30

Enumerator
Generic	Generic.
GenericPython	Python.
Mac	MacOS specific.
Windows	Windows specific.
Unix	Unix specific.
OpenUrl	Open URL action.
SubmitUrlEncoded	POST data to an URL, using "application/x-www-form-urlencoded" or "application/json" if the body is valid JSON. Since QGIS 3.24
SubmitUrlMultipart	POST data to an URL using "multipart/form-data". Since QGIS 3.24

Definition at line 4041 of file qgis.h.

AttributeEditorContainerType

enum class Qgis::AttributeEditorContainerType : int

strong

Attribute editor container types.

Since

QGIS 3.32

Enumerator
GroupBox	A group box.
Tab	A tab widget.
Row	A row of editors (horizontal layout)

Definition at line 4636 of file qgis.h.

AttributeEditorType

enum class Qgis::AttributeEditorType : int

strong

Attribute editor types.

Note

Prior to QGIS 3.32 this was available as QgsAttributeEditorElement::AttributeEditorType.

Since

QGIS 3.32

Enumerator
Container	A container.
Field	A field.
Relation	A relation.
QmlElement	A QML element.
HtmlElement	A HTML element.
Action	A layer action element (since QGIS 3.22)
TextElement	A text element (since QGIS 3.30)
SpacerElement	A spacer element (since QGIS 3.30)
Invalid	Invalid.

Definition at line 4617 of file qgis.h.

AttributeFormLayout

enum class Qgis::AttributeFormLayout : int

strong

Available form types for layout of the attribute form editor.

Note

Prior to QGIS 3.32 this was available as QgsEditFormConfig::EditorLayout.

Since

QGIS 3.32

Enumerator
AutoGenerated	Autogenerate a simple tabular layout for the form.
DragAndDrop	"Drag and drop" layout. Needs to be configured.
UiFile	Load a .ui file for the layout. Needs to be configured.

Definition at line 4651 of file qgis.h.

AttributeFormPythonInitCodeSource

enum class Qgis::AttributeFormPythonInitCodeSource : int

strong

The Python init code source for attribute forms.

Note

Prior to QGIS 3.32 this was available as QgsEditFormConfig::PythonInitCodeSource.

Since

QGIS 3.32

Enumerator
NoSource	Do not use Python code at all.
File	Load the Python code from an external file.
Dialog	Use the Python code provided in the dialog.
Environment	Use the Python code available in the Python environment.

Definition at line 4681 of file qgis.h.

AttributeFormSuppression

enum class Qgis::AttributeFormSuppression : int

strong

Available form types for layout of the attribute form editor.

Note

Prior to QGIS 3.32 this was available as QgsEditFormConfig::FeatureFormSuppress.

Since

QGIS 3.32

Enumerator
Default	Use the application-wide setting.
On	Always suppress feature form.
Off	Never suppress feature form.

Definition at line 4666 of file qgis.h.

AutoRefreshMode

enum class Qgis::AutoRefreshMode : int

strong

Map layer automatic refresh modes.

Since

QGIS 3.34

Enumerator
Disabled	Automatic refreshing is disabled.
ReloadData	Reload data (and draw the new data)
RedrawOnly	Redraw current data only.

Definition at line 1927 of file qgis.h.

AvoidIntersectionsMode

enum class Qgis::AvoidIntersectionsMode : int

strong

Flags which control how intersections of pre-existing feature are handled when digitizing new features.

Note

Prior to QGIS 3.26 this was available as QgsProject::AvoidIntersectionsMode

Since

QGIS 3.26

Enumerator
AllowIntersections	Overlap with any feature allowed when digitizing new features.
AvoidIntersectionsCurrentLayer	Overlap with features from the active layer when digitizing new features not allowed.
AvoidIntersectionsLayers	Overlap with features from a specified list of layers when digitizing new features not allowed.

Definition at line 3680 of file qgis.h.

Axis

enum class Qgis::Axis : int

strong

Cartesian axes.

Since

QGIS 3.34

Enumerator
X	X-axis.
Y	Y-axis.
Z	Z-axis.

Definition at line 2082 of file qgis.h.

BabelCommandFlag

enum class Qgis::BabelCommandFlag : int

strong

Babel command flags, which control how commands and arguments are generated for executing GPSBabel processes.

Since

QGIS 3.22

Enumerator
QuoteFilePaths	File paths should be enclosed in quotations and escaped.

Definition at line 1679 of file qgis.h.

BabelFormatCapability

enum class Qgis::BabelFormatCapability : int

strong

Babel GPS format capabilities.

Since

QGIS 3.22

Enumerator
Import	Format supports importing.
Export	Format supports exporting.
Waypoints	Format supports waypoints.
Routes	Format supports routes.
Tracks	Format supports tracks.

Definition at line 1660 of file qgis.h.

BetweenLineConstraint

enum class Qgis::BetweenLineConstraint : int

strong

Between line constraints which can be enabled.

Since

QGIS 3.26

Enumerator
NoConstraint	No additional constraint.
Perpendicular	Perpendicular.
Parallel	Parallel.

Definition at line 3468 of file qgis.h.

BlendMode

enum class Qgis::BlendMode : int

strong

Blending modes defining the available composition modes that can be used when painting.

Note

Prior to QGIS 3.30 this was available as QgsPainting::BlendMode.

Since

QGIS 3.30

Enumerator
Normal	Normal.
Lighten	Lighten.
Screen	Screen.
Dodge	Dodge.
Addition	Addition.
Darken	Darken.
Multiply	Multiple.
Burn	Burn.
Overlay	Overlay.
SoftLight	Soft light.
HardLight	Hard light.
Difference	Difference.
Subtract	Subtract.
Source	Source.
DestinationOver	Destination over.
Clear	Clear.
Destination	Destination.
SourceIn	Source in.
DestinationIn	Destination in.
SourceOut	Source out.
DestinationOut	Destination out.
SourceAtop	Source atop.
DestinationAtop	Destination atop.
Xor	XOR.

Definition at line 4274 of file qgis.h.

BrowserDirectoryMonitoring

enum class Qgis::BrowserDirectoryMonitoring : int

strong

Browser directory item monitoring switches.

Since

QGIS 3.20

Enumerator
Default	Use default logic to determine whether directory should be monitored.
NeverMonitor	Never monitor the directory, regardless of the default logic.
AlwaysMonitor	Always monitor the directory, regardless of the default logic.

Definition at line 778 of file qgis.h.

BrowserItemCapability

enum class Qgis::BrowserItemCapability : int

strong

Browser item capabilities.

Since

QGIS 3.20

Enumerator
NoCapabilities	Item has no capabilities.
SetCrs	Can set CRS on layer or group of layers. deprecated since QGIS 3.6 – no longer used by QGIS and will be removed in QGIS 4.0.
Fertile	Can create children. Even items without this capability may have children, but cannot create them, it means that children are created by item ancestors.
Fast	CreateChildren() is fast enough to be run in main thread when refreshing items, most root items (wms,wfs,wcs,postgres...) are considered fast because they are reading data only from QgsSettings.
Collapse	The collapse/expand status for this items children should be ignored in order to avoid undesired network connections (wms etc.)
Rename	Item can be renamed.
Delete	Item can be deleted.
ItemRepresentsFile	Item's path() directly represents a file on disk (since QGIS 3.22)
RefreshChildrenWhenItemIsRefreshed	When the item is refreshed, all its populated children will also be refreshed in turn (since QGIS 3.26)

Definition at line 705 of file qgis.h.

BrowserItemState

enum class Qgis::BrowserItemState : int

strong

Browser item states.

Since

QGIS 3.20

Enumerator
NotPopulated	Children not yet created.
Populating	Creating children in separate thread (populating or refreshing)
Populated	Children created.

Definition at line 692 of file qgis.h.

BrowserItemType

enum class Qgis::BrowserItemType : int

strong

Browser item types.

Since

QGIS 3.20

Enumerator
Collection	A collection of items.
Directory	Represents a file directory.
Layer	Represents a map layer.
Error	Contains an error message.
Favorites	Represents a favorite item.
Project	Represents a QGIS project.
Custom	Custom item type.
Fields	Collection of fields.
Field	Vector layer field.

Definition at line 673 of file qgis.h.

BrowserLayerType

enum class Qgis::BrowserLayerType : int

strong

Browser item layer types.

Since

QGIS 3.20

Enumerator
NoType	No type.
Vector	Generic vector layer.
Raster	Raster layer.
Point	Vector point layer.
Line	Vector line layer.
Polygon	Vector polygon layer.
TableLayer	Vector non-spatial layer.
Database	Database layer.
Table	Database table.
Plugin	Plugin based layer.
Mesh	Mesh layer.
VectorTile	Vector tile layer.
PointCloud	Point cloud layer.
TiledScene	Tiled scene layer (since QGIS 3.34)

Definition at line 754 of file qgis.h.

BufferSide

enum class Qgis::BufferSide : int

strong

Side of line to buffer.

Since

QGIS 3.22

Enumerator
Left	Buffer to left of line.
Right	Buffer to right of line.

Definition at line 1762 of file qgis.h.

CadConstraintType

enum class Qgis::CadConstraintType : int

strong

Advanced digitizing constraint type.

Since

QGIS 3.32

Enumerator
Generic	Generic value.
Angle	Angle value.
Distance	Distance value.
XCoordinate	X Coordinate value.
YCoordinate	Y Coordinate value.
ZValue	Z value.
MValue	M value.

Definition at line 3494 of file qgis.h.

Capitalization

enum class Qgis::Capitalization : int

strong

String capitalization options.

Note

Prior to QGIS 3.24 this was available as QgsStringUtils::Capitalization

Since

QGIS 3.24

Enumerator
MixedCase	Mixed case, ie no change.
AllUppercase	Convert all characters to uppercase.
AllLowercase	Convert all characters to lowercase.
ForceFirstLetterToCapital	Convert just the first letter of each word to uppercase, leave the rest untouched.
SmallCaps	Mixed case small caps (since QGIS 3.24)
TitleCase	Simple title case conversion - does not fully grammatically parse the text and uses simple rules only. Note that this method does not convert any characters to lowercase, it only uppercases required letters. Callers must ensure that input strings are already lowercased.
UpperCamelCase	Convert the string to upper camel case. Note that this method does not unaccent characters.
AllSmallCaps	Force all characters to small caps (since QGIS 3.24)

Definition at line 2883 of file qgis.h.

CaptureTechnique

enum class Qgis::CaptureTechnique : int

strong

Capture technique.

Since

QGIS 3.26

Enumerator
StraightSegments	Default capture mode - capture occurs with straight line segments.
CircularString	Capture in circular strings.
Streaming	Streaming points digitizing mode (points are automatically added as the mouse cursor moves).
Shape	Digitize shapes.

Definition at line 312 of file qgis.h.

ContentStatus

enum class Qgis::ContentStatus : int

strong

Status for fetched or stored content.

Since

QGIS 3.22

Enumerator
NotStarted	Content fetching/storing has not started yet.
Running	Content fetching/storing is in progress.
Finished	Content fetching/storing is finished and successful.
Failed	Content fetching/storing has failed.
Canceled	Content fetching/storing has been canceled.

Definition at line 1511 of file qgis.h.

CoordinateDisplayType

enum class Qgis::CoordinateDisplayType : int

strong

Formats for displaying coordinates.

Since

QGIS 3.28

Enumerator
MapCrs	Map CRS.
MapGeographic	Map Geographic CRS equivalent (stays unchanged if the map CRS is geographic)
CustomCrs	Custom CRS.

Definition at line 3857 of file qgis.h.

CoordinateOrder

enum class Qgis::CoordinateOrder : int

strong

Order of coordinates.

Since

QGIS 3.26

Enumerator
Default	Respect the default axis ordering for the CRS, as defined in the CRS's parameters.
XY	Easting/Northing (or Longitude/Latitude for geographic CRS)
YX	Northing/Easting (or Latitude/Longitude for geographic CRS)

Definition at line 2033 of file qgis.h.

CoordinateTransformationFlag

enum class Qgis::CoordinateTransformationFlag : int

strong

Flags which adjust the coordinate transformations behave.

Since

QGIS 3.26

Enumerator
BallparkTransformsAreAppropriate	Indicates that approximate "ballpark" results are appropriate for this coordinate transform. See QgsCoordinateTransform::setBallparkTransformsAreAppropriate() for further details.
IgnoreImpossibleTransformations	Indicates that impossible transformations (such as those which attempt to transform between two different celestial bodies) should be silently handled and marked as invalid. See QgsCoordinateTransform::isTransformationPossible() and QgsCoordinateTransform::isValid().

Definition at line 2297 of file qgis.h.

CoverageValidityResult

enum class Qgis::CoverageValidityResult : int

strong

Coverage validity results.

Since

QGIS 3.36

Enumerator
Invalid	Coverage is invalid. Invalidity includes polygons that overlap, that have gaps smaller than the gap width, or non-polygonal entries in the input collection.
Valid	Coverage is valid.
Error	An exception occurred while determining validity.

Definition at line 1800 of file qgis.h.

CrsAxisDirection

enum class Qgis::CrsAxisDirection : int

strong

Coordinate reference system axis directions.

From "Geographic information — Well-known text representation of coordinate reference systems", section 7.5.1.

Since

QGIS 3.26

Enumerator
North	North.
NorthNorthEast	North North East.
NorthEast	North East.
EastNorthEast	East North East.
East	East.
EastSouthEast	East South East.
SouthEast	South East.
SouthSouthEast	South South East.
South	South.
SouthSouthWest	South South West.
SouthWest	South West.
WestSouthWest	West South West.
West	West.
WestNorthWest	West North West.
NorthWest	North West.
NorthNorthWest	North North West.
GeocentricX	Geocentric (X)
GeocentricY	Geocentric (Y)
GeocentricZ	Geocentric (Z)
Up	Up.
Down	Down.
Forward	Forward.
Aft	Aft.
Port	Port.
Starboard	Starboard.
Clockwise	Clockwise.
CounterClockwise	Counter clockwise.
ColumnPositive	Column positive.
ColumnNegative	Column negative.
RowPositive	Row positive.
RowNegative	Row negative.
DisplayRight	Display right.
DisplayLeft	Display left.
DisplayUp	Display up.
DisplayDown	Display down.
Future	Future.
Past	Past.
Towards	Towards.
AwayFrom	Away from.
Unspecified	Unspecified.

Definition at line 1983 of file qgis.h.

CrsDefinitionFormat

enum class Qgis::CrsDefinitionFormat : int

strong

CRS definition formats.

Since

QGIS 3.24

Enumerator
Wkt	WKT format (always recommended over proj string format)
Proj	Proj string format.

Definition at line 3316 of file qgis.h.

CrsIdentifierType

enum class Qgis::CrsIdentifierType : int

strong

Available identifier string types for representing coordinate reference systems.

Note

Prior to QGIS 3.36 this was available as QgsCoordinateReferenceSystem::IdentifierType

Since

QGIS 3.36

Enumerator
ShortString	A heavily abbreviated string, for use when a compact representation is required.
MediumString	A medium-length string, recommended for general purpose use.
FullString	Full definition – possibly a very lengthy string, e.g. with no truncation of custom WKT definitions.

Definition at line 2048 of file qgis.h.

CrsType

enum class Qgis::CrsType : int

strong

Coordinate reference system types.

Contains a subset of Proj's PJ_TYPE enum, specifically the types which relate to CRS types.

Since

QGIS 3.34

Enumerator
Unknown	Unknown type.
Geodetic	Geodetic CRS.
Geocentric	Geocentric CRS.
Geographic2d	2D geographic CRS
Geographic3d	3D geopraphic CRS
Vertical	Vertical CRS.
Projected	Projected CRS.
Compound	Compound (horizontal + vertical) CRS.
Temporal	Temporal CRS.
Engineering	Engineering CRS.
Bound	Bound CRS.
Other	Other type.
DerivedProjected	Derived projected CRS.

Definition at line 1958 of file qgis.h.

CrsWktVariant

enum class Qgis::CrsWktVariant : int

strong

Coordinate reference system WKT formatting variants.

Note

Prior to QGIS 3.36 this was available as QgsCoordinateReferenceSystem::WktVariant

Since

QGIS 3.36

Enumerator
Wkt1Gdal	WKT1 as traditionally output by GDAL, deriving from OGC 01-009. A notable departure from WKT1_GDAL with respect to OGC 01-009 is that in WKT1_GDAL, the unit of the PRIMEM value is always degrees.
Wkt1Esri	WKT1 as traditionally output by ESRI software, deriving from OGC 99-049.
Wkt2_2015	Full WKT2 string, conforming to ISO 19162:2015(E) / OGC 12-063r5 with all possible nodes and new keyword names.
Wkt2_2015Simplified	Same as WKT2_2015 with the following exceptions: UNIT keyword used. ID node only on top element. No ORDER element in AXIS element. PRIMEM node omitted if it is Greenwich. ELLIPSOID.UNIT node omitted if it is UnitOfMeasure::METRE. PARAMETER.UNIT / PRIMEM.UNIT omitted if same as AXIS. AXIS.UNIT omitted and replaced by a common GEODCRS.UNIT if they are all the same on all axis.
Wkt2_2019	Full WKT2 string, conforming to ISO 19162:2019 / OGC 18-010, with all possible nodes and new keyword names. Non-normative list of differences: WKT2_2019 uses GEOGCRS / BASEGEOGCRS keywords for GeographicCRS.
Wkt2_2019Simplified	WKT2_2019 with the simplification rule of WKT2_SIMPLIFIED.
Preferred	Preferred format, matching the most recent WKT ISO standard. Currently an alias to WKT2_2019, but may change in future versions.
PreferredSimplified	Preferred simplified format, matching the most recent WKT ISO standard. Currently an alias to WKT2_2019_SIMPLIFIED, but may change in future versions.
PreferredGdal	Preferred format for conversion of CRS to WKT for use with the GDAL library.

Definition at line 2063 of file qgis.h.

DashPatternLineEndingRule

enum class Qgis::DashPatternLineEndingRule : int

strong

Dash pattern line ending rules.

Since

QGIS 3.24

Enumerator
NoRule	No special rule.
FullDash	Start or finish the pattern with a full dash.
HalfDash	Start or finish the pattern with a half length dash.
FullGap	Start or finish the pattern with a full gap.
HalfGap	Start or finish the pattern with a half length gap.

Definition at line 2796 of file qgis.h.

DashPatternSizeAdjustment

enum class Qgis::DashPatternSizeAdjustment : int

strong

Dash pattern size adjustment options.

Since

QGIS 3.24

Enumerator
ScaleBothDashAndGap	Both the dash and gap lengths are adjusted equally.
ScaleDashOnly	Only dash lengths are adjusted.
ScaleGapOnly	Only gap lengths are adjusted.

Definition at line 2811 of file qgis.h.

DatabaseProviderConnectionCapability2

enum class Qgis::DatabaseProviderConnectionCapability2 : int

strong

The Capability enum represents the extended operations supported by the connection.

Since

QGIS 3.32

Enumerator
SetFieldComment	Can set comments for fields via setFieldComment()
SetFieldAlias	Can set aliases for fields via setFieldAlias()

Definition at line 4573 of file qgis.h.

DataItemProviderCapability

enum class Qgis::DataItemProviderCapability : int

strong

Capabilities for data item providers.

Note

Prior to QGIS 3.36 this was available as QgsDataProvider::DataCapability

Since

QGIS 3.36

Enumerator
NoCapabilities	No capabilities.
Files	Can provides items which corresponds to files.
Directories	Can provides items which corresponds to directories.
Databases	Can provides items which corresponds to databases.
NetworkSources	Network/internet source.

Definition at line 729 of file qgis.h.

DataProviderFlag

enum class Qgis::DataProviderFlag : int

strong

Generic data provider flags.

Since

QGIS 3.26

Enumerator
IsBasemapSource	Associated source should be considered a 'basemap' layer. See Qgis::MapLayerProperty::IsBasemapLayer.
FastExtent2D	Provider's 2D extent retrieval via QgsDataProvider::extent() is always guaranteed to be trivial/fast to calculate. Since QGIS 3.38.
FastExtent3D	Provider's 3D extent retrieval via QgsDataProvider::extent3D() is always guaranteed to be trivial/fast to calculate. Since QGIS 3.38.

Definition at line 1940 of file qgis.h.

DataType

enum class Qgis::DataType : int

strong

Raster data types.

This is modified and extended copy of GDALDataType.

Enumerator
UnknownDataType	Unknown or unspecified type.
Byte	Eight bit unsigned integer (quint8)
Int8	Eight bit signed integer (qint8) (added in QGIS 3.30)
UInt16	Sixteen bit unsigned integer (quint16)
Int16	Sixteen bit signed integer (qint16)
UInt32	Thirty two bit unsigned integer (quint32)
Int32	Thirty two bit signed integer (qint32)
Float32	Thirty two bit floating point (float)
Float64	Sixty four bit floating point (double)
CInt16	Complex Int16.
CInt32	Complex Int32.
CFloat32	Complex Float32.
CFloat64	Complex Float64.
ARGB32	Color, alpha, red, green, blue, 4 bytes the same as QImage::Format_ARGB32.
ARGB32_Premultiplied	Color, alpha, red, green, blue, 4 bytes the same as QImage::Format_ARGB32_Premultiplied.

Definition at line 287 of file qgis.h.

DateTimeStatistic

enum class Qgis::DateTimeStatistic : int

strong

Available date/time statistics.

Since

QGIS 3.36. Prior to 3.36 this was available as QgsDateTimeStatisticalSummary::Statistic.

Enumerator
Count	Count.
CountDistinct	Number of distinct datetime values.
CountMissing	Number of missing (null) values.
Min	Minimum (earliest) datetime value.
Max	Maximum (latest) datetime value.
Range	Interval between earliest and latest datetime value.
All	All statistics.

Definition at line 5017 of file qgis.h.

DeviceConnectionStatus

enum class Qgis::DeviceConnectionStatus : int

strong

GPS connection status.

Since

QGIS 3.30

Enumerator
Disconnected	Device is disconnected.
Connecting	Device is connecting.
Connected	Device is successfully connected.

Definition at line 1540 of file qgis.h.

DistanceUnit

enum class Qgis::DistanceUnit : int

strong

Units of distance.

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes::DistanceUnit.

Since

QGIS 3.30

Enumerator
Meters	Meters.
Kilometers	Kilometers.
Feet	Imperial feet.
NauticalMiles	Nautical miles.
Yards	Imperial yards.
Miles	Terrestrial miles.
Degrees	Degrees, for planar geographic CRS distance measurements.
Centimeters	Centimeters.
Millimeters	Millimeters.
Inches	Inches (since QGIS 3.32)
Unknown	Unknown distance unit.

Definition at line 4357 of file qgis.h.

DistanceUnitType

enum class Qgis::DistanceUnitType : int

strong

Types of distance units.

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes::DistanceUnitType.

Since

QGIS 3.30

Enumerator
Standard	Unit is a standard measurement unit.
Geographic	Unit is a geographic (e.g., degree based) unit.
Unknown	Unknown unit type.

Definition at line 4380 of file qgis.h.

DpiMode

enum class Qgis::DpiMode

strong

DpiMode enum.

Since

QGIS 3.26

Enumerator
All	All.
Off	Off.
QGIS	QGIS.
UMN	UMN.
GeoServer	GeoServer.

Definition at line 2852 of file qgis.h.

DriveType

enum class Qgis::DriveType : int

strong

Drive types.

Since

QGIS 3.20

Enumerator
Unknown	Unknown type.
Invalid	Invalid path.
Removable	Removable drive.
Fixed	Fixed drive.
Remote	Remote drive.
CdRom	CD-ROM.
RamDisk	RAM disk.
Cloud	Cloud storage – files may be remote or locally stored, depending on user configuration.

Definition at line 876 of file qgis.h.

ElevationMapCombineMethod

enum class Qgis::ElevationMapCombineMethod : int

strong

Methods used to select the elevation when two elevation maps are combined.

Since

QGIS 3.30

Enumerator
HighestElevation	Keep the highest elevation if it is not null.
NewerElevation	Keep the new elevation regardless of its value if it is not null.

Definition at line 4259 of file qgis.h.

EndCapStyle

enum class Qgis::EndCapStyle : int

strong

End cap styles for buffers.

Since

QGIS 3.22

Enumerator
Round	Round cap.
Flat	Flat cap (in line with start/end of line)
Square	Square cap (extends past start/end of line by buffer distance)

Definition at line 1774 of file qgis.h.

ExpressionType

enum class Qgis::ExpressionType

strong

Expression types.

Since

QGIS 3.32

Enumerator
Qgis	Native QGIS expression.
PointCloud	Point cloud expression.
RasterCalculator	Raster calculator expression (since QGIS 3.34)

Definition at line 4695 of file qgis.h.

FeatureAvailability

enum class Qgis::FeatureAvailability : int

strong

Possible return value for QgsFeatureSource::hasFeatures() to determine if a source is empty.

It is implemented as a three-value logic, so it can return if there are features available for sure, if there are no features available for sure or if there might be features available but there is no guarantee for this.

Note

Prior to QGIS 3.36 this was available as QgsFeatureSource::FeatureAvailability

Since

QGIS 3.36

Enumerator
NoFeaturesAvailable	There are certainly no features available in this source.
FeaturesAvailable	There is at least one feature available in this source.
FeaturesMaybeAvailable	There may be features available in this source.

Definition at line 386 of file qgis.h.

FeatureRequestFilterType

enum class Qgis::FeatureRequestFilterType : int

strong

Types of feature request filters.

Note

Prior to QGIS 3.36 this was available as QgsFeatureRequest::FilterType

Since

QGIS 3.36

Enumerator
NoFilter	No filter is applied.
Fid	Filter using feature ID.
Expression	Filter using expression.
Fids	Filter using feature IDs.

Definition at line 1855 of file qgis.h.

FeatureRequestFlag

enum class Qgis::FeatureRequestFlag : int

strong

Flags for controlling feature requests.

Note

Prior to QGIS 3.36 this was available as QgsFeatureRequest::Flag

Since

QGIS 3.36

Enumerator
NoFlags	No flags are set.
NoGeometry	Geometry is not required. It may still be returned if e.g. required for a filter condition.
SubsetOfAttributes	Fetch only a subset of attributes (setSubsetOfAttributes sets this flag)
ExactIntersect	Use exact geometry intersection (slower) instead of bounding boxes.
IgnoreStaticNodesDuringExpressionCompilation	If a feature request uses a filter expression which can be partially precalculated due to static nodes in the expression, setting this flag will prevent these precalculated values from being utilized during compilation of the filter for the backend provider. This flag significantly slows down feature requests and should be used for debugging purposes only. (Since QGIS 3.18)
EmbeddedSymbols	Retrieve any embedded feature symbology (since QGIS 3.20)

Definition at line 1827 of file qgis.h.

FeatureSymbologyExport

enum class Qgis::FeatureSymbologyExport : int

strong

Options for exporting features considering their symbology.

Note

Prior to QGIS 3.32 this was available as QgsVectorFileWriter::SymbologyExport.

Since

QGIS 3.32

Enumerator
NoSymbology	Export only data.
PerFeature	Keeps the number of features and export symbology per feature.
PerSymbolLayer	Exports one feature per symbol layer (considering symbol levels)

Definition at line 4710 of file qgis.h.

FieldConfigurationFlag

enum class Qgis::FieldConfigurationFlag : int

strong

Configuration flags for fields These flags are meant to be user-configurable and are not describing any information from the data provider.

Note

FieldConfigurationFlag are expressed in the negative forms so that default flags is NoFlag.

Since

QGIS 3.34

Enumerator
NoFlag	No flag is defined.
NotSearchable	Defines if the field is searchable (used in the locator search for instance)
HideFromWms	Field is not available if layer is served as WMS from QGIS server.
HideFromWfs	Field is not available if layer is served as WFS from QGIS server.

Definition at line 1387 of file qgis.h.

FieldDomainMergePolicy

enum class Qgis::FieldDomainMergePolicy : int

strong

Merge policy for field domains.

When a feature is built by merging multiple features, defines how the value of attributes following the domain are computed.

Since

QGIS 3.26

Enumerator
DefaultValue	Use default field value.
Sum	Sum of values.
GeometryWeighted	New values are computed as the weighted average of the source values.

Definition at line 3348 of file qgis.h.

FieldDomainSplitPolicy

enum class Qgis::FieldDomainSplitPolicy : int

strong

Split policy for field domains.

When a feature is split into multiple parts, defines how the value of attributes following the domain are computed.

Since

QGIS 3.26

Enumerator
DefaultValue	Use default field value.
Duplicate	Duplicate original value.
GeometryRatio	New values are computed by the ratio of their area/length compared to the area/length of the original feature.
UnsetField	Clears the field value so that the data provider backend will populate using any backend triggers or similar logic (since QGIS 3.30)

Definition at line 3331 of file qgis.h.

FieldDomainType

enum class Qgis::FieldDomainType : int

strong

Types of field domain.

Since

QGIS 3.26

Enumerator
Coded	Coded field domain.
Range	Numeric range field domain (min/max)
Glob	Glob string pattern field domain.

Definition at line 3376 of file qgis.h.

FieldDuplicatePolicy

enum class Qgis::FieldDuplicatePolicy : int

strong

Duplicate policy for fields.

When a feature is duplicated, defines how the value of attributes are computed.

Since

QGIS 3.38

Enumerator
DefaultValue	Use default field value.
Duplicate	Duplicate original value.
UnsetField	Clears the field value so that the data provider backend will populate using any backend triggers or similar logic (since QGIS 3.30)

Definition at line 3363 of file qgis.h.

FieldMetadataProperty

enum class Qgis::FieldMetadataProperty : int

strong

Standard field metadata values.

Since

QGIS 3.30

Enumerator
GeometryCrs	Available for geometry field types with a specific associated coordinate reference system (as a QgsCoordinateReferenceSystem value)
GeometryWkbType	Available for geometry field types which accept geometries of a specific WKB type only (as a QgsWkbTypes::Type value)
CustomProperty	Starting point for custom user set properties.

Definition at line 1411 of file qgis.h.

FieldOrigin

enum class Qgis::FieldOrigin : int

strong

Field origin.

Note

Prior to QGIS 3.38 this was available as QgsFields::FieldOrigin

Since

QGIS 3.38

Enumerator
Unknown	The field origin has not been specified.
Provider	Field originates from the underlying data provider of the vector layer.
Join	Field originates from a joined layer.
Edit	Field has been temporarily added in editing mode.
Expression	Field is calculated from an expression.

Definition at line 1370 of file qgis.h.

FileFilterType

enum class Qgis::FileFilterType : int

strong

Type of file filters.

Prior to QGIS 3.32 this was available as QgsProviderMetadata::FilterType

Since

QGIS 3.32

Enumerator
Vector	Vector layers.
Raster	Raster layers.
Mesh	Mesh layers.
MeshDataset	Mesh datasets.
PointCloud	Point clouds (since QGIS 3.18)
VectorTile	Vector tile layers (since QGIS 3.32)
TiledScene	Tiled scene layers (since QGIS 3.34)

Definition at line 1104 of file qgis.h.

FileOperationFlag

enum class Qgis::FileOperationFlag : int

strong

File operation flags.

Since

QGIS 3.22

Enumerator
IncludeMetadataFile	Indicates that any associated .qmd metadata file should be included with the operation.
IncludeStyleFile	Indicates that any associated .qml styling file should be included with the operation.

Definition at line 1897 of file qgis.h.

FilePathType

enum class Qgis::FilePathType : int

strong

File path types.

Since

QGIS 3.22

Enumerator
Absolute	Absolute path.
Relative	Relative path.

Definition at line 1342 of file qgis.h.

GdalResampleAlgorithm

enum class Qgis::GdalResampleAlgorithm : int

strong

Resampling algorithm to be used (equivalent to GDAL's enum GDALResampleAlg)

Note

RA_Max, RA_Min, RA_Median, RA_Q1 and RA_Q3 are available on GDAL >= 2.0 builds only

Since

QGIS 3.34

Enumerator
RA_NearestNeighbour	Nearest neighbour (select on one input pixel)
RA_Bilinear	Bilinear (2x2 kernel)
RA_Cubic	Cubic Convolution Approximation (4x4 kernel)
RA_CubicSpline	Cubic B-Spline Approximation (4x4 kernel)
RA_Lanczos	Lanczos windowed sinc interpolation (6x6 kernel)
RA_Average	Average (computes the average of all non-NODATA contributing pixels)
RA_Mode	Mode (selects the value which appears most often of all the sampled points)
RA_Max	Maximum (selects the maximum of all non-NODATA contributing pixels)
RA_Min	Minimum (selects the minimum of all non-NODATA contributing pixels)
RA_Median	Median (selects the median of all non-NODATA contributing pixels)
RA_Q1	First quartile (selects the first quartile of all non-NODATA contributing pixels)
RA_Q3	Third quartile (selects the third quartile of all non-NODATA contributing pixels)

Definition at line 4875 of file qgis.h.

GeometryOperationResult

enum class Qgis::GeometryOperationResult : int

strong

Success or failure of a geometry operation.

This enum gives details about cause of failure.

Since

QGIS 3.22

Enumerator
Success	Operation succeeded.
NothingHappened	Nothing happened, without any error.
InvalidBaseGeometry	The base geometry on which the operation is done is invalid or empty.
InvalidInputGeometryType	The input geometry (ring, part, split line, etc.) has not the correct geometry type.
SelectionIsEmpty	No features were selected.
SelectionIsGreaterThanOne	More than one features were selected.
GeometryEngineError	Geometry engine misses a method implemented or an error occurred in the geometry engine.
LayerNotEditable	Cannot edit layer.
AddPartSelectedGeometryNotFound	The selected geometry cannot be found.
AddPartNotMultiGeometry	The source geometry is not multi.
AddRingNotClosed	The input ring is not closed.
AddRingNotValid	The input ring is not valid.
AddRingCrossesExistingRings	The input ring crosses existing rings (it is not disjoint)
AddRingNotInExistingFeature	The input ring doesn't have any existing ring to fit into.
SplitCannotSplitPoint	Cannot split points.
GeometryTypeHasChanged	Operation has changed geometry type.

Definition at line 1708 of file qgis.h.

GeometryType

enum class Qgis::GeometryType : int

strong

The geometry types are used to group Qgis::WkbType in a coarse way.

Note

Prior to 3.30 this was available as QgsWkbTypes.GeometryType.

Since

QGIS 3.30

Enumerator
Point	Points.
Line	Lines.
Polygon	Polygons.
Unknown	Unknown types.
Null	No geometry.

Definition at line 273 of file qgis.h.

GeometryValidationEngine

enum class Qgis::GeometryValidationEngine : int

strong

Available engines for validating geometries.

Since

QGIS 3.22

Enumerator
QgisInternal	Use internal QgsGeometryValidator method.
Geos	Use GEOS validation methods.

Definition at line 1750 of file qgis.h.

GeometryValidityFlag

enum class Qgis::GeometryValidityFlag : int

strong

Geometry validity check flags.

Since

QGIS 3.22

Enumerator
AllowSelfTouchingHoles	Indicates that self-touching holes are permitted. OGC validity states that self-touching holes are NOT permitted, whilst other vendor validity checks (e.g. ESRI) permit self-touching holes.

Definition at line 1737 of file qgis.h.

GnssConstellation

enum class Qgis::GnssConstellation

strong

GNSS constellation.

Since

QGIS 3.30

Enumerator
Unknown	Unknown/other system.
Gps	Global Positioning System (GPS)
Glonass	Global Navigation Satellite System (GLONASS)
Galileo	Galileo.
BeiDou	BeiDou.
Qzss	Quasi Zenith Satellite System (QZSS)
Navic	Indian Regional Navigation Satellite System (IRNSS) / NAVIC.
Sbas	SBAS.

Definition at line 1570 of file qgis.h.

GpsConnectionType

enum class Qgis::GpsConnectionType : int

strong

GPS connection types.

Since

QGIS 3.30

Enumerator
Automatic	Automatically detected GPS device connection.
Internal	Internal GPS device.
Serial	Serial port GPS device.
Gpsd	GPSD device.

Definition at line 1526 of file qgis.h.

GpsFeatureType

enum class Qgis::GpsFeatureType : int

strong

GPS feature types.

Since

QGIS 3.22

Enumerator
Waypoint	Waypoint.
Route	Route.
Track	Track.

Definition at line 1693 of file qgis.h.

GpsFixStatus

enum class Qgis::GpsFixStatus : int

strong

GPS fix status.

Note

Prior to QGIS 3.30 this was available as QgsGpsInformation::FixStatus

Since

QGIS 3.30

Enumerator
NoData	No fix data available.
NoFix	GPS is not fixed.
Fix2D	2D fix
Fix3D	3D fix

Definition at line 1555 of file qgis.h.

GpsInformationComponent

enum class Qgis::GpsInformationComponent : int

strong

GPS information component.

Since

QGIS 3.30

Enumerator
Location	2D location (latitude/longitude), as a QgsPointXY value
Altitude	Altitude/elevation above or below the mean sea level.
GroundSpeed	Ground speed.
Bearing	Bearing measured in degrees clockwise from true north to the direction of travel.
TotalTrackLength	Total distance of current GPS track (available from QgsGpsLogger class only)
TrackDistanceFromStart	Direct distance from first vertex in current GPS track to last vertex (available from QgsGpsLogger class only)
Pdop	Dilution of precision.
Hdop	Horizontal dilution of precision.
Vdop	Vertical dilution of precision.
HorizontalAccuracy	Horizontal accuracy in meters.
VerticalAccuracy	Vertical accuracy in meters.
HvAccuracy	3D RMS
SatellitesUsed	Count of satellites used in obtaining the fix.
Timestamp	Timestamp.
TrackStartTime	Timestamp at start of current track (available from QgsGpsLogger class only)
TrackEndTime	Timestamp at end (current point) of current track (available from QgsGpsLogger class only)
TrackDistanceSinceLastPoint	Distance since last recorded location (available from QgsGpsLogger class only)
TrackTimeSinceLastPoint	Time since last recorded location (available from QgsGpsLogger class only)
GeoidalSeparation	Geoidal separation, the difference between the WGS-84 Earth ellipsoid and mean-sea-level (geoid), "-" means mean-sea-level below ellipsoid.
EllipsoidAltitude	Altitude/elevation above or below the WGS-84 Earth ellipsoid.

Definition at line 1622 of file qgis.h.

GpsNavigationStatus

enum class Qgis::GpsNavigationStatus : int

strong

GPS navigation status.

Since

QGIS 3.38

Enumerator
NotValid	Navigation status not valid.
Safe	Safe.
Caution	Caution.
Unsafe	Unsafe.

Definition at line 1608 of file qgis.h.

GpsQualityIndicator

enum class Qgis::GpsQualityIndicator

strong

GPS signal quality indicator.

Since

QGIS 3.22.6

Enumerator
Unknown	Unknown.
Invalid	Invalid.
GPS	Standalone.
DGPS	Differential GPS.
PPS	PPS.
RTK	Real-time-kynematic.
FloatRTK	Float real-time-kynematic.
Estimated	Estimated.
Manual	Manual input mode.
Simulation	Simulation mode.

Definition at line 1588 of file qgis.h.

GradientColorSource

enum class Qgis::GradientColorSource : int

strong

Gradient color sources.

Note

Prior to QGIS 3.24 this was available as QgsGradientFillSymbolLayer::GradientColorType

Since

QGIS 3.24

Enumerator
SimpleTwoColor	Simple two color gradient.
ColorRamp	Gradient color ramp.

Definition at line 2698 of file qgis.h.

GradientSpread

enum class Qgis::GradientSpread : int

strong

Gradient spread options, which control how gradients are rendered outside of their start and end points.

Note

Prior to QGIS 3.24 this was available as QgsGradientFillSymbolLayer::GradientSpread

Since

QGIS 3.24

Enumerator
Pad	Pad out gradient using colors at endpoint of gradient.
Reflect	Reflect gradient.
Repeat	Repeat gradient.

Definition at line 2742 of file qgis.h.

GradientType

enum class Qgis::GradientType : int

strong

Gradient types.

Note

Prior to QGIS 3.24 this was available as QgsGradientFillSymbolLayer::GradientType

Since

QGIS 3.24

Enumerator
Linear	Linear gradient.
Radial	Radial (circular) gradient.
Conical	Conical (polar) gradient.

Definition at line 2712 of file qgis.h.

GraduatedMethod

enum class Qgis::GraduatedMethod : int

strong

Methods for modifying symbols by range in a graduated symbol renderer.

Note

Prior to QGIS 3.26 this was available as QgsGraduatedSymbolRenderer::GraduatedMethod

Since

QGIS 3.26

Enumerator
Color	Alter color of symbols.
Size	Alter size of symbols.

Definition at line 2826 of file qgis.h.

HistoryProviderBackend

enum class Qgis::HistoryProviderBackend : int

strong

History provider backends.

Since

QGIS 3.24

Enumerator
LocalProfile	Local profile.

Definition at line 2978 of file qgis.h.

HttpMethod

enum class Qgis::HttpMethod : int

strong

Different methods of HTTP requests.

Since

QGIS 3.22

Enumerator
Get	GET method.
Post	POST method.

Definition at line 790 of file qgis.h.

InputControllerType

enum class Qgis::InputControllerType : int

strong

Input controller types.

Since

QGIS 3.34

Enumerator
Map2D	2D map controller
Map3D	3D map controller

Definition at line 4540 of file qgis.h.

InvalidGeometryCheck

enum class Qgis::InvalidGeometryCheck : int

strong

Methods for handling of features with invalid geometries.

Note

Prior to QGIS 3.36 this was available as QgsFeatureRequest::InvalidGeometryCheck

Since

QGIS 3.36

Enumerator
NoCheck	No invalid geometry checking.
SkipInvalid	Skip any features with invalid geometry. This requires a slow geometry validity check for every feature.
AbortOnInvalid	Close iterator on encountering any features with invalid geometry. This requires a slow geometry validity check for every feature.

Definition at line 1871 of file qgis.h.

JoinStyle

enum class Qgis::JoinStyle : int

strong

Join styles for buffers.

Since

QGIS 3.22

Enumerator
Round	Use rounded joins.
Miter	Use mitered joins.
Bevel	Use beveled joins.

Definition at line 1787 of file qgis.h.

LabelingFlag

enum class Qgis::LabelingFlag : int

strong

Various flags that affect drawing and placement of labels.

Prior to QGIS 3.30 this was available as QgsLabelingEngineSettings::Flag

Since

QGIS 3.30

Enumerator
UseAllLabels	Whether to draw all labels even if there would be collisions.
UsePartialCandidates	Whether to use also label candidates that are partially outside of the map view.
RenderOutlineLabels	Whether to render labels as text or outlines. Deprecated and of QGIS 3.4.3 - use defaultTextRenderFormat() instead.
DrawLabelRectOnly	Whether to only draw the label rect and not the actual label text (used for unit tests)
DrawCandidates	Whether to draw rectangles of generated candidates (good for debugging)
DrawUnplacedLabels	Whether to render unplaced labels as an indicator/warning for users.
CollectUnplacedLabels	Whether unplaced labels should be collected in the labeling results (regardless of whether they are being rendered). Since QGIS 3.20.
DrawLabelMetrics	Whether to render label metric guides (for debugging). Since QGIS 3.30.

Definition at line 2417 of file qgis.h.

LabelLinePlacementFlag

enum class Qgis::LabelLinePlacementFlag : int

strong

Line placement flags, which control how candidates are generated for a linear feature.

Note

Prior to QGIS 3.32 this was available as QgsLabeling::LinePlacementFlag

Since

QGIS 3.32

Enumerator
OnLine	Labels can be placed directly over a line feature.
AboveLine	Labels can be placed above a line feature. Unless MapOrientation is also specified this mode respects the direction of the line feature, so a line from right to left labels will have labels placed placed below the line feature.
BelowLine	Labels can be placed below a line feature. Unless MapOrientation is also specified this mode respects the direction of the line feature, so a line from right to left labels will have labels placed placed above the line feature.
MapOrientation	Signifies that the AboveLine and BelowLine flags should respect the map's orientation rather than the feature's orientation. For example, AboveLine will always result in label's being placed above a line, regardless of the line's direction.

Definition at line 1025 of file qgis.h.

LabelMultiLineAlignment

enum class Qgis::LabelMultiLineAlignment : int

strong

Text alignment for multi-line labels.

Note

Prior to QGIS 3.26 this was available as QgsPalLayerSettings::MultiLineAlign

Since

QGIS 3.26

Enumerator
Left	Left align.
Center	Center align.
Right	Right align.
FollowPlacement	Alignment follows placement of label, e.g., labels to the left of a feature will be drawn with right alignment.
Justify	Justified.

Definition at line 1088 of file qgis.h.

LabelOffsetType

enum class Qgis::LabelOffsetType : int

strong

Behavior modifier for label offset and distance, only applies in some label placement modes.

Note

Prior to QGIS 3.26 this was available as QgsPalLayerSettings::OffsetType

Since

QGIS 3.26

Enumerator
FromPoint	Offset distance applies from point geometry.
FromSymbolBounds	Offset distance applies from rendered symbol bounds.

Definition at line 991 of file qgis.h.

LabelOverlapHandling

enum class Qgis::LabelOverlapHandling : int

strong

Label overlap handling.

Since

QGIS 3.26

Enumerator
PreventOverlap	Do not allow labels to overlap other labels.
AllowOverlapIfRequired	Avoids overlapping labels when possible, but permit overlaps if labels for features cannot otherwise be placed.
AllowOverlapAtNoCost	Labels may freely overlap other labels, at no cost.

Definition at line 917 of file qgis.h.

LabelPlacement

enum class Qgis::LabelPlacement : int

strong

Placement modes which determine how label candidates are generated for a feature.

Note

Prior to QGIS 3.26 this was available as QgsPalLayerSettings::Placement

Since

QGIS 3.26

Enumerator
AroundPoint	Arranges candidates in a circle around a point (or centroid of a polygon). Applies to point or polygon layers only.
OverPoint	Arranges candidates over a point (or centroid of a polygon), or at a preset offset from the point. Applies to point or polygon layers only.
Line	Arranges candidates parallel to a generalised line representing the feature or parallel to a polygon's perimeter. Applies to line or polygon layers only.
Curved	Arranges candidates following the curvature of a line feature. Applies to line layers only.
Horizontal	Arranges horizontal candidates scattered throughout a polygon feature. Applies to polygon layers only.
Free	Arranges candidates scattered throughout a polygon feature. Candidates are rotated to respect the polygon's orientation. Applies to polygon layers only.
OrderedPositionsAroundPoint	Candidates are placed in predefined positions around a point. Preference is given to positions with greatest cartographic appeal, e.g., top right, bottom right, etc. Applies to point layers only.
PerimeterCurved	Arranges candidates following the curvature of a polygon's boundary. Applies to polygon layers only.
OutsidePolygons	Candidates are placed outside of polygon boundaries. Applies to polygon layers only. Since QGIS 3.14.

Definition at line 944 of file qgis.h.

LabelPlacementEngineVersion

enum class Qgis::LabelPlacementEngineVersion : int

strong

Labeling placement engine version.

Prior to QGIS 3.30 this was available as QgsLabelingEngineSettings::PlacementEngineVersion

Since

QGIS 3.30

Enumerator
Version1	Version 1, matches placement from QGIS <= 3.10.1.
Version2	Version 2 (default for new projects since QGIS 3.12)

Definition at line 2448 of file qgis.h.

LabelPolygonPlacementFlag

enum class Qgis::LabelPolygonPlacementFlag : int

strong

Polygon placement flags, which control how candidates are generated for a polygon feature.

Note

Prior to QGIS 3.32 this was available as QgsLabeling::PolygonPlacementFlag

Since

QGIS 3.32

Enumerator
AllowPlacementOutsideOfPolygon	Labels can be placed outside of a polygon feature.
AllowPlacementInsideOfPolygon	Labels can be placed inside a polygon feature.

Definition at line 1050 of file qgis.h.

LabelPredefinedPointPosition

enum class Qgis::LabelPredefinedPointPosition : int

strong

Positions for labels when using the Qgis::LabelPlacement::OrderedPositionsAroundPoint placement mode.

Note

Prior to QGIS 3.26 this was available as QgsPalLayerSettings::PredefinedPointPosition

Since

QGIS 3.26

Enumerator
TopLeft	Label on top-left of point.
TopSlightlyLeft	Label on top of point, slightly left of center.
TopMiddle	Label directly above point.
TopSlightlyRight	Label on top of point, slightly right of center.
TopRight	Label on top-right of point.
MiddleLeft	Label on left of point.
MiddleRight	Label on right of point.
BottomLeft	Label on bottom-left of point.
BottomSlightlyLeft	Label below point, slightly left of center.
BottomMiddle	Label directly below point.
BottomSlightlyRight	Label below point, slightly right of center.
BottomRight	Label on bottom right of point.
OverPoint	Label directly centered over point (since QGIS 3.38)

Definition at line 965 of file qgis.h.

LabelPrioritization

enum class Qgis::LabelPrioritization : int

strong

Label prioritization.

Since

QGIS 3.38

Enumerator
PreferCloser	Prefer closer labels, falling back to alternate positions before larger distances.
PreferPositionOrdering	Prefer labels follow position ordering, falling back to more distance labels before alternate positions.

Definition at line 930 of file qgis.h.

LabelQuadrantPosition

enum class Qgis::LabelQuadrantPosition : int

strong

Label quadrant positions.

Note

Prior to QGIS 3.26 this was available as QgsPalLayerSettings::QuadrantPosition

Since

QGIS 3.26

Enumerator
AboveLeft	Above left.
Above	Above center.
AboveRight	Above right.
Left	Left middle.
Over	Center middle.
Right	Right middle.
BelowLeft	Below left.
Below	Below center.
BelowRight	BelowRight.

Definition at line 1005 of file qgis.h.

LayerFilter

enum class Qgis::LayerFilter : int

strong

Filter for layers.

Since

QGIS 3.34. Prior to 3.34 this was available as QgsMapLayerProxyModel::Filter.

Enumerator
RasterLayer
NoGeometry
PointLayer
LineLayer
PolygonLayer
HasGeometry
VectorLayer
PluginLayer
WritableLayer
MeshLayer	QgsMeshLayer. Since QGIS 3.6
VectorTileLayer	QgsVectorTileLayer. Since QGIS 3.14
PointCloudLayer	QgsPointCloudLayer. Since QGIS 3.18
AnnotationLayer	QgsAnnotationLayer. Since QGIS 3.22
TiledSceneLayer	QgsTiledSceneLayer. Since QGIS 3.34
All
SpatialLayer	Since QGIS 3.24

Definition at line 132 of file qgis.h.

LayerTreeFilterFlag

enum class Qgis::LayerTreeFilterFlag : int

strong

Layer tree filter flags.

Since

QGIS 3.32

Enumerator
SkipVisibilityCheck	If set, the standard visibility check should be skipped.

Definition at line 3940 of file qgis.h.

LayerTreeInsertionMethod

enum class Qgis::LayerTreeInsertionMethod : int

strong

Layer tree insertion methods.

Since

QGIS 3.30

Enumerator
AboveInsertionPoint	Layers are added in the tree above the insertion point.
TopOfTree	Layers are added at the top of the layer tree.
OptimalInInsertionGroup	Layers are added at optimal locations across the insertion point's group.

Definition at line 3927 of file qgis.h.

LayerType

enum class Qgis::LayerType : int

strong

Types of layers that can be added to a map.

Since

QGIS 3.30. Prior to 3.30 this was available as QgsMapLayerType.

Enumerator
Vector	Vector layer.
Raster	Raster layer.
Plugin	Plugin based layer.
Mesh	Mesh layer. Added in QGIS 3.2.
VectorTile	Vector tile layer. Added in QGIS 3.14.
Annotation	Contains freeform, georeferenced annotations. Added in QGIS 3.16.
PointCloud	Point cloud layer. Added in QGIS 3.18.
Group	Composite group layer. Added in QGIS 3.24.
TiledScene	Tiled scene layer. Added in QGIS 3.34.

Definition at line 113 of file qgis.h.

LayoutUnit

enum class Qgis::LayoutUnit : int

strong

Layout measurement units.

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes::LayoutUnit.

Since

QGIS 3.30

Enumerator
Millimeters	Millimeters.
Centimeters	Centimeters.
Meters	Meters.
Inches	Inches.
Feet	Feet.
Points	Typographic points.
Picas	Typographic picas.
Pixels	Pixels.

Definition at line 4508 of file qgis.h.

LayoutUnitType

enum class Qgis::LayoutUnitType : int

strong

Types of layout units.

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes::LayoutUnitType.

Since

QGIS 3.30

Enumerator
PaperUnits	Unit is a paper based measurement unit.
ScreenUnits	Unit is a screen based measurement unit.

Definition at line 4528 of file qgis.h.

LegendJsonRenderFlag

enum class Qgis::LegendJsonRenderFlag : int

strong

Legend JSON export flags.

Flags to control JSON attributes when exporting a legend in JSON format.

Since

QGIS 3.36

Enumerator
ShowRuleDetails	If set, the rule expression of a rule based renderer legend item will be added to the JSON.

Definition at line 3962 of file qgis.h.

LightSourceType

enum class Qgis::LightSourceType : int

strong

Light source types for 3D scenes.

Since

QGIS 3.26

Enumerator
Point	Point light source.
Directional	Directional light source.

Definition at line 3563 of file qgis.h.

LineClipMode

enum class Qgis::LineClipMode : int

strong

Line clipping modes.

Since

QGIS 3.24

Enumerator
ClipPainterOnly	Applying clipping on the painter only (i.e. line endpoints will coincide with polygon bounding box, but will not be part of the visible portion of the line)
ClipToIntersection	Clip lines to intersection with polygon shape (slower) (i.e. line endpoints will coincide with polygon exterior)
NoClipping	Lines are not clipped, will extend to shape's bounding box.

Definition at line 2783 of file qgis.h.

LineExtensionSide

enum class Qgis::LineExtensionSide : int

strong

Designates whether the line extension constraint is currently soft locked with the previous or next vertex of the locked one.

Since

QGIS 3.26

Enumerator
BeforeVertex	Lock to previous vertex.
AfterVertex	Lock to next vertex.
NoVertex	Don't lock to vertex.

Definition at line 3481 of file qgis.h.

LoadStyleFlag

enum class Qgis::LoadStyleFlag : int

strong

Flags for loading layer styles.

Since

QGIS 3.38

Enumerator
IgnoreMissingStyleErrors	If the style is missing, then don't flag it as an error. This flag can be used when the caller is not certain that a style exists, and accordingly a failure to find the style does not indicate an issue with loading the style itself.

Definition at line 159 of file qgis.h.

MakeValidMethod

enum class Qgis::MakeValidMethod : int

strong

Algorithms to use when repairing invalid geometries.

Since

QGIS 3.28

Enumerator
Linework	Combines all rings into a set of noded lines and then extracts valid polygons from that linework.
Structure	Structured method, first makes all rings valid and then merges shells and subtracts holes from shells to generate valid result. Assumes that holes and shells are correctly categorized. Requires GEOS 3.10+.

Definition at line 1813 of file qgis.h.

MapBoxGlStyleSourceType

enum class Qgis::MapBoxGlStyleSourceType : int

strong

Available MapBox GL style source types.

Since

QGIS 3.28

Enumerator
Vector	Vector source.
Raster	Raster source.
RasterDem	Raster DEM source.
GeoJson	GeoJSON source.
Image	Image source.
Video	Video source.
Unknown	Other/unknown source type.

Definition at line 3758 of file qgis.h.

MapLayerActionFlag

enum class Qgis::MapLayerActionFlag : int

strong

Map layer action flags.

Prior to QGIS 3.30 this was available as QgsMapLayerAction::Flag

Since

QGIS 3.30

Enumerator
EnabledOnlyWhenEditable	Action should be shown only for editable layers.

Definition at line 4018 of file qgis.h.

MapLayerActionTarget

enum class Qgis::MapLayerActionTarget : int

strong

Map layer action targets.

Prior to QGIS 3.30 this was available as QgsMapLayerAction::Target

Since

QGIS 3.30

Enumerator
Layer	Action targets a complete layer.
SingleFeature	Action targets a single feature from a layer.
MultipleFeatures	Action targets multiple features from a layer.
AllActions

Definition at line 3992 of file qgis.h.

MapLayerProperty

enum class Qgis::MapLayerProperty : int

strong

Generic map layer properties.

Since

QGIS 3.22

Enumerator
UsersCannotToggleEditing	Indicates that users are not allowed to toggle editing for this layer. Note that this does not imply that the layer is non-editable (see isEditable(), supportsEditing() ), rather that the editable status of the layer cannot be changed by users manually. Since QGIS 3.22.
IsBasemapLayer	Layer is considered a 'basemap' layer, and certain properties of the layer should be ignored when calculating project-level properties. For instance, the extent of basemap layers is ignored when calculating the extent of a project, as these layers are typically global and extend outside of a project's area of interest. Since QGIS 3.26.

Definition at line 1912 of file qgis.h.

MapLayerRendererFlag

enum class Qgis::MapLayerRendererFlag : int

strong

Flags which control how map layer renderers behave.

Since

QGIS 3.34

Enumerator
RenderPartialOutputs	The renderer benefits from rendering temporary in-progress preview renders. These are temporary results which will be used for the layer during rendering in-progress compositions, which will differ from the final layer render. They can be used for showing overlays or other information to users which help inform them about what is actually occurring during a slow layer render, but where these overlays and additional content is not wanted in the final layer renders. Another use case is rendering unsorted results as soon as they are available, before doing a final sorted render of the entire layer contents.
RenderPartialOutputOverPreviousCachedImage	When rendering temporary in-progress preview renders, these preview renders can be drawn over any previously cached layer render we have for the same region. This can allow eg a low-resolution zoomed in version of the last map render to be used as a base painting surface to overdraw with incremental preview render outputs. If not set, an empty image will be used as the starting point for the render preview image.

Definition at line 2381 of file qgis.h.

MapRecenteringMode

enum class Qgis::MapRecenteringMode

strong

Modes for recentering map canvases.

Since

QGIS 3.30

Enumerator
Always	Always recenter map.
WhenOutsideVisibleExtent	Only recenter map when new center would be outside of current visible extent.
Never	Never recenter map.

Definition at line 2965 of file qgis.h.

MapSettingsFlag

enum class Qgis::MapSettingsFlag : int

strong

Flags which adjust the way maps are rendered.

Since

QGIS 3.22

Enumerator
Antialiasing	Enable anti-aliasing for map rendering.
DrawEditingInfo	Enable drawing of vertex markers for layers in editing mode.
ForceVectorOutput	Vector graphics should not be cached and drawn as raster images.
UseAdvancedEffects	Enable layer opacity and blending effects.
DrawLabeling	Enable drawing of labels on top of the map.
UseRenderingOptimization	Enable vector simplification and other rendering optimizations.
DrawSelection	Whether vector selections should be shown in the rendered map.
DrawSymbolBounds	Draw bounds of symbols (for debugging/testing)
RenderMapTile	Draw map such that there are no problems between adjacent tiles.
RenderPartialOutput	Whether to make extra effort to update map image with partially rendered layers (better for interactive map canvas). Added in QGIS 3.0.
RenderPreviewJob	Render is a 'canvas preview' render, and shortcuts should be taken to ensure fast rendering.
RenderBlocking	Render and load remote sources in the same thread to ensure rendering remote sources (svg and images). WARNING: this flag must NEVER be used from GUI based applications (like the main QGIS application) or crashes will result. Only for use in external scripts or QGIS server.
LosslessImageRendering	Render images losslessly whenever possible, instead of the default lossy jpeg rendering used for some destination devices (e.g. PDF). This flag only works with builds based on Qt 5.13 or later.
Render3DMap	Render is for a 3D map.
HighQualityImageTransforms	Enable high quality image transformations, which results in better appearance of scaled or rotated raster components of a map (since QGIS 3.24)
SkipSymbolRendering	Disable symbol rendering while still drawing labels if enabled (since QGIS 3.24)
ForceRasterMasks	Force symbol masking to be applied using a raster method. This is considerably faster when compared to the vector method, but results in a inferior quality output. (since QGIS 3.26.1)
RecordProfile	Enable run-time profiling while rendering (since QGIS 3.34)

Definition at line 2317 of file qgis.h.

MapToolUnit

enum class Qgis::MapToolUnit : int

strong

Type of unit of tolerance value from settings.

For map (project) units, use MapToolUnit::Project.

Since

QGIS 3.32

Enumerator
Layer	Layer unit value.
Pixels	Pixels unit of tolerance.
Project	Map (project) units.

Definition at line 4325 of file qgis.h.

MarkerClipMode

enum class Qgis::MarkerClipMode : int

strong

Marker clipping modes.

Since

QGIS 3.24

Enumerator
NoClipping	No clipping, render complete markers.
Shape	Clip to polygon shape.
CentroidWithin	Render complete markers wherever their centroid falls within the polygon shape.
CompletelyWithin	Render complete markers wherever the completely fall within the polygon shape.

Definition at line 2769 of file qgis.h.

MarkerLinePlacement

enum class Qgis::MarkerLinePlacement : int

strong

Defines how/where the symbols should be placed on a line.

Note

Prior to QGIS 3.24 this was available as QgsTemplatedLineSymbolLayerBase::Placement

Since

QGIS 3.24

Enumerator
Interval	Place symbols at regular intervals.
Vertex	Place symbols on every vertex in the line.
LastVertex	Place symbols on the last vertex in the line.
FirstVertex	Place symbols on the first vertex in the line.
CentralPoint	Place symbols at the mid point of the line.
CurvePoint	Place symbols at every virtual curve point in the line (used when rendering curved geometry types only)
SegmentCenter	Place symbols at the center of every line segment.
InnerVertices	Inner vertices (i.e. all vertices except the first and last vertex) (since QGIS 3.24)

Definition at line 2676 of file qgis.h.

MarkerShape

enum class Qgis::MarkerShape : int

strong

Marker shapes.

Note

Prior to QGIS 3.24 this was available as QgsSimpleMarkerSymbolLayerBase::Shape

Since

QGIS 3.24

Enumerator
Square	Square.
Diamond	Diamond.
Pentagon	Pentagon.
Hexagon	Hexagon.
Triangle	Triangle.
EquilateralTriangle	Equilateral triangle.
Star	Star.
Arrow	Arrow.
Circle	Circle.
Cross	Cross (lines only)
CrossFill	Solid filled cross.
Cross2	Rotated cross (lines only), 'x' shape.
Line	Vertical line.
ArrowHead	Right facing arrow head (unfilled, lines only)
ArrowHeadFilled	Right facing filled arrow head.
SemiCircle	Semi circle (top half)
ThirdCircle	One third circle (top left third)
QuarterCircle	Quarter circle (top left quarter)
QuarterSquare	Quarter square (top left quarter)
HalfSquare	Half square (left half)
DiagonalHalfSquare	Diagonal half square (bottom left half)
RightHalfTriangle	Right half of triangle.
LeftHalfTriangle	Left half of triangle.
Octagon	Octagon (since QGIS 3.18)
SquareWithCorners	A square with diagonal corners (since QGIS 3.18)
AsteriskFill	A filled asterisk shape (since QGIS 3.18)
HalfArc	A line-only half arc (since QGIS 3.20)
ThirdArc	A line-only one third arc (since QGIS 3.20)
QuarterArc	A line-only one quarter arc (since QGIS 3.20)
ParallelogramRight	Parallelogram that slants right (since QGIS 3.28)
ParallelogramLeft	Parallelogram that slants left (since QGIS 3.28)
Trapezoid	Trapezoid (since QGIS 3.28)
Shield	A shape consisting of a triangle attached to a rectangle (since QGIS 3.28)
DiamondStar	A 4-sided star (since QGIS 3.28)
Heart	Heart (since QGIS 3.28)
Decagon	Decagon (since QGIS 3.28)
RoundedSquare	A square with rounded corners (since QGIS 3.28)

Definition at line 2627 of file qgis.h.

MeshEditingErrorType

enum class Qgis::MeshEditingErrorType : int

strong

Type of error that can occur during mesh frame editing.

Since

QGIS 3.22

Enumerator
NoError	No type.
InvalidFace	An error occurs due to an invalid face (for example, vertex indexes are unordered)
TooManyVerticesInFace	A face has more vertices than the maximum number supported per face.
FlatFace	A flat face is present.
UniqueSharedVertex	A least two faces share only one vertices.
InvalidVertex	An error occurs due to an invalid vertex (for example, vertex index is out of range the available vertex)
ManifoldFace	ManifoldFace.

Definition at line 1325 of file qgis.h.

MeshElevationMode

enum class Qgis::MeshElevationMode : int

strong

Mesh layer elevation modes.

Since

QGIS 3.38

Enumerator
FixedElevationRange	Layer has a fixed elevation range.
FromVertices	Elevation should be taken from mesh vertices.
FixedRangePerGroup	Layer has a fixed (manually specified) elevation range per group.

Definition at line 3455 of file qgis.h.

MessageLevel

enum Qgis::MessageLevel

Level for messages This will be used both for message log and message bar in application.

Enumerator
Info	Information message.
Warning	Warning message.
Critical	Critical/error message.
Success	Used for reporting a successful operation.
NoLevel	No level.

Definition at line 98 of file qgis.h.

MetadataDateType

enum class Qgis::MetadataDateType

strong

Date types for metadata.

Since

QGIS 3.30

Enumerator
Created	Date created.
Published	Date published.
Revised	Date revised.
Superseded	Date superseded.

Definition at line 4059 of file qgis.h.

NavigationMode

enum class Qgis::NavigationMode : int

strong

The navigation mode used by 3D cameras.

Since

QGIS 3.30

Enumerator
TerrainBased	The default navigation based on the terrain.
Walk	Uses WASD keys or arrows to navigate in walking (first person) manner.

Definition at line 3575 of file qgis.h.

PlaybackOperation

enum class Qgis::PlaybackOperation : int

strong

Media playback operations.

Since

QGIS 3.36

Enumerator
SkipToStart	Jump to start of playback.
PreviousFrame	Step to previous frame.
PlayReverse	Play in reverse.
Pause	Pause playback.
PlayForward	Play forward.
NextFrame	Step to next frame.
SkipToEnd	Jump to end of playback.

Definition at line 2178 of file qgis.h.

PlotAxisSuffixPlacement

enum class Qgis::PlotAxisSuffixPlacement

strong

Placement options for suffixes in the labels for axis of plots.

Since

QGIS 3.32

Enumerator
NoLabels	Do not place suffixes.
EveryLabel	Place suffix after every value label.
FirstLabel	Place suffix after the first label value only.
LastLabel	Place suffix after the last label value only.
FirstAndLastLabels	Place suffix after the first and last label values only.

Definition at line 2838 of file qgis.h.

PlotToolFlag

enum class Qgis::PlotToolFlag : int

strong

Flags that control the way the QgsPlotTools operate.

Since

QGIS 3.26

Enumerator
ShowContextMenu	Show a context menu when right-clicking with the tool.

Definition at line 3528 of file qgis.h.

Point3DShape

enum class Qgis::Point3DShape : int

strong

3D point shape types.

Note

Prior to QGIS 3.36 this was available as QgsPoint3DSymbol::Shape

Since

QGIS 3.36

Enumerator
Cylinder	Cylinder.
Sphere	Sphere.
Cone	Cone.
Cube	Cube.
Torus	Torus.
Plane	Flat plane.
ExtrudedText	Extruded text.
Model	Model.
Billboard	Billboard.

Definition at line 3544 of file qgis.h.

PointCloudDrawOrder

enum class Qgis::PointCloudDrawOrder : int

strong

Pointcloud rendering order for 2d views.

/since QGIS 3.26

Enumerator
Default	Draw points in the order they are stored.
BottomToTop	Draw points with larger Z values last.
TopToBottom	Draw points with larger Z values first.

Definition at line 3665 of file qgis.h.

PointCloudSymbol

enum class Qgis::PointCloudSymbol : int

strong

Rendering symbols for point cloud points.

Since

QGIS 3.26

Enumerator
Square	Renders points as squares.
Circle	Renders points as circles.

Definition at line 3653 of file qgis.h.

PointCountMethod

enum class Qgis::PointCountMethod : int

strong

Methods which define the number of points randomly filling a polygon.

Note

Prior to QGIS 3.24 this was available as QgsRandomMarkerFillSymbolLayer::CountMethod

Since

QGIS 3.24

Enumerator
Absolute	The point count is used as an absolute count of markers.
DensityBased	The point count is part of a marker density count.

Definition at line 2757 of file qgis.h.

PostgresRelKind

enum class Qgis::PostgresRelKind

strong

Postgres database relkind options.

Since

QGIS 3.32

Enumerator
NotSet	Not set.
Unknown	Unknown.
OrdinaryTable	Ordinary table.
Index	Index.
Sequence	Sequence.
View	View.
MaterializedView	Materialized view.
CompositeType	Composition type.
ToastTable	TOAST table.
ForeignTable	Foreign table.
PartitionedTable	Partitioned table.

Definition at line 4552 of file qgis.h.

ProcessingAlgorithmFlag

enum class Qgis::ProcessingAlgorithmFlag : int

strong

Flags indicating how and when an algorithm operates and should be exposed to users.

Note

Prior to QGIS 3.36 this was available as QgsProcessingAlgorithm::Flag

Since

QGIS 3.36

Enumerator
HideFromToolbox	Algorithm should be hidden from the toolbox.
HideFromModeler	Algorithm should be hidden from the modeler.
SupportsBatch	Algorithm supports batch mode.
CanCancel	Algorithm can be canceled.
RequiresMatchingCrs	Algorithm requires that all input layers have matching coordinate reference systems.
NoThreading	Algorithm is not thread safe and cannot be run in a background thread, e.g. for algorithms which manipulate the current project, layer selections, or with external dependencies which are not thread-safe.
DisplayNameIsLiteral	Algorithm's display name is a static literal string, and should not be translated or automatically formatted. For use with algorithms named after commands, e.g. GRASS 'v.in.ogr'.
SupportsInPlaceEdits	Algorithm supports in-place editing.
KnownIssues	Algorithm has known issues.
CustomException	Algorithm raises custom exception notices, don't use the standard ones.
PruneModelBranchesBasedOnAlgorithmResults	Algorithm results will cause remaining model branches to be pruned based on the results of running the algorithm.
SkipGenericModelLogging	When running as part of a model, the generic algorithm setup and results logging should be skipped.
NotAvailableInStandaloneTool	Algorithm should not be available from the standalone "qgis_process" tool. Used to flag algorithms which make no sense outside of the QGIS application, such as "select by..." style algorithms.
RequiresProject	The algorithm requires that a valid QgsProject is available from the processing context in order to execute.
Deprecated	Algorithm is deprecated.

Definition at line 3044 of file qgis.h.

ProcessingDateTimeParameterDataType

enum class Qgis::ProcessingDateTimeParameterDataType : int

strong

Processing date time parameter data types.

Note

Prior to QGIS 3.36 this was available as QgsProcessingParameterDateTime::Type

Since

QGIS 3.36

Enumerator
DateTime	Datetime values.
Date	Date values.
Time	Time values.

Definition at line 3259 of file qgis.h.

ProcessingFeatureSourceDefinitionFlag

enum class Qgis::ProcessingFeatureSourceDefinitionFlag : int

strong

Flags which control behavior for a Processing feature source.

Note

Prior to QGIS 3.36 this was available as QgsProcessingFeatureSourceDefinition::Flag

Since

QGIS 3.36

Enumerator
OverrideDefaultGeometryCheck	If set, the default geometry check method (as dictated by QgsProcessingContext) will be overridden for this source.
CreateIndividualOutputPerInputFeature	If set, every feature processed from this source will be placed into its own individually created output destination. Support for this flag depends on how an algorithm is executed.

Definition at line 3111 of file qgis.h.

ProcessingFeatureSourceFlag

enum class Qgis::ProcessingFeatureSourceFlag : int

strong

Flags which control how QgsProcessingFeatureSource fetches features.

Note

Prior to QGIS 3.36 this was available as QgsProcessingFeatureSource::Flag

Since

QGIS 3.36

Enumerator
SkipGeometryValidityChecks	Invalid geometry checks should always be skipped. This flag can be useful for algorithms which always require invalid geometries, regardless of any user settings (e.g. "repair geometry" type algorithms).

Definition at line 3135 of file qgis.h.

ProcessingFieldParameterDataType

enum class Qgis::ProcessingFieldParameterDataType : int

strong

Processing field parameter data types.

Note

Prior to QGIS 3.36 this was available as QgsProcessingParameterField::DataType

Since

QGIS 3.36

Enumerator
Any	Accepts any field.
Numeric	Accepts numeric fields.
String	Accepts string fields.
DateTime	Accepts datetime fields.
Binary	Accepts binary fields, since QGIS 3.34.
Boolean	Accepts boolean fields, since QGIS 3.34.

Definition at line 3241 of file qgis.h.

ProcessingFileParameterBehavior

enum class Qgis::ProcessingFileParameterBehavior : int

strong

Flags which dictate the behavior of QgsProcessingParameterFile.

Note

Prior to QGIS 3.36 this was available as QgsProcessingParameterFile::Behavior

Since

QGIS 3.36

Enumerator
File	Parameter is a single file.
Folder	Parameter is a folder.

Definition at line 3213 of file qgis.h.

ProcessingLogLevel

enum class Qgis::ProcessingLogLevel : int

strong

Logging level for algorithms to use when pushing feedback messages.

Note

Prior to QGIS 3.36 this was available as QgsProcessingContext::LogLevel

Since

QGIS 3.36

Enumerator
DefaultLevel	Default logging level.
Verbose	Verbose logging.
ModelDebug	Model debug level logging. Includes verbose logging and other outputs useful for debugging models (since QGIS 3.34).

Definition at line 3096 of file qgis.h.

ProcessingModelChildAlgorithmExecutionStatus

enum class Qgis::ProcessingModelChildAlgorithmExecutionStatus : int

strong

Reflects the status of a child algorithm in a Processing model.

Since

QGIS 3.38

Enumerator
NotExecuted	Child has not been executed.
Success	Child was successfully executed.
Failed	Child encountered an error while executing.

Definition at line 3288 of file qgis.h.

ProcessingModelChildParameterSource

enum class Qgis::ProcessingModelChildParameterSource : int

strong

Processing model child parameter sources.

Since

QGIS 3.34

Enumerator
ModelParameter	Parameter value is taken from a parent model parameter.
ChildOutput	Parameter value is taken from an output generated by a child algorithm.
StaticValue	Parameter value is a static value.
Expression	Parameter value is taken from an expression, evaluated just before the algorithm runs.
ExpressionText	Parameter value is taken from a text with expressions, evaluated just before the algorithm runs.
ModelOutput	Parameter value is linked to an output parameter for the model.

Definition at line 3272 of file qgis.h.

ProcessingNumberParameterType

enum class Qgis::ProcessingNumberParameterType : int

strong

Processing numeric parameter data types.

Note

Prior to QGIS 3.36 this was available as QgsProcessingParameterNumber::Type

Since

QGIS 3.36

Enumerator
Integer	Integer values.
Double	Double/float values.

Definition at line 3227 of file qgis.h.

ProcessingParameterFlag

enum class Qgis::ProcessingParameterFlag : int

strong

Flags which dictate the behavior of Processing parameters.

Note

Prior to QGIS 3.36 this was available as QgsProcessingParameterDefinition::Flag

Since

QGIS 3.36

Enumerator
Advanced	Parameter is an advanced parameter which should be hidden from users by default.
Hidden	Parameter is hidden and should not be shown to users.
Optional	Parameter is optional.
IsModelOutput	Destination parameter is final output. The parameter name will be used.

Definition at line 3187 of file qgis.h.

ProcessingParameterTypeFlag

enum class Qgis::ProcessingParameterTypeFlag : int

strong

Flags which dictate the behavior of Processing parameter types.

Each parameter type can offer a number of additional flags to fine tune its behavior and capabilities.

Note

Prior to QGIS 3.36 this was available as QgsProcessingParameterType::ParameterFlag

Since

QGIS 3.36

Enumerator
ExposeToModeler	Is this parameter available in the modeler. Is set to on by default.

Definition at line 3161 of file qgis.h.

ProcessingPropertyAvailability

enum class Qgis::ProcessingPropertyAvailability : int

strong

Property availability, used for QgsProcessingAlgorithm::VectorProperties in order to determine if properties are available or not.

Note

Prior to QGIS 3.36 this was available as QgsProcessingAlgorithm::PropertyAvailability

Since

QGIS 3.36

Enumerator
NotAvailable	Properties are not available.
Available	Properties are available.

Definition at line 3082 of file qgis.h.

ProcessingProviderFlag

enum class Qgis::ProcessingProviderFlag : int

strong

Flags indicating how and when an processing provider operates and should be exposed to users.

Note

Prior to QGIS 3.36 this was available as QgsProcessingProvider::Flag

Since

QGIS 3.36

Enumerator
DeemphasiseSearchResults	Algorithms should be de-emphasised in the search results when searching for algorithms. Use for low-priority providers or those with substantial known issues.
CompatibleWithVirtualRaster	The processing provider's algorithms can work with QGIS virtualraster data provider. Since QGIS 3.36.

Definition at line 3020 of file qgis.h.

ProcessingSourceType

enum class Qgis::ProcessingSourceType : int

strong

Processing data source types.

Note

Prior to QGIS 3.36 this was available as QgsProcessing::SourceType

Since

QGIS 3.36

Enumerator
MapLayer	Any map layer type (raster, vector, mesh, point cloud, annotation or plugin layer)
VectorAnyGeometry	Any vector layer with geometry.
VectorPoint	Vector point layers.
VectorLine	Vector line layers.
VectorPolygon	Vector polygon layers.
Raster	Raster layers.
File	Files (i.e. non map layer sources, such as text files)
Vector	Tables (i.e. vector layers with or without geometry). When used for a sink this indicates the sink has no geometry.
Mesh	Mesh layers. Since QGIS 3.6
Plugin	Plugin layers. Since QGIS 3.22
PointCloud	Point cloud layers. Since QGIS 3.22
Annotation	Annotation layers. Since QGIS 3.22
VectorTile	Vector tile layers. Since QGIS 3.32

Definition at line 2994 of file qgis.h.

ProcessingTinInputLayerType

enum class Qgis::ProcessingTinInputLayerType : int

strong

Defines the type of input layer for a Processing TIN input.

Note

Prior to QGIS 3.36 this was available as QgsProcessingParameterTinInputLayers::Type

Since

QGIS 3.36

Enumerator
Vertices	Input that adds only vertices.
StructureLines	Input that adds add structure lines.
BreakLines	Input that adds vertices and break lines.

Definition at line 3303 of file qgis.h.

ProfileExportType

enum class Qgis::ProfileExportType : int

strong

Types of export for elevation profiles.

Since

QGIS 3.32

Enumerator
Features3D	Export profiles as 3D features, with elevation values stored in exported geometry Z values.
Profile2D	Export profiles as 2D profile lines, with elevation stored in exported geometry Y dimension and distance in X dimension.
DistanceVsElevationTable	Export profiles as a table of sampled distance vs elevation values.

Definition at line 3640 of file qgis.h.

ProfileGeneratorFlag

enum class Qgis::ProfileGeneratorFlag : int

strong

Flags that control the way the QgsAbstractProfileGenerator operate.

Since

QGIS 3.26

Enumerator
RespectsMaximumErrorMapUnit	Generated profile respects the QgsProfileGenerationContext::maximumErrorMapUnits() property.
RespectsDistanceRange	Generated profile respects the QgsProfileGenerationContext::distanceRange() property.
RespectsElevationRange	Generated profile respects the QgsProfileGenerationContext::elevationRange() property.

Definition at line 3625 of file qgis.h.

ProfileSurfaceSymbology

enum class Qgis::ProfileSurfaceSymbology : int

strong

Surface symbology type for elevation profile plots.

Since

QGIS 3.26

Enumerator
Line	The elevation surface will be rendered using a line symbol.
FillBelow	The elevation surface will be rendered using a fill symbol below the surface level.
FillAbove	The elevation surface will be rendered using a fill symbol above the surface level (since QGIS 3.32)

Definition at line 3600 of file qgis.h.

ProjectCapability

enum class Qgis::ProjectCapability : int

strong

Flags which control project capabilities.

These flags are specific upfront on creation of a QgsProject object, and can be used to selectively enable potentially costly functionality for the project.

Since

QGIS 3.26.1

Enumerator
ProjectStyles	Enable the project embedded style library. Enabling this flag can increase the time required to clear and load projects.

Definition at line 3739 of file qgis.h.

ProjectFileFormat

enum class Qgis::ProjectFileFormat : int

strong

Flags which control project read behavior.

Note

Prior to QGIS 3.26 this was available as QgsProject::FileFormat

Since

QGIS 3.26

Enumerator
Qgz	Archive file format, supports auxiliary data.
Qgs	Project saved in a clear text, does not support auxiliary data.

Definition at line 3695 of file qgis.h.

ProjectFlag

enum class Qgis::ProjectFlag : int

strong

Flags which control the behavior of QgsProjects.

Since

QGIS 3.26

Enumerator
EvaluateDefaultValuesOnProviderSide	If set, default values for fields will be evaluated on the provider side when features from the project are created instead of when they are committed.
TrustStoredLayerStatistics	If set, then layer statistics (such as the layer extent) will be read from values stored in the project instead of requesting updated values from the data provider. Additionally, when this flag is set, primary key unicity is not checked for views and materialized views with Postgres provider.
RememberLayerEditStatusBetweenSessions	If set, then any layers set to be editable will be stored in the project and immediately made editable whenever that project is restored.
RememberAttributeTableWindowsBetweenSessions	If set, then any open attribute tables will be stored in the project and immediately reopened when the project is restored.

Definition at line 3512 of file qgis.h.

ProjectReadFlag

enum class Qgis::ProjectReadFlag : int

strong

Flags which control project read behavior.

Note

Prior to QGIS 3.26 this was available as QgsProject::ReadFlag

Since

QGIS 3.26

Enumerator
DontResolveLayers	Don't resolve layer paths (i.e. don't load any layer content). Dramatically improves project read time if the actual data from the layers is not required.
DontLoadLayouts	Don't load print layouts. Improves project read time if layouts are not required, and allows projects to be safely read in background threads (since print layouts are not thread safe).
TrustLayerMetadata	Trust layer metadata. Improves project read time. Do not use it if layers' extent is not fixed during the project's use by QGIS and QGIS Server.
DontStoreOriginalStyles	Skip the initial XML style storage for layers. Useful for minimising project load times in non-interactive contexts.
DontLoad3DViews	Skip loading 3D views (since QGIS 3.26)
DontLoadProjectStyles	Skip loading project style databases (deprecated – use ProjectCapability::ProjectStyles flag instead)
ForceReadOnlyLayers	Open layers in a read-only mode. (since QGIS 3.28)

Definition at line 3709 of file qgis.h.

PropertyType

enum class Qgis::PropertyType : int

strong

Property types.

Note

Prior to QGIS 3.36 this was available as QgsProperty::Type

Since

QGIS 3.36

Enumerator
Invalid	Invalid (not set) property.
Static	Static property.
Field	Field based property.
Expression	Expression based property.

Definition at line 491 of file qgis.h.

ProviderStyleStorageCapability

enum class Qgis::ProviderStyleStorageCapability : int

strong

The StorageCapability enum represents the style storage operations supported by the provider.

Since

QGIS 3.34

Enumerator
SaveToDatabase
LoadFromDatabase
DeleteFromDatabase

Definition at line 4587 of file qgis.h.

PythonMacroMode

enum class Qgis::PythonMacroMode : int

strong

Authorisation to run Python Macros.

Since

QGIS 3.10

Enumerator
Never	Macros are never run.
Ask	User is prompt before running.
SessionOnly	Only during this session.
Always	Macros are always run.
NotForThisSession	Macros will not be run for this session.

Definition at line 339 of file qgis.h.

RangeLimits

enum class Qgis::RangeLimits : int

strong

Describes how the limits of a range are handled.

Since

QGIS 3.38

Enumerator
IncludeBoth	Both lower and upper values are included in the range.
IncludeLowerExcludeUpper	Lower value is included in the range, upper value is excluded.
ExcludeLowerIncludeUpper	Lower value is excluded from the range, upper value in inccluded.
ExcludeBoth	Both lower and upper values are excluded from the range.

Definition at line 3427 of file qgis.h.

RasterAttributeTableFieldUsage

enum class Qgis::RasterAttributeTableFieldUsage : int

strong

The RasterAttributeTableFieldUsage enum represents the usage of a Raster Attribute Table field.

Note

Directly mapped from GDALRATFieldUsage enum values.

Since

QGIS 3.30

Enumerator
Generic	Field usage Generic.
PixelCount	Field usage PixelCount.
Name	Field usage Name.
Min	Field usage Min.
Max	Field usage Max.
MinMax	Field usage MinMax.
Red	Field usage Red.
Green	Field usage Green.
Blue	Field usage Blue.
Alpha	Field usage Alpha.
RedMin	Field usage RedMin.
GreenMin	Field usage GreenMin.
BlueMin	Field usage BlueMin.
AlphaMin	Field usage AlphaMin.
RedMax	Field usage RedMax.
GreenMax	Field usage GreenMax.
BlueMax	Field usage BlueMax.
AlphaMax	Field usage AlphaMax.
MaxCount	Not used by QGIS: GDAL Maximum GFU value (equals to GFU_AlphaMax+1 currently)

Definition at line 1253 of file qgis.h.

RasterAttributeTableType

enum class Qgis::RasterAttributeTableType : int

strong

The RasterAttributeTableType enum represents the type of RAT.

note Directly mapped from GDALRATTableType enum values.

Since

QGIS 3.30

Enumerator
Thematic
Athematic

Definition at line 1282 of file qgis.h.

RasterBandStatistic

enum class Qgis::RasterBandStatistic : int

strong

Available raster band statistics.

Since

QGIS 3.36. Prior to 3.36 this was available as QgsRasterBandStats::Stats.

Enumerator
NoStatistic	No statistic.
Min	Minimum.
Max	Maximum.
Range	Range.
Sum	Sum.
Mean	Mean.
StdDev	Standard deviation.
SumOfSquares	Sum of squares.
All	All available statistics.

Definition at line 5071 of file qgis.h.

RasterBuildPyramidOption

enum class Qgis::RasterBuildPyramidOption : int

strong

Raster pyramid building options.

Note

Prior to QGIS 3.30 this was available as QgsRaster::RasterBuildPyramids

Since

QGIS 3.30

Enumerator
No	Never.
Yes	Yes.
CopyExisting	Copy existing.

Definition at line 4161 of file qgis.h.

RasterColorInterpretation

enum class Qgis::RasterColorInterpretation : int

strong

Raster color interpretation.

This is a modified copy of the GDAL GDALColorInterp enum.

Note

Prior to QGIS 3.30 this was available as QgsRaster::ColorInterpretation

Since

QGIS 3.30

Enumerator
Undefined	Undefined.
GrayIndex	Grayscale.
PaletteIndex	Paletted (see associated color table)
RedBand	Red band of RGBA image.
GreenBand	Green band of RGBA image.
BlueBand	Blue band of RGBA image.
AlphaBand	Alpha (0=transparent, 255=opaque)
HueBand	Hue band of HLS image.
SaturationBand	Saturation band of HLS image.
LightnessBand	Lightness band of HLS image.
CyanBand	Cyan band of CMYK image.
MagentaBand	Magenta band of CMYK image.
YellowBand	Yellow band of CMYK image.
BlackBand	Black band of CMLY image.
YCbCr_YBand	Y Luminance.
YCbCr_CbBand	Cb Chroma.
YCbCr_CrBand	Cr Chroma.
ContinuousPalette	Continuous palette, QGIS addition, GRASS.

Definition at line 4077 of file qgis.h.

RasterDrawingStyle

enum class Qgis::RasterDrawingStyle : int

strong

Raster drawing styles.

Note

Prior to QGIS 3.30 this was available as QgsRaster::DrawingStyle

Since

QGIS 3.30

Enumerator
Undefined	Undefined.
SingleBandGray	A single band image drawn as a range of gray colors.
SingleBandPseudoColor	A single band image drawn using a pseudocolor algorithm.
PalettedColor	A "Palette" image drawn using color table.
PalettedSingleBandGray	A "Palette" layer drawn in gray scale.
PalettedSingleBandPseudoColor	A "Palette" layerdrawn using a pseudocolor algorithm.
PalettedMultiBandColor	Currently not supported.
MultiBandSingleBandGray	A layer containing 2 or more bands, but a single band drawn as a range of gray colors.
MultiBandSingleBandPseudoColor	A layer containing 2 or more bands, but a single band drawn using a pseudocolor algorithm.
MultiBandColor	A layer containing 2 or more bands, mapped to RGB color space. In the case of a multiband with only two bands, one band will be mapped to more than one color.
SingleBandColorData	ARGB values rendered directly.

Definition at line 4123 of file qgis.h.

RasterElevationMode

enum class Qgis::RasterElevationMode : int

strong

Raster layer elevation modes.

Since

QGIS 3.38

Enumerator
FixedElevationRange	Layer has a fixed elevation range.
RepresentsElevationSurface	Pixel values represent an elevation surface.
FixedRangePerBand	Layer has a fixed (manually specified) elevation range per band.
DynamicRangePerBand	Layer has a elevation range per band, calculated dynamically from an expression.

Definition at line 3441 of file qgis.h.

RasterExportType

enum class Qgis::RasterExportType : int

strong

Raster file export types.

Prior to QGIS 3.32 this was available as QgsRasterFileWriter::Mode

Since

QGIS 3.32

Enumerator
Raw	Raw data.
RenderedImage	Rendered image.

Definition at line 1295 of file qgis.h.

RasterFileWriterResult

enum class Qgis::RasterFileWriterResult : int

strong

Raster file export results.

Prior to QGIS 3.32 this was available as QgsRasterFileWriter::WriterError

Since

QGIS 3.32

Enumerator
Success	Successful export.
SourceProviderError	Source data provider error.
DestinationProviderError	Destination data provider error.
CreateDatasourceError	Data source creation error.
WriteError	Write error.
NoDataConflict	Internal error if a value used for 'no data' was found in input.
Canceled	Writing was manually canceled.

Definition at line 1308 of file qgis.h.

RasterIdentifyFormat

enum class Qgis::RasterIdentifyFormat : int

strong

Raster identify formats.

Note

Prior to QGIS 3.30 this was available as QgsRaster::IdentifyFormat

Since

QGIS 3.30

Enumerator
Undefined	Undefined.
Value	Numerical pixel value.
Text	WMS text.
Html	WMS HTML.
Feature	WMS GML/JSON -> feature.

Definition at line 4176 of file qgis.h.

RasterInterfaceCapability

enum class Qgis::RasterInterfaceCapability : int

strong

Raster interface capabilities.

Note

Prior to QGIS 3.38 this was available as QgsRasterInterface::Capability

Since

QGIS 3.38

Enumerator
NoCapabilities	No capabilities.
Size	Original data source size (and thus resolution) is known, it is not always available, for example for WMS.
Create	Create new datasets (Unused and deprecated – will be removed in QGIS 4)
Remove	Delete datasets (Unused and deprecated – will be removed in QGIS 4)
BuildPyramids	Supports building of pyramids (overviews) (Deprecated since QGIS 3.38 – use RasterProviderCapability::BuildPyramids instead)
Identify	At least one identify format supported.
IdentifyValue	Numerical values.
IdentifyText	WMS text.
IdentifyHtml	WMS HTML.
IdentifyFeature	WMS GML -> feature.
Prefetch	Allow prefetching of out-of-view images.

Definition at line 4197 of file qgis.h.

RasterLayerType

enum class Qgis::RasterLayerType : int

strong

Raster layer types.

Note

Prior to QGIS 3.30 this was available as QgsRasterLayer::LayerType

Since

QGIS 3.30

Enumerator
GrayOrUndefined	Gray or undefined.
Palette	Palette.
MultiBand	Multi band.
SingleBandColorData	Single band containing color data.

Definition at line 4107 of file qgis.h.

RasterPipeInterfaceRole

enum class Qgis::RasterPipeInterfaceRole : int

strong

Raster pipe interface roles.

Since

QGIS 3.22

Enumerator
Unknown	Unknown role.
Provider	Data provider role.
Renderer	Raster renderer role.
Brightness	Brightness filter role.
Resampler	Resampler role.
Projector	Projector role.
Nuller	Raster nuller role.
HueSaturation	Hue/saturation filter role (also applies grayscale/color inversion)

Definition at line 1182 of file qgis.h.

RasterProviderCapability

enum class Qgis::RasterProviderCapability : int

strong

Raster data provider capabilities.

Note

Prior to QGIS 3.38 this was available as QgsRasterDataProvider::ProviderCapability

Since

QGIS 3.38

Enumerator
NoProviderCapabilities	Provider has no capabilities.
ReadLayerMetadata	Provider can read layer metadata from data store. Since QGIS 3.0. See QgsDataProvider::layerMetadata()
WriteLayerMetadata	Provider can write layer metadata to the data store. Since QGIS 3.0. See QgsDataProvider::writeLayerMetadata()
ProviderHintBenefitsFromResampling	Provider benefits from resampling and should apply user default resampling settings (since QGIS 3.10)
ProviderHintCanPerformProviderResampling	Provider can perform resampling (to be opposed to post rendering resampling) (since QGIS 3.16)
ReloadData	Is able to force reload data / clear local caches. Since QGIS 3.18, see QgsDataProvider::reloadProviderData()
DpiDependentData
NativeRasterAttributeTable	Provider's rendering is dependent on requested pixel size of the viewport (since QGIS 3.20) Indicates that the provider supports native raster attribute table (since QGIS 3.30)
BuildPyramids	Supports building of pyramids (overviews) (since QGIS 3.38 – this is a replacement for RasterInterfaceCapability::BuildPyramids)

Definition at line 4230 of file qgis.h.

RasterPyramidFormat

enum class Qgis::RasterPyramidFormat : int

strong

Raster pyramid formats.

Note

Prior to QGIS 3.30 this was available as QgsRaster::RasterPyramidsFormat

Since

QGIS 3.30

Enumerator
GeoTiff	Geotiff .ovr (external)
Internal	Internal.
Erdas	Erdas Image .aux (external)

Definition at line 4146 of file qgis.h.

RasterRendererCapability

enum class Qgis::RasterRendererCapability : int

strong

Raster renderer capabilities.

Since

QGIS 3.48

Enumerator
UsesMultipleBands	The renderer utilizes multiple raster bands for color data (note that alpha bands are not considered for this capability)

Definition at line 1234 of file qgis.h.

RasterRendererFlag

enum class Qgis::RasterRendererFlag : int

strong

Flags which control behavior of raster renderers.

Since

QGIS 3.28

Enumerator
InternalLayerOpacityHandling	The renderer internally handles the raster layer's opacity, so the default layer level opacity handling should not be applied.
UseNoDataForOutOfRangePixels	Out of range pixels (eg those values outside of the rendered map's z range filter) should be set using additional nodata values instead of additional transparency values (since QGIS 3.38)

Definition at line 1213 of file qgis.h.

RasterResamplingStage

enum class Qgis::RasterResamplingStage : int

strong

Stage at which raster resampling occurs.

Since

QGIS 3.22

Enumerator
ResampleFilter	Resampling occurs in ResamplingFilter.
Provider	Resampling occurs in Provider.

Definition at line 1199 of file qgis.h.

RasterTemporalCapabilityFlag

enum class Qgis::RasterTemporalCapabilityFlag : int

strong

Flags for raster layer temporal capabilities.

Since

QGIS 3.28

Enumerator
RequestedTimesMustExactlyMatchAllAvailableTemporalRanges	If present, indicates that the provider must only request temporal values which are exact matches for the values present in QgsRasterDataProviderTemporalCapabilities::allAvailableTemporalRanges().

Definition at line 2266 of file qgis.h.

RasterTemporalMode

enum class Qgis::RasterTemporalMode : int

strong

Raster layer temporal modes.

Since

QGIS 3.22

Enumerator
FixedTemporalRange	Mode when temporal properties have fixed start and end datetimes.
TemporalRangeFromDataProvider	Mode when raster layer delegates temporal range handling to the dataprovider.
RedrawLayerOnly	Redraw the layer when temporal range changes, but don't apply any filtering. Useful when raster symbology expressions depend on the time range. (since QGIS 3.22)
FixedRangePerBand	Layer has a fixed temporal range per band (since QGIS 3.38)
RepresentsTemporalValues	Pixel values represent an datetime.

Definition at line 2236 of file qgis.h.

RelationshipCapability

enum class Qgis::RelationshipCapability : int

strong

Relationship capabilities.

Since

QGIS 3.30

Enumerator
MultipleFieldKeys	Supports multiple field keys (as opposed to a singular field)
ForwardPathLabel	Supports forward path labels.
BackwardPathLabel	Supports backward path labels.

Definition at line 3836 of file qgis.h.

RelationshipCardinality

enum class Qgis::RelationshipCardinality : int

strong

Relationship cardinality.

Since

QGIS 3.28

Enumerator
OneToOne	One to one relationship.
OneToMany	One to many relationship.
ManyToOne	Many to one relationship.
ManyToMany	Many to many relationship.

Definition at line 3822 of file qgis.h.

RelationshipStrength

enum class Qgis::RelationshipStrength : int

strong

Relationship strength.

Note

Prior to QGIS 3.28 this was available as QgsRelation::RelationStrength.

Since

QGIS 3.28

Enumerator
Association	Loose relation, related elements are not part of the parent and a parent copy will not copy any children.
Composition	Fix relation, related elements are part of the parent and a parent copy will copy any children or delete of parent will delete children.

Definition at line 3810 of file qgis.h.

RelationshipType

enum class Qgis::RelationshipType : int

strong

Relationship types.

Note

Prior to QGIS 3.28 this was available as QgsRelation::RelationType.

Since

QGIS 3.28

Enumerator
Normal	A normal relation.
Generated	A generated relation is a child of a polymorphic relation.

Definition at line 3796 of file qgis.h.

RenderContextFlag

enum class Qgis::RenderContextFlag : int

strong

Flags which affect rendering operations.

Since

QGIS 3.22

Enumerator
DrawEditingInfo	Enable drawing of vertex markers for layers in editing mode.
ForceVectorOutput	Vector graphics should not be cached and drawn as raster images.
UseAdvancedEffects	Enable layer opacity and blending effects.
UseRenderingOptimization	Enable vector simplification and other rendering optimizations.
DrawSelection	Whether vector selections should be shown in the rendered map.
DrawSymbolBounds	Draw bounds of symbols (for debugging/testing)
RenderMapTile	Draw map such that there are no problems between adjacent tiles.
Antialiasing	Use antialiasing while drawing.
RenderPartialOutput	Whether to make extra effort to update map image with partially rendered layers (better for interactive map canvas). Added in QGIS 3.0.
RenderPreviewJob	Render is a 'canvas preview' render, and shortcuts should be taken to ensure fast rendering.
RenderBlocking	Render and load remote sources in the same thread to ensure rendering remote sources (svg and images). WARNING: this flag must NEVER be used from GUI based applications (like the main QGIS application) or crashes will result. Only for use in external scripts or QGIS server.
RenderSymbolPreview	The render is for a symbol preview only and map based properties may not be available, so care should be taken to handle map unit based sizes in an appropriate way.
LosslessImageRendering	Render images losslessly whenever possible, instead of the default lossy jpeg rendering used for some destination devices (e.g. PDF). This flag only works with builds based on Qt 5.13 or later.
ApplyScalingWorkaroundForTextRendering	Whether a scaling workaround designed to stablise the rendering of small font sizes (or for painters scaled out by a large amount) when rendering text. Generally this is recommended, but it may incur some performance cost.
Render3DMap	Render is for a 3D map.
ApplyClipAfterReprojection	Feature geometry clipping to mapExtent() must be performed after the geometries are transformed using coordinateTransform(). Usually feature geometry clipping occurs using the extent() in the layer's CRS prior to geometry transformation, but in some cases when extent() could not be accurately calculated it is necessary to clip geometries to mapExtent() AFTER transforming them using coordinateTransform().
RenderingSubSymbol	Set whenever a sub-symbol of a parent symbol is currently being rendered. Can be used during symbol and symbol layer rendering to determine whether the symbol being rendered is a subsymbol. (Since QGIS 3.24)
HighQualityImageTransforms	Enable high quality image transformations, which results in better appearance of scaled or rotated raster components of a map (since QGIS 3.24)
SkipSymbolRendering	Disable symbol rendering while still drawing labels if enabled (since QGIS 3.24)
RecordProfile	Enable run-time profiling while rendering (since QGIS 3.34)

Definition at line 2348 of file qgis.h.

RendererUsage

enum class Qgis::RendererUsage : int

strong

Usage of the renderer.

Since

QGIS 3.24

Enumerator
View	Renderer used for displaying on screen.
Export	Renderer used for printing or exporting to a file.
Unknown	Renderer used for unknown usage.

Definition at line 2939 of file qgis.h.

RenderSubcomponentProperty

enum class Qgis::RenderSubcomponentProperty : int

strong

Rendering subcomponent properties.

Since

QGIS 3.22

Enumerator
Generic	Generic subcomponent property.
ShadowOffset	Shadow offset.
BlurSize	Blur size.
GlowSpread	Glow spread size.

Definition at line 2600 of file qgis.h.

RenderUnit

enum class Qgis::RenderUnit : int

strong

Rendering size units.

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes::RenderUnit.

Since

QGIS 3.30

Enumerator
Millimeters	Millimeters.
MapUnits	Map units.
Pixels	Pixels.
Percentage	Percentage of another measurement (e.g., canvas size, feature size)
Points	Points (e.g., for font sizes)
Inches	Inches.
Unknown	Mixed or unknown units.
MetersInMapUnits	Meters value as Map units.

Definition at line 4488 of file qgis.h.

ScaleMethod

enum class Qgis::ScaleMethod : int

strong

Scale methods.

Since

QGIS 3.20

Enumerator
ScaleArea	Calculate scale by the area.
ScaleDiameter	Calculate scale by the diameter.

Definition at line 433 of file qgis.h.

ScaleToTileZoomLevelMethod

enum class Qgis::ScaleToTileZoomLevelMethod : int

strong

Available methods for converting map scales to tile zoom levels.

Since

QGIS 3.26

Enumerator
MapBox	Uses a scale doubling approach to account for hi-DPI tiles, and rounds to the nearest tile level for the map scale.
Esri	No scale doubling, always rounds down when matching to available tile levels.

Definition at line 2914 of file qgis.h.

ScriptLanguage

enum class Qgis::ScriptLanguage : int

strong

Scripting languages.

Since

QGIS 3.30

Enumerator
Css	CSS.
QgisExpression	QGIS expressions.
Html	HTML.
JavaScript	JavaScript.
Json	JSON.
Python	Python.
R	R Stats.
Sql	SQL.
Batch	Windows batch files.
Bash	Bash scripts.
Unknown	Unknown/other language.

Definition at line 3883 of file qgis.h.

ScriptLanguageCapability

enum class Qgis::ScriptLanguageCapability : int

strong

Script language capabilities.

The flags reflect the support capabilities of a scripting language.

Since

QGIS 3.32

Enumerator
Reformat	Language supports automatic code reformatting.
CheckSyntax	Language supports syntax checking.
ToggleComment	Language supports comment toggling.

Definition at line 3906 of file qgis.h.

SelectBehavior

enum class Qgis::SelectBehavior : int

strong

Specifies how a selection should be applied.

Since

QGIS 3.22

Enumerator
SetSelection	Set selection, removing any existing selection.
AddToSelection	Add selection to current selection.
IntersectSelection	Modify current selection to include only select features which match.
RemoveFromSelection	Remove from current selection.

Definition at line 1437 of file qgis.h.

SelectGeometryRelationship

enum class Qgis::SelectGeometryRelationship : int

strong

Geometry relationship test to apply for selecting features.

Since

QGIS 3.28

Enumerator
Intersect	Select where features intersect the reference geometry.
Within	Select where features are within the reference geometry.

Definition at line 1451 of file qgis.h.

SelectionFlag

enum class Qgis::SelectionFlag : int

strong

Flags which control feature selection behavior.

Since

QGIS 3.28

Enumerator
SingleFeatureSelection	Select only a single feature, picking the "best" match for the selection geometry.
ToggleSelection	Enables a "toggle" selection mode, where previously selected matching features will be deselected and previously deselected features will be selected. This flag works only when the SingleFeatureSelection flag is also set.

Definition at line 1463 of file qgis.h.

SelectionRenderingMode

enum class Qgis::SelectionRenderingMode : int

strong

Specifies how a selection should be rendered.

Since

QGIS 3.34

Enumerator
Default	Use default symbol and selection colors.
CustomColor	Use default symbol with a custom selection color.
CustomSymbol	Use a custom symbol.

Definition at line 1424 of file qgis.h.

SensorThingsEntity

enum class Qgis::SensorThingsEntity : int

strong

OGC SensorThings API entity types.

Since

QGIS 3.36

Enumerator
Invalid	An invalid/unknown entity.
Thing	A Thing is an object of the physical world (physical things) or the information world (virtual things) that is capable of being identified and integrated into communication networks.
Location	A Location entity locates the Thing or the Things it associated with. A Thing’s Location entity is defined as the last known location of the Thing.
HistoricalLocation	A Thing’s HistoricalLocation entity set provides the times of the current (i.e., last known) and previous locations of the Thing.
Datastream	A Datastream groups a collection of Observations measuring the same ObservedProperty and produced by the same Sensor.
Sensor	A Sensor is an instrument that observes a property or phenomenon with the goal of producing an estimate of the value of the property.
ObservedProperty	An ObservedProperty specifies the phenomenon of an Observation.
Observation	An Observation is the act of measuring or otherwise determining the value of a property.
FeatureOfInterest	In the context of the Internet of Things, many Observations’ FeatureOfInterest can be the Location of the Thing. For example, the FeatureOfInterest of a wifi-connect thermostat can be the Location of the thermostat (i.e., the living room where the thermostat is located in). In the case of remote sensing, the FeatureOfInterest can be the geographical area or volume that is being sensed.
MultiDatastream	A MultiDatastream groups a collection of Observations and the Observations in a MultiDatastream have a complex result type. Implemented in the SensorThings version 1.1 "MultiDatastream extension". (Since QGIS 3.38)

Definition at line 5098 of file qgis.h.

SettingsOption

enum class Qgis::SettingsOption : int

strong

Settings options.

Since

QGIS 3.26

Enumerator
SaveFormerValue
SaveEnumFlagAsInt

Definition at line 533 of file qgis.h.

SettingsOrigin

enum class Qgis::SettingsOrigin : int

strong

The setting origin describes where a setting is stored.

Since

QGIS 3.30

Enumerator
Any	From any origin.
Global	Global settings are stored in qgis_global_settings.ini
Local	Local settings are stored in the user profile.

Definition at line 3870 of file qgis.h.

SettingsTreeNodeOption

enum class Qgis::SettingsTreeNodeOption : int

strong

Options for named list nodes.

Since

QGIS 3.30

Enumerator
NamedListSelectedItemSetting	Creates a setting to store which is the current item.

Definition at line 475 of file qgis.h.

SettingsTreeNodeType

enum class Qgis::SettingsTreeNodeType

strong

Type of tree node.

Since

QGIS 3.30

Enumerator
Root	Root Node.
Standard	Normal Node.
NamedList

Definition at line 463 of file qgis.h.

SettingsType

enum class Qgis::SettingsType : int

strong

Types of settings entries.

Since

QGIS 3.26

Enumerator
Custom	Custom implementation.
Variant	Generic variant.
String	String.
StringList	List of strings.
VariantMap	Map of strings.
Bool	Boolean.
Integer	Integer.
Double	Double precision number.
EnumFlag	Enum or Flag.
Color	Color.

Definition at line 444 of file qgis.h.

ShaderClassificationMethod

enum class Qgis::ShaderClassificationMethod : int

strong

Color ramp shader classification methods.

Note

Prior to QGIS 3.38 this was available as QgsColorRampShader::ClassificationMode

Since

QGIS 3.38

Enumerator
Continuous	Uses breaks from color palette.
EqualInterval	Uses equal interval.
Quantile	Uses quantile (i.e. equal pixel) count.

Definition at line 1169 of file qgis.h.

ShaderInterpolationMethod

enum class Qgis::ShaderInterpolationMethod : int

strong

Color ramp shader interpolation methods.

Note

Prior to QGIS 3.38 this was available as QgsColorRampShader::Type

Since

QGIS 3.38

Enumerator
Linear	Interpolates the color between two class breaks linearly.
Discrete	Assigns the color of the higher class for every pixel between two class breaks.
Exact	Assigns the color of the exact matching value in the color ramp item list.

Definition at line 1154 of file qgis.h.

SldExportOption

enum class Qgis::SldExportOption : int

strong

SLD export options.

Since

QGIS 3.30

Enumerator
NoOptions	Default SLD export.
Svg	Export complex styles to separate SVG files for better compatibility with OGC servers.
Png	Export complex styles to separate PNG files for better compatibility with OGC servers.

Definition at line 505 of file qgis.h.

SldExportVendorExtension

enum class Qgis::SldExportVendorExtension : int

strong

SLD export vendor extensions, allow the use of vendor extensions when exporting to SLD.

Since

QGIS 3.30

Enumerator
NoVendorExtension	No vendor extensions.
GeoServerVendorExtension	Use GeoServer vendor extensions when required.
DeegreeVendorExtension	Use Deegree vendor extensions when required.

Definition at line 520 of file qgis.h.

SnappingMode

enum class Qgis::SnappingMode : int

strong

SnappingMode defines on which layer the snapping is performed.

Since

QGIS 3.26

Enumerator
ActiveLayer	On the active layer.
AllLayers	On all vector layers.
AdvancedConfiguration	On a per layer configuration basis.

Definition at line 546 of file qgis.h.

SnappingType

enum class Qgis::SnappingType : int

strong

SnappingTypeFlag defines on what object the snapping is performed.

Since

QGIS 3.26

Enumerator
NoSnap	No snapping.
Vertex	On vertices.
Segment	On segments.
Area	On Area.
Centroid	On centroid.
MiddleOfSegment	On Middle segment.
LineEndpoint	Start or end points of lines, or first vertex in polygon rings only (since QGIS 3.20)

Definition at line 558 of file qgis.h.

SpatialFilterType

enum class Qgis::SpatialFilterType : int

strong

Feature request spatial filter types.

Since

QGIS 3.22

Enumerator
NoFilter	No spatial filtering of features.
BoundingBox	Filter using a bounding box.
DistanceWithin	Filter by distance to reference geometry.

Definition at line 1884 of file qgis.h.

SpatialIndexPresence

enum class Qgis::SpatialIndexPresence : int

strong

Enumeration of spatial index presence states.

Note

Prior to QGIS 3.36 this was available as QgsFeatureSource::SpatialIndexPresence

Since

QGIS 3.36

Enumerator
Unknown	Spatial index presence cannot be determined, index may or may not exist.
NotPresent	No spatial index exists for the source.
Present	A valid spatial index exists for the source.

Definition at line 367 of file qgis.h.

SqlKeywordCategory

enum class Qgis::SqlKeywordCategory : int

strong

SqlKeywordCategory enum represents the categories of the SQL keywords used by the SQL query editor.

Note

The category has currently no usage, but it was planned for future uses.

Since

QGIS 3.22

Enumerator
Keyword	SQL keyword.
Constant	SQL constant.
Function	SQL generic function.
Geospatial	SQL spatial function.
Operator	SQL operator.
Math	SQL math function.
Aggregate	SQL aggregate function.
String	SQL string function.
Identifier	SQL identifier.

Definition at line 858 of file qgis.h.

SqlLayerDefinitionCapability

enum class Qgis::SqlLayerDefinitionCapability : int

strong

SqlLayerDefinitionCapability enum lists the arguments supported by the provider when creating SQL query layers.

Since

QGIS 3.22

Enumerator
SubsetStringFilter	SQL layer definition supports subset string filter.
GeometryColumn	SQL layer definition supports geometry column.
PrimaryKeys	SQL layer definition supports primary keys.
UnstableFeatureIds	SQL layer definition supports disabling select at id.

Definition at line 841 of file qgis.h.

Statistic

enum class Qgis::Statistic : int

strong

Available generic statistics.

Since

QGIS 3.36. Prior to 3.36 this was available as QgsStatisticalSummary::Statistic.

Enumerator
Count	Count.
CountMissing	Number of missing (null) values.
Sum	Sum of values.
Mean	Mean of values.
Median	Median of values.
StDev	Standard deviation of values.
StDevSample	Sample standard deviation of values.
Min	Min of values.
Max	Max of values.
Range	Range of values (max - min)
Minority	Minority of values.
Majority	Majority of values.
Variety	Variety (count of distinct) values.
FirstQuartile	First quartile.
ThirdQuartile	Third quartile.
InterQuartileRange	Inter quartile range (IQR)
First	First value (since QGIS 3.6)
Last	Last value (since QGIS 3.6)
All	All statistics.

Definition at line 4980 of file qgis.h.

StringStatistic

enum class Qgis::StringStatistic : int

strong

Available string statistics.

Since

QGIS 3.36. Prior to 3.36 this was available as QgsStringStatisticalSummary::Statistic.

Enumerator
Count	Count.
CountDistinct	Number of distinct string values.
CountMissing	Number of missing (null) values.
Min	Minimum string value.
Max	Maximum string value.
MinimumLength	Minimum length of string.
MaximumLength	Maximum length of string.
MeanLength	Mean length of strings.
Minority	Minority of strings.
Majority	Majority of strings.
All	All statistics.

Definition at line 5042 of file qgis.h.

SublayerFlag

enum class Qgis::SublayerFlag : int

strong

Flags which reflect the properties of sublayers in a dataset.

Since

QGIS 3.22

Enumerator
SystemTable	Sublayer is a system or internal table, which should be hidden by default.

Definition at line 1138 of file qgis.h.

SublayerPromptMode

enum class Qgis::SublayerPromptMode : int

strong

Specifies how to handle layer sources with multiple sublayers.

Since

QGIS 3.22

Enumerator
AlwaysAsk	Always ask users to select from available sublayers, if sublayers are present.
AskExcludingRasterBands	Ask users to select from available sublayers, unless only raster bands are present.
NeverAskSkip	Never ask users to select sublayers, instead don't load anything.
NeverAskLoadAll	Never ask users to select sublayers, instead automatically load all available sublayers.

Definition at line 1354 of file qgis.h.

SublayerQueryFlag

enum class Qgis::SublayerQueryFlag : int

strong

Flags which control how data providers will scan for sublayers in a dataset.

Since

QGIS 3.22

Enumerator
FastScan	Indicates that the provider must scan for sublayers using the fastest possible approach – e.g. by first checking that a uri has an extension which is known to be readable by the provider.
ResolveGeometryType	Attempt to resolve the geometry type for vector sublayers.
CountFeatures	Count features in vector sublayers.
IncludeSystemTables	Include system or internal tables (these are not included by default)

Definition at line 1121 of file qgis.h.

SymbolCoordinateReference

enum class Qgis::SymbolCoordinateReference : int

strong

Symbol coordinate reference modes.

Note

Prior to QGIS 3.24 this was available as QgsGradientFillSymbolLayer::GradientCoordinateMode

Since

QGIS 3.24

Enumerator
Feature	Relative to feature/shape being rendered.
Viewport	Relative to the whole viewport/output device.

Definition at line 2727 of file qgis.h.

SymbolFlag

enum class Qgis::SymbolFlag : int

strong

Flags controlling behavior of symbols.

Since

QGIS 3.20

Enumerator
RendererShouldUseSymbolLevels	If present, indicates that a QgsFeatureRenderer using the symbol should use symbol levels for best results.

Definition at line 604 of file qgis.h.

SymbolLayerFlag

enum class Qgis::SymbolLayerFlag : int

strong

Flags controlling behavior of symbol layers.

Note

These differ from Qgis::SymbolLayerUserFlag in that Qgis::SymbolLayerFlag flags are used to reflect the inbuilt properties of a symbol layer type, whereas Qgis::SymbolLayerUserFlag are optional, user controlled flags which can be toggled for a symbol layer.

Since

QGIS 3.22

Enumerator
DisableFeatureClipping	If present, indicates that features should never be clipped to the map extent during rendering.

Definition at line 636 of file qgis.h.

SymbolLayerUserFlag

enum class Qgis::SymbolLayerUserFlag : int

strong

User-specified flags controlling behavior of symbol layers.

Note

These differ from Qgis::SymbolLayerFlag in that Qgis::SymbolLayerFlag flags are used to reflect the inbuilt properties of a symbol layer type, whereas Qgis::SymbolLayerUserFlag are optional, user controlled flags which can be toggled for a symbol layer.

Since

QGIS 3.34

Enumerator
DisableSelectionRecoloring	If present, indicates that the symbol layer should not be recolored when rendering selected features.

Definition at line 654 of file qgis.h.

SymbolPreviewFlag

enum class Qgis::SymbolPreviewFlag : int

strong

Flags for controlling how symbol preview images are generated.

Since

QGIS 3.20

Enumerator
FlagIncludeCrosshairsForMarkerSymbols	Include a crosshairs reference image in the background of marker symbol previews.

Definition at line 618 of file qgis.h.

SymbolRenderHint

enum class Qgis::SymbolRenderHint : int

strong

Flags controlling behavior of symbols during rendering.

Since

QGIS 3.20

Enumerator
DynamicRotation	Rotation of symbol may be changed during rendering and symbol should not be cached.

Definition at line 578 of file qgis.h.

SymbolRotationMode

enum class Qgis::SymbolRotationMode : int

strong

Modes for handling how symbol and text entity rotation is handled when maps are rotated.

Since

QGIS 3.32

Enumerator
RespectMapRotation	Entity is rotated along with the map.
IgnoreMapRotation	Entity ignores map rotation.

Definition at line 592 of file qgis.h.

SymbolType

enum class Qgis::SymbolType : int

strong

Symbol types.

Since

QGIS 3.20

Enumerator
Marker	Marker symbol.
Line	Line symbol.
Fill	Fill symbol.
Hybrid	Hybrid symbol.

Definition at line 419 of file qgis.h.

SystemOfMeasurement

enum class Qgis::SystemOfMeasurement : int

strong

Systems of unit measurement.

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes::SystemOfMeasurement.

Since

QGIS 3.30

Enumerator
Unknown	Unknown system of measurement.
Metric	International System of Units (SI)
Imperial	British Imperial.
USCS	United States customary system.

Definition at line 4310 of file qgis.h.

TemporalIntervalMatchMethod

enum class Qgis::TemporalIntervalMatchMethod : int

strong

Method to use when resolving a temporal range to a data provider layer or band.

Since

QGIS 3.22

Enumerator
MatchUsingWholeRange	Use an exact match to the whole temporal range.
MatchExactUsingStartOfRange	Match the start of the temporal range to a corresponding layer or band, and only use exact matching results.
MatchExactUsingEndOfRange	Match the end of the temporal range to a corresponding layer or band, and only use exact matching results.
FindClosestMatchToStartOfRange	Match the start of the temporal range to the least previous closest datetime.
FindClosestMatchToEndOfRange	Match the end of the temporal range to the least previous closest datetime.

Definition at line 2251 of file qgis.h.

TemporalNavigationMode

enum class Qgis::TemporalNavigationMode : int

strong

Temporal navigation modes.

Note

Prior to QGIS 3.36 this was available as QgsTemporalNavigationObject::NavigationMode

Since

QGIS 3.36

Enumerator
Disabled	Temporal navigation is disabled.
Animated	Temporal navigation relies on frames within a datetime range.
FixedRange	Temporal navigation relies on a fixed datetime range.
Movie	Movie mode – behaves like a video player, with a fixed frame duration and no temporal range (since QGIS 3.36)

Definition at line 2149 of file qgis.h.

TemporalUnit

enum class Qgis::TemporalUnit : int

strong

Temporal units.

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes::TemporalUnit.

Since

QGIS 3.30

Enumerator
Milliseconds	Milliseconds.
Seconds	Seconds.
Minutes	Minutes.
Hours	Hours.
Days	Days.
Weeks	Weeks.
Months	Months.
Years	Years.
Decades	Decades.
Centuries	Centuries.
IrregularStep	Special 'irregular step' time unit, used for temporal data which uses irregular, non-real-world unit steps (since QGIS 3.20)
Unknown	Unknown time unit.

Definition at line 4464 of file qgis.h.

TextCharacterVerticalAlignment

enum class Qgis::TextCharacterVerticalAlignment : int

strong

Text vertical alignment for characters.

This enum controls vertical alignment of individual characters within a block of text.

Since

QGIS 3.30

Enumerator
Normal	Adjacent characters are positioned in the standard way for text in the writing system in use.
SuperScript	Characters are placed above the base line for normal text.
SubScript	Characters are placed below the base line for normal text.

Definition at line 2545 of file qgis.h.

TextComponent

enum class Qgis::TextComponent : int

strong

Text components.

Note

Prior to QGIS 3.28 this was available as QgsTextRenderer::TextPart

Since

QGIS 3.28

Enumerator
Text	Text component.
Buffer	Buffer component.
Background	Background shape.
Shadow	Drop shadow.

Definition at line 2494 of file qgis.h.

TextHorizontalAlignment

enum class Qgis::TextHorizontalAlignment : int

strong

Text horizontal alignment.

Note

Prior to QGIS 3.28 this was available as QgsTextRenderer::HAlignment

Since

QGIS 3.28

Enumerator
Left	Left align.
Center	Center align.
Right	Right align.
Justify	Justify align.

Definition at line 2510 of file qgis.h.

TextLayoutMode

enum class Qgis::TextLayoutMode : int

strong

Text layout modes.

Note

Prior to QGIS 3.28 this was available as QgsTextRenderer::DrawMode

Since

QGIS 3.28

Enumerator
Rectangle	Text within rectangle layout mode.
Point	Text at point of origin layout mode.
Labeling	Labeling-specific layout mode.
RectangleCapHeightBased	Similar to Rectangle mode, but uses cap height only when calculating font heights for the first line of text, and cap height + descent for subsequent lines of text (since QGIS 3.30)
RectangleAscentBased	Similar to Rectangle mode, but uses ascents only when calculating font and line heights. (since QGIS 3.30)

Definition at line 2477 of file qgis.h.

TextOrientation

enum class Qgis::TextOrientation : int

strong

Text orientations.

Note

Prior to QGIS 3.28 this was available as QgsTextFormat::TextOrientation

Since

QGIS 3.28

Enumerator
Horizontal	Horizontally oriented text.
Vertical	Vertically oriented text.
RotationBased	Horizontally or vertically oriented text based on rotation (only available for map labeling)

Definition at line 2462 of file qgis.h.

TextRendererFlag

enum class Qgis::TextRendererFlag : int

strong

Flags which control the behavior of rendering text.

Since

QGIS 3.24

Enumerator
WrapLines	Automatically wrap long lines of text.

Definition at line 2901 of file qgis.h.

TextRenderFormat

enum class Qgis::TextRenderFormat : int

strong

Options for rendering text.

Since

QGIS 3.22

Enumerator
AlwaysOutlines	Always render text using path objects (AKA outlines/curves). This setting guarantees the best quality rendering, even when using a raster paint surface (where sub-pixel path based text rendering is superior to sub-pixel text-based rendering). The downside is that text is converted to paths only, so users cannot open created vector outputs for post-processing in other applications and retain text editability. This setting also guarantees complete compatibility with the full range of formatting options available through QgsTextRenderer and QgsTextFormat, some of which may not be possible to reproduce when using a vector-based paint surface and TextFormatAlwaysText mode. A final benefit to this setting is that vector exports created using text as outlines do not require all users to have the original fonts installed in order to display the text in its original style.
AlwaysText	Always render text as text objects. While this mode preserves text objects as text for post-processing in external vector editing applications, it can result in rendering artifacts or poor quality rendering, depending on the text format settings. Even with raster based paint devices, TextFormatAlwaysText can result in inferior rendering quality to TextFormatAlwaysOutlines. When rendering using TextFormatAlwaysText to a vector based device (e.g. PDF or SVG), care must be taken to ensure that the required fonts are available to users when opening the created files, or default fallback fonts will be used to display the output instead. (Although PDF exports MAY automatically embed some fonts when possible, depending on the user's platform).

Definition at line 2403 of file qgis.h.

TextVerticalAlignment

enum class Qgis::TextVerticalAlignment : int

strong

Text vertical alignment.

This enum controls vertical alignment of text in a predefined rectangular bounding box. See also Qgis::TextCharacterVerticalAlignment.

Note

Prior to QGIS 3.28 this was available as QgsTextRenderer::VAlignment

Since

QGIS 3.28

Enumerator
Top	Align to top.
VerticalCenter	Center align.
Bottom	Align to bottom.

Definition at line 2529 of file qgis.h.

TileAvailability

enum class Qgis::TileAvailability

strong

Possible availability states for a tile within a tile matrix.

Since

QGIS 3.32

Enumerator
Available	Tile is available within the matrix.
NotAvailable	Tile is not available within the matrix, e.g. there is no content for the tile.
AvailableNoChildren	Tile is available within the matrix, and is known to have no children (ie no higher zoom level tiles exist covering this tile's region)
UseLowerZoomLevelTile	Tile is not available at the requested zoom level, it should be replaced by a tile from a lower zoom level instead182.

Definition at line 4760 of file qgis.h.

TileChildrenAvailability

enum class Qgis::TileChildrenAvailability

strong

Possible availability states for a tile's children.

Since

QGIS 3.34

Enumerator
NoChildren	Tile is known to have no children.
Available	Tile children are already available.
NeedFetching	Tile has children, but they are not yet available and must be fetched.

Definition at line 4821 of file qgis.h.

TiledSceneBoundingVolumeType

enum class Qgis::TiledSceneBoundingVolumeType

strong

Tiled scene bounding volume types.

Since

QGIS 3.34

Enumerator
Region	Region type.
OrientedBox	Oriented bounding box (rotated box)
Sphere	Sphere.

Definition at line 4793 of file qgis.h.

TiledSceneProviderCapability

enum class Qgis::TiledSceneProviderCapability : int

strong

Tiled scene data provider capabilities.

Since

QGIS 3.34

Enumerator
ReadLayerMetadata	Provider can read layer metadata from data store. See QgsDataProvider::layerMetadata()

Definition at line 4774 of file qgis.h.

TiledSceneRendererFlag

enum class Qgis::TiledSceneRendererFlag : int

strong

Flags which control how tiled scene 2D renderers behave.

Since

QGIS 3.34

Enumerator
RequiresTextures	Renderer requires textures.
ForceRasterRender	Layer should always be rendered as a raster image.
RendersTriangles	Renderer can render triangle primitives.
RendersLines	Renderer can render line primitives.

Definition at line 4853 of file qgis.h.

TiledSceneRequestFlag

enum class Qgis::TiledSceneRequestFlag : int

strong

Flags which control how tiled scene requests behave.

Since

QGIS 3.34

Enumerator
NoHierarchyFetch	Do not allow hierarchy fetching when hierarchy is not currently available. Avoids network requests, but may result in an incomplete tile set. If set, then callers will need to manually perform hierarchy fetches as required.

Definition at line 4834 of file qgis.h.

TilePixelRatio

enum class Qgis::TilePixelRatio

strong

DpiMode enum.

Since

QGIS 3.30

Enumerator
Undefined	Undefined (not scale)
StandardDpi	Standard (96 DPI)
HighDpi	High (192 DPI)

Definition at line 2866 of file qgis.h.

TileRefinementProcess

enum class Qgis::TileRefinementProcess

strong

Tiled scene tile refinement processes.

Refinement determines the process by which a lower resolution parent tile renders when its higher resolution children are selected to be rendered.

Since

QGIS 3.34

Enumerator
Replacement	When tile is refined then its children should be used in place of itself.
Additive	When tile is refined its content should be used alongside its children simultaneously.

Definition at line 4809 of file qgis.h.

TransactionMode

enum class Qgis::TransactionMode : int

strong

Transaction mode.

Since

QGIS 3.26

Enumerator
Disabled	Edits are buffered locally and sent to the provider when toggling layer editing mode.
AutomaticGroups	Automatic transactional editing means that on supported datasources (postgres and geopackage databases) the edit state of all tables that originate from the same database are synchronized and executed in a server side transaction.
BufferedGroups	Buffered transactional editing means that all editable layers in the buffered transaction group are toggled synchronously and all edits are saved in a local edit buffer. Saving changes is executed within a single transaction on all layers (per provider).

Definition at line 3389 of file qgis.h.

TransformDirection

enum class Qgis::TransformDirection : int

strong

Indicates the direction (forward or inverse) of a transform.

Since

QGIS 3.22

Enumerator
Forward	Forward transform (from source to destination)
Reverse	Reverse/inverse transform (from destination to source)

Definition at line 2285 of file qgis.h.

UnitType

enum class Qgis::UnitType : int

strong

Unit types.

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes::UnitType.

Since

QGIS 3.30

Enumerator
Distance	Distance unit.
Area	Area unit.
Volume	Volume unit.
Unknown	Unknown unit type.
Temporal	Temporal unit.

Definition at line 4340 of file qgis.h.

UnplacedLabelVisibility

enum class Qgis::UnplacedLabelVisibility : int

strong

Unplaced label visibility.

Since

QGIS 3.20

Enumerator
FollowEngineSetting	Respect the label engine setting.
NeverShow	Never show unplaced labels, regardless of the engine setting.

Definition at line 905 of file qgis.h.

UpsideDownLabelHandling

enum class Qgis::UpsideDownLabelHandling : int

strong

Handling techniques for upside down labels.

Note

Prior to QGIS 3.26 this was available as QgsPalLayerSettings::UpsideDownLabels

Since

QGIS 3.26

Enumerator
FlipUpsideDownLabels	Upside-down labels (90 <= angle < 270) are shown upright.
AllowUpsideDownWhenRotationIsDefined	Show upside down when rotation is layer- or data-defined.
AlwaysAllowUpsideDown	Show upside down for all labels, including dynamic ones.

Definition at line 1073 of file qgis.h.

UserProfileSelectionPolicy

enum class Qgis::UserProfileSelectionPolicy : int

strong

User profile selection policy.

Since

QGIS 3.32

Enumerator
LastProfile	Open the last closed profile (only mode supported prior to QGIS 3.32)
DefaultProfile	Open a specific profile.
AskUser	Let the user choose which profile to open.

Definition at line 4602 of file qgis.h.

VectorDataProviderAttributeEditCapability

enum class Qgis::VectorDataProviderAttributeEditCapability : int

strong

Attribute editing capabilities which may be supported by vector data providers.

Since

QGIS 3.32

Enumerator
EditAlias	Allows editing aliases.
EditComment	Allows editing comments.

Definition at line 399 of file qgis.h.

VectorDataProviderTemporalMode

enum class Qgis::VectorDataProviderTemporalMode : int

strong

Vector data provider temporal handling modes.

Since

QGIS 3.22

Enumerator
HasFixedTemporalRange	Entire dataset from provider has a fixed start and end datetime.
StoresFeatureDateTimeInstantInField	Dataset has feature datetime instants stored in a single field.
StoresFeatureDateTimeStartAndEndInSeparateFields	Dataset stores feature start and end datetimes in separate fields.

Definition at line 2223 of file qgis.h.

VectorEditResult

enum class Qgis::VectorEditResult : int

strong

Specifies the result of a vector layer edit operation.

Since

QGIS 3.22

Enumerator
Success	Edit operation was successful.
EmptyGeometry	Edit operation resulted in an empty geometry.
EditFailed	Edit operation failed.
FetchFeatureFailed	Unable to fetch requested feature.
InvalidLayer	Edit failed due to invalid layer.

Definition at line 1484 of file qgis.h.

VectorExportResult

enum class Qgis::VectorExportResult : int

strong

Vector layer export result codes.

Since

QGIS 3.20

Enumerator
Success	No errors were encountered.
ErrorCreatingDataSource	Could not create the destination data source.
ErrorCreatingLayer	Could not create destination layer.
ErrorAttributeTypeUnsupported	Source layer has an attribute type which could not be handled by destination.
ErrorAttributeCreationFailed	Destination provider was unable to create an attribute.
ErrorProjectingFeatures	An error occurred while reprojecting features to destination CRS.
ErrorFeatureWriteFailed	An error occurred while writing a feature to the destination.
ErrorInvalidLayer	Could not access newly created destination layer.
ErrorInvalidProvider	Could not find a matching provider key.
ErrorProviderUnsupportedFeature	Provider does not support creation of empty layers.
ErrorConnectionFailed	Could not connect to destination.
UserCanceled	User canceled the export.

Definition at line 802 of file qgis.h.

VectorFileWriterCapability

enum class Qgis::VectorFileWriterCapability : int

strong

Capabilities supported by a QgsVectorFileWriter object.

Since

QGIS 3.32

Enumerator
FieldAliases	Writer can support field aliases.
FieldComments	Writer can support field comments.

Definition at line 823 of file qgis.h.

VectorLayerTypeFlag

enum class Qgis::VectorLayerTypeFlag : int

strong

Vector layer type flags.

Since

QGIS 3.24

Enumerator
SqlQuery	SQL query layer.

Definition at line 326 of file qgis.h.

VectorProfileType

enum class Qgis::VectorProfileType : int

strong

Types of elevation profiles to generate for vector sources.

Since

QGIS 3.26

Enumerator
IndividualFeatures	Treat each feature as an individual object (eg buildings)
ContinuousSurface	The features should be treated as representing values on a continuous surface (eg contour lines)

Definition at line 3613 of file qgis.h.

VectorRenderingSimplificationFlag

enum class Qgis::VectorRenderingSimplificationFlag : int

strong

Simplification flags for vector feature rendering.

Note

Prior to QGIS 3.38 this was available as QgsVectorSimplifyMethod::SimplifyHint

Since

QGIS 3.38

Enumerator
NoSimplification	No simplification can be applied.
GeometrySimplification	The geometries can be simplified using the current map2pixel context state.
AntialiasingSimplification	The geometries can be rendered with 'AntiAliasing' disabled because of it is '1-pixel size'.
FullSimplification	All simplification hints can be applied ( Geometry + AA-disabling )

Definition at line 2576 of file qgis.h.

VectorSimplificationAlgorithm

enum class Qgis::VectorSimplificationAlgorithm : int

strong

Simplification algorithms for vector features.

Note

Prior to QGIS 3.38 this was available as QgsVectorSimplifyMethod::SimplifyAlgorithm

Since

QGIS 3.38

Enumerator
Distance	The simplification uses the distance between points to remove duplicate points.
SnapToGrid	The simplification uses a grid (similar to ST_SnapToGrid) to remove duplicate points.
Visvalingam	The simplification gives each point in a line an importance weighting, so that least important points are removed first.
SnappedToGridGlobal	Snap to a global grid based on the tolerance. Good for consistent results for incoming vertices, regardless of their feature.

Definition at line 2560 of file qgis.h.

VectorTemporalLimitMode

enum class Qgis::VectorTemporalLimitMode : int

strong

Mode for the handling of the limits of the filtering timeframe for vector features.

Since

QGIS 3.22

Enumerator
IncludeBeginExcludeEnd	Default mode: include the Begin limit, but exclude the End limit.
IncludeBeginIncludeEnd	Mode to include both limits of the filtering timeframe.

Definition at line 2211 of file qgis.h.

VectorTemporalMode

enum class Qgis::VectorTemporalMode : int

strong

Vector layer temporal feature modes.

Since

QGIS 3.22

Enumerator
FixedTemporalRange	Mode when temporal properties have fixed start and end datetimes.
FeatureDateTimeInstantFromField	Mode when features have a datetime instant taken from a single field.
FeatureDateTimeStartAndEndFromFields	Mode when features have separate fields for start and end times.
FeatureDateTimeStartAndDurationFromFields	Mode when features have a field for start time and a field for event duration.
FeatureDateTimeStartAndEndFromExpressions	Mode when features use expressions for start and end times.
RedrawLayerOnly	Redraw the layer when temporal range changes, but don't apply any filtering. Useful when symbology or rule based renderer expressions depend on the time range.

Definition at line 2195 of file qgis.h.

VectorTileProviderCapability

enum class Qgis::VectorTileProviderCapability : int

strong

Enumeration with capabilities that vector tile data providers might implement.

Since

QGIS 3.32

Enumerator
ReadLayerMetadata	Provider can read layer metadata from data store. See QgsDataProvider::layerMetadata()

Definition at line 4741 of file qgis.h.

VectorTileProviderFlag

enum class Qgis::VectorTileProviderFlag : int

strong

Flags for vector tile data providers.

Since

QGIS 3.32

Enumerator
AlwaysUseTileMatrixSetFromProvider	Vector tile layer must always use the tile matrix set from the data provider, and should never store, restore or override the definition of this matrix set.

Definition at line 4723 of file qgis.h.

VertexMarkerType

enum class Qgis::VertexMarkerType : int

strong

Editing vertex markers, used for showing vertices during a edit operation.

Since

QGIS 3.22

Enumerator
SemiTransparentCircle	Semi-transparent circle marker.
Cross	Cross marker.
NoMarker	No marker.

Definition at line 1499 of file qgis.h.

VertexType

enum class Qgis::VertexType : int

strong

Types of vertex.

Since

QGIS 3.22

Enumerator
Segment	The actual start or end point of a segment.
Curve	An intermediate point on a segment defining the curvature of the segment.

Definition at line 2613 of file qgis.h.

VerticalAxisInversion

enum class Qgis::VerticalAxisInversion : int

strong

Vertical axis inversion options for 3D views.

Since

QGIS 3.30

Enumerator
Never	Never invert vertical axis movements.
WhenDragging	Invert vertical axis movements when dragging in first person modes.
Always	Always invert vertical axis movements.

Definition at line 3587 of file qgis.h.

ViewSyncModeFlag

enum class Qgis::ViewSyncModeFlag : int

strong

Synchronization of 2D map canvas and 3D view.

Since

QGIS 3.26

Enumerator
Sync3DTo2D	Synchronize 3D view camera to the main map canvas extent.
Sync2DTo3D	Update the 2D main canvas extent to include the viewed area from the 3D view.

Definition at line 2952 of file qgis.h.

VolumeUnit

enum class Qgis::VolumeUnit : int

strong

Units of volume.

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes::VolumeUnit.

Since

QGIS 3.30

Enumerator
CubicMeters	Cubic meters.
CubicFeet	Cubic feet.
CubicYards	Cubic yards.
Barrel	Barrels.
CubicDecimeter	Cubic decimeters.
Liters	Litres.
GallonUS	US Gallons.
CubicInch	Cubic inches.
CubicCentimeter	Cubic Centimeters.
CubicDegrees	Cubic degrees, for planar geographic CRS volume measurements.
Unknown	Unknown volume unit.

Definition at line 4420 of file qgis.h.

WkbType

enum class Qgis::WkbType : quint32

strong

The WKB type describes the number of dimensions a geometry has.

• Point
• LineString
• Polygon

as well as the number of dimensions for each individual vertex

• X (always)
• Y (always)
• Z (optional)
• M (measurement value, optional)

it also has values for multi types, collections, unknown geometry, null geometry, no geometry and curve support.

These classes of geometry are often used for data sources to communicate what kind of geometry should be expected for a given geometry field. It is also used for tools or algorithms to decide if they should be available for a given geometry type or act in a different mode.

Note

Prior to 3.30 this was available as QgsWkbTypes.Type.

Since

QGIS 3.30

Enumerator
Unknown	Unknown.
Point	Point.
LineString	LineString.
Polygon	Polygon.
Triangle	Triangle.
MultiPoint	MultiPoint.
MultiLineString	MultiLineString.
MultiPolygon	MultiPolygon.
GeometryCollection	GeometryCollection.
CircularString	CircularString.
CompoundCurve	CompoundCurve.
CurvePolygon	CurvePolygon.
MultiCurve	MultiCurve.
MultiSurface	MultiSurface.
NoGeometry	No geometry.
PointZ	PointZ.
LineStringZ	LineStringZ.
PolygonZ	PolygonZ.
TriangleZ	TriangleZ.
MultiPointZ	MultiPointZ.
MultiLineStringZ	MultiLineStringZ.
MultiPolygonZ	MultiPolygonZ.
GeometryCollectionZ	GeometryCollectionZ.
CircularStringZ	CircularStringZ.
CompoundCurveZ	CompoundCurveZ.
CurvePolygonZ	CurvePolygonZ.
MultiCurveZ	MultiCurveZ.
MultiSurfaceZ	MultiSurfaceZ.
PointM	PointM.
LineStringM	LineStringM.
PolygonM	PolygonM.
TriangleM	TriangleM.
MultiPointM	MultiPointM.
MultiLineStringM	MultiLineStringM.
MultiPolygonM	MultiPolygonM.
GeometryCollectionM	GeometryCollectionM.
CircularStringM	CircularStringM.
CompoundCurveM	CompoundCurveM.
CurvePolygonM	CurvePolygonM.
MultiCurveM	MultiCurveM.
MultiSurfaceM	MultiSurfaceM.
PointZM	PointZM.
LineStringZM	LineStringZM.
PolygonZM	PolygonZM.
MultiPointZM	MultiPointZM.
MultiLineStringZM	MultiLineStringZM.
MultiPolygonZM	MultiPolygonZM.
GeometryCollectionZM	GeometryCollectionZM.
CircularStringZM	CircularStringZM.
CompoundCurveZM	CompoundCurveZM.
CurvePolygonZM	CurvePolygonZM.
MultiCurveZM	MultiCurveZM.
MultiSurfaceZM	MultiSurfaceZM.
TriangleZM	TriangleZM.
Point25D	Point25D.
LineString25D	LineString25D.
Polygon25D	Polygon25D.
MultiPoint25D	MultiPoint25D.
MultiLineString25D	MultiLineString25D.
MultiPolygon25D	MultiPolygon25D.

Definition at line 200 of file qgis.h.

ZonalStatistic

enum class Qgis::ZonalStatistic : int

strong

Statistics to be calculated during a zonal statistics operation.

Since

QGIS 3.36. Prior to 3.36 this was available as QgsZonalStatistics::Statistic.

Enumerator
Count	Pixel count.
Sum	Sum of pixel values.
Mean	Mean of pixel values.
Median	Median of pixel values.
StDev	Standard deviation of pixel values.
Min	Min of pixel values.
Max	Max of pixel values.
Range	Range of pixel values (max - min)
Minority	Minority of pixel values.
Majority	Majority of pixel values.
Variety	Variety (count of distinct) pixel values.
Variance	Variance of pixel values.
All	All statistics.
Default	Default statistics.

Definition at line 4898 of file qgis.h.

ZonalStatisticResult

enum class Qgis::ZonalStatisticResult : int

strong

Zonal statistics result codes.

Since

QGIS 3.36. Prior to 3.36 this was available as QgsZonalStatistics::Result.

Enumerator
Success	Success.
LayerTypeWrong	Layer is not a polygon layer.
LayerInvalid	Layer is invalid.
RasterInvalid	Raster layer is invalid.
RasterBandInvalid	The raster band does not exist on the raster layer.
FailedToCreateField	Output fields could not be created.
Canceled	Algorithm was canceled.

Definition at line 4930 of file qgis.h.

Member Function Documentation

defaultProjectScales()

QString Qgis::defaultProjectScales ( )

static

A string with default project scales.

Since

QGIS 3.12

Definition at line 252 of file qgis.cpp.

devVersion()

QString Qgis::devVersion ( )

static

The development version.

Since

QGIS 3.12

Definition at line 275 of file qgis.cpp.

geosVersion()

QString Qgis::geosVersion ( )

static

GEOS string version linked.

Since

QGIS 3.20

Definition at line 280 of file qgis.cpp.

geosVersionInt()

int Qgis::geosVersionInt ( )

static

GEOS version number linked.

Since

QGIS 3.20

Definition at line 285 of file qgis.cpp.

geosVersionMajor()

int Qgis::geosVersionMajor ( )

static

GEOS Major version number linked.

Since

QGIS 3.20

Definition at line 295 of file qgis.cpp.

geosVersionMinor()

int Qgis::geosVersionMinor ( )

static

GEOS Minor version number linked.

Since

QGIS 3.20

Definition at line 300 of file qgis.cpp.

geosVersionPatch()

int Qgis::geosVersionPatch ( )

static

GEOS Patch version number linked.

Since

QGIS 3.20

Definition at line 305 of file qgis.cpp.

Q_ENUM() [1/11]

Qgis::Q_ENUM

(

GnssConstellation

)

Q_ENUM() [2/11]

Qgis::Q_ENUM

(

GpsFixStatus

)

Q_ENUM() [3/11]

Qgis::Q_ENUM

(

GpsNavigationStatus

)

Q_ENUM() [4/11]

Qgis::Q_ENUM

(

InputControllerType

)

Q_ENUM() [5/11]

Qgis::Q_ENUM

(

ProcessingAlgorithmFlag

)

Q_ENUM() [6/11]

Qgis::Q_ENUM

(

ProcessingProviderFlag

)

Q_ENUM() [7/11]

Qgis::Q_ENUM

(

ProfileExportType

)

Q_ENUM() [8/11]

Qgis::Q_ENUM

(

ProfileSurfaceSymbology

)

Q_ENUM() [9/11]

Qgis::Q_ENUM

(

ProviderStyleStorageCapability

)

Q_ENUM() [10/11]

Qgis::Q_ENUM

(

ScaleToTileZoomLevelMethod

)

Q_ENUM() [11/11]

Qgis::Q_ENUM

(

VectorProfileType

)

releaseName()

QString Qgis::releaseName ( )

static

Release name.

Since

QGIS 3.12

Definition at line 270 of file qgis.cpp.

version()

QString Qgis::version ( )

static

Version string.

Since

QGIS 3.12

Definition at line 258 of file qgis.cpp.

versionInt()

int Qgis::versionInt ( )

static

Version number used for comparing versions using the "Check QGIS Version" function.

Since

QGIS 3.12

Definition at line 263 of file qgis.cpp.

Member Data Documentation

DEFAULT_HIGHLIGHT_BUFFER_MM

const double Qgis::DEFAULT_HIGHLIGHT_BUFFER_MM = 0.5

static

Default highlight buffer in mm.

Definition at line 5131 of file qgis.h.

DEFAULT_HIGHLIGHT_COLOR

const QColor Qgis::DEFAULT_HIGHLIGHT_COLOR = QColor( 255, 0, 0, 128 )

static

Default highlight color.

The transparency is expected to only be applied to polygon fill. Lines and outlines are rendered opaque.

Definition at line 5126 of file qgis.h.

DEFAULT_HIGHLIGHT_MIN_WIDTH_MM

const double Qgis::DEFAULT_HIGHLIGHT_MIN_WIDTH_MM = 1.0

static

Default highlight line/stroke minimum width in mm.

Definition at line 5136 of file qgis.h.

DEFAULT_M_COORDINATE

const double Qgis::DEFAULT_M_COORDINATE = 0.0

static

Default M coordinate value.

This value have to be assigned to the M coordinate for the vertex.

Since

QGIS 3.20

Definition at line 5156 of file qgis.h.

DEFAULT_MAPTOPIXEL_THRESHOLD

const float Qgis::DEFAULT_MAPTOPIXEL_THRESHOLD = 1.0f

static

Default threshold between map coordinates and device coordinates for map2pixel simplification.

Definition at line 5119 of file qgis.h.

DEFAULT_SEARCH_RADIUS_MM

const double Qgis::DEFAULT_SEARCH_RADIUS_MM = 2.

static

Identify search radius in mm.

Definition at line 5116 of file qgis.h.

DEFAULT_SNAP_TOLERANCE

const double Qgis::DEFAULT_SNAP_TOLERANCE = 12.0

static

Default snapping distance tolerance.

Definition at line 5167 of file qgis.h.

DEFAULT_SNAP_UNITS

const Qgis::MapToolUnit Qgis::DEFAULT_SNAP_UNITS = Qgis::MapToolUnit::Pixels

static

Default snapping distance units.

Definition at line 5172 of file qgis.h.

DEFAULT_Z_COORDINATE

const double Qgis::DEFAULT_Z_COORDINATE = 0.0

static

Default Z coordinate value.

This value have to be assigned to the Z coordinate for the vertex.

Definition at line 5149 of file qgis.h.

QGIS_DEV_VERSION

const char * Qgis::QGIS_DEV_VERSION = QGSVERSION

static

The development version.

Definition at line 82 of file qgis.h.

SCALE_PRECISION

const double Qgis::SCALE_PRECISION = 0.9999999999

static

Fudge factor used to compare two scales.

The code is often going from scale to scale denominator. So it looses precision and, when a limit is inclusive, can lead to errors. To avoid that, use this factor instead of using <= or >=.

Definition at line 5143 of file qgis.h.

UI_SCALE_FACTOR

const double Qgis::UI_SCALE_FACTOR = 1

static

UI scaling factor.

This should be applied to all widget sizes obtained from font metrics, to account for differences in the default font sizes across different platforms.

Definition at line 5162 of file qgis.h.

---

The documentation for this class was generated from the following files:

• /home/fischer/src/qgis-3.38/src/core/qgis.h
• /home/fischer/src/qgis-3.38/src/core/qgis.cpp