QGIS API Documentation  3.21.0-Master (909859188c)
Public Types | 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  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 }
 Flags for controlling how an annotation item behaves in the GUI. More...
 
enum class  AnnotationItemNodeType : int { VertexHandle }
 Annotation item node types. More...
 
enum class  BabelCommandFlag : int { QuoteFilePaths = 1 << 0 }
 Babel command flags, which control how commands and arguments are generated for executing GPSBabel processes. 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  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
}
 Browser item capabilities. More...
 
enum class  BrowserItemState : int { NotPopulated , Populating , Populated }
 Browser item states. More...
 
enum class  BrowserItemType : int {
  Collection , Directory , Layer , Error ,
  Favorites , Project , Custom , Fields ,
  Field
}
 Browser item types. More...
 
enum class  BrowserLayerType : int {
  NoType , Vector , Raster , Point ,
  Line , Polygon , TableLayer , Database ,
  Table , Plugin , Mesh , VectorTile ,
  PointCloud
}
 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  ContentStatus : int {
  NotStarted , Running , Finished , Failed ,
  Canceled
}
 Status for fetched or stored content. 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  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  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 }
 GPS feature types. 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  MapLayerProperty : int { UsersCannotToggleEditing = 1 << 0 }
 Generic map layer properties. 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  PythonMacroMode : int {
  Never = 0 , Ask = 1 , SessionOnly = 2 , Always = 3 ,
  NotForThisSession
}
 Authorisation to run Python Macros. 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
}
 Raster pipe interface roles. More...
 
enum class  RasterResamplingStage : int { ResampleFilter , Provider }
 Stage at which raster resampling occurs. 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  ScaleMethod : int { ScaleArea , ScaleDiameter }
 Scale methods. More...
 
enum class  SelectBehavior : int { SetSelection , AddToSelection , IntersectSelection , RemoveFromSelection }
 Specifies how a selection should be applied. 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
}
 SqlKeywordCategory enum represents the categories of the SQL keywords used by the SQL query editor. 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 }
 Flags which reflect the properties of sublayers in a dataset. 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  SymbolFlag : int { RendererShouldUseSymbolLevels = 1 << 0 }
 Flags controlling behavior of symbols. More...
 
enum class  SymbolPreviewFlag : int { FlagIncludeCrosshairsForMarkerSymbols = 1 << 0 }
 Flags for controlling how symbol preview images are generated. 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  UnplacedLabelVisibility : int { FollowEngineSetting , NeverShow }
 Unplaced label visibility. 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  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...
 

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 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 62 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 398 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 785 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 750 of file qgis.h.

◆ AnnotationItemGuiFlag

enum Qgis::AnnotationItemGuiFlag : int
strong

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

Since
QGIS 3.22
Enumerator
FlagNoCreationTools 

Do not show item creation tools for the item type.

Definition at line 762 of file qgis.h.

◆ AnnotationItemNodeType

enum Qgis::AnnotationItemNodeType : int
strong

Annotation item node types.

Since
QGIS 3.22
Enumerator
VertexHandle 

Node is a handle for manipulating vertices.

Definition at line 774 of file qgis.h.

◆ BabelCommandFlag

enum Qgis::BabelCommandFlag : int
strong

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

Since
QGIS 3.22
Enumerator
QuoteFilePaths 

File paths should be enclosed in quotations and escaped.

Definition at line 596 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 579 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 304 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)

Definition at line 262 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 249 of file qgis.h.

◆ BrowserItemType

enum Qgis::BrowserItemType : int
strong

Browser item types.

Since
QGIS 3.20
Enumerator
Collection 

A collection of items.

Directory 

Represents a file directory.

Layer 

Represents a map layer.

Error 

Contains an error message.

Favorites 

Represents a favorite item.

Project 

Represents a QGIS project.

Custom 

Custom item type.

Fields 

Collection of fields.

Field 

Vector layer field.

Definition at line 230 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 281 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 674 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 564 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 119 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 382 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 686 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 725 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 497 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 623 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 662 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 651 of file qgis.h.

◆ GpsFeatureType

enum Qgis::GpsFeatureType : int
strong

GPS feature types.

Since
QGIS 3.22
Enumerator
Waypoint 

Waypoint.

Route 

Route.

Track 

Track.

Definition at line 608 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 316 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 699 of file qgis.h.

◆ MapLayerProperty

enum Qgis::MapLayerProperty : int
strong

Generic map layer properties.

Since
QGIS 3.22
Enumerator
UsersCannotToggleEditing 

Indicates that users are not allowed to toggle editing for this layer. Note that this does not imply that the layer is non-editable (see isEditable(), supportsEditing() ), rather that the editable status of the layer cannot be changed by users manually. Since QGIS 3.22.

Definition at line 738 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 480 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 105 of file qgis.h.

◆ PythonMacroMode

enum Qgis::PythonMacroMode : int
strong

Authorisation to run Python Macros.

Since
QGIS 3.10
Enumerator
Never 

Macros are never run.

Ask 

User is prompt before running.

SessionOnly 

Only during this session.

Always 

Macros are always run.

NotForThisSession 

Macros will not be run for this session.

Definition at line 142 of file qgis.h.

◆ RasterPipeInterfaceRole

enum Qgis::RasterPipeInterfaceRole : int
strong

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 449 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 466 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 839 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 182 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 523 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 712 of file qgis.h.

◆ SqlKeywordCategory

enum Qgis::SqlKeywordCategory : int
strong

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

Note
The category has currently no usage, but it was planned for future uses.
Since
QGIS 3.22
Enumerator
Keyword 

SQL keyword.

Constant 

SQL constant.

Function 

SQL generic function.

Geospatial 

SQL spatial function.

Operator 

SQL operator.

Math 

SQL math function.

Aggregate 

SQL aggregate function.

String 

SQL string function.

Identifier 

SQL identifier.

Definition at line 364 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 349 of file qgis.h.

◆ SublayerFlag

enum Qgis::SublayerFlag : int
strong

Flags which reflect the properties of sublayers in a dataset.

Since
QGIS 3.22
Enumerator
SystemTable 

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

Definition at line 437 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 509 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 422 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 206 of file qgis.h.

◆ SymbolPreviewFlag

enum Qgis::SymbolPreviewFlag : int
strong

Flags for controlling how symbol preview images are generated.

Since
QGIS 3.20
Enumerator
FlagIncludeCrosshairsForMarkerSymbols 

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

Definition at line 218 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 194 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 168 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 852 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 410 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 826 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 537 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 328 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 814 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 798 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 552 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 279 of file qgis.cpp.

◆ devVersion()

QString Qgis::devVersion ( )
static

The development version.

Since
QGIS 3.12

Definition at line 302 of file qgis.cpp.

◆ geosVersion()

QString Qgis::geosVersion ( )
static

GEOS string version linked.

Since
QGIS 3.20

Definition at line 307 of file qgis.cpp.

◆ geosVersionInt()

int Qgis::geosVersionInt ( )
static

GEOS version number linked.

Since
QGIS 3.20

Definition at line 312 of file qgis.cpp.

◆ geosVersionMajor()

int Qgis::geosVersionMajor ( )
static

GEOS Major version number linked.

Since
QGIS 3.20

Definition at line 322 of file qgis.cpp.

◆ geosVersionMinor()

int Qgis::geosVersionMinor ( )
static

GEOS Minor version number linked.

Since
QGIS 3.20

Definition at line 327 of file qgis.cpp.

◆ geosVersionPatch()

int Qgis::geosVersionPatch ( )
static

GEOS Patch version number linked.

Since
QGIS 3.20

Definition at line 332 of file qgis.cpp.

◆ releaseName()

QString Qgis::releaseName ( )
static

Release name.

Since
QGIS 3.12

Definition at line 297 of file qgis.cpp.

◆ version()

QString Qgis::version ( )
static

Version string.

Since
QGIS 3.12

Definition at line 285 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 290 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 883 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 877 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 889 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 911 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 869 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 866 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 924 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 930 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 904 of file qgis.h.

◆ QGIS_DEV_VERSION

const char * Qgis::QGIS_DEV_VERSION = QGSVERSION
static

The development version.

Definition at line 89 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 897 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 918 of file qgis.h.


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