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

#include <qgis.h>

Public Types
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 }
	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	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	FeatureCountState : int { Uncounted = -2 , UnknownCount = -1 }
	Enumeration of feature count states. 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	ScaleMethod : int { ScaleArea , ScaleDiameter }
	Scale methods. 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	UnplacedLabelVisibility : int { FollowEngineSetting , NeverShow }
	Unplaced label visibility. 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...

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

Member Enumeration Documentation

◆ BrowserDirectoryMonitoring

enum Qgis::BrowserDirectoryMonitoring : int

strong

Browser directory item monitoring switches.

Since: QGIS 3.20

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

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

Definition at line 261 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 248 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 229 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 279 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 118 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 336 of file qgis.h.

◆ MessageLevel

enum Qgis::MessageLevel

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

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

Definition at line 104 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 141 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 181 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 205 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 217 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 193 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 167 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 353 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 315 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 381 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 375 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 387 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 409 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 367 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 364 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 422 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 428 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 402 of file qgis.h.

◆ QGIS_DEV_VERSION

const char * Qgis::QGIS_DEV_VERSION = QGSVERSION

static

The development version.

Definition at line 88 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 395 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 416 of file qgis.h.

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

/build/qgis-3.20.0+99unstable/src/core/qgis.h
/build/qgis-3.20.0+99unstable/src/core/qgis.cpp

Public Types

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Enumeration Documentation

◆ BrowserDirectoryMonitoring

◆ BrowserItemCapability

◆ BrowserItemState

◆ BrowserItemType

◆ BrowserLayerType

◆ DataType

◆ DriveType

◆ MessageLevel

◆ PythonMacroMode

◆ ScaleMethod

◆ SymbolFlag

◆ SymbolPreviewFlag

◆ SymbolRenderHint

◆ SymbolType

◆ UnplacedLabelVisibility

◆ VectorExportResult

Member Function Documentation

◆ defaultProjectScales()

◆ devVersion()

◆ geosVersion()

◆ geosVersionInt()

◆ geosVersionMajor()

◆ geosVersionMinor()

◆ geosVersionPatch()

◆ releaseName()

◆ version()

◆ versionInt()

Member Data Documentation

◆ DEFAULT_HIGHLIGHT_BUFFER_MM

◆ DEFAULT_HIGHLIGHT_COLOR

◆ DEFAULT_HIGHLIGHT_MIN_WIDTH_MM

◆ DEFAULT_M_COORDINATE

◆ DEFAULT_MAPTOPIXEL_THRESHOLD

◆ DEFAULT_SEARCH_RADIUS_MM

◆ DEFAULT_SNAP_TOLERANCE

◆ DEFAULT_SNAP_UNITS

◆ DEFAULT_Z_COORDINATE

◆ QGIS_DEV_VERSION

◆ SCALE_PRECISION

◆ UI_SCALE_FACTOR