QGIS API Documentation  3.27.0-Master (bef583a8ef)
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
Qgis Class Reference

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

#include <qgis.h>

Public Types

enum class  ActionStart : int { SIP_MONKEYPATCH_COMPAT_NAME =( DownloadLater ) , SIP_MONKEYPATCH_COMPAT_NAME =( DownloadImmediately ) }
 Enum to determine when an operation would begin. More...
 
enum class  AltitudeBinding : int { Vertex , Centroid }
 Altitude binding. More...
 
enum class  AltitudeClamping : int { Absolute , Relative , Terrain }
 Altitude clamping. More...
 
enum class  AngularDirection : int { Clockwise , CounterClockwise }
 Angular directions. 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...
 
enum class  AnnotationItemGuiFlag : int { FlagNoCreationTools = 1 << 0 }
 Annotation item flags. More...
 
enum class  AnnotationItemNodeType : int { VertexHandle }
 Annotation item GUI flags. 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  BabelCommandFlag : int { QuoteFilePaths = 1 << 0 }
 Babel GPS format capabilities. More...
 
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  BrowserDirectoryMonitoring : int { Default , NeverMonitor , AlwaysMonitor }
 Browser directory item monitoring switches. More...
 
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
}
 Symbol layer flags. More...
 
enum class  BrowserLayerType : int {
  NoType , Vector , Raster , Point ,
  Line , Polygon , TableLayer , Database ,
  Table , Plugin , Mesh , VectorTile ,
  PointCloud
}
 Browser item layer types. More...
 
enum class  BufferSide : int { SIP_MONKEYPATCH_COMPAT_NAME =( SideLeft ) = 0 , SIP_MONKEYPATCH_COMPAT_NAME =( SideRight ) }
 Side of line to buffer. 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  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...
 
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
}
 Data provider flags. More...
 
enum class  CrsDefinitionFormat : int { SIP_MONKEYPATCH_COMPAT_NAME =( FormatWkt ) , SIP_MONKEYPATCH_COMPAT_NAME =( FormatProj ) }
 CRS definition formats. 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...
 
enum class  DataProviderFlag : int { IsBasemapSource = 1 << 1 }
 Map layer properties. More...
 
enum class  DataType : int {
  UnknownDataType = 0 , Byte = 1 , 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  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
}
 Drive types. More...
 
enum class  EndCapStyle : int { SIP_MONKEYPATCH_COMPAT_NAME =( CapRound ) = 1 , SIP_MONKEYPATCH_COMPAT_NAME =( CapFlat ) , SIP_MONKEYPATCH_COMPAT_NAME =( CapSquare ) }
 End cap styles for buffers. More...
 
enum class  FeatureCountState : int { Uncounted = -2 , UnknownCount = -1 }
 Enumeration of feature count states. More...
 
enum class  FieldDomainMergePolicy : int { DefaultValue , Sum , GeometryWeighted }
 Merge policy for field domains. More...
 
enum class  FieldDomainSplitPolicy : int { DefaultValue , Duplicate , GeometryRatio }
 Split policy for field domains. More...
 
enum class  FieldDomainType : int { Coded , Range , Glob }
 Types of field domain. More...
 
enum class  FileOperationFlag : int { IncludeMetadataFile = 1 << 0 , IncludeStyleFile = 1 << 1 }
 File operation flags. More...
 
enum class  FilePathType : int { Absolute , Relative }
 File path types. More...
 
enum class  GeometryOperationResult : int {
  Success = 0 , NothingHappened = 1000 , InvalidBaseGeometry , InvalidInputGeometryType ,
  SelectionIsEmpty , SelectionIsGreaterThanOne , GeometryEngineError , LayerNotEditable ,
  AddPartSelectedGeometryNotFound , AddPartNotMultiGeometry , AddRingNotClosed , AddRingNotValid ,
  AddRingCrossesExistingRings , AddRingNotInExistingFeature , SplitCannotSplitPoint
}
 Success or failure of a geometry operation. More...
 
enum class  GeometryValidationEngine : int { SIP_MONKEYPATCH_COMPAT_NAME =( ValidatorQgisInternal ) , SIP_MONKEYPATCH_COMPAT_NAME =( ValidatorGeos ) }
 Available engines for validating geometries. More...
 
enum class  GeometryValidityFlag : int { SIP_MONKEYPATCH_COMPAT_NAME =( FlagAllowSelfTouchingHoles ) = 1 << 0 }
 Geometry validity check flags. More...
 
enum class  GpsFeatureType : int { Waypoint , Route , Track }
 Babel command flags. 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 { SIP_MONKEYPATCH_COMPAT_NAME =( GraduatedColor ) , SIP_MONKEYPATCH_COMPAT_NAME =( GraduatedSize ) }
 Methods for modifying symbols by range in a graduated symbol renderer. More...
 
enum class  HistoryProviderBackend : int { LocalProfile = 1 << 0 }
 History provider backends. More...
 
enum class  HttpMethod : int { Get = 0 , Post = 1 }
 Different methods of HTTP requests. More...
 
enum class  JoinStyle : int { SIP_MONKEYPATCH_COMPAT_NAME =( JoinStyleRound ) = 1 , SIP_MONKEYPATCH_COMPAT_NAME =( JoinStyleMiter ) , SIP_MONKEYPATCH_COMPAT_NAME =( JoinStyleBevel ) }
 Join styles for buffers. More...
 
enum class  LabelMultiLineAlignment : int {
  SIP_MONKEYPATCH_COMPAT_NAME =( MultiLeft ) = 0 , SIP_MONKEYPATCH_COMPAT_NAME =( MultiCenter ) , SIP_MONKEYPATCH_COMPAT_NAME =( MultiRight ) , SIP_MONKEYPATCH_COMPAT_NAME =( MultiFollowPlacement ) ,
  SIP_MONKEYPATCH_COMPAT_NAME =( MultiJustify )
}
 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  LabelPredefinedPointPosition : int {
  TopLeft , TopSlightlyLeft , TopMiddle , TopSlightlyRight ,
  TopRight , MiddleLeft , MiddleRight , BottomLeft ,
  BottomSlightlyLeft , BottomMiddle , BottomSlightlyRight , BottomRight
}
 Positions for labels when using the Qgis::LabelPlacement::OrderedPositionsAroundPoint placement mode. More...
 
enum class  LabelQuadrantPosition : int {
  SIP_MONKEYPATCH_COMPAT_NAME =( QuadrantAboveLeft ) , SIP_MONKEYPATCH_COMPAT_NAME =( QuadrantAbove ) , SIP_MONKEYPATCH_COMPAT_NAME =( QuadrantAboveRight ) , SIP_MONKEYPATCH_COMPAT_NAME =( QuadrantLeft ) ,
  SIP_MONKEYPATCH_COMPAT_NAME =( QuadrantOver ) , SIP_MONKEYPATCH_COMPAT_NAME =( QuadrantRight ) , SIP_MONKEYPATCH_COMPAT_NAME =( QuadrantBelowLeft ) , SIP_MONKEYPATCH_COMPAT_NAME =( QuadrantBelow ) ,
  SIP_MONKEYPATCH_COMPAT_NAME =( QuadrantBelowRight )
}
 Label quadrant positions. More...
 
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  MapLayerProperty : int { UsersCannotToggleEditing = 1 << 0 , IsBasemapLayer = 1 << 1 }
 File operation flags. 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
}
 Coordinate transformation flags. 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...
 
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
}
 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  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  PlotToolFlag : int { ShowContextMenu = 1 << 0 }
 Flags that control the way the QgsPlotTools operate. 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 { SIP_MONKEYPATCH_COMPAT_NAME =( AbsoluteCount ) , SIP_MONKEYPATCH_COMPAT_NAME =( DensityBasedCount ) }
 Methods which define the number of points randomly filling a polygon. More...
 
enum class  ProfileGeneratorFlag : int { RespectsMaximumErrorMapUnit = 1 << 0 , RespectsDistanceRange = 1 << 1 , RespectsElevationRange = 1 << 2 }
 Flags that control the way the QgsAbstractProfileGenerator operate. More...
 
enum class  ProfileSurfaceSymbology : int { Line , FillBelow }
 Surface symbology type for elevation profile plots. 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...
 
enum class  ProjectReadFlag : int {
  SIP_MONKEYPATCH_COMPAT_NAME =( FlagDontResolveLayers ) = 1 << 0 , SIP_MONKEYPATCH_COMPAT_NAME =( FlagDontLoadLayouts ) = 1 << 1 , SIP_MONKEYPATCH_COMPAT_NAME =( FlagTrustLayerMetadata ) = 1 << 2 , SIP_MONKEYPATCH_COMPAT_NAME =( FlagDontStoreOriginalStyles ) = 1 << 3 ,
  SIP_MONKEYPATCH_COMPAT_NAME =( FlagDontLoad3DViews ) = 1 << 4 , DontLoadProjectStyles = 1 << 5
}
 Flags which control project read behavior. More...
 
enum class  PythonMacroMode : int {
  Never = 0 , Ask = 1 , SessionOnly = 2 , Always = 3 ,
  NotForThisSession
}
 Vector layer type flags. More...
 
enum class  RasterPipeInterfaceRole : int {
  SIP_MONKEYPATCH_COMPAT_NAME =( UnknownRole ) = 0 , SIP_MONKEYPATCH_COMPAT_NAME =( ProviderRole ) = 1 , SIP_MONKEYPATCH_COMPAT_NAME =( RendererRole ) = 2 , SIP_MONKEYPATCH_COMPAT_NAME =( BrightnessRole ) = 3 ,
  SIP_MONKEYPATCH_COMPAT_NAME =( ResamplerRole ) = 4 , SIP_MONKEYPATCH_COMPAT_NAME =( ProjectorRole ) = 5 , SIP_MONKEYPATCH_COMPAT_NAME =( NullerRole ) = 6 , SIP_MONKEYPATCH_COMPAT_NAME =( HueSaturationRole ) = 7
}
 Sublayer flags. More...
 
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...
 
enum class  RasterTemporalMode : int { SIP_MONKEYPATCH_COMPAT_NAME =( ModeFixedTemporalRange ) = 0 , SIP_MONKEYPATCH_COMPAT_NAME =( ModeTemporalRangeFromDataProvider ) = 1 , SIP_MONKEYPATCH_COMPAT_NAME =( ModeRedrawLayerOnly ) = 2 }
 Raster layer temporal modes. 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
}
 Flags which affect rendering operations. More...
 
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  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  SelectBehavior : int { SetSelection , AddToSelection , IntersectSelection , RemoveFromSelection }
 Specifies how a selection should be applied. More...
 
enum class  SettingsOption : int { SaveFormerValue = 1 << 1 , SaveEnumFlagAsInt = 1 << 2 }
 Settings options. More...
 
enum class  SettingsType : int {
  Variant , String , StringList , Bool ,
  Integer , Double , EnumFlag , Color
}
 Types of settings entries. 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 {
  SIP_MONKEYPATCH_COMPAT_NAME =( NoSnapFlag ) = 0 , SIP_MONKEYPATCH_COMPAT_NAME =( VertexFlag ) = 1 << 0 , SIP_MONKEYPATCH_COMPAT_NAME =( SegmentFlag ) = 1 << 1 , SIP_MONKEYPATCH_COMPAT_NAME =( AreaFlag ) = 1 << 2 ,
  SIP_MONKEYPATCH_COMPAT_NAME =( CentroidFlag ) = 1 << 3 , SIP_MONKEYPATCH_COMPAT_NAME =( MiddleOfSegmentFlag ) = 1 << 4 , SIP_MONKEYPATCH_COMPAT_NAME =( LineEndpointFlag ) = 1 << 5
}
 SnappingTypeFlag defines on what object the snapping is performed. More...
 
enum class  SpatialFilterType : int { NoFilter , BoundingBox , DistanceWithin }
 Feature request spatial filter types. More...
 
enum class  SqlKeywordCategory : int {
  Keyword , Constant , Function , Geospatial ,
  Operator , Math , Aggregate , String ,
  Identifier
}
 SQL layer definition capabilities. More...
 
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  SublayerFlag : int { SystemTable = 1 << 0 }
 Sublayer query flags. More...
 
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...
 
enum class  SymbolCoordinateReference : int { Feature , Viewport }
 Symbol coordinate reference modes. More...
 
enum class  SymbolFlag : int { RendererShouldUseSymbolLevels = 1 << 0 }
 Flags controlling behavior of symbols. More...
 
enum class  SymbolLayerFlag : int { DisableFeatureClipping = 1 << 0 }
 Flags controlling behavior of symbol layers. More...
 
enum class  SymbolPreviewFlag : int { FlagIncludeCrosshairsForMarkerSymbols = 1 << 0 }
 Symbol flags. More...
 
enum class  SymbolRenderHint : int { DynamicRotation = 2 }
 Flags controlling behavior of symbols during rendering. More...
 
enum class  SymbolType : int { Marker , Line , Fill , Hybrid }
 Symbol types. 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  TextRendererFlag : int { WrapLines = 1 << 0 }
 Flags which control the behavior of rendering text. More...
 
enum class  TextRenderFormat : int { SIP_MONKEYPATCH_COMPAT_NAME =( TextFormatAlwaysOutlines ) , SIP_MONKEYPATCH_COMPAT_NAME =( TextFormatAlwaysText ) }
 Options for rendering text. More...
 
enum class  TransactionMode : int { Disabled = 0 , AutomaticGroups = 1 , BufferedGroups = 2 }
 Transaction mode. More...
 
enum class  TransformDirection : int { SIP_MONKEYPATCH_COMPAT_NAME =( ForwardTransform ) , SIP_MONKEYPATCH_COMPAT_NAME =( ReverseTransform ) }
 Flags for raster layer temporal capabilities. More...
 
enum class  UnplacedLabelVisibility : int { FollowEngineSetting , NeverShow }
 Unplaced label visibility. More...
 
enum class  UpsideDownLabelHandling : int { SIP_MONKEYPATCH_COMPAT_NAME =( Upright ) , SIP_MONKEYPATCH_COMPAT_NAME =( ShowDefined ) , SIP_MONKEYPATCH_COMPAT_NAME =( ShowAll ) }
 Handling techniques for upside down labels. More...
 
enum class  VectorDataProviderTemporalMode : int { SIP_MONKEYPATCH_COMPAT_NAME =( ProviderHasFixedTemporalRange ) = 0 , SIP_MONKEYPATCH_COMPAT_NAME =( ProviderStoresFeatureDateTimeInstantInField ) , SIP_MONKEYPATCH_COMPAT_NAME =( ProviderStoresFeatureDateTimeStartAndEndInSeparateFields ) }
 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 {
  SIP_MONKEYPATCH_COMPAT_NAME =( NoError ) = 0 , SIP_MONKEYPATCH_COMPAT_NAME =( ErrCreateDataSource ) , SIP_MONKEYPATCH_COMPAT_NAME =( ErrCreateLayer ) , SIP_MONKEYPATCH_COMPAT_NAME =( ErrAttributeTypeUnsupported ) ,
  SIP_MONKEYPATCH_COMPAT_NAME =( ErrAttributeCreationFailed ) , SIP_MONKEYPATCH_COMPAT_NAME =( ErrProjection ) , SIP_MONKEYPATCH_COMPAT_NAME =( ErrFeatureWriteFailed ) , SIP_MONKEYPATCH_COMPAT_NAME =( ErrInvalidLayer ) ,
  SIP_MONKEYPATCH_COMPAT_NAME =( ErrInvalidProvider ) , SIP_MONKEYPATCH_COMPAT_NAME =( ErrProviderUnsupportedFeature ) , SIP_MONKEYPATCH_COMPAT_NAME =( ErrConnectionFailed ) , SIP_MONKEYPATCH_COMPAT_NAME =( ErrUserCanceled )
}
 Vector layer export result codes. More...
 
enum class  VectorLayerTypeFlag : int { SqlQuery = 1 << 0 }
 Vector layer type flags. More...
 
enum class  VectorProfileType : int { IndividualFeatures , ContinuousSurface }
 Types of elevation profiles to generate for vector sources. 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 {
  SIP_MONKEYPATCH_COMPAT_NAME =( ModeFixedTemporalRange ) = 0 , SIP_MONKEYPATCH_COMPAT_NAME =( ModeFeatureDateTimeInstantFromField ) , SIP_MONKEYPATCH_COMPAT_NAME =( ModeFeatureDateTimeStartAndEndFromFields ) , SIP_MONKEYPATCH_COMPAT_NAME =( ModeFeatureDateTimeStartAndDurationFromFields ) ,
  SIP_MONKEYPATCH_COMPAT_NAME =( ModeFeatureDateTimeStartAndEndFromExpressions ) , SIP_MONKEYPATCH_COMPAT_NAME =( ModeRedrawLayerOnly )
}
 Vector layer temporal feature modes. More...
 
enum class  VertexMarkerType : int { SemiTransparentCircle , Cross , NoMarker }
 Editing vertex markers, used for showing vertices during a edit operation. More...
 
enum class  VertexType : int { SIP_MONKEYPATCH_COMPAT_NAME =( SegmentVertex ) = 1 , SIP_MONKEYPATCH_COMPAT_NAME =( CurveVertex ) = 2 }
 Types of vertex. More...
 
enum class  ViewSyncModeFlag : int { Sync3DTo2D = 1 << 0 , Sync2DTo3D = 1 << 1 }
 Synchronization of 2D map canvas and 3D view. More...
 

Public Member Functions

 Q_DECLARE_FLAGS (BrowserItemCapabilities, BrowserItemCapability) SIP_MONKEYPATCH_FLAGS_UNNEST(QgsDataItem
 Browser item capabilities. More...
 
 Q_DECLARE_FLAGS (GeometryValidityFlags, GeometryValidityFlag) SIP_MONKEYPATCH_FLAGS_UNNEST(QgsGeometry
 Geometry validity flags. More...
 
 Q_DECLARE_FLAGS (MapSettingsFlags, MapSettingsFlag) SIP_MONKEYPATCH_FLAGS_UNNEST(QgsMapSettings
 Map settings flags. More...
 
 Q_DECLARE_FLAGS (ProjectReadFlags, ProjectReadFlag) SIP_MONKEYPATCH_FLAGS_UNNEST(QgsProject
 Project load flags. More...
 
 Q_DECLARE_FLAGS (RenderContextFlags, RenderContextFlag) SIP_MONKEYPATCH_FLAGS_UNNEST(QgsRenderContext
 Render context flags. More...
 
 Q_DECLARE_FLAGS (SnappingTypes, SnappingType) SIP_MONKEYPATCH_FLAGS_UNNEST(QgsSnappingConfig
 Snapping types. More...
 
 Q_DECLARE_FLAGS (SymbolPreviewFlags, SymbolPreviewFlag) SIP_MONKEYPATCH_FLAGS_UNNEST(QgsSymbol
 Symbol preview flags. More...
 
 Q_DECLARE_FLAGS (SymbolRenderHints, SymbolRenderHint) SIP_MONKEYPATCH_FLAGS_UNNEST(QgsSymbol
 Symbol render hints. More...
 
 Q_ENUM (ProfileSurfaceSymbology)
 
 Q_ENUM (ScaleToTileZoomLevelMethod)
 
 Q_ENUM (VectorProfileType)
 

Static Public Member Functions

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

Static Public Attributes

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

Detailed Description

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

Definition at line 71 of file qgis.h.

Member Enumeration Documentation

◆ ActionStart

enum Qgis::ActionStart : int
strong

Enum to determine when an operation would begin.

Since
QGIS 3.22
Enumerator
SIP_MONKEYPATCH_COMPAT_NAME 

Do not start immediately the action.

SIP_MONKEYPATCH_COMPAT_NAME 

Action will start immediately.

Definition at line 521 of file qgis.h.

◆ AltitudeBinding

enum 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 1788 of file qgis.h.

◆ AltitudeClamping

enum 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 1775 of file qgis.h.

◆ AngularDirection

enum Qgis::AngularDirection : int
strong

Angular directions.

Since
QGIS 3.24
Enumerator
Clockwise 

Clockwise direction.

CounterClockwise 

Counter-clockwise direction.

Definition at line 1653 of file qgis.h.

◆ AnnotationItemEditOperationResult

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 1153 of file qgis.h.

◆ AnnotationItemFlag

enum 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 1114 of file qgis.h.

◆ AnnotationItemGuiFlag

enum Qgis::AnnotationItemGuiFlag : int
strong

Annotation item flags.

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 1128 of file qgis.h.

◆ AnnotationItemNodeType

enum Qgis::AnnotationItemNodeType : int
strong

Annotation item GUI flags.

Annotation item node types.

Since
QGIS 3.22
Enumerator
VertexHandle 

Node is a handle for manipulating vertices.

Definition at line 1142 of file qgis.h.

◆ AvoidIntersectionsMode

enum 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 1933 of file qgis.h.

◆ BabelCommandFlag

enum Qgis::BabelCommandFlag : int
strong

Babel GPS format capabilities.

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 872 of file qgis.h.

◆ BabelFormatCapability

enum 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 853 of file qgis.h.

◆ BetweenLineConstraint

enum 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 1800 of file qgis.h.

◆ BrowserDirectoryMonitoring

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 425 of file qgis.h.

◆ BrowserItemCapability

enum 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 380 of file qgis.h.

◆ BrowserItemState

enum 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 367 of file qgis.h.

◆ BrowserItemType

enum Qgis::BrowserItemType : int
strong

Symbol layer flags.

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 348 of file qgis.h.

◆ BrowserLayerType

enum 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.

Definition at line 402 of file qgis.h.

◆ BufferSide

enum Qgis::BufferSide : int
strong

Side of line to buffer.

Since
QGIS 3.22
Enumerator
SIP_MONKEYPATCH_COMPAT_NAME 

Buffer to left of line.

SIP_MONKEYPATCH_COMPAT_NAME 

Buffer to right of line.

Definition at line 954 of file qgis.h.

◆ Capitalization

enum 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 1610 of file qgis.h.

◆ CaptureTechnique

enum 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 152 of file qgis.h.

◆ ContentStatus

enum 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 818 of file qgis.h.

◆ CoordinateOrder

enum 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 1101 of file qgis.h.

◆ CoordinateTransformationFlag

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 1266 of file qgis.h.

◆ CrsAxisDirection

enum Qgis::CrsAxisDirection : int
strong

Data provider flags.

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 1051 of file qgis.h.

◆ CrsDefinitionFormat

enum Qgis::CrsDefinitionFormat : int
strong

CRS definition formats.

Since
QGIS 3.24
Enumerator
SIP_MONKEYPATCH_COMPAT_NAME 

WKT format (always recommended over proj string format)

SIP_MONKEYPATCH_COMPAT_NAME 

Proj string format.

Definition at line 1705 of file qgis.h.

◆ DashPatternLineEndingRule

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 1549 of file qgis.h.

◆ DashPatternSizeAdjustment

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 1564 of file qgis.h.

◆ DataProviderFlag

enum Qgis::DataProviderFlag : int
strong

Map layer properties.

Generic data provider flags.

Since
QGIS 3.26
Enumerator
IsBasemapSource 

Associated source should be considered a 'basemap' layer. See Qgis::MapLayerProperty::IsBasemapLayer.

Definition at line 1035 of file qgis.h.

◆ DataType

enum 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)

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 128 of file qgis.h.

◆ DpiMode

enum Qgis::DpiMode
strong

DpiMode enum.

Since
QGIS 3.26
Enumerator
All 

All.

Off 

Off.

QGIS 

QGIS.

UMN 

UMN.

GeoServer 

GeoServer.

Definition at line 1590 of file qgis.h.

◆ DriveType

enum 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.

Definition at line 505 of file qgis.h.

◆ EndCapStyle

enum Qgis::EndCapStyle : int
strong

End cap styles for buffers.

Since
QGIS 3.22
Enumerator
SIP_MONKEYPATCH_COMPAT_NAME 

Round cap.

SIP_MONKEYPATCH_COMPAT_NAME 

Flat cap (in line with start/end of line)

SIP_MONKEYPATCH_COMPAT_NAME 

Square cap (extends past start/end of line by buffer distance)

Definition at line 966 of file qgis.h.

◆ FieldDomainMergePolicy

enum 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 1736 of file qgis.h.

◆ FieldDomainSplitPolicy

enum 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.

Definition at line 1720 of file qgis.h.

◆ FieldDomainType

enum 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 1749 of file qgis.h.

◆ FileOperationFlag

enum 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 1005 of file qgis.h.

◆ FilePathType

enum Qgis::FilePathType : int
strong

File path types.

Since
QGIS 3.22
Enumerator
Absolute 

Absolute path.

Relative 

Relative path.

Definition at line 751 of file qgis.h.

◆ GeometryOperationResult

enum 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.

Definition at line 901 of file qgis.h.

◆ GeometryValidationEngine

enum Qgis::GeometryValidationEngine : int
strong

Available engines for validating geometries.

Since
QGIS 3.22
Enumerator
SIP_MONKEYPATCH_COMPAT_NAME 

Use internal QgsGeometryValidator method.

SIP_MONKEYPATCH_COMPAT_NAME 

Use GEOS validation methods.

Definition at line 942 of file qgis.h.

◆ GeometryValidityFlag

enum Qgis::GeometryValidityFlag : int
strong

Geometry validity check flags.

Since
QGIS 3.22
Enumerator
SIP_MONKEYPATCH_COMPAT_NAME 

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 929 of file qgis.h.

◆ GpsFeatureType

enum Qgis::GpsFeatureType : int
strong

Babel command flags.

GPS feature types.

Since
QGIS 3.22
Enumerator
Waypoint 

Waypoint.

Route 

Route.

Track 

Track.

Definition at line 886 of file qgis.h.

◆ GpsQualityIndicator

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 833 of file qgis.h.

◆ GradientColorSource

enum 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 1451 of file qgis.h.

◆ GradientSpread

enum 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 1495 of file qgis.h.

◆ GradientType

enum 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 1465 of file qgis.h.

◆ GraduatedMethod

enum 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
SIP_MONKEYPATCH_COMPAT_NAME 

Alter color of symbols.

SIP_MONKEYPATCH_COMPAT_NAME 

Alter size of symbols.

Definition at line 1579 of file qgis.h.

◆ HistoryProviderBackend

enum Qgis::HistoryProviderBackend : int
strong

History provider backends.

Since
QGIS 3.24
Enumerator
LocalProfile 

Local profile.

Definition at line 1691 of file qgis.h.

◆ HttpMethod

enum Qgis::HttpMethod : int
strong

Different methods of HTTP requests.

Since
3.22
Enumerator
Get 

GET method.

Post 

POST method.

Definition at line 437 of file qgis.h.

◆ JoinStyle

enum Qgis::JoinStyle : int
strong

Join styles for buffers.

Since
QGIS 3.22
Enumerator
SIP_MONKEYPATCH_COMPAT_NAME 

Use rounded joins.

SIP_MONKEYPATCH_COMPAT_NAME 

Use mitered joins.

SIP_MONKEYPATCH_COMPAT_NAME 

Use beveled joins.

Definition at line 979 of file qgis.h.

◆ LabelMultiLineAlignment

enum 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
SIP_MONKEYPATCH_COMPAT_NAME 

Left align.

SIP_MONKEYPATCH_COMPAT_NAME 

Center align.

SIP_MONKEYPATCH_COMPAT_NAME 

Right align.

SIP_MONKEYPATCH_COMPAT_NAME 

Alignment follows placement of label, e.g., labels to the left of a feature will be drawn with right alignment.

SIP_MONKEYPATCH_COMPAT_NAME 

Justified.

Definition at line 657 of file qgis.h.

◆ LabelOffsetType

enum 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 607 of file qgis.h.

◆ LabelOverlapHandling

enum 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 545 of file qgis.h.

◆ LabelPlacement

enum 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 560 of file qgis.h.

◆ LabelPredefinedPointPosition

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.

Definition at line 582 of file qgis.h.

◆ LabelQuadrantPosition

enum Qgis::LabelQuadrantPosition : int
strong

Label quadrant positions.

Note
Prior to QGIS 3.26 this was available as QgsPalLayerSettings::QuadrantPosition
Since
QGIS 3.26
Enumerator
SIP_MONKEYPATCH_COMPAT_NAME 

Above left.

SIP_MONKEYPATCH_COMPAT_NAME 

Above center.

SIP_MONKEYPATCH_COMPAT_NAME 

Above right.

SIP_MONKEYPATCH_COMPAT_NAME 

Left middle.

SIP_MONKEYPATCH_COMPAT_NAME 

Center middle.

SIP_MONKEYPATCH_COMPAT_NAME 

Right middle.

SIP_MONKEYPATCH_COMPAT_NAME 

Below left.

SIP_MONKEYPATCH_COMPAT_NAME 

Below center.

SIP_MONKEYPATCH_COMPAT_NAME 

BelowRight.

Definition at line 621 of file qgis.h.

◆ LightSourceType

enum 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 1855 of file qgis.h.

◆ LineClipMode

enum 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 1536 of file qgis.h.

◆ LineExtensionSide

enum 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 1813 of file qgis.h.

◆ MapLayerProperty

enum Qgis::MapLayerProperty : int
strong

File operation flags.

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 1020 of file qgis.h.

◆ MapSettingsFlag

enum Qgis::MapSettingsFlag : int
strong

Coordinate transformation flags.

Since
QGIS 3.26 Flags which adjust the way maps are rendered.
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)

Definition at line 1286 of file qgis.h.

◆ MarkerClipMode

enum 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 1522 of file qgis.h.

◆ MarkerLinePlacement

enum 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 1429 of file qgis.h.

◆ MarkerShape

enum 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)

Definition at line 1388 of file qgis.h.

◆ MeshEditingErrorType

enum 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 734 of file qgis.h.

◆ 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 114 of file qgis.h.

◆ PlotToolFlag

enum 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 1842 of file qgis.h.

◆ PointCloudDrawOrder

enum 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 1918 of file qgis.h.

◆ PointCloudSymbol

enum 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 1906 of file qgis.h.

◆ PointCountMethod

enum 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
SIP_MONKEYPATCH_COMPAT_NAME 

The point count is used as an absolute count of markers.

SIP_MONKEYPATCH_COMPAT_NAME 

The point count is part of a marker density count.

Definition at line 1510 of file qgis.h.

◆ ProfileGeneratorFlag

enum 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 1891 of file qgis.h.

◆ ProfileSurfaceSymbology

enum 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.

Definition at line 1867 of file qgis.h.

◆ ProjectFileFormat

enum 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 1948 of file qgis.h.

◆ ProjectFlag

enum 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 1826 of file qgis.h.

◆ ProjectReadFlag

enum 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
SIP_MONKEYPATCH_COMPAT_NAME 

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.

SIP_MONKEYPATCH_COMPAT_NAME 

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).

SIP_MONKEYPATCH_COMPAT_NAME 

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.

SIP_MONKEYPATCH_COMPAT_NAME 

Skip the initial XML style storage for layers. Useful for minimising project load times in non-interactive contexts.

SIP_MONKEYPATCH_COMPAT_NAME 

Skip loading 3D views (since QGIS 3.26)

DontLoadProjectStyles 

Skip loading project style databases (since QGIS 3.26)

Definition at line 1962 of file qgis.h.

◆ PythonMacroMode

enum Qgis::PythonMacroMode : int
strong

Vector layer type flags.

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 179 of file qgis.h.

◆ RasterPipeInterfaceRole

enum Qgis::RasterPipeInterfaceRole : int
strong

Sublayer flags.

Raster pipe interface roles.

Since
QGIS 3.22
Enumerator
SIP_MONKEYPATCH_COMPAT_NAME 

Unknown role.

SIP_MONKEYPATCH_COMPAT_NAME 

Data provider role.

SIP_MONKEYPATCH_COMPAT_NAME 

Raster renderer role.

SIP_MONKEYPATCH_COMPAT_NAME 

Brightness filter role.

SIP_MONKEYPATCH_COMPAT_NAME 

Resampler role.

SIP_MONKEYPATCH_COMPAT_NAME 

Projector role.

SIP_MONKEYPATCH_COMPAT_NAME 

Raster nuller role.

SIP_MONKEYPATCH_COMPAT_NAME 

Hue/saturation filter role (also applies grayscale/color inversion)

Definition at line 703 of file qgis.h.

◆ RasterResamplingStage

enum 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 720 of file qgis.h.

◆ RasterTemporalCapabilityFlag

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 1235 of file qgis.h.

◆ RasterTemporalMode

enum Qgis::RasterTemporalMode : int
strong

Raster layer temporal modes.

Since
QGIS 3.22
Enumerator
SIP_MONKEYPATCH_COMPAT_NAME 

Mode when temporal properties have fixed start and end datetimes.

SIP_MONKEYPATCH_COMPAT_NAME 

Mode when raster layer delegates temporal range handling to the dataprovider.

SIP_MONKEYPATCH_COMPAT_NAME 

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)

Definition at line 1207 of file qgis.h.

◆ RenderContextFlag

enum 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)

Definition at line 1315 of file qgis.h.

◆ RendererUsage

enum 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 1665 of file qgis.h.

◆ RenderSubcomponentProperty

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 1361 of file qgis.h.

◆ ScaleMethod

enum 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 219 of file qgis.h.

◆ ScaleToTileZoomLevelMethod

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 1641 of file qgis.h.

◆ SelectBehavior

enum 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 777 of file qgis.h.

◆ SettingsOption

enum Qgis::SettingsOption : int
strong

Settings options.

Since
QGIS 3.26
Enumerator
SaveFormerValue 
SaveEnumFlagAsInt 

Definition at line 247 of file qgis.h.

◆ SettingsType

enum Qgis::SettingsType : int
strong

Types of settings entries.

Since
QGIS 3.26
Enumerator
Variant 

Generic variant.

String 

String.

StringList 

List of strings.

Bool 

Boolean.

Integer 

Integer.

Double 

Double precision number.

EnumFlag 

Enum or Flag.

Color 

Color.

Definition at line 230 of file qgis.h.

◆ SnappingMode

enum 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 260 of file qgis.h.

◆ SnappingType

enum Qgis::SnappingType : int
strong

SnappingTypeFlag defines on what object the snapping is performed.

Since
QGIS 3.26
Enumerator
SIP_MONKEYPATCH_COMPAT_NAME 

No snapping.

SIP_MONKEYPATCH_COMPAT_NAME 

On vertices.

SIP_MONKEYPATCH_COMPAT_NAME 

On segments.

SIP_MONKEYPATCH_COMPAT_NAME 

On Area.

SIP_MONKEYPATCH_COMPAT_NAME 

On centroid.

SIP_MONKEYPATCH_COMPAT_NAME 

On Middle segment.

SIP_MONKEYPATCH_COMPAT_NAME 

Start or end points of lines, or first vertex in polygon rings only (since QGIS 3.20)

Definition at line 272 of file qgis.h.

◆ SpatialFilterType

enum 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 992 of file qgis.h.

◆ SqlKeywordCategory

enum Qgis::SqlKeywordCategory : int
strong

SQL layer definition capabilities.

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 487 of file qgis.h.

◆ SqlLayerDefinitionCapability

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 470 of file qgis.h.

◆ SublayerFlag

enum Qgis::SublayerFlag : int
strong

Sublayer query flags.

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 689 of file qgis.h.

◆ SublayerPromptMode

enum 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 763 of file qgis.h.

◆ SublayerQueryFlag

enum 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 672 of file qgis.h.

◆ SymbolCoordinateReference

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 1480 of file qgis.h.

◆ SymbolFlag

enum 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 306 of file qgis.h.

◆ SymbolLayerFlag

enum Qgis::SymbolLayerFlag : int
strong

Flags controlling behavior of symbol layers.

Since
QGIS 3.22
Enumerator
DisableFeatureClipping 

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

Definition at line 334 of file qgis.h.

◆ SymbolPreviewFlag

enum Qgis::SymbolPreviewFlag : int
strong

Symbol flags.

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 320 of file qgis.h.

◆ SymbolRenderHint

enum 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 292 of file qgis.h.

◆ SymbolType

enum 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 205 of file qgis.h.

◆ TemporalIntervalMatchMethod

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 1220 of file qgis.h.

◆ TextRendererFlag

enum 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 1628 of file qgis.h.

◆ TextRenderFormat

enum Qgis::TextRenderFormat : int
strong

Options for rendering text.

Since
QGIS 3.22
Enumerator
SIP_MONKEYPATCH_COMPAT_NAME 

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.

SIP_MONKEYPATCH_COMPAT_NAME 

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 1349 of file qgis.h.

◆ TransactionMode

enum 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 1762 of file qgis.h.

◆ TransformDirection

enum Qgis::TransformDirection : int
strong

Flags for raster layer temporal capabilities.

Since
QGIS 3.28 Indicates the direction (forward or inverse) of a transform.
QGIS 3.22
Enumerator
SIP_MONKEYPATCH_COMPAT_NAME 

Forward transform (from source to destination)

SIP_MONKEYPATCH_COMPAT_NAME 

Reverse/inverse transform (from destination to source)

Definition at line 1254 of file qgis.h.

◆ UnplacedLabelVisibility

enum 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 533 of file qgis.h.

◆ UpsideDownLabelHandling

enum 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
SIP_MONKEYPATCH_COMPAT_NAME 

Upside-down labels (90 <= angle < 270) are shown upright.

SIP_MONKEYPATCH_COMPAT_NAME 

Show upside down when rotation is layer- or data-defined.

SIP_MONKEYPATCH_COMPAT_NAME 

Show upside down for all labels, including dynamic ones.

Definition at line 642 of file qgis.h.

◆ VectorDataProviderTemporalMode

Vector data provider temporal handling modes.

Since
QGIS 3.22
Enumerator
SIP_MONKEYPATCH_COMPAT_NAME 

Entire dataset from provider has a fixed start and end datetime.

SIP_MONKEYPATCH_COMPAT_NAME 

Dataset has feature datetime instants stored in a single field.

SIP_MONKEYPATCH_COMPAT_NAME 

Dataset stores feature start and end datetimes in separate fields.

Definition at line 1194 of file qgis.h.

◆ VectorEditResult

enum 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 791 of file qgis.h.

◆ VectorExportResult

enum Qgis::VectorExportResult : int
strong

Vector layer export result codes.

Since
QGIS 3.20
Enumerator
SIP_MONKEYPATCH_COMPAT_NAME 

No errors were encountered.

SIP_MONKEYPATCH_COMPAT_NAME 

Could not create the destination data source.

SIP_MONKEYPATCH_COMPAT_NAME 

Could not create destination layer.

SIP_MONKEYPATCH_COMPAT_NAME 

Source layer has an attribute type which could not be handled by destination.

SIP_MONKEYPATCH_COMPAT_NAME 

Destination provider was unable to create an attribute.

SIP_MONKEYPATCH_COMPAT_NAME 

An error occurred while reprojecting features to destination CRS.

SIP_MONKEYPATCH_COMPAT_NAME 

An error occurred while writing a feature to the destination.

SIP_MONKEYPATCH_COMPAT_NAME 

Could not access newly created destination layer.

SIP_MONKEYPATCH_COMPAT_NAME 

Could not find a matching provider key.

SIP_MONKEYPATCH_COMPAT_NAME 

Provider does not support creation of empty layers.

SIP_MONKEYPATCH_COMPAT_NAME 

Could not connect to destination.

SIP_MONKEYPATCH_COMPAT_NAME 

User canceled the export.

Definition at line 449 of file qgis.h.

◆ VectorLayerTypeFlag

enum Qgis::VectorLayerTypeFlag : int
strong

Vector layer type flags.

Since
QGIS 3.24
Enumerator
SqlQuery 

SQL query layer.

Definition at line 166 of file qgis.h.

◆ VectorProfileType

enum 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 1879 of file qgis.h.

◆ VectorTemporalLimitMode

enum 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 1182 of file qgis.h.

◆ VectorTemporalMode

enum Qgis::VectorTemporalMode : int
strong

Vector layer temporal feature modes.

Since
QGIS 3.22
Enumerator
SIP_MONKEYPATCH_COMPAT_NAME 

Mode when temporal properties have fixed start and end datetimes.

SIP_MONKEYPATCH_COMPAT_NAME 

Mode when features have a datetime instant taken from a single field.

SIP_MONKEYPATCH_COMPAT_NAME 

Mode when features have separate fields for start and end times.

SIP_MONKEYPATCH_COMPAT_NAME 

Mode when features have a field for start time and a field for event duration.

SIP_MONKEYPATCH_COMPAT_NAME 

Mode when features use expressions for start and end times.

SIP_MONKEYPATCH_COMPAT_NAME 

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 1166 of file qgis.h.

◆ VertexMarkerType

enum 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 806 of file qgis.h.

◆ VertexType

enum Qgis::VertexType : int
strong

Types of vertex.

Since
QGIS 3.22
Enumerator
SIP_MONKEYPATCH_COMPAT_NAME 

The actual start or end point of a segment.

SIP_MONKEYPATCH_COMPAT_NAME 

An intermediate point on a segment defining the curvature of the segment.

Definition at line 1374 of file qgis.h.

◆ ViewSyncModeFlag

enum 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 1678 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 271 of file qgis.cpp.

◆ devVersion()

QString Qgis::devVersion ( )
static

The development version.

Since
QGIS 3.12

Definition at line 294 of file qgis.cpp.

◆ geosVersion()

QString Qgis::geosVersion ( )
static

GEOS string version linked.

Since
QGIS 3.20

Definition at line 299 of file qgis.cpp.

◆ geosVersionInt()

int Qgis::geosVersionInt ( )
static

GEOS version number linked.

Since
QGIS 3.20

Definition at line 304 of file qgis.cpp.

◆ geosVersionMajor()

int Qgis::geosVersionMajor ( )
static

GEOS Major version number linked.

Since
QGIS 3.20

Definition at line 314 of file qgis.cpp.

◆ geosVersionMinor()

int Qgis::geosVersionMinor ( )
static

GEOS Minor version number linked.

Since
QGIS 3.20

Definition at line 319 of file qgis.cpp.

◆ geosVersionPatch()

int Qgis::geosVersionPatch ( )
static

GEOS Patch version number linked.

Since
QGIS 3.20

Definition at line 324 of file qgis.cpp.

◆ Q_DECLARE_FLAGS() [1/8]

Qgis::Q_DECLARE_FLAGS ( BrowserItemCapabilities  ,
BrowserItemCapability   
)

Browser item capabilities.

◆ Q_DECLARE_FLAGS() [2/8]

Qgis::Q_DECLARE_FLAGS ( GeometryValidityFlags  ,
GeometryValidityFlag   
)

Geometry validity flags.

◆ Q_DECLARE_FLAGS() [3/8]

Qgis::Q_DECLARE_FLAGS ( MapSettingsFlags  ,
MapSettingsFlag   
)

Map settings flags.

◆ Q_DECLARE_FLAGS() [4/8]

Qgis::Q_DECLARE_FLAGS ( ProjectReadFlags  ,
ProjectReadFlag   
)

Project load flags.

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

◆ Q_DECLARE_FLAGS() [5/8]

Qgis::Q_DECLARE_FLAGS ( RenderContextFlags  ,
RenderContextFlag   
)

Render context flags.

◆ Q_DECLARE_FLAGS() [6/8]

Qgis::Q_DECLARE_FLAGS ( SnappingTypes  ,
SnappingType   
)

Snapping types.

◆ Q_DECLARE_FLAGS() [7/8]

Qgis::Q_DECLARE_FLAGS ( SymbolPreviewFlags  ,
SymbolPreviewFlag   
)

Symbol preview flags.

◆ Q_DECLARE_FLAGS() [8/8]

Qgis::Q_DECLARE_FLAGS ( SymbolRenderHints  ,
SymbolRenderHint   
)

Symbol render hints.

◆ Q_ENUM() [1/3]

Qgis::Q_ENUM ( ProfileSurfaceSymbology  )

◆ Q_ENUM() [2/3]

Qgis::Q_ENUM ( ScaleToTileZoomLevelMethod  )

◆ Q_ENUM() [3/3]

Qgis::Q_ENUM ( VectorProfileType  )

◆ releaseName()

QString Qgis::releaseName ( )
static

Release name.

Since
QGIS 3.12

Definition at line 289 of file qgis.cpp.

◆ version()

QString Qgis::version ( )
static

Version string.

Since
QGIS 3.12

Definition at line 277 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 282 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.

Since
QGIS 2.3

Definition at line 2004 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.

Since
QGIS 2.3

Definition at line 1998 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.

Since
QGIS 2.3

Definition at line 2010 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 2032 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 1990 of file qgis.h.

◆ DEFAULT_SEARCH_RADIUS_MM

const double Qgis::DEFAULT_SEARCH_RADIUS_MM = 2.
static

Identify search radius in mm.

Since
QGIS 2.3

Definition at line 1987 of file qgis.h.

◆ DEFAULT_SNAP_TOLERANCE

const double Qgis::DEFAULT_SNAP_TOLERANCE = 12.0
static

Default snapping distance tolerance.

Since
QGIS 3.0

Definition at line 2045 of file qgis.h.

◆ DEFAULT_SNAP_UNITS

const QgsTolerance::UnitType Qgis::DEFAULT_SNAP_UNITS = QgsTolerance::Pixels
static

Default snapping distance units.

Since
QGIS 3.0

Definition at line 2051 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.

Since
QGIS 3.0

Definition at line 2025 of file qgis.h.

◆ QGIS_DEV_VERSION

const char * Qgis::QGIS_DEV_VERSION = QGSVERSION
static

The development version.

Definition at line 98 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 >=.

Since
QGIS 2.15

Definition at line 2018 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.

Since
QGIS 3.0

Definition at line 2039 of file qgis.h.


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